Index (openai-api-sdk 0.8.1.BETA-JDK17 API)

A B C D E F G H I J L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Serialized Form

A

accuracy() - Method in class bg.codexio.ai.openai.api.sdk.chat.ManualConfigurationStage: Configures temperature, topP and penalties.
AccuracyStage - Class in bg.codexio.ai.openai.api.sdk.chat: Configures temperature, topP, penalties and seed.
ActionTypeStage<R> - Class in bg.codexio.ai.openai.api.sdk.images: A stage to choose the Images related action desired Current version includes following possibilities: Creating images Editing images Generating images variations
addCause(NotValidAuthenticationMethod) - Method in exception class bg.codexio.ai.openai.api.sdk.auth.exception.NotValidAuthenticationMethod: Used if more than one SdkAuth methods are provided to collect all of their errors in one exception.
AIModelStage - Class in bg.codexio.ai.openai.api.sdk.chat: A stage to choose a model supported by /v1/chat/completions model endpoint compatibility .
AIModelStage<R,E> - Class in bg.codexio.ai.openai.api.sdk.images: A stage to choose a model supported by /v1/chat/completions model endpoint compatibility .
AIModelStage - Class in bg.codexio.ai.openai.api.sdk.vision: A stage to choose a model supported by /v1/chat/completions model endpoint compatibility .
AIModelStage - Class in bg.codexio.ai.openai.api.sdk.voice.speech: A stage to choose a model supported by /v1/audio/speech model endpoint compatibility .
AIModelStage - Class in bg.codexio.ai.openai.api.sdk.voice.transcription: A stage to choose a model supported by /v1/audio/transcriptions model endpoint compatibility .
AIModelStage - Class in bg.codexio.ai.openai.api.sdk.voice.translation: A stage to choose a model supported by /v1/audio/translations model endpoint compatibility .
ALMOST_THE_WHOLE_PICTURE - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.tolerance.ColorDeviation
analyze(DetailedAnalyze) - Method in class bg.codexio.ai.openai.api.sdk.vision.ImageDetailStage: Adds DetailedAnalyze to the request
and() - Method in class bg.codexio.ai.openai.api.sdk.chat.AccuracyStage: Go back
and() - Method in class bg.codexio.ai.openai.api.sdk.chat.TokenStage: Go back
and() - Method in class bg.codexio.ai.openai.api.sdk.chat.ToolStage: Go back
and() - Method in class bg.codexio.ai.openai.api.sdk.HttpBuilder: Goes to next stage with empty ObjectMapper
andDownload(File) - Method in class bg.codexio.ai.openai.api.sdk.images.SynchronousExecutor: Downloads the image from the successful HTTP response and returns the File instance/s.
andGetRaw() - Method in class bg.codexio.ai.openai.api.sdk.images.SynchronousExecutor: Returns the whole DTO from the HTTP response that includes the generated image and the additional information, including the useful revised prompt.
andRespond() - Method in class bg.codexio.ai.openai.api.sdk.chat.MessageStage: Goes ahead.
andRespond() - Method in class bg.codexio.ai.openai.api.sdk.chat.TemperatureStage: Bypass all configuration steps and go directly to ChatRuntimeSelectionStage.
andRespond() - Method in class bg.codexio.ai.openai.api.sdk.images.ImagesTerminalStage
andRespond() - Method in interface bg.codexio.ai.openai.api.sdk.TerminalStage
andRespond() - Method in class bg.codexio.ai.openai.api.sdk.vision.ImageChooserOrSkipStage: Finishes adding images for explanation and goes on the next stage
andRespond() - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.SimplifiedStage: Preconfigures TTS1HDModel with HD quality the default speaker with mp3 output format and x1 speed.
andRespond() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.SimplifiedStage: Autoconfigures AI Model Whisper10, temperature TemperatureStage.deterministic(), language LanguageStage.talkingInEnglish() and format FormatStage.justText()
andRespond() - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.SimplifiedStage: Autoconfigures AI Model Whisper10, temperature TemperatureStage.deterministic() and format FormatStage.justText()
another(File) - Method in class bg.codexio.ai.openai.api.sdk.images.ActionTypeStage
another(File) - Method in class bg.codexio.ai.openai.api.sdk.images.VariatingActionTypeStage
apiKey - Enum constant in enum class bg.codexio.ai.openai.api.sdk.auth.FromJson.AvailableKeys
AQUA - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
areColorsSimilar(int, int, double) - Static method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage
asImage() - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage
asInputStream() - Method in class bg.codexio.ai.openai.api.sdk.auth.FromJson
ask(String...) - Method in class bg.codexio.ai.openai.api.sdk.chat.AsyncContextStage: Sends async request to OpenAI API.
ask(String...) - Method in class bg.codexio.ai.openai.api.sdk.chat.ImmediateContextStage: Sends request to the OpenAI API.
ask(String...) - Method in class bg.codexio.ai.openai.api.sdk.chat.ReactiveContextStage: Sends async request to OpenAI API.
askRaw(String...) - Method in class bg.codexio.ai.openai.api.sdk.chat.AsyncContextStage: Sends async request to OpenAI API.
askRaw(String...) - Method in class bg.codexio.ai.openai.api.sdk.chat.ImmediateContextStage: Sends request to the OpenAI API.
askRaw(String...) - Method in class bg.codexio.ai.openai.api.sdk.chat.ReactiveContextStage: Sends async request to OpenAI API.
assist(String) - Method in class bg.codexio.ai.openai.api.sdk.chat.MessageStage: Provides knowledge the AI Model should operate with
async() - Method in class bg.codexio.ai.openai.api.sdk.chat.ChatRuntimeSelectionStage: Requests will be asynchronous with promises.
async() - Method in class bg.codexio.ai.openai.api.sdk.images.PromptfulImagesRuntimeSelectionStage: Requests will be asynchronous with promises.
async() - Method in class bg.codexio.ai.openai.api.sdk.images.PromptlessImagesRuntimeSelectionStage: Requests will be asynchronous with promises.
async() - Method in interface bg.codexio.ai.openai.api.sdk.RuntimeSelectionStage
async() - Method in class bg.codexio.ai.openai.api.sdk.vision.VisionRuntimeSelectionStage: Goes further to prompt the GPT model in an asynchronous promise-based fashion.
async() - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.SpeechRuntimeSelectionStage: Requests will be asynchronous with promises
async() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.TranscriptionRuntimeSelectionStage: Requests will be asynchronous with promises
async() - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.TranslationRuntimeSelectionStage: Requests will be asynchronous with promises
async(Processing) - Method in class bg.codexio.ai.openai.api.sdk.chat.ChatRuntimeSelectionStage: Requests will be asynchronous with promises.
AsyncApi<R> - Class in bg.codexio.ai.openai.api.sdk.images: Reactive API to add a final instruction and proceed with the HTTP call.
AsyncContextStage - Class in bg.codexio.ai.openai.api.sdk.chat: Async context to choose between raw response or just a simple string answer.
AsyncDownloadStage - Class in bg.codexio.ai.openai.api.sdk.voice.speech: Configures target folder
AsyncExecutor<R> - Class in bg.codexio.ai.openai.api.sdk.images: Promise abstraction.
AsyncPromise - Class in bg.codexio.ai.openai.api.sdk.chat: Promise abstraction.
AsyncPromise - Class in bg.codexio.ai.openai.api.sdk.vision: Async promise to choose between raw response or just a simple string answer.
AsyncPromiseStage - Class in bg.codexio.ai.openai.api.sdk.voice.speech: Registers callbacks
AsyncPromiseStage - Class in bg.codexio.ai.openai.api.sdk.voice.transcription: Registers callbacks and sends request
AsyncPromiseStage - Class in bg.codexio.ai.openai.api.sdk.voice.translation: Registers callbacks and sends request
AsyncPromptStage - Class in bg.codexio.ai.openai.api.sdk.vision: Sends calls to OpenAI API with the already defined callbacks, and possibly with prompt.
AsyncPromptStage - Class in bg.codexio.ai.openai.api.sdk.voice.speech: Registers text input
AsyncPromptStage - Class in bg.codexio.ai.openai.api.sdk.voice.transcription: Registers user input optionally
AsyncPromptStage - Class in bg.codexio.ai.openai.api.sdk.voice.translation: Registers user input optionally
AsyncRawPromise - Class in bg.codexio.ai.openai.api.sdk.chat: Promise abstraction.
audio(AudioFormat) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.OutputStage: Sets AudioFormat
AudioFileStage - Class in bg.codexio.ai.openai.api.sdk.voice.transcription: Configures which audio file to transcribe
AudioFileStage - Class in bg.codexio.ai.openai.api.sdk.voice.translation: Configures which audio file to translate
AUTH - Static variable in class bg.codexio.ai.openai.api.sdk.auth.FromEnvironment
AUTH - Static variable in class bg.codexio.ai.openai.api.sdk.auth.FromJson
authenticate(HttpExecutorContext) - Static method in class bg.codexio.ai.openai.api.sdk.chat.Chat: Authenticates against OpenAI API with manually supplied
ApiCredentials and HttpTimeouts.
authenticate(HttpExecutorContext) - Static method in class bg.codexio.ai.openai.api.sdk.images.Images: Authenticates against OpenAI API with manually supplied
ApiCredentials and HttpTimeouts.
authenticate(HttpExecutorContext) - Static method in class bg.codexio.ai.openai.api.sdk.vision.Vision: Authenticates against OpenAI API with manually supplied
ApiCredentials and HttpTimeouts.
authenticate(HttpExecutorContext) - Static method in class bg.codexio.ai.openai.api.sdk.voice.speech.Speech: Authenticates against OpenAI API with manually supplied
ApiCredentials and HttpTimeouts.
authenticate(HttpExecutorContext) - Static method in class bg.codexio.ai.openai.api.sdk.voice.transcription.Transcription: Authenticates against OpenAI API with manually supplied
ApiCredentials and HttpTimeouts.
authenticate(HttpExecutorContext) - Static method in class bg.codexio.ai.openai.api.sdk.voice.translation.Translation: Authenticates against OpenAI API with manually supplied
ApiCredentials and HttpTimeouts.
authenticate(SdkAuth) - Static method in class bg.codexio.ai.openai.api.sdk.chat.Chat: Authenticates against OpenAI API with an implementation of SdkAuth.
authenticate(SdkAuth) - Static method in class bg.codexio.ai.openai.api.sdk.images.Images: Authenticates against OpenAI API with an implementation of SdkAuth.
authenticate(SdkAuth) - Static method in class bg.codexio.ai.openai.api.sdk.vision.Vision: Authenticates against OpenAI API with an implementation of SdkAuth.
authenticate(SdkAuth) - Static method in class bg.codexio.ai.openai.api.sdk.voice.speech.Speech: Authenticates against OpenAI API with an implementation of SdkAuth.
authenticate(SdkAuth) - Static method in class bg.codexio.ai.openai.api.sdk.voice.transcription.Transcription: Authenticates against OpenAI API with an implementation of SdkAuth.
authenticate(SdkAuth) - Static method in class bg.codexio.ai.openai.api.sdk.voice.translation.Translation: Authenticates against OpenAI API with an implementation of SdkAuth.
Authenticator - Class in bg.codexio.ai.openai.api.sdk
autoAuthenticate(Function<SdkAuth, T>) - Static method in class bg.codexio.ai.openai.api.sdk.Authenticator

