Package org.springframework.ai.openai.api
package org.springframework.ai.openai.api
-
ClassDescriptionSingle class implementation of the OpenAI Chat Completion API and OpenAI Embedding API.Represents a chat completion response returned by model, based on the provided input.Chat completion choice.Represents a streamed chunk of a chat completion response returned by model, based on the provided input.Chat completion choice.The reason the model stopped generating tokens.Message comprising the conversation.Represents an annotation within a message, specifically for URL citations.A URL citation when using web search.Audio response from the model.The function definition.An array of content parts with a defined type.Shortcut constructor for an image content.Constructor for base64-encoded fileThe role of the author of this message.The relevant tool call.Creates a model request for the given chat conversation.Parameters for audio output.Specifies the output audio format.Specifies the voice type.Helper factory that creates a tool_choice of type 'none', 'auto' or selected function by name.This tool searches the web for relevant results to use in a response.High level guidance for the amount of context window space to use for the search.Approximate location parameters for the search.OpenAI Chat Completion Models.Represents an embedding vector returned by embedding endpoint.List of multiple embedding responses.OpenAI Embeddings Models: Embeddings.Creates an embedding vector representing the input text.Represents a tool the model may call.Function definition.Create a tool of type 'function' and the given function definition.Log probability information for the choice.Message content tokens with log probability information.The most likely tokens and their log probability, at this token position.The type of modality for the model completion.Specifies the processing type used for serving the request.Usage statistics for the completion request.Breakdown of tokens used in a completion.Breakdown of tokens used in the promptTurn audio into text or text into audio.Builder to construct
OpenAiAudioApiinstance.Request to generates audio from the input text.The format to audio in.Builder for the SpeechRequest.The voice to use for synthesis.The Transcription Object represents a verbose json transcription response returned by model, based on the provided input.Segment of the transcribed text and its corresponding details.Extracted word and it corresponding timestamps.The available models for the transcriptions API.Request to transcribe an audio file to text.The format of the transcript and translation outputs, in one of these options: json, text, srt, verbose_json, or vtt.Request to translate an audio file to English.TTS is an AI model that converts text to natural sounding spoken text.Whisper is a general-purpose speech recognition model.Used to deserialize the `embedding` field returned by the model.OpenAI File API.The intended purpose of the uploaded fileOpenAI Image API.Builder to constructOpenAiImageApiinstance.OpenAI Image API model.OpenAI Moderation API.Builder to constructOpenAiModerationApiinstance.Helper class to support Streaming function calling.An object specifying the format that the model must output.JSON schema object that describes the format of the JSON object.