Package-level declarations
Types
Build assistants that can call models and use tools to perform tasks.
Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position.
Manages hosted containers and their files. Container creation can incur hosted resource charges. Default implementations preserve source compatibility for custom clients.
Checks image/audio uploads for supported OpenAI provenance signals.
Manage persisted conversations and their items. Deleting a conversation does not delete its items.
Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
Manage fine-tuning jobs to tailor a model to your specific training data.
Shares checkpoint models between projects. All operations require an Admin API key.
Scoped Live primary, sideband or fork WebSocket. Device audio and media processing belong to the caller.
Defines the configuration parameters for logging.
Classifies text and images against OpenAI's content policy.
OpenAI API.
Organization management client. Use an Admin API key, separately from application credentials.
OpenAI client configuration.
A class to configure the OpenAI host. It provides a mechanism to customize the base URL and additional query parameters used in OpenAI API requests.
Organization identity and project management using an Admin API key.
Organization governance operations requiring an Admin API credential. Default methods support custom clients.
Manages organization and project hard spend limits and notification alerts using an Admin API key. Default operations throw UnsupportedOperationException so custom clients can omit this capability.
Reads organization usage and cost reports using an Admin API key.
Proxy configuration.
Scoped bidirectional GA Realtime connection. Audio capture/playback and media encoding belong to the caller.
A scoped Responses WebSocket. Keep one event collector active while sending successive turns.
Specifies the retry strategy
Upload files in parts, then assemble them into a regular file. Default methods throw UnsupportedOperationException so custom OpenAI implementations remain source compatible. Clients created by the SDK implement all operations.
Vector stores are used to store files for use by the file_search tool.
Manages saved custom voices and consent recordings in the authenticated project. Default operations throw UnsupportedOperationException, allowing existing custom clients to omit this capability.
Functions
Observes HTTP status and response headers for every response received by this client, including error responses, retries, and redirects, before decoding or streaming the body. A transport failure or cancellation before receiving a response does not invoke observer.
Creates an instance of OpenAI.
Creates an administration client; OpenAIConfig.token must authorize the requested admin operations.
Creates an administration client with the supplied Admin API key.