B

BALANCED_TOLERANCE - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.tolerance.ColorDeviation
baseUrl - Enum constant in enum class bg.codexio.ai.openai.api.sdk.auth.FromJson.AvailableKeys
BATCH - Enum constant in enum class bg.codexio.ai.openai.api.sdk.Processing
BEIGE - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
bg.codexio.ai.openai.api.sdk - package bg.codexio.ai.openai.api.sdk
bg.codexio.ai.openai.api.sdk.auth - package bg.codexio.ai.openai.api.sdk.auth
bg.codexio.ai.openai.api.sdk.auth.exception - package bg.codexio.ai.openai.api.sdk.auth.exception
bg.codexio.ai.openai.api.sdk.auth.util - package bg.codexio.ai.openai.api.sdk.auth.util
bg.codexio.ai.openai.api.sdk.chat - package bg.codexio.ai.openai.api.sdk.chat
bg.codexio.ai.openai.api.sdk.images - package bg.codexio.ai.openai.api.sdk.images
bg.codexio.ai.openai.api.sdk.images.color - package bg.codexio.ai.openai.api.sdk.images.color
bg.codexio.ai.openai.api.sdk.images.tolerance - package bg.codexio.ai.openai.api.sdk.images.tolerance
bg.codexio.ai.openai.api.sdk.vision - package bg.codexio.ai.openai.api.sdk.vision
bg.codexio.ai.openai.api.sdk.voice.speech - package bg.codexio.ai.openai.api.sdk.voice.speech
bg.codexio.ai.openai.api.sdk.voice.transcription - package bg.codexio.ai.openai.api.sdk.voice.transcription
bg.codexio.ai.openai.api.sdk.voice.translation - package bg.codexio.ai.openai.api.sdk.voice.translation
bigSquare() - Method in class bg.codexio.ai.openai.api.sdk.images.Dalle2SizeStage: The biggest square with dimensions 256x256 px.
BLACK - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
BLUE - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
BROWN - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
builder - Variable in class bg.codexio.ai.openai.api.sdk.images.ImageConfigurationStage

C

Chat - Class in bg.codexio.ai.openai.api.sdk.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 - Class in bg.codexio.ai.openai.api.sdk.chat: Base for all Chat stages
ChatRuntimeSelectionStage - Class in bg.codexio.ai.openai.api.sdk.chat: Configures how the HTTP client to act.
choices(int) - Method in class bg.codexio.ai.openai.api.sdk.chat.TokenStage: Configures n
ChoicesStage<R,E> - Class in bg.codexio.ai.openai.api.sdk.images: A stage to choose the number of the images generated.
chooseTool(ChatTool) - Method in class bg.codexio.ai.openai.api.sdk.chat.ToolStage: Adds a tool and set it as toolChoice.
ColorDeviation - Enum Class in bg.codexio.ai.openai.api.sdk.images.tolerance
CORAL - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
creating() - Method in class bg.codexio.ai.openai.api.sdk.images.ActionTypeStage: Creates images given a prompt.
creating() - Method in class bg.codexio.ai.openai.api.sdk.images.CreatingActionTypeStage: Creates images given a prompt.
CreatingActionTypeStage - Class in bg.codexio.ai.openai.api.sdk.images: Explicit marker action type stage for flows where only creating is possible
E.g.
creativeAs(Creativity) - Method in class bg.codexio.ai.openai.api.sdk.chat.TemperatureStage: Configures temperature
creativeAs(Creativity) - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.TemperatureStage: Configures temperature
creativeAs(Creativity) - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.TemperatureStage: Configures temperature
credentials() - Method in class bg.codexio.ai.openai.api.sdk.auth.FromDeveloper
credentials() - Method in class bg.codexio.ai.openai.api.sdk.auth.FromEnvironment: In this implementation we first look for the api key in the environment variables
If this variable is missing, a NotValidAuthenticationMethod error is thrown, as the authentication can never proceed without an api key.
If organization id is configured, it is applied, otherwise the default empty value is used
credentials() - Method in class bg.codexio.ai.openai.api.sdk.auth.FromJson: In this implementation we first look for the apiKey in the provided JSON file
If this variable is missing, a NotValidAuthenticationMethod error is thrown, as the authentication can never proceed without an api key.
If orgId or organizationId is configured, it is applied, otherwise the default empty value is used
Check FromJson.AvailableKeys for the correct naming.
credentials() - Method in interface bg.codexio.ai.openai.api.sdk.auth.SdkAuth
CYAN - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor

