Module azure.openai.chat
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_azure.openai.chat_1.0.1.png)
ballerinax/azure.openai.chat Ballerina library
Overview
This is a generated connector from Azure OpenAI Chat Completions API OpenAPI specification.
The Azure Azure OpenAI Service REST API Chat Completions Endpoint will create completions for chat messages with the ChatGPT (preview) and GPT-4 (preview) models.
Prerequisites
- Create an Azure account
- Create an Azure OpenAI resource
- Deploy an appropriate model within the resource by referring to Deploy a model guide
- Obtain tokens by following Azure OpenAI Authentication guide
Quickstart
To use the Azure OpenAI Chat connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
Import the ballerinax/azure.openai.chat
module into the Ballerina project.
import ballerinax/azure.openai.chat; import ballerina/io;
Step 2: Create a new connector instance
Create and initialize a chat:Client
with the obtained apiKey
and a serviceUrl
containing the deployed models.
final chat:Client chatClient = check new ( config = {auth: {apiKey: apiKey}}, serviceUrl = serviceUrl );
Step 3: Invoke connector operation
-
Now you can use the operations available within the connector.
Note: These operations are in the form of remote operations.
Following is an example of creating a conversation with an OpenAI gpt-35-turbo model:
public function main() returns error? { final chat:Client chatClient = check new ( config = {auth: {apiKey: apiKey}}, serviceUrl = serviceUrl ); chat:Chat_completions_body chatBody = { messages: [{role: "user", content: "What is Ballerina?"}] }; chat:Inline_response_200 chatResult = check chatClient->/deployments/["chat"]/chat/completions.post("2023-03-15-preview", chatBody); io:println(chatResult); }
-
Use
bal run
command to compile and run the Ballerina program.