Index (Spring AI Model - OpenAI 1.0.2 API)

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

A

AAC - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.AudioResponseFormat
acceptedPredictionTokens() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage.CompletionTokenDetails: Returns the value of the acceptedPredictionTokens record component.
AI_METADATA_STRING - Static variable in class org.springframework.ai.openai.metadata.audio.OpenAiAudioSpeechResponseMetadata
AI_METADATA_STRING - Static variable in class org.springframework.ai.openai.metadata.audio.OpenAiAudioTranscriptionResponseMetadata
ALLOY - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.Voice: Alloy voice
ALLOY - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice
Annotation(String, OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation: Creates an instance of a Annotation record class.
annotations() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage: Returns the value of the annotations record component.
apiKey(String) - Method in class org.springframework.ai.openai.api.OpenAiApi.Builder
apiKey(String) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.Builder
apiKey(String) - Method in class org.springframework.ai.openai.api.OpenAiImageApi.Builder
apiKey(String) - Method in class org.springframework.ai.openai.api.OpenAiModerationApi.Builder
apiKey(ApiKey) - Method in class org.springframework.ai.openai.api.OpenAiApi.Builder
apiKey(ApiKey) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.Builder
apiKey(ApiKey) - Method in class org.springframework.ai.openai.api.OpenAiImageApi.Builder
apiKey(ApiKey) - Method in class org.springframework.ai.openai.api.OpenAiModerationApi.Builder
approximate() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation: Returns the value of the approximate record component.
Approximate(String, String, String, String) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation.Approximate: Creates an instance of a Approximate record class.
arguments() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ChatCompletionFunction: Returns the value of the arguments record component.
ASH - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.Voice: Ash voice
ASH - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice
ASSISTANT - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Role: Assistant message.
AUDIO - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.OutputModality
audioOutput() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage: Returns the value of the audioOutput record component.
AudioOutput(String, String, Long, String) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.AudioOutput: Creates an instance of a AudioOutput record class.
audioParameters() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the audioParameters record component.
AudioParameters(OpenAiApi.ChatCompletionRequest.AudioParameters.Voice, OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters: Creates an instance of a AudioParameters record class.
audioTokens() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage.CompletionTokenDetails: Returns the value of the audioTokens record component.
audioTokens() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage.PromptTokensDetails: Returns the value of the audioTokens record component.
AUTO - Static variable in class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.ToolChoiceBuilder: Model can pick between generating a message or calling a function.
avgLogprob() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Segment: Returns the value of the avgLogprob record component.

B

b64Json() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.Data: Returns the value of the b64Json record component.
b64Json() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Data: Returns the value of the b64Json record component.
BALLAD - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.Voice: Ballad voice
BALLAD - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice
baseUrl(String) - Method in class org.springframework.ai.openai.api.OpenAiApi.Builder
baseUrl(String) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.Builder
baseUrl(String) - Method in class org.springframework.ai.openai.api.OpenAiImageApi.Builder
baseUrl(String) - Method in class org.springframework.ai.openai.api.OpenAiModerationApi.Builder
build() - Method in class org.springframework.ai.openai.api.OpenAiApi.Builder
build() - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.Builder
build() - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Builder
build() - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.Builder
build() - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest.Builder
build() - Method in class org.springframework.ai.openai.api.OpenAiImageApi.Builder
build() - Method in class org.springframework.ai.openai.api.OpenAiModerationApi.Builder
build() - Method in class org.springframework.ai.openai.api.ResponseFormat.Builder
build() - Method in class org.springframework.ai.openai.api.ResponseFormat.JsonSchema.Builder
build() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder
build() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder
build() - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder
build() - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
build() - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder
build() - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder
build() - Method in class org.springframework.ai.openai.OpenAiModerationOptions.Builder
builder() - Static method in class org.springframework.ai.openai.api.OpenAiApi
builder() - Static method in class org.springframework.ai.openai.api.OpenAiAudioApi
builder() - Static method in record class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest
builder() - Static method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest
builder() - Static method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest
builder() - Static method in class org.springframework.ai.openai.api.OpenAiImageApi
builder() - Static method in class org.springframework.ai.openai.api.OpenAiModerationApi
builder() - Static method in class org.springframework.ai.openai.api.ResponseFormat
builder() - Static method in class org.springframework.ai.openai.api.ResponseFormat.JsonSchema
builder() - Static method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
builder() - Static method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
builder() - Static method in class org.springframework.ai.openai.OpenAiChatModel
builder() - Static method in class org.springframework.ai.openai.OpenAiChatOptions
builder() - Static method in class org.springframework.ai.openai.OpenAiEmbeddingOptions
builder() - Static method in class org.springframework.ai.openai.OpenAiImageOptions
builder() - Static method in class org.springframework.ai.openai.OpenAiModerationOptions
Builder() - Constructor for class org.springframework.ai.openai.api.OpenAiApi.Builder
Builder() - Constructor for class org.springframework.ai.openai.api.OpenAiAudioApi.Builder
Builder() - Constructor for class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Builder
Builder() - Constructor for class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.Builder
Builder() - Constructor for class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest.Builder
Builder() - Constructor for class org.springframework.ai.openai.api.OpenAiImageApi.Builder
Builder() - Constructor for class org.springframework.ai.openai.api.OpenAiModerationApi.Builder
Builder() - Constructor for class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder
Builder() - Constructor for class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder
Builder() - Constructor for class org.springframework.ai.openai.OpenAiChatOptions.Builder
Builder() - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder
Builder() - Constructor for class org.springframework.ai.openai.OpenAiImageOptions.Builder
Builder(OpenAiApi) - Constructor for class org.springframework.ai.openai.api.OpenAiApi.Builder
Builder(OpenAiAudioTranscriptionOptions) - Constructor for class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder
Builder(OpenAiChatModel) - Constructor for class org.springframework.ai.openai.OpenAiChatModel.Builder
Builder(OpenAiChatOptions) - Constructor for class org.springframework.ai.openai.OpenAiChatOptions.Builder
Builder(OpenAiImageOptions) - Constructor for class org.springframework.ai.openai.OpenAiImageOptions.Builder

C

cachedTokens() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage.PromptTokensDetails: Returns the value of the cachedTokens record component.
call(String) - Method in interface org.springframework.ai.openai.audio.speech.SpeechModel: Generates spoken audio from the provided text message.
call(String) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel
call(AudioTranscriptionPrompt) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel
call(Prompt) - Method in class org.springframework.ai.openai.OpenAiChatModel
call(EmbeddingRequest) - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel
call(ImagePrompt) - Method in class org.springframework.ai.openai.OpenAiImageModel
call(ModerationPrompt) - Method in class org.springframework.ai.openai.OpenAiModerationModel
call(SpeechPrompt) - Method in interface org.springframework.ai.openai.audio.speech.SpeechModel: Sends a speech request to the OpenAI TTS API and returns the resulting speech response.
call(SpeechPrompt) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel
call(Resource) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel
categories() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResult: Returns the value of the categories record component.
Categories(boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Creates an instance of a Categories record class.
categoryScores() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResult: Returns the value of the categoryScores record component.
CategoryScores(double, double, double, double, double, double, double, double, double, double, double) - Constructor for record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Creates an instance of a CategoryScores record class.
ChatCompletion(String, List<OpenAiApi.ChatCompletion.Choice>, Long, String, String, String, String, OpenAiApi.Usage) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion: Creates an instance of a ChatCompletion record class.
ChatCompletionChunk(String, List<OpenAiApi.ChatCompletionChunk.ChunkChoice>, Long, String, String, String, String, OpenAiApi.Usage) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk: Creates an instance of a ChatCompletionChunk record class.
chatCompletionEntity(OpenAiApi.ChatCompletionRequest) - Method in class org.springframework.ai.openai.api.OpenAiApi: Creates a model response for the given chat conversation.
chatCompletionEntity(OpenAiApi.ChatCompletionRequest, MultiValueMap<String, String>) - Method in class org.springframework.ai.openai.api.OpenAiApi: Creates a model response for the given chat conversation.
ChatCompletionFunction(String, String) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ChatCompletionFunction: Creates an instance of a ChatCompletionFunction record class.
ChatCompletionMessage(Object, OpenAiApi.ChatCompletionMessage.Role) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage: Create a chat completion message with the given content and role.
ChatCompletionMessage(Object, OpenAiApi.ChatCompletionMessage.Role, String, String, List<OpenAiApi.ChatCompletionMessage.ToolCall>, String, OpenAiApi.ChatCompletionMessage.AudioOutput, List<OpenAiApi.ChatCompletionMessage.Annotation>) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage: Creates an instance of a ChatCompletionMessage record class.
ChatCompletionRequest(List<OpenAiApi.ChatCompletionMessage>, Boolean) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Shortcut constructor for a chat completion request with the given messages for streaming.
ChatCompletionRequest(List<OpenAiApi.ChatCompletionMessage>, String, Boolean, Map<String, String>, Double, Map<String, Integer>, Boolean, Integer, Integer, Integer, Integer, List<OpenAiApi.OutputModality>, OpenAiApi.ChatCompletionRequest.AudioParameters, Double, ResponseFormat, Integer, String, List<String>, Boolean, OpenAiApi.ChatCompletionRequest.StreamOptions, Double, Double, List<OpenAiApi.FunctionTool>, Object, Boolean, String, String, OpenAiApi.ChatCompletionRequest.WebSearchOptions, String) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Creates an instance of a ChatCompletionRequest record class.
ChatCompletionRequest(List<OpenAiApi.ChatCompletionMessage>, String, Double) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Shortcut constructor for a chat completion request with the given messages, model and temperature.
ChatCompletionRequest(List<OpenAiApi.ChatCompletionMessage>, String, Double, boolean) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Shortcut constructor for a chat completion request with the given messages, model, temperature and control for streaming.
ChatCompletionRequest(List<OpenAiApi.ChatCompletionMessage>, String, List<OpenAiApi.FunctionTool>, Object) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Shortcut constructor for a chat completion request with the given messages, model, tools and tool choice.
ChatCompletionRequest(List<OpenAiApi.ChatCompletionMessage>, String, OpenAiApi.ChatCompletionRequest.AudioParameters, boolean) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Shortcut constructor for a chat completion request with text and audio output.
chatCompletionStream(OpenAiApi.ChatCompletionRequest) - Method in class org.springframework.ai.openai.api.OpenAiApi: Creates a streaming chat response for the given chat conversation.
chatCompletionStream(OpenAiApi.ChatCompletionRequest, MultiValueMap<String, String>) - Method in class org.springframework.ai.openai.api.OpenAiApi: Creates a streaming chat response for the given chat conversation.
CHATGPT_4_O_LATEST - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: The chatgpt-4o-latest model ID continuously points to the version of GPT-4o used in ChatGPT.
Choice(OpenAiApi.ChatCompletionFinishReason, Integer, OpenAiApi.ChatCompletionMessage, OpenAiApi.LogProbs) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion.Choice: Creates an instance of a Choice record class.
choices() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion: Returns the value of the choices record component.
choices() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk: Returns the value of the choices record component.
ChunkChoice(OpenAiApi.ChatCompletionFinishReason, Integer, OpenAiApi.ChatCompletionMessage, OpenAiApi.LogProbs) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk.ChunkChoice: Creates an instance of a ChunkChoice record class.
chunkToChatCompletion(OpenAiApi.ChatCompletionChunk) - Method in class org.springframework.ai.openai.api.OpenAiStreamFunctionCallingHelper: Convert the ChatCompletionChunk into a ChatCompletion.
city() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation.Approximate: Returns the value of the city record component.
clone() - Method in class org.springframework.ai.openai.OpenAiChatModel
completionsPath(String) - Method in class org.springframework.ai.openai.api.OpenAiApi.Builder
completionTokenDetails() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage: Returns the value of the completionTokenDetails record component.
CompletionTokenDetails(Integer, Integer, Integer, Integer) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.Usage.CompletionTokenDetails: Creates an instance of a CompletionTokenDetails record class.
completionTokens() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage: Returns the value of the completionTokens record component.
compressionRatio() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Segment: Returns the value of the compressionRatio record component.
content() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage: Get message content as String.
content() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs: Returns the value of the content record component.
Content(String, Float, List<Integer>, List<OpenAiApi.LogProbs.Content.TopLogProbs>) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content: Creates an instance of a Content record class.
CONTENT_FILTER - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionFinishReason: The content was omitted due to a flag from our content filters.
copy() - Method in class org.springframework.ai.openai.OpenAiChatOptions
copy() - Method in class org.springframework.ai.openai.OpenAiImageOptions: Create a copy of this options instance.
CORAL - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.Voice: Coral voice
CORAL - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice
country() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation.Approximate: Returns the value of the country record component.
create() - Static method in interface org.springframework.ai.openai.metadata.audio.OpenAiAudioSpeechMetadata: Factory method used to construct a new OpenAiAudioSpeechMetadata
created() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion: Returns the value of the created record component.
created() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk: Returns the value of the created record component.
created() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageResponse: Returns the value of the created record component.
createImage(OpenAiImageApi.OpenAiImageRequest) - Method in class org.springframework.ai.openai.api.OpenAiImageApi
createModeration(OpenAiModerationApi.OpenAiModerationRequest) - Method in class org.springframework.ai.openai.api.OpenAiModerationApi
createSpeech(OpenAiAudioApi.SpeechRequest) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi: Request to generates audio from the input text.
createTranscription(OpenAiAudioApi.TranscriptionRequest) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi: Transcribes audio into the input language.
createTranscription(OpenAiAudioApi.TranscriptionRequest, Class<T>) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi: Transcribes audio into the input language.
createTranslation(OpenAiAudioApi.TranslationRequest) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi: Translates audio into English.
createTranslation(OpenAiAudioApi.TranslationRequest, Class<T>) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi: Translates audio into English.

D

DALL_E_2 - Enum constant in enum class org.springframework.ai.openai.api.OpenAiImageApi.ImageModel: The previous DALL·E model released in Nov 2022.
DALL_E_3 - Enum constant in enum class org.springframework.ai.openai.api.OpenAiImageApi.ImageModel: The latest DALL·E model released in Nov 2023.
data() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.AudioOutput: Returns the value of the data record component.
data() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio: Returns the value of the data record component.
data() - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingList: Returns the value of the data record component.
data() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageResponse: Returns the value of the data record component.
Data(String, String, String) - Constructor for record class org.springframework.ai.openai.api.OpenAiImageApi.Data: Creates an instance of a Data record class.
Data(String, String, String) - Constructor for record class org.springframework.ai.openai.api.OpenAiModerationApi.Data: Creates an instance of a Data record class.
DEFAULT_BASE_URL - Static variable in class org.springframework.ai.openai.api.common.OpenAiApiConstants
DEFAULT_CHAT_MODEL - Static variable in class org.springframework.ai.openai.api.OpenAiApi
DEFAULT_EMBEDDING_MODEL - Static variable in class org.springframework.ai.openai.api.OpenAiApi
DEFAULT_IMAGE_MODEL - Static variable in class org.springframework.ai.openai.api.OpenAiImageApi
DEFAULT_MODERATION_MODEL - Static variable in class org.springframework.ai.openai.api.OpenAiModerationApi
defaultOptions(OpenAiChatOptions) - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder
delta() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk.ChunkChoice: Returns the value of the delta record component.
detail() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl: Returns the value of the detail record component.
dimensions() - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest: Returns the value of the dimensions record component.
dimensions(Integer) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder
duration() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse: Returns the value of the duration record component.

E

ECHO - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.Voice: Echo voice
ECHO - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice
embed(Document) - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel
embedding() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Embedding: Returns the value of the embedding record component.
Embedding(Integer, float[]) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.Embedding: Create an embedding with the given index, embedding and object type set to 'embedding'.
Embedding(Integer, float[], String) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.Embedding: Creates an instance of a Embedding record class.
EmbeddingList(String, List<T>, String, OpenAiApi.Usage) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingList: Creates an instance of a EmbeddingList record class.
EmbeddingRequest(T) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest: Create an embedding request with the given input.
EmbeddingRequest(T, String) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest: Create an embedding request with the given input, model and encoding format set to float.
EmbeddingRequest(T, String, String, Integer, String) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest: Creates an instance of a EmbeddingRequest record class.
embeddings(OpenAiApi.EmbeddingRequest<T>) - Method in class org.springframework.ai.openai.api.OpenAiApi: Creates an embedding vector representing the input text or token array.
embeddingsPath(String) - Method in class org.springframework.ai.openai.api.OpenAiApi.Builder
encodingFormat() - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest: Returns the value of the encodingFormat record component.
encodingFormat(String) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder
end() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Segment: Returns the value of the end record component.
end() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Word: Returns the value of the end record component.
endIndex() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation: Returns the value of the endIndex record component.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion.Choice: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk.ChunkChoice: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.AudioOutput: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ChatCompletionFunction: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputFile: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ToolCall: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.StreamOptions: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation.Approximate: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.Embedding: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingList: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content.TopLogProbs: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage.CompletionTokenDetails: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage.PromptTokensDetails: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Segment: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Word: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.Data: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageRequest: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageResponse: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Data: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationRequest: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResponse: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.springframework.ai.openai.api.ResponseFormat
equals(Object) - Method in class org.springframework.ai.openai.api.ResponseFormat.JsonSchema
equals(Object) - Method in class org.springframework.ai.openai.audio.speech.Speech
equals(Object) - Method in class org.springframework.ai.openai.audio.speech.SpeechMessage
equals(Object) - Method in class org.springframework.ai.openai.audio.speech.SpeechPrompt
equals(Object) - Method in class org.springframework.ai.openai.audio.speech.SpeechResponse
equals(Object) - Method in class org.springframework.ai.openai.metadata.OpenAiImageGenerationMetadata
equals(Object) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
equals(Object) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
equals(Object) - Method in class org.springframework.ai.openai.OpenAiChatOptions
equals(Object) - Method in class org.springframework.ai.openai.OpenAiImageOptions
expiresAt() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.AudioOutput: Returns the value of the expiresAt record component.
extractAiResponseHeaders(ResponseEntity<?>) - Static method in class org.springframework.ai.openai.metadata.support.OpenAiResponseHeaderExtractor

F

FABLE - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.Voice: Fable voice
FABLE - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice
file() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest: Returns the value of the file record component.
file() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest: Returns the value of the file record component.
file(byte[]) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.Builder
file(byte[]) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest.Builder
fileData() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputFile: Returns the value of the fileData record component.
filename() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputFile: Returns the value of the filename record component.
fileName() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest: Returns the value of the fileName record component.
fileName() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest: Returns the value of the fileName record component.
fileName(String) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.Builder
fileName(String) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest.Builder
finishReason() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion.Choice: Returns the value of the finishReason record component.
finishReason() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk.ChunkChoice: Returns the value of the finishReason record component.
FLAC - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat: FLAC format
FLAC - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.AudioResponseFormat
flagged() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResult: Returns the value of the flagged record component.
format() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio: Returns the value of the format record component.
format() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters: Returns the value of the format record component.
frequencyPenalty() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the frequencyPenalty record component.
frequencyPenalty(Double) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
from(String) - Static method in class org.springframework.ai.openai.metadata.audio.OpenAiAudioSpeechResponseMetadata
from(String) - Static method in class org.springframework.ai.openai.metadata.audio.OpenAiAudioTranscriptionResponseMetadata
from(OpenAiAudioApi.StructuredResponse) - Static method in class org.springframework.ai.openai.metadata.audio.OpenAiAudioSpeechResponseMetadata
from(OpenAiAudioApi.StructuredResponse) - Static method in class org.springframework.ai.openai.metadata.audio.OpenAiAudioTranscriptionResponseMetadata
fromOptions(OpenAiChatOptions) - Static method in class org.springframework.ai.openai.OpenAiChatOptions
fromOptions(OpenAiImageOptions) - Static method in class org.springframework.ai.openai.OpenAiImageOptions: Create a new OpenAiImageOptions instance from an existing one.
function() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ToolCall: Returns the value of the function record component.
Function(String, String, String) - Constructor for class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Function: Create tool function definition.
Function(String, String, Map<String, Object>, Boolean) - Constructor for class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Function: Create tool function definition.
FUNCTION - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Type: Function tool type.
FUNCTION(String) - Static method in class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.ToolChoiceBuilder: Specifying a particular function forces the model to call that function.
FunctionTool() - Constructor for class org.springframework.ai.openai.api.OpenAiApi.FunctionTool
FunctionTool(OpenAiApi.FunctionTool.Function) - Constructor for class org.springframework.ai.openai.api.OpenAiApi.FunctionTool: Create a tool of type 'function' and the given function definition.
FunctionTool(OpenAiApi.FunctionTool.Type, OpenAiApi.FunctionTool.Function) - Constructor for class org.springframework.ai.openai.api.OpenAiApi.FunctionTool: Create a tool of type 'function' and the given function definition.

G

getDefaultOptions() - Method in class org.springframework.ai.openai.OpenAiChatModel
getDefaultOptions() - Method in class org.springframework.ai.openai.OpenAiModerationModel
getDescription() - Method in class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Function
getDescription() - Method in enum class org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders
getDimensions() - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions
getEncodingFormat() - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions
getFrequencyPenalty() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getFunction() - Method in class org.springframework.ai.openai.api.OpenAiApi.FunctionTool
getGranularityType() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
getHeight() - Method in class org.springframework.ai.openai.OpenAiImageOptions
getHttpHeaders() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getInput() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
getInstructions() - Method in class org.springframework.ai.openai.audio.speech.SpeechPrompt
getInternalToolExecutionEnabled() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getJsonSchema() - Method in class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Function
getJsonSchema() - Method in class org.springframework.ai.openai.api.ResponseFormat
getLanguage() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
getLogitBias() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getLogprobs() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getMaxCompletionTokens() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getMaxTokens() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getMetadata() - Method in class org.springframework.ai.openai.audio.speech.Speech
getMetadata() - Method in class org.springframework.ai.openai.audio.speech.SpeechResponse
getMetadata() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getModel() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
getModel() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
getModel() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getModel() - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions
getModel() - Method in class org.springframework.ai.openai.OpenAiImageOptions
getModel() - Method in class org.springframework.ai.openai.OpenAiModerationOptions
getN() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getN() - Method in class org.springframework.ai.openai.OpenAiImageOptions
getName() - Method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel
getName() - Method in class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Function
getName() - Method in class org.springframework.ai.openai.api.ResponseFormat.JsonSchema
getName() - Method in enum class org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders
getOptions() - Method in class org.springframework.ai.openai.audio.speech.SpeechPrompt
getOutput() - Method in class org.springframework.ai.openai.audio.speech.Speech
getOutputAudio() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getOutputModalities() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getParallelToolCalls() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getParameters() - Method in class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Function
getPresencePenalty() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getPrompt() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
getQuality() - Method in class org.springframework.ai.openai.OpenAiImageOptions
getRateLimit() - Method in class org.springframework.ai.openai.metadata.audio.OpenAiAudioSpeechResponseMetadata
getRateLimit() - Method in class org.springframework.ai.openai.metadata.audio.OpenAiAudioTranscriptionResponseMetadata
getReasoningEffort() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getRequestsLimit() - Method in class org.springframework.ai.openai.metadata.OpenAiRateLimit
getRequestsRemaining() - Method in class org.springframework.ai.openai.metadata.OpenAiRateLimit
getRequestsReset() - Method in class org.springframework.ai.openai.metadata.OpenAiRateLimit
getResponseFormat() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
getResponseFormat() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
getResponseFormat() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getResponseFormat() - Method in class org.springframework.ai.openai.OpenAiImageOptions
getResponseType() - Method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptResponseFormat
getResult() - Method in class org.springframework.ai.openai.audio.speech.SpeechResponse
getResults() - Method in class org.springframework.ai.openai.audio.speech.SpeechResponse
getRevisedPrompt() - Method in class org.springframework.ai.openai.metadata.OpenAiImageGenerationMetadata
getSchema() - Method in class org.springframework.ai.openai.api.ResponseFormat
getSchema() - Method in class org.springframework.ai.openai.api.ResponseFormat.JsonSchema
getSeed() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getSize() - Method in class org.springframework.ai.openai.OpenAiImageOptions
getSpeed() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
getStop() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getStopSequences() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getStore() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getStreamOptions() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getStreamUsage() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getStrict() - Method in class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Function
getStrict() - Method in class org.springframework.ai.openai.api.ResponseFormat.JsonSchema
getStyle() - Method in class org.springframework.ai.openai.OpenAiImageOptions
getTemperature() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
getTemperature() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getText() - Method in class org.springframework.ai.openai.audio.speech.SpeechMessage: Returns the text of this speech message.
getTextContent(List<OpenAiApi.ChatCompletionMessage.MediaContent>) - Static method in class org.springframework.ai.openai.api.OpenAiApi: Returns a string containing all text values from the given media content list.
getTokensLimit() - Method in class org.springframework.ai.openai.metadata.OpenAiRateLimit
getTokensRemaining() - Method in class org.springframework.ai.openai.metadata.OpenAiRateLimit
getTokensReset() - Method in class org.springframework.ai.openai.metadata.OpenAiRateLimit
getToolCallbacks() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getToolChoice() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getToolContext() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getToolNames() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getTools() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getTopK() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getTopLogprobs() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getTopP() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getType() - Method in class org.springframework.ai.openai.api.OpenAiApi.FunctionTool
getType() - Method in class org.springframework.ai.openai.api.ResponseFormat
getUser() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getUser() - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions
getUser() - Method in class org.springframework.ai.openai.OpenAiImageOptions
getValue() - Method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel
getValue() - Method in enum class org.springframework.ai.openai.api.OpenAiApi.EmbeddingModel
getValue() - Method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.AudioResponseFormat
getValue() - Method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice
getValue() - Method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.GranularityType
getValue() - Method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptResponseFormat
getValue() - Method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TtsModel
getValue() - Method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.WhisperModel
getValue() - Method in enum class org.springframework.ai.openai.api.OpenAiImageApi.ImageModel
getVerbosity() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getVoice() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
getWebSearchOptions() - Method in class org.springframework.ai.openai.OpenAiChatOptions
getWidth() - Method in class org.springframework.ai.openai.OpenAiImageOptions
GPT_3_5_TURBO - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-3.5 Turbo models can understand and generate natural language or code and have been optimized for chat using the Chat Completions API but work well for non-chat tasks as well.
GPT_3_5_TURBO_INSTRUCT - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-3.5 Turbo Instruct has similar capabilities to GPT-3 era models.
GPT_4 - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-4 is an older version of a high-intelligence GPT model, usable in Chat Completions.
GPT_4_1 - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-4.1 is the flagship model for complex tasks.
GPT_4_1_MINI - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-4.1-mini provides a balance between intelligence, speed, and cost that makes it an attractive model for many use cases.
GPT_4_1_NANO - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-4.1-nano is the fastest, most cost-effective GPT-4.1 model.
GPT_4_O - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-4o (“o” for “omni”) is the versatile, high-intelligence flagship model.
GPT_4_O_AUDIO_PREVIEW - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-4o Audio Preview represents a preview release of models that accept audio inputs and outputs via the Chat Completions REST API.
GPT_4_O_MINI - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-4o-mini is a fast, affordable small model for focused tasks.
GPT_4_O_MINI_AUDIO_PREVIEW - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-4o-mini Audio Preview is a preview release model that accepts audio inputs and outputs and can be used in the Chat Completions REST API.
GPT_4_O_MINI_SEARCH_PREVIEW - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-4o mini Search Preview is a specialized model for web search in Chat Completions.
GPT_4_O_MINI_TTS - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TtsModel: Text-to-speech model powered by GPT-4o mini
GPT_4_O_SEARCH_PREVIEW - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-4o Search Preview is a specialized model for web search in Chat Completions.
GPT_4_TURBO - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-4 Turbo is the next generation of GPT-4, an older high-intelligence GPT model.
GPT_4O_MINI_REALTIME_PREVIEW - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-4o-mini Realtime model, is capable of responding to audio and text inputs in realtime over WebRTC or a WebSocket interface.
GPT_4O_REALTIME_PREVIEW - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-4o Realtime model, is capable of responding to audio and text inputs in realtime over WebRTC or a WebSocket interface.
GPT_5 - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-5 is the next-generation flagship model with enhanced capabilities for complex reasoning and problem-solving tasks.
GPT_5_CHAT_LATEST - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-5 Chat points to the GPT-5 snapshot currently used in ChatGPT.
GPT_5_MINI - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-5 mini is a faster, more cost-efficient version of GPT-5.
GPT_5_NANO - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: GPT-5 Nano is the fastest, cheapest version of GPT-5.
granularityType() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest: Returns the value of the granularityType record component.
granularityType(OpenAiAudioApi.TranscriptionRequest.GranularityType) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.Builder
granularityType(OpenAiAudioApi.TranscriptionRequest.GranularityType) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder

H

harassment() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Returns the value of the harassment record component.
harassment() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Returns the value of the harassment record component.
harassmentThreatening() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Returns the value of the harassmentThreatening record component.
harassmentThreatening() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Returns the value of the harassmentThreatening record component.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion.Choice: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk.ChunkChoice: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.AudioOutput: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ChatCompletionFunction: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputFile: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ToolCall: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.StreamOptions: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation.Approximate: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Embedding: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingList: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content.TopLogProbs: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage.CompletionTokenDetails: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage.PromptTokensDetails: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Segment: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Word: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.Data: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageRequest: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageResponse: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Data: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationRequest: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResponse: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResult: Returns a hash code value for this object.
hashCode() - Method in class org.springframework.ai.openai.api.ResponseFormat
hashCode() - Method in class org.springframework.ai.openai.api.ResponseFormat.JsonSchema
hashCode() - Method in class org.springframework.ai.openai.audio.speech.Speech
hashCode() - Method in class org.springframework.ai.openai.audio.speech.SpeechMessage
hashCode() - Method in class org.springframework.ai.openai.audio.speech.SpeechPrompt
hashCode() - Method in class org.springframework.ai.openai.audio.speech.SpeechResponse
hashCode() - Method in class org.springframework.ai.openai.metadata.OpenAiImageGenerationMetadata
hashCode() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
hashCode() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
hashCode() - Method in class org.springframework.ai.openai.OpenAiChatOptions
hashCode() - Method in class org.springframework.ai.openai.OpenAiImageOptions
hate() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Returns the value of the hate record component.
hate() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Returns the value of the hate record component.
hateThreatening() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Returns the value of the hateThreatening record component.
hateThreatening() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Returns the value of the hateThreatening record component.
headers(MultiValueMap<String, String>) - Method in class org.springframework.ai.openai.api.OpenAiApi.Builder
headers(MultiValueMap<String, String>) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.Builder
headers(MultiValueMap<String, String>) - Method in class org.springframework.ai.openai.api.OpenAiImageApi.Builder
headers(MultiValueMap<String, String>) - Method in class org.springframework.ai.openai.api.OpenAiModerationApi.Builder
height(Integer) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder
HIGH - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize: High context size.
httpHeaders(Map<String, String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder

I

id() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion: Returns the value of the id record component.
id() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk: Returns the value of the id record component.
id() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.AudioOutput: Returns the value of the id record component.
id() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ToolCall: Returns the value of the id record component.
id() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Segment: Returns the value of the id record component.
id() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResponse: Returns the value of the id record component.
ImageResponseMetadata - Interface in org.springframework.ai.openai
imagesPath(String) - Method in class org.springframework.ai.openai.api.OpenAiImageApi.Builder
imageUrl() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent: Returns the value of the imageUrl record component.
ImageUrl(String) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl
ImageUrl(String, String) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl: Creates an instance of a ImageUrl record class.
INCLUDE_USAGE - Static variable in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.StreamOptions
includeUsage() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.StreamOptions: Returns the value of the includeUsage record component.
index() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion.Choice: Returns the value of the index record component.
index() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk.ChunkChoice: Returns the value of the index record component.
index() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ToolCall: Returns the value of the index record component.
index() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Embedding: Returns the value of the index record component.
input() - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest: Returns the value of the input record component.
input() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest: Returns the value of the input record component.
input(String) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Builder
input(String) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder
inputAudio() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent: Returns the value of the inputAudio record component.
InputAudio(String, OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio.Format) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio: Creates an instance of a InputAudio record class.
inputFile() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent: Returns the value of the inputFile record component.
InputFile(String, String) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputFile: Creates an instance of a InputFile record class.
internalCall(Prompt, ChatResponse) - Method in class org.springframework.ai.openai.OpenAiChatModel
internalStream(Prompt, ChatResponse) - Method in class org.springframework.ai.openai.OpenAiChatModel
internalToolExecutionEnabled(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
isJsonType() - Method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptResponseFormat
isStreamingToolFunctionCall(OpenAiApi.ChatCompletionChunk) - Method in class org.springframework.ai.openai.api.OpenAiStreamFunctionCallingHelper
isStreamingToolFunctionCallFinish(OpenAiApi.ChatCompletionChunk) - Method in class org.springframework.ai.openai.api.OpenAiStreamFunctionCallingHelper

J

JSON - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptResponseFormat
JSON_OBJECT - Enum constant in enum class org.springframework.ai.openai.api.ResponseFormat.Type: Enables JSON mode, which guarantees the message the model generates is valid JSON.
JSON_SCHEMA - Enum constant in enum class org.springframework.ai.openai.api.ResponseFormat.Type: Enables Structured Outputs which guarantees the model will match your supplied JSON schema.
jsonSchema(String) - Method in class org.springframework.ai.openai.api.ResponseFormat.Builder
jsonSchema(ResponseFormat.JsonSchema) - Method in class org.springframework.ai.openai.api.ResponseFormat.Builder
JsonSchema() - Constructor for class org.springframework.ai.openai.api.ResponseFormat.JsonSchema

L

language() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse: Returns the value of the language record component.
language() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest: Returns the value of the language record component.
language(String) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.Builder
language(String) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder
LENGTH - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionFinishReason: The maximum number of tokens specified in the request was reached.
logitBias() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the logitBias record component.
logitBias(Map<String, Integer>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
logprob() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content: Returns the value of the logprob record component.
logprob() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content.TopLogProbs: Returns the value of the logprob record component.
logprobs() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion.Choice: Returns the value of the logprobs record component.
logprobs() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk.ChunkChoice: Returns the value of the logprobs record component.
logprobs() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the logprobs record component.
logprobs(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
LogProbs(List<OpenAiApi.LogProbs.Content>, List<OpenAiApi.LogProbs.Content>) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.LogProbs: Creates an instance of a LogProbs record class.
LOW - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize: Low context size.

M

maxCompletionTokens() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the maxCompletionTokens record component.
maxCompletionTokens(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder: Sets an upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.
maxTokens() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the maxTokens record component.
maxTokens(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder: Sets the maximum number of tokens to generate in the chat completion.
MediaContent(String) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent: Shortcut constructor for a text content.
MediaContent(String, String, OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl, OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio, OpenAiApi.ChatCompletionMessage.MediaContent.InputFile) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent: Creates an instance of a MediaContent record class.
MediaContent(OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent: Shortcut constructor for an image content.
MediaContent(OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent: Shortcut constructor for an audio content.
MediaContent(OpenAiApi.ChatCompletionMessage.MediaContent.InputFile) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent: Shortcut constructor for a file content
MEDIUM - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize: Medium context size.
merge(OpenAiApi.ChatCompletionChunk, OpenAiApi.ChatCompletionChunk) - Method in class org.springframework.ai.openai.api.OpenAiStreamFunctionCallingHelper: Merge the previous and current ChatCompletionChunk into a single one.
message() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion.Choice: Returns the value of the message record component.
messages() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the messages record component.
metadata() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the metadata record component.
metadata(Map<String, String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
model() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion: Returns the value of the model record component.
model() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk: Returns the value of the model record component.
model() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the model record component.
model() - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingList: Returns the value of the model record component.
model() - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest: Returns the value of the model record component.
model() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest: Returns the value of the model record component.
model() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest: Returns the value of the model record component.
model() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest: Returns the value of the model record component.
model() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageRequest: Returns the value of the model record component.
model() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationRequest: Returns the value of the model record component.
model() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResponse: Returns the value of the model record component.
model(String) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Builder
model(String) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.Builder
model(String) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest.Builder
model(String) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder
model(String) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder
model(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
model(String) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder
model(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder
model(String) - Method in class org.springframework.ai.openai.OpenAiModerationOptions.Builder
model(OpenAiApi.ChatModel) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
MP3 - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio.Format: MP3 audio format
MP3 - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat: MP3 format
MP3 - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.AudioResponseFormat
mutate() - Method in class org.springframework.ai.openai.api.OpenAiApi: Returns a builder pre-populated with the current configuration for mutation.
mutate() - Method in class org.springframework.ai.openai.OpenAiChatModel: Returns a builder pre-populated with the current configuration for mutation.

N

n() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the n record component.
n() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageRequest: Returns the value of the n record component.
N(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
N(Integer) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder
name() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ChatCompletionFunction: Returns the value of the name record component.
name() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage: Returns the value of the name record component.
name(String) - Method in class org.springframework.ai.openai.api.ResponseFormat.JsonSchema.Builder
NONE - Static variable in class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.ToolChoiceBuilder: Model will not call a function and instead generates a message
noSpeechProb() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Segment: Returns the value of the noSpeechProb record component.
NOVA - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.Voice: Nova voice
NOVA - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice
NULL - Static variable in interface org.springframework.ai.openai.metadata.audio.OpenAiAudioSpeechMetadata
NULL - Static variable in class org.springframework.ai.openai.metadata.audio.OpenAiAudioSpeechResponseMetadata
NULL - Static variable in class org.springframework.ai.openai.metadata.audio.OpenAiAudioTranscriptionResponseMetadata

O

O1 - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: The o1 series of models are trained with reinforcement learning to perform complex reasoning.
O1_MINI - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: o1-mini is a faster and more affordable reasoning model compared to o1.
O1_PRO - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: The o1-pro model, part of the o1 series trained with reinforcement learning for complex reasoning, uses more compute to think harder and provide consistently better answers.
O3 - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: o3 is a well-rounded and powerful model across domains.
O3_MINI - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: o3-mini is a small reasoning model, providing high intelligence at cost and latency targets similar to o1-mini.
O4_MINI - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: o4-mini is the latest small o-series model.
object() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion: Returns the value of the object record component.
object() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk: Returns the value of the object record component.
object() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Embedding: Returns the value of the object record component.
object() - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingList: Returns the value of the object record component.
observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder
ONYX - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.Voice: Onyx voice
ONYX - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice
openAiApi(OpenAiApi) - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder
OpenAiApi - Class in org.springframework.ai.openai.api: Single class implementation of the OpenAI Chat Completion API and OpenAI Embedding API.
OpenAiApi(String, ApiKey, MultiValueMap<String, String>, String, String, RestClient.Builder, WebClient.Builder, ResponseErrorHandler) - Constructor for class org.springframework.ai.openai.api.OpenAiApi: Create a new chat completion api.
OpenAiApi.Builder - Class in org.springframework.ai.openai.api
OpenAiApi.ChatCompletion - Record Class in org.springframework.ai.openai.api: Represents a chat completion response returned by model, based on the provided input.
OpenAiApi.ChatCompletion.Choice - Record Class in org.springframework.ai.openai.api: Chat completion choice.
OpenAiApi.ChatCompletionChunk - Record Class in org.springframework.ai.openai.api: Represents a streamed chunk of a chat completion response returned by model, based on the provided input.
OpenAiApi.ChatCompletionChunk.ChunkChoice - Record Class in org.springframework.ai.openai.api: Chat completion choice.
OpenAiApi.ChatCompletionFinishReason - Enum Class in org.springframework.ai.openai.api: The reason the model stopped generating tokens.
OpenAiApi.ChatCompletionMessage - Record Class in org.springframework.ai.openai.api: Message comprising the conversation.
OpenAiApi.ChatCompletionMessage.Annotation - Record Class in org.springframework.ai.openai.api: Represents an annotation within a message, specifically for URL citations.
OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation - Record Class in org.springframework.ai.openai.api: A URL citation when using web search.
OpenAiApi.ChatCompletionMessage.AudioOutput - Record Class in org.springframework.ai.openai.api: Audio response from the model.
OpenAiApi.ChatCompletionMessage.ChatCompletionFunction - Record Class in org.springframework.ai.openai.api: The function definition.
OpenAiApi.ChatCompletionMessage.MediaContent - Record Class in org.springframework.ai.openai.api: An array of content parts with a defined type.
OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl - Record Class in org.springframework.ai.openai.api: Shortcut constructor for an image content.
OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio - Record Class in org.springframework.ai.openai.api
OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio.Format - Enum Class in org.springframework.ai.openai.api
OpenAiApi.ChatCompletionMessage.MediaContent.InputFile - Record Class in org.springframework.ai.openai.api: Constructor for base64-encoded file
OpenAiApi.ChatCompletionMessage.Role - Enum Class in org.springframework.ai.openai.api: The role of the author of this message.
OpenAiApi.ChatCompletionMessage.ToolCall - Record Class in org.springframework.ai.openai.api: The relevant tool call.
OpenAiApi.ChatCompletionRequest - Record Class in org.springframework.ai.openai.api: Creates a model request for the given chat conversation.
OpenAiApi.ChatCompletionRequest.AudioParameters - Record Class in org.springframework.ai.openai.api: Parameters for audio output.
OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat - Enum Class in org.springframework.ai.openai.api: Specifies the output audio format.
OpenAiApi.ChatCompletionRequest.AudioParameters.Voice - Enum Class in org.springframework.ai.openai.api: Specifies the voice type.
OpenAiApi.ChatCompletionRequest.StreamOptions - Record Class in org.springframework.ai.openai.api
OpenAiApi.ChatCompletionRequest.ToolChoiceBuilder - Class in org.springframework.ai.openai.api: Helper factory that creates a tool_choice of type 'none', 'auto' or selected function by name.
OpenAiApi.ChatCompletionRequest.WebSearchOptions - Record Class in org.springframework.ai.openai.api: This tool searches the web for relevant results to use in a response.
OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize - Enum Class in org.springframework.ai.openai.api: High level guidance for the amount of context window space to use for the search.
OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation - Record Class in org.springframework.ai.openai.api: Approximate location parameters for the search.
OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation.Approximate - Record Class in org.springframework.ai.openai.api
OpenAiApi.ChatModel - Enum Class in org.springframework.ai.openai.api: OpenAI Chat Completion Models.
OpenAiApi.Embedding - Record Class in org.springframework.ai.openai.api: Represents an embedding vector returned by embedding endpoint.
OpenAiApi.EmbeddingList<T> - Record Class in org.springframework.ai.openai.api: List of multiple embedding responses.
OpenAiApi.EmbeddingModel - Enum Class in org.springframework.ai.openai.api: OpenAI Embeddings Models: Embeddings.
OpenAiApi.EmbeddingRequest<T> - Record Class in org.springframework.ai.openai.api: Creates an embedding vector representing the input text.
OpenAiApi.FunctionTool - Class in org.springframework.ai.openai.api: Represents a tool the model may call.
OpenAiApi.FunctionTool.Function - Class in org.springframework.ai.openai.api: Function definition.
OpenAiApi.FunctionTool.Type - Enum Class in org.springframework.ai.openai.api: Create a tool of type 'function' and the given function definition.
OpenAiApi.LogProbs - Record Class in org.springframework.ai.openai.api: Log probability information for the choice.
OpenAiApi.LogProbs.Content - Record Class in org.springframework.ai.openai.api: Message content tokens with log probability information.
OpenAiApi.LogProbs.Content.TopLogProbs - Record Class in org.springframework.ai.openai.api: The most likely tokens and their log probability, at this token position.
OpenAiApi.OutputModality - Enum Class in org.springframework.ai.openai.api: The type of modality for the model completion.
OpenAiApi.Usage - Record Class in org.springframework.ai.openai.api: Usage statistics for the completion request.
OpenAiApi.Usage.CompletionTokenDetails - Record Class in org.springframework.ai.openai.api: Breakdown of tokens used in a completion.
OpenAiApi.Usage.PromptTokensDetails - Record Class in org.springframework.ai.openai.api: Breakdown of tokens used in the prompt
OpenAiApiClientErrorException - Exception in org.springframework.ai.openai.api.common: Thrown on 4xx client errors, such as 401 - Incorrect API key provided, 401 - You must be a member of an organization to use the API, 429 - Rate limit reached for requests, 429 - You exceeded your current quota , please check your plan and billing details.
OpenAiApiClientErrorException(String) - Constructor for exception org.springframework.ai.openai.api.common.OpenAiApiClientErrorException
OpenAiApiClientErrorException(String, Throwable) - Constructor for exception org.springframework.ai.openai.api.common.OpenAiApiClientErrorException
OpenAiApiConstants - Class in org.springframework.ai.openai.api.common: Common value constants for OpenAI api.
OpenAiApiResponseHeaders - Enum Class in org.springframework.ai.openai.metadata.support: Enumeration of OpenAI API response headers.
OpenAiAudioApi - Class in org.springframework.ai.openai.api: Turn audio into text or text into audio.
OpenAiAudioApi(String, ApiKey, MultiValueMap<String, String>, RestClient.Builder, WebClient.Builder, ResponseErrorHandler) - Constructor for class org.springframework.ai.openai.api.OpenAiAudioApi: Create a new audio api.
OpenAiAudioApi.Builder - Class in org.springframework.ai.openai.api: Builder to construct OpenAiAudioApi instance.
OpenAiAudioApi.SpeechRequest - Record Class in org.springframework.ai.openai.api: Request to generates audio from the input text.
OpenAiAudioApi.SpeechRequest.AudioResponseFormat - Enum Class in org.springframework.ai.openai.api: The format to audio in.
OpenAiAudioApi.SpeechRequest.Builder - Class in org.springframework.ai.openai.api: Builder for the SpeechRequest.
OpenAiAudioApi.SpeechRequest.Voice - Enum Class in org.springframework.ai.openai.api: The voice to use for synthesis.
OpenAiAudioApi.StructuredResponse - Record Class in org.springframework.ai.openai.api: The Transcription Object represents a verbose json transcription response returned by model, based on the provided input.
OpenAiAudioApi.StructuredResponse.Segment - Record Class in org.springframework.ai.openai.api: Segment of the transcribed text and its corresponding details.
OpenAiAudioApi.StructuredResponse.Word - Record Class in org.springframework.ai.openai.api: Extracted word and it corresponding timestamps.
OpenAiAudioApi.TranscriptionRequest - Record Class in org.springframework.ai.openai.api: Request to transcribe an audio file to text.
OpenAiAudioApi.TranscriptionRequest.Builder - Class in org.springframework.ai.openai.api
OpenAiAudioApi.TranscriptionRequest.GranularityType - Enum Class in org.springframework.ai.openai.api
OpenAiAudioApi.TranscriptResponseFormat - Enum Class in org.springframework.ai.openai.api: The format of the transcript and translation outputs, in one of these options: json, text, srt, verbose_json, or vtt.
OpenAiAudioApi.TranslationRequest - Record Class in org.springframework.ai.openai.api: Request to translate an audio file to English.
OpenAiAudioApi.TranslationRequest.Builder - Class in org.springframework.ai.openai.api
OpenAiAudioApi.TtsModel - Enum Class in org.springframework.ai.openai.api: TTS is an AI model that converts text to natural sounding spoken text.
OpenAiAudioApi.WhisperModel - Enum Class in org.springframework.ai.openai.api: Whisper is a general-purpose speech recognition model.
OpenAiAudioSpeechMetadata - Interface in org.springframework.ai.openai.metadata.audio
OpenAiAudioSpeechModel - Class in org.springframework.ai.openai: OpenAI audio speech client implementation for backed by OpenAiAudioApi.
OpenAiAudioSpeechModel(OpenAiAudioApi) - Constructor for class org.springframework.ai.openai.OpenAiAudioSpeechModel: Initializes a new instance of the OpenAiAudioSpeechModel class with the provided OpenAiAudioApi.
OpenAiAudioSpeechModel(OpenAiAudioApi, OpenAiAudioSpeechOptions) - Constructor for class org.springframework.ai.openai.OpenAiAudioSpeechModel: Initializes a new instance of the OpenAiAudioSpeechModel class with the provided OpenAiAudioApi and options.
OpenAiAudioSpeechModel(OpenAiAudioApi, OpenAiAudioSpeechOptions, RetryTemplate) - Constructor for class org.springframework.ai.openai.OpenAiAudioSpeechModel: Initializes a new instance of the OpenAiAudioSpeechModel class with the provided OpenAiAudioApi and options.
OpenAiAudioSpeechOptions - Class in org.springframework.ai.openai: Options for OpenAI text to audio - speech synthesis.
OpenAiAudioSpeechOptions() - Constructor for class org.springframework.ai.openai.OpenAiAudioSpeechOptions
OpenAiAudioSpeechOptions.Builder - Class in org.springframework.ai.openai
OpenAiAudioSpeechResponseMetadata - Class in org.springframework.ai.openai.metadata.audio: Audio speech metadata implementation for OpenAI.
OpenAiAudioSpeechResponseMetadata() - Constructor for class org.springframework.ai.openai.metadata.audio.OpenAiAudioSpeechResponseMetadata
OpenAiAudioSpeechResponseMetadata(RateLimit) - Constructor for class org.springframework.ai.openai.metadata.audio.OpenAiAudioSpeechResponseMetadata
OpenAiAudioTranscriptionModel - Class in org.springframework.ai.openai: OpenAI audio transcription client implementation for backed by OpenAiAudioApi.
OpenAiAudioTranscriptionModel(OpenAiAudioApi) - Constructor for class org.springframework.ai.openai.OpenAiAudioTranscriptionModel: OpenAiAudioTranscriptionModel is a client class used to interact with the OpenAI Audio Transcription API.
OpenAiAudioTranscriptionModel(OpenAiAudioApi, OpenAiAudioTranscriptionOptions) - Constructor for class org.springframework.ai.openai.OpenAiAudioTranscriptionModel: OpenAiAudioTranscriptionModel is a client class used to interact with the OpenAI Audio Transcription API.
OpenAiAudioTranscriptionModel(OpenAiAudioApi, OpenAiAudioTranscriptionOptions, RetryTemplate) - Constructor for class org.springframework.ai.openai.OpenAiAudioTranscriptionModel: OpenAiAudioTranscriptionModel is a client class used to interact with the OpenAI Audio Transcription API.
OpenAiAudioTranscriptionOptions - Class in org.springframework.ai.openai: OpenAI Audio Transcription Options.
OpenAiAudioTranscriptionOptions() - Constructor for class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
OpenAiAudioTranscriptionOptions.Builder - Class in org.springframework.ai.openai
OpenAiAudioTranscriptionResponseMetadata - Class in org.springframework.ai.openai.metadata.audio: Audio transcription metadata implementation for OpenAI.
OpenAiAudioTranscriptionResponseMetadata() - Constructor for class org.springframework.ai.openai.metadata.audio.OpenAiAudioTranscriptionResponseMetadata
OpenAiAudioTranscriptionResponseMetadata(OpenAiRateLimit) - Constructor for class org.springframework.ai.openai.metadata.audio.OpenAiAudioTranscriptionResponseMetadata
OpenAiChatModel - Class in org.springframework.ai.openai: ChatModel and StreamingChatModel implementation for OpenAI backed by OpenAiApi.
OpenAiChatModel(OpenAiApi, OpenAiChatOptions, ToolCallingManager, RetryTemplate, ObservationRegistry) - Constructor for class org.springframework.ai.openai.OpenAiChatModel
OpenAiChatModel(OpenAiApi, OpenAiChatOptions, ToolCallingManager, RetryTemplate, ObservationRegistry, ToolExecutionEligibilityPredicate) - Constructor for class org.springframework.ai.openai.OpenAiChatModel
OpenAiChatModel.Builder - Class in org.springframework.ai.openai
OpenAiChatOptions - Class in org.springframework.ai.openai: Options for the OpenAI Chat API.
OpenAiChatOptions() - Constructor for class org.springframework.ai.openai.OpenAiChatOptions
OpenAiChatOptions.Builder - Class in org.springframework.ai.openai
OpenAiEmbeddingModel - Class in org.springframework.ai.openai: Open AI Embedding Model implementation.
OpenAiEmbeddingModel(OpenAiApi) - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingModel: Constructor for the OpenAiEmbeddingModel class.
OpenAiEmbeddingModel(OpenAiApi, MetadataMode) - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingModel: Initializes a new instance of the OpenAiEmbeddingModel class.
OpenAiEmbeddingModel(OpenAiApi, MetadataMode, OpenAiEmbeddingOptions) - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingModel: Initializes a new instance of the OpenAiEmbeddingModel class.
OpenAiEmbeddingModel(OpenAiApi, MetadataMode, OpenAiEmbeddingOptions, RetryTemplate) - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingModel: Initializes a new instance of the OpenAiEmbeddingModel class.
OpenAiEmbeddingModel(OpenAiApi, MetadataMode, OpenAiEmbeddingOptions, RetryTemplate, ObservationRegistry) - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingModel: Initializes a new instance of the OpenAiEmbeddingModel class.
OpenAiEmbeddingOptions - Class in org.springframework.ai.openai: OpenAI Embedding Options.
OpenAiEmbeddingOptions() - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingOptions
OpenAiEmbeddingOptions.Builder - Class in org.springframework.ai.openai
OpenAiImageApi - Class in org.springframework.ai.openai.api: OpenAI Image API.
OpenAiImageApi(String, ApiKey, MultiValueMap<String, String>, String, RestClient.Builder, ResponseErrorHandler) - Constructor for class org.springframework.ai.openai.api.OpenAiImageApi: Create a new OpenAI Image API with the provided base URL.
OpenAiImageApi.Builder - Class in org.springframework.ai.openai.api: Builder to construct OpenAiImageApi instance.
OpenAiImageApi.Data - Record Class in org.springframework.ai.openai.api
OpenAiImageApi.ImageModel - Enum Class in org.springframework.ai.openai.api: OpenAI Image API model.
OpenAiImageApi.OpenAiImageRequest - Record Class in org.springframework.ai.openai.api
OpenAiImageApi.OpenAiImageResponse - Record Class in org.springframework.ai.openai.api
OpenAiImageGenerationMetadata - Class in org.springframework.ai.openai.metadata
OpenAiImageGenerationMetadata(String) - Constructor for class org.springframework.ai.openai.metadata.OpenAiImageGenerationMetadata
OpenAiImageModel - Class in org.springframework.ai.openai: OpenAiImageModel is a class that implements the ImageModel interface.
OpenAiImageModel(OpenAiImageApi) - Constructor for class org.springframework.ai.openai.OpenAiImageModel: Creates an instance of the OpenAiImageModel.
OpenAiImageModel(OpenAiImageApi, OpenAiImageOptions, RetryTemplate) - Constructor for class org.springframework.ai.openai.OpenAiImageModel: Initializes a new instance of the OpenAiImageModel.
OpenAiImageModel(OpenAiImageApi, OpenAiImageOptions, RetryTemplate, ObservationRegistry) - Constructor for class org.springframework.ai.openai.OpenAiImageModel: Initializes a new instance of the OpenAiImageModel.
OpenAiImageOptions - Class in org.springframework.ai.openai: OpenAI Image API options.
OpenAiImageOptions() - Constructor for class org.springframework.ai.openai.OpenAiImageOptions
OpenAiImageOptions.Builder - Class in org.springframework.ai.openai
OpenAiImageRequest(String, String) - Constructor for record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageRequest
OpenAiImageRequest(String, String, Integer, String, String, String, String, String) - Constructor for record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageRequest: Creates an instance of a OpenAiImageRequest record class.
OpenAiImageResponse(Long, List<OpenAiImageApi.Data>) - Constructor for record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageResponse: Creates an instance of a OpenAiImageResponse record class.
OpenAiModerationApi - Class in org.springframework.ai.openai.api: OpenAI Moderation API.
OpenAiModerationApi(String, ApiKey, MultiValueMap<String, String>, RestClient.Builder, ResponseErrorHandler) - Constructor for class org.springframework.ai.openai.api.OpenAiModerationApi: Create a new OpenAI Moderation API with the provided base URL.
OpenAiModerationApi.Builder - Class in org.springframework.ai.openai.api: Builder to construct OpenAiModerationApi instance.
OpenAiModerationApi.Categories - Record Class in org.springframework.ai.openai.api
OpenAiModerationApi.CategoryScores - Record Class in org.springframework.ai.openai.api
OpenAiModerationApi.Data - Record Class in org.springframework.ai.openai.api
OpenAiModerationApi.OpenAiModerationRequest - Record Class in org.springframework.ai.openai.api
OpenAiModerationApi.OpenAiModerationResponse - Record Class in org.springframework.ai.openai.api
OpenAiModerationApi.OpenAiModerationResult - Record Class in org.springframework.ai.openai.api
OpenAiModerationGenerationMetadata - Class in org.springframework.ai.openai.metadata
OpenAiModerationGenerationMetadata() - Constructor for class org.springframework.ai.openai.metadata.OpenAiModerationGenerationMetadata
OpenAiModerationModel - Class in org.springframework.ai.openai: OpenAiModerationModel is a class that implements the ModerationModel interface.
OpenAiModerationModel(OpenAiModerationApi) - Constructor for class org.springframework.ai.openai.OpenAiModerationModel
OpenAiModerationModel(OpenAiModerationApi, RetryTemplate) - Constructor for class org.springframework.ai.openai.OpenAiModerationModel
OpenAiModerationOptions - Class in org.springframework.ai.openai: OpenAI Moderation API options.
OpenAiModerationOptions() - Constructor for class org.springframework.ai.openai.OpenAiModerationOptions
OpenAiModerationOptions.Builder - Class in org.springframework.ai.openai
OpenAiModerationRequest(String) - Constructor for record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationRequest
OpenAiModerationRequest(String, String) - Constructor for record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationRequest: Creates an instance of a OpenAiModerationRequest record class.
OpenAiModerationResponse(String, String, OpenAiModerationApi.OpenAiModerationResult[]) - Constructor for record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResponse: Creates an instance of a OpenAiModerationResponse record class.
OpenAiModerationResult(boolean, OpenAiModerationApi.Categories, OpenAiModerationApi.CategoryScores) - Constructor for record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResult: Creates an instance of a OpenAiModerationResult record class.
OpenAiRateLimit - Class in org.springframework.ai.openai.metadata: RateLimit implementation for OpenAI.
OpenAiRateLimit(Long, Long, Duration, Long, Long, Duration) - Constructor for class org.springframework.ai.openai.metadata.OpenAiRateLimit
OpenAiResponseHeaderExtractor - Class in org.springframework.ai.openai.metadata.support: Utility used to extract known HTTP response headers for the OpenAI API.
OpenAiRuntimeHints - Class in org.springframework.ai.openai.aot: The OpenAiRuntimeHints class is responsible for registering runtime hints for OpenAI API classes.
OpenAiRuntimeHints() - Constructor for class org.springframework.ai.openai.aot.OpenAiRuntimeHints
OpenAiStreamFunctionCallingHelper - Class in org.springframework.ai.openai.api: Helper class to support Streaming function calling.
OpenAiStreamFunctionCallingHelper() - Constructor for class org.springframework.ai.openai.api.OpenAiStreamFunctionCallingHelper
options - Variable in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder
options - Variable in class org.springframework.ai.openai.OpenAiChatOptions.Builder
options - Variable in class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder
options - Variable in class org.springframework.ai.openai.OpenAiImageOptions.Builder
OPUS - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat: OPUS format
OPUS - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.AudioResponseFormat
org.springframework.ai.openai - package org.springframework.ai.openai
org.springframework.ai.openai.aot - package org.springframework.ai.openai.aot
org.springframework.ai.openai.api - package org.springframework.ai.openai.api
org.springframework.ai.openai.api.common - package org.springframework.ai.openai.api.common
org.springframework.ai.openai.audio.speech - package org.springframework.ai.openai.audio.speech
org.springframework.ai.openai.metadata - package org.springframework.ai.openai.metadata
org.springframework.ai.openai.metadata.audio - package org.springframework.ai.openai.metadata.audio
org.springframework.ai.openai.metadata.support - package org.springframework.ai.openai.metadata.support
outputAudio(OpenAiApi.ChatCompletionRequest.AudioParameters) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
outputModalities() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the outputModalities record component.
outputModalities(List<String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder

P

parallelToolCalls() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the parallelToolCalls record component.
parallelToolCalls(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
PCM - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.AudioResponseFormat
PCM16 - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat: PCM16 format
presencePenalty() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the presencePenalty record component.
presencePenalty(Double) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
probBytes() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content: Returns the value of the probBytes record component.
probBytes() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content.TopLogProbs: Returns the value of the probBytes record component.
prompt() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest: Returns the value of the prompt record component.
prompt() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest: Returns the value of the prompt record component.
prompt() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageRequest: Returns the value of the prompt record component.
prompt() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationRequest: Returns the value of the prompt record component.
prompt(String) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.Builder
prompt(String) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest.Builder
prompt(String) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder
promptTokens() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage: Returns the value of the promptTokens record component.
promptTokensDetails() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage: Returns the value of the promptTokensDetails record component.
PromptTokensDetails(Integer, Integer) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.Usage.PromptTokensDetails: Creates an instance of a PromptTokensDetails record class.
PROVIDER_NAME - Static variable in class org.springframework.ai.openai.api.common.OpenAiApiConstants

Q

quality() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageRequest: Returns the value of the quality record component.
quality(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder

R

rawContent() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage: Returns the value of the rawContent record component.
reasoningEffort() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the reasoningEffort record component.
reasoningEffort(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
reasoningTokens() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage.CompletionTokenDetails: Returns the value of the reasoningTokens record component.
refusal() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage: Returns the value of the refusal record component.
refusal() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs: Returns the value of the refusal record component.
region() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation.Approximate: Returns the value of the region record component.
registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.openai.aot.OpenAiRuntimeHints
rejectedPredictionTokens() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage.CompletionTokenDetails: Returns the value of the rejectedPredictionTokens record component.
REQUESTS_LIMIT_HEADER - Enum constant in enum class org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders
REQUESTS_REMAINING_HEADER - Enum constant in enum class org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders
REQUESTS_RESET_HEADER - Enum constant in enum class org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders
responseErrorHandler(ResponseErrorHandler) - Method in class org.springframework.ai.openai.api.OpenAiApi.Builder
responseErrorHandler(ResponseErrorHandler) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.Builder
responseErrorHandler(ResponseErrorHandler) - Method in class org.springframework.ai.openai.api.OpenAiImageApi.Builder
responseErrorHandler(ResponseErrorHandler) - Method in class org.springframework.ai.openai.api.OpenAiModerationApi.Builder
responseFormat() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the responseFormat record component.
responseFormat() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest: Returns the value of the responseFormat record component.
responseFormat() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest: Returns the value of the responseFormat record component.
responseFormat() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest: Returns the value of the responseFormat record component.
responseFormat() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageRequest: Returns the value of the responseFormat record component.
responseFormat(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder
responseFormat(OpenAiAudioApi.SpeechRequest.AudioResponseFormat) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Builder
responseFormat(OpenAiAudioApi.SpeechRequest.AudioResponseFormat) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder
responseFormat(OpenAiAudioApi.TranscriptResponseFormat) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.Builder
responseFormat(OpenAiAudioApi.TranscriptResponseFormat) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest.Builder
responseFormat(OpenAiAudioApi.TranscriptResponseFormat) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder
responseFormat(ResponseFormat) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
ResponseFormat - Class in org.springframework.ai.openai.api: An object specifying the format that the model must output.
ResponseFormat() - Constructor for class org.springframework.ai.openai.api.ResponseFormat
ResponseFormat(ResponseFormat.Type, String) - Constructor for class org.springframework.ai.openai.api.ResponseFormat
ResponseFormat.Builder - Class in org.springframework.ai.openai.api
ResponseFormat.JsonSchema - Class in org.springframework.ai.openai.api: JSON schema object that describes the format of the JSON object.
ResponseFormat.JsonSchema.Builder - Class in org.springframework.ai.openai.api
ResponseFormat.Type - Enum Class in org.springframework.ai.openai.api
responseType - Variable in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptResponseFormat
restClientBuilder(RestClient.Builder) - Method in class org.springframework.ai.openai.api.OpenAiApi.Builder
restClientBuilder(RestClient.Builder) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.Builder
restClientBuilder(RestClient.Builder) - Method in class org.springframework.ai.openai.api.OpenAiImageApi.Builder
restClientBuilder(RestClient.Builder) - Method in class org.springframework.ai.openai.api.OpenAiModerationApi.Builder
results() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResponse: Returns the value of the results record component.
retryTemplate(RetryTemplate) - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder
revisedPrompt() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.Data: Returns the value of the revisedPrompt record component.
revisedPrompt() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Data: Returns the value of the revisedPrompt record component.
role() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage: Returns the value of the role record component.

S

SAGE - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.Voice: Sage voice
SAGE - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice
schema(String) - Method in class org.springframework.ai.openai.api.ResponseFormat.JsonSchema.Builder
schema(Map<String, Object>) - Method in class org.springframework.ai.openai.api.ResponseFormat.JsonSchema.Builder
searchContextSize() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions: Returns the value of the searchContextSize record component.
seed() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the seed record component.
seed(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
seek() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Segment: Returns the value of the seek record component.
Segment(Integer, Integer, Float, Float, String, List<Integer>, Float, Float, Float, Float) - Constructor for record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Segment: Creates an instance of a Segment record class.
SEGMENT - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.GranularityType
segments() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse: Returns the value of the segments record component.
selfHarm() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Returns the value of the selfHarm record component.
selfHarm() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Returns the value of the selfHarm record component.
selfHarmInstructions() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Returns the value of the selfHarmInstructions record component.
selfHarmInstructions() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Returns the value of the selfHarmInstructions record component.
selfHarmIntent() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Returns the value of the selfHarmIntent record component.
selfHarmIntent() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Returns the value of the selfHarmIntent record component.
serviceTier() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion: Returns the value of the serviceTier record component.
serviceTier() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk: Returns the value of the serviceTier record component.
serviceTier() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the serviceTier record component.
setDescription(String) - Method in class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Function
setDimensions(Integer) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions
setEncodingFormat(String) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions
setFrequencyPenalty(Double) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setFunction(OpenAiApi.FunctionTool.Function) - Method in class org.springframework.ai.openai.api.OpenAiApi.FunctionTool
setGranularityType(OpenAiAudioApi.TranscriptionRequest.GranularityType) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
setHeight(Integer) - Method in class org.springframework.ai.openai.OpenAiImageOptions
setHttpHeaders(Map<String, String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setInput(String) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
setInternalToolExecutionEnabled(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setJsonSchema(String) - Method in class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Function
setJsonSchema(ResponseFormat.JsonSchema) - Method in class org.springframework.ai.openai.api.ResponseFormat
setLanguage(String) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
setLogitBias(Map<String, Integer>) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setLogprobs(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setMaxCompletionTokens(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setMaxTokens(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setMetadata(Map<String, String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setModel(String) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
setModel(String) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
setModel(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setModel(String) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions
setModel(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions
setModel(String) - Method in class org.springframework.ai.openai.OpenAiModerationOptions
setN(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setN(Integer) - Method in class org.springframework.ai.openai.OpenAiImageOptions
setName(String) - Method in class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Function
setObservationConvention(ChatModelObservationConvention) - Method in class org.springframework.ai.openai.OpenAiChatModel: Use the provided convention for reporting observation data
setObservationConvention(EmbeddingModelObservationConvention) - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel: Use the provided convention for reporting observation data
setObservationConvention(ImageModelObservationConvention) - Method in class org.springframework.ai.openai.OpenAiImageModel: Use the provided convention for reporting observation data
setOutputAudio(OpenAiApi.ChatCompletionRequest.AudioParameters) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setOutputModalities(List<String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setParallelToolCalls(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setParameters(Map<String, Object>) - Method in class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Function
setPresencePenalty(Double) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setPrompt(String) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
setQuality(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions
setReasoningEffort(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setResponseFormat(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions
setResponseFormat(OpenAiAudioApi.SpeechRequest.AudioResponseFormat) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
setResponseFormat(OpenAiAudioApi.TranscriptResponseFormat) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
setResponseFormat(ResponseFormat) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setSchema(String) - Method in class org.springframework.ai.openai.api.ResponseFormat
setSeed(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setSize(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions
setSpeed(Float) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
setStop(List<String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setStopSequences(List<String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setStore(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setStreamOptions(OpenAiApi.ChatCompletionRequest.StreamOptions) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setStreamUsage(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setStrict(Boolean) - Method in class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Function
setStyle(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions
setTemperature(Double) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setTemperature(Float) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions
setText(String) - Method in class org.springframework.ai.openai.audio.speech.SpeechMessage: Sets the text of this speech message.
setToolCallbacks(List<ToolCallback>) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setToolChoice(Object) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setToolContext(Map<String, Object>) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setToolNames(Set<String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setTools(List<OpenAiApi.FunctionTool>) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setTopLogprobs(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setTopP(Double) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setType(OpenAiApi.FunctionTool.Type) - Method in class org.springframework.ai.openai.api.OpenAiApi.FunctionTool
setType(ResponseFormat.Type) - Method in class org.springframework.ai.openai.api.ResponseFormat
setUser(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setUser(String) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions
setUser(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions
setVerbosity(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setVoice(String) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
setVoice(OpenAiAudioApi.SpeechRequest.Voice) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
setWebSearchOptions(OpenAiApi.ChatCompletionRequest.WebSearchOptions) - Method in class org.springframework.ai.openai.OpenAiChatOptions
setWidth(Integer) - Method in class org.springframework.ai.openai.OpenAiImageOptions
sexual() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Returns the value of the sexual record component.
sexual() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Returns the value of the sexual record component.
sexualMinors() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Returns the value of the sexualMinors record component.
sexualMinors() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Returns the value of the sexualMinors record component.
SHIMMER - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.Voice: Shimmer voice
SHIMMER - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice
size() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageRequest: Returns the value of the size record component.
Speech - Class in org.springframework.ai.openai.audio.speech: The Speech class represents the result of speech synthesis from an AI model.
Speech(byte[]) - Constructor for class org.springframework.ai.openai.audio.speech.Speech
SpeechMessage - Class in org.springframework.ai.openai.audio.speech: The SpeechMessage class represents a single text message to be converted to speech by the OpenAI TTS API.
SpeechMessage(String) - Constructor for class org.springframework.ai.openai.audio.speech.SpeechMessage: Constructs a new SpeechMessage object with the given text.
SpeechModel - Interface in org.springframework.ai.openai.audio.speech: The SpeechModel interface provides a way to interact with the OpenAI Text-to-Speech (TTS) API.
SpeechPrompt - Class in org.springframework.ai.openai.audio.speech: The SpeechPrompt class represents a request to the OpenAI Text-to-Speech (TTS) API.
SpeechPrompt(String) - Constructor for class org.springframework.ai.openai.audio.speech.SpeechPrompt
SpeechPrompt(String, OpenAiAudioSpeechOptions) - Constructor for class org.springframework.ai.openai.audio.speech.SpeechPrompt
SpeechPrompt(SpeechMessage) - Constructor for class org.springframework.ai.openai.audio.speech.SpeechPrompt
SpeechPrompt(SpeechMessage, OpenAiAudioSpeechOptions) - Constructor for class org.springframework.ai.openai.audio.speech.SpeechPrompt
SpeechRequest(String, String, String, OpenAiAudioApi.SpeechRequest.AudioResponseFormat, Float) - Constructor for record class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest: Creates an instance of a SpeechRequest record class.
SpeechResponse - Class in org.springframework.ai.openai.audio.speech: Creates a new instance of SpeechResponse with the given speech result.
SpeechResponse(Speech) - Constructor for class org.springframework.ai.openai.audio.speech.SpeechResponse: Creates a new instance of SpeechResponse with the given speech result.
SpeechResponse(Speech, OpenAiAudioSpeechResponseMetadata) - Constructor for class org.springframework.ai.openai.audio.speech.SpeechResponse: Creates a new instance of SpeechResponse with the given speech result and speech response metadata.
speed() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest: Returns the value of the speed record component.
speed(Float) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Builder
speed(Float) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder
SRT - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptResponseFormat
start() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Segment: Returns the value of the start record component.
start() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Word: Returns the value of the start record component.
startIndex() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation: Returns the value of the startIndex record component.
stop() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the stop record component.
stop(List<String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
STOP - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionFinishReason: The model hit a natural stop point or a provided stop sequence.
store() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the store record component.
store(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
stream() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the stream record component.
stream(String) - Method in interface org.springframework.ai.openai.audio.speech.StreamingSpeechModel: Generates a stream of audio bytes from the provided text message.
stream(Prompt) - Method in class org.springframework.ai.openai.OpenAiChatModel
stream(OpenAiAudioApi.SpeechRequest) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi: Streams audio generated from the input text.
stream(SpeechPrompt) - Method in interface org.springframework.ai.openai.audio.speech.StreamingSpeechModel: Sends a speech request to the OpenAI TTS API and returns a stream of the resulting speech responses.
stream(SpeechPrompt) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel: Streams the audio response for the given speech prompt.
StreamingSpeechModel - Interface in org.springframework.ai.openai.audio.speech: The StreamingSpeechModel interface provides a way to interact with the OpenAI Text-to-Speech (TTS) API using a streaming approach, allowing you to receive the generated audio in a real-time fashion.
streamOptions() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the streamOptions record component.
streamOptions(OpenAiApi.ChatCompletionRequest.StreamOptions) - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Sets the OpenAiApi.ChatCompletionRequest.StreamOptions for this request.
StreamOptions(Boolean) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.StreamOptions: Creates an instance of a StreamOptions record class.
streamUsage(boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
strict(Boolean) - Method in class org.springframework.ai.openai.api.ResponseFormat.JsonSchema.Builder
StructuredResponse(String, Float, String, List<OpenAiAudioApi.StructuredResponse.Word>, List<OpenAiAudioApi.StructuredResponse.Segment>) - Constructor for record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse: Creates an instance of a StructuredResponse record class.
style() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageRequest: Returns the value of the style record component.
style(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder
SYSTEM - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Role: System message.
systemFingerprint() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion: Returns the value of the systemFingerprint record component.
systemFingerprint() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk: Returns the value of the systemFingerprint record component.

T

temperature() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the temperature record component.
temperature() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Segment: Returns the value of the temperature record component.
temperature() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest: Returns the value of the temperature record component.
temperature() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest: Returns the value of the temperature record component.
temperature(Double) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
temperature(Float) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.Builder
temperature(Float) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest.Builder
temperature(Float) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder
text() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent: Returns the value of the text record component.
text() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Segment: Returns the value of the text record component.
text() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse: Returns the value of the text record component.
TEXT - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.OutputModality
TEXT - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptResponseFormat
TEXT - Enum constant in enum class org.springframework.ai.openai.api.ResponseFormat.Type: Generates a text response.
TEXT_EMBEDDING_3_LARGE - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.EmbeddingModel: Most capable embedding model for both english and non-english tasks.
TEXT_EMBEDDING_3_SMALL - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.EmbeddingModel: Increased performance over 2nd generation ada embedding model.
TEXT_EMBEDDING_ADA_002 - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.EmbeddingModel: Most capable 2nd generation embedding model, replacing 16 first generation models.
timezone() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation.Approximate: Returns the value of the timezone record component.
title() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation: Returns the value of the title record component.
token() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content: Returns the value of the token record component.
token() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content.TopLogProbs: Returns the value of the token record component.
tokens() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Segment: Returns the value of the tokens record component.
TOKENS_LIMIT_HEADER - Enum constant in enum class org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders
TOKENS_REMAINING_HEADER - Enum constant in enum class org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders
TOKENS_RESET_HEADER - Enum constant in enum class org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders
TOOL - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Role: Tool message.
TOOL_CALL - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionFinishReason: Only for compatibility with Mistral AI API.
TOOL_CALLS - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionFinishReason: The model called a tool.
ToolCall(Integer, String, String, OpenAiApi.ChatCompletionMessage.ChatCompletionFunction) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ToolCall: Creates an instance of a ToolCall record class.
ToolCall(String, String, OpenAiApi.ChatCompletionMessage.ChatCompletionFunction) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ToolCall
toolCallbacks(List<ToolCallback>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
toolCallbacks(ToolCallback...) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
toolCallId() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage: Returns the value of the toolCallId record component.
toolCallingManager(ToolCallingManager) - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder
toolCalls() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage: Returns the value of the toolCalls record component.
toolChoice() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the toolChoice record component.
toolChoice(Object) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
ToolChoiceBuilder() - Constructor for class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.ToolChoiceBuilder
toolContext(Map<String, Object>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
toolExecutionEligibilityPredicate(ToolExecutionEligibilityPredicate) - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder
toolNames(String...) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
toolNames(Set<String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
tools() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the tools record component.
tools(List<OpenAiApi.FunctionTool>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
topLogprobs() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the topLogprobs record component.
topLogprobs() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content: Returns the value of the topLogprobs record component.
topLogprobs(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
TopLogProbs(String, Float, List<Integer>) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content.TopLogProbs: Creates an instance of a TopLogProbs record class.
topP() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the topP record component.
topP(Double) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion.Choice: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk.ChunkChoice: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.AudioOutput: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ChatCompletionFunction: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputFile: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ToolCall: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.StreamOptions: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation.Approximate: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Embedding: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingList: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content.TopLogProbs: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.LogProbs: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage.CompletionTokenDetails: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage.PromptTokensDetails: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Segment: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Word: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.Data: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageRequest: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageResponse: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Data: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationRequest: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResponse: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResult: Returns a string representation of this record class.
toString() - Method in class org.springframework.ai.openai.api.ResponseFormat
toString() - Method in class org.springframework.ai.openai.audio.speech.Speech
toString() - Method in class org.springframework.ai.openai.metadata.audio.OpenAiAudioSpeechResponseMetadata
toString() - Method in class org.springframework.ai.openai.metadata.audio.OpenAiAudioTranscriptionResponseMetadata
toString() - Method in class org.springframework.ai.openai.metadata.OpenAiImageGenerationMetadata
toString() - Method in class org.springframework.ai.openai.metadata.OpenAiRateLimit
toString() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions
toString() - Method in class org.springframework.ai.openai.OpenAiChatModel
toString() - Method in class org.springframework.ai.openai.OpenAiChatOptions
toString() - Method in class org.springframework.ai.openai.OpenAiImageOptions
totalTokens() - Method in record class org.springframework.ai.openai.api.OpenAiApi.Usage: Returns the value of the totalTokens record component.
transcript() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.AudioOutput: Returns the value of the transcript record component.
TranscriptionRequest(byte[], String, String, String, String, OpenAiAudioApi.TranscriptResponseFormat, Float, OpenAiAudioApi.TranscriptionRequest.GranularityType) - Constructor for record class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest: Creates an instance of a TranscriptionRequest record class.
TranslationRequest(byte[], String, String, String, OpenAiAudioApi.TranscriptResponseFormat, Float) - Constructor for record class org.springframework.ai.openai.api.OpenAiAudioApi.TranslationRequest: Creates an instance of a TranslationRequest record class.
TTS_1 - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TtsModel: The latest text to speech model, optimized for speed.
TTS_1_HD - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TtsModel: The latest text to speech model, optimized for quality.
type() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation: Returns the value of the type record component.
type() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent: Returns the value of the type record component.
type() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ToolCall: Returns the value of the type record component.
type() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation: Returns the value of the type record component.
type(ResponseFormat.Type) - Method in class org.springframework.ai.openai.api.ResponseFormat.Builder

U

url() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation: Returns the value of the url record component.
url() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.ImageUrl: Returns the value of the url record component.
url() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.Data: Returns the value of the url record component.
url() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Data: Returns the value of the url record component.
urlCitation() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation: Returns the value of the urlCitation record component.
UrlCitation(Integer, Integer, String, String) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation: Creates an instance of a UrlCitation record class.
usage() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletion: Returns the value of the usage record component.
usage() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk: Returns the value of the usage record component.
usage() - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingList: Returns the value of the usage record component.
Usage(Integer, Integer, Integer) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.Usage
Usage(Integer, Integer, Integer, OpenAiApi.Usage.PromptTokensDetails, OpenAiApi.Usage.CompletionTokenDetails) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.Usage: Creates an instance of a Usage record class.
user() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the user record component.
user() - Method in record class org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest: Returns the value of the user record component.
user() - Method in record class org.springframework.ai.openai.api.OpenAiImageApi.OpenAiImageRequest: Returns the value of the user record component.
user(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
user(String) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder
user(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder
USER - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Role: User message.
userLocation() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions: Returns the value of the userLocation record component.
UserLocation(String, OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation.Approximate) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation: Creates an instance of a UserLocation record class.

V

value - Variable in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel
value - Variable in enum class org.springframework.ai.openai.api.OpenAiApi.EmbeddingModel
value - Variable in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.AudioResponseFormat
value - Variable in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice
value - Variable in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.GranularityType
value - Variable in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptResponseFormat
value - Variable in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TtsModel
value - Variable in enum class org.springframework.ai.openai.api.OpenAiAudioApi.WhisperModel
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionFinishReason: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio.Format: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Role: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.Voice: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.EmbeddingModel: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Type: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.OutputModality: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.AudioResponseFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.GranularityType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptResponseFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TtsModel: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.WhisperModel: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.OpenAiImageApi.ImageModel: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.api.ResponseFormat.Type: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionFinishReason: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio.Format: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Role: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.Voice: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.ChatModel: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.EmbeddingModel: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.FunctionTool.Type: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiApi.OutputModality: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.AudioResponseFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.GranularityType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptResponseFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TtsModel: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiAudioApi.WhisperModel: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.OpenAiImageApi.ImageModel: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.api.ResponseFormat.Type: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders: Returns an array containing the constants of this enum class, in the order they are declared.
VERBOSE_JSON - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptResponseFormat
verbosity() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the verbosity record component.
verbosity(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
VERSE - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Voice
violence() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Returns the value of the violence record component.
violence() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Returns the value of the violence record component.
violenceGraphic() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.Categories: Returns the value of the violenceGraphic record component.
violenceGraphic() - Method in record class org.springframework.ai.openai.api.OpenAiModerationApi.CategoryScores: Returns the value of the violenceGraphic record component.
voice() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters: Returns the value of the voice record component.
voice() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest: Returns the value of the voice record component.
voice(String) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Builder
voice(String) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder
voice(OpenAiAudioApi.SpeechRequest.Voice) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.Builder
voice(OpenAiAudioApi.SpeechRequest.Voice) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder
VTT - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptResponseFormat

W

WAV - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio.Format: WAV audio format
WAV - Enum constant in enum class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat: WAV format
WAV - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.AudioResponseFormat
webClientBuilder(WebClient.Builder) - Method in class org.springframework.ai.openai.api.OpenAiApi.Builder
webClientBuilder(WebClient.Builder) - Method in class org.springframework.ai.openai.api.OpenAiAudioApi.Builder
webSearchOptions() - Method in record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest: Returns the value of the webSearchOptions record component.
webSearchOptions(OpenAiApi.ChatCompletionRequest.WebSearchOptions) - Method in class org.springframework.ai.openai.OpenAiChatOptions.Builder
WebSearchOptions(OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize, OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation) - Constructor for record class org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions: Creates an instance of a WebSearchOptions record class.
WHISPER_1 - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.WhisperModel
width(Integer) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder
withDefaultOptions(OpenAiModerationOptions) - Method in class org.springframework.ai.openai.OpenAiModerationModel
withRateLimit(RateLimit) - Method in class org.springframework.ai.openai.metadata.audio.OpenAiAudioSpeechResponseMetadata
withRateLimit(RateLimit) - Method in class org.springframework.ai.openai.metadata.audio.OpenAiAudioTranscriptionResponseMetadata
withSpeechMetadata(OpenAiAudioSpeechMetadata) - Method in class org.springframework.ai.openai.audio.speech.Speech
word() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Word: Returns the value of the word record component.
Word(String, Float, Float) - Constructor for record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse.Word: Creates an instance of a Word record class.
WORD - Enum constant in enum class org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest.GranularityType
words() - Method in record class org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse: Returns the value of the words record component.

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