D

Dalle2SizeStage<R,E> - Class in bg.codexio.ai.openai.api.sdk.images: A stage to choose the dimensions of the image generated supported by dall-e-2
Dalle3SizeStage<R,E> - Class in bg.codexio.ai.openai.api.sdk.images: A stage to choose the dimensions of the image generated supported by dall-e-3
DARK_GRAY - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
deepConfigure() - Method in class bg.codexio.ai.openai.api.sdk.chat.TemperatureStage: Goes to manually configuring some non-trivial options such as tools, tokens and accuracy.
DEFAULT - Enum constant in enum class bg.codexio.ai.openai.api.sdk.Processing
DEFAULT_AUTHENTICATIONS - Static variable in class bg.codexio.ai.openai.api.sdk.Authenticator: Authentication methods it will be tested against, when using Authenticator.autoAuthenticate(Function) ()}.
defaultModel() - Method in class bg.codexio.ai.openai.api.sdk.images.AIModelStage: Configures the AI Model to be DallE20
defaultModel() - Method in class bg.codexio.ai.openai.api.sdk.vision.AIModelStage: Configures the AI Model to be GPT40VisionPreviewModel
defaultModel() - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.AIModelStage: Configures the AI Model to be TTS1Model
defaults() - Static method in class bg.codexio.ai.openai.api.sdk.chat.Chat: Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods.
defaults() - Static method in class bg.codexio.ai.openai.api.sdk.images.Images: Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods.
defaults() - Static method in class bg.codexio.ai.openai.api.sdk.vision.Vision: Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods.
defaults() - Static method in class bg.codexio.ai.openai.api.sdk.voice.speech.Speech: Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods.
defaults() - Static method in class bg.codexio.ai.openai.api.sdk.voice.transcription.Transcription: Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods.
defaults() - Static method in class bg.codexio.ai.openai.api.sdk.voice.translation.Translation: Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods.
defaultSpeaker() - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.VoiceStage: Sets a Speaker to Speaker.ECHO
defaultTokens() - Method in class bg.codexio.ai.openai.api.sdk.vision.TokenStage: Configures maxTokens So response will be limited as much as the models default
describe() - Method in class bg.codexio.ai.openai.api.sdk.vision.AsyncPromptStage: Sends request to the OpenAI API.
describe() - Method in class bg.codexio.ai.openai.api.sdk.vision.ReactivePromptStage: Sends async request to OpenAI API.
describe() - Method in class bg.codexio.ai.openai.api.sdk.vision.SynchronousPromptStage: Sends request to the OpenAI API.
describe(String) - Method in class bg.codexio.ai.openai.api.sdk.vision.AsyncPromptStage: Sends request to the OpenAI API.
describe(String) - Method in class bg.codexio.ai.openai.api.sdk.vision.ReactivePromptStage: Sends async request to OpenAI API.
describe(String) - Method in class bg.codexio.ai.openai.api.sdk.vision.SynchronousPromptStage: Sends request to the OpenAI API.
describeRaw() - Method in class bg.codexio.ai.openai.api.sdk.vision.SynchronousPromptStage: Sends request to the OpenAI API.
describeRaw(String) - Method in class bg.codexio.ai.openai.api.sdk.vision.SynchronousPromptStage: Sends request to the OpenAI API.
deterministic() - Method in class bg.codexio.ai.openai.api.sdk.chat.TemperatureStage: Configures all parameters to be mostly deterministic.
deterministic() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.TemperatureStage: Configures temperature to Creativity.TRULY_DETERMINISTIC
deterministic() - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.TemperatureStage: Configures temperature to Creativity.TRULY_DETERMINISTIC
developer() - Method in class bg.codexio.ai.openai.api.sdk.chat.MessageStage: Provides context to AI Model to act as a generic software developer.
developer(String) - Method in class bg.codexio.ai.openai.api.sdk.chat.MessageStage: Provides context to AI Model to act as a software developer of some kind.
dictate(String) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.AsyncPromptStage
dictate(String) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.ReactivePromptStage
dictate(String) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.SynchronousPromptStage
done() - Method in class bg.codexio.ai.openai.api.sdk.chat.ManualConfigurationStage: After things are configured, go ahead.
doPass(ApiCredentials) - Static method in class bg.codexio.ai.openai.api.sdk.auth.FromDeveloper: Factory function to by as close as possible to the other SdkAuth implementations.
download(File) - Method in class bg.codexio.ai.openai.api.sdk.images.ReactiveExecutor
DownloadExecutor - Class in bg.codexio.ai.openai.api.sdk.images: An internal executor used to handle the files download
DownloadExecutor - Class in bg.codexio.ai.openai.api.sdk.voice.speech: Utility to download files with random names to a given folder
DownloadExecutor.Streams - Class in bg.codexio.ai.openai.api.sdk.images
downloadTo(File) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.ReactiveDownloadStage: Configures target folder to download to
downloadTo(File) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.SynchronousDownloadStage: Executes the request so far in synchronous blocking fashion, the result of the OpenAI API response is then downloaded to the supplied folder.
downloadTo(File, AudioBinaryResponse, String) - Static method in class bg.codexio.ai.openai.api.sdk.voice.speech.DownloadExecutor

E

editing(File) - Method in class bg.codexio.ai.openai.api.sdk.images.ActionTypeStage
editing(File) - Method in class bg.codexio.ai.openai.api.sdk.images.EditingActionTypeStage
EditingActionTypeStage - Class in bg.codexio.ai.openai.api.sdk.images: Explicit marker action type stage for flows where only editing is possible
E.g.
EditingMaskStage<R,E> - Class in bg.codexio.ai.openai.api.sdk.images: A stage to specify the editable areas of the image.
ensureCreatorTerminalStage() - Method in class bg.codexio.ai.openai.api.sdk.images.SimplifiedStage
EVERYTHING - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.tolerance.ColorDeviation
executeGeneration(String) - Method in class bg.codexio.ai.openai.api.sdk.images.SimplifiedStage
executor - Variable in class bg.codexio.ai.openai.api.sdk.chat.ChatConfigurationStage
executor - Variable in class bg.codexio.ai.openai.api.sdk.images.ImageConfigurationStage
executor - Variable in class bg.codexio.ai.openai.api.sdk.vision.VisionConfigurationStage
executor - Variable in class bg.codexio.ai.openai.api.sdk.voice.speech.SpeechConfigurationStage
executor - Variable in class bg.codexio.ai.openai.api.sdk.voice.transcription.TranscriptionConfigurationStage
executor - Variable in class bg.codexio.ai.openai.api.sdk.voice.translation.TranslationConfigurationStage
expectBase64() - Method in class bg.codexio.ai.openai.api.sdk.images.FormatStage: Sets the image format to Base 64.
expectUrl() - Method in class bg.codexio.ai.openai.api.sdk.images.FormatStage: Sets the image format to url.
explain(File) - Method in class bg.codexio.ai.openai.api.sdk.vision.ImageChooserStage: Adds image as a local file
explain(File) - Method in class bg.codexio.ai.openai.api.sdk.vision.SimplifiedStage
explain(String) - Method in class bg.codexio.ai.openai.api.sdk.vision.ImageChooserStage: Adds image as a URL or Base64 encoded string
explain(String) - Method in class bg.codexio.ai.openai.api.sdk.vision.SimplifiedStage
explainAnother(File) - Method in class bg.codexio.ai.openai.api.sdk.vision.ImageChooserOrSkipStage
explainAnother(String) - Method in class bg.codexio.ai.openai.api.sdk.vision.ImageChooserOrSkipStage

