openai-client-java

OpenAI client for Java, replicates the official Python client.

This library does not support legacy and/or deprecated APIs by OpenAI

Download

Step 1. Add the JitPack repository to your build file

Add it in your root build.gradle at the end of repositories:

allprojects {
  repositories {
    ...
    maven { url 'https://jitpack.io' }
  }
}

Step 2. Add the dependency

dependencies {
  compile 'com.salvadormontiel:openai-client-java:0.0.6'
}

How to use it?

Chat completion

var client = new OpenAI(System.getenv("OPENAI_API_KEY"));

var messages = new ArrayList<ChatMessage>();
messages.add(
        new ChatMessage.Builder()
                .asSystemRole()
                .setContent("You are a helpful assistant.")
                .build()
);
messages.add(
        new ChatMessage.Builder()
                .asUserRole()
                .setContent("count to 10, each number in a new line")
                .build()
);

var input = new ChatCompletionInput.Builder()
        .setModel("gpt-3.5-turbo")
        .setMessages(messages)
        .build();

var completion = client.chat().completions().create(input);
System.out.println(completion.choices.get(0).message.content);

Streaming chat completion

var client = new OpenAI(System.getenv("OPENAI_API_KEY"));

var messages = new ArrayList<ChatMessage>();
messages.add(
        new ChatMessage.Builder()
                .asSystemRole()
                .setContent("You are a helpful assistant.")
                .build()
);
messages.add(
        new ChatMessage.Builder()
                .asUserRole()
                .setContent("count to 10, each number in a new line")
                .build()
);

var input = new ChatCompletionInput.Builder()
        .setModel("gpt-3.5-turbo")
        .setMessages(messages)
        .setStream(true)
        .build();

var completion = client.chat().completions().createAsStream(input);

completion.subscribe(new Flow.Subscriber<>() {
    private Flow.Subscription subscription;

    @Override
    public void onSubscribe(Flow.Subscription subscription) {
        this.subscription = subscription;
        subscription.request(1);
    }

    @Override
    public void onNext(ChatCompletionChunk chunk) {
        String content = chunk.choices.get(0).delta.content;
        if (content != null) System.out.print(content);

        subscription.request(1);
    }

    @Override
    public void onError(Throwable throwable) {
        throwable.printStackTrace();
    }

    @Override
    public void onComplete() {}
});

Function calling

public enum WeatherUnit {
    CELSIUS, FAHRENHEIT;
}

public class Weather implements FunctionProperties {
    @PropertyDetails(description = "The city and state, e.g. San Francisco, CA", required = true)
    public String location;

    public WeatherUnit unit;
}

var client = new OpenAI(System.getenv("OPENAI_API_KEY"));

FunctionExecutor executor = new FunctionExecutor();
executor.addFunction(
        "get_current_weather",
        "Get the current weather in a given location",
        Weather.class,
        weather -> {
            var unit = weather.unit != null ? weather.unit : WeatherUnit.CELSIUS;
            var temperature = new Random().nextInt(45);
            var w = temperature < 15 ? "cold" : (temperature < 35 ? "sunny" : "drought");
            var apiResponse = "City " + weather.location + ", " + temperature + "° " + unit + ", weather: " + w;
            System.out.println("\nWeather API response: " + apiResponse);

            return apiResponse;
        });

var question = "What's the weather like in Boston today?";
System.out.println("Question: " + question);

var input = new ChatCompletionInput.Builder()
        .setModel("gpt-3.5-turbo")
        .addMessage(
                new ChatMessage.Builder()
                        .asUserRole()
                        .setContent(question)
                        .build()
        )
        .setTools(executor.getTools())
        .build();
var completion = client.chat().completions().create(input, executor);

System.out.println("\n> " + completion.choices.get(0).message.content);

Generate image

var client = new OpenAI(System.getenv("OPENAI_API_KEY"));

var input = new ImageInput.Builder()
        .setModel("dall-e-3")
        .setPrompt("A cute baby sea otter")
        .setN(1)
        .setSize("1024x1024")
        .build();
var response = client.images().generate(input);
System.out.println(response.data.get(0).url);
System.out.println(response.data.get(0).revisedPrompt);

Create edited image

