README.md

Ballerina OpenAI Audio connector

Overview

OpenAI, a leading AI research organization focused on creating friendly AI for humanity, provides the OpenAI API to access its powerful AI models for tasks like natural language processing and image generation.

The ballarinax/openai.audio package offers APIs to connect and interact with audio related endpoints of OpenAI REST API v1 providing access to various models developed by OpenAI for audio-related tasks.

Setup guide

To use the OpenAI Connector, you must have access to the OpenAI API through a OpenAI Platform account and a project under it. If you do not have a OpenAI Platform account, you can sign up for one here.

Create a OpenAI API Key

1. Open the OpenAI Platform Dashboard.

2. Navigate to Dashboard -> API keys

3. Click on the "Create new secret key" button

4. Fill the details and click on Create secret key

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

Quickstart

To use the OpenAI Audio connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module

Import the openai.audio module.

import ballerinax/openai.audio;

Step 2: Instantiate a new connector

Create a audio:ConnectionConfig with the obtained API Key and initialize the connector.

configurable string token = ?;

final images:Client openAIAudio = check new ({
    auth: {
        token
    }
});

Step 3: Invoke the connector operation

Now, utilize the available connector operations.

Transcribe audio into input language

public function main(string fileName) returns error? {
    byte[] fileContent = check io:fileReadBytes(fileName);
    audio:CreateTranscriptionRequest request = {
        model: "whisper-1",
        file: {fileContent, fileName}
    };

    audio:CreateTranscriptionResponse response =
        check OpenAIAudio->/audio/transcriptions.post(request);
}

Step 4: Run the Ballerina application

bal run

Examples

The OpenAI Audio connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

1. International news translator - Converts a text news given in any language to english
2. Meeting transcriber and translator - Converts an audio given in a different language into text in input language and english

Build from the source

Setting up the prerequisites

1. Download and install Java SE Development Kit (JDK) version 17. You can download it from either of the following sources:

   • Oracle JDK
   • OpenJDK

   Note: After installation, remember to set the JAVA_HOME environment variable to the directory where JDK was installed.

2. Download and install Ballerina Swan Lake.

3. Download and install Docker.

   Note: Ensure that the Docker daemon is running before executing any tests.

4. Export Github Personal access token with read package permissions as follows,

   export packageUser=<Username>
   export packagePAT=<Personal access token>

Build options

Execute the commands below to build from the source.

1. To build the package:

   ./gradlew clean build

2. To run the tests:

   ./gradlew clean test

3. To build the without the tests:

   ./gradlew clean build -x test

4. To run tests against different environments:

   ./gradlew clean test -Pgroups=<Comma separated groups/test cases>

5. To debug the package with a remote debugger:

   ./gradlew clean build -Pdebug=<port>

6. To debug with the Ballerina language:

   ./gradlew clean build -PbalJavaDebug=<port>

7. Publish the generated artifacts to the local Ballerina Central repository:

   ./gradlew clean build -PpublishToLocalCentral=true

8. Publish the generated artifacts to the Ballerina Central repository:

   ./gradlew clean build -PpublishToCentral=true

Contribute to Ballerina

As an open-source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All the contributors are encouraged to read the Ballerina Code of Conduct.

Useful links

• For more information go to the openai.audio package.
• For example demonstrations of the usage, go to Ballerina By Examples.
• Chat live with us via our Discord server.
• Post all technical questions on Stack Overflow with the #ballerina tag.