F

fast() - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.SpeedStage: Configures the Speed as Speed.TWICE_FASTER
file(String) - Static method in class bg.codexio.ai.openai.api.sdk.auth.FromJson: Factory method denoting a JSON file with absolute path
forLowerRates() - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.OutputStage: Sets AudioFormat optimized for lower rates, as AudioFormat.AAC
FormatStage<R,E> - Class in bg.codexio.ai.openai.api.sdk.images: A stage to choose the format of the response images
FormatStage - Class in bg.codexio.ai.openai.api.sdk.voice.transcription: Configures the format of the output file
FormatStage - Class in bg.codexio.ai.openai.api.sdk.voice.translation: Configures the format of the output file
formatted(TranscriptionFormat) - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.FormatStage
formatted(TranscriptionFormat) - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.FormatStage
forStreaming() - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.OutputStage: Sets AudioFormat optimized for streaming, as AudioFormat.OPUS
FromDeveloper - Class in bg.codexio.ai.openai.api.sdk.auth: Use this for manually passing the credentials and still conforming the SdkAuth contract.
FromEnvironment - Class in bg.codexio.ai.openai.api.sdk.auth: When instantiated and FromEnvironment.credentials() is called, series of environment variables will be scanned to provide necessary ApiCredentials.
FromJson - Class in bg.codexio.ai.openai.api.sdk.auth: When instantiated and FromJson.credentials() is called, already configured json file is scanned for credentials.
FromJson.AvailableKeys - Enum Class in bg.codexio.ai.openai.api.sdk.auth

G

generate(String) - Method in class bg.codexio.ai.openai.api.sdk.images.AsyncApi
generate(String) - Method in interface bg.codexio.ai.openai.api.sdk.images.ImagesPromptStage
generate(String) - Method in class bg.codexio.ai.openai.api.sdk.images.ReactiveApi
generate(String) - Method in class bg.codexio.ai.openai.api.sdk.images.SimplifiedStage: Go ahead to specify instructions for image creation with high creativity and dall-e-3 model executed with a synchronous call.
generate(String) - Method in class bg.codexio.ai.openai.api.sdk.images.SynchronousApi
get() - Method in class bg.codexio.ai.openai.api.sdk.images.ReactiveExecutor
getCause() - Method in exception class bg.codexio.ai.openai.api.sdk.auth.exception.NotValidAuthenticationMethod
getEnv(String) - Method in class bg.codexio.ai.openai.api.sdk.auth.FromEnvironment
GOLD - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
GRAY - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
GREEN - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
guide(String) - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.AsyncPromptStage: Guides the transcription with additional prompt
guide(String) - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.ReactivePromptStage: Guides the transcription with additional prompt Notifies the OpenAIHttpExecutor.ReactiveExecution.lines() and OpenAIHttpExecutor.ReactiveExecution.response() when parts (and the whole) of the response is received.
guide(String) - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.SynchronousPromptStage: Guides the transcription with additional prompt
guide(String) - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.AsyncPromptStage: Guides the translation with additional prompt
guide(String) - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.ReactivePromptStage: Guides the translation with additional prompt Notifies the OpenAIHttpExecutor.ReactiveExecution.lines() and OpenAIHttpExecutor.ReactiveExecution.response() when parts (and the whole) of the response is received.
guide(String) - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.SynchronousPromptStage: Guides the translation with additional prompt

H

HALF - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.tolerance.ColorDeviation
hasAlphaChannel(BufferedImage) - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage
hdPowered() - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.AIModelStage: Configures the AI Model to be TTS1HDModel
highDefinitioned() - Method in class bg.codexio.ai.openai.api.sdk.images.QualityStage: Sets the quality to HD.
HttpBuilder<T> - Class in bg.codexio.ai.openai.api.sdk: Default usage is to configure the HTTP connection and
serialization / deserialization methods using ObjectMapper.
HttpBuilder(HttpExecutorContext, BiFunction<HttpExecutorContext, ObjectMapper, T>) - Constructor for class bg.codexio.ai.openai.api.sdk.HttpBuilder

I

ImageChooserOrSkipStage - Class in bg.codexio.ai.openai.api.sdk.vision: Either inputs more images and goes back to ImageDetailStage or goes further to select a runtime.
ImageChooserStage - Class in bg.codexio.ai.openai.api.sdk.vision: Configures image either as a file or base64 encoded one
ImageConfigurationStage<R> - Class in bg.codexio.ai.openai.api.sdk.images: Base for all Image stages
ImageConfigurationStage(DefaultOpenAIHttpExecutor<R, ImageDataResponse>, ImageRequestBuilder<R>) - Constructor for class bg.codexio.ai.openai.api.sdk.images.ImageConfigurationStage
ImageDetailStage - Class in bg.codexio.ai.openai.api.sdk.vision: Configures the DetailedAnalyze
Images<R> - Class in bg.codexio.ai.openai.api.sdk.images: 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> - Interface in bg.codexio.ai.openai.api.sdk.images
ImagesTerminalStage<R,E> - Class in bg.codexio.ai.openai.api.sdk.images: Marker stage for finishing the configurations of the prompt.
imaginative() - Method in class bg.codexio.ai.openai.api.sdk.chat.TemperatureStage: You may receive a lot of irrelevancy.
Highly creative parameters with less deterministic properties.
immediate() - Method in class bg.codexio.ai.openai.api.sdk.chat.ChatRuntimeSelectionStage: Requests will be synchronously blocking without streaming enabled.
immediate() - Method in class bg.codexio.ai.openai.api.sdk.images.PromptfulImagesRuntimeSelectionStage: Requests will be synchronously blocking without streaming enabled.
immediate() - Method in class bg.codexio.ai.openai.api.sdk.images.PromptlessImagesRuntimeSelectionStage: Requests will be synchronously blocking without streaming enabled.
immediate() - Method in interface bg.codexio.ai.openai.api.sdk.RuntimeSelectionStage
immediate() - Method in class bg.codexio.ai.openai.api.sdk.vision.VisionRuntimeSelectionStage: Goes further to prompt the GPT model in a synchronous fashion.
immediate() - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.SpeechRuntimeSelectionStage: Requests will be synchronously blocking
immediate() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.TranscriptionRuntimeSelectionStage: Requests will be synchronously blocking
immediate() - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.TranslationRuntimeSelectionStage: Requests will be synchronously blocking
immediate(Processing) - Method in class bg.codexio.ai.openai.api.sdk.chat.ChatRuntimeSelectionStage: Requests will be synchronously blocking and might utilize server-sent events (real-time streaming).
ImmediateContextStage - Class in bg.codexio.ai.openai.api.sdk.chat: Synchronous context to choose between raw response or just a simple string answer.
INDIGO - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
IntermediateStage - Interface in bg.codexio.ai.openai.api.sdk: Marker Interface for all stages that are not TerminalStage
inventive() - Method in class bg.codexio.ai.openai.api.sdk.chat.TemperatureStage: Configures all parameters to be balanced between creativity and determinism.
isNullOrBlank(String) - Static method in class bg.codexio.ai.openai.api.sdk.auth.util.StringUtil

