Constructor Detail

• OpenAIClientImpl

  OpenAIClientImpl(ClientOptions clientOptions)

Method Detail

• async

   OpenAIClientAsync async()

  Returns a version of this client that uses asynchronous execution.

  The returned client shares its resources, like its connection pool and thread pools, with this client.

• withRawResponse

   OpenAIClient.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   OpenAIClient withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• completions

   CompletionService completions()

  Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position.

• chat

   ChatService chat()

• embeddings

   EmbeddingService embeddings()

  Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.

• files

   FileService files()

  Files are used to upload documents that can be used with features like Assistants and Fine-tuning.

• images

   ImageService images()

  Given a prompt and/or an input image, the model will generate a new image.

• audio

   AudioService audio()

• moderations

   ModerationService moderations()

  Given text and/or image inputs, classifies if those inputs are potentially harmful.

• models

   ModelService models()

  List and describe the various models available in the API.

• fineTuning

   FineTuningService fineTuning()

• graders

   GraderService graders()

• vectorStores

   VectorStoreService vectorStores()

• webhooks

   WebhookService webhooks()

• beta

   BetaService beta()

• batches

   BatchService batches()

  Create large batches of API requests to run asynchronously.

• uploads

   UploadService uploads()

  Use Uploads to upload large files in multiple parts.

• responses

   ResponseService responses()

• realtime

   RealtimeService realtime()

• conversations

   ConversationService conversations()

  Manage conversations and conversation items.

• evals

   EvalService evals()

  Manage and run evals in the OpenAI platform.

• containers

   ContainerService containers()

• skills

   SkillService skills()

• videos

   VideoService videos()

• close

   Unit close()

  Closes this client, relinquishing any underlying resources.

  This is purposefully not inherited from AutoCloseable because the client is long-lived and usually should not be synchronously closed via try-with-resources.

  It's also usually not necessary to call this method at all. the default HTTP client automatically releases threads and connections if they remain idle, but if you are writing an application that needs to aggressively release unused resources, then you may call this method.