All Classes

Class	Description
AccuracyStage	Configures temperature, topP, penalties and seed.
ActionTypeStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>	A stage to choose the Images related action desired Current version includes following possibilities: Creating images Editing images Generating images variations
AIModelStage	A stage to choose a model supported by /v1/chat/completions model endpoint compatibility .
AIModelStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage>	A stage to choose a model supported by /v1/chat/completions model endpoint compatibility .
AIModelStage	A stage to choose a model supported by /v1/chat/completions model endpoint compatibility .
AIModelStage	A stage to choose a model supported by /v1/audio/speech model endpoint compatibility .
AIModelStage	A stage to choose a model supported by /v1/audio/transcriptions model endpoint compatibility .
AIModelStage	A stage to choose a model supported by /v1/audio/translations model endpoint compatibility .
AsyncApi<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>	Reactive API to add a final instruction and proceed with the HTTP call.
AsyncContextStage	Async context to choose between raw response or just a simple string answer.
AsyncDownloadStage	Configures target folder
AsyncExecutor<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>	Promise abstraction.
AsyncPromise	Promise abstraction.
AsyncPromise	Async promise to choose between raw response or just a simple string answer.
AsyncPromiseStage	Registers callbacks
AsyncPromiseStage	Registers callbacks and sends request
AsyncPromiseStage	Registers callbacks and sends request
AsyncPromptStage	Sends calls to OpenAI API with the already defined callbacks, and possibly with prompt.
AsyncPromptStage	Registers text input
AsyncPromptStage	Registers user input optionally
AsyncPromptStage	Registers user input optionally
AsyncRawPromise	Promise abstraction.
AudioFileStage	Configures which audio file to transcribe
AudioFileStage	Configures which audio file to translate
Authenticator
Chat	Entrypoint for Chat Completions API. The interaction starts by configuring the HTTP connection either by providing a preconfigured ChatHttpExecutor http client, HttpExecutorContext, SdkAuth or leave it to Chat.defaults().
ChatConfigurationStage	Base for all Chat stages
ChatRuntimeSelectionStage	Configures how the HTTP client to act.
ChoicesStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage>	A stage to choose the number of the images generated.
ColorDeviation
CreatingActionTypeStage	Explicit marker action type stage for flows where only creating is possible E.g.
Dalle2SizeStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage>	A stage to choose the dimensions of the image generated supported by dall-e-2
Dalle3SizeStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage>	A stage to choose the dimensions of the image generated supported by dall-e-3
DownloadExecutor	An internal executor used to handle the files download
DownloadExecutor	Utility to download files with random names to a given folder
DownloadExecutor.Streams
EditingActionTypeStage	Explicit marker action type stage for flows where only editing is possible E.g.
EditingMaskStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage>	A stage to specify the editable areas of the image.
FormatStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage>	A stage to choose the format of the response images
FormatStage	Configures the format of the output file
FormatStage	Configures the format of the output file
FromDeveloper	Use this for manually passing the credentials and still conforming the SdkAuth contract.
FromEnvironment	When instantiated and FromEnvironment.credentials() is called, series of environment variables will be scanned to provide necessary ApiCredentials.
FromJson	When instantiated and FromJson.credentials() is called, already configured json file is scanned for credentials.
FromJson.AvailableKeys
HttpBuilder<T>	Default usage is to configure the HTTP connection and serialization / deserialization methods using ObjectMapper.
ImageChooserOrSkipStage	Either inputs more images and goes back to ImageDetailStage or goes further to select a runtime.
ImageChooserStage	Configures image either as a file or base64 encoded one
ImageConfigurationStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>	Base for all Image stages
ImageDetailStage	Configures the DetailedAnalyze
Images<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>	Entrypoint for Images API, supporting Creating, Editing/a>, and Variating. The interaction starts by configuring the HTTP connection either by providing a preconfigured http client - CreateImageHttpExecutor, EditImageHttpExecutor and ImageVariationHttpExecutor respectively, HttpExecutorContext, SdkAuth or leave it to Images.defaults().
ImagesPromptStage<E extends RuntimeExecutor>
ImagesTerminalStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage>	Marker stage for finishing the configurations of the prompt.
ImmediateContextStage	Synchronous context to choose between raw response or just a simple string answer.
IntermediateStage	Marker Interface for all stages that are not TerminalStage
LanguageStage	Tells the OpenAI API in which language the voice in the audio file is.
ManualConfigurationStage	Configures tokens, tools and accuracy/
MessageStage	Configures messages such as system and assistant messages.
NotValidAuthenticationMethod	Usually thrown by SdkAuth if integral parts of the authentication are missing.
OutputStage	Configures the output format
PopularColor
PreSimplifiedStage	Sets audio file for transcription, before all other autoconfiguration.
PreSimplifiedStage	Sets audio file for translation, before all other autoconfiguration.
Processing	Processing type.
PromptfulImagesRuntimeSelectionStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>	Configures how the HTTP client to act.
PromptlessImagesRuntimeSelectionStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>	Configures how the HTTP client to act.
QualityStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage>	A stage to choose the quality of the images generated.
ReactiveApi<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>	Reactive API to add a final instruction and proceed with the HTTP call.
ReactiveContextStage	Reactive context to choose between raw response or just a simple string answer.
ReactiveDownloadStage	Configures target folder
ReactiveExecutor<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>	Reactive context to choose if the response image should be automatically downloaded or just delivered.
ReactivePromptStage	Sends calls to OpenAI API in a reactive fashion
ReactivePromptStage	Registers text input
ReactivePromptStage	Registers text input optionally
ReactivePromptStage	Registers text input optionally
RuntimeExecutor	Marker interface for stages that send requests on behalf of a runtime - synchronously, asynchronously or reactive.
RuntimeSelectionStage	Defines all the ways the underlying runtime should act.
SdkAuth	This interface provider an instance of ApiCredentials It can have multiple implementations according to the way the api key is provided to the application As easy for implementation it is, this library provides the following default implementation for immediate usage: FromDeveloper FromEnvironment FromJson As this is a FunctionalInterface it can also be implemented as a lambda (supplier) in the notation of
SimplifiedStage	A simplified stage where some things such as AI Model Type and creativity are already configured.
SimplifiedStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage>	A simplified stage where some things such as AI Model Type and creativity are already configured.
SimplifiedStage	A simplified stage where some things such as AI Model Type and tokens are already configured.
SimplifiedStage	Preconfigured stage with AI Model, speaker, format and speed
SimplifiedStage	Simplifies configuration with already configured AI Model, temperature, language and output format;
SimplifiedStage	Simplifies configuration with already configured AI Model, temperature and output format;
Speech	Entrypoint for Speech API. The interaction starts by configuring the HTTP connection either by providing a preconfigured SpeechHttpExecutor http client, HttpExecutorContext, SdkAuth or leave it to Speech.defaults().
SpeechConfigurationStage	Base for all Speech stages
SpeechRuntimeSelectionStage	Configures how the HTTP client to act.
SpeedStage	Configures the speed of the output audio file
StartStage
StringUtil
StyleStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage>	A stage to choose the style of the images generated.
SynchronousApi<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>	Synchronous API to add a final instruction and proceed with the HTTP call.
SynchronousDownloadStage	Sends blocking requests to OpenAI API
SynchronousExecutor<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>	Synchronous context to choose between raw response, just a simple string answer, or an image download
SynchronousPromptStage	Synchronous context to choose between raw response or just a simple string answer.
SynchronousPromptStage	Adds user input and proceeds to blocking execution
SynchronousPromptStage
SynchronousPromptStage	Sends blocking requests to OpenAI API with given user supplied prompt
TemperatureStage	Configures the temperature or in other words, the creativity of the model.
TemperatureStage	Configures the temperature or in other words, the creativity of the model.
TemperatureStage	Configures the temperature or in other words, the creativity of the model.
TerminalStage	Stages which provide the ability to bypass further configurations and go to selecting a runtime.
TokenStage	Configures maxTokens, N(choices) and stop.
TokenStage	Configures maxTokens
ToolStage	Configures tools such as functions.
Transcription	Entrypoint for Transcription API. The interaction starts by configuring the HTTP connection either by providing a preconfigured TranscriptionHttpExecutor http client, HttpExecutorContext, SdkAuth or leave it to Transcription.defaults().
TranscriptionConfigurationStage	Base for all Transcription stages
TranscriptionRuntimeSelectionStage	Configures how the HTTP client to act.
Translation	Entrypoint for Translation API. The interaction starts by configuring the HTTP connection either by providing a preconfigured TranslationHttpExecutor http client, HttpExecutorContext, SdkAuth or leave it to Translation.defaults().
TranslationConfigurationStage	Base for all Translation stages
TranslationRuntimeSelectionStage	Configures how the HTTP client to act.
VariatingActionTypeStage	Explicit marker action type stage for flows where only creating variations is possible E.g.
Vision	Entrypoint for Vision API. The interaction starts by configuring the HTTP connection either by providing a preconfigured VisionHttpExecutor http client, HttpExecutorContext, SdkAuth or leave it to Vision.defaults().
VisionConfigurationStage
VisionRuntimeSelectionStage
VoiceStage	Configures which person's voice to use