Skip to content

Commit

Permalink
Remove unnecessary newlines and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
manodyaSenevirathne committed Aug 12, 2024
1 parent 3cb62ff commit ea9d80f
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 15 deletions.
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ To use the OpenAI Connector, you must have access to the OpenAI API through a [O

1. Open the [OpenAI Platform Dashboard](https://platform.openai.com).


2. Navigate to **Dashboard** -> **API keys**.
<img src=/docs/setup/resources/navigate-api-key-dashboard.png alt="Navigate to API key section" style="width: 70%;">

Expand All @@ -33,7 +32,6 @@ To use the OpenAI Connector, you must have access to the OpenAI API through a [O
5. Store the API key securely to use in your application.
<img src=/docs/setup/resources/saved-key.png alt="Generated New API key" style="width: 70%;">


## Quickstart

To use the `OpenAI Chat` connector in your Ballerina application, update the `.bal` file as follows:
Expand Down Expand Up @@ -85,7 +83,6 @@ public function main() returns error? {
};
// Call the API.
CreateChatCompletionResponse response = check openAIChat->/chat/completions.post(request);
}
```
Expand Down
8 changes: 0 additions & 8 deletions ballerina/Module.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ To use the OpenAI Connector, you must have access to the OpenAI API through a [O

1. Open the [OpenAI Platform Dashboard](https://platform.openai.com).


2. Navigate to **Dashboard** -> **API keys**.
<img src=/docs/setup/resources/navigate-api-key-dashboard.png alt="Navigate to API key section" style="width: 70%;">

Expand All @@ -23,12 +22,8 @@ To use the OpenAI Connector, you must have access to the OpenAI API through a [O
<img src=/docs/setup/resources/create-new-secrete-key.png alt="Create New API key" style="width: 70%;">

5. Store the API key securely to use in your application.
<img src=/docs/setup/resources/saved-key.png alt="Generated New API key" style="width: 70%;">on Create secret key.
<img src=/docs/setup/resources/saved-key.png alt="Generated New API key" style="width: 70%;">

5. Store the API key securely to use in your application.


## Quickstart

To use the `OpenAI Chat` connector in your Ballerina application, update the `.bal` file as follows:
Expand Down Expand Up @@ -66,7 +61,6 @@ Now, you can utilize available connector operations.
#### Generate a response for given message

```ballerina
public function main() returns error? {
// Create a chat completion request.
Expand All @@ -80,7 +74,6 @@ public function main() returns error? {
};
// Call the API.
CreateChatCompletionResponse response = check openAIChat->/chat/completions.post(request);
}
```
Expand All @@ -91,7 +84,6 @@ public function main() returns error? {
bal run
```


## Examples

The `OpenAI Chat` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/module-ballerinax-openai.chat/tree/main/examples/), covering the following use cases:
Expand Down
4 changes: 0 additions & 4 deletions ballerina/Package.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ To use the OpenAI Connector, you must have access to the OpenAI API through a [O

1. Open the [OpenAI Platform Dashboard](https://platform.openai.com).


2. Navigate to **Dashboard** -> **API keys**.
<img src=/docs/setup/resources/navigate-api-key-dashboard.png alt="Navigate to API key section" style="width: 70%;">

Expand Down Expand Up @@ -62,7 +61,6 @@ Now, you can utilize available connector operations.
#### Generate a response for given message

```ballerina
public function main() returns error? {
// Create a chat completion request.
Expand All @@ -76,7 +74,6 @@ public function main() returns error? {
};
// Call the API.
CreateChatCompletionResponse response = check openAIChat->/chat/completions.post(request);
}
```
Expand All @@ -87,7 +84,6 @@ public function main() returns error? {
bal run
```


## Examples

The `OpenAI Chat` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/module-ballerinax-openai.chat/tree/main/examples/), covering the following use cases:
Expand Down

0 comments on commit ea9d80f

Please sign in to comment.