Home

Awesome

Ballerina OpenAI Images connector

Build Trivy GraalVM Check GitHub Last Commit GitHub Issues

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.images package offers APIs to connect and interact with OpenAI REST API v1 providing access to the new DALL.E models developed by OpenAI for various image-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.

  1. Open the OpenAI Platform Dashboard.

  2. Navigate to Dashboard -> API keys <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-openai.images/main/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/ballerina-platform/module-ballerinax-openai.images/main/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/ballerina-platform/module-ballerinax-openai.images/main/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/ballerina-platform/module-ballerinax-openai.images/main/docs/setup/resources/saved-key.png alt="OpenAI Platform" style="width: 70%;">

Quickstart

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

Step 1: Import the module

Import the openai.images module.

import ballerinax/openai.images;

Step 2: Instantiate a new connector

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

configurable string token= ?;

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

Step 3: Invoke the connector operation

Now, utilize the available connector operations.

Generate a image

public function main() returns error? {

    images:CreateImageRequest request = { 
        prompt: "A cute baby sea otter",        
        model: "dall-e-3",
        n: 1,
        size: "1024x1024",
        response_format: "url"        
    };

    images:ImagesResponse response = check openAIImages->/images/generations.post(request);
}

Step 4: Run the Ballerina application

bal run

Examples

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

  1. Personalized visual content generator - Create personalized visual content for targeted email marketing by generating and editing images to include specific products.

  2. Rapid product visualizer - Generate and vary product images for client presentations to showcase different design options and aid decision-making.

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:

    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