ballerinax/openai.moderations Ballerina library

1.0.1

Overview

This is a generated connector for the OpenAI moderations API OpenAPI Specification. OpenAI is an American artificial intelligence research laboratory consisting of a non-profit corporation and a for-profit subsidiary. OpenAI conducts AI research with the declared intention of promoting and developing friendly AI. The OpenAI Moderations API provides a way to access new moderation models developed by OpenAI for content moderation tasks.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quick start

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

Step 1: Import the connector

First, import the ballerinax/openai.moderations module into the Ballerina project.

Copy
import ballerinax/openai.moderations;
import ballerina/io;

Step 2: Create a new connector instance

Create and initialize a moderations:Client with the obtained apiKey.

Copy
moderations:Client moderationsClient = check new ({
    auth: {
        token: "sk-XXXXXXXXX"
    }
});

Step 3: Invoke the connector operation

  1. Now you can use the operations available within the connector.

    Following is an example on identifying harmful content using the OpenAI moderations model:

    Moderate with Text Moderation model

    Copy
    public function main() returns error? {
        moderations:CreateModerationRequest createModerationRequest = {
            input: "I want to kill them.",
            model: "text-moderation-stable"
        };
    
        moderations:CreateModerationResponse|error unionResult = check moderationsClient->/moderations.post(createModerationRequest);
    
        if unionResult is moderations:CreateModerationResponse {
            io:println(unionResult);
        } else {
            io:println(unionResult);
        }
    }
  2. Use the bal run command to compile and run the Ballerina program.

Sample

Copy
import ballerinax/openai.moderations;
import ballerina/io;

moderations:Client moderationsClient = check new ({
    auth: {
        token: "sk-XXXXXXXXX"
    }
});

public function main() returns error? {
    moderations:CreateModerationRequest createModerationRequest = {
        input: "I want to kill them.",
        model: "text-moderation-stable"
    };

    moderations:CreateModerationResponse|error unionResult = check moderationsClient->/moderations.post(createModerationRequest);

    if unionResult is moderations:CreateModerationResponse {
        io:println(unionResult);
    } else {
        io:println(unionResult);
    }
}

Import

import ballerinax/openai.moderations;Copy

Metadata

Released date: over 1 year ago

Version: 1.0.1

License: Apache-2.0


Compatibility

Platform: any

Ballerina version: 2201.4.0

GraalVM compatible: Yes


Pull count

Total: 0

Current verison: 2


Weekly downloads


Source repository


Keywords

AI/OpenAI

Cost/Paid

Text moderations

OpenAI moderations


Contributors

Other versions

See more...