Package io.github.sashirestela.openai

Class SimpleOpenAI

java.lang.Object

io.github.sashirestela.openai.base.OpenAIProvider

io.github.sashirestela.openai.SimpleOpenAI

All Implemented Interfaces:

AssistantServices, AudioServices, BatchServices, ChatCompletionServices, CompletionServices, EmbeddingServices, FileServices, FineTunningServices, ImageServices, ModelServices, ModerationServices, RealtimeServices, ResponseServices, SessionServices, UploadServices

public class SimpleOpenAI
extends OpenAIProvider
implements AssistantServices, AudioServices, BatchServices, ChatCompletionServices, CompletionServices, EmbeddingServices, FileServices, FineTunningServices, ImageServices, ModelServices, ModerationServices, RealtimeServices, SessionServices, UploadServices, ResponseServices

The standard OpenAI implementation which implements the full services.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	SimpleOpenAI.StandardConfigurator

Field Summary

Fields inherited from class io.github.sashirestela.openai.base.OpenAIProvider

cleverClient, realtime

Constructor Summary

Constructors

Constructor	Description
SimpleOpenAI(@NonNull String apiKey, String organizationId, String projectId, String baseUrl, HttpClient httpClient, io.github.sashirestela.cleverclient.client.HttpClientAdapter clientAdapter, io.github.sashirestela.cleverclient.retry.RetryConfig retryConfig, com.fasterxml.jackson.databind.ObjectMapper objectMapper, RealtimeConfig realtimeConfig)	Constructor used to generate a builder.

Method Summary

Modifier and Type	Method	Description
OpenAIBeta2.Assistants	assistants()
OpenAI.Audios	audios()
OpenAI.Batches	batches()
OpenAI.ChatCompletions	chatCompletions()
OpenAI.Completions	completions()
OpenAI.Embeddings	embeddings()
OpenAI.Files	files()
OpenAI.FineTunings	fineTunings()
OpenAI.Images	images()
OpenAI.Models	models()
OpenAI.Moderations	moderations()
OpenAIRealtime	realtime()
OpenAI.Responses	responses()
OpenAI.SessionTokens	sessionTokens()
OpenAIBeta2.ThreadMessages	threadMessages()
OpenAIBeta2.ThreadRuns	threadRuns()
OpenAIBeta2.ThreadRunSteps	threadRunSteps()
OpenAIBeta2.Threads	threads()
OpenAI.Uploads	uploads()
OpenAIBeta2.VectorStoreFileBatches	vectorStoreFileBatches()
OpenAIBeta2.VectorStoreFiles	vectorStoreFiles()
OpenAIBeta2.VectorStores	vectorStores()

Methods inherited from class io.github.sashirestela.openai.base.OpenAIProvider

getOrCreateService, shutDown

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleOpenAI

public SimpleOpenAI(@NonNull
                    @NonNull String apiKey,
                    String organizationId,
                    String projectId,
                    String baseUrl,
                    HttpClient httpClient,
                    io.github.sashirestela.cleverclient.client.HttpClientAdapter clientAdapter,
                    io.github.sashirestela.cleverclient.retry.RetryConfig retryConfig,
                    com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                    RealtimeConfig realtimeConfig)

Constructor used to generate a builder.

Parameters:

apiKey - Identifier to be used for authentication. Mandatory.

organizationId - Organization's id to be charged for usage. Optional.

projectId - Project's id to provide access to a single project. Optional.

baseUrl - Host's url, If not provided, it'll be 'https://api.openai.com'. Optional.

httpClient - A HttpClient object. One is created by default if not provided. Optional. Deprecated in favor of clientAdapter.

clientAdapter - Component to make http services. If none is passed the JavaHttpClientAdapter will be used. Optional.

retryConfig - Configuration for request retrying. If not provided, default values will be used. Optional.

objectMapper - Provides Json conversions either to and from objects. Optional.

realtimeConfig - Configuration for websocket Realtime API. Optional.

Method Detail

audios

public OpenAI.Audios audios()

Specified by:

audios in interface AudioServices

batches

public OpenAI.Batches batches()

Specified by:

batches in interface BatchServices

chatCompletions

public OpenAI.ChatCompletions chatCompletions()

Specified by:

chatCompletions in interface ChatCompletionServices

completions

public OpenAI.Completions completions()

Specified by:

completions in interface CompletionServices

embeddings

public OpenAI.Embeddings embeddings()

Specified by:

embeddings in interface EmbeddingServices

files

public OpenAI.Files files()

Specified by:

files in interface FileServices

fineTunings

public OpenAI.FineTunings fineTunings()

Specified by:

fineTunings in interface FineTunningServices

images

public OpenAI.Images images()

Specified by:

images in interface ImageServices

models

public OpenAI.Models models()

Specified by:

models in interface ModelServices

moderations

public OpenAI.Moderations moderations()

Specified by:

moderations in interface ModerationServices

uploads

public OpenAI.Uploads uploads()

Specified by:

uploads in interface UploadServices

sessionTokens

public OpenAI.SessionTokens sessionTokens()

Specified by:

sessionTokens in interface SessionServices

responses

public OpenAI.Responses responses()

Specified by:

responses in interface ResponseServices

assistants

public OpenAIBeta2.Assistants assistants()

Specified by:

assistants in interface AssistantServices

threads

public OpenAIBeta2.Threads threads()

Specified by:

threads in interface AssistantServices

threadMessages

public OpenAIBeta2.ThreadMessages threadMessages()

Specified by:

threadMessages in interface AssistantServices

threadRuns

public OpenAIBeta2.ThreadRuns threadRuns()

Specified by:

threadRuns in interface AssistantServices

threadRunSteps

public OpenAIBeta2.ThreadRunSteps threadRunSteps()

Specified by:

threadRunSteps in interface AssistantServices

vectorStores

public OpenAIBeta2.VectorStores vectorStores()

Specified by:

vectorStores in interface AssistantServices

vectorStoreFiles

public OpenAIBeta2.VectorStoreFiles vectorStoreFiles()

Specified by:

vectorStoreFiles in interface AssistantServices

vectorStoreFileBatches

public OpenAIBeta2.VectorStoreFileBatches vectorStoreFileBatches()

Specified by:

vectorStoreFileBatches in interface AssistantServices

realtime

public OpenAIRealtime realtime()

Specified by:

realtime in interface RealtimeServices