J

justAdd(ChatTool) - Method in class bg.codexio.ai.openai.api.sdk.chat.ToolStage: Adds a tool.
justText() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.FormatStage: Configures output file to be just text
justText() - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.FormatStage: Configures output file to be just text

L

landscape() - Method in class bg.codexio.ai.openai.api.sdk.images.Dalle3SizeStage: Landscape with dimensions 1792x1024 px.
LanguageStage - Class in bg.codexio.ai.openai.api.sdk.voice.transcription: Tells the OpenAI API in which language the voice in the audio file is.
LAVENDER - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
LIGHT_GRAY - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
LIME - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
limitResponseTo(Integer) - Method in class bg.codexio.ai.openai.api.sdk.vision.TokenStage: Configures maxTokens So response will be limited to less than models default

M

MAGENTA - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
ManualConfigurationStage - Class in bg.codexio.ai.openai.api.sdk.chat: Configures tokens, tools and accuracy/
MAROON - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
masked(int) - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage
masked(int, int, int) - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage
masked(int, int, int, ColorDeviation) - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage
masked(int, ColorDeviation) - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage
masked(PopularColor) - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage
masked(PopularColor, ColorDeviation) - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage
masked(File) - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage
masked(String) - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage
masked(String, ColorDeviation) - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage
max(int) - Method in class bg.codexio.ai.openai.api.sdk.chat.TokenStage: Configures maxTokens
maxTokens() - Method in class bg.codexio.ai.openai.api.sdk.vision.TokenStage: Configures maxTokens To the maximum possible
mediumSquare() - Method in class bg.codexio.ai.openai.api.sdk.images.Dalle2SizeStage: The medium square with dimensions 256x256 px.
MessageStage - Class in bg.codexio.ai.openai.api.sdk.chat: Configures messages such as system and assistant messages.
MessageStage(ChatHttpExecutor, ChatMessageRequest.Builder) - Constructor for class bg.codexio.ai.openai.api.sdk.chat.MessageStage
MINT - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
mp3() - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.OutputStage: Sets AudioFormat as AudioFormat.MP3

N

natural() - Method in class bg.codexio.ai.openai.api.sdk.images.StyleStage: Sets the style to natural.
NAVY - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
noCompression() - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.OutputStage: Sets AudioFormat with no compression, as AudioFormat.FLAC
noExcuses() - Method in class bg.codexio.ai.openai.api.sdk.chat.MessageStage: Provides context to AI Model to not excuse when pointed wrong.
noRepetition() - Method in class bg.codexio.ai.openai.api.sdk.chat.MessageStage: Provides context to AI Model to not repeat old suggestions.
NotValidAuthenticationMethod - Exception Class in bg.codexio.ai.openai.api.sdk.auth.exception: Usually thrown by SdkAuth if integral parts of the authentication are missing.
NotValidAuthenticationMethod(String) - Constructor for exception class bg.codexio.ai.openai.api.sdk.auth.exception.NotValidAuthenticationMethod

O

OLIVE - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
onEachLine(Consumer<String>) - Method in class bg.codexio.ai.openai.api.sdk.chat.AsyncRawPromise: Subscribe to each line (whether streamed or from the whole response)
onEachLine(Consumer<String>) - Method in class bg.codexio.ai.openai.api.sdk.vision.AsyncPromise: Subscribe to each line (whether streamed or from the whole response)
onEachLine(Consumer<String>) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.AsyncPromiseStage: Sends request in asynchronous fashion, registers a callback to be called when String/byteArray line of the response is received.
onEachLine(Consumer<String>) - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.AsyncPromiseStage: Sends request in asynchronous fashion, registers a callback to be called on each line of the response
onEachLine(Consumer<String>) - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.AsyncPromiseStage: Sends request in asynchronous fashion, registers a callback to be called on each line of the response
onEachLine(Consumer<String>, Consumer<Throwable>) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.AsyncPromiseStage: Sends request in asynchronous fashion, registers a callback to be called when String/byteArray line of the response is received.
onResponse(Consumer<ImageDataResponse>) - Method in class bg.codexio.ai.openai.api.sdk.images.AsyncExecutor: Subscribe to the result of the HTTP request
ORANGE - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
organizationId - Enum constant in enum class bg.codexio.ai.openai.api.sdk.auth.FromJson.AvailableKeys
orgId - Enum constant in enum class bg.codexio.ai.openai.api.sdk.auth.FromJson.AvailableKeys
OutputStage - Class in bg.codexio.ai.openai.api.sdk.voice.speech: Configures the output format

P

PINK - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
playback(double) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.SpeedStage: Configures a speed between 0.25 and 4
playback(Speed) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.SpeedStage: Configures a Speed
PopularColor - Enum Class in bg.codexio.ai.openai.api.sdk.images.color
portrait() - Method in class bg.codexio.ai.openai.api.sdk.images.Dalle3SizeStage: Landscape with dimensions 1024x1792 px.
poweredBy(ModelType) - Method in class bg.codexio.ai.openai.api.sdk.chat.AIModelStage
poweredBy(ModelType) - Method in class bg.codexio.ai.openai.api.sdk.vision.AIModelStage
poweredBy(ModelType) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.AIModelStage
poweredBy(ModelType) - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.AIModelStage
poweredBy(ModelType) - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.AIModelStage
poweredByDallE2() - Method in class bg.codexio.ai.openai.api.sdk.images.AIModelStage: Configures the AI Model to be DallE20
poweredByDallE3() - Method in class bg.codexio.ai.openai.api.sdk.images.AIModelStage: Configures the AI Model to be DallE30
poweredByGPT35() - Method in class bg.codexio.ai.openai.api.sdk.chat.AIModelStage: Configures the AI Model to be GPT35TurboModel
poweredByGPT40() - Method in class bg.codexio.ai.openai.api.sdk.chat.AIModelStage: Configures the AI Model to be GPT40Model
poweredByGpt40Vision() - Method in class bg.codexio.ai.openai.api.sdk.vision.AIModelStage: Configures the AI Model to be GPT40VisionPreviewModel
poweredByWhisper10() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.AIModelStage: Configures the AI Model to be Whisper10
poweredByWhisper10() - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.AIModelStage: Configures the AI Model to be Whisper10
predictable() - Method in class bg.codexio.ai.openai.api.sdk.chat.TemperatureStage: Configures all parameters to be mostly deterministic, but also a little bit creative.
PreSimplifiedStage - Class in bg.codexio.ai.openai.api.sdk.voice.transcription: Sets audio file for transcription, before all other autoconfiguration.
PreSimplifiedStage - Class in bg.codexio.ai.openai.api.sdk.voice.translation: Sets audio file for translation, before all other autoconfiguration.
PreSimplifiedStage(ApiCredentials) - Constructor for class bg.codexio.ai.openai.api.sdk.voice.transcription.PreSimplifiedStage
PreSimplifiedStage(ApiCredentials) - Constructor for class bg.codexio.ai.openai.api.sdk.voice.translation.PreSimplifiedStage
Processing - Enum Class in bg.codexio.ai.openai.api.sdk: Processing type.
PromptfulImagesRuntimeSelectionStage<R> - Class in bg.codexio.ai.openai.api.sdk.images: Configures how the HTTP client to act.
PromptlessImagesRuntimeSelectionStage<R> - Class in bg.codexio.ai.openai.api.sdk.images: Configures how the HTTP client to act.
PURPLE - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor

Q

QualityStage<R,E> - Class in bg.codexio.ai.openai.api.sdk.images: A stage to choose the quality of the images generated.

R