var client = new OpenAI(System.getenv("OPENAI_API_KEY"));

var image = Paths.get("sample-files/indoor-image.png");
var mask = Paths.get("sample-files/indoor-mask.png");

var input = new ImageEditInput.Builder()
        .setImage(image)
        .setMask(mask)
        .setModel("dall-e-2")
        .setPrompt("A sunlit indoor lounge area with a pool containing a car")
        .setN(1)
        .setSize("1024x1024")
        .build();
var response = client.images().edit(input);
System.out.println(response.data.get(0).url);

Create image variation

var client = new OpenAI(System.getenv("OPENAI_API_KEY"));

var image = Paths.get("sample-files/indoor-image.png");

var input = new ImageVariationInput.Builder()
        .setImage(image)
        .setModel("dall-e-2")
        .setN(1)
        .setSize("1024x1024")
        .build();
var response = client.images().createVariation(input);
System.out.println(response.data.get(0).url);

Create audio speech

var client = new OpenAI(System.getenv("OPENAI_API_KEY"));

var input = new SpeechInput.Builder()
        .setModel("tts-1")
        .setInput("The quick brown fox jumped over the lazy dog.")
        .setVoice("alloy")
        .build();
var file = client.audio().speech().create(input);
System.out.println(file.toAbsolutePath());

Create transcription

var client = new OpenAI(System.getenv("OPENAI_API_KEY"));

Path localFile = Paths.get("sample-files/speech.mp3");
var input = new TranscriptionInput.Builder()
        .setModel("whisper-1")
        .setFile(localFile)
        .build();
var transcription = client.audio().transcriptions().create(input);
System.out.println(transcription.text);

Create translation

var client = new OpenAI(System.getenv("OPENAI_API_KEY"));

Path localFile = Paths.get("sample-files/speech.mp3");
var input = new TranslationInput.Builder()
        .setModel("whisper-1")
        .setFile(localFile)
        .setResponseFormat("json")
        .build();
var transcription = client.audio().translations().create(input);
System.out.println(transcription.text);

Create embeddings

var client = new OpenAI(System.getenv("OPENAI_API_KEY"));

var input = new EmbeddingsInput.Builder()
        .setInput("The food was delicious and the waiter...")
        .setModel("text-embedding-ada-002")
        .setEncodingFormat("float")
        .build();

var embeddings = client.embeddings().create(input);
System.out.println(embeddings);

Supported APIs

• Audio
  • Create speech
  • Create transcription
  • Create translation
  • Function calling
• Chat
  • Create chat completion
  • Stream chat completion
• Embeddings
  • Create embeddings
• Fine-tuning
  • Create fine-tuning job
  • List fine-tuning jobs
  • List fine-tuning events
  • List fine-tuning checkpoints
  • Retrieve fine-tuning job
  • Cancel fine-tuning
• Batch
  • Create batch
  • Retrieve batch
  • Cancel batch
  • List batch
• Files
  • Upload file
  • List files
  • Retrieve file
  • Delete file
• Images
  • Create image
  • Create image edit
  • Create image variation
• Models
  • List models
  • Retrieve model
  • Delete a fine-tuned model
• Moderations
  • Create moderation

Beta APIs

• Assistants
  • Create assistant
  • List assistants
  • Retrieve assistant
  • Modify assistant
  • Delete assistant
• Threads
  • Create thread
  • Retrieve thread
  • Modify thread
  • Delete thread
• Messages
  • Create message
  • List messages
  • Retrieve message
  • Modify message
• Runs
  • Create run
  • Create thread and run
  • List runs
  • Retrieve run
  • Modify run
  • Submit tool outputs to run
  • Cancel a run
• Run Steps
  • List run steps
  • Retrieve run step
• Vector Stores
  • Create vector store
  • List vector stores
  • Retrieve vector store
  • Modify vector store
  • Delete vector store
• Vector Store Files
  • Create vector store file
  • List vector store files
  • Delete vector store file
• Vector Store File Batches
  • Create vector store file batch
  • Retrieve vector store file batch
  • Cancel vector store file batch
  • List vector store files in a batch

Contributing

Do you want to contribute or give me a hand a hand with the documentation? I will appreciate that!