Package io.github.stefanbratanov.jvm.openai

Class OpenAI

java.lang.Object

io.github.stefanbratanov.jvm.openai.OpenAI

public final class OpenAI
extends Object

A class which when created using the newBuilder(String) can be used to create clients based on the endpoints defined at API Reference - OpenAI API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAI.Builder

Method Summary

Modifier and Type	Method	Description
AssistantsClient	assistantsClient()
AudioClient	audioClient()
ChatClient	chatClient()
EmbeddingsClient	embeddingsClient()
FilesClient	filesClient()
FineTuningClient	fineTuningClient()
ImagesClient	imagesClient()
MessagesClient	messagesClient()
ModelsClient	modelsClient()
ModerationsClient	moderationsClient()
static OpenAI.Builder	newBuilder(String apiKey)
RunsClient	runsClient()
ThreadsClient	threadsClient()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

audioClient

public AudioClient audioClient()

Returns:

a client based on Audio

chatClient

public ChatClient chatClient()

Returns:

a client based on Chat

embeddingsClient

public EmbeddingsClient embeddingsClient()

Returns:

a client based on Embeddings

fineTuningClient

public FineTuningClient fineTuningClient()

Returns:

a client based on Fine-tuning

filesClient

public FilesClient filesClient()

Returns:

a client based on Files

imagesClient

public ImagesClient imagesClient()

Returns:

a client based on Images

modelsClient

public ModelsClient modelsClient()

Returns:

a client based on Models

moderationsClient

public ModerationsClient moderationsClient()

Returns:

a client based on Moderations

assistantsClient

public AssistantsClient assistantsClient()

Returns:

a client based on Assistants

threadsClient

public ThreadsClient threadsClient()

Returns:

a client based on Threads

messagesClient

public MessagesClient messagesClient()

Returns:

a client based on Messages

runsClient

public RunsClient runsClient()

Returns:

a client based on Runs

newBuilder

public static OpenAI.Builder newBuilder(String apiKey)

Parameters:

apiKey - the API key used for authentication