randomized() - Method in class bg.codexio.ai.openai.api.sdk.chat.TemperatureStage: You may receive total non-sense in the answers .
Configures all parameters to the highest creativity with little to none determinism and a lot of repetitions.
randomized() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.TemperatureStage: Configures temperature to Creativity.I_HAVE_NO_IDEA_WHAT_I_AM_TALKING
randomized() - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.TemperatureStage: Configures temperature to Creativity.I_HAVE_NO_IDEA_WHAT_I_AM_TALKING
reactive() - Method in class bg.codexio.ai.openai.api.sdk.chat.ChatRuntimeSelectionStage: Requests will be asynchronous under reactive API.
reactive() - Method in class bg.codexio.ai.openai.api.sdk.images.PromptfulImagesRuntimeSelectionStage: Requests will be asynchronous under reactive API.
reactive() - Method in class bg.codexio.ai.openai.api.sdk.images.PromptlessImagesRuntimeSelectionStage: Requests will be asynchronous under reactive API.
reactive() - Method in interface bg.codexio.ai.openai.api.sdk.RuntimeSelectionStage
reactive() - Method in class bg.codexio.ai.openai.api.sdk.vision.VisionRuntimeSelectionStage: Goes further to prompt the GPT model in an asynchronous reactive-based fashion.
reactive() - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.SpeechRuntimeSelectionStage: Requests will be asynchronous reactive
reactive() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.TranscriptionRuntimeSelectionStage: Requests will be asynchronous reactive
reactive() - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.TranslationRuntimeSelectionStage: Requests will be asynchronous reactive
reactive(Processing) - Method in class bg.codexio.ai.openai.api.sdk.chat.ChatRuntimeSelectionStage: Requests will be asynchronous under reactive API.
ReactiveApi<R> - Class in bg.codexio.ai.openai.api.sdk.images: Reactive API to add a final instruction and proceed with the HTTP call.
ReactiveContextStage - Class in bg.codexio.ai.openai.api.sdk.chat: Reactive context to choose between raw response or just a simple string answer.
ReactiveDownloadStage - Class in bg.codexio.ai.openai.api.sdk.voice.speech: Configures target folder
ReactiveExecutor<R> - Class in bg.codexio.ai.openai.api.sdk.images: Reactive context to choose if the response image should be automatically downloaded or just delivered.
ReactivePromptStage - Class in bg.codexio.ai.openai.api.sdk.vision: Sends calls to OpenAI API in a reactive fashion
ReactivePromptStage - Class in bg.codexio.ai.openai.api.sdk.voice.speech: Registers text input
ReactivePromptStage - Class in bg.codexio.ai.openai.api.sdk.voice.transcription: Registers text input optionally
ReactivePromptStage - Class in bg.codexio.ai.openai.api.sdk.voice.translation: Registers text input optionally
REAL_TIME - Enum constant in enum class bg.codexio.ai.openai.api.sdk.Processing
RED - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
requestBuilder - Variable in class bg.codexio.ai.openai.api.sdk.chat.ChatConfigurationStage
requestBuilder - Variable in class bg.codexio.ai.openai.api.sdk.voice.speech.SpeechConfigurationStage
requestBuilder - Variable in class bg.codexio.ai.openai.api.sdk.voice.transcription.TranscriptionConfigurationStage
requestBuilder - Variable in class bg.codexio.ai.openai.api.sdk.voice.translation.TranslationConfigurationStage
requestContext - Variable in class bg.codexio.ai.openai.api.sdk.vision.VisionConfigurationStage
resetImageWithAlpha(BufferedImage, int, double) - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage
resource(String) - Static method in class bg.codexio.ai.openai.api.sdk.auth.FromJson: Factory method denoting a JSON resource file with relative path
RuntimeExecutor - Interface in bg.codexio.ai.openai.api.sdk: Marker interface for stages that send requests on behalf of a runtime - synchronously, asynchronously or reactive.
RuntimeSelectionStage - Interface in bg.codexio.ai.openai.api.sdk: Defines all the ways the underlying runtime should act.

S

sameSpeed() - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.SpeedStage: Configures the Speed as Speed.NORMAL
sampleRepetitionsTo(int) - Method in class bg.codexio.ai.openai.api.sdk.chat.AccuracyStage: Configures seed
scaleRepetitionToCreativity(Creativity) - Method in class bg.codexio.ai.openai.api.sdk.chat.TemperatureStage: Configures temperature and additionally configures topP, frequencyPenalty and presencePenalty by applying approximation for topP and inverse function for the penalties.
SdkAuth - Interface in bg.codexio.ai.openai.api.sdk.auth: 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
SILVER - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
SimplifiedStage - Class in bg.codexio.ai.openai.api.sdk.chat: A simplified stage where some things such as AI Model Type and creativity are already configured.
SimplifiedStage<R,E> - Class in bg.codexio.ai.openai.api.sdk.images: A simplified stage where some things such as AI Model Type and creativity are already configured.
SimplifiedStage - Class in bg.codexio.ai.openai.api.sdk.vision: A simplified stage where some things such as AI Model Type and tokens are already configured.
SimplifiedStage - Class in bg.codexio.ai.openai.api.sdk.voice.speech: Preconfigured stage with AI Model, speaker, format and speed
SimplifiedStage - Class in bg.codexio.ai.openai.api.sdk.voice.transcription: Simplifies configuration with already configured AI Model, temperature, language and output format;
SimplifiedStage - Class in bg.codexio.ai.openai.api.sdk.voice.translation: Simplifies configuration with already configured AI Model, temperature and output format;
SimplifiedStage(ApiCredentials) - Constructor for class bg.codexio.ai.openai.api.sdk.voice.speech.SimplifiedStage
SimplifiedStage(ApiCredentials, File) - Constructor for class bg.codexio.ai.openai.api.sdk.voice.transcription.SimplifiedStage
SimplifiedStage(SdkAuth) - Constructor for class bg.codexio.ai.openai.api.sdk.chat.SimplifiedStage
simply() - Static method in class bg.codexio.ai.openai.api.sdk.chat.Chat: Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods.
simply() - Method in class bg.codexio.ai.openai.api.sdk.chat.SimplifiedStage: Go ahead to directly ask question by preconfiguring the AI Model Type and the creativity level and receiving a synchronous response
simply() - Static method in class bg.codexio.ai.openai.api.sdk.images.Images: Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods.
simply() - Static method in class bg.codexio.ai.openai.api.sdk.vision.Vision: Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods.
simply() - Static method in class bg.codexio.ai.openai.api.sdk.voice.speech.Speech: Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods.
simply() - Static method in class bg.codexio.ai.openai.api.sdk.voice.transcription.Transcription: Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods.
simply() - Static method in class bg.codexio.ai.openai.api.sdk.voice.translation.Translation: Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods.
simply(SdkAuth) - Static method in class bg.codexio.ai.openai.api.sdk.chat.Chat: Authenticates against OpenAI API with an implementation of SdkAuth and
preconfigures simple GPT35TurboModel for prompting.
simply(SdkAuth) - Static method in class bg.codexio.ai.openai.api.sdk.images.Images: Authenticates against OpenAI API with an implementation of SdkAuth and
preconfigures simple DallE30 powered instance for creating images.
simply(SdkAuth) - Static method in class bg.codexio.ai.openai.api.sdk.vision.Vision: Authenticates against OpenAI API with an implementation of SdkAuth and
preconfigures simple GPT40VisionPreviewModel for prompting.
simply(SdkAuth) - Static method in class bg.codexio.ai.openai.api.sdk.voice.speech.Speech: Authenticates against OpenAI API with an implementation of SdkAuth and
preconfigures simple TTS1HDModel for prompting.
simply(SdkAuth) - Static method in class bg.codexio.ai.openai.api.sdk.voice.transcription.Transcription: Authenticates against OpenAI API with an implementation of SdkAuth and
preconfigures simple Whisper10 for prompting.
simply(SdkAuth) - Static method in class bg.codexio.ai.openai.api.sdk.voice.translation.Translation: Authenticates against OpenAI API with an implementation of SdkAuth and
preconfigures simple Whisper10 for prompting.
singleChoice() - Method in class bg.codexio.ai.openai.api.sdk.images.ChoicesStage: Sets the number of generated images to one only.
SKY_BLUE - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
slow() - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.SpeedStage: Configures the Speed as Speed.HALF_SLOW
SMALL_DIFFERENCE - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.tolerance.ColorDeviation
smallSquare() - Method in class bg.codexio.ai.openai.api.sdk.images.Dalle2SizeStage: The smallest square with dimensions 256x256 px.
smallTransparency() - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage: This choice is almost the same as unmasked, but will handle more shades of white expanding the editable areas in comparison to the other option
Speech - Class in bg.codexio.ai.openai.api.sdk.voice.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 - Class in bg.codexio.ai.openai.api.sdk.voice.speech: Base for all Speech stages
SpeechRuntimeSelectionStage - Class in bg.codexio.ai.openai.api.sdk.voice.speech: Configures how the HTTP client to act.
SpeedStage - Class in bg.codexio.ai.openai.api.sdk.voice.speech: Configures the speed of the output audio file
square() - Method in class bg.codexio.ai.openai.api.sdk.images.Dalle3SizeStage: Square with dimensions 1024x1024 px.
standardQuality() - Method in class bg.codexio.ai.openai.api.sdk.images.QualityStage: Sets the quality to Standard.
StartStage - Interface in bg.codexio.ai.openai.api.sdk
stopAt(String...) - Method in class bg.codexio.ai.openai.api.sdk.chat.TokenStage: Configures stop
StringUtil - Class in bg.codexio.ai.openai.api.sdk.auth.util
StyleStage<R,E> - Class in bg.codexio.ai.openai.api.sdk.images: A stage to choose the style of the images generated.
subtitles() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.FormatStage: Configures output file to be for subtitles without metadata .srt
subtitles() - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.FormatStage: Configures output file to be for subtitles without metadata .srt
subtitlesWithMetadata() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.FormatStage: Configures output file to be for subtitles with metadata .vtt
subtitlesWithMetadata() - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.FormatStage: Configures output file to be for subtitles with metadata .vtt
SynchronousApi<R> - Class in bg.codexio.ai.openai.api.sdk.images: Synchronous API to add a final instruction and proceed with the HTTP call.
SynchronousDownloadStage - Class in bg.codexio.ai.openai.api.sdk.voice.speech: Sends blocking requests to OpenAI API
SynchronousExecutor<R> - Class in bg.codexio.ai.openai.api.sdk.images: Synchronous context to choose between raw response, just a simple string answer, or an image download
SynchronousPromptStage - Class in bg.codexio.ai.openai.api.sdk.vision: Synchronous context to choose between raw response or just a simple string answer.
SynchronousPromptStage - Class in bg.codexio.ai.openai.api.sdk.voice.speech: Adds user input and proceeds to blocking execution
SynchronousPromptStage - Class in bg.codexio.ai.openai.api.sdk.voice.transcription
SynchronousPromptStage - Class in bg.codexio.ai.openai.api.sdk.voice.translation: Sends blocking requests to OpenAI API with given user supplied prompt

