Add documentation

.gitignore

@@ -1,6 +1,6 @@
 # Compiled class file
 *.class
-
+*.balx
 # Log file
 *.log
 
@@ -10,15 +10,49 @@
 # Mobile Tools for Java (J2ME)
 .mtj.tmp/
 
-# Package Files #
+# .DS_Store files
+*.DS_Store
+
+# Package Files
 *.jar
+!gradle/wrapper/gradle-wrapper.jar
 *.war
-*.nar
 *.ear
 *.zip
 *.tar.gz
 *.rar
+*.deb
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
-replay_pid*
+
+# Ignore everything in this directory
+target
+.classpath
+.settings
+.project
+*.iml
+*.iws
+*.ipr
+.idea
+.m2
+.vscode/
+
+# Ignore ballerina files
+accessToken.bal
+temp.bal.ballerina/
+target/
+generated/
+.DS_Store
+*Ballerina.lock
+.ballerina
+**/Config.toml
+
+# Ignore Gradle project-specific cache directory
+.gradle
+
+# Ignore Gradle build output directory
+build
+
+# Ignore Docker env file
+docker.env

README.md

@@ -8,15 +8,174 @@
 
 ## Overview
 
-[//]: # (TODO: Add overview mentioning the purpose of the module, supported REST API versions, and other high-level details.)
+OpenAI is an American artificial intelligence research organization that comprises both a non-profit and a for-profit entity. The organization focuses on conducting cutting-edge AI research with the goal of developing friendly AI that benefits humanity. By advancing the state of AI, OpenAI aims to ensure that powerful AI technologies are used responsibly and ethically, promoting innovation while addressing potential risks.
+
+The `ballarinax/openai.Assistants` connector allows developers to seamlessly integrate OpenAI's advanced language models into their applications by interacting with [OpenAI REST API v1](https://platform.openai.com/docs/api-reference/assistants). This connector provides tools to build powerful [OpenAI Assistants](https://platform.openai.com/docs/assistants/overview) capable of performing a wide range of tasks, such as generating human-like text, managing conversations with persistent threads, and utilizing multiple tools in parallel. OpenAI has recently announced a variety of new features and improvements to the Assistants API, moving their Beta to a [new API version](https://platform.openai.com/docs/assistants/whats-new), `OpenAI-Beta: assistants=v2`. The users can interact with both the API v1 and v2 by [passing the respective API version header in the request](https://platform.openai.com/docs/assistants/migration/changing-beta-versions)  
+
 
 ## Setup guide
 
-[//]: # (TODO: Add detailed steps to obtain credentials and configure the module.)
+To use the OpenAI Connector, you must have access to the OpenAI API through a [OpenAI Platform account](https://platform.openai.com) and a project under it. If you do not have a OpenAI Platform account, you can sign up for one [here](https://platform.openai.com/signup).
+
+
+1. Open the [OpenAI Platform Dashboard](https://platform.openai.com).
+
+
+2. Navigate to Dashboard -> API keys
+<img src=https://github.com/user-attachments/assets/b2e09c6d-c15f-4cfa-a596-6328b1383162 alt="OpenAI Platform" style="width: 70%;">
+
+
+3. Click on the "Create new secret key" button
+<img src=https://github.com/user-attachments/assets/bf1adab4-5e3f-4094-9a56-5b4c3cc3c19e alt="OpenAI Platform" style="width: 70%;">
+
+
+4. Fill the details and click on Create secret key
+<img src=https://github.com/user-attachments/assets/1c565923-e968-4d5f-9864-7ed2022b8079 alt="OpenAI Platform" style="width: 70%;">
+
+
+5. Store the API key securely to use in your application 
+<img src=https://github.com/user-attachments/assets/bbbf8f38-d551-40ee-9664-f4cf2bd98997 alt="OpenAI Platform" style="width: 70%;">
+
 
 ## Quickstart
 
-[//]: # (TODO: Add a quickstart guide to demonstrate a basic functionality of the module, including sample code snippets.)
+To use the `OpenAI Assistants` connector in your Ballerina application, update the `.bal` file as follows:
+### Step 1: Import the module
+
+Import the `openai.assistants` module.
+
+```ballerina
+import ballerinax/openai.assistants;
+```
+
+### Step 2: Instantiate a new connector
+
+Create a `assistants:ConnectionConfig` with the obtained access token and initialize the connector with it.
+
+```ballerina
+configurable string token = ?;
+
+final assistants:Client openAIAssistant = check new({
+    auth: {
+        token
+    }
+});
+```
+
+#### Setting HTTP Headers in Ballerina
+
+Calls to the Assistants API require that you pass a beta HTTP header. In Ballerina, you can define the header as follows:
+
+```ballerina
+final map<string|string[]> headers = {
+    "OpenAI-Beta": ["assistants=v2"]
+};
+```
+
+### Step 3: Invoke the connector operations
+
+Now, utilize the available connector operations.
+
+#### Create an assistant
+
+```ballerina
+public function main() returns error? {
+
+    // define the required tool
+    assistants:AssistantToolsCode tool = {
+        type: "code_interpreter"
+    };
+
+    // define the assistant request object
+    assistants:CreateAssistantRequest request = {
+        model: "gpt-3.5-turbo",
+        name: "Math Tutor",
+        description: "An Assistant for personal math tutoring",
+        instructions: "You are a personal math tutor. Help the user with their math questions.",
+        tools: [tool]
+    };
+
+    // call the `post assistants` resource to create an Assistant
+    assistants:AssistantObject assistantResponse = check openAIAssistant->/assistants.post(request, headers);
+}
+```
+
+#### Create a thread
+
+A Thread represents a conversation between a user and one or many Assistants. You can create a Thread when a user (or your AI application) starts a conversation with your Assistant.
+
+```ballerina
+public function main() returns error?{
+    // define the thread request 
+    assistants:CreateThreadRequest createThreadReq = {
+        messages: []
+    };
+
+    // call the `post threads` resource to create a Thread
+    assistants:ThreadObject threadResponse = check openAIAssistant->/threads.post(createThreadReq, headers);
+}
+```
+
+#### Add a message to the thread
+
+The contents of the messages your users or applications create are added as Message objects to the Thread. Messages can contain both text and files. There is no limit to the number of Messages you can add to Threads — the context that does not fit into the model's context window will be truncated automatically.
+
+```ballerina
+public function main() returns error?{
+    string threadId = "your_thread_id";
+
+    // define the message object
+    assistants:CreateMessageRequest createMsgReq = {
+        role: "user",
+        content: "Can you help me solve the equation `3x + 11 = 14`?",
+        metadata: {}
+    };
+
+    // create a message in the thread
+    assistants:MessageObject messageResponse = check openAIAssistant->/threads/[threadId]/messages.post(createMsgReq, headers);
+}
+```
+
+#### Create a run
+
+Once all the user Messages have been added to the Thread, you can Run the Thread with any Assistant. Creating a Run uses the model and tools associated with the Assistant to generate a response. These responses are added to the Thread as Assistant Messages.
+
+```ballerina
+public function main() returns error?{
+    string threadId = "your_thread_id";
+
+    // define the run request object
+    assistants:CreateRunRequest runReq = {
+        assistant_id: "your_assistant_id",
+        model: "gpt-3.5-turbo",
+        instructions: "You are a personal math tutor. Assist the user with their math questions.",
+        temperature: 0.7,
+        top_p: 0.9,
+        max_prompt_tokens: 400,
+        max_completion_tokens: 200
+    };
+
+    // create a run in the thread
+    assistants:RunObject runResponse = check openAIAssistant->/threads/[threadId]/runs.post(runReq, headers);
+
+}
+```
+Once the Run completes, you can list the Messages added to the Thread by the Assistant.
+
+```ballerina
+public function main() returns error?{
+    string threadId = "your_thread_id";
+
+    // list messages in the thread
+    assistants:ListMessagesResponse listResponse = openAIAssistant->/threads/[threadId]/messages.get(headers);
+}
+```
+
+### Step 4: Run the Ballerina application
+
+```bash
+bal run
+```
 
 ## Examples