Index (Spring AI Model 2.0.0-M2 API)

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

A

AbstractConversionServiceOutputConverter<T> - Class in org.springframework.ai.converter: Abstract StructuredOutputConverter implementation that uses a pre-configured DefaultConversionService to convert the LLM output into the desired type format.
AbstractConversionServiceOutputConverter(DefaultConversionService) - Constructor for class org.springframework.ai.converter.AbstractConversionServiceOutputConverter: Create a new AbstractConversionServiceOutputConverter instance.
AbstractEmbeddingModel - Class in org.springframework.ai.embedding: Abstract implementation of the EmbeddingModel interface that provides dimensions calculation caching.
AbstractEmbeddingModel() - Constructor for class org.springframework.ai.embedding.AbstractEmbeddingModel
AbstractMessage - Class in org.springframework.ai.chat.messages: The AbstractMessage class is an abstract implementation of the Message interface.
AbstractMessage(MessageType, String, Map) - Constructor for class org.springframework.ai.chat.messages.AbstractMessage: Create a new AbstractMessage with the given message type, text content, and metadata.
AbstractMessageOutputConverter<T> - Class in org.springframework.ai.converter: Abstract StructuredOutputConverter implementation that uses a pre-configured MessageConverter to convert the LLM output into the desired type format.
AbstractMessageOutputConverter(MessageConverter) - Constructor for class org.springframework.ai.converter.AbstractMessageOutputConverter: Create a new AbstractMessageOutputConverter.
AbstractResponseMetadata - Class in org.springframework.ai.model
AbstractResponseMetadata() - Constructor for class org.springframework.ai.model.AbstractResponseMetadata: Create a new AbstractResponseMetadata instance.
add(String, Object) - Method in class org.springframework.ai.chat.prompt.PromptTemplate
add(String, List) - Method in interface org.springframework.ai.chat.memory.ChatMemory: Save the specified messages in the chat memory for the specified conversation.
add(String, List) - Method in class org.springframework.ai.chat.memory.MessageWindowChatMemory
add(String, Message) - Method in interface org.springframework.ai.chat.memory.ChatMemory: Save the specified message in the chat memory for the specified conversation.
addCleaner(ResponseTextCleaner) - Method in class org.springframework.ai.converter.CompositeResponseTextCleaner.Builder: Add a cleaner to the pipeline.
addPattern(String) - Method in class org.springframework.ai.converter.ThinkingTagCleaner.Builder: Add a custom pattern string.
addPattern(Pattern) - Method in class org.springframework.ai.converter.ThinkingTagCleaner.Builder: Add a custom pattern.
aggregate(Flux, Consumer) - Method in class org.springframework.ai.chat.model.MessageAggregator
AI_METADATA_STRING - Static variable in class org.springframework.ai.model.AbstractResponseMetadata: AI metadata string format.
AI_OPERATION_TYPE - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.LowCardinalityKeyNames: The name of the operation being performed.
AI_OPERATION_TYPE - Enum constant in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation.LowCardinalityKeyNames: The name of the operation being performed.
AI_OPERATION_TYPE - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.LowCardinalityKeyNames: The name of the operation being performed.
AI_OPERATION_TYPE - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.LowCardinalityKeyNames: The name of the operation being performed.
AI_PROVIDER - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.LowCardinalityKeyNames: The model provider as identified by the client instrumentation.
AI_PROVIDER - Enum constant in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation.LowCardinalityKeyNames: The model provider as identified by the client instrumentation.
AI_PROVIDER - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.LowCardinalityKeyNames: The model provider as identified by the client instrumentation.
AI_PROVIDER - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.LowCardinalityKeyNames: The provider responsible for the operation.
aiOperationType(ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
aiOperationType(EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
aiOperationType(ImageModelObservationContext) - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
aiOperationType(ToolCallingObservationContext) - Method in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention
aiProvider(ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
aiProvider(EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
aiProvider(ImageModelObservationContext) - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
aiProvider(ToolCallingObservationContext) - Method in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention
AiRuntimeHints - Class in org.springframework.ai.aot: Utility methods for creating native runtime hints.
AiRuntimeHints() - Constructor for class org.springframework.ai.aot.AiRuntimeHints
ALLOW_ADDITIONAL_PROPERTIES_BY_DEFAULT - Enum constant in enum class org.springframework.ai.util.json.schema.JsonSchemaGenerator.SchemaOption: Allow an object to contain additional key/values not defined in the schema.
alwaysThrow(boolean) - Method in class org.springframework.ai.tool.execution.DefaultToolExecutionExceptionProcessor.Builder: Rethrow the ToolExecutionException
ANTHROPIC - Static variable in class org.springframework.ai.model.SpringAIModels
ApiKey - Interface in org.springframework.ai.model: Some model providers API leverage short-lived api keys which must be renewed at regular intervals using another credential.
applicationContext(GenericApplicationContext) - Method in class org.springframework.ai.tool.resolution.SpringBeanToolCallbackResolver.Builder
apply(List) - Method in class org.springframework.ai.model.transformer.KeywordMetadataEnricher
apply(List) - Method in class org.springframework.ai.model.transformer.SummaryMetadataEnricher
applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class org.springframework.ai.model.KotlinModule
applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class org.springframework.ai.util.json.schema.SpringAiSchemaModule
argumentConsumer(Consumer) - Method in class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider.Builder: Sets the argument consumer
arguments() - Method in record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall: Returns the value of the arguments record component.
arguments() - Method in record class org.springframework.ai.tool.augment.AugmentedArgumentEvent: Returns the value of the arguments record component.
argumentType(Class) - Method in class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider.Builder: Sets the argument type
ASSISTANT - Enum constant in enum class org.springframework.ai.chat.messages.MessageType: A Message of type assistant passed in subsequent input Messages as the Message generated in response to the user.
AssistantMessage - Class in org.springframework.ai.chat.messages: Lets the generative know the content was generated as a response to the user.
AssistantMessage(String, Map, List, List) - Constructor for class org.springframework.ai.chat.messages.AssistantMessage
AssistantMessage(String) - Constructor for class org.springframework.ai.chat.messages.AssistantMessage
AssistantMessage.Builder - Class in org.springframework.ai.chat.messages
AssistantMessage.ToolCall - Record Class in org.springframework.ai.chat.messages
AssistantPromptTemplate - Class in org.springframework.ai.chat.prompt
AssistantPromptTemplate(String) - Constructor for class org.springframework.ai.chat.prompt.AssistantPromptTemplate
AssistantPromptTemplate(Resource) - Constructor for class org.springframework.ai.chat.prompt.AssistantPromptTemplate
AUDIO - Enum constant in enum class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityType
AUDIO_SPEECH_MODEL - Static variable in class org.springframework.ai.model.SpringAIModelProperties
AUDIO_TRANSCRIPTION_MODEL - Static variable in class org.springframework.ai.model.SpringAIModelProperties
AudioTranscription - Class in org.springframework.ai.audio.transcription: Represents a response returned by the AI.
AudioTranscription(String) - Constructor for class org.springframework.ai.audio.transcription.AudioTranscription
AudioTranscriptionMetadata - Interface in org.springframework.ai.audio.transcription: Metadata associated with an audio transcription result.
AudioTranscriptionOptions - Interface in org.springframework.ai.audio.transcription: Options for audio transcription.
AudioTranscriptionPrompt - Class in org.springframework.ai.audio.transcription: Represents an audio transcription prompt for an AI model.
AudioTranscriptionPrompt(Resource) - Constructor for class org.springframework.ai.audio.transcription.AudioTranscriptionPrompt: Construct a new AudioTranscriptionPrompt given the resource representing the audio file.
AudioTranscriptionPrompt(Resource, AudioTranscriptionOptions) - Constructor for class org.springframework.ai.audio.transcription.AudioTranscriptionPrompt: Construct a new AudioTranscriptionPrompt given the resource representing the audio file.
AudioTranscriptionResponse - Class in org.springframework.ai.audio.transcription: A response containing an audio transcription result.
AudioTranscriptionResponse(AudioTranscription) - Constructor for class org.springframework.ai.audio.transcription.AudioTranscriptionResponse
AudioTranscriptionResponse(AudioTranscription, AudioTranscriptionResponseMetadata) - Constructor for class org.springframework.ai.audio.transcription.AudioTranscriptionResponse
AudioTranscriptionResponseMetadata - Class in org.springframework.ai.audio.transcription: Metadata associated with an audio transcription response.
AudioTranscriptionResponseMetadata() - Constructor for class org.springframework.ai.audio.transcription.AudioTranscriptionResponseMetadata
AugmentedArgumentEvent<T> - Record Class in org.springframework.ai.tool.augment: An event that encapsulates the augmented arguments extracted from a tool input, along with the associated tool definition and raw input data.
AugmentedArgumentEvent(ToolDefinition, String, T) - Constructor for record class org.springframework.ai.tool.augment.AugmentedArgumentEvent: Creates an instance of a AugmentedArgumentEvent record class.
AugmentedArgumentType(String, Type, String, boolean) - Constructor for record class org.springframework.ai.tool.augment.ToolInputSchemaAugmenter.AugmentedArgumentType: Creates an instance of a AugmentedArgumentType record class.
AugmentedToolCallback<T> - Class in org.springframework.ai.tool.augment: This class wraps an existing ToolCallback and modifies its input schema to include additional fields defined in the provided Record type.
AugmentedToolCallback(ToolCallback, Class, Consumer, boolean) - Constructor for class org.springframework.ai.tool.augment.AugmentedToolCallback
AugmentedToolCallbackProvider<T> - Class in org.springframework.ai.tool.augment
AugmentedToolCallbackProvider(Object, Class, Consumer, boolean) - Constructor for class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider
AugmentedToolCallbackProvider(ToolCallbackProvider, Class, Consumer, boolean) - Constructor for class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider
AugmentedToolCallbackProvider.Builder<T> - Class in org.springframework.ai.tool.augment: Builder for AugmentedToolCallbackProvider.
augmentSystemMessage(String) - Method in class org.springframework.ai.chat.prompt.Prompt: Augments the last system message in the prompt with the provided text.
augmentSystemMessage(Function) - Method in class org.springframework.ai.chat.prompt.Prompt: Augments the first system message in the prompt with the provided function.
augmentToolInputSchema(String, String, Type, String, boolean) - Static method in class org.springframework.ai.tool.augment.ToolInputSchemaAugmenter
augmentToolInputSchema(String, List) - Static method in class org.springframework.ai.tool.augment.ToolInputSchemaAugmenter
augmentUserMessage(String) - Method in class org.springframework.ai.chat.prompt.Prompt: Augments the last user message in the prompt with the provided text.
augmentUserMessage(Function) - Method in class org.springframework.ai.chat.prompt.Prompt: Augments the last user message in the prompt with the provided function.
AZURE_OPENAI - Static variable in class org.springframework.ai.model.SpringAIModels

B

batch(List) - Method in interface org.springframework.ai.embedding.BatchingStrategy: EmbeddingModel implementations can call this method to optimize embedding tokens.
batch(List) - Method in class org.springframework.ai.embedding.TokenCountBatchingStrategy
BatchingStrategy - Interface in org.springframework.ai.embedding: Contract for batching Document objects so that the call to embed them could be optimized.
BeanOutputConverter<T> - Class in org.springframework.ai.converter: An implementation of StructuredOutputConverter that transforms the LLM output to a specific object type using JSON schema.
BeanOutputConverter(Class) - Constructor for class org.springframework.ai.converter.BeanOutputConverter: Constructor to initialize with the target type's class.
BeanOutputConverter(Class, ObjectMapper) - Constructor for class org.springframework.ai.converter.BeanOutputConverter: Constructor to initialize with the target type's class, a custom object mapper, and a line endings normalizer to ensure consistent line endings on any platform.
BeanOutputConverter(Class, ObjectMapper, ResponseTextCleaner) - Constructor for class org.springframework.ai.converter.BeanOutputConverter: Constructor to initialize with the target type's class, a custom object mapper, and a custom text cleaner.
BeanOutputConverter(ParameterizedTypeReference) - Constructor for class org.springframework.ai.converter.BeanOutputConverter: Constructor to initialize with the target class type reference.
BeanOutputConverter(ParameterizedTypeReference, ObjectMapper) - Constructor for class org.springframework.ai.converter.BeanOutputConverter: Constructor to initialize with the target class type reference, a custom object mapper, and a line endings normalizer to ensure consistent line endings on any platform.
BeanOutputConverter(ParameterizedTypeReference, ObjectMapper, ResponseTextCleaner) - Constructor for class org.springframework.ai.converter.BeanOutputConverter: Constructor to initialize with the target class type reference, a custom object mapper, and a custom text cleaner.
BEDROCK_COHERE - Static variable in class org.springframework.ai.model.SpringAIModels
BEDROCK_CONVERSE - Static variable in class org.springframework.ai.model.SpringAIModels
BEDROCK_TITAN - Static variable in class org.springframework.ai.model.SpringAIModels
build() - Method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions.Builder
build() - Method in interface org.springframework.ai.audio.tts.TextToSpeechOptions.Builder: Builds the TextToSpeechOptions.
build() - Method in class org.springframework.ai.chat.memory.MessageWindowChatMemory.Builder
build() - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder
build() - Method in class org.springframework.ai.chat.messages.SystemMessage.Builder
build() - Method in class org.springframework.ai.chat.messages.ToolResponseMessage.Builder
build() - Method in class org.springframework.ai.chat.messages.UserMessage.Builder
build() - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata.Builder: Build the Generation metadata.
build() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
build() - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadataBuilder
build() - Method in class org.springframework.ai.chat.model.ChatResponse.Builder
build() - Method in class org.springframework.ai.chat.observation.ChatModelObservationContext.Builder
build() - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder: Build the ChatOptions.
build() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
build() - Method in class org.springframework.ai.chat.prompt.Prompt.Builder
build() - Method in class org.springframework.ai.chat.prompt.PromptTemplate.Builder
build() - Method in class org.springframework.ai.chat.prompt.SystemPromptTemplate.Builder
build() - Method in class org.springframework.ai.converter.CompositeResponseTextCleaner.Builder: Build the composite cleaner.
build() - Method in class org.springframework.ai.converter.ThinkingTagCleaner.Builder: Build the thinking tag cleaner.
build() - Method in class org.springframework.ai.embedding.DefaultEmbeddingOptionsBuilder
build() - Method in interface org.springframework.ai.embedding.EmbeddingOptions.Builder
build() - Method in class org.springframework.ai.embedding.observation.EmbeddingModelObservationContext.Builder
build() - Method in class org.springframework.ai.image.ImageOptionsBuilder
build() - Method in class org.springframework.ai.image.observation.ImageModelObservationContext.Builder
build() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
build() - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder
build() - Method in class org.springframework.ai.model.tool.DefaultToolExecutionResult.Builder
build() - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
build() - Method in class org.springframework.ai.model.transformer.KeywordMetadataEnricher.Builder
build() - Method in class org.springframework.ai.moderation.Categories.Builder
build() - Method in class org.springframework.ai.moderation.CategoryScores.Builder
build() - Method in class org.springframework.ai.moderation.Moderation.Builder
build() - Method in class org.springframework.ai.moderation.ModerationOptionsBuilder
build() - Method in class org.springframework.ai.moderation.ModerationResult.Builder
build() - Method in class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider.Builder: Builds the AugmentedToolCallbackProvider instance.
build() - Method in class org.springframework.ai.tool.definition.DefaultToolDefinition.Builder
build() - Method in class org.springframework.ai.tool.execution.DefaultToolExecutionExceptionProcessor.Builder
build() - Method in class org.springframework.ai.tool.function.FunctionToolCallback.Builder
build() - Method in class org.springframework.ai.tool.metadata.DefaultToolMetadata.Builder
build() - Method in class org.springframework.ai.tool.method.MethodToolCallback.Builder
build() - Method in class org.springframework.ai.tool.method.MethodToolCallbackProvider.Builder
build() - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext.Builder
build() - Method in class org.springframework.ai.tool.resolution.SpringBeanToolCallbackResolver.Builder
builder() - Static method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions
builder() - Static method in interface org.springframework.ai.audio.tts.TextToSpeechOptions: Creates a new TextToSpeechOptions.Builder to create the default TextToSpeechOptions.
builder() - Static method in class org.springframework.ai.chat.memory.MessageWindowChatMemory
builder() - Static method in class org.springframework.ai.chat.messages.AssistantMessage
builder() - Static method in class org.springframework.ai.chat.messages.SystemMessage
builder() - Static method in class org.springframework.ai.chat.messages.ToolResponseMessage
builder() - Static method in class org.springframework.ai.chat.messages.UserMessage
builder() - Static method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata
builder() - Static method in class org.springframework.ai.chat.metadata.ChatResponseMetadata
builder() - Static method in class org.springframework.ai.chat.model.ChatResponse
builder() - Static method in class org.springframework.ai.chat.observation.ChatModelObservationContext
builder() - Static method in interface org.springframework.ai.chat.prompt.ChatOptions: Creates a new ChatOptions.Builder to create the default ChatOptions.
builder() - Static method in class org.springframework.ai.chat.prompt.Prompt
builder() - Static method in class org.springframework.ai.chat.prompt.PromptTemplate
builder() - Static method in class org.springframework.ai.chat.prompt.SystemPromptTemplate
builder() - Static method in class org.springframework.ai.converter.CompositeResponseTextCleaner: Creates a builder for constructing a composite cleaner.
builder() - Static method in class org.springframework.ai.converter.ThinkingTagCleaner: Creates a builder for constructing a thinking tag cleaner.
builder() - Static method in interface org.springframework.ai.embedding.EmbeddingOptions
builder() - Static method in class org.springframework.ai.embedding.observation.EmbeddingModelObservationContext
builder() - Static method in class org.springframework.ai.image.ImageOptionsBuilder
builder() - Static method in class org.springframework.ai.image.observation.ImageModelObservationContext
builder() - Static method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
builder() - Static method in class org.springframework.ai.model.tool.DefaultToolCallingManager
builder() - Static method in record class org.springframework.ai.model.tool.DefaultToolExecutionResult
builder() - Static method in interface org.springframework.ai.model.tool.ToolCallingChatOptions: A builder to create a new ToolCallingChatOptions instance.
builder() - Static method in interface org.springframework.ai.model.tool.ToolCallingManager: Create a default ToolCallingManager builder.
builder() - Static method in interface org.springframework.ai.model.tool.ToolExecutionResult: Create a default ToolExecutionResult builder.
builder() - Static method in class org.springframework.ai.moderation.Categories
builder() - Static method in class org.springframework.ai.moderation.CategoryScores
builder() - Static method in class org.springframework.ai.moderation.Moderation
builder() - Static method in class org.springframework.ai.moderation.ModerationOptionsBuilder
builder() - Static method in class org.springframework.ai.moderation.ModerationResult
builder() - Static method in class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider: Creates a new builder instance
builder() - Static method in record class org.springframework.ai.tool.definition.DefaultToolDefinition
builder() - Static method in interface org.springframework.ai.tool.definition.ToolDefinition: Create a default ToolDefinition builder.
builder() - Static method in class org.springframework.ai.tool.execution.DefaultToolExecutionExceptionProcessor
builder() - Static method in record class org.springframework.ai.tool.metadata.DefaultToolMetadata
builder() - Static method in interface org.springframework.ai.tool.metadata.ToolMetadata: Create a default ToolMetadata builder.
builder() - Static method in class org.springframework.ai.tool.method.MethodToolCallback
builder() - Static method in class org.springframework.ai.tool.method.MethodToolCallbackProvider
builder() - Static method in class org.springframework.ai.tool.observation.ToolCallingObservationContext
builder() - Static method in class org.springframework.ai.tool.resolution.SpringBeanToolCallbackResolver
builder(Method) - Static method in class org.springframework.ai.tool.support.ToolDefinitions: Create a default ToolDefinition builder from a Method.
builder(String, BiFunction) - Static method in class org.springframework.ai.tool.function.FunctionToolCallback: Build a FunctionToolCallback from a BiFunction.
builder(String, Consumer) - Static method in class org.springframework.ai.tool.function.FunctionToolCallback: Build a FunctionToolCallback from a Consumer.
builder(String, Function) - Static method in class org.springframework.ai.tool.function.FunctionToolCallback: Build a FunctionToolCallback from a Function.
builder(String, Supplier) - Static method in class org.springframework.ai.tool.function.FunctionToolCallback: Build a FunctionToolCallback from a Supplier.
builder(ChatModel) - Static method in class org.springframework.ai.model.transformer.KeywordMetadataEnricher
Builder() - Constructor for class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions.Builder
Builder() - Constructor for class org.springframework.ai.chat.messages.SystemMessage.Builder
Builder() - Constructor for class org.springframework.ai.chat.messages.UserMessage.Builder
Builder() - Constructor for class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
Builder() - Constructor for class org.springframework.ai.chat.prompt.Prompt.Builder
Builder() - Constructor for class org.springframework.ai.chat.prompt.PromptTemplate.Builder
Builder() - Constructor for class org.springframework.ai.chat.prompt.SystemPromptTemplate.Builder
Builder() - Constructor for class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
Builder() - Constructor for class org.springframework.ai.moderation.Categories.Builder
Builder() - Constructor for class org.springframework.ai.moderation.CategoryScores.Builder
Builder() - Constructor for class org.springframework.ai.moderation.Moderation.Builder
Builder() - Constructor for class org.springframework.ai.moderation.ModerationResult.Builder
Builder() - Constructor for class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider.Builder
Builder() - Constructor for class org.springframework.ai.tool.execution.DefaultToolExecutionExceptionProcessor.Builder
Builder() - Constructor for class org.springframework.ai.tool.resolution.SpringBeanToolCallbackResolver.Builder
Builder(ChatModel) - Constructor for class org.springframework.ai.model.transformer.KeywordMetadataEnricher.Builder
buildGenerations(ToolExecutionResult) - Static method in interface org.springframework.ai.model.tool.ToolExecutionResult: Build a list of Generation from the tool execution result, useful for sending the tool execution result to the client directly.

C

call(String) - Method in interface org.springframework.ai.audio.tts.TextToSpeechModel
call(String) - Method in interface org.springframework.ai.chat.model.ChatModel
call(String) - Method in class org.springframework.ai.tool.augment.AugmentedToolCallback
call(String) - Method in class org.springframework.ai.tool.function.FunctionToolCallback
call(String) - Method in class org.springframework.ai.tool.method.MethodToolCallback
call(String) - Method in interface org.springframework.ai.tool.ToolCallback: Execute tool with the given input and return the result to send back to the AI model.
call(String, ToolContext) - Method in class org.springframework.ai.tool.augment.AugmentedToolCallback
call(String, ToolContext) - Method in class org.springframework.ai.tool.function.FunctionToolCallback
call(String, ToolContext) - Method in class org.springframework.ai.tool.method.MethodToolCallback
call(String, ToolContext) - Method in interface org.springframework.ai.tool.ToolCallback: Execute tool with the given input and context, and return the result to send back to the AI model.
call(AudioTranscriptionPrompt) - Method in interface org.springframework.ai.audio.transcription.TranscriptionModel: Transcribes the audio from the given prompt.
call(TextToSpeechPrompt) - Method in interface org.springframework.ai.audio.tts.TextToSpeechModel
call(Message...) - Method in interface org.springframework.ai.chat.model.ChatModel
call(Prompt) - Method in interface org.springframework.ai.chat.model.ChatModel
call(DocumentEmbeddingRequest) - Method in interface org.springframework.ai.embedding.DocumentEmbeddingModel
call(EmbeddingRequest) - Method in interface org.springframework.ai.embedding.EmbeddingModel
call(ImagePrompt) - Method in interface org.springframework.ai.image.ImageModel
call(ModerationPrompt) - Method in interface org.springframework.ai.moderation.ModerationModel
call(TReq) - Method in interface org.springframework.ai.model.Model: Executes a method call to the AI model.
categories(Categories) - Method in class org.springframework.ai.moderation.ModerationResult.Builder
Categories - Class in org.springframework.ai.moderation: The Categories class represents a set of categories used to classify content.
Categories.Builder - Class in org.springframework.ai.moderation
categoryScores(CategoryScores) - Method in class org.springframework.ai.moderation.ModerationResult.Builder
CategoryScores - Class in org.springframework.ai.moderation: This class represents the scores for different categories of content.
CategoryScores.Builder - Class in org.springframework.ai.moderation
CHAT_MODEL - Static variable in class org.springframework.ai.model.SpringAIModelProperties
CHAT_MODEL_OPERATION - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation
ChatGenerationMetadata - Interface in org.springframework.ai.chat.metadata: Represents the metadata associated with the generation of a chat response.
ChatGenerationMetadata.Builder - Interface in org.springframework.ai.chat.metadata
ChatMemory - Interface in org.springframework.ai.chat.memory: The contract for storing and managing the memory of chat conversations.
chatMemoryRepository(ChatMemoryRepository) - Method in class org.springframework.ai.chat.memory.MessageWindowChatMemory.Builder
ChatMemoryRepository - Interface in org.springframework.ai.chat.memory: A repository for storing and retrieving chat messages.
ChatModel - Interface in org.springframework.ai.chat.model
ChatModelCompletionObservationHandler - Class in org.springframework.ai.chat.observation: Handler for emitting the chat completion content to logs.
ChatModelCompletionObservationHandler() - Constructor for class org.springframework.ai.chat.observation.ChatModelCompletionObservationHandler
ChatModelDescription - Interface in org.springframework.ai.model: Marker interface, to be used to store info on the model such as the current context length.
ChatModelMeterObservationHandler - Class in org.springframework.ai.chat.observation: Handler for generating metrics from chat model observations.
ChatModelMeterObservationHandler(MeterRegistry) - Constructor for class org.springframework.ai.chat.observation.ChatModelMeterObservationHandler
ChatModelObservationContext - Class in org.springframework.ai.chat.observation: Context used to store metadata for chat model exchanges.
ChatModelObservationContext.Builder - Class in org.springframework.ai.chat.observation
ChatModelObservationConvention - Interface in org.springframework.ai.chat.observation: Interface for an ObservationConvention for chat model exchanges.
ChatModelObservationDocumentation - Enum Class in org.springframework.ai.chat.observation: Documented conventions for chat model observations.
ChatModelObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.ai.chat.observation: High-cardinality observation key names for chat model operations.
ChatModelObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.ai.chat.observation: Low-cardinality observation key names for chat model operations.
ChatModelPromptContentObservationHandler - Class in org.springframework.ai.chat.observation: Handler for emitting the chat prompt content to logs.
ChatModelPromptContentObservationHandler() - Constructor for class org.springframework.ai.chat.observation.ChatModelPromptContentObservationHandler
chatOptions(ChatOptions) - Method in class org.springframework.ai.chat.prompt.Prompt.Builder
ChatOptions - Interface in org.springframework.ai.chat.prompt: ModelOptions representing the common options that are portable across different chat models.
ChatOptions.Builder - Interface in org.springframework.ai.chat.prompt: Builder for creating ChatOptions instance.
ChatPromptTemplate - Class in org.springframework.ai.chat.prompt: A PromptTemplate that lets you specify the role as a string should the current implementations and their roles not suffice for your needs.
ChatPromptTemplate(List) - Constructor for class org.springframework.ai.chat.prompt.ChatPromptTemplate
ChatResponse - Class in org.springframework.ai.chat.model: The chat completion (e.g. generation) response returned by an AI provider.
ChatResponse(List) - Constructor for class org.springframework.ai.chat.model.ChatResponse: Construct a new ChatResponse instance without metadata.
ChatResponse(List, ChatResponseMetadata) - Constructor for class org.springframework.ai.chat.model.ChatResponse: Construct a new ChatResponse instance.
ChatResponse.Builder - Class in org.springframework.ai.chat.model
ChatResponseMetadata - Class in org.springframework.ai.chat.metadata: Models common AI provider metadata returned in an AI response.
ChatResponseMetadata() - Constructor for class org.springframework.ai.chat.metadata.ChatResponseMetadata
ChatResponseMetadata.Builder - Class in org.springframework.ai.chat.metadata
clean(String) - Method in class org.springframework.ai.converter.CompositeResponseTextCleaner
clean(String) - Method in class org.springframework.ai.converter.MarkdownCodeBlockCleaner
clean(String) - Method in interface org.springframework.ai.converter.ResponseTextCleaner: Clean the given text by removing unwanted patterns, tags, or formatting.
clean(String) - Method in class org.springframework.ai.converter.ThinkingTagCleaner
clean(String) - Method in class org.springframework.ai.converter.WhitespaceCleaner
clear() - Method in class org.springframework.ai.model.MutableResponseMetadata: Clears the entries from the context.
clear(String) - Method in interface org.springframework.ai.chat.memory.ChatMemory: Clear the chat memory for the specified conversation.
clear(String) - Method in class org.springframework.ai.chat.memory.MessageWindowChatMemory
clearContext() - Static method in class org.springframework.ai.model.tool.internal.ToolCallReactiveContextHolder
completionTokens() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage: Returns the value of the completionTokens record component.
CompositeResponseTextCleaner - Class in org.springframework.ai.converter: A composite ResponseTextCleaner that applies multiple cleaners in sequence.
CompositeResponseTextCleaner() - Constructor for class org.springframework.ai.converter.CompositeResponseTextCleaner: Creates a composite cleaner with no cleaners.
CompositeResponseTextCleaner(List) - Constructor for class org.springframework.ai.converter.CompositeResponseTextCleaner: Creates a composite cleaner with the given cleaners.
CompositeResponseTextCleaner(ResponseTextCleaner...) - Constructor for class org.springframework.ai.converter.CompositeResponseTextCleaner: Creates a composite cleaner with the given cleaners.
CompositeResponseTextCleaner.Builder - Class in org.springframework.ai.converter: Builder for CompositeResponseTextCleaner.
computeIfAbsent(String, Function) - Method in class org.springframework.ai.model.MutableResponseMetadata: Returns an element or calls a mapping function if entry not present.
containsKey(Object) - Method in class org.springframework.ai.model.AbstractResponseMetadata: Checks if context contains a key.
containsKey(Object) - Method in class org.springframework.ai.model.MutableResponseMetadata: Checks if context contains a key.
containsKey(Object) - Method in interface org.springframework.ai.model.ResponseMetadata: Checks if context contains a key.
containsKey(String) - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata
containsKey(String) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
content(String) - Method in class org.springframework.ai.chat.prompt.Prompt.Builder
content(String) - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder
contentFilter(String) - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata.Builder: Add content filter to the Generation result.
contentFilter(String) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadataBuilder
contentFilters(Set) - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata.Builder: Add content filters to the Generation result.
contentFilters(Set) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadataBuilder
CONTEXT_STR_PLACEHOLDER - Static variable in class org.springframework.ai.model.transformer.KeywordMetadataEnricher
CONVERSATION_ID - Static variable in interface org.springframework.ai.chat.memory.ChatMemory: The key to retrieve the chat memory conversation id from the context.
conversationHistory() - Method in record class org.springframework.ai.model.tool.DefaultToolExecutionResult: Returns the value of the conversationHistory record component.
conversationHistory() - Method in interface org.springframework.ai.model.tool.ToolExecutionResult: The history of messages exchanged during the conversation, including the tool execution result.
conversationHistory(List) - Method in class org.springframework.ai.model.tool.DefaultToolExecutionResult.Builder
convert(Object, Type) - Method in class org.springframework.ai.tool.execution.DefaultToolCallResultConverter
convert(Object, Type) - Method in interface org.springframework.ai.tool.execution.ToolCallResultConverter: Given an Object returned by a tool, convert it to a String compatible with the given class type.
convert(String) - Method in class org.springframework.ai.converter.BeanOutputConverter: Parses the given text to transform it to the desired target type.
convert(String) - Method in class org.springframework.ai.converter.ListOutputConverter
convert(String) - Method in class org.springframework.ai.converter.MapOutputConverter
convertTypeValuesToUpperCase(ObjectNode) - Static method in class org.springframework.ai.util.json.schema.JsonSchemaGenerator
copy() - Method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions
copy() - Method in interface org.springframework.ai.audio.tts.TextToSpeechOptions: Returns a copy of this TextToSpeechOptions.
copy() - Method in class org.springframework.ai.chat.messages.SystemMessage
copy() - Method in class org.springframework.ai.chat.messages.UserMessage
copy() - Method in interface org.springframework.ai.chat.prompt.ChatOptions: Returns a copy of this ChatOptions.
copy() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
copy() - Method in class org.springframework.ai.chat.prompt.Prompt
copy() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
copyToTarget(S, Class, Class) - Static method in class org.springframework.ai.model.ModelOptionsUtils: Returns a new instance of the targetBeanClazz that copies the bean values from the sourceBean instance.
create() - Static method in interface org.springframework.ai.audio.transcription.AudioTranscriptionMetadata: Factory method used to construct a new AudioTranscriptionMetadata
create() - Method in class org.springframework.ai.chat.prompt.AssistantPromptTemplate
create() - Method in class org.springframework.ai.chat.prompt.ChatPromptTemplate
create() - Method in class org.springframework.ai.chat.prompt.PromptTemplate
create() - Method in interface org.springframework.ai.chat.prompt.PromptTemplateActions
create() - Method in class org.springframework.ai.chat.prompt.SystemPromptTemplate
create(Map) - Method in class org.springframework.ai.chat.prompt.AssistantPromptTemplate
create(Map) - Method in class org.springframework.ai.chat.prompt.ChatPromptTemplate
create(Map) - Method in class org.springframework.ai.chat.prompt.PromptTemplate
create(Map) - Method in interface org.springframework.ai.chat.prompt.PromptTemplateActions
create(Map) - Method in class org.springframework.ai.chat.prompt.SystemPromptTemplate
create(Map, ChatOptions) - Method in class org.springframework.ai.chat.prompt.ChatPromptTemplate
create(Map, ChatOptions) - Method in class org.springframework.ai.chat.prompt.PromptTemplate
create(Map, ChatOptions) - Method in interface org.springframework.ai.chat.prompt.PromptTemplateActions
create(ChatOptions) - Method in class org.springframework.ai.chat.prompt.ChatPromptTemplate
create(ChatOptions) - Method in class org.springframework.ai.chat.prompt.PromptTemplate
create(ChatOptions) - Method in interface org.springframework.ai.chat.prompt.PromptTemplateActions
createMessage() - Method in class org.springframework.ai.chat.prompt.AssistantPromptTemplate
createMessage() - Method in class org.springframework.ai.chat.prompt.PromptTemplate
createMessage() - Method in interface org.springframework.ai.chat.prompt.PromptTemplateMessageActions
createMessage() - Method in class org.springframework.ai.chat.prompt.SystemPromptTemplate
createMessage(List) - Method in class org.springframework.ai.chat.prompt.PromptTemplate
createMessage(List) - Method in interface org.springframework.ai.chat.prompt.PromptTemplateMessageActions
createMessage(Map) - Method in class org.springframework.ai.chat.prompt.AssistantPromptTemplate
createMessage(Map) - Method in class org.springframework.ai.chat.prompt.PromptTemplate
createMessage(Map) - Method in interface org.springframework.ai.chat.prompt.PromptTemplateMessageActions
createMessage(Map) - Method in class org.springframework.ai.chat.prompt.SystemPromptTemplate
createMessages() - Method in class org.springframework.ai.chat.prompt.ChatPromptTemplate
createMessages() - Method in interface org.springframework.ai.chat.prompt.PromptTemplateChatActions
createMessages(Map) - Method in class org.springframework.ai.chat.prompt.ChatPromptTemplate
createMessages(Map) - Method in interface org.springframework.ai.chat.prompt.PromptTemplateChatActions
CURRENT - Enum constant in enum class org.springframework.ai.model.transformer.SummaryMetadataEnricher.SummaryType

D

dangerousAndCriminalContent(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
dangerousAndCriminalContent(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
DEEPSEEK - Static variable in class org.springframework.ai.model.SpringAIModels
DEFAULT_CONVERSATION_ID - Static variable in interface org.springframework.ai.chat.memory.ChatMemory
DEFAULT_NAME - Static variable in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
DEFAULT_NAME - Static variable in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
DEFAULT_NAME - Static variable in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
DEFAULT_NAME - Static variable in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention
DEFAULT_SUMMARY_EXTRACT_TEMPLATE - Static variable in class org.springframework.ai.model.transformer.SummaryMetadataEnricher
DEFAULT_TOOL_EXECUTION_ENABLED - Static variable in interface org.springframework.ai.model.tool.ToolCallingChatOptions
DefaultChatGenerationMetadata - Class in org.springframework.ai.chat.metadata: Default implementation of ChatGenerationMetadata.
DefaultChatGenerationMetadataBuilder - Class in org.springframework.ai.chat.metadata
DefaultChatModelObservationConvention - Class in org.springframework.ai.chat.observation: Default conventions to populate observations for chat model operations.
DefaultChatModelObservationConvention() - Constructor for class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
DefaultChatOptions - Class in org.springframework.ai.chat.prompt: Default implementation for the ChatOptions.
DefaultChatOptions() - Constructor for class org.springframework.ai.chat.prompt.DefaultChatOptions
DefaultChatOptionsBuilder - Class in org.springframework.ai.chat.prompt: Implementation of ChatOptions.Builder to create DefaultChatOptions.
DefaultChatOptionsBuilder() - Constructor for class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
DefaultChatOptionsBuilder(DefaultChatOptions) - Constructor for class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
DefaultEmbeddingModelObservationConvention - Class in org.springframework.ai.embedding.observation: Default conventions to populate observations for embedding model operations.
DefaultEmbeddingModelObservationConvention() - Constructor for class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
DefaultEmbeddingOptions - Class in org.springframework.ai.embedding: Default implementation of EmbeddingOptions.
DefaultEmbeddingOptions() - Constructor for class org.springframework.ai.embedding.DefaultEmbeddingOptions
DefaultEmbeddingOptionsBuilder - Class in org.springframework.ai.embedding: Default implementation of EmbeddingOptions.Builder.
DefaultEmbeddingOptionsBuilder() - Constructor for class org.springframework.ai.embedding.DefaultEmbeddingOptionsBuilder
DefaultImageModelObservationConvention - Class in org.springframework.ai.image.observation: Default conventions to populate observations for image model operations.
DefaultImageModelObservationConvention() - Constructor for class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
DefaultTextToSpeechOptions - Class in org.springframework.ai.audio.tts: Default implementation of the TextToSpeechOptions interface.
DefaultTextToSpeechOptions.Builder - Class in org.springframework.ai.audio.tts
DefaultToolCallingChatOptions - Class in org.springframework.ai.model.tool: Default implementation of ToolCallingChatOptions.
DefaultToolCallingChatOptions() - Constructor for class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
DefaultToolCallingChatOptions.Builder - Class in org.springframework.ai.model.tool: Default implementation of ToolCallingChatOptions.Builder.
DefaultToolCallingManager - Class in org.springframework.ai.model.tool: Default implementation of ToolCallingManager.
DefaultToolCallingManager(ObservationRegistry, ToolCallbackResolver, ToolExecutionExceptionProcessor) - Constructor for class org.springframework.ai.model.tool.DefaultToolCallingManager
DefaultToolCallingManager.Builder - Class in org.springframework.ai.model.tool
DefaultToolCallingObservationConvention - Class in org.springframework.ai.tool.observation: Default conventions to populate observations for tool calling operations.
DefaultToolCallingObservationConvention() - Constructor for class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention
DefaultToolCallingObservationConvention(String) - Constructor for class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention
DefaultToolCallResultConverter - Class in org.springframework.ai.tool.execution: A default implementation of ToolCallResultConverter.
DefaultToolCallResultConverter() - Constructor for class org.springframework.ai.tool.execution.DefaultToolCallResultConverter
DefaultToolDefinition - Record Class in org.springframework.ai.tool.definition: Default implementation of ToolDefinition.
DefaultToolDefinition(String, String, String) - Constructor for record class org.springframework.ai.tool.definition.DefaultToolDefinition: Creates an instance of a DefaultToolDefinition record class.
DefaultToolDefinition.Builder - Class in org.springframework.ai.tool.definition
DefaultToolExecutionEligibilityPredicate - Class in org.springframework.ai.model.tool: Default implementation of ToolExecutionEligibilityPredicate that checks whether tool execution is enabled in the prompt options and if the chat response contains tool calls.
DefaultToolExecutionEligibilityPredicate() - Constructor for class org.springframework.ai.model.tool.DefaultToolExecutionEligibilityPredicate
DefaultToolExecutionExceptionProcessor - Class in org.springframework.ai.tool.execution: Default implementation of ToolExecutionExceptionProcessor.
DefaultToolExecutionExceptionProcessor(boolean) - Constructor for class org.springframework.ai.tool.execution.DefaultToolExecutionExceptionProcessor
DefaultToolExecutionExceptionProcessor(boolean, List) - Constructor for class org.springframework.ai.tool.execution.DefaultToolExecutionExceptionProcessor
DefaultToolExecutionExceptionProcessor.Builder - Class in org.springframework.ai.tool.execution
DefaultToolExecutionResult - Record Class in org.springframework.ai.model.tool: Default implementation of ToolExecutionResult.
DefaultToolExecutionResult(List, boolean) - Constructor for record class org.springframework.ai.model.tool.DefaultToolExecutionResult: Creates an instance of a DefaultToolExecutionResult record class.
DefaultToolExecutionResult.Builder - Class in org.springframework.ai.model.tool
DefaultToolMetadata - Record Class in org.springframework.ai.tool.metadata: Default implementation of ToolMetadata.
DefaultToolMetadata(boolean) - Constructor for record class org.springframework.ai.tool.metadata.DefaultToolMetadata: Creates an instance of a DefaultToolMetadata record class.
DefaultToolMetadata.Builder - Class in org.springframework.ai.tool.metadata
DefaultUsage - Class in org.springframework.ai.chat.metadata: Default implementation of the Usage interface.
DefaultUsage(Integer, Integer, Integer, Object) - Constructor for class org.springframework.ai.chat.metadata.DefaultUsage: Create a new DefaultUsage with promptTokens, completionTokens, totalTokens and native Usage object.
DefaultUsage(Integer, Integer) - Constructor for class org.springframework.ai.chat.metadata.DefaultUsage: Create a new DefaultUsage with promptTokens and completionTokens.
DefaultUsage(Integer, Integer, Integer) - Constructor for class org.springframework.ai.chat.metadata.DefaultUsage: Create a new DefaultUsage with promptTokens, completionTokens, and totalTokens.
DefaultUsage(Integer, Integer, Integer) - Constructor for record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage: Creates an instance of a DefaultUsage record class.
delegate(ToolCallbackProvider) - Method in class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider.Builder: Sets the delegate ToolCallbackProvider
DelegatingToolCallbackResolver - Class in org.springframework.ai.tool.resolution: A ToolCallbackResolver that delegates to a list of ToolCallbackResolver instances.
DelegatingToolCallbackResolver(List) - Constructor for class org.springframework.ai.tool.resolution.DelegatingToolCallbackResolver
deleteByConversationId(String) - Method in interface org.springframework.ai.chat.memory.ChatMemoryRepository
deleteByConversationId(String) - Method in class org.springframework.ai.chat.memory.InMemoryChatMemoryRepository
description() - Element in annotation interface org.springframework.ai.tool.annotation.Tool: The description of the tool.
description() - Element in annotation interface org.springframework.ai.tool.annotation.ToolParam: The description of the tool argument.
description() - Method in record class org.springframework.ai.tool.augment.ToolInputSchemaAugmenter.AugmentedArgumentType: Returns the value of the description record component.
description() - Method in record class org.springframework.ai.tool.definition.DefaultToolDefinition: Returns the value of the description record component.
description() - Method in interface org.springframework.ai.tool.definition.ToolDefinition: The tool description, used by the AI model to determine what the tool does.
description(String) - Method in class org.springframework.ai.tool.definition.DefaultToolDefinition.Builder
description(String) - Method in class org.springframework.ai.tool.function.FunctionToolCallback.Builder
dimensions() - Method in class org.springframework.ai.embedding.AbstractEmbeddingModel
dimensions() - Method in interface org.springframework.ai.embedding.DocumentEmbeddingModel
dimensions() - Method in interface org.springframework.ai.embedding.EmbeddingModel: Get the number of dimensions of the embedded vectors.
dimensions(Integer) - Method in class org.springframework.ai.embedding.DefaultEmbeddingOptionsBuilder
dimensions(Integer) - Method in interface org.springframework.ai.embedding.EmbeddingOptions.Builder
dimensions(EmbeddingModel, String, String) - Static method in class org.springframework.ai.embedding.AbstractEmbeddingModel: Return the dimension of the requested embedding generative name.
DocumentEmbeddingModel - Interface in org.springframework.ai.embedding: EmbeddingModel is a generic interface for embedding models.
DocumentEmbeddingRequest - Class in org.springframework.ai.embedding: Represents a request to embed a list of documents.
DocumentEmbeddingRequest(List) - Constructor for class org.springframework.ai.embedding.DocumentEmbeddingRequest
DocumentEmbeddingRequest(List, EmbeddingOptions) - Constructor for class org.springframework.ai.embedding.DocumentEmbeddingRequest
DocumentEmbeddingRequest(Document...) - Constructor for class org.springframework.ai.embedding.DocumentEmbeddingRequest
doubleToFloat(List) - Static method in class org.springframework.ai.model.EmbeddingUtils

E

ELEVEN_LABS - Static variable in class org.springframework.ai.model.SpringAIModels
embed(String) - Method in interface org.springframework.ai.embedding.EmbeddingModel: Embeds the given text into a vector.
embed(List) - Method in interface org.springframework.ai.embedding.EmbeddingModel: Embeds a batch of texts into vectors.
embed(List, EmbeddingOptions, BatchingStrategy) - Method in interface org.springframework.ai.embedding.EmbeddingModel: Embeds a batch of Documents into vectors based on a BatchingStrategy.
embed(Document) - Method in interface org.springframework.ai.embedding.EmbeddingModel: Embeds the given document's content into a vector.
Embedding - Class in org.springframework.ai.embedding: Represents a single embedding vector.
Embedding(float[], Integer) - Constructor for class org.springframework.ai.embedding.Embedding: Creates a new Embedding instance.
Embedding(float[], Integer, EmbeddingResultMetadata) - Constructor for class org.springframework.ai.embedding.Embedding: Creates a new Embedding instance.
EMBEDDING_MODEL - Static variable in class org.springframework.ai.model.SpringAIModelProperties
EMBEDDING_MODEL_OPERATION - Enum constant in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation
embeddingDimensions - Variable in class org.springframework.ai.embedding.AbstractEmbeddingModel: Cached embedding dimensions.
EmbeddingModel - Interface in org.springframework.ai.embedding: EmbeddingModel is a generic interface for embedding models.
EmbeddingModelDescription - Interface in org.springframework.ai.model: Description of an embedding model.
EmbeddingModelMeterObservationHandler - Class in org.springframework.ai.embedding.observation: Handler for generating metrics from embedding model observations.
EmbeddingModelMeterObservationHandler(MeterRegistry) - Constructor for class org.springframework.ai.embedding.observation.EmbeddingModelMeterObservationHandler
EmbeddingModelObservationContext - Class in org.springframework.ai.embedding.observation: Context used to store metadata for embedding model exchanges.
EmbeddingModelObservationContext.Builder - Class in org.springframework.ai.embedding.observation
EmbeddingModelObservationConvention - Interface in org.springframework.ai.embedding.observation: Interface for an ObservationConvention for embedding model exchanges.
EmbeddingModelObservationDocumentation - Enum Class in org.springframework.ai.embedding.observation: Documented conventions for embedding model observations.
EmbeddingModelObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.ai.embedding.observation: High-cardinality observation key names for embedding model operations.
EmbeddingModelObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.ai.embedding.observation: Low-cardinality observation key names for embedding model operations.
EmbeddingOptions - Interface in org.springframework.ai.embedding: Options for embedding models.
EmbeddingOptions.Builder - Interface in org.springframework.ai.embedding
embeddingRequest(EmbeddingRequest) - Method in class org.springframework.ai.embedding.observation.EmbeddingModelObservationContext.Builder
EmbeddingRequest - Class in org.springframework.ai.embedding: Request to embed a list of input instructions.
EmbeddingRequest(List, EmbeddingOptions) - Constructor for class org.springframework.ai.embedding.EmbeddingRequest
EmbeddingResponse - Class in org.springframework.ai.embedding: Embedding response object.
EmbeddingResponse(List) - Constructor for class org.springframework.ai.embedding.EmbeddingResponse: Creates a new EmbeddingResponse instance with empty metadata.
EmbeddingResponse(List, EmbeddingResponseMetadata) - Constructor for class org.springframework.ai.embedding.EmbeddingResponse: Creates a new EmbeddingResponse instance.
EmbeddingResponseMetadata - Class in org.springframework.ai.embedding: Common AI provider metadata returned in an embedding response.
EmbeddingResponseMetadata() - Constructor for class org.springframework.ai.embedding.EmbeddingResponseMetadata
EmbeddingResponseMetadata(String, Usage) - Constructor for class org.springframework.ai.embedding.EmbeddingResponseMetadata
EmbeddingResponseMetadata(String, Usage, Map) - Constructor for class org.springframework.ai.embedding.EmbeddingResponseMetadata
EmbeddingResultMetadata - Class in org.springframework.ai.embedding: Metadata associated with the embedding result.
EmbeddingResultMetadata() - Constructor for class org.springframework.ai.embedding.EmbeddingResultMetadata
EmbeddingResultMetadata(String, EmbeddingResultMetadata.ModalityType, MimeType, Object) - Constructor for class org.springframework.ai.embedding.EmbeddingResultMetadata
EmbeddingResultMetadata.ModalityType - Enum Class in org.springframework.ai.embedding
EmbeddingResultMetadata.ModalityUtils - Class in org.springframework.ai.embedding
EmbeddingUtils - Class in org.springframework.ai.model: Utility methods for embedding related operations.
embedForResponse(List) - Method in interface org.springframework.ai.embedding.EmbeddingModel: Embeds a batch of texts into vectors and returns the EmbeddingResponse.
empty() - Static method in interface org.springframework.ai.chat.metadata.PromptMetadata: Factory method used to create empty PromptMetadata when the information is not supplied by the AI provider.
EMPTY - Static variable in class org.springframework.ai.embedding.EmbeddingResultMetadata
EmptyRateLimit - Class in org.springframework.ai.chat.metadata: A RateLimit implementation that returns zero for all property getters
EmptyRateLimit() - Constructor for class org.springframework.ai.chat.metadata.EmptyRateLimit
EmptyUsage - Class in org.springframework.ai.chat.metadata: A EmptyUsage implementation that returns zero for all property getters
EmptyUsage() - Constructor for class org.springframework.ai.chat.metadata.EmptyUsage
ensureValidInputSchema(String) - Static method in class org.springframework.ai.util.json.schema.JsonSchemaUtils: Ensures that the input schema is valid for AI model APIs.
entrySet() - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata
entrySet() - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
entrySet() - Method in class org.springframework.ai.model.AbstractResponseMetadata
entrySet() - Method in class org.springframework.ai.model.MutableResponseMetadata
entrySet() - Method in interface org.springframework.ai.model.ResponseMetadata
equals(Object) - Method in class org.springframework.ai.audio.transcription.AudioTranscription
equals(Object) - Method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions
equals(Object) - Method in class org.springframework.ai.audio.tts.Speech
equals(Object) - Method in class org.springframework.ai.audio.tts.TextToSpeechMessage
equals(Object) - Method in class org.springframework.ai.audio.tts.TextToSpeechPrompt
equals(Object) - Method in class org.springframework.ai.audio.tts.TextToSpeechResponse
equals(Object) - Method in class org.springframework.ai.chat.messages.AbstractMessage
equals(Object) - Method in class org.springframework.ai.chat.messages.AssistantMessage
equals(Object) - Method in record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.springframework.ai.chat.messages.SystemMessage
equals(Object) - Method in class org.springframework.ai.chat.messages.ToolResponseMessage
equals(Object) - Method in record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata
equals(Object) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
equals(Object) - Method in class org.springframework.ai.chat.metadata.DefaultUsage
equals(Object) - Method in class org.springframework.ai.chat.model.ChatResponse
equals(Object) - Method in class org.springframework.ai.chat.model.Generation
equals(Object) - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.springframework.ai.chat.prompt.Prompt
equals(Object) - Method in class org.springframework.ai.embedding.Embedding
equals(Object) - Method in class org.springframework.ai.embedding.EmbeddingResponse
equals(Object) - Method in class org.springframework.ai.image.Image
equals(Object) - Method in class org.springframework.ai.image.ImageMessage
equals(Object) - Method in class org.springframework.ai.image.ImagePrompt
equals(Object) - Method in class org.springframework.ai.image.ImageResponse
equals(Object) - Method in record class org.springframework.ai.model.SimpleApiKey: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.model.tool.DefaultToolExecutionResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.springframework.ai.moderation.Categories
equals(Object) - Method in class org.springframework.ai.moderation.CategoryScores
equals(Object) - Method in class org.springframework.ai.moderation.Moderation
equals(Object) - Method in class org.springframework.ai.moderation.ModerationMessage
equals(Object) - Method in class org.springframework.ai.moderation.ModerationPrompt
equals(Object) - Method in class org.springframework.ai.moderation.ModerationResponse
equals(Object) - Method in class org.springframework.ai.moderation.ModerationResult
equals(Object) - Method in record class org.springframework.ai.tool.augment.AugmentedArgumentEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.tool.augment.ToolInputSchemaAugmenter.AugmentedArgumentType: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.tool.definition.DefaultToolDefinition: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.tool.metadata.DefaultToolMetadata: Indicates whether some other object is "equal to" this one.
ErrorLoggingObservationHandler - Class in org.springframework.ai.model.observation: An ObservationHandler that logs errors using a Tracer.
ErrorLoggingObservationHandler(Tracer, List) - Constructor for class org.springframework.ai.model.observation.ErrorLoggingObservationHandler
ErrorLoggingObservationHandler(Tracer, List, Consumer) - Constructor for class org.springframework.ai.model.observation.ErrorLoggingObservationHandler
EXCERPT_KEYWORDS_METADATA_KEY - Static variable in class org.springframework.ai.model.transformer.KeywordMetadataEnricher
executeToolCalls(Prompt, ChatResponse) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager
executeToolCalls(Prompt, ChatResponse) - Method in interface org.springframework.ai.model.tool.ToolCallingManager: Execute the tool calls requested by the model.

F

financial(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
financial(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
findByConversationId(String) - Method in interface org.springframework.ai.chat.memory.ChatMemoryRepository
findByConversationId(String) - Method in class org.springframework.ai.chat.memory.InMemoryChatMemoryRepository
findByPromptIndex(int) - Method in interface org.springframework.ai.chat.metadata.PromptMetadata: Returns an Optional PromptMetadata.PromptFilterMetadata at the given index.
findClassesInPackage(String, TypeFilter) - Static method in class org.springframework.ai.aot.AiRuntimeHints: Finds all classes in the specified package that match the given type filter.
findConversationIds() - Method in interface org.springframework.ai.chat.memory.ChatMemoryRepository
findConversationIds() - Method in class org.springframework.ai.chat.memory.InMemoryChatMemoryRepository
findInnerClassesFor(Class) - Static method in class org.springframework.ai.aot.AiRuntimeHints: Discovers all inner classes of a given class.
findJsonAnnotatedClassesInPackage(Class) - Static method in class org.springframework.ai.aot.AiRuntimeHints: Finds classes in a package that are annotated with JsonInclude or have Jackson annotations.
findJsonAnnotatedClassesInPackage(String) - Static method in class org.springframework.ai.aot.AiRuntimeHints: Finds classes in a package that are annotated with JsonInclude or have Jackson annotations.
FINISH_REASON - Static variable in interface org.springframework.ai.model.tool.ToolExecutionResult
finishReason(String) - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata.Builder: Set the reason this choice completed for the generation.
finishReason(String) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadataBuilder
flagged(boolean) - Method in class org.springframework.ai.moderation.ModerationResult.Builder
format(String) - Method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions.Builder
format(String) - Method in interface org.springframework.ai.audio.tts.TextToSpeechOptions.Builder: Sets the output format for the generated audio.
FormatProvider - Interface in org.springframework.ai.converter: Implementations of this interface provides instructions for how the output of a language generative should be formatted.
frequencyPenalty(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
frequencyPenalty(Double) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
frequencyPenalty(Double) - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder: Builds with the frequency penalty to use for the chat.
frequencyPenalty(Double) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
from(int, Object) - Static method in interface org.springframework.ai.chat.metadata.PromptMetadata.PromptFilterMetadata: Factory method used to construct a new PromptMetadata.PromptFilterMetadata with the given prompt index and content filter metadata.
from(Object...) - Static method in class org.springframework.ai.support.ToolCallbacks
from(Method) - Static method in interface org.springframework.ai.tool.metadata.ToolMetadata: Create a default ToolMetadata instance from a Method.
from(Method) - Static method in class org.springframework.ai.tool.support.ToolDefinitions: Create a default ToolDefinition instance from a Method.
from(List) - Static method in interface org.springframework.ai.tool.ToolCallbackProvider
from(ChatResponse) - Method in class org.springframework.ai.chat.model.ChatResponse.Builder
from(ToolCallback...) - Static method in interface org.springframework.ai.tool.ToolCallbackProvider
fromJson(Integer, Integer, Integer, Object) - Static method in class org.springframework.ai.chat.metadata.DefaultUsage: Create a new DefaultUsage with promptTokens, completionTokens, and totalTokens.
fromJson(String, TypeReference) - Static method in class org.springframework.ai.util.json.JsonParser: Converts a JSON string to a Java object.
fromJson(String, Class) - Static method in class org.springframework.ai.util.json.JsonParser: Converts a JSON string to a Java object.
fromJson(String, Type) - Static method in class org.springframework.ai.util.json.JsonParser: Converts a JSON string to a Java object.
FunctionToolCallback<I,O> - Class in org.springframework.ai.tool.function: A ToolCallback implementation to invoke functions as tools.
FunctionToolCallback(ToolDefinition, ToolMetadata, Type, BiFunction, ToolCallResultConverter) - Constructor for class org.springframework.ai.tool.function.FunctionToolCallback
FunctionToolCallback.Builder<I,O> - Class in org.springframework.ai.tool.function

G

generate(Usage, Observation.Context, MeterRegistry) - Static method in class org.springframework.ai.model.observation.ModelUsageMetricsGenerator
generateForMethodInput(Method, JsonSchemaGenerator.SchemaOption...) - Static method in class org.springframework.ai.util.json.schema.JsonSchemaGenerator: Generate a JSON Schema for a method's input parameters.
generateForType(Type, JsonSchemaGenerator.SchemaOption...) - Static method in class org.springframework.ai.util.json.schema.JsonSchemaGenerator: Generate a JSON Schema for a class type.
Generation - Class in org.springframework.ai.chat.model: Represents a response returned by the AI.
Generation - Class in org.springframework.ai.moderation: The Generation class represents a response from a moderation process.
Generation(AssistantMessage) - Constructor for class org.springframework.ai.chat.model.Generation
Generation(AssistantMessage, ChatGenerationMetadata) - Constructor for class org.springframework.ai.chat.model.Generation
Generation(Moderation) - Constructor for class org.springframework.ai.moderation.Generation
Generation(Moderation, ModerationGenerationMetadata) - Constructor for class org.springframework.ai.moderation.Generation
generationMetadata(ModerationGenerationMetadata) - Method in class org.springframework.ai.moderation.Generation
generations(List) - Method in class org.springframework.ai.chat.model.ChatResponse.Builder
get(String) - Method in interface org.springframework.ai.chat.memory.ChatMemory: Get the messages in the chat memory for the specified conversation.
get(String) - Method in class org.springframework.ai.chat.memory.MessageWindowChatMemory
get(String) - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata
get(String) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
get(String) - Method in class org.springframework.ai.model.AbstractResponseMetadata: Gets an entry from the context.
get(String) - Method in class org.springframework.ai.model.MutableResponseMetadata: Gets an entry from the context.
get(String) - Method in interface org.springframework.ai.model.ResponseMetadata: Gets an entry from the context.
getB64Json() - Method in class org.springframework.ai.image.Image
getBiFunctionArgumentClass(Class, int) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper: Retrieves the class of a specific argument in a given function class.
getBiFunctionInputClass(Class) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper: Returns the input class of a given function class.
getCategories() - Method in class org.springframework.ai.moderation.ModerationResult
getCategoryScores() - Method in class org.springframework.ai.moderation.ModerationResult
getCompletionTokens() - Method in class org.springframework.ai.chat.metadata.DefaultUsage
getCompletionTokens() - Method in class org.springframework.ai.chat.metadata.EmptyUsage
getCompletionTokens() - Method in interface org.springframework.ai.chat.metadata.Usage: Returns the number of tokens returned in the generation (aka completion) of the AI's response.
getCompletionTokens() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage
getConsumerInputClass(Class) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper: Returns the input class of a given Consumer class.
getContentFilterMetadata() - Method in interface org.springframework.ai.chat.metadata.PromptMetadata.PromptFilterMetadata: Returns the underlying AI provider metadata for filtering applied to prompt content.
getContentFilters() - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata
getContentFilters() - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
getContents() - Method in class org.springframework.ai.chat.prompt.Prompt
getContext() - Method in class org.springframework.ai.chat.model.ToolContext: Returns the immutable context map.
getContext() - Static method in class org.springframework.ai.model.tool.internal.ToolCallReactiveContextHolder
getContextualName(ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
getContextualName(EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
getContextualName(ImageModelObservationContext) - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
getContextualName(ToolCallingObservationContext) - Method in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention
getConversionService() - Method in class org.springframework.ai.converter.AbstractConversionServiceOutputConverter: Return the ConversionService used by this converter.
getCreated() - Method in class org.springframework.ai.image.ImageResponseMetadata
getCumulativeUsage(Usage, ChatResponse) - Static method in class org.springframework.ai.support.UsageCalculator: Accumulate usage tokens from the previous chat response to the current usage tokens.
getDangerousAndCriminalContent() - Method in class org.springframework.ai.moderation.CategoryScores
getDefaultOptions() - Method in interface org.springframework.ai.audio.tts.TextToSpeechModel
getDefaultOptions() - Method in interface org.springframework.ai.chat.model.ChatModel
getDescription() - Method in interface org.springframework.ai.model.ModelDescription: Returns the description of the model.
getDimensions() - Method in class org.springframework.ai.embedding.DefaultEmbeddingOptions
getDimensions() - Method in interface org.springframework.ai.embedding.EmbeddingOptions
getDimensions() - Method in interface org.springframework.ai.model.EmbeddingModelDescription
getDocumentData() - Method in class org.springframework.ai.embedding.EmbeddingResultMetadata
getDocumentId() - Method in class org.springframework.ai.embedding.EmbeddingResultMetadata
getDuplicateToolNames(List) - Static method in class org.springframework.ai.tool.support.ToolUtils
getDuplicateToolNames(ToolCallback...) - Static method in class org.springframework.ai.tool.support.ToolUtils
getFinancial() - Method in class org.springframework.ai.moderation.CategoryScores
getFinishReason() - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata: Get the reason this choice completed for the generation.
getFinishReason() - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
getFormat() - Method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions
getFormat() - Method in interface org.springframework.ai.audio.tts.TextToSpeechOptions: Returns the output format for the generated audio.
getFormat() - Method in class org.springframework.ai.converter.BeanOutputConverter: Provides the expected format of the response, instructing that it should adhere to the generated JSON schema.
getFormat() - Method in interface org.springframework.ai.converter.FormatProvider: Get the format of the output of a language generative.
getFormat() - Method in class org.springframework.ai.converter.ListOutputConverter
getFormat() - Method in class org.springframework.ai.converter.MapOutputConverter
getFrequencyPenalty() - Method in interface org.springframework.ai.chat.prompt.ChatOptions: Returns the frequency penalty to use for the chat.
getFrequencyPenalty() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
getFrequencyPenalty() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
getFunctionArgumentClass(Class, int) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper: Retrieves the class of a specific argument in a given function class.
getFunctionArgumentType(ResolvableType, int) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper: Retrieves the type of a specific argument in a given function class.
getFunctionInputClass(Class) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper: Returns the input class of a given function class.
getFunctionOutputClass(Class) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper: Returns the output class of a given function class.
getHarassment() - Method in class org.springframework.ai.moderation.CategoryScores
getHarassmentThreatening() - Method in class org.springframework.ai.moderation.CategoryScores
getHate() - Method in class org.springframework.ai.moderation.CategoryScores
getHateThreatening() - Method in class org.springframework.ai.moderation.CategoryScores
getHealth() - Method in class org.springframework.ai.moderation.CategoryScores
getHeight() - Method in interface org.springframework.ai.image.ImageOptions
getHighCardinalityKeyValues(ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
getHighCardinalityKeyValues(EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
getHighCardinalityKeyValues(ImageModelObservationContext) - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
getHighCardinalityKeyValues(ToolCallingObservationContext) - Method in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention
getId() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata: A unique identifier for the chat completion operation.
getId() - Method in class org.springframework.ai.moderation.Moderation
getIndex() - Method in class org.springframework.ai.embedding.Embedding
getInstructions() - Method in class org.springframework.ai.audio.transcription.AudioTranscriptionPrompt
getInstructions() - Method in class org.springframework.ai.audio.tts.TextToSpeechPrompt
getInstructions() - Method in class org.springframework.ai.chat.prompt.Prompt
getInstructions() - Method in class org.springframework.ai.embedding.DocumentEmbeddingRequest
getInstructions() - Method in class org.springframework.ai.embedding.EmbeddingRequest
getInstructions() - Method in class org.springframework.ai.image.ImagePrompt
getInstructions() - Method in interface org.springframework.ai.model.ModelRequest: Retrieves the instructions or input required by the AI model.
getInstructions() - Method in class org.springframework.ai.moderation.ModerationPrompt
getInternalToolExecutionEnabled() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
getInternalToolExecutionEnabled() - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions: Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
getJsonPropertyValues(Class) - Static method in class org.springframework.ai.model.ModelOptionsUtils: Returns the list of name values of the JsonProperty annotations.
getJsonSchema() - Method in class org.springframework.ai.converter.BeanOutputConverter: Provides the generated JSON schema for the target type.
getJsonSchema(Type) - Static method in class org.springframework.ai.model.ModelOptionsUtils
getJsonSchema(Type, boolean) - Static method in class org.springframework.ai.model.ModelOptionsUtils: Generates JSON Schema (version 2020_12) for the given class.
getJsonSchemaMap() - Method in class org.springframework.ai.converter.BeanOutputConverter
getLastUserOrToolResponseMessage() - Method in class org.springframework.ai.chat.prompt.Prompt: Get the last user or tool response message in the prompt.
getLaw() - Method in class org.springframework.ai.moderation.CategoryScores
getLowCardinalityKeyValues(ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
getLowCardinalityKeyValues(EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
getLowCardinalityKeyValues(ImageModelObservationContext) - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
getLowCardinalityKeyValues(ToolCallingObservationContext) - Method in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention
getMaxTokens() - Method in interface org.springframework.ai.chat.prompt.ChatOptions: Returns the maximum number of tokens to use for the chat.
getMaxTokens() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
getMaxTokens() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
getMedia() - Method in class org.springframework.ai.chat.messages.AssistantMessage
getMedia() - Method in class org.springframework.ai.chat.messages.UserMessage
getMessageConverter() - Method in class org.springframework.ai.converter.AbstractMessageOutputConverter: Return the message converter used by this output converter.
getMessageType() - Method in class org.springframework.ai.chat.messages.AbstractMessage: Get the message type of the message.
getMessageType() - Method in interface org.springframework.ai.chat.messages.Message: Get the message type.
getMetadata() - Method in class org.springframework.ai.audio.transcription.AudioTranscription
getMetadata() - Method in class org.springframework.ai.audio.transcription.AudioTranscriptionResponse
getMetadata() - Method in class org.springframework.ai.audio.tts.Speech
getMetadata() - Method in class org.springframework.ai.audio.tts.TextToSpeechResponse
getMetadata() - Method in class org.springframework.ai.chat.messages.AbstractMessage: Get the metadata of the message.
getMetadata() - Method in class org.springframework.ai.chat.model.ChatResponse
getMetadata() - Method in class org.springframework.ai.chat.model.Generation
getMetadata() - Method in class org.springframework.ai.embedding.Embedding
getMetadata() - Method in class org.springframework.ai.embedding.EmbeddingResponse
getMetadata() - Method in class org.springframework.ai.image.ImageGeneration
getMetadata() - Method in class org.springframework.ai.image.ImageResponse
getMetadata() - Method in interface org.springframework.ai.model.ModelResponse: Retrieves the response metadata associated with the AI model's response.
getMetadata() - Method in interface org.springframework.ai.model.ModelResult: Retrieves the metadata associated with the result of an AI model.
getMetadata() - Method in class org.springframework.ai.moderation.Generation
getMetadata() - Method in class org.springframework.ai.moderation.ModerationResponse
getMimeType() - Method in class org.springframework.ai.embedding.EmbeddingResultMetadata
getModalityType() - Method in class org.springframework.ai.embedding.EmbeddingResultMetadata
getModalityType(MimeType) - Static method in class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityUtils: Infers the EmbeddingResultMetadata.ModalityType of the source data used to generate the embedding using the source data MimeType.
getModel() - Method in interface org.springframework.ai.audio.transcription.AudioTranscriptionOptions
getModel() - Method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions
getModel() - Method in interface org.springframework.ai.audio.tts.TextToSpeechOptions: Returns the model to use for text-to-speech.
getModel() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata: The model that handled the request.
getModel() - Method in interface org.springframework.ai.chat.prompt.ChatOptions: Returns the model to use for the chat.
getModel() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
getModel() - Method in class org.springframework.ai.embedding.DefaultEmbeddingOptions
getModel() - Method in interface org.springframework.ai.embedding.EmbeddingOptions
getModel() - Method in class org.springframework.ai.embedding.EmbeddingResponseMetadata: The model that handled the request.
getModel() - Method in interface org.springframework.ai.image.ImageOptions
getModel() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
getModel() - Method in class org.springframework.ai.moderation.Moderation
getModel() - Method in interface org.springframework.ai.moderation.ModerationOptions
getN() - Method in interface org.springframework.ai.image.ImageOptions
getName() - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
getName() - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
getName() - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
getName() - Method in interface org.springframework.ai.model.ModelDescription: Returns the name of the model.
getName() - Method in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention
getNativeUsage() - Method in class org.springframework.ai.chat.metadata.DefaultUsage
getNativeUsage() - Method in class org.springframework.ai.chat.metadata.EmptyUsage
getNativeUsage() - Method in interface org.springframework.ai.chat.metadata.Usage: Return the usage data from the underlying model API response.
getNativeUsage() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage
getObjectMapper() - Method in class org.springframework.ai.converter.BeanOutputConverter: Configures and returns an object mapper for JSON operations.
getObjectMapper() - Static method in class org.springframework.ai.util.json.JsonParser: Returns a Jackson ObjectMapper instance tailored for JSON-parsing operations for tool calling and structured output.
getOperationMetadata() - Method in class org.springframework.ai.model.observation.ModelObservationContext
getOperationMetadata() - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext
getOperationType() - Method in class org.springframework.ai.image.observation.ImageModelObservationContext
getOptions() - Method in class org.springframework.ai.audio.transcription.AudioTranscriptionPrompt
getOptions() - Method in class org.springframework.ai.audio.tts.TextToSpeechPrompt
getOptions() - Method in class org.springframework.ai.chat.prompt.Prompt
getOptions() - Method in class org.springframework.ai.embedding.DocumentEmbeddingRequest
getOptions() - Method in class org.springframework.ai.embedding.EmbeddingRequest
getOptions() - Method in class org.springframework.ai.image.ImagePrompt
getOptions() - Method in interface org.springframework.ai.model.ModelRequest: Retrieves the customizable options for AI model interactions.
getOptions() - Method in class org.springframework.ai.moderation.ModerationPrompt
getOrDefault(Object, T) - Method in class org.springframework.ai.model.AbstractResponseMetadata: Returns an element or default if not present.
getOrDefault(Object, T) - Method in class org.springframework.ai.model.MutableResponseMetadata: Returns an element or default if not present.
getOrDefault(Object, T) - Method in interface org.springframework.ai.model.ResponseMetadata: Returns an element or default if not present.
getOrDefault(String, Supplier) - Method in interface org.springframework.ai.model.ResponseMetadata: Returns an element or default if not present.
getOrDefault(String, T) - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata
getOrDefault(String, T) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
getOutput() - Method in class org.springframework.ai.audio.transcription.AudioTranscription
getOutput() - Method in class org.springframework.ai.audio.tts.Speech
getOutput() - Method in class org.springframework.ai.chat.model.Generation
getOutput() - Method in class org.springframework.ai.embedding.Embedding
getOutput() - Method in class org.springframework.ai.image.ImageGeneration
getOutput() - Method in interface org.springframework.ai.model.ModelResult: Retrieves the output generated by the AI model.
getOutput() - Method in class org.springframework.ai.moderation.Generation
getOutputSchema() - Method in interface org.springframework.ai.model.tool.StructuredOutputChatOptions
getPii() - Method in class org.springframework.ai.moderation.CategoryScores
getPresencePenalty() - Method in interface org.springframework.ai.chat.prompt.ChatOptions: Returns the presence penalty to use for the chat.
getPresencePenalty() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
getPresencePenalty() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
getPromptIndex() - Method in interface org.springframework.ai.chat.metadata.PromptMetadata.PromptFilterMetadata: Index of the prompt filter metadata contained in the AI response.
getPromptMetadata() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata: Returns the prompt metadata gathered by the AI during request processing.
getPromptTokens() - Method in class org.springframework.ai.chat.metadata.DefaultUsage
getPromptTokens() - Method in class org.springframework.ai.chat.metadata.EmptyUsage
getPromptTokens() - Method in interface org.springframework.ai.chat.metadata.Usage: Returns the number of tokens used in the prompt of the AI request.
getPromptTokens() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage
getRateLimit() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata: Returns AI provider specific metadata on rate limits.
getRawMap() - Method in class org.springframework.ai.model.MutableResponseMetadata
getRequest() - Method in class org.springframework.ai.model.observation.ModelObservationContext
getRequestsLimit() - Method in class org.springframework.ai.chat.metadata.EmptyRateLimit
getRequestsLimit() - Method in interface org.springframework.ai.chat.metadata.RateLimit: Returns the maximum number of requests that are permitted before exhausting the rate limit.
getRequestsRemaining() - Method in class org.springframework.ai.chat.metadata.EmptyRateLimit
getRequestsRemaining() - Method in interface org.springframework.ai.chat.metadata.RateLimit: Returns the remaining number of requests that are permitted before exhausting the rate limit.
getRequestsReset() - Method in class org.springframework.ai.chat.metadata.EmptyRateLimit
getRequestsReset() - Method in interface org.springframework.ai.chat.metadata.RateLimit: Returns the time until the rate limit (based on requests) resets to its initial state.
getRequired(Object) - Method in class org.springframework.ai.model.AbstractResponseMetadata: Gets an entry from the context.
getRequired(Object) - Method in class org.springframework.ai.model.MutableResponseMetadata: Gets an entry from the context.
getRequired(Object) - Method in interface org.springframework.ai.model.ResponseMetadata: Gets an entry from the context.
getResponse() - Method in class org.springframework.ai.model.observation.ModelObservationContext
getResponseFormat() - Method in interface org.springframework.ai.image.ImageOptions
getResponses() - Method in class org.springframework.ai.chat.messages.ToolResponseMessage
getResult() - Method in class org.springframework.ai.audio.transcription.AudioTranscriptionResponse
getResult() - Method in class org.springframework.ai.audio.tts.TextToSpeechResponse
getResult() - Method in class org.springframework.ai.chat.model.ChatResponse
getResult() - Method in class org.springframework.ai.embedding.EmbeddingResponse
getResult() - Method in class org.springframework.ai.image.ImageResponse
getResult() - Method in interface org.springframework.ai.model.ModelResponse: Retrieves the (first) result of the AI model.
getResult() - Method in class org.springframework.ai.moderation.ModerationResponse
getResults() - Method in class org.springframework.ai.audio.transcription.AudioTranscriptionResponse
getResults() - Method in class org.springframework.ai.audio.tts.TextToSpeechResponse
getResults() - Method in class org.springframework.ai.chat.model.ChatResponse: The List of generated outputs.
getResults() - Method in class org.springframework.ai.embedding.EmbeddingResponse
getResults() - Method in class org.springframework.ai.image.ImageResponse: The List of generated outputs.
getResults() - Method in interface org.springframework.ai.model.ModelResponse: Retrieves the list of generated outputs by the AI model.
getResults() - Method in class org.springframework.ai.moderation.Moderation
getResults() - Method in class org.springframework.ai.moderation.ModerationResponse
getSchemaType() - Method in class org.springframework.ai.tool.resolution.SpringBeanToolCallbackResolver
getSelfHarm() - Method in class org.springframework.ai.moderation.CategoryScores
getSelfHarmInstructions() - Method in class org.springframework.ai.moderation.CategoryScores
getSelfHarmIntent() - Method in class org.springframework.ai.moderation.CategoryScores
getSexual() - Method in class org.springframework.ai.moderation.CategoryScores
getSexualMinors() - Method in class org.springframework.ai.moderation.CategoryScores
getSpeed() - Method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions
getSpeed() - Method in interface org.springframework.ai.audio.tts.TextToSpeechOptions: Returns the speed of the generated speech.
getStopSequences() - Method in interface org.springframework.ai.chat.prompt.ChatOptions: Returns the stop sequences to use for the chat.
getStopSequences() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
getStopSequences() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
getStyle() - Method in interface org.springframework.ai.image.ImageOptions
getSystemMessage() - Method in class org.springframework.ai.chat.prompt.Prompt: Get the first system message in the prompt.
getSystemMessages() - Method in class org.springframework.ai.chat.prompt.Prompt: Get all system messages in the prompt.
getTemperature() - Method in interface org.springframework.ai.chat.prompt.ChatOptions: Returns the temperature to use for the chat.
getTemperature() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
getTemperature() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
getTemplate() - Method in class org.springframework.ai.chat.prompt.PromptTemplate
getText() - Method in class org.springframework.ai.audio.tts.TextToSpeechMessage
getText() - Method in class org.springframework.ai.chat.messages.AbstractMessage: Get the content of the message.
getText() - Method in class org.springframework.ai.image.ImageMessage
getText() - Method in class org.springframework.ai.moderation.ModerationMessage
getTokensLimit() - Method in class org.springframework.ai.chat.metadata.EmptyRateLimit
getTokensLimit() - Method in interface org.springframework.ai.chat.metadata.RateLimit: Returns the maximum number of tokens that are permitted before exhausting the rate limit.
getTokensRemaining() - Method in class org.springframework.ai.chat.metadata.EmptyRateLimit
getTokensRemaining() - Method in interface org.springframework.ai.chat.metadata.RateLimit: Returns the remaining number of tokens that are permitted before exhausting the rate limit.
getTokensReset() - Method in class org.springframework.ai.chat.metadata.EmptyRateLimit
getTokensReset() - Method in interface org.springframework.ai.chat.metadata.RateLimit: Returns the time until the rate limit (based on tokens) resets to its initial state.
getToolCallArguments() - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext
getToolCallbacks() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
getToolCallbacks() - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions: ToolCallbacks to be registered with the ChatModel.
getToolCallbacks() - Method in class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider
getToolCallbacks() - Method in class org.springframework.ai.tool.method.MethodToolCallbackProvider
getToolCallbacks() - Method in class org.springframework.ai.tool.StaticToolCallbackProvider: Returns the array of function callbacks held by this provider.
getToolCallbacks() - Method in interface org.springframework.ai.tool.ToolCallbackProvider
getToolCallHistory() - Method in class org.springframework.ai.chat.model.ToolContext: Returns the tool call history from the context map.
getToolCallResult() - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext
getToolCallResultConverter(Method) - Static method in class org.springframework.ai.tool.support.ToolUtils
getToolCalls() - Method in class org.springframework.ai.chat.messages.AssistantMessage
getToolContext() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
getToolContext() - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions: Get the configured tool context.
getToolDefinition() - Method in class org.springframework.ai.tool.augment.AugmentedToolCallback
getToolDefinition() - Method in exception class org.springframework.ai.tool.execution.ToolExecutionException
getToolDefinition() - Method in class org.springframework.ai.tool.function.FunctionToolCallback
getToolDefinition() - Method in class org.springframework.ai.tool.method.MethodToolCallback
getToolDefinition() - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext
getToolDefinition() - Method in interface org.springframework.ai.tool.ToolCallback: Definition used by the AI model to determine when and how to call the tool.
getToolDescription(Method) - Static method in class org.springframework.ai.tool.support.ToolUtils
getToolDescriptionFromName(String) - Static method in class org.springframework.ai.tool.support.ToolUtils
getToolMetadata() - Method in class org.springframework.ai.tool.function.FunctionToolCallback
getToolMetadata() - Method in class org.springframework.ai.tool.method.MethodToolCallback
getToolMetadata() - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext
getToolMetadata() - Method in interface org.springframework.ai.tool.ToolCallback: Metadata providing additional information on how to handle the tool.
getToolName(Method) - Static method in class org.springframework.ai.tool.support.ToolUtils
getToolNames() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
getToolNames() - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions: Names of the tools to register with the ChatModel.
getToolReturnDirect(Method) - Static method in class org.springframework.ai.tool.support.ToolUtils
getTopK() - Method in interface org.springframework.ai.chat.prompt.ChatOptions: Returns the top K to use for the chat.
getTopK() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
getTopK() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
getTopP() - Method in interface org.springframework.ai.chat.prompt.ChatOptions: Returns the top P to use for the chat.
getTopP() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
getTopP() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
getTotalTokens() - Method in class org.springframework.ai.chat.metadata.DefaultUsage
getTotalTokens() - Method in interface org.springframework.ai.chat.metadata.Usage: Return the total number of tokens from both the prompt of an AI request and generation of the AI's response.
getTotalTokens() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage
getUrl() - Method in class org.springframework.ai.image.Image
getUsage() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata: Returns AI provider specific metadata on API usage.
getUsage() - Method in class org.springframework.ai.embedding.EmbeddingResponseMetadata: The AI provider specific metadata on API usage.
getUserMessage() - Method in class org.springframework.ai.chat.prompt.Prompt: Get the last user message in the prompt.
getUserMessages() - Method in class org.springframework.ai.chat.prompt.Prompt: Get all user messages in the prompt.
getValue() - Method in enum class org.springframework.ai.chat.messages.MessageType
getValue() - Method in interface org.springframework.ai.model.ApiKey: Returns an api key to use for a making request.
getValue() - Method in class org.springframework.ai.model.NoopApiKey
getValue() - Method in record class org.springframework.ai.model.SimpleApiKey
getVersion() - Method in interface org.springframework.ai.model.ModelDescription: Returns the version of the model.
getViolence() - Method in class org.springframework.ai.moderation.CategoryScores
getViolenceGraphic() - Method in class org.springframework.ai.moderation.CategoryScores
getVoice() - Method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions
getVoice() - Method in interface org.springframework.ai.audio.tts.TextToSpeechOptions: Returns the voice to use for text-to-speech.
getWeight() - Method in class org.springframework.ai.image.ImageMessage
getWidth() - Method in interface org.springframework.ai.image.ImageOptions
GOOGLE_GEN_AI - Static variable in class org.springframework.ai.model.SpringAIModels

H

harassment(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
harassment(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
harassmentThreatening(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
harassmentThreatening(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
hasFinishReasons(Set) - Method in class org.springframework.ai.chat.model.ChatResponse: Whether the model has finished with any of the given finish reasons.
hashCode() - Method in class org.springframework.ai.audio.transcription.AudioTranscription
hashCode() - Method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions
hashCode() - Method in class org.springframework.ai.audio.tts.Speech
hashCode() - Method in class org.springframework.ai.audio.tts.TextToSpeechMessage
hashCode() - Method in class org.springframework.ai.audio.tts.TextToSpeechPrompt
hashCode() - Method in class org.springframework.ai.audio.tts.TextToSpeechResponse
hashCode() - Method in class org.springframework.ai.chat.messages.AbstractMessage
hashCode() - Method in class org.springframework.ai.chat.messages.AssistantMessage
hashCode() - Method in record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall: Returns a hash code value for this object.
hashCode() - Method in class org.springframework.ai.chat.messages.SystemMessage
hashCode() - Method in class org.springframework.ai.chat.messages.ToolResponseMessage
hashCode() - Method in record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse: Returns a hash code value for this object.
hashCode() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata
hashCode() - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
hashCode() - Method in class org.springframework.ai.chat.metadata.DefaultUsage
hashCode() - Method in class org.springframework.ai.chat.model.ChatResponse
hashCode() - Method in class org.springframework.ai.chat.model.Generation
hashCode() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage: Returns a hash code value for this object.
hashCode() - Method in class org.springframework.ai.chat.prompt.Prompt
hashCode() - Method in class org.springframework.ai.embedding.Embedding
hashCode() - Method in class org.springframework.ai.embedding.EmbeddingResponse
hashCode() - Method in class org.springframework.ai.image.Image
hashCode() - Method in class org.springframework.ai.image.ImageMessage
hashCode() - Method in class org.springframework.ai.image.ImagePrompt
hashCode() - Method in class org.springframework.ai.image.ImageResponse
hashCode() - Method in record class org.springframework.ai.model.SimpleApiKey: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.model.tool.DefaultToolExecutionResult: Returns a hash code value for this object.
hashCode() - Method in class org.springframework.ai.moderation.Categories
hashCode() - Method in class org.springframework.ai.moderation.CategoryScores
hashCode() - Method in class org.springframework.ai.moderation.Moderation
hashCode() - Method in class org.springframework.ai.moderation.ModerationMessage
hashCode() - Method in class org.springframework.ai.moderation.ModerationPrompt
hashCode() - Method in class org.springframework.ai.moderation.ModerationResponse
hashCode() - Method in class org.springframework.ai.moderation.ModerationResult
hashCode() - Method in record class org.springframework.ai.tool.augment.AugmentedArgumentEvent: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.tool.augment.ToolInputSchemaAugmenter.AugmentedArgumentType: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.tool.definition.DefaultToolDefinition: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.tool.metadata.DefaultToolMetadata: Returns a hash code value for this object.
hasToolCalls() - Method in class org.springframework.ai.chat.messages.AssistantMessage
hasToolCalls() - Method in class org.springframework.ai.chat.model.ChatResponse: Whether the model has requested the execution of a tool.
hate(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
hate(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
hateThreatening(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
hateThreatening(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
health(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
health(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
height(Integer) - Method in class org.springframework.ai.image.ImageOptionsBuilder
HUGGINGFACE - Static variable in class org.springframework.ai.model.SpringAIModels

I

id() - Method in record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall: Returns the value of the id record component.
id() - Method in record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse: Returns the value of the id record component.
id(String) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
id(String) - Method in class org.springframework.ai.moderation.Moderation.Builder
Image - Class in org.springframework.ai.image
Image(String, String) - Constructor for class org.springframework.ai.image.Image
IMAGE - Enum constant in enum class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityType
IMAGE_MODEL - Static variable in class org.springframework.ai.model.SpringAIModelProperties
IMAGE_MODEL_OPERATION - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation
ImageGeneration - Class in org.springframework.ai.image
ImageGeneration(Image) - Constructor for class org.springframework.ai.image.ImageGeneration
ImageGeneration(Image, ImageGenerationMetadata) - Constructor for class org.springframework.ai.image.ImageGeneration
ImageGenerationMetadata - Interface in org.springframework.ai.image
ImageMessage - Class in org.springframework.ai.image
ImageMessage(String) - Constructor for class org.springframework.ai.image.ImageMessage
ImageMessage(String, Float) - Constructor for class org.springframework.ai.image.ImageMessage
ImageModel - Interface in org.springframework.ai.image
ImageModelObservationContext - Class in org.springframework.ai.image.observation: Context used to store metadata for image model exchanges.
ImageModelObservationContext.Builder - Class in org.springframework.ai.image.observation
ImageModelObservationConvention - Interface in org.springframework.ai.image.observation: Interface for an ObservationConvention for image model exchanges.
ImageModelObservationDocumentation - Enum Class in org.springframework.ai.image.observation: Documented conventions for image model observations.
ImageModelObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.ai.image.observation: High-cardinality observation key names for image model operations.
ImageModelObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.ai.image.observation: Low-cardinality observation key names for image model operations.
ImageModelPromptContentObservationHandler - Class in org.springframework.ai.image.observation: Handler for emitting image prompt content to logs.
ImageModelPromptContentObservationHandler() - Constructor for class org.springframework.ai.image.observation.ImageModelPromptContentObservationHandler
ImageOptions - Interface in org.springframework.ai.image: ImageOptions represent the common options, portable across different image generation models.
ImageOptionsBuilder - Class in org.springframework.ai.image
imagePrompt(ImagePrompt) - Method in class org.springframework.ai.image.observation.ImageModelObservationContext.Builder
ImagePrompt - Class in org.springframework.ai.image
ImagePrompt(String) - Constructor for class org.springframework.ai.image.ImagePrompt
ImagePrompt(String, ImageOptions) - Constructor for class org.springframework.ai.image.ImagePrompt
ImagePrompt(List) - Constructor for class org.springframework.ai.image.ImagePrompt
ImagePrompt(List, ImageOptions) - Constructor for class org.springframework.ai.image.ImagePrompt
ImagePrompt(ImageMessage, ImageOptions) - Constructor for class org.springframework.ai.image.ImagePrompt
ImageResponse - Class in org.springframework.ai.image: The image completion (e.g. imageGeneration) response returned by an AI provider.
ImageResponse(List) - Constructor for class org.springframework.ai.image.ImageResponse: Construct a new ImageResponse instance without metadata.
ImageResponse(List, ImageResponseMetadata) - Constructor for class org.springframework.ai.image.ImageResponse: Construct a new ImageResponse instance.
ImageResponseMetadata - Class in org.springframework.ai.image: Represents metadata associated with an image response.
ImageResponseMetadata() - Constructor for class org.springframework.ai.image.ImageResponseMetadata
ImageResponseMetadata(Long) - Constructor for class org.springframework.ai.image.ImageResponseMetadata
InMemoryChatMemoryRepository - Class in org.springframework.ai.chat.memory: An in-memory implementation of ChatMemoryRepository.
InMemoryChatMemoryRepository() - Constructor for class org.springframework.ai.chat.memory.InMemoryChatMemoryRepository
inputSchema() - Method in record class org.springframework.ai.tool.definition.DefaultToolDefinition: Returns the value of the inputSchema record component.
inputSchema() - Method in interface org.springframework.ai.tool.definition.ToolDefinition: The schema of the parameters used to call the tool.
inputSchema(String) - Method in class org.springframework.ai.tool.definition.DefaultToolDefinition.Builder
inputSchema(String) - Method in class org.springframework.ai.tool.function.FunctionToolCallback.Builder
inputType(Type) - Method in class org.springframework.ai.tool.function.FunctionToolCallback.Builder
inputType(ParameterizedTypeReference) - Method in class org.springframework.ai.tool.function.FunctionToolCallback.Builder
internalToolExecutionEnabled(Boolean) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
internalToolExecutionEnabled(Boolean) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder: Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
isDangerousAndCriminalContent() - Method in class org.springframework.ai.moderation.Categories
isEmpty() - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata
isEmpty() - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
isEmpty() - Method in class org.springframework.ai.model.AbstractResponseMetadata
isEmpty() - Method in class org.springframework.ai.model.MutableResponseMetadata
isEmpty() - Method in interface org.springframework.ai.model.ResponseMetadata: Returns true if this map contains no key-value mappings.
isEmpty(Usage) - Static method in class org.springframework.ai.support.UsageCalculator: Check if the Usage is empty.
isFinancial() - Method in class org.springframework.ai.moderation.Categories
isFlagged() - Method in class org.springframework.ai.moderation.ModerationResult
isHarassment() - Method in class org.springframework.ai.moderation.Categories
isHarassmentThreatening() - Method in class org.springframework.ai.moderation.Categories
isHate() - Method in class org.springframework.ai.moderation.Categories
isHateThreatening() - Method in class org.springframework.ai.moderation.Categories
isHealth() - Method in class org.springframework.ai.moderation.Categories
isInternalToolExecutionEnabled(ChatOptions) - Static method in interface org.springframework.ai.model.tool.ToolCallingChatOptions
isInternalToolExecutionEnabled(ChatOptions) - Method in interface org.springframework.ai.model.tool.ToolExecutionEligibilityChecker: Determines if tool execution should be performed by the Spring AI or by the client.
isLaw() - Method in class org.springframework.ai.moderation.Categories
isPii() - Method in class org.springframework.ai.moderation.Categories
isSelfHarm() - Method in class org.springframework.ai.moderation.Categories
isSelfHarmInstructions() - Method in class org.springframework.ai.moderation.Categories
isSelfHarmIntent() - Method in class org.springframework.ai.moderation.Categories
isSexual() - Method in class org.springframework.ai.moderation.Categories
isSexualMinors() - Method in class org.springframework.ai.moderation.Categories
isToolCallResponse(ChatResponse) - Method in interface org.springframework.ai.model.tool.ToolExecutionEligibilityChecker: Determines if the response is a tool call message response.
isToolExecutionRequired(ChatOptions, ChatResponse) - Method in interface org.springframework.ai.model.tool.ToolExecutionEligibilityChecker: Determines if tool execution should be performed based on the prompt options and chat response.
isToolExecutionRequired(ChatOptions, ChatResponse) - Method in interface org.springframework.ai.model.tool.ToolExecutionEligibilityPredicate: Determines if tool execution should be performed based on the prompt options and chat response.
isViolence() - Method in class org.springframework.ai.moderation.Categories
isViolenceGraphic() - Method in class org.springframework.ai.moderation.Categories

J

JSON_SCHEMA - Enum constant in enum class org.springframework.ai.util.json.schema.SchemaType: JSON schema.
JsonParser - Class in org.springframework.ai.util.json: Utilities to perform parsing operations between JSON and Java.
JsonSchemaGenerator - Class in org.springframework.ai.util.json.schema: Utilities to generate JSON Schemas from Java types and method signatures.
JsonSchemaGenerator.SchemaOption - Enum Class in org.springframework.ai.util.json.schema: Options for generating JSON Schemas.
JsonSchemaUtils - Class in org.springframework.ai.util.json.schema: Utility methods for working with JSON schemas.
jsonToMap(String) - Static method in class org.springframework.ai.model.ModelOptionsUtils: Converts the given JSON string to a Map of String and Object using the default ObjectMapper.
jsonToMap(String, ObjectMapper) - Static method in class org.springframework.ai.model.ModelOptionsUtils: Converts the given JSON string to a Map of String and Object using a custom ObjectMapper.
jsonToObject(String, Class) - Static method in class org.springframework.ai.model.ModelOptionsUtils: Converts the given JSON string to an Object of the given type.

K

keySet() - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata
keySet() - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
keySet() - Method in class org.springframework.ai.model.AbstractResponseMetadata
keySet() - Method in class org.springframework.ai.model.MutableResponseMetadata
keySet() - Method in interface org.springframework.ai.model.ResponseMetadata
keyValue(String, Object) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
keywordCount(int) - Method in class org.springframework.ai.model.transformer.KeywordMetadataEnricher.Builder
KeywordMetadataEnricher - Class in org.springframework.ai.model.transformer: Keyword extractor that uses generative to extract 'excerpt_keywords' metadata field.
KeywordMetadataEnricher(ChatModel, int) - Constructor for class org.springframework.ai.model.transformer.KeywordMetadataEnricher: Create a new KeywordMetadataEnricher instance.
KeywordMetadataEnricher(ChatModel, PromptTemplate) - Constructor for class org.springframework.ai.model.transformer.KeywordMetadataEnricher: Create a new KeywordMetadataEnricher instance.
KeywordMetadataEnricher.Builder - Class in org.springframework.ai.model.transformer
KEYWORDS_TEMPLATE - Static variable in class org.springframework.ai.model.transformer.KeywordMetadataEnricher
keywordsTemplate(PromptTemplate) - Method in class org.springframework.ai.model.transformer.KeywordMetadataEnricher.Builder
KnuddelsRuntimeHints - Class in org.springframework.ai.aot
KnuddelsRuntimeHints() - Constructor for class org.springframework.ai.aot.KnuddelsRuntimeHints
KotlinModule - Class in org.springframework.ai.model
KotlinModule() - Constructor for class org.springframework.ai.model.KotlinModule

L

law(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
law(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
ListOutputConverter - Class in org.springframework.ai.converter: StructuredOutputConverter implementation that uses a DefaultConversionService to convert the LLM output into a List instance.
ListOutputConverter() - Constructor for class org.springframework.ai.converter.ListOutputConverter
ListOutputConverter(DefaultConversionService) - Constructor for class org.springframework.ai.converter.ListOutputConverter
logger - Static variable in interface org.springframework.ai.tool.ToolCallback

M

map - Variable in class org.springframework.ai.model.AbstractResponseMetadata: Metadata map.
map(Observation.Context) - Method in class org.springframework.ai.tool.observation.ToolCallingContentObservationFilter
MapOutputConverter - Class in org.springframework.ai.converter: StructuredOutputConverter implementation that uses a pre-configured MappingJackson2MessageConverter to convert the LLM output into a java.util.Map<String, Object> instance.
MapOutputConverter() - Constructor for class org.springframework.ai.converter.MapOutputConverter
mapToClass(Map, Class) - Static method in class org.springframework.ai.model.ModelOptionsUtils: Converts the given Map to the given class.
MarkdownCodeBlockCleaner - Class in org.springframework.ai.converter: A ResponseTextCleaner that removes markdown code block formatting from LLM responses.
MarkdownCodeBlockCleaner() - Constructor for class org.springframework.ai.converter.MarkdownCodeBlockCleaner
maxMessages(int) - Method in class org.springframework.ai.chat.memory.MessageWindowChatMemory.Builder
maxTokens(Integer) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
maxTokens(Integer) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
maxTokens(Integer) - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder: Builds with the maximum number of tokens to use for the chat.
maxTokens(Integer) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
media - Variable in class org.springframework.ai.chat.messages.AssistantMessage
media - Variable in class org.springframework.ai.chat.messages.UserMessage
media(List) - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder
media(List) - Method in class org.springframework.ai.chat.messages.UserMessage.Builder
media(Media...) - Method in class org.springframework.ai.chat.messages.UserMessage.Builder
merge(Object, Object, Class, List) - Static method in class org.springframework.ai.model.ModelOptionsUtils: Merges the source object into the target object and returns an object represented by the given class.
merge(Object, Object, Class) - Static method in class org.springframework.ai.model.ModelOptionsUtils: Merges the source object into the target object and returns an object represented by the given class.
mergeBeans(S, T, Class, boolean) - Static method in class org.springframework.ai.model.ModelOptionsUtils: Merges the source object into the target object.
mergeOption(T, T) - Static method in class org.springframework.ai.model.ModelOptionsUtils: Return the runtime value if not empty, or else the default value.
mergeToolCallbacks(List, List) - Static method in interface org.springframework.ai.model.tool.ToolCallingChatOptions
mergeToolContext(Map, Map) - Static method in interface org.springframework.ai.model.tool.ToolCallingChatOptions
mergeToolNames(Set, Set) - Static method in interface org.springframework.ai.model.tool.ToolCallingChatOptions
Message - Interface in org.springframework.ai.chat.messages: The Message interface represents a message that can be sent or received in a chat application.
MESSAGE_TYPE - Static variable in class org.springframework.ai.chat.messages.AbstractMessage: The key for the message type in the metadata.
MessageAggregator - Class in org.springframework.ai.chat.model: Helper that for streaming chat responses, aggregate the chat response messages into a single AssistantMessage.
MessageAggregator() - Constructor for class org.springframework.ai.chat.model.MessageAggregator
MessageAggregator.DefaultUsage - Record Class in org.springframework.ai.chat.model
messages(List) - Method in class org.springframework.ai.chat.prompt.Prompt.Builder
messages(Message...) - Method in class org.springframework.ai.chat.prompt.Prompt.Builder
messageType - Variable in class org.springframework.ai.chat.messages.AbstractMessage: The message type of the message.
MessageType - Enum Class in org.springframework.ai.chat.messages: Enumeration representing types of Messages in a chat application.
MessageWindowChatMemory - Class in org.springframework.ai.chat.memory: A chat memory implementation that maintains a message window of a specified size, ensuring that the total number of messages does not exceed the specified limit.
MessageWindowChatMemory.Builder - Class in org.springframework.ai.chat.memory
metadata - Variable in class org.springframework.ai.chat.messages.AbstractMessage: Additional options for the message to influence the response, not a generative map.
metadata(String, Object) - Method in class org.springframework.ai.chat.model.ChatResponse.Builder
metadata(String, T) - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata.Builder: Add metadata to the Generation result.
metadata(String, T) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadataBuilder
metadata(Map) - Method in class org.springframework.ai.chat.messages.SystemMessage.Builder
metadata(Map) - Method in class org.springframework.ai.chat.messages.ToolResponseMessage.Builder
metadata(Map) - Method in class org.springframework.ai.chat.messages.UserMessage.Builder
metadata(Map) - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata.Builder: Add metadata to the Generation result.
metadata(Map) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
metadata(Map) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadataBuilder
metadata(ChatResponseMetadata) - Method in class org.springframework.ai.chat.model.ChatResponse.Builder
METADATA_TOOL_ID - Static variable in interface org.springframework.ai.model.tool.ToolExecutionResult
METADATA_TOOL_NAME - Static variable in interface org.springframework.ai.model.tool.ToolExecutionResult
MethodToolCallback - Class in org.springframework.ai.tool.method: A ToolCallback implementation to invoke methods as tools.
MethodToolCallback(ToolDefinition, ToolMetadata, Method, Object, ToolCallResultConverter) - Constructor for class org.springframework.ai.tool.method.MethodToolCallback
MethodToolCallback.Builder - Class in org.springframework.ai.tool.method
MethodToolCallbackProvider - Class in org.springframework.ai.tool.method: A ToolCallbackProvider that builds ToolCallback instances from Tool-annotated methods.
MethodToolCallbackProvider.Builder - Class in org.springframework.ai.tool.method
MINIMAX - Static variable in class org.springframework.ai.model.SpringAIModels
MISTRAL - Static variable in class org.springframework.ai.model.SpringAIModels
ModalityUtils() - Constructor for class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityUtils
model(String) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
model(String) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
model(String) - Method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions.Builder
model(String) - Method in interface org.springframework.ai.audio.tts.TextToSpeechOptions.Builder: Sets the model to use for text-to-speech.
model(String) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
model(String) - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder: Builds with the model to use for the chat.
model(String) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
model(String) - Method in class org.springframework.ai.embedding.DefaultEmbeddingOptionsBuilder
model(String) - Method in interface org.springframework.ai.embedding.EmbeddingOptions.Builder
model(String) - Method in class org.springframework.ai.image.ImageOptionsBuilder
model(String) - Method in class org.springframework.ai.moderation.Moderation.Builder
model(String) - Method in class org.springframework.ai.moderation.ModerationOptionsBuilder
Model<TReq,TRes> - Interface in org.springframework.ai.model: The Model interface provides a generic API for invoking AI models.
MODEL_PREFIX - Static variable in class org.springframework.ai.model.SpringAIModelProperties
ModelDescription - Interface in org.springframework.ai.model: Describes an AI model's basic characteristics.
ModelObservationContext<REQ,RES> - Class in org.springframework.ai.model.observation: Context used when sending a request to a machine learning model and waiting for a response from the model provider.
ModelObservationContext(REQ, AiOperationMetadata) - Constructor for class org.springframework.ai.model.observation.ModelObservationContext
ModelOptions - Interface in org.springframework.ai.model: Interface representing the customizable options for AI model interactions.
ModelOptionsUtils - Class in org.springframework.ai.model: Utility class for manipulating ModelOptions objects.
ModelOptionsUtils() - Constructor for class org.springframework.ai.model.ModelOptionsUtils
ModelRequest<T> - Interface in org.springframework.ai.model: Interface representing a request to an AI model.
ModelResponse<T> - Interface in org.springframework.ai.model: Interface representing the response received from an AI model.
ModelResult<T> - Interface in org.springframework.ai.model: This interface provides methods to access the main output of the AI model and the metadata associated with this result.
ModelUsageMetricsGenerator - Class in org.springframework.ai.model.observation: Generate metrics about the model usage in the context of an AI operation.
Moderation - Class in org.springframework.ai.moderation: The Moderation class represents the result of a moderation process.
MODERATION_MODEL - Static variable in class org.springframework.ai.model.SpringAIModelProperties
Moderation.Builder - Class in org.springframework.ai.moderation
ModerationGenerationMetadata - Interface in org.springframework.ai.moderation: An interface that represents metadata associated with the results of a moderation generation process.
ModerationMessage - Class in org.springframework.ai.moderation: Represents a single message intended for moderation, encapsulating the text content.
ModerationMessage(String) - Constructor for class org.springframework.ai.moderation.ModerationMessage
ModerationModel - Interface in org.springframework.ai.moderation: The ModerationModel interface defines a generic AI model for moderation.
ModerationOptions - Interface in org.springframework.ai.moderation: Represents the options for moderation.
ModerationOptionsBuilder - Class in org.springframework.ai.moderation: A builder class for creating instances of ModerationOptions.
ModerationPrompt - Class in org.springframework.ai.moderation: Represents a prompt for moderation containing a single message and the options for the moderation model.
ModerationPrompt(String) - Constructor for class org.springframework.ai.moderation.ModerationPrompt
ModerationPrompt(String, ModerationOptions) - Constructor for class org.springframework.ai.moderation.ModerationPrompt
ModerationPrompt(ModerationMessage, ModerationOptions) - Constructor for class org.springframework.ai.moderation.ModerationPrompt
ModerationResponse - Class in org.springframework.ai.moderation: Represents a response from a moderation process, encapsulating the moderation metadata and the generated content.
ModerationResponse(Generation) - Constructor for class org.springframework.ai.moderation.ModerationResponse
ModerationResponse(Generation, ModerationResponseMetadata) - Constructor for class org.springframework.ai.moderation.ModerationResponse
ModerationResponseMetadata - Class in org.springframework.ai.moderation: Defines the metadata associated with a moderation response, extending a base response interface.
ModerationResponseMetadata() - Constructor for class org.springframework.ai.moderation.ModerationResponseMetadata
ModerationResult - Class in org.springframework.ai.moderation: Represents the result of a moderation process, indicating whether content was flagged, the categories of moderation, and detailed scores for each category.
ModerationResult.Builder - Class in org.springframework.ai.moderation
MULTI_MODAL_EMBEDDING_MODEL - Static variable in class org.springframework.ai.model.SpringAIModelProperties
MutableResponseMetadata - Class in org.springframework.ai.model
MutableResponseMetadata() - Constructor for class org.springframework.ai.model.MutableResponseMetadata
mutate() - Method in class org.springframework.ai.chat.messages.SystemMessage
mutate() - Method in class org.springframework.ai.chat.messages.UserMessage
mutate() - Method in class org.springframework.ai.chat.prompt.Prompt
mutate() - Method in class org.springframework.ai.chat.prompt.PromptTemplate

N

N(Integer) - Method in class org.springframework.ai.image.ImageOptionsBuilder
name() - Method in record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall: Returns the value of the name record component.
name() - Method in record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse: Returns the value of the name record component.
name() - Element in annotation interface org.springframework.ai.tool.annotation.Tool: The name of the tool.
name() - Method in record class org.springframework.ai.tool.augment.ToolInputSchemaAugmenter.AugmentedArgumentType: Returns the value of the name record component.
name() - Method in record class org.springframework.ai.tool.definition.DefaultToolDefinition: Returns the value of the name record component.
name() - Method in interface org.springframework.ai.tool.definition.ToolDefinition: The tool name.
name(String) - Method in class org.springframework.ai.tool.definition.DefaultToolDefinition.Builder
NEXT - Enum constant in enum class org.springframework.ai.model.transformer.SummaryMetadataEnricher.SummaryType
NoopApiKey - Class in org.springframework.ai.model: This implementation of ApiKey indicates that no API key should be used, e.g. no HTTP headers should be set.
NoopApiKey() - Constructor for class org.springframework.ai.model.NoopApiKey
NULL - Static variable in interface org.springframework.ai.audio.transcription.AudioTranscriptionMetadata
NULL - Static variable in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata

O

OBJECT_MAPPER - Static variable in class org.springframework.ai.model.ModelOptionsUtils
objectToMap(Object) - Static method in class org.springframework.ai.model.ModelOptionsUtils: Converts the given object to a Map.
observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder
OCI_GENAI - Static variable in class org.springframework.ai.model.SpringAIModels
of(Iterable) - Static method in interface org.springframework.ai.chat.metadata.PromptMetadata: Factory method used to create a new PromptMetadata composed of an Iterable of PromptMetadata.PromptFilterMetadata.
of(PromptMetadata.PromptFilterMetadata...) - Static method in interface org.springframework.ai.chat.metadata.PromptMetadata: Factory method used to create a new PromptMetadata composed of an array of PromptMetadata.PromptFilterMetadata.
OLLAMA - Static variable in class org.springframework.ai.model.SpringAIModels
onError(Observation.Context) - Method in class org.springframework.ai.model.observation.ErrorLoggingObservationHandler
onStop(ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.ChatModelCompletionObservationHandler
onStop(ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.ChatModelMeterObservationHandler
onStop(ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.ChatModelPromptContentObservationHandler
onStop(EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.EmbeddingModelMeterObservationHandler
onStop(ImageModelObservationContext) - Method in class org.springframework.ai.image.observation.ImageModelPromptContentObservationHandler
OPEN_API_SCHEMA - Enum constant in enum class org.springframework.ai.util.json.schema.SchemaType: Open API schema.
OPENAI - Static variable in class org.springframework.ai.model.SpringAIModels
OPENAI_SDK - Static variable in class org.springframework.ai.model.SpringAIModels
options - Variable in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
org.springframework.ai.aot - package org.springframework.ai.aot
org.springframework.ai.audio.transcription - package org.springframework.ai.audio.transcription
org.springframework.ai.audio.tts - package org.springframework.ai.audio.tts
org.springframework.ai.chat.memory - package org.springframework.ai.chat.memory
org.springframework.ai.chat.messages - package org.springframework.ai.chat.messages
org.springframework.ai.chat.metadata - package org.springframework.ai.chat.metadata
org.springframework.ai.chat.model - package org.springframework.ai.chat.model
org.springframework.ai.chat.observation - package org.springframework.ai.chat.observation: Provides the API for chat observations.
org.springframework.ai.chat.prompt - package org.springframework.ai.chat.prompt
org.springframework.ai.converter - package org.springframework.ai.converter: Provides converters for transforming AI model text outputs into structured Java types.
org.springframework.ai.embedding - package org.springframework.ai.embedding: Provides the API for embedding observations.
org.springframework.ai.embedding.observation - package org.springframework.ai.embedding.observation: Provides the API for embedding observations.
org.springframework.ai.image - package org.springframework.ai.image
org.springframework.ai.image.observation - package org.springframework.ai.image.observation: Provides classes for observing image data.
org.springframework.ai.model - package org.springframework.ai.model: Provides a set of interfaces and classes for a generic API designed to interact with various AI models.
org.springframework.ai.model.observation - package org.springframework.ai.model.observation: Provides classes for observing model data.
org.springframework.ai.model.tool - package org.springframework.ai.model.tool
org.springframework.ai.model.tool.internal - package org.springframework.ai.model.tool.internal
org.springframework.ai.model.transformer - package org.springframework.ai.model.transformer
org.springframework.ai.moderation - package org.springframework.ai.moderation
org.springframework.ai.support - package org.springframework.ai.support
org.springframework.ai.tool - package org.springframework.ai.tool
org.springframework.ai.tool.annotation - package org.springframework.ai.tool.annotation
org.springframework.ai.tool.augment - package org.springframework.ai.tool.augment
org.springframework.ai.tool.definition - package org.springframework.ai.tool.definition
org.springframework.ai.tool.execution - package org.springframework.ai.tool.execution
org.springframework.ai.tool.function - package org.springframework.ai.tool.function
org.springframework.ai.tool.metadata - package org.springframework.ai.tool.metadata
org.springframework.ai.tool.method - package org.springframework.ai.tool.method
org.springframework.ai.tool.observation - package org.springframework.ai.tool.observation: Provides the API for chat client advisors observations.
org.springframework.ai.tool.resolution - package org.springframework.ai.tool.resolution
org.springframework.ai.tool.support - package org.springframework.ai.tool.support
org.springframework.ai.util.json - package org.springframework.ai.util.json
org.springframework.ai.util.json.schema - package org.springframework.ai.util.json.schema

P

pii(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
pii(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
POSTGRESML - Static variable in class org.springframework.ai.model.SpringAIModels
postProcessSchema(JsonNode) - Method in class org.springframework.ai.converter.BeanOutputConverter: Empty template method that allows for customization of the JSON schema in subclasses.
presencePenalty(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
presencePenalty(Double) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
presencePenalty(Double) - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder: Builds with the presence penalty to use for the chat.
presencePenalty(Double) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
PREVIOUS - Enum constant in enum class org.springframework.ai.model.transformer.SummaryMetadataEnricher.SummaryType
process(ToolExecutionException) - Method in class org.springframework.ai.tool.execution.DefaultToolExecutionExceptionProcessor
process(ToolExecutionException) - Method in interface org.springframework.ai.tool.execution.ToolExecutionExceptionProcessor: Convert an exception thrown by a tool to a String that can be sent back to the AI model or throw an exception to be handled by the caller.
prompt(Prompt) - Method in class org.springframework.ai.chat.observation.ChatModelObservationContext.Builder
Prompt - Class in org.springframework.ai.chat.prompt: The Prompt class represents a prompt used in AI model requests.
Prompt(String) - Constructor for class org.springframework.ai.chat.prompt.Prompt
Prompt(String, ChatOptions) - Constructor for class org.springframework.ai.chat.prompt.Prompt
Prompt(List) - Constructor for class org.springframework.ai.chat.prompt.Prompt
Prompt(List, ChatOptions) - Constructor for class org.springframework.ai.chat.prompt.Prompt
Prompt(Message) - Constructor for class org.springframework.ai.chat.prompt.Prompt
Prompt(Message...) - Constructor for class org.springframework.ai.chat.prompt.Prompt
Prompt(Message, ChatOptions) - Constructor for class org.springframework.ai.chat.prompt.Prompt
Prompt.Builder - Class in org.springframework.ai.chat.prompt
promptMetadata(PromptMetadata) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
PromptMetadata - Interface in org.springframework.ai.chat.metadata: Abstract Data Type (ADT) modeling metadata gathered by the AI during request processing.
PromptMetadata.PromptFilterMetadata - Interface in org.springframework.ai.chat.metadata: Abstract Data Type (ADT) modeling filter metadata for all prompts sent during an AI request.
PromptTemplate - Class in org.springframework.ai.chat.prompt: A template for creating prompts.
PromptTemplate(String) - Constructor for class org.springframework.ai.chat.prompt.PromptTemplate
PromptTemplate(Resource) - Constructor for class org.springframework.ai.chat.prompt.PromptTemplate
PromptTemplate.Builder - Class in org.springframework.ai.chat.prompt
PromptTemplateActions - Interface in org.springframework.ai.chat.prompt
PromptTemplateChatActions - Interface in org.springframework.ai.chat.prompt
PromptTemplateMessageActions - Interface in org.springframework.ai.chat.prompt
PromptTemplateStringActions - Interface in org.springframework.ai.chat.prompt
promptTokens() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage: Returns the value of the promptTokens record component.
properties(Map) - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder
PROPERTY_REQUIRED_FALSE_BY_DEFAULT - Enum constant in enum class org.springframework.ai.util.json.schema.SpringAiSchemaModule.Option: Properties are only required if marked as such via one of the supported annotations.
provider(String) - Method in class org.springframework.ai.chat.observation.ChatModelObservationContext.Builder
provider(String) - Method in class org.springframework.ai.embedding.observation.EmbeddingModelObservationContext.Builder
provider(String) - Method in class org.springframework.ai.image.observation.ImageModelObservationContext.Builder
put(String, T) - Method in class org.springframework.ai.model.MutableResponseMetadata: Puts an element to the context.

R

rateLimit(RateLimit) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
RateLimit - Interface in org.springframework.ai.chat.metadata: Abstract Data Type (ADT) encapsulating metadata from an AI provider's API rate limits granted to the API key in use and the API key's current balance.
rawInput() - Method in record class org.springframework.ai.tool.augment.AugmentedArgumentEvent: Returns the value of the rawInput record component.
registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.aot.KnuddelsRuntimeHints
registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.aot.SpringAiCoreRuntimeHints
registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.aot.ToolRuntimeHints
remove(Object) - Method in class org.springframework.ai.model.MutableResponseMetadata: Removes an entry from the context.
removeExtraArgumentsAfterProcessing(boolean) - Method in class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider.Builder: Sets whether to remove extra arguments after processing
render() - Method in class org.springframework.ai.chat.prompt.ChatPromptTemplate
render() - Method in class org.springframework.ai.chat.prompt.PromptTemplate
render() - Method in interface org.springframework.ai.chat.prompt.PromptTemplateStringActions
render(Map) - Method in class org.springframework.ai.chat.prompt.ChatPromptTemplate
render(Map) - Method in class org.springframework.ai.chat.prompt.PromptTemplate
render(Map) - Method in interface org.springframework.ai.chat.prompt.PromptTemplateStringActions
renderer - Variable in class org.springframework.ai.chat.prompt.PromptTemplate.Builder
renderer(TemplateRenderer) - Method in class org.springframework.ai.chat.prompt.PromptTemplate.Builder
renderer(TemplateRenderer) - Method in class org.springframework.ai.chat.prompt.SystemPromptTemplate.Builder
REQUEST_EMBEDDING_DIMENSIONS - Enum constant in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation.HighCardinalityKeyNames: The number of dimensions the resulting output embeddings have.
REQUEST_FREQUENCY_PENALTY - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: The frequency penalty setting for the model request.
REQUEST_IMAGE_RESPONSE_FORMAT - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames: The format in which the generated image is returned.
REQUEST_IMAGE_SIZE - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames: The size of the image to generate.
REQUEST_IMAGE_STYLE - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames: The style of the image to generate.
REQUEST_MAX_TOKENS - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: The maximum number of tokens the model generates for a request.
REQUEST_MODEL - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.LowCardinalityKeyNames: The name of the model a request is being made to.
REQUEST_MODEL - Enum constant in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation.LowCardinalityKeyNames: The name of the model a request is being made to.
REQUEST_MODEL - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.LowCardinalityKeyNames: The name of the model a request is being made to.
REQUEST_PRESENCE_PENALTY - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: The presence penalty setting for the model request.
REQUEST_STOP_SEQUENCES - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: List of sequences that the model will use to stop generating further tokens.
REQUEST_TEMPERATURE - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: The temperature setting for the model request.
REQUEST_TOOL_NAMES - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: List of tool definitions provided to the model in the request.
REQUEST_TOP_K - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: The top_k sampling setting for the model request.
REQUEST_TOP_P - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: The top_p sampling setting for the model request.
requestEmbeddingDimension(KeyValues, EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
requestFrequencyPenalty(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
requestImageFormat(KeyValues, ImageModelObservationContext) - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
requestImageSize(KeyValues, ImageModelObservationContext) - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
requestImageStyle(KeyValues, ImageModelObservationContext) - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
requestMaxTokens(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
requestModel(ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
requestModel(EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
requestModel(ImageModelObservationContext) - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
requestPresencePenalty(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
requestStopSequences(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
requestTemperature(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
requestTools(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
requestTopK(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
requestTopP(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
required() - Element in annotation interface org.springframework.ai.tool.annotation.ToolParam: Whether the tool argument is required.
required() - Method in record class org.springframework.ai.tool.augment.ToolInputSchemaAugmenter.AugmentedArgumentType: Returns the value of the required record component.
resolve(String) - Method in class org.springframework.ai.tool.resolution.DelegatingToolCallbackResolver
resolve(String) - Method in class org.springframework.ai.tool.resolution.SpringBeanToolCallbackResolver
resolve(String) - Method in class org.springframework.ai.tool.resolution.StaticToolCallbackResolver
resolve(String) - Method in interface org.springframework.ai.tool.resolution.ToolCallbackResolver: Resolve the ToolCallback for the given tool name.
resolveBeanType(GenericApplicationContext, String) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper: Resolve bean type, either directly with BeanDefinition.getResolvableType() or by resolving the factory method (duplicating ConstructorResolver#resolveFactoryMethodIfPossible logic as it is not public).
resolveToolDefinitions(ToolCallingChatOptions) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager
resolveToolDefinitions(ToolCallingChatOptions) - Method in interface org.springframework.ai.model.tool.ToolCallingManager: Resolve the tool definitions from the model's tool calling options.
resource - Variable in class org.springframework.ai.chat.prompt.PromptTemplate.Builder
resource(Resource) - Method in class org.springframework.ai.chat.prompt.PromptTemplate.Builder
resource(Resource) - Method in class org.springframework.ai.chat.prompt.SystemPromptTemplate.Builder
RESPONSE_FINISH_REASONS - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: Reasons the model stopped generating tokens, corresponding to each generation received.
RESPONSE_ID - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: The unique identifier for the AI response.
RESPONSE_ID - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames: The unique identifier for the AI response.
RESPONSE_MODEL - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.LowCardinalityKeyNames: The name of the model that generated the response.
RESPONSE_MODEL - Enum constant in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation.LowCardinalityKeyNames: The name of the model that generated the response.
RESPONSE_MODEL - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames: The name of the model that generated the response.
responseData() - Method in record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse: Returns the value of the responseData record component.
responseFinishReasons(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
responseFormat(String) - Method in class org.springframework.ai.image.ImageOptionsBuilder
responseId(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
ResponseMetadata - Interface in org.springframework.ai.model: Interface representing metadata associated with an AI model's response.
responseModel(ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
responseModel(EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
responses - Variable in class org.springframework.ai.chat.messages.ToolResponseMessage
responses(List) - Method in class org.springframework.ai.chat.messages.ToolResponseMessage.Builder
ResponseTextCleaner - Interface in org.springframework.ai.converter: Strategy interface for cleaning LLM response text before parsing.
resultConverter() - Element in annotation interface org.springframework.ai.tool.annotation.Tool: The class to use to convert the tool call result to a String.
ResultMetadata - Interface in org.springframework.ai.model: Interface representing metadata associated with the results of an AI model.
results(List) - Method in class org.springframework.ai.moderation.Moderation.Builder
rethrowExceptions(List) - Method in class org.springframework.ai.tool.execution.DefaultToolExecutionExceptionProcessor.Builder: An allowlist of exceptions thrown by tools, which will be unwrapped and re-thrown without further processing.
returnDirect() - Method in record class org.springframework.ai.model.tool.DefaultToolExecutionResult: Returns the value of the returnDirect record component.
returnDirect() - Method in interface org.springframework.ai.model.tool.ToolExecutionResult: Whether the tool execution result should be returned directly or passed back to the model.
returnDirect() - Element in annotation interface org.springframework.ai.tool.annotation.Tool: Whether the tool result should be returned directly or passed back to the model.
returnDirect() - Method in record class org.springframework.ai.tool.metadata.DefaultToolMetadata: Returns the value of the returnDirect record component.
returnDirect() - Method in interface org.springframework.ai.tool.metadata.ToolMetadata: Whether the tool result should be returned directly or passed back to the model.
returnDirect(boolean) - Method in class org.springframework.ai.model.tool.DefaultToolExecutionResult.Builder
returnDirect(boolean) - Method in class org.springframework.ai.tool.metadata.DefaultToolMetadata.Builder

S

saveAll(String, List) - Method in interface org.springframework.ai.chat.memory.ChatMemoryRepository: Replaces all the existing messages for the given conversation ID with the provided messages.
saveAll(String, List) - Method in class org.springframework.ai.chat.memory.InMemoryChatMemoryRepository
schemaType(SchemaType) - Method in class org.springframework.ai.tool.resolution.SpringBeanToolCallbackResolver.Builder
SchemaType - Enum Class in org.springframework.ai.util.json.schema: The type of schema to generate for a given Java type.
selfHarm(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
selfHarm(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
selfHarmInstructions(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
selfHarmInstructions(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
selfHarmIntent(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
selfHarmIntent(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
setB64Json(String) - Method in class org.springframework.ai.image.Image
setCategories(Categories) - Method in class org.springframework.ai.moderation.ModerationResult
setCategoryScores(CategoryScores) - Method in class org.springframework.ai.moderation.ModerationResult
setContext(ContextView) - Static method in class org.springframework.ai.model.tool.internal.ToolCallReactiveContextHolder
setDimensions(Integer) - Method in class org.springframework.ai.embedding.DefaultEmbeddingOptions
setFlagged(boolean) - Method in class org.springframework.ai.moderation.ModerationResult
setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
setFrequencyPenalty(Double) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
setInternalToolExecutionEnabled(Boolean) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
setInternalToolExecutionEnabled(Boolean) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions: Set whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
setMaxTokens(Integer) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
setMaxTokens(Integer) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
setModel(String) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
setModel(String) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
setModel(String) - Method in class org.springframework.ai.embedding.DefaultEmbeddingOptions
setModel(String) - Method in class org.springframework.ai.embedding.EmbeddingResponseMetadata
setObservationConvention(ToolCallingObservationConvention) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager
setOptions(TextToSpeechOptions) - Method in class org.springframework.ai.audio.tts.TextToSpeechPrompt
setOptions(ModerationOptions) - Method in class org.springframework.ai.moderation.ModerationPrompt
setOutputSchema(String) - Method in interface org.springframework.ai.model.tool.StructuredOutputChatOptions
setPresencePenalty(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
setPresencePenalty(Double) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
setResponse(RES) - Method in class org.springframework.ai.model.observation.ModelObservationContext
setStopSequences(List) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
setStopSequences(List) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
setTemperature(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
setTemperature(Double) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
setText(String) - Method in class org.springframework.ai.moderation.ModerationMessage
setToolCallbacks(List) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
setToolCallbacks(List) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions: Set the ToolCallbacks to be registered with the ChatModel.
setToolCallResult(String) - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext
setToolContext(Map) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
setToolContext(Map) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions: Set the tool context values as map.
setToolNames(Set) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
setToolNames(Set) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions: Set the names of the tools to register with the ChatModel.
setTopK(Integer) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
setTopK(Integer) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
setTopP(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
setTopP(Double) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
setUrl(String) - Method in class org.springframework.ai.image.Image
setUsage(Usage) - Method in class org.springframework.ai.embedding.EmbeddingResponseMetadata
sexual(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
sexual(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
sexualMinors(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
sexualMinors(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
SimpleApiKey - Record Class in org.springframework.ai.model: A simple implementation of ApiKey that holds an immutable API key value.
SimpleApiKey(String) - Constructor for record class org.springframework.ai.model.SimpleApiKey: Create a new SimpleApiKey.
Speech - Class in org.springframework.ai.audio.tts: Implementation of the ModelResult interface for the speech model.
Speech(byte[]) - Constructor for class org.springframework.ai.audio.tts.Speech
speed(Double) - Method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions.Builder
speed(Double) - Method in interface org.springframework.ai.audio.tts.TextToSpeechOptions.Builder: Sets the speed of the generated speech.
SPRING_AI_KIND - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.LowCardinalityKeyNames: Spring AI kind.
SpringAiCoreRuntimeHints - Class in org.springframework.ai.aot
SpringAiCoreRuntimeHints() - Constructor for class org.springframework.ai.aot.SpringAiCoreRuntimeHints
springAiKind(ToolCallingObservationContext) - Method in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention
SpringAIModelProperties - Class in org.springframework.ai.model
SpringAIModels - Class in org.springframework.ai.model
SpringAiSchemaModule - Class in org.springframework.ai.util.json.schema: JSON Schema Generator Module for Spring AI.
SpringAiSchemaModule(SpringAiSchemaModule.Option...) - Constructor for class org.springframework.ai.util.json.schema.SpringAiSchemaModule
SpringAiSchemaModule.Option - Enum Class in org.springframework.ai.util.json.schema: Options for customizing the behavior of the module.
SpringBeanToolCallbackResolver - Class in org.springframework.ai.tool.resolution: A Spring ApplicationContext-based implementation that provides a way to retrieve a bean from the Spring context and wrap it into a ToolCallback.
SpringBeanToolCallbackResolver(GenericApplicationContext, SchemaType) - Constructor for class org.springframework.ai.tool.resolution.SpringBeanToolCallbackResolver
SpringBeanToolCallbackResolver.Builder - Class in org.springframework.ai.tool.resolution
STABILITY_AI - Static variable in class org.springframework.ai.model.SpringAIModels
StaticToolCallbackProvider - Class in org.springframework.ai.tool: A simple implementation of ToolCallbackProvider that maintains a static array of ToolCallback objects.
StaticToolCallbackProvider(List) - Constructor for class org.springframework.ai.tool.StaticToolCallbackProvider: Constructs a new StaticToolCallbackProvider with the specified list of function callbacks.
StaticToolCallbackProvider(ToolCallback...) - Constructor for class org.springframework.ai.tool.StaticToolCallbackProvider: Constructs a new StaticToolCallbackProvider with the specified array of function callbacks.
StaticToolCallbackResolver - Class in org.springframework.ai.tool.resolution: A ToolCallbackResolver that resolves tool callbacks from a static registry.
StaticToolCallbackResolver(List) - Constructor for class org.springframework.ai.tool.resolution.StaticToolCallbackResolver
stopSequences(List) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
stopSequences(List) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
stopSequences(List) - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder: Builds with the stop sequences to use for the chat.
stopSequences(List) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
stream(String) - Method in interface org.springframework.ai.audio.tts.StreamingTextToSpeechModel
stream(String) - Method in interface org.springframework.ai.chat.model.StreamingChatModel
stream(String, TextToSpeechOptions) - Method in interface org.springframework.ai.audio.tts.StreamingTextToSpeechModel
stream(TextToSpeechPrompt) - Method in interface org.springframework.ai.audio.tts.StreamingTextToSpeechModel
stream(Message...) - Method in interface org.springframework.ai.chat.model.StreamingChatModel
stream(Prompt) - Method in interface org.springframework.ai.chat.model.ChatModel
stream(Prompt) - Method in interface org.springframework.ai.chat.model.StreamingChatModel
stream(TReq) - Method in interface org.springframework.ai.model.StreamingModel: Executes a method call to the AI model.
StreamingChatModel - Interface in org.springframework.ai.chat.model
StreamingModel<TReq, TResChunk> - Interface in org.springframework.ai.model: The StreamingModel interface provides a generic API for invoking an AI models with streaming response.
StreamingTextToSpeechModel - Interface in org.springframework.ai.audio.tts: Interface for the streaming text to speech model.
StructuredOutputChatOptions - Interface in org.springframework.ai.model.tool: Mixin interface for ChatModels that support structured output.
StructuredOutputConverter<T> - Interface in org.springframework.ai.converter: Converts the (raw) LLM output into a structured responses of type.
style(String) - Method in class org.springframework.ai.image.ImageOptionsBuilder
SummaryMetadataEnricher - Class in org.springframework.ai.model.transformer: Title extractor with adjacent sharing that uses generative to extract 'section_summary', 'prev_section_summary', 'next_section_summary' metadata fields.
SummaryMetadataEnricher(ChatModel, List) - Constructor for class org.springframework.ai.model.transformer.SummaryMetadataEnricher
SummaryMetadataEnricher(ChatModel, List, String, MetadataMode) - Constructor for class org.springframework.ai.model.transformer.SummaryMetadataEnricher
SummaryMetadataEnricher.SummaryType - Enum Class in org.springframework.ai.model.transformer
supportsContext(Observation.Context) - Method in class org.springframework.ai.chat.observation.ChatModelCompletionObservationHandler
supportsContext(Observation.Context) - Method in class org.springframework.ai.chat.observation.ChatModelMeterObservationHandler
supportsContext(Observation.Context) - Method in interface org.springframework.ai.chat.observation.ChatModelObservationConvention
supportsContext(Observation.Context) - Method in class org.springframework.ai.chat.observation.ChatModelPromptContentObservationHandler
supportsContext(Observation.Context) - Method in class org.springframework.ai.embedding.observation.EmbeddingModelMeterObservationHandler
supportsContext(Observation.Context) - Method in interface org.springframework.ai.embedding.observation.EmbeddingModelObservationConvention
supportsContext(Observation.Context) - Method in interface org.springframework.ai.image.observation.ImageModelObservationConvention
supportsContext(Observation.Context) - Method in class org.springframework.ai.image.observation.ImageModelPromptContentObservationHandler
supportsContext(Observation.Context) - Method in class org.springframework.ai.model.observation.ErrorLoggingObservationHandler
supportsContext(Observation.Context) - Method in interface org.springframework.ai.tool.observation.ToolCallingObservationConvention
SYSTEM - Enum constant in enum class org.springframework.ai.chat.messages.MessageType: A Message of type system passed as input Messages containing high-level instructions for the conversation, such as behave like a certain character or provide answers in a specific format.
SystemMessage - Class in org.springframework.ai.chat.messages: A message of the type 'system' passed as input.
SystemMessage(String) - Constructor for class org.springframework.ai.chat.messages.SystemMessage
SystemMessage(Resource) - Constructor for class org.springframework.ai.chat.messages.SystemMessage
SystemMessage.Builder - Class in org.springframework.ai.chat.messages
SystemPromptTemplate - Class in org.springframework.ai.chat.prompt
SystemPromptTemplate(String) - Constructor for class org.springframework.ai.chat.prompt.SystemPromptTemplate
SystemPromptTemplate(Resource) - Constructor for class org.springframework.ai.chat.prompt.SystemPromptTemplate
SystemPromptTemplate.Builder - Class in org.springframework.ai.chat.prompt

T

temperature(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
temperature(Double) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
temperature(Double) - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder: Builds with the temperature to use for the chat.
temperature(Double) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
template - Variable in class org.springframework.ai.chat.prompt.PromptTemplate.Builder
template(String) - Method in class org.springframework.ai.chat.prompt.PromptTemplate.Builder
template(String) - Method in class org.springframework.ai.chat.prompt.SystemPromptTemplate.Builder
test(ChatOptions, ChatResponse) - Method in class org.springframework.ai.model.tool.DefaultToolExecutionEligibilityPredicate
text(String) - Method in class org.springframework.ai.chat.messages.SystemMessage.Builder
text(String) - Method in class org.springframework.ai.chat.messages.UserMessage.Builder
text(Resource) - Method in class org.springframework.ai.chat.messages.SystemMessage.Builder
text(Resource) - Method in class org.springframework.ai.chat.messages.UserMessage.Builder
TEXT - Enum constant in enum class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityType
TEXT_EMBEDDING_MODEL - Static variable in class org.springframework.ai.model.SpringAIModelProperties
textContent - Variable in class org.springframework.ai.chat.messages.AbstractMessage: The content of the message.
TextToSpeechMessage - Class in org.springframework.ai.audio.tts: Implementation of the TextToSpeechMessage interface for the text to speech message.
TextToSpeechMessage(String) - Constructor for class org.springframework.ai.audio.tts.TextToSpeechMessage
TextToSpeechModel - Interface in org.springframework.ai.audio.tts: Interface for the text to speech model.
TextToSpeechOptions - Interface in org.springframework.ai.audio.tts: Interface for text-to-speech model options.
TextToSpeechOptions.Builder - Interface in org.springframework.ai.audio.tts: Builder for TextToSpeechOptions.
TextToSpeechPrompt - Class in org.springframework.ai.audio.tts: Implementation of the ModelRequest interface for the text to speech prompt.
TextToSpeechPrompt(String) - Constructor for class org.springframework.ai.audio.tts.TextToSpeechPrompt
TextToSpeechPrompt(String, TextToSpeechOptions) - Constructor for class org.springframework.ai.audio.tts.TextToSpeechPrompt
TextToSpeechPrompt(TextToSpeechMessage) - Constructor for class org.springframework.ai.audio.tts.TextToSpeechPrompt
TextToSpeechPrompt(TextToSpeechMessage, TextToSpeechOptions) - Constructor for class org.springframework.ai.audio.tts.TextToSpeechPrompt
TextToSpeechResponse - Class in org.springframework.ai.audio.tts: Implementation of the ModelResponse interface for the text to speech response.
TextToSpeechResponse(List) - Constructor for class org.springframework.ai.audio.tts.TextToSpeechResponse
TextToSpeechResponse(List, TextToSpeechResponseMetadata) - Constructor for class org.springframework.ai.audio.tts.TextToSpeechResponse
TextToSpeechResponseMetadata - Class in org.springframework.ai.audio.tts: Metadata associated with an audio transcription response.
TextToSpeechResponseMetadata() - Constructor for class org.springframework.ai.audio.tts.TextToSpeechResponseMetadata
ThinkingTagCleaner - Class in org.springframework.ai.converter: A ResponseTextCleaner that removes thinking tags from LLM responses.
ThinkingTagCleaner() - Constructor for class org.springframework.ai.converter.ThinkingTagCleaner: Creates a cleaner with default thinking tag patterns.
ThinkingTagCleaner(String...) - Constructor for class org.springframework.ai.converter.ThinkingTagCleaner: Creates a cleaner with custom pattern strings.
ThinkingTagCleaner(List) - Constructor for class org.springframework.ai.converter.ThinkingTagCleaner: Creates a cleaner with custom patterns.
ThinkingTagCleaner.Builder - Class in org.springframework.ai.converter: Builder for ThinkingTagCleaner.
toAugmentedArgumentTypes(Class) - Static method in class org.springframework.ai.tool.augment.ToolInputSchemaAugmenter: Extracts the tool argument types from a record class annotated with ToolParam.
toFloatArray(float[]) - Static method in class org.springframework.ai.model.EmbeddingUtils
toJson(Object) - Static method in class org.springframework.ai.util.json.JsonParser: Converts a Java object to a JSON string if it's not already a valid JSON string.
toJsonString(Object) - Static method in class org.springframework.ai.model.ModelOptionsUtils: Converts the given object to a JSON string.
toJsonStringPrettyPrinter(Object) - Static method in class org.springframework.ai.model.ModelOptionsUtils: Converts the given object to a JSON string.
TokenCountBatchingStrategy - Class in org.springframework.ai.embedding: Token count based strategy implementation for BatchingStrategy.
TokenCountBatchingStrategy() - Constructor for class org.springframework.ai.embedding.TokenCountBatchingStrategy
TokenCountBatchingStrategy(EncodingType, int, double) - Constructor for class org.springframework.ai.embedding.TokenCountBatchingStrategy
TokenCountBatchingStrategy(EncodingType, int, double, ContentFormatter, MetadataMode) - Constructor for class org.springframework.ai.embedding.TokenCountBatchingStrategy
TokenCountBatchingStrategy(TokenCountEstimator, int, double, ContentFormatter, MetadataMode) - Constructor for class org.springframework.ai.embedding.TokenCountBatchingStrategy: Constructs a TokenCountBatchingStrategy with the specified parameters.
toList(float[]) - Static method in class org.springframework.ai.model.EmbeddingUtils
Tool - Annotation Interface in org.springframework.ai.tool.annotation: Marks a method as a tool in Spring AI.
TOOL - Enum constant in enum class org.springframework.ai.chat.messages.MessageType: A Message of type function passed as input Messages with function content in a chat application.
TOOL_CALL - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation: Tool calling observations.
TOOL_CALL_ARGUMENTS - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.HighCardinalityKeyNames: The input arguments to the tool call.
TOOL_CALL_HISTORY - Static variable in class org.springframework.ai.chat.model.ToolContext: The key for the running, tool call history stored in the context map.
TOOL_CALL_RESULT - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.HighCardinalityKeyNames: The result of the tool call.
TOOL_DEFINITION_DESCRIPTION - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.HighCardinalityKeyNames: Description of the tool.
TOOL_DEFINITION_NAME - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.LowCardinalityKeyNames: The name of the tool.
TOOL_DEFINITION_SCHEMA - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.HighCardinalityKeyNames: Schema of the parameters used to call the tool.
ToolCall(String, String, String, String) - Constructor for record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall: Creates an instance of a ToolCall record class.
toolCallArguments(String) - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext.Builder
ToolCallback - Interface in org.springframework.ai.tool: Represents a tool whose execution can be triggered by an AI model.
ToolCallbackProvider - Interface in org.springframework.ai.tool: Provides ToolCallback instances for tools defined in different sources.
toolCallbackResolver(ToolCallbackResolver) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder
ToolCallbackResolver - Interface in org.springframework.ai.tool.resolution: A resolver for ToolCallback instances.
toolCallbacks(List) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
toolCallbacks(List) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder: ToolCallbacks to be registered with the ChatModel.
toolCallbacks(ToolCallback...) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
toolCallbacks(ToolCallback...) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder: ToolCallbacks to be registered with the ChatModel.
ToolCallbacks - Class in org.springframework.ai.support: Provides ToolCallback instances for tools defined in different sources.
ToolCallingChatOptions - Interface in org.springframework.ai.model.tool: A set of options that can be used to configure the interaction with a chat model, including tool calling.
ToolCallingChatOptions.Builder - Interface in org.springframework.ai.model.tool: A builder to create a ToolCallingChatOptions instance.
ToolCallingContentObservationFilter - Class in org.springframework.ai.tool.observation: An ObservationFilter to include the tool call content (input/output) in the observation.
ToolCallingContentObservationFilter() - Constructor for class org.springframework.ai.tool.observation.ToolCallingContentObservationFilter
ToolCallingManager - Interface in org.springframework.ai.model.tool: Service responsible for managing the tool calling process for a chat model.
ToolCallingObservationContext - Class in org.springframework.ai.tool.observation: Context used to store data for tool calling observations.
ToolCallingObservationContext.Builder - Class in org.springframework.ai.tool.observation
ToolCallingObservationConvention - Interface in org.springframework.ai.tool.observation: Interface for an ObservationConvention for tool calling observations.
ToolCallingObservationDocumentation - Enum Class in org.springframework.ai.tool.observation: Tool calling observation documentation.
ToolCallingObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.ai.tool.observation: High cardinality key names.
ToolCallingObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.ai.tool.observation: Low cardinality key names.
ToolCallReactiveContextHolder - Class in org.springframework.ai.model.tool.internal: This class bridges blocking Tools call and the reactive context.
toolCallResult(String) - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext.Builder
toolCallResultConverter(ToolCallResultConverter) - Method in class org.springframework.ai.tool.function.FunctionToolCallback.Builder
toolCallResultConverter(ToolCallResultConverter) - Method in class org.springframework.ai.tool.method.MethodToolCallback.Builder
ToolCallResultConverter - Interface in org.springframework.ai.tool.execution: A functional interface to convert tool call results to a String that can be sent back to the AI model.
toolCalls(List) - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder
toolContext(String, Object) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
toolContext(String, Object) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder: Add a specific key/value pair to the tool context.
toolContext(Map) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
toolContext(Map) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder: Add a Map of context values into tool context.
ToolContext - Class in org.springframework.ai.chat.model: Represents the context for tool execution in a function calling scenario.
ToolContext(Map) - Constructor for class org.springframework.ai.chat.model.ToolContext: Constructs a new ToolContext with the given context map.
toolDefinition() - Method in record class org.springframework.ai.tool.augment.AugmentedArgumentEvent: Returns the value of the toolDefinition record component.
toolDefinition(ToolDefinition) - Method in class org.springframework.ai.tool.method.MethodToolCallback.Builder
toolDefinition(ToolDefinition) - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext.Builder
ToolDefinition - Interface in org.springframework.ai.tool.definition: Definition used by the AI model to determine when and how to call the tool.
toolDefinitionDescription(KeyValues, ToolCallingObservationContext) - Method in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention
toolDefinitionName(ToolCallingObservationContext) - Method in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention
ToolDefinitions - Class in org.springframework.ai.tool.support: Utility class for creating ToolDefinition builders and instances from Java Method objects.
toolDefinitionSchema(KeyValues, ToolCallingObservationContext) - Method in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention
ToolExecutionEligibilityChecker - Interface in org.springframework.ai.model.tool: Interface for determining when tool execution should be performed based on model responses.
ToolExecutionEligibilityPredicate - Interface in org.springframework.ai.model.tool: Interface for determining when tool execution should be performed based on model responses.
ToolExecutionException - Exception Class in org.springframework.ai.tool.execution: An exception thrown when a tool execution fails.
ToolExecutionException(ToolDefinition, Throwable) - Constructor for exception class org.springframework.ai.tool.execution.ToolExecutionException
toolExecutionExceptionProcessor(ToolExecutionExceptionProcessor) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder
ToolExecutionExceptionProcessor - Interface in org.springframework.ai.tool.execution: A functional interface to process a ToolExecutionException by either converting the error message to a String that can be sent back to the AI model or throwing an exception to be handled by the caller.
ToolExecutionResult - Interface in org.springframework.ai.model.tool: The result of a tool execution.
ToolInputSchemaAugmenter - Class in org.springframework.ai.tool.augment: This utility provides functionality to augment a JSON Schema with additional fields based on a provided Record type.
ToolInputSchemaAugmenter.AugmentedArgumentType - Record Class in org.springframework.ai.tool.augment: Represents an extended argument type with additional metadata such as description and required status.
toolMetadata(ToolMetadata) - Method in class org.springframework.ai.tool.function.FunctionToolCallback.Builder
toolMetadata(ToolMetadata) - Method in class org.springframework.ai.tool.method.MethodToolCallback.Builder
toolMetadata(ToolMetadata) - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext.Builder
ToolMetadata - Interface in org.springframework.ai.tool.metadata: Metadata about a tool specification and execution.
toolMethod(Method) - Method in class org.springframework.ai.tool.method.MethodToolCallback.Builder
toolNames(String...) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
toolNames(String...) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder: Names of the tools to register with the ChatModel.
toolNames(Set) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
toolNames(Set) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder: Names of the tools to register with the ChatModel.
toolObject(Object) - Method in class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider.Builder: Sets the tool object (alternative to delegate)
toolObject(Object) - Method in class org.springframework.ai.tool.method.MethodToolCallback.Builder
toolObjects(Object...) - Method in class org.springframework.ai.tool.method.MethodToolCallbackProvider.Builder
ToolParam - Annotation Interface in org.springframework.ai.tool.annotation: Marks a tool argument.
ToolResponse(String, String, String) - Constructor for record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse: Creates an instance of a ToolResponse record class.
ToolResponseMessage - Class in org.springframework.ai.chat.messages: The ToolResponseMessage class represents a message with a function content in a chat application.
ToolResponseMessage(List, Map) - Constructor for class org.springframework.ai.chat.messages.ToolResponseMessage
ToolResponseMessage.Builder - Class in org.springframework.ai.chat.messages
ToolResponseMessage.ToolResponse - Record Class in org.springframework.ai.chat.messages
ToolRuntimeHints - Class in org.springframework.ai.aot: Registers runtime hints for the tool calling APIs.
ToolRuntimeHints() - Constructor for class org.springframework.ai.aot.ToolRuntimeHints
ToolUtils - Class in org.springframework.ai.tool.support: Miscellaneous tool utility methods.
topK(Integer) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
topK(Integer) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
topK(Integer) - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder: Builds with the top K to use for the chat.
topK(Integer) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
topP(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
topP(Double) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
topP(Double) - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder: Builds with the top P to use for the chat.
topP(Double) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
toPrimitive(Float[]) - Static method in class org.springframework.ai.model.EmbeddingUtils
toPrimitive(List) - Static method in class org.springframework.ai.model.EmbeddingUtils
toString() - Method in class org.springframework.ai.audio.transcription.AudioTranscription
toString() - Method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions
toString() - Method in class org.springframework.ai.audio.tts.Speech
toString() - Method in class org.springframework.ai.audio.tts.TextToSpeechMessage
toString() - Method in class org.springframework.ai.audio.tts.TextToSpeechPrompt
toString() - Method in class org.springframework.ai.audio.tts.TextToSpeechResponse
toString() - Method in record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall: Returns a string representation of this record class.
toString() - Method in class org.springframework.ai.chat.messages.AssistantMessage
toString() - Method in class org.springframework.ai.chat.messages.SystemMessage
toString() - Method in record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse: Returns a string representation of this record class.
toString() - Method in class org.springframework.ai.chat.messages.ToolResponseMessage
toString() - Method in class org.springframework.ai.chat.messages.UserMessage
toString() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata
toString() - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
toString() - Method in class org.springframework.ai.chat.metadata.DefaultUsage
toString() - Method in class org.springframework.ai.chat.model.ChatResponse
toString() - Method in class org.springframework.ai.chat.model.Generation
toString() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage: Returns a string representation of this record class.
toString() - Method in class org.springframework.ai.chat.prompt.Prompt
toString() - Method in class org.springframework.ai.embedding.Embedding
toString() - Method in class org.springframework.ai.embedding.EmbeddingResponse
toString() - Method in class org.springframework.ai.image.Image
toString() - Method in class org.springframework.ai.image.ImageGeneration
toString() - Method in class org.springframework.ai.image.ImageMessage
toString() - Method in class org.springframework.ai.image.ImagePrompt
toString() - Method in class org.springframework.ai.image.ImageResponse
toString() - Method in record class org.springframework.ai.model.SimpleApiKey: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.model.tool.DefaultToolExecutionResult: Returns a string representation of this record class.
toString() - Method in class org.springframework.ai.moderation.Categories
toString() - Method in class org.springframework.ai.moderation.CategoryScores
toString() - Method in class org.springframework.ai.moderation.Generation
toString() - Method in class org.springframework.ai.moderation.Moderation
toString() - Method in class org.springframework.ai.moderation.ModerationMessage
toString() - Method in class org.springframework.ai.moderation.ModerationPrompt
toString() - Method in class org.springframework.ai.moderation.ModerationResponse
toString() - Method in class org.springframework.ai.moderation.ModerationResult
toString() - Method in record class org.springframework.ai.tool.augment.AugmentedArgumentEvent: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.tool.augment.ToolInputSchemaAugmenter.AugmentedArgumentType: Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.tool.definition.DefaultToolDefinition: Returns a string representation of this record class.
toString() - Method in class org.springframework.ai.tool.function.FunctionToolCallback
toString() - Method in record class org.springframework.ai.tool.metadata.DefaultToolMetadata: Returns a string representation of this record class.
toString() - Method in class org.springframework.ai.tool.method.MethodToolCallback
totalTokens() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage: Returns the value of the totalTokens record component.
toTypedObject(Object, Class) - Static method in class org.springframework.ai.util.json.JsonParser: Convert a Java Object to a typed Object.
toUpperCaseTypeValues(ObjectNode) - Static method in class org.springframework.ai.model.ModelOptionsUtils
transcribe(Resource) - Method in interface org.springframework.ai.audio.transcription.TranscriptionModel: A convenience method for transcribing an audio resource.
transcribe(Resource, AudioTranscriptionOptions) - Method in interface org.springframework.ai.audio.transcription.TranscriptionModel: A convenience method for transcribing an audio resource with the given options.
TranscriptionModel - Interface in org.springframework.ai.audio.transcription: A transcription model is a type of AI model that converts audio to text.
TRANSFORMERS - Static variable in class org.springframework.ai.model.SpringAIModels
type() - Method in record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall: Returns the value of the type record component.
type() - Method in record class org.springframework.ai.tool.augment.ToolInputSchemaAugmenter.AugmentedArgumentType: Returns the value of the type record component.
TypeResolverHelper - Class in org.springframework.ai.tool.resolution: A utility class that provides methods for resolving types and classes related to functions.

U

UPPER_CASE_TYPE_VALUES - Enum constant in enum class org.springframework.ai.util.json.schema.JsonSchemaGenerator.SchemaOption: Convert all "type" values to upper case.
usage(Usage) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
Usage - Interface in org.springframework.ai.chat.metadata: Abstract Data Type (ADT) encapsulating metadata on the usage of an AI provider's API per AI request.
USAGE_INPUT_TOKENS - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: The number of tokens used in the model input (prompt).
USAGE_INPUT_TOKENS - Enum constant in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation.HighCardinalityKeyNames: The number of tokens used in the model input.
USAGE_INPUT_TOKENS - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames: The number of tokens used in the model input (prompt).
USAGE_OUTPUT_TOKENS - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: The number of tokens used in the model output (completion).
USAGE_OUTPUT_TOKENS - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames: The number of tokens used in the model output (generation).
USAGE_TOTAL_TOKENS - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: The total number of tokens used in the model exchange.
USAGE_TOTAL_TOKENS - Enum constant in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation.HighCardinalityKeyNames: The total number of tokens used in the model exchange.
USAGE_TOTAL_TOKENS - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames: The total number of tokens used in the model exchange.
UsageCalculator - Class in org.springframework.ai.support: A utility class to provide support methods handling Usage.
usageInputTokens(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
usageInputTokens(KeyValues, EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
usageOutputTokens(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
usageTotalTokens(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
usageTotalTokens(KeyValues, EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
USER - Enum constant in enum class org.springframework.ai.chat.messages.MessageType: A Message of type user, having the user role and originating from an end-user or developer.
UserMessage - Class in org.springframework.ai.chat.messages: A message of the type 'user' passed as input Messages with the user role are from the end-user or developer.
UserMessage(String) - Constructor for class org.springframework.ai.chat.messages.UserMessage
UserMessage(Resource) - Constructor for class org.springframework.ai.chat.messages.UserMessage
UserMessage.Builder - Class in org.springframework.ai.chat.messages

V

validateToolCallbacks(List) - Static method in interface org.springframework.ai.model.tool.ToolCallingChatOptions
value() - Method in record class org.springframework.ai.model.SimpleApiKey: Returns the value of the value record component.
valueOf(String) - Static method in enum class org.springframework.ai.chat.messages.MessageType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.LowCardinalityKeyNames: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation.HighCardinalityKeyNames: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation.LowCardinalityKeyNames: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.LowCardinalityKeyNames: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.model.transformer.SummaryMetadataEnricher.SummaryType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.HighCardinalityKeyNames: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.LowCardinalityKeyNames: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.util.json.schema.JsonSchemaGenerator.SchemaOption: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.util.json.schema.SchemaType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.util.json.schema.SpringAiSchemaModule.Option: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.springframework.ai.chat.messages.MessageType: 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.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames: 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.chat.observation.ChatModelObservationDocumentation.LowCardinalityKeyNames: 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.chat.observation.ChatModelObservationDocumentation: 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.embedding.EmbeddingResultMetadata.ModalityType: 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.embedding.observation.EmbeddingModelObservationDocumentation.HighCardinalityKeyNames: 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.embedding.observation.EmbeddingModelObservationDocumentation.LowCardinalityKeyNames: 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.embedding.observation.EmbeddingModelObservationDocumentation: 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.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames: 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.image.observation.ImageModelObservationDocumentation.LowCardinalityKeyNames: 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.image.observation.ImageModelObservationDocumentation: 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.model.transformer.SummaryMetadataEnricher.SummaryType: 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.tool.observation.ToolCallingObservationDocumentation.HighCardinalityKeyNames: 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.tool.observation.ToolCallingObservationDocumentation.LowCardinalityKeyNames: 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.tool.observation.ToolCallingObservationDocumentation: 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.util.json.schema.JsonSchemaGenerator.SchemaOption: 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.util.json.schema.SchemaType: 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.util.json.schema.SpringAiSchemaModule.Option: Returns an array containing the constants of this enum class, in the order they are declared.
variables - Variable in class org.springframework.ai.chat.prompt.PromptTemplate.Builder
variables(Map) - Method in class org.springframework.ai.chat.prompt.PromptTemplate.Builder
variables(Map) - Method in class org.springframework.ai.chat.prompt.SystemPromptTemplate.Builder
VERTEX_AI - Static variable in class org.springframework.ai.model.SpringAIModels
VIDEO - Enum constant in enum class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityType
violence(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
violence(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
violenceGraphic(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
violenceGraphic(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
voice(String) - Method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions.Builder
voice(String) - Method in interface org.springframework.ai.audio.tts.TextToSpeechOptions.Builder: Sets the voice to use for text-to-speech.

W

WhitespaceCleaner - Class in org.springframework.ai.converter: A ResponseTextCleaner that trims leading and trailing whitespace from text.
WhitespaceCleaner() - Constructor for class org.springframework.ai.converter.WhitespaceCleaner
width(Integer) - Method in class org.springframework.ai.image.ImageOptionsBuilder
withoutDefaultPatterns() - Method in class org.springframework.ai.converter.ThinkingTagCleaner.Builder: Disable default patterns.
withTranscriptionMetadata(AudioTranscriptionMetadata) - Method in class org.springframework.ai.audio.transcription.AudioTranscription

Z

ZHIPUAI - Static variable in class org.springframework.ai.model.SpringAIModels

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