T

talkingIn(String) - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.LanguageStage: Denotes a language in which the audio file is
talkingInDeutsch() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.LanguageStage: Denotes a language of the audio file to be German (de)
talkingInEnglish() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.LanguageStage: Denotes a language of the audio file to be English (en)
TEAL - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
TemperatureStage - Class in bg.codexio.ai.openai.api.sdk.chat: Configures the temperature or in other words, the creativity of the model.
TemperatureStage - Class in bg.codexio.ai.openai.api.sdk.voice.transcription: Configures the temperature or in other words, the creativity of the model.
TemperatureStage - Class in bg.codexio.ai.openai.api.sdk.voice.translation: Configures the temperature or in other words, the creativity of the model.
TemperatureStage(ChatHttpExecutor, ChatMessageRequest.Builder) - Constructor for class bg.codexio.ai.openai.api.sdk.chat.TemperatureStage
TerminalStage - Interface in bg.codexio.ai.openai.api.sdk: Stages which provide the ability to bypass further configurations and go to selecting a runtime.
THE_SAME - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.tolerance.ColorDeviation
then(Consumer<ChatMessageResponse>) - Method in class bg.codexio.ai.openai.api.sdk.chat.AsyncRawPromise: Subscribe to the whole response when all lines are supplied.
then(Consumer<ChatMessageResponse>) - Method in class bg.codexio.ai.openai.api.sdk.vision.AsyncPromise: Subscribe to the whole response when all lines are supplied.
then(Consumer<ChatMessageResponse>, Consumer<String>) - Method in class bg.codexio.ai.openai.api.sdk.vision.AsyncPromise: Subscribe both to each line (whether streamed or from the whole response) and to the whole response when all lines are supplied.
then(Consumer<SpeechTextResponse>) - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.AsyncPromiseStage: Sends request in asynchronous fashion, registers a callback to be called when response arrives.
then(Consumer<SpeechTextResponse>) - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.AsyncPromiseStage: Sends request in asynchronous fashion, registers a callback to be called when response arrives.
then(Consumer<File>) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.AsyncPromiseStage: Sends request in asynchronous fashion, registers a callback to be called when file is downloaded.
then(Consumer<File>, Consumer<Throwable>) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.AsyncPromiseStage: Sends request in asynchronous fashion, registers a callback to be called when file is downloaded.
then(Consumer<String>) - Method in class bg.codexio.ai.openai.api.sdk.chat.AsyncPromise: Subscribe to the answer
then(Consumer<String>, Consumer<ChatMessageResponse>) - Method in class bg.codexio.ai.openai.api.sdk.chat.AsyncRawPromise: Subscribe both to each line (whether streamed or from the whole response) and to the whole response when all lines are supplied.
then(Consumer<String>, Consumer<SpeechTextResponse>) - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.AsyncPromiseStage: Sends request in asynchronous fashion, registers callbacks to be called when response arrives and on each line of the response
then(Consumer<String>, Consumer<SpeechTextResponse>) - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.AsyncPromiseStage: Sends request in asynchronous fashion, registers callbacks to be called when response arrives and on each line of the response
then(Consumer<String>, Consumer<File>, Consumer<Throwable>) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.AsyncPromiseStage: Sends request in asynchronous fashion, registers a callback to be called when file is downloaded and a callback to be called when String/byteArray line
THIRTY_PERCENT - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.tolerance.ColorDeviation
throughHttp(ChatHttpExecutor) - Static method in class bg.codexio.ai.openai.api.sdk.chat.Chat
throughHttp(CreateImageHttpExecutor) - Static method in class bg.codexio.ai.openai.api.sdk.images.Images
throughHttp(EditImageHttpExecutor) - Static method in class bg.codexio.ai.openai.api.sdk.images.Images
throughHttp(ImageVariationHttpExecutor) - Static method in class bg.codexio.ai.openai.api.sdk.images.Images
throughHttp(VisionHttpExecutor) - Static method in class bg.codexio.ai.openai.api.sdk.vision.Vision
throughHttp(SpeechHttpExecutor) - Static method in class bg.codexio.ai.openai.api.sdk.voice.speech.Speech
throughHttp(TranscriptionHttpExecutor) - Static method in class bg.codexio.ai.openai.api.sdk.voice.transcription.Transcription
throughHttp(TranslationHttpExecutor) - Static method in class bg.codexio.ai.openai.api.sdk.voice.translation.Translation
tokens() - Method in class bg.codexio.ai.openai.api.sdk.chat.ManualConfigurationStage: Configures maxTokens, stop and choices number.
TokenStage - Class in bg.codexio.ai.openai.api.sdk.chat: Configures maxTokens, N(choices) and stop.
TokenStage - Class in bg.codexio.ai.openai.api.sdk.vision: Configures maxTokens
tools() - Method in class bg.codexio.ai.openai.api.sdk.chat.ManualConfigurationStage: Configures tools such as functions
ToolStage - Class in bg.codexio.ai.openai.api.sdk.chat: Configures tools such as functions.
transcribe(File) - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.AudioFileStage: Sets local audio file to transcribe.
transcribe(File) - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.PreSimplifiedStage
Transcription - Class in bg.codexio.ai.openai.api.sdk.voice.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 - Class in bg.codexio.ai.openai.api.sdk.voice.transcription: Base for all Transcription stages
TranscriptionRuntimeSelectionStage - Class in bg.codexio.ai.openai.api.sdk.voice.transcription: Configures how the HTTP client to act.
translate(File) - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.AudioFileStage: Sets local audio file to translate.
translate(File) - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.PreSimplifiedStage
Translation - Class in bg.codexio.ai.openai.api.sdk.voice.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 - Class in bg.codexio.ai.openai.api.sdk.voice.translation: Base for all Translation stages
TranslationRuntimeSelectionStage - Class in bg.codexio.ai.openai.api.sdk.voice.translation: Configures how the HTTP client to act.
traveller() - Method in class bg.codexio.ai.openai.api.sdk.chat.MessageStage: Provides context to AI Model to act as a travel advisor.
turboPowered() - Method in class bg.codexio.ai.openai.api.sdk.chat.AIModelStage: Configures the AI Model to be GPT401106Model
TWENTY_PERCENT - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.tolerance.ColorDeviation

