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 OpenAI.Builder 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()
AuditLogsClient	auditLogsClient()
BatchClient	batchClient()
ChatClient	chatClient()
EmbeddingsClient	embeddingsClient()
FilesClient	filesClient()
FineTuningClient	fineTuningClient()
ImagesClient	imagesClient()
InvitesClient	invitesClient()
MessagesClient	messagesClient()
ModelsClient	modelsClient()
ModerationsClient	moderationsClient()
static OpenAI.Builder	newBuilder()
static OpenAI.Builder	newBuilder(String apiKey)
ProjectApiKeysClient	projectApiKeysClient()
ProjectsClient	projectsClient()
ProjectServiceAccountsClient	projectServiceAccountsClient()
ProjectUsersClient	projectUsersClient()
RunsClient	runsClient()
RunStepsClient	runStepsClient()
ThreadsClient	threadsClient()
UploadsClient	uploadsClient()
UsersClient	usersClient()
VectorStoreFileBatchesClient	vectorStoreFileBatchesClient()
VectorStoreFilesClient	vectorStoreFilesClient()
VectorStoresClient	vectorStoresClient()

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

batchClient

public BatchClient batchClient()

Returns:

a client based on Batch

filesClient

public FilesClient filesClient()

Returns:

a client based on Files

uploadsClient

public UploadsClient uploadsClient()

Returns:

a client based on Uploads

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

runStepsClient

public RunStepsClient runStepsClient()

Returns:

a client based on Run Steps

vectorStoresClient

public VectorStoresClient vectorStoresClient()

Returns:

a client based on Vector Stores

vectorStoreFilesClient

public VectorStoreFilesClient vectorStoreFilesClient()

Returns:

a client based on Vector Store Files

vectorStoreFileBatchesClient

public VectorStoreFileBatchesClient vectorStoreFileBatchesClient()

Returns:

a client based on Vector Store File Batches

invitesClient

public InvitesClient invitesClient()

Returns:

a client based on Invites

usersClient

public UsersClient usersClient()

Returns:

a client based on Users

projectsClient

public ProjectsClient projectsClient()

Returns:

a client based on Projects

projectUsersClient

public ProjectUsersClient projectUsersClient()

Returns:

a client based on Project Users

projectServiceAccountsClient

public ProjectServiceAccountsClient projectServiceAccountsClient()

Returns:

a client based on Project Service Accounts

projectApiKeysClient

public ProjectApiKeysClient projectApiKeysClient()

Returns:

a client based on Project API Keys

auditLogsClient

public AuditLogsClient auditLogsClient()

Returns:

a client based on Audit Logs

newBuilder

public static OpenAI.Builder newBuilder()

newBuilder

public static OpenAI.Builder newBuilder(String apiKey)

Parameters:

apiKey - the API key used for authentication