ballerinax/openai.audio Ballerina library

Overview

OpenAI, an AI research organization focused on creating friendly AI for humanity, offers 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