U

understanding(ObjectMapper) - Method in class bg.codexio.ai.openai.api.sdk.HttpBuilder: Sets ObjectMapper to be used from the HTTP client.
unguided() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.AsyncPromptStage: No additional prompt is given to the OpenAI API
unguided() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.ReactivePromptStage: Sends request to OpenAI API without additional prompt Notifies the OpenAIHttpExecutor.ReactiveExecution.lines() and OpenAIHttpExecutor.ReactiveExecution.response() when parts (and the whole) of the response is received.
unguided() - Method in class bg.codexio.ai.openai.api.sdk.voice.transcription.SynchronousPromptStage: Sends request to OpenAI API without additional prompt
unguided() - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.AsyncPromptStage: No additional prompt is given to the OpenAI API
unguided() - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.ReactivePromptStage: Sends request to OpenAI API without additional prompt Notifies the OpenAIHttpExecutor.ReactiveExecution.lines() and OpenAIHttpExecutor.ReactiveExecution.response() when parts (and the whole) of the response is received.
unguided() - Method in class bg.codexio.ai.openai.api.sdk.voice.translation.SynchronousPromptStage: Sends request to OpenAI API without additional prompt
unmasked() - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage: Skips the masking stage.
unstyled() - Method in class bg.codexio.ai.openai.api.sdk.images.StyleStage: Sets the style to natural.

V

val() - Method in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
val() - Method in enum class bg.codexio.ai.openai.api.sdk.images.tolerance.ColorDeviation
val() - Method in enum class bg.codexio.ai.openai.api.sdk.Processing
valueOf(String) - Static method in enum class bg.codexio.ai.openai.api.sdk.auth.FromJson.AvailableKeys: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class bg.codexio.ai.openai.api.sdk.images.tolerance.ColorDeviation: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class bg.codexio.ai.openai.api.sdk.Processing: Returns the enum constant of this class with the specified name.
values() - Static method in enum class bg.codexio.ai.openai.api.sdk.auth.FromJson.AvailableKeys: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class bg.codexio.ai.openai.api.sdk.images.tolerance.ColorDeviation: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class bg.codexio.ai.openai.api.sdk.Processing: Returns an array containing the constants of this enum class, in the order they are declared.
VariatingActionTypeStage - Class in bg.codexio.ai.openai.api.sdk.images: Explicit marker action type stage for flows where only creating variations is possible
E.g.
VIOLET - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
VISIBLE_DIFFERENCE - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.tolerance.ColorDeviation
Vision - Class in bg.codexio.ai.openai.api.sdk.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 - Class in bg.codexio.ai.openai.api.sdk.vision
VisionRuntimeSelectionStage - Class in bg.codexio.ai.openai.api.sdk.vision
vivid() - Method in class bg.codexio.ai.openai.api.sdk.images.StyleStage: Sets the style to vivid.
voiceOf(Speaker) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.VoiceStage: Sets a Speaker
VoiceStage - Class in bg.codexio.ai.openai.api.sdk.voice.speech: Configures which person's voice to use

W

whenDownloaded(File, Consumer<File[]>) - Method in class bg.codexio.ai.openai.api.sdk.images.AsyncExecutor: Subscribe to the completion of the download of the image in the response.
whenDownloaded(File, Consumer<File[]>, Consumer<Throwable>) - Method in class bg.codexio.ai.openai.api.sdk.images.AsyncExecutor: Subscribe to the completion of the download of the image in the response.
whenDownloadedTo(File) - Method in class bg.codexio.ai.openai.api.sdk.voice.speech.AsyncDownloadStage: Configures target folder to download to
WHITE - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor
withAlphaChannel(BufferedImage, int, double) - Method in class bg.codexio.ai.openai.api.sdk.images.EditingMaskStage
withCallTimeout(long, TimeUnit) - Method in class bg.codexio.ai.openai.api.sdk.HttpBuilder: Configures HTTP Call Timeout
withChoices(Integer) - Method in class bg.codexio.ai.openai.api.sdk.images.ChoicesStage
withConnectTimeout(long, TimeUnit) - Method in class bg.codexio.ai.openai.api.sdk.HttpBuilder: Configures HTTP Connect Timeout
withContext(String) - Method in class bg.codexio.ai.openai.api.sdk.chat.MessageStage: Provides context to the AI Model.
withFrequencyPenalty(RepetitionPenalty) - Method in class bg.codexio.ai.openai.api.sdk.chat.AccuracyStage: Configures frequencyPenalty
withPresencePenalty(RepetitionPenalty) - Method in class bg.codexio.ai.openai.api.sdk.chat.AccuracyStage: Configures presencePenalty
withReadTimeout(long, TimeUnit) - Method in class bg.codexio.ai.openai.api.sdk.HttpBuilder: Configures HTTP Read Timeout
withRoledMessage(String, String) - Method in class bg.codexio.ai.openai.api.sdk.chat.MessageStage
withSamplingProbability(Creativity) - Method in class bg.codexio.ai.openai.api.sdk.chat.AccuracyStage: Configures topP
withTemperature(Creativity) - Method in class bg.codexio.ai.openai.api.sdk.chat.AccuracyStage: Configures temperature
withTool(ChatTool, boolean) - Method in class bg.codexio.ai.openai.api.sdk.chat.ToolStage: Adds a tool and set it as toolChoice if true.

Y

YELLOW - Enum constant in enum class bg.codexio.ai.openai.api.sdk.images.color.PopularColor

A B C D E F G H I J L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Serialized Form