Update the documentations(Module.md, Package.md and README.md) and update Ballerina.toml

README.md

@@ -8,15 +8,92 @@
 
 ## Overview
 
-[//]: # (TODO: Add overview mentioning the purpose of the module, supported REST API versions, and other high-level details.)
+[OpenAI](https://openai.com/), an AI research organization focused on creating friendly AI for humanity, offers the [OpenAI API](https://platform.openai.com/docs/api-reference/introduction) to access its powerful AI models for tasks like natural language processing and image generation.
+
+The `ballarinax/openai.finetunes` package offers APIs to connect and interact with [the fine-tuning related endpoints of OpenAI REST API v1](https://platform.openai.com/docs/guides/fine-tuning) allowing users to customize OpenAI's AI models to meet specific needs.
 
 ## 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).
+
+#### Create a OpenAI API Key
+
+1. Open the [OpenAI Platform Dashboard](https://platform.openai.com).
+
+2. Navigate to Dashboard -> API keys
+<img src=https://raw.githubusercontent.com/KATTA-00/module-ballerinax-openai.finetunes/docs/docs/setup/resources/navigate-api-key-dashboard.png alt="OpenAI Platform" style="width: 70%;">
+
+3. Click on the "Create new secret key" button
+<img src=https://raw.githubusercontent.com/KATTA-00/module-ballerinax-openai.finetunes/docs/docs/setup/resources/api-key-dashboard.png alt="OpenAI Platform" style="width: 70%;">
+
+4. Fill the details and click on Create secret key
+<img src=https://raw.githubusercontent.com/KATTA-00/module-ballerinax-openai.finetunes/docs/docs/setup/resources/create-new-secret-key.png alt="OpenAI Platform" style="width: 70%;">
+
+5. Store the API key securely to use in your application 
+<img src=https://raw.githubusercontent.com/KATTA-00/module-ballerinax-openai.finetunes/docs/docs/setup/resources/saved-key.png 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 Finetunes` connector in your Ballerina application, update the `.bal` file as follows:
+
+### Step 1: Import the module
+
+Import the `openai.finetunes` module.
+
+```ballerina
+import ballerinax/openai.finetunes;
+import ballerina/io;
+```
+
+### Step 2: Instantiate a new connector
+
+Create a `finetunes:ConnectionConfig` with the obtained API Key and initialize the connector.
+
+```ballerina
+configurable string apiKey = ?;
+
+final finetunes:Client openAIFinetunes = check new({
+    auth: {
+        token: apiKey
+    }
+});
+```
+
+### Step 3: Invoke the connector operation
+
+Now, utilize the available connector operations.
+
+**Note**:  First, create a sample.jsonl file in the same directory. This file should contain the training data formatted according to the guidelines provided [here](https://platform.openai.com/docs/api-reference/files/create).
+
+#### Fine tuning the gpt-3.5-turbo model
+
+```ballerina
+public function main() returns error? {
+
+    finetunes:CreateFileRequest req = {
+        file: {fileContent: check io:fileReadBytes("sample.jsonl"), fileName: "sample.jsonl"},
+        purpose: "fine-tune"
+    };
+
+    finetunes:OpenAIFile fileRes = check openaiFinetunes->/files.post(req);
+
+    string fileId = fileRes.id;
+
+    CreateFineTuningJobRequest fineTuneRequest = {
+        model: "gpt-3.5-turbo",
+        training_file: fileId
+    };
+
+    FineTuningJob fineTuneResponse = 
+        check openaiFinetunes->/fine_tuning/jobs.post(fineTuneRequest);
+}
+```
+
+### Step 4: Run the Ballerina application
+
+```bash
+bal run
+```
 
 ## Examples
 
@@ -115,4 +192,4 @@ All the contributors are encouraged to read the [Ballerina Code of Conduct](http
 * For more information go to the [`openai.finetunes` package](https://central.ballerina.io/ballerinax/openai.finetunes/latest).
 * For example demonstrations of the usage, go to [Ballerina By Examples](https://ballerina.io/learn/by-example/).
 * Chat live with us via our [Discord server](https://discord.gg/ballerinalang).
-* Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.
+* Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.

ballerina/Ballerina.toml

@@ -5,8 +5,8 @@ name = "openai.finetunes"
 version = "1.0.5"
 license = ["Apache-2.0"]
 authors = ["Ballerina"]
-keywords = [] # TODO: Add keywords
-icon = "icon.png" # TODO: Add icon
+keywords = ["AI/Fine-tunes", "OpenAI", "Cost/Paid", "Files", "Models", "Vendor/OpenAI"]
+icon = "icon.png"
 repository = "https://github.com/ballerina-platform/module-ballerinax-openai.finetunes"
 
 [build-options]

ballerina/Module.md

@@ -1,17 +1,95 @@
+
 ## Overview
 
-[//]: # (TODO: Add overview mentioning the purpose of the module, supported REST API versions, and other high-level details.)
+[OpenAI](https://openai.com/), an AI research organization focused on creating friendly AI for humanity, offers the [OpenAI API](https://platform.openai.com/docs/api-reference/introduction) to access its powerful AI models for tasks like natural language processing and image generation.
+
+The `ballarinax/openai.finetunes` package offers APIs to connect and interact with [the fine-tuning related endpoints of OpenAI REST API v1](https://platform.openai.com/docs/guides/fine-tuning) allowing users to customize OpenAI's AI models to meet specific needs.
 
 ## 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).
+
+#### Create a OpenAI API Key
+
+1. Open the [OpenAI Platform Dashboard](https://platform.openai.com).
+
+2. Navigate to Dashboard -> API keys
+<img src=https://raw.githubusercontent.com/KATTA-00/module-ballerinax-openai.finetunes/docs/docs/setup/resources/navigate-api-key-dashboard.png alt="OpenAI Platform" style="width: 70%;">
+
+3. Click on the "Create new secret key" button
+<img src=https://raw.githubusercontent.com/KATTA-00/module-ballerinax-openai.finetunes/docs/docs/setup/resources/api-key-dashboard.png alt="OpenAI Platform" style="width: 70%;">
+
+4. Fill the details and click on Create secret key
+<img src=https://raw.githubusercontent.com/KATTA-00/module-ballerinax-openai.finetunes/docs/docs/setup/resources/create-new-secret-key.png alt="OpenAI Platform" style="width: 70%;">
+
+5. Store the API key securely to use in your application 
+<img src=https://raw.githubusercontent.com/KATTA-00/module-ballerinax-openai.finetunes/docs/docs/setup/resources/saved-key.png 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 Finetunes` connector in your Ballerina application, update the `.bal` file as follows:
+
+### Step 1: Import the module
+
+Import the `openai.finetunes` module.
+
+```ballerina
+import ballerinax/openai.finetunes;
+import ballerina/io;
+```
+
+### Step 2: Instantiate a new connector
+
+Create a `finetunes:ConnectionConfig` with the obtained API Key and initialize the connector.
+
+```ballerina
+configurable string apiKey = ?;
+
+final finetunes:Client openAIFinetunes = check new({
+    auth: {
+        token: apiKey
+    }
+});
+```
+
+### Step 3: Invoke the connector operation
+
+Now, utilize the available connector operations.
+
+**Note**:  First, create a sample.jsonl file in the same directory. This file should contain the training data formatted according to the guidelines provided [here](https://platform.openai.com/docs/api-reference/files/create).
+
+#### Fine tuning the gpt-3.5-turbo model
+
+```ballerina
+public function main() returns error? {
+
+    finetunes:CreateFileRequest req = {
+        file: {fileContent: check io:fileReadBytes("sample.jsonl"), fileName: "sample.jsonl"},
+        purpose: "fine-tune"
+    };
+
+    finetunes:OpenAIFile fileRes = check openaiFinetunes->/files.post(req);
+
+    string fileId = fileRes.id;
+
+    CreateFineTuningJobRequest fineTuneRequest = {
+        model: "gpt-3.5-turbo",
+        training_file: fileId
+    };
+
+    FineTuningJob fineTuneResponse = 
+        check openaiFinetunes->/fine_tuning/jobs.post(fineTuneRequest);
+}
+```
+
+### Step 4: Run the Ballerina application
+
+```bash
+bal run
+```
 
 ## Examples
 
 The `OpenAI Finetunes` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/module-ballerinax-openai.finetunes/tree/main/examples/), covering the following use cases:
 
-[//]: # (TODO: Add examples)
+[//]: # (TODO: Add examples)

ballerina/Package.md

@@ -1,17 +1,95 @@
+
 ## Overview
 
-[//]: # (TODO: Add overview mentioning the purpose of the module, supported REST API versions, and other high-level details.)
+[OpenAI](https://openai.com/), an AI research organization focused on creating friendly AI for humanity, offers the [OpenAI API](https://platform.openai.com/docs/api-reference/introduction) to access its powerful AI models for tasks like natural language processing and image generation.
+
+The `ballarinax/openai.finetunes` package offers APIs to connect and interact with [the fine-tuning related endpoints of OpenAI REST API v1](https://platform.openai.com/docs/guides/fine-tuning) allowing users to customize OpenAI's AI models to meet specific needs.
 
 ## 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).
+
+#### Create a OpenAI API Key
+
+1. Open the [OpenAI Platform Dashboard](https://platform.openai.com).
+
+2. Navigate to Dashboard -> API keys
+<img src=https://raw.githubusercontent.com/KATTA-00/module-ballerinax-openai.finetunes/docs/docs/setup/resources/navigate-api-key-dashboard.png alt="OpenAI Platform" style="width: 70%;">
+
+3. Click on the "Create new secret key" button
+<img src=https://raw.githubusercontent.com/KATTA-00/module-ballerinax-openai.finetunes/docs/docs/setup/resources/api-key-dashboard.png alt="OpenAI Platform" style="width: 70%;">
+
+4. Fill the details and click on Create secret key
+<img src=https://raw.githubusercontent.com/KATTA-00/module-ballerinax-openai.finetunes/docs/docs/setup/resources/create-new-secret-key.png alt="OpenAI Platform" style="width: 70%;">
+
+5. Store the API key securely to use in your application 
+<img src=https://raw.githubusercontent.com/KATTA-00/module-ballerinax-openai.finetunes/docs/docs/setup/resources/saved-key.png 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 Finetunes` connector in your Ballerina application, update the `.bal` file as follows:
+
+### Step 1: Import the module
+
+Import the `openai.finetunes` module.
+
+```ballerina
+import ballerinax/openai.finetunes;
+import ballerina/io;
+```
+
+### Step 2: Instantiate a new connector
+
+Create a `finetunes:ConnectionConfig` with the obtained API Key and initialize the connector.
+
+```ballerina
+configurable string apiKey = ?;
+
+final finetunes:Client openAIFinetunes = check new({
+    auth: {
+        token: apiKey
+    }
+});
+```
+
+### Step 3: Invoke the connector operation
+
+Now, utilize the available connector operations.
+
+**Note**:  First, create a sample.jsonl file in the same directory. This file should contain the training data formatted according to the guidelines provided [here](https://platform.openai.com/docs/api-reference/files/create).
+
+#### Fine tuning the gpt-3.5-turbo model
+
+```ballerina
+public function main() returns error? {
+
+    finetunes:CreateFileRequest req = {
+        file: {fileContent: check io:fileReadBytes("sample.jsonl"), fileName: "sample.jsonl"},
+        purpose: "fine-tune"
+    };
+
+    finetunes:OpenAIFile fileRes = check openaiFinetunes->/files.post(req);
+
+    string fileId = fileRes.id;
+
+    CreateFineTuningJobRequest fineTuneRequest = {
+        model: "gpt-3.5-turbo",
+        training_file: fileId
+    };
+
+    FineTuningJob fineTuneResponse = 
+        check openaiFinetunes->/fine_tuning/jobs.post(fineTuneRequest);
+}
+```
+
+### Step 4: Run the Ballerina application
+
+```bash
+bal run
+```
 
 ## Examples
 
 The `OpenAI Finetunes` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/module-ballerinax-openai.finetunes/tree/main/examples/), covering the following use cases:
 
-[//]: # (TODO: Add examples)
+[//]: # (TODO: Add examples)