Index

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

A

AAC - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.AudioResponseFormat

AAC - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.AudioResponseFormat

AbstractAnnotatedMethodBeanFactoryInitializationAotProcessor - Class in org.springframework.ai.mcp.annotation.spring.scan

AbstractAnnotatedMethodBeanFactoryInitializationAotProcessor(Set<Class<? extends Annotation>>) - Constructor for class org.springframework.ai.mcp.annotation.spring.scan.AbstractAnnotatedMethodBeanFactoryInitializationAotProcessor

AbstractAnnotatedMethodBeanPostProcessor - Class in org.springframework.ai.mcp.annotation.spring.scan

AbstractAnnotatedMethodBeanPostProcessor(AbstractMcpAnnotatedBeans, Set<Class<? extends Annotation>>) - Constructor for class org.springframework.ai.mcp.annotation.spring.scan.AbstractAnnotatedMethodBeanPostProcessor

AbstractAsyncMcpToolMethodCallback<T,RC extends McpRequestContextTypes<?>> - Class in org.springframework.ai.mcp.annotation.method.tool

Abstract base class for creating Function callbacks around async tool methods.

AbstractAsyncMcpToolMethodCallback(ReturnMode, Method, Object) - Constructor for class org.springframework.ai.mcp.annotation.method.tool.AbstractAsyncMcpToolMethodCallback

AbstractAsyncMcpToolMethodCallback(ReturnMode, Method, Object, Class<? extends Throwable>) - Constructor for class org.springframework.ai.mcp.annotation.method.tool.AbstractAsyncMcpToolMethodCallback

Deprecated.

use AbstractAsyncMcpToolMethodCallback(ReturnMode, Method, Object). The toolCallExceptionClass argument is ignored: exception handling now follows the @Tool contract based on the exception type. Will be removed in 2.1.0.

AbstractBedrockApi<I,O,SO> - Class in org.springframework.ai.bedrock.api

Abstract class for the Bedrock API.

AbstractBedrockApi(String, String) - Constructor for class org.springframework.ai.bedrock.api.AbstractBedrockApi

Create a new AbstractBedrockApi instance using default credentials provider and object mapper.

AbstractBedrockApi(String, String, Duration) - Constructor for class org.springframework.ai.bedrock.api.AbstractBedrockApi

Create a new AbstractBedrockApi instance using default credentials provider and object mapper.

AbstractBedrockApi(String, AwsCredentialsProvider, String, JsonMapper) - Constructor for class org.springframework.ai.bedrock.api.AbstractBedrockApi

Create a new AbstractBedrockApi instance using the provided credentials provider, region and object mapper.

AbstractBedrockApi(String, AwsCredentialsProvider, String, JsonMapper, Duration) - Constructor for class org.springframework.ai.bedrock.api.AbstractBedrockApi

Create a new AbstractBedrockApi instance using the provided credentials provider, region and object mapper.

AbstractBedrockApi(String, AwsCredentialsProvider, Region, JsonMapper, Duration) - Constructor for class org.springframework.ai.bedrock.api.AbstractBedrockApi

Create a new AbstractBedrockApi instance using the provided credentials provider, region and JSON mapper.

AbstractBedrockApi.AmazonBedrockInvocationMetrics - Record Class in org.springframework.ai.bedrock.api

Encapsulates the metrics about the model invocation.

AbstractBuilder() - Constructor for class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.bedrock.converse.BedrockChatOptions.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.deepseek.DeepSeekAssistantMessage.AbstractBuilder

Deprecated.

AbstractBuilder() - Constructor for class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

AbstractBuilder() - Constructor for class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

AbstractChatOptionsTests<O extends ChatOptions,B extends ChatOptions.Builder<B>> - Class in org.springframework.ai.test.options

Abstract base class for testing ChatOptions subclasses.

AbstractChatOptionsTests() - Constructor for class org.springframework.ai.test.options.AbstractChatOptionsTests

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

AbstractFilterExpressionConverter - Class in org.springframework.ai.vectorstore.filter.converter

AbstractFilterExpressionConverter is an abstract class that implements the FilterExpressionConverter interface.

AbstractFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Create a new AbstractFilterExpressionConverter.

AbstractMcpAnnotatedBeans - Class in org.springframework.ai.mcp.annotation.spring.scan

Container for Beans that have method with MCP annotations

AbstractMcpAnnotatedBeans() - Constructor for class org.springframework.ai.mcp.annotation.spring.scan.AbstractMcpAnnotatedBeans

AbstractMcpCompleteMethodCallback - Class in org.springframework.ai.mcp.annotation.method.complete

Abstract base class for creating callbacks around complete methods.

AbstractMcpCompleteMethodCallback(Method, Object, String, String, McpUriTemplateManagerFactory) - Constructor for class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback

Constructor for AbstractMcpCompleteMethodCallback.

AbstractMcpCompleteMethodCallback.AbstractBuilder<T extends AbstractMcpCompleteMethodCallback.AbstractBuilder<T,R>,R> - Class in org.springframework.ai.mcp.annotation.method.complete

Abstract builder for creating McpCompleteMethodCallback instances.

AbstractMcpCompleteMethodCallback.McpCompleteMethodException - Exception in org.springframework.ai.mcp.annotation.method.complete

Exception thrown when there is an error invoking a complete method.

AbstractMcpElicitationMethodCallback - Class in org.springframework.ai.mcp.annotation.method.elicitation

Abstract base class for creating callbacks around elicitation methods.

AbstractMcpElicitationMethodCallback(Method, Object) - Constructor for class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback

Constructor for AbstractMcpElicitationMethodCallback.

AbstractMcpElicitationMethodCallback.AbstractBuilder<T extends AbstractMcpElicitationMethodCallback.AbstractBuilder<T,R>,R> - Class in org.springframework.ai.mcp.annotation.method.elicitation

Abstract builder for creating McpElicitationMethodCallback instances.

AbstractMcpElicitationMethodCallback.McpElicitationMethodException - Exception in org.springframework.ai.mcp.annotation.method.elicitation

Exception thrown when there is an error invoking an elicitation method.

AbstractMcpLoggingMethodCallback - Class in org.springframework.ai.mcp.annotation.method.logging

Abstract base class for creating callbacks around logging consumer methods.

AbstractMcpLoggingMethodCallback(Method, Object) - Constructor for class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback

Constructor for AbstractMcpLoggingConsumerMethodCallback.

AbstractMcpLoggingMethodCallback.AbstractBuilder<T extends AbstractMcpLoggingMethodCallback.AbstractBuilder<T,R>,R> - Class in org.springframework.ai.mcp.annotation.method.logging

Abstract builder for creating McpLoggingConsumerMethodCallback instances.

AbstractMcpLoggingMethodCallback.McpLoggingConsumerMethodException - Exception in org.springframework.ai.mcp.annotation.method.logging

Exception thrown when there is an error invoking a logging consumer method.

AbstractMcpProgressMethodCallback - Class in org.springframework.ai.mcp.annotation.method.progress

Abstract base class for creating callbacks around progress methods.

AbstractMcpProgressMethodCallback(Method, Object) - Constructor for class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback

Constructor for AbstractMcpProgressMethodCallback.

AbstractMcpProgressMethodCallback.AbstractBuilder<T extends AbstractMcpProgressMethodCallback.AbstractBuilder<T,R>,R> - Class in org.springframework.ai.mcp.annotation.method.progress

Abstract builder for creating McpProgressMethodCallback instances.

AbstractMcpProgressMethodCallback.McpProgressMethodException - Exception in org.springframework.ai.mcp.annotation.method.progress

Exception thrown when there is an error invoking a progress method.

AbstractMcpPromptListChangedMethodCallback - Class in org.springframework.ai.mcp.annotation.method.changed.prompt

Abstract base class for creating callbacks around prompt list changed consumer methods.

AbstractMcpPromptListChangedMethodCallback(Method, Object) - Constructor for class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback

Constructor for AbstractMcpPromptListChangedMethodCallback.

AbstractMcpPromptListChangedMethodCallback.AbstractBuilder<T extends AbstractMcpPromptListChangedMethodCallback.AbstractBuilder<T,R>,R> - Class in org.springframework.ai.mcp.annotation.method.changed.prompt

Abstract builder for creating McpPromptListChangedMethodCallback instances.

AbstractMcpPromptListChangedMethodCallback.McpPromptListChangedConsumerMethodException - Exception in org.springframework.ai.mcp.annotation.method.changed.prompt

Exception thrown when there is an error invoking a prompt list changed consumer method.

AbstractMcpPromptMethodCallback - Class in org.springframework.ai.mcp.annotation.method.prompt

Abstract base class for creating callbacks around prompt methods.

AbstractMcpPromptMethodCallback(Method, Object, McpSchema.Prompt) - Constructor for class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback

Constructor for AbstractMcpPromptMethodCallback.

AbstractMcpPromptMethodCallback.AbstractBuilder<B extends AbstractMcpPromptMethodCallback.AbstractBuilder<B,T>,T extends AbstractMcpPromptMethodCallback> - Class in org.springframework.ai.mcp.annotation.method.prompt

Abstract builder for creating prompt method callback instances.

AbstractMcpResourceListChangedMethodCallback - Class in org.springframework.ai.mcp.annotation.method.changed.resource

Abstract base class for creating callbacks around resource list changed consumer methods.

AbstractMcpResourceListChangedMethodCallback(Method, Object) - Constructor for class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback

Constructor for AbstractMcpResourceListChangedMethodCallback.

AbstractMcpResourceListChangedMethodCallback.AbstractBuilder<T extends AbstractMcpResourceListChangedMethodCallback.AbstractBuilder<T,R>,R> - Class in org.springframework.ai.mcp.annotation.method.changed.resource

Abstract builder for creating McpResourceListChangedMethodCallback instances.

AbstractMcpResourceListChangedMethodCallback.McpResourceListChangedConsumerMethodException - Exception in org.springframework.ai.mcp.annotation.method.changed.resource

Exception thrown when there is an error invoking a resource list changed consumer method.

AbstractMcpResourceMethodCallback - Class in org.springframework.ai.mcp.annotation.method.resource

Abstract base class for creating callbacks around resource methods.

AbstractMcpResourceMethodCallback(Method, Object, String, String, String, String, McpReadResourceResultConverter, McpUriTemplateManagerFactory, AbstractMcpResourceMethodCallback.ContentType, Map<String, Object>) - Constructor for class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

Constructor for AbstractMcpResourceMethodCallback.

AbstractMcpResourceMethodCallback.AbstractBuilder<T extends AbstractMcpResourceMethodCallback.AbstractBuilder<T,R>,R> - Class in org.springframework.ai.mcp.annotation.method.resource

Abstract builder for creating McpResourceMethodCallback instances.

AbstractMcpResourceMethodCallback.ContentType - Enum Class in org.springframework.ai.mcp.annotation.method.resource

Content type of the resource.

AbstractMcpSamplingMethodCallback - Class in org.springframework.ai.mcp.annotation.method.sampling

Abstract base class for creating callbacks around sampling methods.

AbstractMcpSamplingMethodCallback(Method, Object) - Constructor for class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback

Constructor for AbstractMcpSamplingMethodCallback.

AbstractMcpSamplingMethodCallback.AbstractBuilder<T extends AbstractMcpSamplingMethodCallback.AbstractBuilder<T,R>,R> - Class in org.springframework.ai.mcp.annotation.method.sampling

Abstract builder for creating McpSamplingMethodCallback instances.

AbstractMcpSamplingMethodCallback.McpSamplingMethodException - Exception in org.springframework.ai.mcp.annotation.method.sampling

Exception thrown when there is an error invoking a sampling method.

AbstractMcpToolListChangedMethodCallback - Class in org.springframework.ai.mcp.annotation.method.changed.tool

Abstract base class for creating callbacks around tool list changed consumer methods.

AbstractMcpToolListChangedMethodCallback(Method, Object) - Constructor for class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback

Constructor for AbstractMcpToolListChangedMethodCallback.

AbstractMcpToolListChangedMethodCallback.AbstractBuilder<T extends AbstractMcpToolListChangedMethodCallback.AbstractBuilder<T,R>,R> - Class in org.springframework.ai.mcp.annotation.method.changed.tool

Abstract builder for creating McpToolListChangedMethodCallback instances.

AbstractMcpToolListChangedMethodCallback.McpToolListChangedConsumerMethodException - Exception in org.springframework.ai.mcp.annotation.method.changed.tool

Exception thrown when there is an error invoking a tool list changed consumer method.

AbstractMcpToolMethodCallback<T,RC extends McpRequestContextTypes<?>> - Class in org.springframework.ai.mcp.annotation.method.tool

Abstract base class for creating Function callbacks around tool methods.

AbstractMcpToolMethodCallback(ReturnMode, Method, Object) - Constructor for class org.springframework.ai.mcp.annotation.method.tool.AbstractMcpToolMethodCallback

AbstractMcpToolProvider - Class in org.springframework.ai.mcp.annotation.provider.tool

AbstractMcpToolProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.tool.AbstractMcpToolProvider

AbstractMessage - Class in org.springframework.ai.chat.messages

The AbstractMessage class is an abstract implementation of the Message interface.

AbstractMessage(MessageType, String, Map<String, Object>) - Constructor for class org.springframework.ai.chat.messages.AbstractMessage

Create a new AbstractMessage with the given message type, text content, and metadata.

AbstractMessage(MessageType, List<MessagePart>, Map<String, Object>) - Constructor for class org.springframework.ai.chat.messages.AbstractMessage

Create a new AbstractMessage from an ordered list of parts.

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.

AbstractObservationVectorStore - Class in org.springframework.ai.vectorstore.observation

Abstract base class for VectorStore implementations that provides observation capabilities.

AbstractObservationVectorStore(AbstractVectorStoreBuilder<?>) - Constructor for class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

Creates a new AbstractObservationVectorStore instance with the specified builder settings.

AbstractOpenAiOptions - Class in org.springframework.ai.openai

AbstractOpenAiOptions(String, String, Credential, String, String, AzureOpenAIServiceVersion, String, Boolean, Boolean, Duration, Integer, Proxy, Map<String, String>) - Constructor for class org.springframework.ai.openai.AbstractOpenAiOptions

AbstractOpenAiOptions.AbstractBuilder<O extends AbstractOpenAiOptions,B extends AbstractOpenAiOptions.AbstractBuilder<O,B>> - Class in org.springframework.ai.openai

AbstractOpenAiProperties - Class in org.springframework.ai.model.openai.autoconfigure

AbstractOpenAiProperties() - Constructor for class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

AbstractResponseMetadata - Class in org.springframework.ai.model

AbstractResponseMetadata() - Constructor for class org.springframework.ai.model.AbstractResponseMetadata

Create a new AbstractResponseMetadata instance.

AbstractSessionRepositoryContractTests - Class in org.springframework.ai.test.session

Contract tests every SessionRepository implementation must pass.

AbstractSessionRepositoryContractTests() - Constructor for class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

AbstractSpringAiSchemaModule - Class in org.springframework.ai.util.json.schema

Abstract base for JSON Schema Generator Modules in Spring AI.

AbstractSpringAiSchemaModule(AbstractSpringAiSchemaModule.Option...) - Constructor for class org.springframework.ai.util.json.schema.AbstractSpringAiSchemaModule

AbstractSpringAiSchemaModule.Option - Enum Class in org.springframework.ai.util.json.schema

Options for customizing the behavior of the module.

AbstractSyncMcpToolMethodCallback<T,RC extends McpRequestContextTypes<?>> - Class in org.springframework.ai.mcp.annotation.method.tool

Abstract base class for creating Function callbacks around synchronous tool methods.

AbstractSyncMcpToolMethodCallback(ReturnMode, Method, Object) - Constructor for class org.springframework.ai.mcp.annotation.method.tool.AbstractSyncMcpToolMethodCallback

AbstractSyncMcpToolMethodCallback(ReturnMode, Method, Object, Class<? extends Throwable>) - Constructor for class org.springframework.ai.mcp.annotation.method.tool.AbstractSyncMcpToolMethodCallback

Deprecated.

use AbstractSyncMcpToolMethodCallback(ReturnMode, Method, Object). The toolCallExceptionClass argument is ignored: exception handling now follows the @Tool contract based on the exception type. Will be removed in 2.1.0.

AbstractToolCallConfirmationIT - Class in org.springframework.ai.test.chat.client.advisor

Abstract base class for integration tests of tool call confirmation: a tool marked requiresConfirmation pauses the ToolCallingAdvisor loop, and the application resumes the conversation after running the calls with ToolCallDecisions, against a real model.

AbstractToolCallConfirmationIT() - Constructor for class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT

AbstractToolCallConfirmationIT.Booking - Record Class in org.springframework.ai.test.chat.client.advisor

The booking the tool returns.

AbstractToolCallConfirmationIT.BookingRequest - Record Class in org.springframework.ai.test.chat.client.advisor

The booking request the model sends.

AbstractToolCallConfirmationIT.Weather - Record Class in org.springframework.ai.test.chat.client.advisor

The weather the tool returns.

AbstractToolCallConfirmationIT.WeatherRequest - Record Class in org.springframework.ai.test.chat.client.advisor

The weather request the model sends: one argument, so small models manage it.

AbstractToolCallingAdvisorAutoRegistrationIT - Class in org.springframework.ai.test.chat.client.advisor

Abstract integration-test base for ToolCallingAdvisor auto-registration behaviour.

AbstractToolCallingAdvisorAutoRegistrationIT() - Constructor for class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorAutoRegistrationIT

AbstractToolCallingAdvisorAutoRegistrationIT.ChainIterationCountingAdvisor - Class in org.springframework.ai.test.chat.client.advisor

Counts how many times the advisor chain passes through this advisor.

AbstractToolCallingAdvisorIT - Class in org.springframework.ai.test.chat.client.advisor

Abstract base class for ToolCallingAdvisor integration tests.

AbstractToolCallingAdvisorIT() - Constructor for class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorIT

AbstractVectorStoreBuilder<T extends AbstractVectorStoreBuilder<T>> - Class in org.springframework.ai.vectorstore

Abstract base builder implementing common builder functionality for VectorStore.

AbstractVectorStoreBuilder(EmbeddingModel) - Constructor for class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

AbstractVectorStoreUpsertTests - Class in org.springframework.ai.test.vectorstore

Shared verification suite for VectorStore.upsert(List) implementations, a sibling to BaseVectorStoreTests.

AbstractVectorStoreUpsertTests() - Constructor for class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

AbstractVectorStoreUpsertTests.CallCountingEmbeddingModel - Class in org.springframework.ai.test.vectorstore

An embedding model that counts every call made to it, for asserting that a code path never contacts the model.

accent() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerifiedVoiceLanguage

Returns the value of the accent record component.

accept(McpSchema.LoggingMessageNotification) - Method in class org.springframework.ai.mcp.annotation.method.logging.SyncMcpLoggingMethodCallback

Accept the logging message notification and process it.

accept(McpSchema.ProgressNotification) - Method in class org.springframework.ai.mcp.annotation.method.progress.SyncMcpProgressMethodCallback

Accept the progress notification and process it.

accept(List<McpSchema.Prompt>) - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.SyncMcpPromptListChangedMethodCallback

Accept the prompt list change notification and process it.

accept(List<McpSchema.Resource>) - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.SyncMcpResourceListChangedMethodCallback

Accept the resource list change notification and process it.

accept(List<McpSchema.Tool>) - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.SyncMcpToolListChangedMethodCallback

Accept the tool list change notification and process it.

accept(List<Document>) - Method in interface org.springframework.ai.vectorstore.VectorStore

accept(List<Document>) - Method in class org.springframework.ai.writer.FileDocumentWriter

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.AndExpressionContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.BooleanConstantContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareExpressionContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompoundIdentifierContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantArrayContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.DecimalConstantContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.GroupExpressionContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.InExpressionContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IntegerConstantContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNotNullExpressionContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNullExpressionContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.LongConstantContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NinExpressionContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NotExpressionContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.OrExpressionContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.QuotedIdentifierContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.SimpleIdentifierContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.TextConstantContext

accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.WhereContext

accepted() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerificationAttempt

Returns the value of the accepted record component.

accumulatedResponse() - Method in class org.springframework.ai.chat.client.advisor.UsageAccumulator

Returns the cumulative usage folded in so far, or null if none.

accumulateResponseUsage(ChatResponse, ChatResponse) - Static method in class org.springframework.ai.support.UsageCalculator

Folds the usage of the current chat response into the previously accumulated ChatResponse.

action() - Method in record class org.springframework.ai.mcp.annotation.context.StructuredElicitResult

Returns the value of the action record component.

action(McpSchema.ElicitResult.Action) - Method in class org.springframework.ai.mcp.annotation.context.StructuredElicitResult.Builder

Sets the action.

active() - Static method in record class org.springframework.ai.session.EventFilter

Returns the active conversation: the EventType.MESSAGE events of the active view, in prompt order.

activeView() - Method in record class org.springframework.ai.session.EventFilter

Returns the value of the activeView record component.

activeView(boolean) - Method in class org.springframework.ai.session.EventFilter.Builder

When true, the filter applies to the active view the newest compaction boundary defines, the pinned events, the summary, the preserved events and everything appended since, in that order (see CompactionBoundary.project(List)), instead of to the whole log; false by default.

add(String, Object) - Method in class org.springframework.ai.chat.prompt.PromptTemplate

add(String, String, String, String) - Method in class org.springframework.ai.tool.toolsearch.index.lucene.LuceneToolIndex

Adds a single tool to the index for the specified session.

add(String, List<Message>) - Method in interface org.springframework.ai.chat.memory.ChatMemory

Deprecated.

Save the specified messages in the chat memory for the specified conversation.

add(String, List<Message>) - Method in class org.springframework.ai.chat.memory.MessageWindowChatMemory

Deprecated.

add(String, List<Message>) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

add(String, Message) - Method in interface org.springframework.ai.chat.memory.ChatMemory

Deprecated.

Save the specified message in the chat memory for the specified conversation.

add(String, Message) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

add(List<Document>) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore

add(List<Document>) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

Create a new AbstractObservationVectorStore instance.

add(List<Document>) - Method in interface org.springframework.ai.vectorstore.VectorStore

Adds list of Documents to the vector store.

add(List<Document>, String) - Method in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore

Adds a list of documents to the vector store based on the namespace.

ADD - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Operation

VectorStore add operation.

addCitationDocument(AnthropicCitationDocument) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

addCleaner(ResponseTextCleaner) - Method in class org.springframework.ai.converter.CompositeResponseTextCleaner.Builder

Add a cleaner to the pipeline.

addContactPoint(InetSocketAddress) - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.Builder

Deprecated.

addContent(Content) - Method in class org.springframework.ai.google.genai.cache.CachedContentRequest.Builder

AddEmbeddingsRequest(String, float[], Map<String, Object>, String) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.AddEmbeddingsRequest

AddEmbeddingsRequest(List<String>, List<float[]>, List<Map<String, Object>>, List<String>) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.AddEmbeddingsRequest

Creates an instance of a AddEmbeddingsRequest record class.

additionalMetadata - Variable in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig

additionalMetadata - Variable in class org.springframework.ai.reader.markdown.config.MarkdownDocumentReaderConfig

additionalMetadata(String, Object) - Method in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig.Builder

Adds this additional metadata to the all built Documents.

additionalMetadata(Map<String, Object>) - Method in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig.Builder

Adds this additional metadata to the all built Documents.

additionalModels() - Method in record class org.springframework.ai.ollama.management.ModelManagementOptions

Returns the value of the additionalModels record component.

additionalModels(List<String>) - Method in class org.springframework.ai.ollama.management.ModelManagementOptions.Builder

additionalProperties() - Method in record class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions

Returns the value of the additionalProperties record component.

additionalProperties(Map<String, Object>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions.Builder

additionalProperty(String, Object) - Method in class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions.Builder

addMcpAnnotatedBean(Object, Set<Class<? extends Annotation>>) - Method in class org.springframework.ai.mcp.annotation.spring.scan.AbstractMcpAnnotatedBeans

addMcpClient(McpSyncClient) - Method in class org.springframework.ai.mcp.SyncMcpToolCallbackProvider.Builder

Adds an MCP client to the existing list.

addMeta(String, Object) - Method in class org.springframework.ai.mcp.annotation.context.StructuredElicitResult.Builder

Adds a single meta entry.

addMetadata(ParagraphManager.Paragraph, ParagraphManager.Paragraph, Document) - Method in class org.springframework.ai.reader.pdf.ParagraphPdfDocumentReader

addMetadataColumn(CassandraVectorStore.SchemaColumn) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

addMetadataColumns(List<CassandraVectorStore.SchemaColumn>) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

addMetadataColumns(CassandraVectorStore.SchemaColumn...) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

addPageRange(int, int) - Method in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig.Builder

Restricts reading to only the given inclusive, one-based page range, allowing callers to skip pages such as covers, tables of contents or appendices.

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.

addRegion(String, Rectangle2D) - Method in class org.springframework.ai.reader.pdf.layout.PDFLayoutTextStripperByArea

Add a new region to group text by.

addRoundResponse(ChatResponse) - Method in class org.springframework.ai.chat.client.advisor.UsageAccumulator

Folds the usage of the given round response into the running total.

addTextContent(String) - Method in class org.springframework.ai.google.genai.cache.CachedContentRequest.Builder

addToolReference(ToolReference) - Method in class org.springframework.ai.tool.toolsearch.ToolSearchResponse.Builder

AdvancedRedisChatMemoryRepository - Interface in org.springframework.ai.chat.memory.repository.redis

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory: org.springframework.ai.session.SessionRepository in spring-ai-session, with a JDBC store in spring-ai-session-jdbc. There is no session store for Redis yet; one is planned before 3.0.0, when this module is removed.

AdvancedRedisChatMemoryRepository.MessageWithConversation - Record Class in org.springframework.ai.chat.memory.repository.redis

Deprecated.

A wrapper class to return messages with their conversation context.

adviseCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor

Handles synchronous chat requests by checking the cache before proceeding.

adviseCall(ChatClientRequest, CallAdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor

adviseCall(ChatClientRequest, CallAdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.CallAdvisor

adviseCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ChatModelCallAdvisor

adviseCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor

adviseCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

adviseCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor

adviseCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

adviseCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.session.advisor.SessionTurnAdvisor

adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor

Handles streaming chat requests by checking the cache before proceeding.

adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor

adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.StreamAdvisor

adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ChatModelStreamAdvisor

adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor

Deprecated.

adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor

adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor

adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor

adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.session.advisor.SessionMemoryAdvisor

adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.session.advisor.SessionTurnAdvisor

Advisor - Interface in org.springframework.ai.chat.client.advisor.api

Parent advisor interface for all advisors.

ADVISOR - Enum constant in enum class org.springframework.ai.observation.conventions.SpringAiKind

Spring AI kind for advisor.

ADVISOR_NAME - Enum constant in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.LowCardinalityKeyNames

Advisor name.

ADVISOR_ORDER - Enum constant in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.HighCardinalityKeyNames

Advisor order in the advisor chain.

AdvisorChain - Interface in org.springframework.ai.chat.client.advisor.api

Defines the context for executing a chain of advisors as part of processing a chat request.

advisorName(String) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder

advisorName(AdvisorObservationContext) - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention

AdvisorObservationContext - Class in org.springframework.ai.chat.client.advisor.observation

Context used to store metadata for chat client advisors.

AdvisorObservationContext.Builder - Class in org.springframework.ai.chat.client.advisor.observation

Builder for AdvisorObservationContext.

AdvisorObservationConvention - Interface in org.springframework.ai.chat.client.advisor.observation

Interface for an ObservationConvention for chat client advisors.

AdvisorObservationDocumentation - Enum Class in org.springframework.ai.chat.client.advisor.observation

AI Advisor observation documentation.

AdvisorObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.ai.chat.client.advisor.observation

High cardinality key names.

AdvisorObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.ai.chat.client.advisor.observation

Low cardinality key names.

advisorOrder(int) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder

Sets the advisor order.

advisorOrder(int) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder

Sets the order of the advisor in the advisor chain.

advisorOrder(AdvisorObservationContext) - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention

AdvisorParams - Class in org.springframework.ai.chat.client

Configuration options for the ChatClient request.

advisors(KeyValues, ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

advisors(Consumer<ChatClient.AdvisorSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

advisors(Consumer<ChatClient.AdvisorSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

advisors(List<? extends Advisor>) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder

advisors(List<Advisor>) - Method in interface org.springframework.ai.chat.client.ChatClient.AdvisorSpec

advisors(List<Advisor>) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

advisors(List<Advisor>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec

advisors(List<Advisor>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

advisors(Advisor...) - Method in interface org.springframework.ai.chat.client.ChatClient.AdvisorSpec

advisors(Advisor...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

advisors(Advisor...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec

advisors(Advisor...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

AdvisorUtils - Class in org.springframework.ai.chat.client.advisor

Utilities to work with advisors.

after(ChatClientResponse, AdvisorChain) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor

after(ChatClientResponse, AdvisorChain) - Method in class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor

Not used for semantic cache advisor since we override adviseCall/adviseStream.

after(ChatClientResponse, AdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor

Logic to be executed after the rest of the advisor chain is called.

after(ChatClientResponse, AdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor

Deprecated.

after(ChatClientResponse, AdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor

after(ChatClientResponse, AdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor

after(ChatClientResponse, AdvisorChain) - Method in class org.springframework.ai.session.advisor.SessionMemoryAdvisor

after(ChatClientResponse, AdvisorChain) - Method in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorAutoRegistrationIT.ChainIterationCountingAdvisor

afterPropertiesSet() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorAutoConfiguration

afterPropertiesSet() - Method in class org.springframework.ai.chroma.vectorstore.ChromaVectorStore

afterPropertiesSet() - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingModel

afterPropertiesSet() - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

Initializes the GemFireVectorStore after properties are set.

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.s3.S3VectorStore

afterPropertiesSet() - Method in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

afterSingletonsInstantiated() - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpAsyncHandlersRegistry

afterSingletonsInstantiated() - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

AGENT_MODEL - Static variable in class org.springframework.ai.session.SessionAttributes

The model the agent a session runs is configured with, when known.

AGENT_NAME - Static variable in class org.springframework.ai.session.SessionAttributes

The name of the agent a session runs; absent unless set at creation.

AGENT_VERSION - Static variable in class org.springframework.ai.session.SessionAttributes

The version of the agent definition a session was created with, when known.

agentModel(Session) - Static method in class org.springframework.ai.session.SessionAttributes

The model of the agent a session runs, or null when none was set.

agentName(Session) - Static method in class org.springframework.ai.session.SessionAttributes

The agent name of a session, or null when none was set.

agentVersion(Session) - Static method in class org.springframework.ai.session.SessionAttributes

The agent version of a session, or null when none was set.

aggregate(Flux<ChatResponse>, Consumer<ChatResponse>) - Method in class org.springframework.ai.chat.model.MessageAggregator

aggregateChatClientResponse(Flux<ChatClientResponse>, Consumer<ChatClientResponse>) - Method in class org.springframework.ai.chat.client.ChatClientMessageAggregator

AI_ADVISOR - Enum constant in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation

AI Advisor observations

AI_CHAT_CLIENT - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation

AI Chat Client observations

AI_METADATA_STRING - Static variable in class org.springframework.ai.model.AbstractResponseMetadata

AI metadata string format.

AI_METADATA_STRING - Static variable in class org.springframework.ai.openai.metadata.OpenAiAudioSpeechResponseMetadata

AI_OPERATION_TYPE - Enum constant in enum class org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationDocumentation.LowCardinalityKeyNames

The name of the operation being performed.

AI_OPERATION_TYPE - Enum constant in enum class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationDocumentation.LowCardinalityKeyNames

The name of the operation being performed.

AI_OPERATION_TYPE - Enum constant in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.LowCardinalityKeyNames

The name of the operation being performed.

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.observation.conventions.AiObservationAttributes

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.audio.transcription.observation.TranscriptionModelObservationDocumentation.LowCardinalityKeyNames

The model provider as identified by the client instrumentation.

AI_PROVIDER - Enum constant in enum class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationDocumentation.LowCardinalityKeyNames

The model provider as identified by the client instrumentation.

AI_PROVIDER - Enum constant in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.LowCardinalityKeyNames

The model provider as identified by the client instrumentation.

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.observation.conventions.AiObservationAttributes

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.

AI_VECTOR_STORE - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation

Vector Store observations for clients.

AiObservationAttributes - Enum Class in org.springframework.ai.observation.conventions

Collection of attribute keys used in AI observations (spans, metrics, events).

AiObservationMetricAttributes - Enum Class in org.springframework.ai.observation.conventions

Collection of metric attributes used in AI observations.

AiObservationMetricNames - Enum Class in org.springframework.ai.observation.conventions

Enumeration of metric names used in AI observations.

AiOperationMetadata - Record Class in org.springframework.ai.observation

Metadata associated with an AI operation (e.g. model inference, fine-tuning, evaluation).

AiOperationMetadata(String, String) - Constructor for record class org.springframework.ai.observation.AiOperationMetadata

Create a new AiOperationMetadata instance.

AiOperationMetadata.Builder - Class in org.springframework.ai.observation

Builder for AiOperationMetadata.

aiOperationType(TranscriptionModelObservationContext) - Method in class org.springframework.ai.audio.transcription.observation.DefaultTranscriptionModelObservationConvention

aiOperationType(TextToSpeechModelObservationContext) - Method in class org.springframework.ai.audio.tts.observation.DefaultTextToSpeechModelObservationConvention

aiOperationType(AdvisorObservationContext) - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention

aiOperationType(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

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

AiOperationType - Enum Class in org.springframework.ai.observation.conventions

Types of operations performed by AI systems.

aiProvider(TranscriptionModelObservationContext) - Method in class org.springframework.ai.audio.transcription.observation.DefaultTranscriptionModelObservationConvention

aiProvider(TextToSpeechModelObservationContext) - Method in class org.springframework.ai.audio.tts.observation.DefaultTextToSpeechModelObservationConvention

aiProvider(AdvisorObservationContext) - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention

aiProvider(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

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

AiProvider - Enum Class in org.springframework.ai.observation.conventions

Collection of systems providing AI functionality.

AiRuntimeHints - Class in org.springframework.ai.aot

Utility methods for creating native runtime hints.

AiRuntimeHints() - Constructor for class org.springframework.ai.aot.AiRuntimeHints

AiTokenType - Enum Class in org.springframework.ai.observation.conventions

Types of tokens produced and consumed in an AI operation.

ALAW_8000 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

alignToLeft(String) - Static method in class org.springframework.ai.reader.ExtractedTextFormatter

all - Static variable in enum class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest.Include

all() - Static method in record class org.springframework.ai.session.EventFilter

Returns the whole log with no filtering, including the events a compaction covered and the compaction boundaries themselves.

all() - Static method in interface org.springframework.ai.session.MessageFilter

A filter that stores every message.

All() - Constructor for record class org.springframework.ai.session.EventFilter.Window.All

Creates an instance of a All record class.

ALL - Enum constant in enum class org.springframework.ai.document.MetadataMode

ALL - Enum constant in enum class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.ConsistentLevel

Write must receive an acknowledgement from all replica nodes.

ALL - Static variable in interface org.springframework.ai.session.EventFilter.Window

Every matching event.

ALL_PAGES - Static variable in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig

allAnnotatedBeans - Variable in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

allElements - Variable in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig

allElements(boolean) - Method in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig.Builder

Enables extracting text from all elements in the body, creating a single document.

allow(String) - Static method in record class org.springframework.ai.model.tool.ToolCallDecision

Allows the tool call to run.

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.

ALLOW_ADULT - Enum constant in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.PersonGeneration

ALLOW_ALL - Enum constant in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.PersonGeneration

allowed() - Method in record class org.springframework.ai.model.tool.ToolCallDecision

Returns the value of the allowed record component.

ALLOWED - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.ReviewStatusEnum

ALLOWED_WITH_CHANGES - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.ReviewStatusEnum

allowedDomains() - Method in record class org.springframework.ai.openai.responses.HostedTool.WebSearch

Returns the value of the allowedDomains record component.

allowedDomains(List<String>) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool.Builder

allowedFunctionName(String) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice.Builder

allowedFunctionNames() - Method in record class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice

Returns the value of the allowedFunctionNames record component.

allowedFunctionNames(List<String>) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice.Builder

allowedTools() - Method in record class org.springframework.ai.openai.responses.HostedTool.Mcp

Returns the value of the allowedTools record component.

allowEmptyContext(Boolean) - Method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter.Builder

allowSystemMessages(boolean) - Method in class org.springframework.ai.session.DefaultSessionService.Builder

Whether DefaultSessionService.appendEvent(SessionEvent) may store a SystemMessage; false by default.

ALLOY - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Voice

ALLOY - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.Voice

ALWAYS - Enum constant in enum class org.springframework.ai.ollama.management.PullModelStrategy

Always pull the model, even if it's already available.

AlwaysEvictStrategy - Class in org.springframework.ai.tool.toolsearch.eviction

A ToolIndexEvictionStrategy that clears a session's tool index before every request, ensuring tools are always re-indexed on each conversation turn.

alwaysThrow(boolean) - Method in class org.springframework.ai.tool.execution.DefaultToolExecutionExceptionProcessor.Builder

Rethrow the ToolExecutionException

amazonBedrockInvocationMetrics() - Method in record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingResponse

Returns the value of the amazonBedrockInvocationMetrics record component.

AmazonBedrockInvocationMetrics(Long, Long, Long, Long) - Constructor for record class org.springframework.ai.bedrock.api.AbstractBedrockApi.AmazonBedrockInvocationMetrics

Creates an instance of a AmazonBedrockInvocationMetrics record class.

ANALOG_FILM - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

and(MessageFilter) - Method in interface org.springframework.ai.session.MessageFilter

A filter that stores a message only if both this filter and other accept it.

and(FilterExpressionBuilder.Op, FilterExpressionBuilder.Op) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

AND - Enum constant in enum class org.springframework.ai.vectorstore.filter.Filter.ExpressionType

AND - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

AND - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

AND() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.AndExpressionContext

AndExpressionContext(FiltersParser.BooleanExpressionContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.AndExpressionContext

ANIME - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

AnnotationProviderUtil - Class in org.springframework.ai.mcp.annotation.spring

annotations() - Element in annotation interface org.springframework.ai.mcp.annotation.McpResource

Optional annotations for the client.

annotations() - Element in annotation interface org.springframework.ai.mcp.annotation.McpTool

Additional hints for clients.

ANNOTATIONS - Static variable in class org.springframework.ai.openai.responses.OpenAiResponsesMetadata

Citations attached to the generated text, e.g. from web or file search.

ANTHROPIC - Enum constant in enum class org.springframework.ai.anthropic.AnthropicSkillType

Pre-built skills provided by Anthropic (xlsx, pptx, docx, pdf).

ANTHROPIC - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider

AI system provided by Anthropic.

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

ANTHROPIC_PROVIDER - Static variable in class org.springframework.ai.anthropic.AnthropicChatModel

The OpaquePayload.provider() of parts produced by this model.

AnthropicCacheOptions - Class in org.springframework.ai.anthropic

Anthropic cache options for configuring prompt caching behavior with the Anthropic Java SDK.

AnthropicCacheOptions(AnthropicCacheStrategy, Function<String, Integer>, Map<MessageType, AnthropicCacheTtl>, Map<MessageType, Integer>, Boolean, Boolean) - Constructor for class org.springframework.ai.anthropic.AnthropicCacheOptions

AnthropicCacheOptions.Builder - Class in org.springframework.ai.anthropic

AnthropicCacheProperties - Class in org.springframework.ai.model.anthropic.autoconfigure

AnthropicCacheProperties() - Constructor for class org.springframework.ai.model.anthropic.autoconfigure.AnthropicCacheProperties

AnthropicCacheStrategy - Enum Class in org.springframework.ai.anthropic

Defines the caching strategy for Anthropic prompt caching.

AnthropicCacheTtl - Enum Class in org.springframework.ai.anthropic

Anthropic cache TTL (time-to-live) options for specifying how long cached prompts remain valid.

AnthropicChatAutoConfiguration - Class in org.springframework.ai.model.anthropic.autoconfigure

Auto-configuration for Anthropic Chat Model.

AnthropicChatAutoConfiguration() - Constructor for class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatAutoConfiguration

anthropicChatModel(AnthropicConnectionProperties, AnthropicChatProperties, ToolCallingManager, ObjectProvider<ObservationRegistry>, ObjectProvider<MeterRegistry>, ObjectProvider<ChatModelObservationConvention>, ObjectProvider<AnthropicHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatAutoConfiguration

AnthropicChatModel - Class in org.springframework.ai.anthropic

ChatModel and StreamingChatModel implementation using the official Anthropic Java SDK.

AnthropicChatModel.Builder - Class in org.springframework.ai.anthropic

Builder for creating AnthropicChatModel instances.

AnthropicChatOptions - Class in org.springframework.ai.anthropic

Chat options for AnthropicChatModel.

AnthropicChatOptions(String, String, String, Duration, Integer, Proxy, Map<String, String>, Integer, Metadata, List<String>, Double, Double, Integer, ToolChoice, ThinkingConfigParam, Boolean, List<ToolCallback>, Map<String, Object>, List<AnthropicCitationDocument>, AnthropicCacheOptions, OutputConfig, Map<String, String>, AnthropicSkillContainer, String, AnthropicWebSearchTool, AnthropicServiceTier) - Constructor for class org.springframework.ai.anthropic.AnthropicChatOptions

AnthropicChatOptions.AbstractBuilder<B extends AnthropicChatOptions.AbstractBuilder<B>> - Class in org.springframework.ai.anthropic

AnthropicChatOptions.Builder - Class in org.springframework.ai.anthropic

Builder for creating AnthropicChatOptions instances.

AnthropicChatProperties - Class in org.springframework.ai.model.anthropic.autoconfigure

Anthropic Chat autoconfiguration properties.

AnthropicChatProperties() - Constructor for class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

AnthropicChatProperties.Options - Class in org.springframework.ai.model.anthropic.autoconfigure

AnthropicCitationDocument - Class in org.springframework.ai.anthropic

Builder class for creating citation-enabled documents using the Anthropic Java SDK.

AnthropicCitationDocument.Builder - Class in org.springframework.ai.anthropic

Builder class for AnthropicCitationDocument.

AnthropicCitationDocument.DocumentType - Enum Class in org.springframework.ai.anthropic

Document types supported by Anthropic Citations API.

anthropicClient(AnthropicClient) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder

Sets the synchronous Anthropic client.

anthropicClientAsync(AnthropicClientAsync) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder

Sets the asynchronous Anthropic client.

AnthropicConnectionProperties - Class in org.springframework.ai.model.anthropic.autoconfigure

Anthropic connection properties.

AnthropicConnectionProperties() - Constructor for class org.springframework.ai.model.anthropic.autoconfigure.AnthropicConnectionProperties

AnthropicHttpClientBuilderCustomizer - Interface in org.springframework.ai.anthropic.http.okhttp

Callback for customizing the SpringAiAnthropicHttpClient.Builder used by AnthropicChatModel before the underlying OkHttpClient is built.

AnthropicRateLimit - Class in org.springframework.ai.anthropic.metadata

RateLimit implementation for the Anthropic SDK.

AnthropicRateLimit(Long, Long, Duration, Long, Long, Duration, Long, Long, Duration, Long, Long, Duration) - Constructor for class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

AnthropicServiceTier - Enum Class in org.springframework.ai.anthropic

Service tier for controlling capacity routing on Anthropic API requests.

AnthropicSetup - Class in org.springframework.ai.anthropic

Factory class for creating and configuring Anthropic SDK client instances.

AnthropicSkill - Enum Class in org.springframework.ai.anthropic

Enum representing the pre-built Anthropic Skills available for Claude.

AnthropicSkillContainer - Class in org.springframework.ai.anthropic

Container for Claude Skills in a chat completion request.

AnthropicSkillContainer(List<AnthropicSkillRecord>) - Constructor for class org.springframework.ai.anthropic.AnthropicSkillContainer

AnthropicSkillContainer.Builder - Class in org.springframework.ai.anthropic

AnthropicSkillRecord - Class in org.springframework.ai.anthropic

Represents a Claude Skill - either pre-built Anthropic skill or custom skill.

AnthropicSkillRecord(AnthropicSkillType, String) - Constructor for class org.springframework.ai.anthropic.AnthropicSkillRecord

Create a skill with default "latest" version.

AnthropicSkillRecord(AnthropicSkillType, String, String) - Constructor for class org.springframework.ai.anthropic.AnthropicSkillRecord

Create a skill with a specific version.

AnthropicSkillRecord.Builder - Class in org.springframework.ai.anthropic

AnthropicSkillsResponseHelper - Class in org.springframework.ai.anthropic

Helper utilities for working with Anthropic Claude Skills responses and files.

AnthropicSkillType - Enum Class in org.springframework.ai.anthropic

Enum representing the type of a Claude Skill.

AnthropicWebSearchResult - Record Class in org.springframework.ai.anthropic

Represents an individual web search result returned by Anthropic's built-in web search tool.

AnthropicWebSearchResult(String, String, String) - Constructor for record class org.springframework.ai.anthropic.AnthropicWebSearchResult

Creates an instance of a AnthropicWebSearchResult record class.

AnthropicWebSearchTool - Class in org.springframework.ai.anthropic

Configuration for Anthropic's built-in web search tool.

AnthropicWebSearchTool() - Constructor for class org.springframework.ai.anthropic.AnthropicWebSearchTool

AnthropicWebSearchTool.Builder - Class in org.springframework.ai.anthropic

AnthropicWebSearchTool.UserLocation - Record Class in org.springframework.ai.anthropic

Approximate user location for localizing web search results.

ANY - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice.Mode

Model is constrained to always predict a function call.

ANY - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ToolChoice

anyOf(CompactionTrigger...) - Static method in class org.springframework.ai.session.compaction.CompositeCompactionTrigger

A trigger that fires when any of the given triggers fires.

apiEndpoint(String) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails.Builder

apiKey - Variable in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

apiKey - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

apiKey - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

apiKey(String) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

apiKey(String) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.Builder

apiKey(String) - Method in class org.springframework.ai.google.genai.embedding.GoogleGenAiEmbeddingConnectionDetails.Builder

apiKey(String) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageConnectionDetails.Builder

apiKey(String) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionConnectionDetails.Builder

Sets the API key used to authenticate against the Gemini Developer API.

apiKey(String) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechConnectionDetails.Builder

Sets the API key for the Gemini Developer API.

apiKey(String) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

apiKey(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

apiKey(String) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

apiKey(ApiKey) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.Builder

apiKey(ApiKey) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

Sets the API key using an ApiKey instance.

apiKey(ApiKey) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

Sets the API key using an ApiKey instance.

apiKey(ApiKey) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

Sets the API key using an ApiKey instance.

apiKey(String) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.Builder

apiKey(String) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Builder

apiKey(String) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.Builder

apiKey(String) - Method in class org.springframework.ai.mistralai.api.MistralAiModerationApi.Builder

apiKey(String) - Method in interface org.springframework.ai.vectorstore.pinecone.PineconeVectorStore.Builder.BuilderWithApiKey

Sets the Pinecone API key and moves to index name configuration.

apiKey(ApiKey) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.Builder

apiKey(ApiKey) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Builder

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.

append(String, Message...) - Method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

Appends each message as its own event.

appendEvent(SessionEvent) - Method in class org.springframework.ai.session.DefaultSessionService

appendEvent(SessionEvent) - Method in class org.springframework.ai.session.InMemorySessionRepository

appendEvent(SessionEvent) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository

appendEvent(SessionEvent) - Method in interface org.springframework.ai.session.SessionRepository

Appends one event to the log of the session named by SessionEvent.getSessionId().

appendEvent(SessionEvent) - Method in interface org.springframework.ai.session.SessionService

Appends an event to the session named by SessionEvent.getSessionId().

appendEvents(String, List<SessionEvent>, long) - Method in class org.springframework.ai.session.InMemorySessionRepository

appendEvents(String, List<SessionEvent>, long) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository

appendEvents(String, List<SessionEvent>, long) - Method in interface org.springframework.ai.session.SessionRepository

Appends several events in order, atomically, only if the log's version equals expectedVersion; otherwise nothing is written and false is returned.

appendMessage(String, Message) - Method in interface org.springframework.ai.session.SessionService

Wraps the message in a SessionEvent and appends it; see SessionService.appendEvent(SessionEvent).

apply(McpTransportContext, McpSchema.CallToolRequest) - Method in class org.springframework.ai.mcp.annotation.method.tool.AsyncStatelessMcpToolMethodCallback

Apply the callback to the given request.

apply(McpTransportContext, McpSchema.CallToolRequest) - Method in class org.springframework.ai.mcp.annotation.method.tool.SyncStatelessMcpToolMethodCallback

apply(McpTransportContext, McpSchema.CompleteRequest) - Method in class org.springframework.ai.mcp.annotation.method.complete.AsyncStatelessMcpCompleteMethodCallback

Apply the callback to the given context and request.

apply(McpTransportContext, McpSchema.CompleteRequest) - Method in class org.springframework.ai.mcp.annotation.method.complete.SyncStatelessMcpCompleteMethodCallback

Apply the callback to the given context and request.

apply(McpTransportContext, McpSchema.GetPromptRequest) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AsyncStatelessMcpPromptMethodCallback

Apply the callback to the given context and request.

apply(McpTransportContext, McpSchema.GetPromptRequest) - Method in class org.springframework.ai.mcp.annotation.method.prompt.SyncStatelessMcpPromptMethodCallback

Apply the callback to the given context and request.

apply(McpTransportContext, McpSchema.ReadResourceRequest) - Method in class org.springframework.ai.mcp.annotation.method.resource.AsyncStatelessMcpResourceMethodCallback

Apply the callback to the given context and request.

apply(McpTransportContext, McpSchema.ReadResourceRequest) - Method in class org.springframework.ai.mcp.annotation.method.resource.SyncStatelessMcpResourceMethodCallback

Apply the callback to the given context and request.

apply(McpAsyncServerExchange, McpSchema.CallToolRequest) - Method in class org.springframework.ai.mcp.annotation.method.tool.AsyncMcpToolMethodCallback

Apply the callback to the given request.

apply(McpAsyncServerExchange, McpSchema.CompleteRequest) - Method in class org.springframework.ai.mcp.annotation.method.complete.AsyncMcpCompleteMethodCallback

Apply the callback to the given exchange and request.

apply(McpAsyncServerExchange, McpSchema.GetPromptRequest) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AsyncMcpPromptMethodCallback

Apply the callback to the given exchange and request.

apply(McpAsyncServerExchange, McpSchema.ReadResourceRequest) - Method in class org.springframework.ai.mcp.annotation.method.resource.AsyncMcpResourceMethodCallback

Apply the callback to the given exchange and request.

apply(McpSyncServerExchange, McpSchema.CallToolRequest) - Method in class org.springframework.ai.mcp.annotation.method.tool.SyncMcpToolMethodCallback

Apply the callback to the given request.

apply(McpSyncServerExchange, McpSchema.CompleteRequest) - Method in class org.springframework.ai.mcp.annotation.method.complete.SyncMcpCompleteMethodCallback

Apply the callback to the given exchange and request.

apply(McpSyncServerExchange, McpSchema.GetPromptRequest) - Method in class org.springframework.ai.mcp.annotation.method.prompt.SyncMcpPromptMethodCallback

Apply the callback to the given exchange and request.

apply(McpSyncServerExchange, McpSchema.ReadResourceRequest) - Method in class org.springframework.ai.mcp.annotation.method.resource.SyncMcpResourceMethodCallback

Apply the callback to the given exchange and request.

apply(McpSchema.CreateMessageRequest) - Method in class org.springframework.ai.mcp.annotation.method.sampling.AsyncMcpSamplingMethodCallback

Apply the callback to the given request.

apply(McpSchema.CreateMessageRequest) - Method in class org.springframework.ai.mcp.annotation.method.sampling.SyncMcpSamplingMethodCallback

Apply the callback to the given request.

apply(McpSchema.ElicitRequest) - Method in class org.springframework.ai.mcp.annotation.method.elicitation.AsyncMcpElicitationMethodCallback

Apply the callback to the given request.

apply(McpSchema.ElicitRequest) - Method in class org.springframework.ai.mcp.annotation.method.elicitation.SyncMcpElicitationMethodCallback

Apply the callback to the given request.

apply(McpSchema.LoggingMessageNotification) - Method in class org.springframework.ai.mcp.annotation.method.logging.AsyncMcpLoggingMethodCallback

Apply the callback to the given notification.

apply(McpSchema.ProgressNotification) - Method in class org.springframework.ai.mcp.annotation.method.progress.AsyncMcpProgressMethodCallback

Apply the progress notification and process it asynchronously.

apply(String, Map<String, ? extends Object>) - Method in class org.springframework.ai.template.NoOpTemplateRenderer

apply(String, Map<String, ? extends Object>) - Method in class org.springframework.ai.template.st.StTemplateRenderer

apply(String, Map<String, ? extends Object>) - Method in interface org.springframework.ai.template.TemplateRenderer

apply(List<McpSchema.Prompt>) - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.AsyncMcpPromptListChangedMethodCallback

Apply the callback to the given prompt list.

apply(List<McpSchema.Resource>) - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.AsyncMcpResourceListChangedMethodCallback

Apply the callback to the given resource list.

apply(List<McpSchema.Tool>) - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.AsyncMcpToolListChangedMethodCallback

Apply the callback to the given tool list.

apply(List<Document>) - Method in class org.springframework.ai.model.transformer.KeywordMetadataEnricher

apply(List<Document>) - Method in class org.springframework.ai.model.transformer.SummaryMetadataEnricher

apply(List<Document>) - Method in class org.springframework.ai.transformer.ContentFormatTransformer

Post process documents chunked from loader.

apply(List<Document>) - Method in class org.springframework.ai.transformer.splitter.TextSplitter

apply(List<SessionEvent>) - Method in record class org.springframework.ai.session.EventFilter

Applies this filter to the events of one session held in memory: with EventFilter.activeView() first reduces the log to its active view (CompactionBoundary.project(List)), then keeps the events that EventFilter.matches(SessionEvent), then applies the window keeping turns whole.

apply(Map<Query, List<List<Document>>>) - Method in interface org.springframework.ai.rag.retrieval.join.DocumentJoiner

apply(Query) - Method in interface org.springframework.ai.rag.preretrieval.query.expansion.QueryExpander

apply(Query) - Method in interface org.springframework.ai.rag.preretrieval.query.transformation.QueryTransformer

apply(Query) - Method in interface org.springframework.ai.rag.retrieval.search.DocumentRetriever

apply(Query, List<Document>) - Method in interface org.springframework.ai.rag.generation.augmentation.QueryAugmenter

apply(Query, List<Document>) - Method in interface org.springframework.ai.rag.postretrieval.document.DocumentPostProcessor

apply(MockWeatherService.Request) - Method in class org.springframework.ai.test.chat.client.advisor.MockWeatherService

applyAccumulatedUsage(ChatClientResponse) - Method in class org.springframework.ai.chat.client.advisor.UsageAccumulator

Stamps the accumulated total usage onto the given response.

applyLanguageTextNormalization() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Returns the value of the applyLanguageTextNormalization record component.

applyLanguageTextNormalization(Boolean) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.Builder

applyLanguageTextNormalization(Boolean) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

applyTextNormalization() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Returns the value of the applyTextNormalization record component.

applyTextNormalization(ElevenLabsApi.SpeechRequest.TextNormalizationMode) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.Builder

applyTextNormalization(ElevenLabsApi.SpeechRequest.TextNormalizationMode) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class org.springframework.ai.model.KotlinModule

applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class org.springframework.ai.util.json.schema.AbstractSpringAiSchemaModule

applyWindow(List<SessionEvent>) - Method in record class org.springframework.ai.session.EventFilter

Applies the window to the filtered events of one session, oldest first, keeping turns whole: a EventFilter.Window.Last window whose first event is not a turn start is extended back to the nearest turn start before it.

args() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStdioClientProperties.Parameters

Returns the value of the args record component.

argumentConsumer(Consumer<AugmentedArgumentEvent<T>>) - 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.deepseek.api.DeepSeekApi.ChatCompletionMessage.ChatCompletionFunction

Returns the value of the arguments record component.

arguments() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ChatCompletionFunction

Returns the value of the arguments record component.

arguments() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message.ToolCallFunction

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.

ARGUMENTS - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolCallAttributes

Deprecated.

argumentType(Class<T>) - Method in class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider.Builder

Sets the argument type

artifacts() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageResponse

Returns the value of the artifacts record component.

Artifacts(long, String, String) - Constructor for record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageResponse.Artifacts

Creates an instance of a Artifacts record class.

asCompleteReference(McpComplete) - Static method in class org.springframework.ai.mcp.annotation.adapter.CompleteAdapter

Convert a McpComplete annotation to a McpSchema.CompleteReference object.

asCompleteReference(McpComplete, Method) - Static method in class org.springframework.ai.mcp.annotation.adapter.CompleteAdapter

Convert a McpComplete annotation and Method to a McpSchema.CompleteReference object.

ASH - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Voice

ASH - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.Voice

aspectRatio(String) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

asPrompt(McpPrompt) - Static method in class org.springframework.ai.mcp.annotation.adapter.PromptAdapter

Convert a McpPrompt annotation to a McpSchema.Prompt object.

asPrompt(McpPrompt, Method) - Static method in class org.springframework.ai.mcp.annotation.adapter.PromptAdapter

Convert a McpPrompt annotation to a McpSchema.Prompt object, including argument information from the method parameters.

asResource(McpResource) - Static method in class org.springframework.ai.mcp.annotation.adapter.ResourceAdapter

asResourceTemplate(McpResource) - Static method in class org.springframework.ai.mcp.annotation.adapter.ResourceAdapter

assertNoInternalAddress(String) - Static method in class org.springframework.ai.bedrock.converse.api.URLValidator

Resolves all IP addresses for the given hostname and throws SecurityException if any resolve to a loopback, link-local, site-local, or wildcard address.

assertObservationRegistry(TestObservationRegistry, VectorStoreProvider, VectorStoreObservationContext.Operation) - Static method in class org.springframework.ai.test.vectorstore.ObservationTestUtil

assertWrongDimensionRejected(VectorStore) - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

Assert that the store's own pre-write check rejects a wrong-sized vector.

assignExchangeType(Class<?>, Object) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback

assignExchangeType(Class<?>, Object) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AsyncMcpPromptMethodCallback

assignExchangeType(Class<?>, Object) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AsyncStatelessMcpPromptMethodCallback

assignExchangeType(Class<?>, Object) - Method in class org.springframework.ai.mcp.annotation.method.prompt.SyncMcpPromptMethodCallback

assignExchangeType(Class<?>, Object) - Method in class org.springframework.ai.mcp.annotation.method.prompt.SyncStatelessMcpPromptMethodCallback

assignExchangeType(Class<?>, Object) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

assignExchangeType(Class<?>, Object) - Method in class org.springframework.ai.mcp.annotation.method.resource.AsyncMcpResourceMethodCallback

assignExchangeType(Class<?>, Object) - Method in class org.springframework.ai.mcp.annotation.method.resource.AsyncStatelessMcpResourceMethodCallback

assignExchangeType(Class<?>, Object) - Method in class org.springframework.ai.mcp.annotation.method.resource.SyncMcpResourceMethodCallback

assignExchangeType(Class<?>, Object) - Method in class org.springframework.ai.mcp.annotation.method.resource.SyncStatelessMcpResourceMethodCallback

assistant(String) - Static method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

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.

ASSISTANT - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.Role

Assistant message.

ASSISTANT - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.Role

ASSISTANT - Enum constant in enum class org.springframework.ai.ollama.api.OllamaApi.Message.Role

Assistant message type.

AssistantMessage - Class in org.springframework.ai.chat.messages

Lets the generative know the content was generated as a response to the user.

AssistantMessage(String) - Constructor for class org.springframework.ai.chat.messages.AssistantMessage

AssistantMessage(String, Map<String, Object>, List<AssistantMessage.ToolCall>, List<Media>) - Constructor for class org.springframework.ai.chat.messages.AssistantMessage

AssistantMessage(List<MessagePart>, Map<String, Object>) - Constructor for class org.springframework.ai.chat.messages.AssistantMessage

Creates a message from an ordered list of content parts, which may include ReasoningParts interleaved with the rest of the content.

AssistantMessage.Builder<B extends AssistantMessage.Builder<B>> - Class in org.springframework.ai.chat.messages

Builder for AssistantMessage.

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

ASYNC - Enum constant in enum class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties.ClientType

Asynchronous (McpAsyncClient) client

ASYNC - Enum constant in enum class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.ApiType

Asynchronous (McpAsyncServer) server

asyncCompaction(boolean) - Method in class org.springframework.ai.session.advisor.SessionAdvisors.Builder

Whether compaction runs after the call returns, on the scheduler; see SessionTurnAdvisor.Builder.asyncCompaction(boolean).

asyncCompaction(boolean) - Method in class org.springframework.ai.session.advisor.SessionTurnAdvisor.Builder

Whether compaction runs after the call returns, on the SessionTurnAdvisor.Builder.scheduler, so a summarizing strategy adds no model call to the reply's latency; false by default.

AsyncElicitationSpecification - Record Class in org.springframework.ai.mcp.annotation.method.elicitation

AsyncElicitationSpecification(String[], Function<McpSchema.ElicitRequest, Mono<McpSchema.ElicitResult>>) - Constructor for record class org.springframework.ai.mcp.annotation.method.elicitation.AsyncElicitationSpecification

Creates an instance of a AsyncElicitationSpecification record class.

AsyncLoggingSpecification - Record Class in org.springframework.ai.mcp.annotation.method.logging

AsyncLoggingSpecification(String[], Function<McpSchema.LoggingMessageNotification, Mono<Void>>) - Constructor for record class org.springframework.ai.mcp.annotation.method.logging.AsyncLoggingSpecification

Creates an instance of a AsyncLoggingSpecification record class.

AsyncMcpAnnotationProviders - Class in org.springframework.ai.mcp.annotation.spring

AsyncMcpCompleteMethodCallback - Class in org.springframework.ai.mcp.annotation.method.complete

Class for creating BiFunction callbacks around complete methods with asynchronous support.

AsyncMcpCompleteMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.complete

Builder for creating AsyncMcpCompleteMethodCallback instances.

AsyncMcpCompleteProvider - Class in org.springframework.ai.mcp.annotation.provider.complete

Provider for asynchronous MCP complete methods.

AsyncMcpCompleteProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.complete.AsyncMcpCompleteProvider

Create a new AsyncMcpCompletionProvider.

AsyncMcpElicitationMethodCallback - Class in org.springframework.ai.mcp.annotation.method.elicitation

Class for creating Function callbacks around elicitation methods that return Mono.

AsyncMcpElicitationMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.elicitation

Builder for creating AsyncMcpElicitationMethodCallback instances.

AsyncMcpElicitationProvider - Class in org.springframework.ai.mcp.annotation.provider.elicitation

Provider for asynchronous elicitation callbacks.

AsyncMcpElicitationProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.elicitation.AsyncMcpElicitationProvider

Create a new AsyncMcpElicitationProvider.

AsyncMcpLoggingMethodCallback - Class in org.springframework.ai.mcp.annotation.method.logging

Class for creating Function callbacks around logging consumer methods that return Mono.

AsyncMcpLoggingMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.logging

Builder for creating AsyncMcpLoggingConsumerMethodCallback instances.

AsyncMcpLoggingProvider - Class in org.springframework.ai.mcp.annotation.provider.logging

Provider for asynchronous logging consumer callbacks.

AsyncMcpLoggingProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.logging.AsyncMcpLoggingProvider

Create a new AsyncMcpLoggingConsumerProvider.

AsyncMcpProgressMethodCallback - Class in org.springframework.ai.mcp.annotation.method.progress

Asynchronous implementation of a progress method callback.

AsyncMcpProgressMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.progress

Builder for creating AsyncMcpProgressMethodCallback instances.

AsyncMcpProgressProvider - Class in org.springframework.ai.mcp.annotation.provider.progress

Provider for asynchronous progress callbacks.

AsyncMcpProgressProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.progress.AsyncMcpProgressProvider

Create a new AsyncMcpProgressProvider.

AsyncMcpPromptListChangedMethodCallback - Class in org.springframework.ai.mcp.annotation.method.changed.prompt

Class for creating Function callbacks around prompt list changed consumer methods that return Mono.

AsyncMcpPromptListChangedMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.changed.prompt

Builder for creating AsyncMcpPromptListChangedMethodCallback instances.

AsyncMcpPromptListChangedProvider - Class in org.springframework.ai.mcp.annotation.provider.changed.prompt

Provider for asynchronous prompt list changed consumer callbacks.

AsyncMcpPromptListChangedProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.changed.prompt.AsyncMcpPromptListChangedProvider

Create a new AsyncMcpPromptListChangedProvider.

AsyncMcpPromptMethodCallback - Class in org.springframework.ai.mcp.annotation.method.prompt

Class for creating BiFunction callbacks around prompt methods with asynchronous processing.

AsyncMcpPromptMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.prompt

Builder for creating AsyncMcpPromptMethodCallback instances.

AsyncMcpPromptProvider - Class in org.springframework.ai.mcp.annotation.provider.prompt

Provider for asynchronous MCP prompt methods.

AsyncMcpPromptProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.prompt.AsyncMcpPromptProvider

Create a new AsyncMcpPromptProvider.

AsyncMcpResourceListChangedMethodCallback - Class in org.springframework.ai.mcp.annotation.method.changed.resource

Class for creating Function callbacks around resource list changed consumer methods that return Mono.

AsyncMcpResourceListChangedMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.changed.resource

Builder for creating AsyncMcpResourceListChangedMethodCallback instances.

AsyncMcpResourceListChangedProvider - Class in org.springframework.ai.mcp.annotation.provider.changed.resource

Provider for asynchronous resource list changed consumer callbacks.

AsyncMcpResourceListChangedProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.changed.resource.AsyncMcpResourceListChangedProvider

Create a new AsyncMcpResourceListChangedProvider.

AsyncMcpResourceMethodCallback - Class in org.springframework.ai.mcp.annotation.method.resource

Class for creating BiFunction callbacks around resource methods with asynchronous processing.

AsyncMcpResourceMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.resource

Builder for creating AsyncMcpResourceMethodCallback instances.

AsyncMcpResourceProvider - Class in org.springframework.ai.mcp.annotation.provider.resource

Provider for asynchronous MCP resource methods.

AsyncMcpResourceProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.resource.AsyncMcpResourceProvider

Create a new AsyncMcpResourceProvider.

AsyncMcpSamplingMethodCallback - Class in org.springframework.ai.mcp.annotation.method.sampling

Class for creating Function callbacks around sampling methods that return Mono.

AsyncMcpSamplingMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.sampling

Builder for creating AsyncMcpSamplingMethodCallback instances.

AsyncMcpSamplingProvider - Class in org.springframework.ai.mcp.annotation.provider.sampling

Provider for asynchronous sampling callbacks.

AsyncMcpSamplingProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.sampling.AsyncMcpSamplingProvider

Create a new AsyncMcpSamplingProvider.

AsyncMcpToolCallback - Class in org.springframework.ai.mcp

Adapts MCP tools to Spring AI's ToolCallback interface with asynchronous execution.

AsyncMcpToolCallback(McpAsyncClient, McpSchema.Tool) - Constructor for class org.springframework.ai.mcp.AsyncMcpToolCallback

Deprecated.

use AsyncMcpToolCallback.Builder instead

AsyncMcpToolCallback.Builder - Class in org.springframework.ai.mcp

Builder for constructing AsyncMcpToolCallback instances.

AsyncMcpToolCallbackProvider - Class in org.springframework.ai.mcp

Provides MCP tools asynchronously from multiple MCP servers as Spring AI tool callbacks.

AsyncMcpToolCallbackProvider(McpAsyncClient...) - Constructor for class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider

Deprecated.

use AsyncMcpToolCallbackProvider.builder() instead

AsyncMcpToolCallbackProvider(List<McpAsyncClient>) - Constructor for class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider

Deprecated.

use AsyncMcpToolCallbackProvider.builder() instead

AsyncMcpToolCallbackProvider(McpToolFilter, McpAsyncClient...) - Constructor for class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider

Deprecated.

use AsyncMcpToolCallbackProvider.builder() instead

AsyncMcpToolCallbackProvider(McpToolFilter, List<McpAsyncClient>) - Constructor for class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider

Deprecated.

use AsyncMcpToolCallbackProvider.builder() instead

AsyncMcpToolCallbackProvider.Builder - Class in org.springframework.ai.mcp

Builder for AsyncMcpToolCallbackProvider configuration.

AsyncMcpToolListChangedMethodCallback - Class in org.springframework.ai.mcp.annotation.method.changed.tool

Class for creating Function callbacks around tool list changed consumer methods that return Mono.

AsyncMcpToolListChangedMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.changed.tool

Builder for creating AsyncMcpToolListChangedMethodCallback instances.

AsyncMcpToolListChangedProvider - Class in org.springframework.ai.mcp.annotation.provider.changed.tool

Provider for asynchronous tool list changed consumer callbacks.

AsyncMcpToolListChangedProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.changed.tool.AsyncMcpToolListChangedProvider

Create a new AsyncMcpToolListChangedProvider.

AsyncMcpToolMethodCallback - Class in org.springframework.ai.mcp.annotation.method.tool

Class for creating Function callbacks around tool methods.

AsyncMcpToolMethodCallback(ReturnMode, Method, Object) - Constructor for class org.springframework.ai.mcp.annotation.method.tool.AsyncMcpToolMethodCallback

AsyncMcpToolMethodCallback(ReturnMode, Method, Object, Class<? extends Throwable>) - Constructor for class org.springframework.ai.mcp.annotation.method.tool.AsyncMcpToolMethodCallback

Deprecated.

use AsyncMcpToolMethodCallback(ReturnMode, Method, Object). The toolCallExceptionClass argument is ignored: exception handling now follows the @Tool contract based on the exception type. Will be removed in 2.1.0.

AsyncMcpToolProvider - Class in org.springframework.ai.mcp.annotation.provider.tool

AsyncMcpToolProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.tool.AsyncMcpToolProvider

Create a new SyncMcpToolProvider.

AsyncProgressSpecification - Record Class in org.springframework.ai.mcp.annotation.method.progress

Specification for asynchronous progress handlers.

AsyncProgressSpecification(String[], Function<McpSchema.ProgressNotification, Mono<Void>>) - Constructor for record class org.springframework.ai.mcp.annotation.method.progress.AsyncProgressSpecification

Creates an instance of a AsyncProgressSpecification record class.

AsyncPromptListChangedSpecification - Record Class in org.springframework.ai.mcp.annotation.method.changed.prompt

AsyncPromptListChangedSpecification(String[], Function<List<McpSchema.Prompt>, Mono<Void>>) - Constructor for record class org.springframework.ai.mcp.annotation.method.changed.prompt.AsyncPromptListChangedSpecification

Creates an instance of a AsyncPromptListChangedSpecification record class.

asyncReadTimeout(Duration) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder

AsyncResourceListChangedSpecification - Record Class in org.springframework.ai.mcp.annotation.method.changed.resource

AsyncResourceListChangedSpecification(String[], Function<List<McpSchema.Resource>, Mono<Void>>) - Constructor for record class org.springframework.ai.mcp.annotation.method.changed.resource.AsyncResourceListChangedSpecification

Creates an instance of a AsyncResourceListChangedSpecification record class.

AsyncSamplingSpecification - Record Class in org.springframework.ai.mcp.annotation.method.sampling

AsyncSamplingSpecification(String[], Function<McpSchema.CreateMessageRequest, Mono<McpSchema.CreateMessageResult>>) - Constructor for record class org.springframework.ai.mcp.annotation.method.sampling.AsyncSamplingSpecification

Creates an instance of a AsyncSamplingSpecification record class.

AsyncStatelessMcpCompleteMethodCallback - Class in org.springframework.ai.mcp.annotation.method.complete

Class for creating BiFunction callbacks around complete methods with asynchronous processing for stateless contexts.

AsyncStatelessMcpCompleteMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.complete

Builder for creating AsyncStatelessMcpCompleteMethodCallback instances.

AsyncStatelessMcpCompleteProvider - Class in org.springframework.ai.mcp.annotation.provider.complete

Provider for asynchronous stateless MCP complete methods.

AsyncStatelessMcpCompleteProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.complete.AsyncStatelessMcpCompleteProvider

Create a new AsyncStatelessMcpCompleteProvider.

AsyncStatelessMcpPromptMethodCallback - Class in org.springframework.ai.mcp.annotation.method.prompt

Class for creating BiFunction callbacks around prompt methods with asynchronous processing for stateless contexts.

AsyncStatelessMcpPromptMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.prompt

Builder for creating AsyncStatelessMcpPromptMethodCallback instances.

AsyncStatelessMcpPromptProvider - Class in org.springframework.ai.mcp.annotation.provider.prompt

Provider for asynchronous stateless MCP prompt methods.

AsyncStatelessMcpPromptProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.prompt.AsyncStatelessMcpPromptProvider

Create a new AsyncStatelessMcpPromptProvider.

AsyncStatelessMcpResourceMethodCallback - Class in org.springframework.ai.mcp.annotation.method.resource

Class for creating BiFunction callbacks around resource methods with asynchronous processing for stateless contexts.

AsyncStatelessMcpResourceMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.resource

Builder for creating AsyncStatelessMcpResourceMethodCallback instances.

AsyncStatelessMcpResourceProvider - Class in org.springframework.ai.mcp.annotation.provider.resource

Provider for asynchronous stateless MCP resource methods.

AsyncStatelessMcpResourceProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.resource.AsyncStatelessMcpResourceProvider

Create a new AsyncStatelessMcpResourceProvider.

AsyncStatelessMcpToolMethodCallback - Class in org.springframework.ai.mcp.annotation.method.tool

Class for creating Function callbacks around async stateless tool methods.

AsyncStatelessMcpToolMethodCallback(ReturnMode, Method, Object) - Constructor for class org.springframework.ai.mcp.annotation.method.tool.AsyncStatelessMcpToolMethodCallback

AsyncStatelessMcpToolMethodCallback(ReturnMode, Method, Object, Class<? extends Throwable>) - Constructor for class org.springframework.ai.mcp.annotation.method.tool.AsyncStatelessMcpToolMethodCallback

Deprecated.

use AsyncStatelessMcpToolMethodCallback(ReturnMode, java.lang.reflect.Method, Object). The toolCallExceptionClass argument is ignored: exception handling now follows the @Tool contract based on the exception type. Will be removed in 2.1.0.

AsyncStatelessMcpToolProvider - Class in org.springframework.ai.mcp.annotation.provider.tool

Provider for asynchronous stateless MCP tool methods.

AsyncStatelessMcpToolProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.tool.AsyncStatelessMcpToolProvider

Create a new AsyncStatelessMcpToolProvider.

asyncToolCallbacks(List<McpAsyncClient>) - Static method in class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider

Creates a reactive stream of tool callbacks from multiple MCP clients.

AsyncToolListChangedSpecification - Record Class in org.springframework.ai.mcp.annotation.method.changed.tool

AsyncToolListChangedSpecification(String[], Function<List<McpSchema.Tool>, Mono<Void>>) - Constructor for record class org.springframework.ai.mcp.annotation.method.changed.tool.AsyncToolListChangedSpecification

Creates an instance of a AsyncToolListChangedSpecification record class.

asyncTools(ObjectProvider<List<ToolCallback>>, List<ToolCallback>, ObjectProvider<List<ToolCallbackProvider>>, ObjectProvider<ToolCallbackProvider>, McpServerProperties) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.StatelessToolCallbackConverterAutoConfiguration

asyncTools(ObjectProvider<List<ToolCallback>>, List<ToolCallback>, ObjectProvider<List<ToolCallbackProvider>>, ObjectProvider<ToolCallbackProvider>, McpServerProperties) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.ToolCallbackConverterAutoConfiguration

attributes() - Method in record class org.springframework.ai.chat.messages.part.MediaPart

Returns the value of the attributes record component.

attributes() - Method in interface org.springframework.ai.chat.messages.part.MessagePart

Free-form, serialization-safe attributes of this part, such as a streaming part index or a provider item id.

attributes() - Method in record class org.springframework.ai.chat.messages.part.ReasoningPart

Returns the value of the attributes record component.

attributes() - Method in record class org.springframework.ai.chat.messages.part.TextPart

Returns the value of the attributes record component.

attributes() - Method in record class org.springframework.ai.chat.messages.part.ToolCallPart

Returns the value of the attributes record component.

attributes() - Method in record class org.springframework.ai.chat.messages.part.ToolResultPart

Returns the value of the attributes record component.

attributes() - Method in record class org.springframework.ai.chat.messages.part.UnknownPart

Returns the value of the attributes record component.

audience() - Element in annotation interface org.springframework.ai.mcp.annotation.McpResource.McpAnnotations

Describes who the intended customer of this object or data is.

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

audioEncoding(GoogleGenAiAudioSpeechOptions.AudioEncoding) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.Builder

AudioObservationAutoConfiguration - Class in org.springframework.ai.model.audio.observation.autoconfigure

Auto-configuration for Spring AI text-to-speech and transcription model observations: the meter handlers that record the token usage of speech and transcription models, and the opt-in handlers that log the text given to a speech model and the transcript a transcription model returned.

AudioObservationAutoConfiguration() - Constructor for class org.springframework.ai.model.audio.observation.autoconfigure.AudioObservationAutoConfiguration

AudioParameters(OpenAiChatOptions.AudioParameters.Voice, OpenAiChatOptions.AudioParameters.AudioResponseFormat) - Constructor for record class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters

Creates an instance of a AudioParameters record class.

AudioPlayer - Class in org.springframework.ai.utils

AudioSpeechObservationProperties - Class in org.springframework.ai.model.audio.observation.autoconfigure

Configuration properties for text-to-speech model observations.

AudioSpeechObservationProperties() - Constructor for class org.springframework.ai.model.audio.observation.autoconfigure.AudioSpeechObservationProperties

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.

AudioTranscriptionObservationProperties - Class in org.springframework.ai.model.audio.observation.autoconfigure

Configuration properties for transcription model observations.

AudioTranscriptionObservationProperties() - Constructor for class org.springframework.ai.model.audio.observation.autoconfigure.AudioTranscriptionObservationProperties

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

augment(Query, List<Document>) - Method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter

augment(Query, List<Document>) - Method in interface org.springframework.ai.rag.generation.augmentation.QueryAugmenter

Augments the user query with contextual data.

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 extends Record> - 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<T>, Consumer<AugmentedArgumentEvent<T>>, boolean) - Constructor for class org.springframework.ai.tool.augment.AugmentedToolCallback

AugmentedToolCallbackProvider<T extends Record> - Class in org.springframework.ai.tool.augment

AugmentedToolCallbackProvider(Object, Class<T>, Consumer<AugmentedArgumentEvent<T>>, boolean) - Constructor for class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider

AugmentedToolCallbackProvider(ToolCallbackProvider, Class<T>, Consumer<AugmentedArgumentEvent<T>>, boolean) - Constructor for class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider

AugmentedToolCallbackProvider.Builder<T extends Record> - 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<SystemMessage, SystemMessage>) - 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<ToolInputSchemaAugmenter.AugmentedArgumentType>) - 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<UserMessage, UserMessage>) - Method in class org.springframework.ai.chat.prompt.Prompt

Augments the last user message in the prompt with the provided function.

AUTO - Enum constant in enum class org.springframework.ai.anthropic.AnthropicServiceTier

Use priority capacity if available, otherwise fall back to standard capacity.

AUTO - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.TextNormalizationMode

AUTO - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice.Mode

Model decides whether to call a function or return a natural language response.

AUTO - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl.ImageDetail

AUTO - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ToolChoice

AUTO - Static variable in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.ToolChoiceBuilder

Model can pick between generating a message or calling a function.

autoCacheThreshold - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

autoCacheThreshold(Integer) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

autoCacheTtl - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

autoCacheTtl(Duration) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

autoId(boolean) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore.Builder

Configures whether to use auto-generated IDs for documents.

AUTOINDEX - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

autoTruncate - Variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextParametersBuilder

autoTruncate(Boolean) - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.Builder

autoTruncate(Boolean) - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.Builder

autoTruncate(Boolean) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextParametersBuilder

availableForTiers() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the availableForTiers record component.

AWAITING_DECISION_METADATA_KEY - Static variable in record class org.springframework.ai.model.tool.ToolCallDecisions

The response metadata key under which a paused loop lists the keys of the tool calls that wait for a decision, as a List<String>.

awaitingDecision(ChatResponse) - Static method in record class org.springframework.ai.model.tool.ToolCallDecisions

The keys of the tool calls a paused loop waits on (see ToolCallDecisions.toolCallKeys(AssistantMessage)), or an empty list when the response is not a paused one.

AwsOpenSearchConnectionDetails - Interface in org.springframework.ai.vectorstore.opensearch.autoconfigure

azure(Boolean) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

azure(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

AZURE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by Azure.

AZURE - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

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

AzureAiSearchFilterExpressionConverter - Class in org.springframework.ai.vectorstore.azure

Converts Filter.Expression into Azure Search OData filter syntax.

AzureAiSearchFilterExpressionConverter(List<AzureVectorStore.MetadataField>) - Constructor for class org.springframework.ai.vectorstore.azure.AzureAiSearchFilterExpressionConverter

AzureOpenAiCredentials - Class in org.springframework.ai.openai.setup

Factory for adapting Azure credentials for use with OpenAI models hosted on Microsoft Foundry.

azureOpenAIServiceVersion(AzureOpenAIServiceVersion) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

azureOpenAIServiceVersion(AzureOpenAIServiceVersion) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

AzureVectorStore - Class in org.springframework.ai.vectorstore.azure

Uses Azure Cognitive Search as a backing vector store.

AzureVectorStore(AzureVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.azure.AzureVectorStore

Protected constructor that accepts a builder instance.

AzureVectorStore.Builder - Class in org.springframework.ai.vectorstore.azure

Builder class for creating AzureVectorStore instances.

AzureVectorStore.MetadataField - Record Class in org.springframework.ai.vectorstore.azure

AzureVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.azure.autoconfigure

Auto-configuration for Azure Vector Store.

AzureVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreAutoConfiguration

AzureVectorStoreProperties - Class in org.springframework.ai.vectorstore.azure.autoconfigure

Configuration properties for Azure Vector Store.

AzureVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

B

backend(Backend) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

Backoff() - Constructor for class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties.Backoff

BALLAD - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Voice

BALLAD - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.Voice

BAN - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.SafetyControlEnum

banReason() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the banReason record component.

base64() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageResponse.Artifacts

Returns the value of the base64 record component.

BASE64 - Enum constant in enum class org.springframework.ai.openai.OpenAiEmbeddingOptions.EncodingFormat

BaseAdvisor - Interface in org.springframework.ai.chat.client.advisor.api

Base advisor that implements common aspects of the CallAdvisor and StreamAdvisor, reducing the boilerplate code needed to implement an advisor.

BaseAdvisorChain - Interface in org.springframework.ai.chat.client.advisor.api

A base interface for advisor chains that can be used to chain multiple advisors together, both for call and stream advisors.

BaseAdvisorChain.Builder<B extends BaseAdvisorChain.Builder<B>> - Interface in org.springframework.ai.chat.client.advisor.api

Builder for creating a BaseAdvisorChain instance.

BaseChatMemoryAdvisor - Interface in org.springframework.ai.chat.client.advisor.api

Base interface for chat memory advisors.

basePath(String) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider.Builder

Deprecated.

Sets the project basePath as endpoint prefix where clients should send their JSON-RPC messages

baseUrl - Variable in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

baseUrl - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

baseUrl - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

baseUrl(String) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

baseUrl(String) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

baseUrl(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

baseUrl(String) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

baseUrl(String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi.Builder

baseUrl(String) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.Builder

baseUrl(String) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.Builder

baseUrl(String) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Builder

baseUrl(String) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider.Builder

Deprecated.

Sets the base URL for the server transport.

baseUrl(String) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.Builder

baseUrl(String) - Method in class org.springframework.ai.mistralai.api.MistralAiModerationApi.Builder

baseUrl(String) - Method in class org.springframework.ai.ollama.api.OllamaApi.Builder

BaseVectorStoreTests - Class in org.springframework.ai.test.vectorstore

Base test class for VectorStore implementations.

BaseVectorStoreTests() - Constructor for class org.springframework.ai.test.vectorstore.BaseVectorStoreTests

batch(List<Document>) - Method in interface org.springframework.ai.embedding.BatchingStrategy

EmbeddingModel implementations can call this method to optimize embedding tokens.

batch(List<Document>) - Method in class org.springframework.ai.embedding.TokenCountBatchingStrategy

batchingStrategy - Variable in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

batchingStrategy - Variable in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

batchingStrategy(BatchingStrategy) - Method in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

Sets the batching strategy.

batchingStrategy(BatchingStrategy) - Method in interface org.springframework.ai.vectorstore.VectorStore.Builder

Sets the batching strategy.

BatchingStrategy - Interface in org.springframework.ai.embedding

Contract for batching Document objects so that the call to embed them could be optimized.

beamWidth(int) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

Sets the beam width.

bean - Variable in class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback.AbstractBuilder

bean - Variable in class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback

bean - Variable in class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback.AbstractBuilder

bean - Variable in class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback

bean - Variable in class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback.AbstractBuilder

bean - Variable in class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback

bean - Variable in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

bean - Variable in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback

bean - Variable in class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback.AbstractBuilder

bean - Variable in class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback

bean - Variable in class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback.AbstractBuilder

bean - Variable in class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback

bean - Variable in class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback.AbstractBuilder

bean - Variable in class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback

bean - Variable in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback.AbstractBuilder

bean - Variable in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback

bean - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

bean - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

bean - Variable in class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback.AbstractBuilder

bean - Variable in class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback

bean(Object) - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback.AbstractBuilder

Set the bean instance that contains the method.

bean(Object) - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback.AbstractBuilder

Set the bean instance that contains the method.

bean(Object) - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback.AbstractBuilder

Set the bean instance that contains the method.

bean(Object) - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

Set the bean instance that contains the method.

bean(Object) - Method in class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback.AbstractBuilder

Set the bean instance that contains the method.

bean(Object) - Method in class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback.AbstractBuilder

Set the bean instance that contains the method.

bean(Object) - Method in class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback.AbstractBuilder

Set the bean instance that contains the method.

bean(Object) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback.AbstractBuilder

Set the bean instance that contains the method.

bean(Object) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

Set the bean instance that contains the method.

bean(Object) - Method in class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback.AbstractBuilder

Set the bean instance that contains the method.

beanFactory - Variable in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

beanMethods(Object) - Static method in class org.springframework.ai.mcp.annotation.spring.AnnotationProviderUtil

Returns the declared methods of the given bean, sorted by method name and parameter types.

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<T>) - Constructor for class org.springframework.ai.converter.BeanOutputConverter

Constructor to initialize with the target type's class.

BeanOutputConverter(Class<T>, JsonMapper) - Constructor for class org.springframework.ai.converter.BeanOutputConverter

Constructor to initialize with the target type's class, a custom JSON mapper, and a line endings normalizer to ensure consistent line endings on any platform.

BeanOutputConverter(Class<T>, JsonMapper, ResponseTextCleaner) - Constructor for class org.springframework.ai.converter.BeanOutputConverter

Constructor to initialize with the target type's class, a custom JSON mapper, and a custom text cleaner.

BeanOutputConverter(ParameterizedTypeReference<T>) - Constructor for class org.springframework.ai.converter.BeanOutputConverter

Constructor to initialize with the target class type reference.

BeanOutputConverter(ParameterizedTypeReference<T>, JsonMapper) - Constructor for class org.springframework.ai.converter.BeanOutputConverter

Constructor to initialize with the target class type reference, a custom JSON mapper, and a line endings normalizer to ensure consistent line endings on any platform.

BeanOutputConverter(ParameterizedTypeReference<T>, JsonMapper, ResponseTextCleaner) - Constructor for class org.springframework.ai.converter.BeanOutputConverter

Constructor to initialize with the target class type reference, a custom JSON mapper, and a custom text cleaner.

BearerTokenAuthenticationFilterFunction - Class in org.springframework.ai.vectorstore.gemfire

BearerTokenAuthenticationFilterFunction(String) - Constructor for class org.springframework.ai.vectorstore.gemfire.BearerTokenAuthenticationFilterFunction

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

BEDROCK_CONVERSE - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider

AI system provided by Bedrock Converse.

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

BEDROCK_KNOWLEDGE_BASE - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

BEDROCK_PROVIDER - Static variable in class org.springframework.ai.bedrock.converse.api.ConverseApiUtils

The OpaquePayload.provider() of parts produced by the Bedrock Converse chat model.

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

BedrockAwsConnectionConfiguration - Class in org.springframework.ai.model.bedrock.autoconfigure

Configuration for AWS connection.

BedrockAwsConnectionConfiguration() - Constructor for class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionConfiguration

BedrockAwsConnectionProperties - Class in org.springframework.ai.model.bedrock.autoconfigure

Configuration properties for Bedrock AWS connection.

BedrockAwsConnectionProperties() - Constructor for class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

BedrockCacheOptions - Class in org.springframework.ai.bedrock.converse.api

AWS Bedrock cache options for configuring prompt caching behavior.

BedrockCacheOptions(BedrockCacheStrategy, boolean) - Constructor for class org.springframework.ai.bedrock.converse.api.BedrockCacheOptions

BedrockCacheOptions(BedrockCacheStrategy, boolean, BedrockCacheTtl) - Constructor for class org.springframework.ai.bedrock.converse.api.BedrockCacheOptions

BedrockCacheOptions(BedrockCacheStrategy, boolean, BedrockCacheTtl, boolean) - Constructor for class org.springframework.ai.bedrock.converse.api.BedrockCacheOptions

BedrockCacheOptions.Builder - Class in org.springframework.ai.bedrock.converse.api

Builder for constructing BedrockCacheOptions instances.

BedrockCacheProperties - Class in org.springframework.ai.model.bedrock.converse.autoconfigure

BedrockCacheProperties() - Constructor for class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockCacheProperties

BedrockCacheStrategy - Enum Class in org.springframework.ai.bedrock.converse.api

Defines the caching strategy for AWS Bedrock prompt caching.

BedrockCacheTtl - Enum Class in org.springframework.ai.bedrock.converse.api

AWS Bedrock cache TTL options for specifying how long cached prompts remain valid.

BedrockChatOptions - Class in org.springframework.ai.bedrock.converse

The options to be used when sending a chat request to the Bedrock API.

BedrockChatOptions(String, Double, Integer, Double, Map<String, Object>, List<String>, Double, Integer, Double, List<ToolCallback>, Map<String, Object>, BedrockCacheOptions, String) - Constructor for class org.springframework.ai.bedrock.converse.BedrockChatOptions

BedrockChatOptions.AbstractBuilder<B extends BedrockChatOptions.AbstractBuilder<B>> - Class in org.springframework.ai.bedrock.converse

BedrockChatOptions.Builder - Class in org.springframework.ai.bedrock.converse

BedrockCohereEmbeddingAutoConfiguration - Class in org.springframework.ai.model.bedrock.cohere.autoconfigure

Auto-configuration for Bedrock Cohere Embedding Model.

BedrockCohereEmbeddingAutoConfiguration() - Constructor for class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingAutoConfiguration

BedrockCohereEmbeddingModel - Class in org.springframework.ai.bedrock.cohere

EmbeddingModel implementation that uses the Bedrock Cohere Embedding API.

BedrockCohereEmbeddingModel(CohereEmbeddingBedrockApi) - Constructor for class org.springframework.ai.bedrock.cohere.BedrockCohereEmbeddingModel

BedrockCohereEmbeddingModel(CohereEmbeddingBedrockApi, BedrockCohereEmbeddingOptions) - Constructor for class org.springframework.ai.bedrock.cohere.BedrockCohereEmbeddingModel

BedrockCohereEmbeddingOptions - Class in org.springframework.ai.bedrock.cohere

Options for the Bedrock Cohere embedding API.

BedrockCohereEmbeddingOptions(CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType, CohereEmbeddingBedrockApi.CohereEmbeddingRequest.Truncate) - Constructor for class org.springframework.ai.bedrock.cohere.BedrockCohereEmbeddingOptions

BedrockCohereEmbeddingOptions.Builder - Class in org.springframework.ai.bedrock.cohere

BedrockCohereEmbeddingProperties - Class in org.springframework.ai.model.bedrock.cohere.autoconfigure

Bedrock Cohere Embedding autoconfiguration properties.

BedrockCohereEmbeddingProperties() - Constructor for class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties

BedrockCohereEmbeddingProperties.Options - Class in org.springframework.ai.model.bedrock.cohere.autoconfigure

BedrockConverseProxyChatAutoConfiguration - Class in org.springframework.ai.model.bedrock.converse.autoconfigure

Auto-configuration for Bedrock Converse Proxy Chat Client.

BedrockConverseProxyChatAutoConfiguration() - Constructor for class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatAutoConfiguration

BedrockConverseProxyChatProperties - Class in org.springframework.ai.model.bedrock.converse.autoconfigure

Configuration properties for Bedrock Converse.

BedrockConverseProxyChatProperties() - Constructor for class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

BedrockConverseProxyChatProperties.Options - Class in org.springframework.ai.model.bedrock.converse.autoconfigure

BedrockKnowledgeBaseFilterExpressionConverter - Class in org.springframework.ai.vectorstore.bedrockknowledgebase

Converts Spring AI Filter.Expression to Bedrock Knowledge Base RetrievalFilter.

BedrockKnowledgeBaseFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseFilterExpressionConverter

BedrockKnowledgeBaseVectorStore - Class in org.springframework.ai.vectorstore.bedrockknowledgebase

Amazon Bedrock Knowledge Base implementation of VectorStore.

BedrockKnowledgeBaseVectorStore.Builder - Class in org.springframework.ai.vectorstore.bedrockknowledgebase

Builder for BedrockKnowledgeBaseVectorStore.

BedrockKnowledgeBaseVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure

Auto-configuration for Amazon Bedrock Knowledge Base Vector Store.

BedrockKnowledgeBaseVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreAutoConfiguration

BedrockKnowledgeBaseVectorStoreProperties - Class in org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure

Configuration properties for Amazon Bedrock Knowledge Base VectorStore.

BedrockKnowledgeBaseVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreProperties

BedrockMediaFormat - Class in org.springframework.ai.bedrock.converse.api

The BedrockMediaFormat class provides mappings between MIME types and their corresponding Bedrock media formats for documents, images, and videos.

BedrockMediaFormat() - Constructor for class org.springframework.ai.bedrock.converse.api.BedrockMediaFormat

bedrockProxyChatModel(AwsCredentialsProvider, AwsRegionProvider, BedrockAwsConnectionProperties, BedrockConverseProxyChatProperties, ToolCallingManager, ObjectProvider<ObservationRegistry>, ObjectProvider<ChatModelObservationConvention>, ObjectProvider<BedrockRuntimeClient>, ObjectProvider<BedrockRuntimeAsyncClient>) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatAutoConfiguration

BedrockProxyChatModel - Class in org.springframework.ai.bedrock.converse

A ChatModel implementation that uses the Amazon Bedrock Converse API to interact with the Supported models.

BedrockProxyChatModel(BedrockRuntimeClient, BedrockRuntimeAsyncClient, BedrockChatOptions, ObservationRegistry, ToolCallingManager) - Constructor for class org.springframework.ai.bedrock.converse.BedrockProxyChatModel

BedrockProxyChatModel(BedrockRuntimeClient, BedrockRuntimeAsyncClient, BedrockChatOptions, ObservationRegistry, ToolCallingManager, MediaFetcher) - Constructor for class org.springframework.ai.bedrock.converse.BedrockProxyChatModel

BedrockProxyChatModel.Builder - Class in org.springframework.ai.bedrock.converse

bedrockRuntimeAsyncClient(BedrockRuntimeAsyncClient) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder

bedrockRuntimeClient(BedrockRuntimeClient) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder

BedrockRuntimeHints - Class in org.springframework.ai.bedrock.aot

The BedrockRuntimeHints class is responsible for registering runtime hints for Bedrock AI API classes.

BedrockTitanEmbeddingAutoConfiguration - Class in org.springframework.ai.model.bedrock.titan.autoconfigure

Auto-configuration for Bedrock Titan Embedding Model.

BedrockTitanEmbeddingAutoConfiguration() - Constructor for class org.springframework.ai.model.bedrock.titan.autoconfigure.BedrockTitanEmbeddingAutoConfiguration

BedrockTitanEmbeddingModel - Class in org.springframework.ai.bedrock.titan

EmbeddingModel implementation that uses the Bedrock Titan Embedding API.

BedrockTitanEmbeddingModel(TitanEmbeddingBedrockApi, ObservationRegistry) - Constructor for class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingModel

BedrockTitanEmbeddingModel.InputType - Enum Class in org.springframework.ai.bedrock.titan

BedrockTitanEmbeddingOptions - Class in org.springframework.ai.bedrock.titan

Options for the Titan Embedding API.

BedrockTitanEmbeddingOptions(BedrockTitanEmbeddingModel.InputType) - Constructor for class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingOptions

BedrockTitanEmbeddingOptions.Builder - Class in org.springframework.ai.bedrock.titan

BedrockTitanEmbeddingProperties - Class in org.springframework.ai.model.bedrock.titan.autoconfigure

Bedrock Titan Embedding autoconfiguration properties.

BedrockTitanEmbeddingProperties() - Constructor for class org.springframework.ai.model.bedrock.titan.autoconfigure.BedrockTitanEmbeddingProperties

before(ChatClientRequest, AdvisorChain) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor

before(ChatClientRequest, AdvisorChain) - Method in class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor

Not used for semantic cache advisor since we override adviseCall/adviseStream.

before(ChatClientRequest, AdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor

Logic to be executed before the rest of the advisor chain is called.

before(ChatClientRequest, AdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor

Deprecated.

before(ChatClientRequest, AdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor

before(ChatClientRequest, AdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor

before(ChatClientRequest, AdvisorChain) - Method in class org.springframework.ai.session.advisor.SessionMemoryAdvisor

before(ChatClientRequest, AdvisorChain) - Method in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorAutoRegistrationIT.ChainIterationCountingAdvisor

betaPrefixPath(String) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.Builder

BIGSERIAL - Enum constant in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgIdType

BIN_FLAT - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

BIN_IVF_FLAT - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

BINARY - Enum constant in enum class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore.IndexType

Use Binary Quantization-based vector index

BLOB - Enum constant in enum class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.ContentType

Binary blob content type.

BLOCK_LOW_AND_ABOVE - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmBlockThreshold

BLOCK_LOW_AND_ABOVE - Enum constant in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.SafetyFilterLevel

BLOCK_MEDIUM_AND_ABOVE - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmBlockThreshold

BLOCK_MEDIUM_AND_ABOVE - Enum constant in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.SafetyFilterLevel

BLOCK_NONE - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmBlockThreshold

BLOCK_NONE - Enum constant in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.SafetyFilterLevel

BLOCK_ONLY_HIGH - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmBlockThreshold

BLOCK_ONLY_HIGH - Enum constant in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.SafetyFilterLevel

blockedDomains(List<String>) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool.Builder

BM25 - Enum constant in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.TextScorer

BM25STD - Enum constant in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.TextScorer

Booking(String, String) - Constructor for record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.Booking

Creates an instance of a Booking record class.

BookingRequest(String) - Constructor for record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.BookingRequest

Creates an instance of a BookingRequest record class.

bookingTool() - Method in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT

The booking tool, marked to need a person's confirmation.

bool(String) - Static method in record class org.springframework.ai.vectorstore.azure.AzureVectorStore.MetadataField

bool(String) - Static method in record class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.MetadataField

Creates a metadata field of type BOOLEAN.

BOOLEAN - Enum constant in enum class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.MetadataField.Type

BOOLEAN_VALUE - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

BOOLEAN_VALUE - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

BOOLEAN_VALUE() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.BooleanConstantContext

BooleanConstantContext(FiltersParser.ConstantContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.BooleanConstantContext

booleanExpression() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.AndExpressionContext

booleanExpression() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

booleanExpression() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.GroupExpressionContext

booleanExpression() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NotExpressionContext

booleanExpression() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.OrExpressionContext

booleanExpression() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.WhereContext

booleanExpression(int) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.AndExpressionContext

booleanExpression(int) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.OrExpressionContext

BooleanExpressionContext() - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.BooleanExpressionContext

BooleanExpressionContext(ParserRuleContext, int) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.BooleanExpressionContext

bottomRightX() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.ExtractedImage

Returns the value of the bottomRightX record component.

bottomRightY() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.ExtractedImage

Returns the value of the bottomRightY record component.

bucketName(String) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.Builder

Configures the Couchbase bucket, parent of the selected Scope.

buckets(int) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

Sets the number of buckets.

build() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder

build() - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder

Builds a new AnthropicChatModel instance.

build() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

build() - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder

Build the AnthropicCitationDocument.

build() - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder

build() - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord.Builder

build() - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool.Builder

build() - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

build() - Method in class org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationContext.Builder

build() - Method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions.Builder

build() - Method in class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationContext.Builder

build() - Method in interface org.springframework.ai.audio.tts.TextToSpeechOptions.Builder

Builds the TextToSpeechOptions.

build() - Method in class org.springframework.ai.bedrock.cohere.BedrockCohereEmbeddingOptions.Builder

build() - Method in class org.springframework.ai.bedrock.converse.api.BedrockCacheOptions.Builder

Builds the BedrockCacheOptions instance.

build() - Method in class org.springframework.ai.bedrock.converse.api.StreamingToolCallBuilder

build() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions.AbstractBuilder

build() - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder

build() - Method in class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingRequest.Builder

build() - Method in class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingOptions.Builder

build() - Method in class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor.Builder

Builds and returns a new SemanticCacheAdvisor instance.

build() - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisorChain.Builder

Builds and returns the BaseAdvisorChain.

build() - Method in class org.springframework.ai.chat.client.advisor.ChatModelCallAdvisor.Builder

build() - Method in class org.springframework.ai.chat.client.advisor.ChatModelStreamAdvisor.Builder

build() - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder

build() - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor.Builder

Deprecated.

Build the advisor.

build() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder

build() - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor.Builder

build() - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor.Builder

build() - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder

Builds the StructuredOutputValidationAdvisor.

build() - Method in class org.springframework.ai.chat.client.advisor.ToolCallAdvisor.Builder

Deprecated, for removal: This API element is subject to removal in a future version.

build() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder

Builds and returns a new ToolCallingAdvisor instance with the configured properties.

build() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor.Builder

Builds and returns a new ToolSearchToolCallingAdvisor instance with the configured properties.

build() - Method in class org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor.Builder

build() - Method in class org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor.Builder

Build the advisor.

build() - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

build() - Method in class org.springframework.ai.chat.client.ChatClientRequest.Builder

build() - Method in class org.springframework.ai.chat.client.ChatClientResponse.Builder

build() - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

build() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder

build() - Method in class org.springframework.ai.chat.evaluation.FactCheckingEvaluator.Builder

build() - Method in class org.springframework.ai.chat.evaluation.RelevancyEvaluator.Builder

build() - Method in class org.springframework.ai.chat.memory.MessageWindowChatMemory.Builder

Deprecated.

build() - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.Builder

Deprecated.

build() - Method in class org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepository.Builder

Deprecated.

build() - Method in class org.springframework.ai.chat.memory.repository.mongo.MongoChatMemoryRepository.Builder

Deprecated.

build() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

build() - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig.Builder

Deprecated.

Builds a new RedisChatMemoryConfig instance.

build() - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository.Builder

Deprecated.

Builds and returns an instance of RedisChatMemoryRepository.

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.chroma.vectorstore.ChromaApi.Builder

build() - Method in class org.springframework.ai.chroma.vectorstore.ChromaVectorStore.Builder

Builds the ChromaVectorStore instance.

build() - Method in class org.springframework.ai.content.Media.Builder

Builds a new Media instance with the configured properties.

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.deepseek.api.DeepSeekApi.Builder

build() - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Build the DeepSeekApi.ChatCompletionRequest.

build() - Method in class org.springframework.ai.deepseek.api.ResponseFormat.Builder

build() - Method in class org.springframework.ai.deepseek.DeepSeekAssistantMessage.AbstractBuilder

Deprecated.

build() - Method in class org.springframework.ai.deepseek.DeepSeekChatModel.Builder

build() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

build() - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder

Returns the immutable configuration.

build() - Method in class org.springframework.ai.document.Document.Builder

Builds the Document.

build() - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.Builder

build() - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.Builder

build() - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Builder

build() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel.Builder

build() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

build() - Method in class org.springframework.ai.embedding.DefaultEmbeddingOptions.Builder

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.google.genai.cache.CachedContentRequest.Builder

build() - Method in class org.springframework.ai.google.genai.cache.CachedContentUpdateRequest.Builder

build() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent.Builder

build() - Method in class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.Builder

build() - Method in class org.springframework.ai.google.genai.embedding.GoogleGenAiEmbeddingConnectionDetails.Builder

build() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatModel.Builder

build() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

build() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice.Builder

build() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageConnectionDetails.Builder

build() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

build() - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.Builder

build() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

build() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionConnectionDetails.Builder

build() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionModel.Builder

Builds a new GoogleGenAiTranscriptionModel instance.

build() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.Builder

build() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechConnectionDetails.Builder

build() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechModel.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.mcp.annotation.context.DefaultMcpAsyncRequestContext.Builder

build() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext.Builder

build() - Method in class org.springframework.ai.mcp.annotation.context.StructuredElicitResult.Builder

Builds the StructuredElicitResult instance.

build() - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback.AbstractBuilder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.AsyncMcpPromptListChangedMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.SyncMcpPromptListChangedMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback.AbstractBuilder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.AsyncMcpResourceListChangedMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.SyncMcpResourceListChangedMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback.AbstractBuilder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.AsyncMcpToolListChangedMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.SyncMcpToolListChangedMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.complete.AsyncMcpCompleteMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.complete.AsyncStatelessMcpCompleteMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.complete.SyncMcpCompleteMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.complete.SyncStatelessMcpCompleteMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback.AbstractBuilder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.elicitation.AsyncMcpElicitationMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.elicitation.SyncMcpElicitationMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback.AbstractBuilder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.logging.AsyncMcpLoggingMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.logging.SyncMcpLoggingMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback.AbstractBuilder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.progress.AsyncMcpProgressMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.progress.SyncMcpProgressMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback.AbstractBuilder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.prompt.AsyncMcpPromptMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.prompt.AsyncStatelessMcpPromptMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.prompt.SyncMcpPromptMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.prompt.SyncStatelessMcpPromptMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.resource.AsyncMcpResourceMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.resource.AsyncStatelessMcpResourceMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.resource.SyncMcpResourceMethodCallback.Builder

build() - Method in class org.springframework.ai.mcp.annotation.method.resource.SyncStatelessMcpResourceMethodCallback.Builder

build() - Method in class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback.AbstractBuilder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.sampling.AsyncMcpSamplingMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.annotation.method.sampling.SyncMcpSamplingMethodCallback.Builder

Build the callback.

build() - Method in class org.springframework.ai.mcp.AsyncMcpToolCallback.Builder

Builds an AsyncMcpToolCallback with the configured parameters.

build() - Method in class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider.Builder

build() - Method in class org.springframework.ai.mcp.client.webflux.transport.WebClientStreamableHttpTransport.Builder

Construct a fresh instance of WebClientStreamableHttpTransport using the current builder configuration.

build() - Method in class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport.Builder

Deprecated.

Builds a new WebFluxSseClientTransport instance.

build() - Method in class org.springframework.ai.mcp.McpConnectionInfo.Builder

Builds and returns a new McpConnectionInfo instance with the configured values.

build() - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider.Builder

Deprecated.

Builds a new instance of WebFluxSseServerTransportProvider with the configured settings.

build() - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStatelessServerTransport.Builder

Builds a new instance of WebFluxStatelessServerTransport with the configured settings.

build() - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider.Builder

Builds a new instance of WebFluxStreamableServerTransportProvider with the configured settings.

build() - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider.Builder

Deprecated.

Builds a new instance of WebMvcSseServerTransportProvider with the configured settings.

build() - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStatelessServerTransport.Builder

Builds a new instance of WebMvcStatelessServerTransport with the configured settings.

build() - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider.Builder

Builds a new instance of WebMvcStreamableServerTransportProvider with the configured settings.

build() - Method in class org.springframework.ai.mcp.SyncMcpToolCallback.Builder

Builds a SyncMcpToolCallback with the configured parameters.

build() - Method in class org.springframework.ai.mcp.SyncMcpToolCallbackProvider.Builder

Builds the provider with configured parameters.

build() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.Builder

build() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.Builder

build() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema.Builder

build() - Method in class org.springframework.ai.mistralai.api.MistralAiModerationApi.Builder

build() - Method in class org.springframework.ai.mistralai.MistralAiChatModel.Builder

build() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder

build() - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingModel.Builder

build() - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingOptions.Builder

build() - Method in class org.springframework.ai.mistralai.moderation.MistralAiModerationModel.Builder

build() - Method in class org.springframework.ai.mistralai.moderation.MistralAiModerationOptions.Builder

build() - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions.Builder

build() - Method in class org.springframework.ai.model.tool.DefaultStructuredOutputChatOptions.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.observation.AiOperationMetadata.Builder

Build the AiOperationMetadata instance.

build() - Method in class org.springframework.ai.ollama.api.OllamaApi.Builder

build() - Method in class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

build() - Method in class org.springframework.ai.ollama.api.OllamaApi.Message.Builder

build() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

build() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

build() - Method in class org.springframework.ai.ollama.management.ModelManagementOptions.Builder

build() - Method in class org.springframework.ai.ollama.OllamaChatModel.Builder

build() - Method in class org.springframework.ai.ollama.OllamaEmbeddingModel.Builder

build() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

build() - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

build() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel.Builder

Builds the OpenAiAudioSpeechModel instance.

build() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder

build() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel.Builder

Builds a new OpenAiAudioTranscriptionModel instance.

build() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder

build() - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder

Builds a new OpenAiChatModel instance.

build() - Method in class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat.Builder

build() - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

build() - Method in class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions.Builder

build() - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel.Builder

build() - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder

build() - Method in class org.springframework.ai.openai.OpenAiImageModel.Builder

build() - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder

build() - Method in class org.springframework.ai.openai.OpenAiModerationModel.Builder

build() - Method in class org.springframework.ai.openai.OpenAiModerationOptions.Builder

build() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatModel.Builder

build() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

build() - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions.Builder

build() - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder

build() - Method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter.Builder

build() - Method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander.Builder

build() - Method in class org.springframework.ai.rag.preretrieval.query.transformation.CompressionQueryTransformer.Builder

build() - Method in class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer.Builder

build() - Method in class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer.Builder

build() - Method in class org.springframework.ai.rag.Query.Builder

build() - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever.Builder

build() - Method in class org.springframework.ai.reader.ExtractedTextFormatter.Builder

Constructs and returns an instance of ExtractedTextFormatter using the configurations set on this builder.

build() - Method in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig.Builder

build() - Method in class org.springframework.ai.reader.markdown.config.MarkdownDocumentReaderConfig.Builder

build() - Method in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig.Builder

Returns the immutable configuration.

build() - Method in class org.springframework.ai.session.advisor.SessionAdvisors.Builder

The advisors, in their order: the turn, then the memory.

build() - Method in class org.springframework.ai.session.advisor.SessionMemoryAdvisor.Builder

build() - Method in class org.springframework.ai.session.advisor.SessionTurnAdvisor.Builder

build() - Method in class org.springframework.ai.session.compaction.ChatModelSummarizer.Builder

build() - Method in class org.springframework.ai.session.compaction.TokenCountTrigger.Builder

build() - Method in class org.springframework.ai.session.compaction.WindowCompactionStrategy.Builder

build() - Method in class org.springframework.ai.session.CreateSessionRequest.Builder

build() - Method in class org.springframework.ai.session.DefaultSessionService.Builder

Builds the service.

build() - Method in class org.springframework.ai.session.EventFilter.Builder

build() - Method in class org.springframework.ai.session.InMemorySessionRepository.Builder

Builds the repository.

build() - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository.Builder

Builds the repository.

build() - Method in class org.springframework.ai.session.Session.Builder

build() - Method in class org.springframework.ai.session.SessionEvent.Builder

Builds the event, checking that the type and the message agree.

build() - Method in class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.Builder

build() - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions.Builder

build() - Method in class org.springframework.ai.template.st.StTemplateRenderer.Builder

Builds and returns a new StTemplateRenderer instance with the configured settings.

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.toolsearch.ToolReference.Builder

build() - Method in class org.springframework.ai.tool.toolsearch.ToolSearchResponse.Builder

build() - Method in class org.springframework.ai.tool.toolsearch.ToolSearchResponse.SearchMetadata.Builder

build() - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder

build() - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore.Builder

build() - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore.Builder

Builds the BedrockKnowledgeBaseVectorStore.

build() - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

build() - Method in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore.Builder

build() - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.Builder

build() - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore.Builder

Builds the ElasticsearchVectorStore instance.

build() - Method in record class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder.Op

build() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

build() - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBBuilder

Builds and returns a new MariaDBVectorStore instance with the configured settings.

build() - Method in class org.springframework.ai.vectorstore.milvus.MilvusSearchRequest.MilvusBuilder

Builds and returns a MilvusSearchRequest instance.

build() - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore.Builder

Builds and returns a new MilvusVectorStore instance with the configured settings.

build() - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.Builder

Builds the MongoDBAtlasVectorStore instance.

build() - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Builder

build() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder

build() - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.Builder

Builds a new OpenSearchVectorStore instance with the configured properties.

build() - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore.Builder

build() - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgVectorStoreBuilder

build() - Method in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore.Builder

Builds a new PineconeVectorStore instance with the configured properties.

build() - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore.Builder

Builds and returns a new QdrantVectorStore instance with the configured settings.

build() - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache.Builder

build() - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

build() - Method in class org.springframework.ai.vectorstore.s3.S3VectorStore.Builder

build() - Method in class org.springframework.ai.vectorstore.SearchRequest.Builder

build() - Method in class org.springframework.ai.vectorstore.SimpleVectorStore.SimpleVectorStoreBuilder

build() - Method in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore.Builder

build() - Method in interface org.springframework.ai.vectorstore.VectorStore.Builder

Builds and returns a new VectorStore instance with the configured settings.

build() - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.Builder

Builds and returns a new WeaviateVectorStore instance with the configured settings.

build() - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions.Builder

build() - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.Builder

build() - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails.Builder

build() - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.ImageBuilder

build() - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.MultimodalInstanceBuilder

build() - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextInstanceBuilder

build() - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextParametersBuilder

build() - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

buildArgs(Method, Object, McpSchema.CompleteRequest) - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback

Builds the arguments array for invoking the method.

buildArgs(Method, Object, McpSchema.CreateMessageRequest) - Method in class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback

Builds the arguments array for invoking the method.

buildArgs(Method, Object, McpSchema.ElicitRequest) - Method in class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback

Builds the arguments array for invoking the method.

buildArgs(Method, Object, McpSchema.GetPromptRequest) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback

Builds the arguments array for invoking the method.

buildArgs(Method, Object, McpSchema.LoggingMessageNotification) - Method in class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback

Builds the arguments array for invoking the method.

buildArgs(Method, Object, McpSchema.ProgressNotification) - Method in class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback

Builds the arguments array for invoking the method.

buildArgs(Method, Object, McpSchema.ReadResourceRequest, Map<String, String>) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

Builds the arguments array for invoking the method.

buildArgs(Method, Object, List<McpSchema.Prompt>) - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback

Builds the arguments array for invoking the method.

buildArgs(Method, Object, List<McpSchema.Resource>) - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback

Builds the arguments array for invoking the method.

buildArgs(Method, Object, List<McpSchema.Tool>) - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback

Builds the arguments array for invoking the method.

buildArgsWithoutUriVariables(Parameter[], Object[], Object, McpSchema.ReadResourceRequest) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

Builds arguments for methods without URI variables.

buildArgsWithUriVariables(Parameter[], Object[], Object, McpSchema.ReadResourceRequest, Map<String, String>) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

Builds arguments for methods with URI variables.

builder() - Static method in class org.springframework.ai.anthropic.AnthropicCacheOptions

builder() - Static method in class org.springframework.ai.anthropic.AnthropicChatModel

Creates a new builder for AnthropicChatModel.

builder() - Static method in class org.springframework.ai.anthropic.AnthropicChatOptions

Creates a new builder for AnthropicChatOptions.

builder() - Static method in class org.springframework.ai.anthropic.AnthropicCitationDocument

builder() - Static method in class org.springframework.ai.anthropic.AnthropicSkillContainer

builder() - Static method in class org.springframework.ai.anthropic.AnthropicSkillRecord

builder() - Static method in class org.springframework.ai.anthropic.AnthropicWebSearchTool

builder() - Static method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient

builder() - Static method in class org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationContext

builder() - Static method in class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions

builder() - Static method in class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationContext

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.bedrock.cohere.BedrockCohereEmbeddingOptions

builder() - Static method in class org.springframework.ai.bedrock.converse.api.BedrockCacheOptions

Creates a new builder for constructing BedrockCacheOptions.

builder() - Static method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

builder() - Static method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel

builder() - Static method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingRequest

builder() - Static method in class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingOptions

builder() - Static method in class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor

Creates a new builder for constructing SemanticCacheAdvisor instances.

builder() - Static method in class org.springframework.ai.chat.client.advisor.ChatModelCallAdvisor

builder() - Static method in class org.springframework.ai.chat.client.advisor.ChatModelStreamAdvisor

builder() - Static method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext

Create a new AdvisorObservationContext.Builder instance.

builder() - Static method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor

builder() - Static method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

builder() - Static method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor

Returns a new StructuredOutputValidationAdvisor.Builder.

builder() - Static method in class org.springframework.ai.chat.client.advisor.ToolCallAdvisor

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0 in favor of ToolCallingAdvisor.builder().

builder() - Static method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

Creates a new Builder instance for constructing a ToolCallingAdvisor.

builder() - Static method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor

Creates a new Builder instance for constructing a ToolSearchToolCallingAdvisor.

builder() - Static method in record class org.springframework.ai.chat.client.ChatClientRequest

builder() - Static method in record class org.springframework.ai.chat.client.ChatClientResponse

builder() - Static method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext

builder() - Static method in class org.springframework.ai.chat.evaluation.RelevancyEvaluator

builder() - Static method in class org.springframework.ai.chat.memory.MessageWindowChatMemory

Deprecated.

builder() - Static method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig

Deprecated.

builder() - Static method in class org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepository

Deprecated.

builder() - Static method in class org.springframework.ai.chat.memory.repository.mongo.MongoChatMemoryRepository

Deprecated.

builder() - Static method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig

Deprecated.

builder() - Static method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig

Deprecated.

builder() - Static method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

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.chroma.vectorstore.ChromaApi

builder() - Static method in class org.springframework.ai.content.Media

Creates a new Media builder.

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 class org.springframework.ai.deepseek.api.DeepSeekApi

builder() - Static method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Create a new DeepSeekApi.ChatCompletionRequest builder.

builder() - Static method in class org.springframework.ai.deepseek.api.ResponseFormat

builder() - Static method in class org.springframework.ai.deepseek.DeepSeekAssistantMessage

Deprecated.

builder() - Static method in class org.springframework.ai.deepseek.DeepSeekChatModel

builder() - Static method in class org.springframework.ai.deepseek.DeepSeekChatOptions

builder() - Static method in class org.springframework.ai.document.DefaultContentFormatter

Start building a new configuration.

builder() - Static method in class org.springframework.ai.document.Document

builder() - Static method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi

builder() - Static method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

builder() - Static method in class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi

builder() - Static method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel

builder() - Static method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

builder() - Static method in class org.springframework.ai.embedding.DefaultEmbeddingOptions

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.google.genai.cache.CachedContentRequest

builder() - Static method in class org.springframework.ai.google.genai.cache.CachedContentUpdateRequest

builder() - Static method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

builder() - Static method in class org.springframework.ai.google.genai.embedding.GoogleGenAiEmbeddingConnectionDetails

builder() - Static method in class org.springframework.ai.google.genai.GoogleGenAiChatModel

builder() - Static method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

builder() - Static method in record class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice

builder() - Static method in class org.springframework.ai.google.genai.image.GoogleGenAiImageConnectionDetails

builder() - Static method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

builder() - Static method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions

builder() - Static method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

builder() - Static method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionConnectionDetails

builder() - Static method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionModel

Creates a new builder for GoogleGenAiTranscriptionModel.

builder() - Static method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

builder() - Static method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechConnectionDetails

builder() - Static method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechModel

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.mcp.annotation.context.DefaultMcpAsyncRequestContext

builder() - Static method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

builder() - Static method in record class org.springframework.ai.mcp.annotation.context.StructuredElicitResult

builder() - Static method in class org.springframework.ai.mcp.annotation.method.changed.prompt.AsyncMcpPromptListChangedMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.changed.prompt.SyncMcpPromptListChangedMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.changed.resource.AsyncMcpResourceListChangedMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.changed.resource.SyncMcpResourceListChangedMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.changed.tool.AsyncMcpToolListChangedMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.changed.tool.SyncMcpToolListChangedMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.complete.AsyncMcpCompleteMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.complete.AsyncStatelessMcpCompleteMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.complete.SyncMcpCompleteMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.complete.SyncStatelessMcpCompleteMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.elicitation.AsyncMcpElicitationMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.elicitation.SyncMcpElicitationMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.logging.AsyncMcpLoggingMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.logging.SyncMcpLoggingMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.progress.AsyncMcpProgressMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.progress.SyncMcpProgressMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.prompt.AsyncMcpPromptMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.prompt.AsyncStatelessMcpPromptMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.prompt.SyncMcpPromptMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.prompt.SyncStatelessMcpPromptMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.resource.AsyncMcpResourceMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.resource.AsyncStatelessMcpResourceMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.resource.SyncMcpResourceMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.resource.SyncStatelessMcpResourceMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.sampling.AsyncMcpSamplingMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.annotation.method.sampling.SyncMcpSamplingMethodCallback

Create a new builder.

builder() - Static method in class org.springframework.ai.mcp.AsyncMcpToolCallback

Creates a builder for constructing AsyncMcpToolCallback instances.

builder() - Static method in class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider

Creates a builder for constructing provider instances.

builder() - Static method in record class org.springframework.ai.mcp.McpConnectionInfo

Creates a new Builder instance for constructing McpConnectionInfo.

builder() - Static method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider

Deprecated.

builder() - Static method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStatelessServerTransport

Create a builder for the server.

builder() - Static method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider

builder() - Static method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider

Deprecated.

Creates a new Builder instance for configuring and creating instances of WebMvcSseServerTransportProvider.

builder() - Static method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStatelessServerTransport

Create a builder for the server.

builder() - Static method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider

builder() - Static method in class org.springframework.ai.mcp.SyncMcpToolCallback

Creates a builder for constructing SyncMcpToolCallback instances.

builder() - Static method in class org.springframework.ai.mcp.SyncMcpToolCallbackProvider

Creates a builder for constructing provider instances.

builder() - Static method in class org.springframework.ai.mistralai.api.MistralAiApi

builder() - Static method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

builder() - Static method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema

builder() - Static method in class org.springframework.ai.mistralai.api.MistralAiModerationApi

builder() - Static method in class org.springframework.ai.mistralai.MistralAiChatModel

builder() - Static method in class org.springframework.ai.mistralai.MistralAiChatOptions

builder() - Static method in class org.springframework.ai.mistralai.MistralAiEmbeddingModel

builder() - Static method in class org.springframework.ai.mistralai.MistralAiEmbeddingOptions

builder() - Static method in class org.springframework.ai.mistralai.moderation.MistralAiModerationModel

builder() - Static method in class org.springframework.ai.mistralai.moderation.MistralAiModerationOptions

builder() - Static method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions

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.StructuredOutputChatOptions

A builder to create a new StructuredOutputChatOptions instance.

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 record class org.springframework.ai.observation.AiOperationMetadata

Create a new AiOperationMetadata.Builder instance.

builder() - Static method in class org.springframework.ai.ollama.api.OllamaApi

builder() - Static method in class org.springframework.ai.ollama.api.OllamaChatOptions

builder() - Static method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

builder() - Static method in record class org.springframework.ai.ollama.management.ModelManagementOptions

builder() - Static method in class org.springframework.ai.ollama.OllamaChatModel

builder() - Static method in class org.springframework.ai.ollama.OllamaEmbeddingModel

builder() - Static method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient

builder() - Static method in class org.springframework.ai.openai.OpenAiAudioSpeechModel

Creates a new builder instance with default configuration.

builder() - Static method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions

builder() - Static method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel

Creates a new builder for OpenAiAudioTranscriptionModel.

builder() - Static method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

builder() - Static method in class org.springframework.ai.openai.OpenAiChatModel

Creates a new builder for OpenAiChatModel.

builder() - Static method in class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat

builder() - Static method in class org.springframework.ai.openai.OpenAiChatOptions

builder() - Static method in record class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions

builder() - Static method in class org.springframework.ai.openai.OpenAiEmbeddingModel

builder() - Static method in class org.springframework.ai.openai.OpenAiEmbeddingOptions

builder() - Static method in class org.springframework.ai.openai.OpenAiImageModel

builder() - Static method in class org.springframework.ai.openai.OpenAiImageOptions

builder() - Static method in class org.springframework.ai.openai.OpenAiModerationModel

builder() - Static method in class org.springframework.ai.openai.OpenAiModerationOptions

builder() - Static method in class org.springframework.ai.openai.responses.OpenAiResponsesChatModel

builder() - Static method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

builder() - Static method in class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions

builder() - Static method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor

builder() - Static method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter

builder() - Static method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander

builder() - Static method in class org.springframework.ai.rag.preretrieval.query.transformation.CompressionQueryTransformer

builder() - Static method in class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer

builder() - Static method in class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer

builder() - Static method in record class org.springframework.ai.rag.Query

builder() - Static method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever

builder() - Static method in class org.springframework.ai.reader.ExtractedTextFormatter

Provides an instance of the builder for this formatter.

builder() - Static method in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig

builder() - Static method in class org.springframework.ai.reader.markdown.config.MarkdownDocumentReaderConfig

builder() - Static method in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig

Start building a new configuration.

builder() - Static method in class org.springframework.ai.session.compaction.TokenCountTrigger

builder() - Static method in class org.springframework.ai.session.compaction.WindowCompactionStrategy

builder() - Static method in class org.springframework.ai.session.CreateSessionRequest

builder() - Static method in class org.springframework.ai.session.DefaultSessionService

builder() - Static method in record class org.springframework.ai.session.EventFilter

Returns a new EventFilter.Builder.

builder() - Static method in class org.springframework.ai.session.InMemorySessionRepository

Returns a new InMemorySessionRepository.Builder.

builder() - Static method in class org.springframework.ai.session.jdbc.JdbcSessionRepository

Returns a new JdbcSessionRepository.Builder.

builder() - Static method in class org.springframework.ai.session.Session

builder() - Static method in class org.springframework.ai.session.SessionEvent

Returns a new SessionEvent.Builder.

builder() - Static method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

builder() - Static method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

builder() - Static method in class org.springframework.ai.template.st.StTemplateRenderer

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 record class org.springframework.ai.tool.toolsearch.ToolReference

builder() - Static method in record class org.springframework.ai.tool.toolsearch.ToolSearchResponse

builder() - Static method in record class org.springframework.ai.tool.toolsearch.ToolSearchResponse.SearchMetadata

builder() - Static method in class org.springframework.ai.transformer.splitter.TokenTextSplitter

builder() - Static method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache

builder() - Static method in class org.springframework.ai.vectorstore.SearchRequest

Builder for creating the SearchRequest instance.

builder() - Static method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions

builder() - Static method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions

builder() - Static method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails

builder(Rest5Client, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore

Creates a new builder instance for ElasticsearchVectorStore.

builder(SearchIndexClient, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.azure.AzureVectorStore

builder(Cluster, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore

builder(Session, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore

Creates a new builder for configuring and creating CoherenceVectorStore instances.

builder(ObservationRegistry) - Static method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisorChain

Creates a new BaseAdvisorChain.Builder for the default BaseAdvisorChain implementation.

builder(ObservationRegistry) - Static method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain

builder(MilvusServiceClient, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

Creates a new MilvusBuilder instance with the specified Milvus client.

builder(QdrantClient, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

Creates a new QdrantBuilder instance.

builder(WeaviateClient, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore

Creates a new WeaviateBuilder instance.

builder(Method) - Static method in class org.springframework.ai.tool.support.ToolDefinitions

Create a default ToolDefinition builder from a Method.

builder(String) - Static method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest

builder(String, String) - Static method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

builder(String, BiFunction<I, ToolContext, O>) - Static method in class org.springframework.ai.tool.function.FunctionToolCallback

Build a FunctionToolCallback from a BiFunction.

builder(String, Consumer<I>) - Static method in class org.springframework.ai.tool.function.FunctionToolCallback

Build a FunctionToolCallback from a Consumer.

builder(String, Function<I, O>) - Static method in class org.springframework.ai.tool.function.FunctionToolCallback

Build a FunctionToolCallback from a Function.

builder(String, Supplier<O>) - Static method in class org.springframework.ai.tool.function.FunctionToolCallback

Build a FunctionToolCallback from a Supplier.

builder(String, VectorStoreObservationContext.Operation) - Static method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

builder(Driver, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

builder(OpenSearchClient, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

Creates a new builder instance for configuring an OpenSearchVectorStore.

builder(ChatClient.Builder) - Static method in class org.springframework.ai.chat.evaluation.FactCheckingEvaluator

builder(ChatMemory) - Static method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor

Deprecated.

builder(ChatModel) - Static method in interface org.springframework.ai.chat.client.ChatClient

builder(ChatModel) - Static method in class org.springframework.ai.model.transformer.KeywordMetadataEnricher

builder(ChatModel) - Static method in class org.springframework.ai.session.compaction.ChatModelSummarizer

builder(ChatModel, ObservationRegistry, ChatClientObservationConvention, AdvisorObservationConvention) - Static method in interface org.springframework.ai.chat.client.ChatClient

builder(ChatModel, ObservationRegistry, ChatClientObservationConvention, AdvisorObservationConvention, ToolCallingAdvisor.Builder<?>) - Static method in interface org.springframework.ai.chat.client.ChatClient

Creates a ChatClient.Builder for constructing a ChatClient.

builder(ChromaApi, EmbeddingModel) - Static method in class org.springframework.ai.chroma.vectorstore.ChromaVectorStore

builder(EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

builder(EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

builder(EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore

Creates a new builder for constructing a PineconeVectorStore instance.

builder(EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.SimpleVectorStore

Creates an instance of SimpleVectorStore builder.

builder(OllamaApi.Message.Role) - Static method in record class org.springframework.ai.ollama.api.OllamaApi.Message

builder(SessionService) - Static method in class org.springframework.ai.session.advisor.SessionAdvisors

builder(SessionService) - Static method in class org.springframework.ai.session.advisor.SessionMemoryAdvisor

builder(SessionService) - Static method in class org.springframework.ai.session.advisor.SessionTurnAdvisor

builder(VectorStore) - Static method in class org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor

builder(VectorStore) - Static method in class org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor

builder(MongoTemplate, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

Creates a new builder instance for MongoDBAtlasVectorStore.

builder(JdbcTemplate, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

Creates a new MariaDBBuilder instance.

builder(JdbcTemplate, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

builder(JdbcTemplate, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

builder(WebClient.Builder) - Static method in class org.springframework.ai.mcp.client.webflux.transport.WebClientStreamableHttpTransport

Create a stateful builder for creating WebClientStreamableHttpTransport instances.

builder(WebClient.Builder) - Static method in class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport

Deprecated.

Creates a new builder for WebFluxSseClientTransport.

builder(Client, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

Creates a new TypesenseBuilder instance.

builder(RedisClient, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

builder(BedrockAgentRuntimeClient, String) - Static method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore

Creates a new builder for BedrockKnowledgeBaseVectorStore.

Builder() - Constructor for class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder

Builder() - Constructor for class org.springframework.ai.anthropic.AnthropicChatOptions.Builder

Builder() - Constructor for class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder

Builder() - Constructor for class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder

Builder() - Constructor for class org.springframework.ai.anthropic.AnthropicSkillRecord.Builder

Builder() - Constructor for class org.springframework.ai.anthropic.AnthropicWebSearchTool.Builder

Builder() - Constructor for class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions.Builder

Builder() - Constructor for class org.springframework.ai.bedrock.cohere.BedrockCohereEmbeddingOptions.Builder

Builder() - Constructor for class org.springframework.ai.bedrock.converse.api.BedrockCacheOptions.Builder

Builder() - Constructor for class org.springframework.ai.bedrock.converse.BedrockChatOptions.Builder

Builder() - Constructor for class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingRequest.Builder

Builder() - Constructor for class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingOptions.Builder

Builder() - Constructor for class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor.Builder

Builder() - Constructor for class org.springframework.ai.chat.client.advisor.ToolCallAdvisor.Builder

Deprecated, for removal: This API element is subject to removal in a future version.

Builder() - Constructor for class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder

Builder() - Constructor for class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor.Builder

Builder() - Constructor for class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig.Builder

Deprecated.

Builder() - Constructor for class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository.Builder

Deprecated.

Builder() - Constructor for class org.springframework.ai.chat.messages.AssistantMessage.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.chroma.vectorstore.ChromaApi.Builder

Builder() - Constructor for class org.springframework.ai.deepseek.api.DeepSeekApi.Builder

Builder() - Constructor for class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Builder() - Constructor for class org.springframework.ai.deepseek.DeepSeekAssistantMessage.Builder

Deprecated.

Builder() - Constructor for class org.springframework.ai.deepseek.DeepSeekChatOptions.Builder

Builder() - Constructor for class org.springframework.ai.document.Document.Builder

Builder() - Constructor for class org.springframework.ai.elevenlabs.api.ElevenLabsApi.Builder

Builder() - Constructor for class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.Builder

Builder() - Constructor for class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Builder

Builder() - Constructor for class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel.Builder

Builder() - Constructor for class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

Builder() - Constructor for class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.Builder

Builder() - Constructor for class org.springframework.ai.google.genai.embedding.GoogleGenAiEmbeddingConnectionDetails.Builder

Builder() - Constructor for class org.springframework.ai.google.genai.GoogleGenAiChatOptions.Builder

Builder() - Constructor for class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice.Builder

Builder() - Constructor for class org.springframework.ai.google.genai.image.GoogleGenAiImageConnectionDetails.Builder

Builder() - Constructor for class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

Builder() - Constructor for class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.changed.prompt.AsyncMcpPromptListChangedMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.changed.prompt.SyncMcpPromptListChangedMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.changed.resource.AsyncMcpResourceListChangedMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.changed.resource.SyncMcpResourceListChangedMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.changed.tool.AsyncMcpToolListChangedMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.changed.tool.SyncMcpToolListChangedMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.complete.AsyncMcpCompleteMethodCallback.Builder

Constructor for Builder.

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.complete.AsyncStatelessMcpCompleteMethodCallback.Builder

Constructor for Builder.

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.complete.SyncMcpCompleteMethodCallback.Builder

Constructor for Builder.

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.complete.SyncStatelessMcpCompleteMethodCallback.Builder

Constructor for Builder.

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.elicitation.AsyncMcpElicitationMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.elicitation.SyncMcpElicitationMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.logging.AsyncMcpLoggingMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.logging.SyncMcpLoggingMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.progress.AsyncMcpProgressMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.progress.SyncMcpProgressMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.prompt.AsyncMcpPromptMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.prompt.AsyncStatelessMcpPromptMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.prompt.SyncMcpPromptMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.prompt.SyncStatelessMcpPromptMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.resource.AsyncMcpResourceMethodCallback.Builder

Constructor for Builder.

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.resource.AsyncStatelessMcpResourceMethodCallback.Builder

Constructor for Builder.

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.sampling.AsyncMcpSamplingMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.annotation.method.sampling.SyncMcpSamplingMethodCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.AsyncMcpToolCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider.Builder

Deprecated.

Builder() - Constructor for class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider.Builder

Deprecated.

Builder() - Constructor for class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider.Builder

Builder() - Constructor for class org.springframework.ai.mcp.SyncMcpToolCallback.Builder

Builder() - Constructor for class org.springframework.ai.mcp.SyncMcpToolCallbackProvider.Builder

Builder() - Constructor for class org.springframework.ai.mistralai.api.MistralAiApi.Builder

Builder() - Constructor for class org.springframework.ai.mistralai.api.MistralAiModerationApi.Builder

Builder() - Constructor for class org.springframework.ai.mistralai.MistralAiChatOptions.Builder

Builder() - Constructor for class org.springframework.ai.mistralai.MistralAiEmbeddingModel.Builder

Builder() - Constructor for class org.springframework.ai.mistralai.MistralAiEmbeddingOptions.Builder

Builder() - Constructor for class org.springframework.ai.mistralai.moderation.MistralAiModerationModel.Builder

Builder() - Constructor for class org.springframework.ai.model.tool.DefaultStructuredOutputChatOptions.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.ollama.api.OllamaApi.Builder

Builder() - Constructor for class org.springframework.ai.ollama.api.OllamaChatOptions.Builder

Builder() - Constructor for class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

Builder() - Constructor for class org.springframework.ai.ollama.management.ModelManagementOptions.Builder

Builder() - Constructor for class org.springframework.ai.openai.OpenAiChatOptions.Builder

Builder() - Constructor for class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions.Builder

Builder() - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder

Builder() - Constructor for class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.Builder

Builder() - Constructor for class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions.Builder

Builder() - Constructor for class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter.Builder

Builder() - Constructor for class org.springframework.ai.reader.ExtractedTextFormatter.Builder

Builder() - Constructor for class org.springframework.ai.session.CreateSessionRequest.Builder

Builder() - Constructor for class org.springframework.ai.session.DefaultSessionService.Builder

Builder() - Constructor for class org.springframework.ai.session.Session.Builder

Builder() - Constructor for class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.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.toolsearch.ToolReference.Builder

Builder() - Constructor for class org.springframework.ai.tool.toolsearch.ToolSearchResponse.Builder

Builder() - Constructor for class org.springframework.ai.tool.toolsearch.ToolSearchResponse.SearchMetadata.Builder

Builder() - Constructor for class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache.Builder

Builder() - Constructor for class org.springframework.ai.vectorstore.SearchRequest.Builder

Builder() - Constructor for class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions.Builder

Builder() - Constructor for class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.Builder

Builder() - Constructor for class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails.Builder

Builder(Rest5Client, EmbeddingModel) - Constructor for class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore.Builder

Sets the Elasticsearch REST client.

Builder(ObservationRegistry) - Constructor for class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder

Builder(String) - Constructor for class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

Builder(String, String) - Constructor for class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder

Builder(ChatModel) - Constructor for class org.springframework.ai.model.transformer.KeywordMetadataEnricher.Builder

Builder(OllamaApi.Message.Role) - Constructor for class org.springframework.ai.ollama.api.OllamaApi.Message.Builder

Builder(JdbcTemplate, EmbeddingModel) - Constructor for class org.springframework.ai.vectorstore.oracle.OracleVectorStore.Builder

Sets the JdbcTemplate to be used for database operations.

Builder(WebClient.Builder) - Constructor for class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport.Builder

Deprecated.

Creates a new builder with the specified WebClient.Builder.

Builder(Client, EmbeddingModel) - Constructor for class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore.Builder

Constructs a new TypesenseBuilder instance.

Builder(S3VectorsClient, EmbeddingModel) - Constructor for class org.springframework.ai.vectorstore.s3.S3VectorStore.Builder

builderShouldReturnNewInstances() - Method in class org.springframework.ai.test.options.AbstractChatOptionsTests

buildGeneration() - Method in exception org.springframework.ai.model.tool.ToolCallLimitExceededException

Builds a single Generation representing this exception, so that a limit breach is never mistaken for one of several equally valid answers.

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.

buildMethodArguments(T, Map<String, Object>, McpSchema.CallToolRequest) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractMcpToolMethodCallback

Builds the method arguments from the context, tool input arguments, and optionally the full request.

buildParts() - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder

The parts this builder would put in the message: the explicit parts, with the text, tool call and media parts replaced by the corresponding legacy setters that were called.

buildParts() - Method in class org.springframework.ai.deepseek.DeepSeekAssistantMessage.AbstractBuilder

Deprecated.

buildTypedArgument(Object, Type) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractMcpToolMethodCallback

Builds a typed argument from a raw value and type information.

byMessageType(MessageType...) - Static method in interface org.springframework.ai.session.MessageFilter

A filter that stores only the messages of the given types.

C

C - Enum constant in enum class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Unit

Celsius.

cache(SemanticCache) - Method in class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor.Builder

Sets the semantic cache implementation.

Cache() - Constructor for class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Cache

CachedContentException(String) - Constructor for exception org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService.CachedContentException

CachedContentException(String, Throwable) - Constructor for exception org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService.CachedContentException

cachedContentName - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

cachedContentName(String) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

CachedContentPage(List<GoogleGenAiCachedContent>, String) - Constructor for class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService.CachedContentPage

CachedContentRequest - Class in org.springframework.ai.google.genai.cache

Request for creating cached content in Google GenAI.

CachedContentRequest.Builder - Class in org.springframework.ai.google.genai.cache

CachedContentServiceCondition - Class in org.springframework.ai.model.google.genai.autoconfigure.chat

Condition that checks if the GoogleGenAiCachedContentService can be created.

CachedContentServiceCondition() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.chat.CachedContentServiceCondition

CachedContentUpdateRequest - Class in org.springframework.ai.google.genai.cache

Request for updating cached content in Google GenAI.

CachedContentUpdateRequest.Builder - Class in org.springframework.ai.google.genai.cache

cachedTokens() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.Usage.PromptTokensDetails

Returns the value of the cachedTokens record component.

CacheEligibilityResolver - Class in org.springframework.ai.anthropic

Resolves cache eligibility for messages based on the provided AnthropicCacheOptions.

CacheEligibilityResolver(AnthropicCacheStrategy, Map<MessageType, AnthropicCacheTtl>, Map<MessageType, Integer>, Function<String, Integer>, Set<MessageType>) - Constructor for class org.springframework.ai.anthropic.CacheEligibilityResolver

cacheOptions - Variable in class org.springframework.ai.bedrock.converse.BedrockChatOptions.AbstractBuilder

cacheOptions(AnthropicCacheOptions) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

cacheOptions(BedrockCacheOptions) - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions.AbstractBuilder

cacheToolResults(boolean) - Method in class org.springframework.ai.bedrock.converse.api.BedrockCacheOptions.Builder

Sets whether to cache tool result messages.

cacheToolResults(Boolean) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder

Place a cache_control breakpoint on the last tool result message of the request so that tool outputs are cached across tool-calling rounds.

call() - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

call() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

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.mcp.AsyncMcpToolCallback

call(String) - Method in class org.springframework.ai.mcp.SyncMcpToolCallback

call(String) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel

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.mcp.AsyncMcpToolCallback

call(String, ToolContext) - Method in class org.springframework.ai.mcp.SyncMcpToolCallback

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(AudioTranscriptionPrompt) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionModel

call(AudioTranscriptionPrompt) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel

call(TextToSpeechPrompt) - Method in interface org.springframework.ai.audio.tts.TextToSpeechModel

call(TextToSpeechPrompt) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel

call(TextToSpeechPrompt) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechModel

call(TextToSpeechPrompt) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel

call(Message...) - Method in interface org.springframework.ai.chat.model.ChatModel

call(Prompt) - Method in class org.springframework.ai.anthropic.AnthropicChatModel

call(Prompt) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel

Invoke the model and return the response.

call(Prompt) - Method in interface org.springframework.ai.chat.model.ChatModel

call(Prompt) - Method in class org.springframework.ai.deepseek.DeepSeekChatModel

call(Prompt) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatModel

call(Prompt) - Method in class org.springframework.ai.mistralai.MistralAiChatModel

call(Prompt) - Method in class org.springframework.ai.ollama.OllamaChatModel

call(Prompt) - Method in class org.springframework.ai.openai.OpenAiChatModel

call(Prompt) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatModel

call(DocumentEmbeddingRequest) - Method in interface org.springframework.ai.embedding.DocumentEmbeddingModel

call(DocumentEmbeddingRequest) - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingModel

call(EmbeddingRequest) - Method in class org.springframework.ai.bedrock.cohere.BedrockCohereEmbeddingModel

call(EmbeddingRequest) - Method in class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingModel

call(EmbeddingRequest) - Method in interface org.springframework.ai.embedding.EmbeddingModel

call(EmbeddingRequest) - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModel

call(EmbeddingRequest) - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingModel

call(EmbeddingRequest) - Method in class org.springframework.ai.ollama.OllamaEmbeddingModel

call(EmbeddingRequest) - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel

call(EmbeddingRequest) - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingModel

call(EmbeddingRequest) - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests.CallCountingEmbeddingModel

call(EmbeddingRequest) - Method in class org.springframework.ai.test.vectorstore.FixedDimensionEmbeddingModel

call(EmbeddingRequest) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

call(EmbeddingRequest) - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModel

call(ImagePrompt) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageModel

call(ImagePrompt) - Method in interface org.springframework.ai.image.ImageModel

call(ImagePrompt) - Method in class org.springframework.ai.openai.OpenAiImageModel

call(ImagePrompt) - Method in class org.springframework.ai.stabilityai.StabilityAiImageModel

Calls the StabilityAiImageModel with the given StabilityAiImagePrompt and returns the ImageResponse.

call(ModerationPrompt) - Method in class org.springframework.ai.mistralai.moderation.MistralAiModerationModel

call(ModerationPrompt) - Method in interface org.springframework.ai.moderation.ModerationModel

call(ModerationPrompt) - Method in class org.springframework.ai.openai.OpenAiModerationModel

call(TReq) - Method in interface org.springframework.ai.model.Model

Executes a method call to the AI model.

CallAdvisor - Interface in org.springframework.ai.chat.client.advisor.api

Advisor for execution flows ultimately resulting in a call to an AI model

CallAdvisorChain - Interface in org.springframework.ai.chat.client.advisor.api

A chain of CallAdvisor instances orchestrating the execution of a ChatClientRequest on the next CallAdvisor in the chain.

CallCountingEmbeddingModel(int) - Constructor for class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests.CallCountingEmbeddingModel

callMethod(Object[]) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractMcpToolMethodCallback

Invokes the tool method with the provided arguments.

calls() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests.CallCountingEmbeddingModel

Returns the number of calls made to this model so far.

canCarryMessage() - Method in class org.springframework.ai.session.EventType

Whether an event of this type carries a Spring AI message: a EventType.MESSAGE event does.

candidateCount - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

candidateCount(Integer) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

candidateCount(Integer) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

capabilities() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Returns the value of the capabilities record component.

Capabilities() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.Capabilities

capabilitiesBuilder() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.McpServerAutoConfiguration

capabilitiesBuilder() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.McpServerStatelessAutoConfiguration

capabilitiesPerClient - Variable in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

CAPTCHA - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.SafetyControlEnum

CAPTCHA_AND_MODERATION - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.SafetyControlEnum

captchaChecks() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharingModerationCheck

Returns the value of the captchaChecks record component.

captchaIds() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharingModerationCheck

Returns the value of the captchaIds record component.

CASSANDRA - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by Cassandra.

CASSANDRA - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

cassandraChatMemoryRepository(CassandraChatMemoryRepositoryProperties, CqlSession) - Method in class org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure.CassandraChatMemoryRepositoryAutoConfiguration

Deprecated.

CassandraChatMemoryRepository - Class in org.springframework.ai.chat.memory.repository.cassandra

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory: org.springframework.ai.session.SessionRepository in spring-ai-session, with a JDBC store in spring-ai-session-jdbc. There is no session store for Cassandra yet; one is planned before 3.0.0, when this module is removed.

CassandraChatMemoryRepositoryAutoConfiguration - Class in org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of the session memory auto-configuration, SessionServiceAutoConfiguration in spring-ai-autoconfigure-model-session. There is no session store for Cassandra yet; one is planned before 3.0.0, when this module is removed.

CassandraChatMemoryRepositoryAutoConfiguration() - Constructor for class org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure.CassandraChatMemoryRepositoryAutoConfiguration

Deprecated.

CassandraChatMemoryRepositoryConfig - Class in org.springframework.ai.chat.memory.repository.cassandra

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory: org.springframework.ai.session.SessionRepository in spring-ai-session, with a JDBC store in spring-ai-session-jdbc. There is no session store for Cassandra yet; one is planned before 3.0.0, when this module is removed.

CassandraChatMemoryRepositoryConfig.Builder - Class in org.springframework.ai.chat.memory.repository.cassandra

Deprecated.

CassandraChatMemoryRepositoryConfig.SchemaColumn - Record Class in org.springframework.ai.chat.memory.repository.cassandra

Deprecated.

CassandraChatMemoryRepositoryConfig.SessionIdToPrimaryKeysTranslator - Interface in org.springframework.ai.chat.memory.repository.cassandra

Deprecated.

Given a string sessionId, return the value for each primary key column.

CassandraChatMemoryRepositoryProperties - Class in org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of the session memory auto-configuration, SessionServiceAutoConfiguration in spring-ai-autoconfigure-model-session. There is no session store for Cassandra yet; one is planned before 3.0.0, when this module is removed.

CassandraChatMemoryRepositoryProperties() - Constructor for class org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure.CassandraChatMemoryRepositoryProperties

Deprecated.

CassandraVectorStore - Class in org.springframework.ai.vectorstore.cassandra

The CassandraVectorStore is for managing and querying vector data in an Apache Cassandra db.

CassandraVectorStore(CassandraVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

CassandraVectorStore.Builder - Class in org.springframework.ai.vectorstore.cassandra

Builder for the Cassandra vector store.

CassandraVectorStore.DocumentIdTranslator - Interface in org.springframework.ai.vectorstore.cassandra

Given a string document id, return the value for each primary key column.

CassandraVectorStore.PrimaryKeyTranslator - Interface in org.springframework.ai.vectorstore.cassandra

Given a list of primary key column values, return the document id.

CassandraVectorStore.SchemaColumn - Record Class in org.springframework.ai.vectorstore.cassandra

CassandraVectorStore.SchemaColumnTags - Enum Class in org.springframework.ai.vectorstore.cassandra

CassandraVectorStore.Similarity - Enum Class in org.springframework.ai.vectorstore.cassandra

Indexes are automatically created with COSINE.

CassandraVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.cassandra.autoconfigure

Auto-configuration for Cassandra Vector Store.

CassandraVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreAutoConfiguration

CassandraVectorStoreProperties - Class in org.springframework.ai.vectorstore.cassandra.autoconfigure

Configuration properties for Cassandra Vector Store.

CassandraVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreProperties

castToExpression(Filter.Operand) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

categories() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationResult

Returns the value of the categories record component.

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(Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Creates an instance of a Categories record class.

Categories.Builder - Class in org.springframework.ai.moderation

category() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the category record component.

category() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the category record component.

categoryFilter() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchRequest

Returns the value of the categoryFilter record component.

categoryScores() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationResult

Returns the value of the categoryScores record component.

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(Double, Double, Double, Double, Double, Double, Double, Double, Double, Double, Double) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Creates an instance of a CategoryScores record class.

CategoryScores.Builder - Class in org.springframework.ai.moderation

cfgScale() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

Returns the value of the cfgScale record component.

cfgScale(Float) - Method in class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.Builder

cfgScale(Float) - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions.Builder

ChainIterationCountingAdvisor() - Constructor for class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorAutoRegistrationIT.ChainIterationCountingAdvisor

ChainIterationCountingAdvisor(int) - Constructor for class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorAutoRegistrationIT.ChainIterationCountingAdvisor

channelNames - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

CHAR_LOCATION - Enum constant in enum class org.springframework.ai.anthropic.Citation.LocationType

Character-based location for plain text documents

charset - Variable in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig

charset(String) - Method in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig.Builder

Sets the character encoding to use for reading the HTML.

CHARSET_METADATA - Static variable in class org.springframework.ai.reader.TextReader

chat(OllamaApi.ChatRequest) - Method in class org.springframework.ai.ollama.api.OllamaApi

Generate the next message in a chat with a provided model.

CHAT - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType

AI operation type for chat completion.

CHAT_CLIENT - Enum constant in enum class org.springframework.ai.observation.conventions.SpringAiKind

Spring AI kind for chat client.

CHAT_CLIENT_ADVISORS - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames

List of configured chat client advisors.

CHAT_CLIENT_CONVERSATION_ID - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames

The identifier of the conversation.

CHAT_CLIENT_TOOL_NAMES - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames

Names of the tools made available to the chat client.

CHAT_COMPLETIONS - Enum constant in enum class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Api

/v1/chat/completions, served by OpenAiChatModel.

CHAT_COMPLETIONS_PROVIDER - Static variable in class org.springframework.ai.openai.OpenAiChatModel

The provider of the payloads this model produces.

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

ChatClient - Interface in org.springframework.ai.chat.client

Client to perform stateless requests to an AI Model, using a fluent API.

ChatClient.AdvisorSpec - Interface in org.springframework.ai.chat.client

ChatClient.Builder - Interface in org.springframework.ai.chat.client

A mutable builder for creating a ChatClient.

ChatClient.CallResponseSpec - Interface in org.springframework.ai.chat.client

ChatClient.ChatClientRequestSpec - Interface in org.springframework.ai.chat.client

ChatClient.EntityParamSpec - Interface in org.springframework.ai.chat.client

Configures optional behaviour for entity(...) calls.

ChatClient.PromptSystemSpec - Interface in org.springframework.ai.chat.client

Specification for a prompt system.

ChatClient.PromptUserSpec - Interface in org.springframework.ai.chat.client

ChatClient.StreamResponseSpec - Interface in org.springframework.ai.chat.client

ChatClientAttributes - Enum Class in org.springframework.ai.chat.client

Common attributes used in ChatClient context.

ChatClientAutoConfiguration - Class in org.springframework.ai.model.chat.client.autoconfigure

Auto-configuration for ChatClient.

ChatClientAutoConfiguration() - Constructor for class org.springframework.ai.model.chat.client.autoconfigure.ChatClientAutoConfiguration

chatClientBuilder(ChatClient.Builder) - Method in class org.springframework.ai.chat.evaluation.FactCheckingEvaluator.Builder

chatClientBuilder(ChatClient.Builder) - Method in class org.springframework.ai.chat.evaluation.RelevancyEvaluator.Builder

chatClientBuilder(ChatClient.Builder) - Method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander.Builder

chatClientBuilder(ChatClient.Builder) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.CompressionQueryTransformer.Builder

chatClientBuilder(ChatClient.Builder) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer.Builder

chatClientBuilder(ChatClient.Builder) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer.Builder

ChatClientBuilderConfigurer - Class in org.springframework.ai.model.chat.client.autoconfigure

Builder for configuring a ChatClient.Builder.

ChatClientBuilderConfigurer() - Constructor for class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderConfigurer

ChatClientBuilderCustomizer - Interface in org.springframework.ai.chat.client

Callback interface that can be used to customize a ChatClient.Builder.

ChatClientBuilderProperties - Class in org.springframework.ai.model.chat.client.autoconfigure

Configuration properties for the chat client builder.

ChatClientBuilderProperties() - Constructor for class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties

ChatClientBuilderProperties.Observations - Class in org.springframework.ai.model.chat.client.autoconfigure

ChatClientBuilderProperties.ToolCalling - Class in org.springframework.ai.model.chat.client.autoconfigure

ChatClientCompletionObservationHandler - Class in org.springframework.ai.chat.client.observation

Handler for emitting the chat client completion content to logs.

ChatClientCompletionObservationHandler() - Constructor for class org.springframework.ai.chat.client.observation.ChatClientCompletionObservationHandler

ChatClientCustomizer - Interface in org.springframework.ai.chat.client

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of ChatClientBuilderCustomizer

ChatClientMessageAggregator - Class in org.springframework.ai.chat.client

Helper that for streaming chat responses, aggregate the chat response messages into a single AssistantMessage.

ChatClientMessageAggregator() - Constructor for class org.springframework.ai.chat.client.ChatClientMessageAggregator

ChatClientObservationContext - Class in org.springframework.ai.chat.client.observation

Context used to store metadata for chat client workflows.

ChatClientObservationContext.Builder - Class in org.springframework.ai.chat.client.observation

ChatClientObservationConvention - Interface in org.springframework.ai.chat.client.observation

Interface for an ObservationConvention for chat client workflows.

ChatClientObservationDocumentation - Enum Class in org.springframework.ai.chat.client.observation

Documented conventions for chat client observations.

ChatClientObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.ai.chat.client.observation

ChatClientObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.ai.chat.client.observation

ChatClientPromptContentObservationHandler - Class in org.springframework.ai.chat.client.observation

Handler for emitting the chat client prompt content to logs.

ChatClientPromptContentObservationHandler() - Constructor for class org.springframework.ai.chat.client.observation.ChatClientPromptContentObservationHandler

chatClientRequest(ChatClientRequest) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder

ChatClientRequest - Record Class in org.springframework.ai.chat.client

Represents a request processed by a ChatClient that ultimately is used to build a Prompt to be sent to an AI model.

ChatClientRequest(Prompt, Map<String, Object>) - Constructor for record class org.springframework.ai.chat.client.ChatClientRequest

Creates an instance of a ChatClientRequest record class.

ChatClientRequest.Builder - Class in org.springframework.ai.chat.client

chatClientResponse() - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

chatClientResponse() - Method in interface org.springframework.ai.chat.client.ChatClient.StreamResponseSpec

chatClientResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

chatClientResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamResponseSpec

ChatClientResponse - Record Class in org.springframework.ai.chat.client

Represents a response returned by a ChatClient.

ChatClientResponse(ChatResponse, Map<String, Object>) - Constructor for record class org.springframework.ai.chat.client.ChatClientResponse

Creates an instance of a ChatClientResponse record class.

ChatClientResponse.Builder - Class in org.springframework.ai.chat.client

chatCompletion(I) - Method in class org.springframework.ai.bedrock.api.AbstractBedrockApi

Chat completion invocation.

ChatCompletion(String, String, Long, String, List<MistralAiApi.ChatCompletion.Choice>, MistralAiApi.Usage) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion

Creates an instance of a ChatCompletion record class.

ChatCompletion(String, List<DeepSeekApi.ChatCompletion.Choice>, Long, String, String, String, DeepSeekApi.Usage) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion

Creates an instance of a ChatCompletion record class.

ChatCompletionChunk(String, String, Long, String, List<MistralAiApi.ChatCompletionChunk.ChunkChoice>, MistralAiApi.Usage) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk

Creates an instance of a ChatCompletionChunk record class.

ChatCompletionChunk(String, List<DeepSeekApi.ChatCompletionChunk.ChunkChoice>, Long, String, String, String, String, DeepSeekApi.Usage) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk

Creates an instance of a ChatCompletionChunk record class.

chatCompletionEntity(DeepSeekApi.ChatCompletionRequest) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi

Creates a model response for the given chat conversation.

chatCompletionEntity(MistralAiApi.ChatCompletionRequest) - Method in class org.springframework.ai.mistralai.api.MistralAiApi

Creates a model response for the given chat conversation.

ChatCompletionFunction(String, String) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.ChatCompletionFunction

Creates an instance of a ChatCompletionFunction record class.

ChatCompletionFunction(String, String) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ChatCompletionFunction

Creates an instance of a ChatCompletionFunction record class.

ChatCompletionMessage(Object, MistralAiApi.ChatCompletionMessage.Role, String, List<MistralAiApi.ChatCompletionMessage.ToolCall>, String) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Creates an instance of a ChatCompletionMessage record class.

ChatCompletionMessage(Object, MistralAiApi.ChatCompletionMessage.Role) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Create a chat completion message with the given content and role.

ChatCompletionMessage(Object, MistralAiApi.ChatCompletionMessage.Role, String, List<MistralAiApi.ChatCompletionMessage.ToolCall>) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Message comprising the conversation.

ChatCompletionMessage(String, DeepSeekApi.ChatCompletionMessage.Role) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage

Create a chat completion message with the given content and role.

ChatCompletionMessage(String, DeepSeekApi.ChatCompletionMessage.Role, String, String, List<DeepSeekApi.ChatCompletionMessage.ToolCall>) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage

Create a chat completion message with the given content and role.

ChatCompletionMessage(String, DeepSeekApi.ChatCompletionMessage.Role, String, String, List<DeepSeekApi.ChatCompletionMessage.ToolCall>, Boolean, String) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage

Creates an instance of a ChatCompletionMessage record class.

ChatCompletionRequest(String, List<MistralAiApi.ChatCompletionMessage>, List<MistralAiApi.FunctionTool>, MistralAiApi.ChatCompletionRequest.ToolChoice, Double, Double, Integer, Integer, Double, Double, Boolean, Boolean, List<String>, MistralAiApi.ChatCompletionRequest.ReasoningEffort, Integer, MistralAiApi.ChatCompletionRequest.ResponseFormat) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Creates an instance of a ChatCompletionRequest record class.

ChatCompletionRequest(List<DeepSeekApi.ChatCompletionMessage>, String, Double, Integer, Double, ResponseFormat, List<String>, Boolean, Double, Double, Boolean, Integer, List<DeepSeekApi.FunctionTool>, Object, DeepSeekApi.ChatCompletionRequest.Thinking, DeepSeekApi.ChatCompletionRequest.ReasoningEffort) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Creates an instance of a ChatCompletionRequest record class.

ChatCompletionRequest(List<DeepSeekApi.ChatCompletionMessage>, Boolean) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Shortcut constructor for a chat completion request with the given messages for streaming.

ChatCompletionRequest(List<DeepSeekApi.ChatCompletionMessage>, String, Double) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Shortcut constructor for a chat completion request with the given messages, model and temperature.

ChatCompletionRequest(List<DeepSeekApi.ChatCompletionMessage>, String, Double, boolean) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Shortcut constructor for a chat completion request with the given messages, model, temperature and control for streaming.

ChatCompletionRequest(List<MistralAiApi.ChatCompletionMessage>, Boolean) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Shortcut constructor for a chat completion request with the given messages and stream.

ChatCompletionRequest(List<MistralAiApi.ChatCompletionMessage>, String) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Shortcut constructor for a chat completion request with the given messages and model.

ChatCompletionRequest(List<MistralAiApi.ChatCompletionMessage>, String, Double) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Shortcut constructor for a chat completion request with the given messages, model and temperature.

ChatCompletionRequest(List<MistralAiApi.ChatCompletionMessage>, String, Double, boolean) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Shortcut constructor for a chat completion request with the given messages, model and temperature.

ChatCompletionRequest(List<MistralAiApi.ChatCompletionMessage>, String, List<MistralAiApi.FunctionTool>, MistralAiApi.ChatCompletionRequest.ToolChoice) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Shortcut constructor for a chat completion request with the given messages, model, tools and tool choice.

chatCompletionStream(I) - Method in class org.springframework.ai.bedrock.api.AbstractBedrockApi

Chat completion invocation with streaming response.

chatCompletionStream(DeepSeekApi.ChatCompletionRequest) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi

Creates a streaming chat response for the given chat conversation.

chatCompletionStream(DeepSeekApi.ChatCompletionRequest, HttpHeaders) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi

Creates a streaming chat response for the given chat conversation.

chatCompletionStream(MistralAiApi.ChatCompletionRequest) - Method in class org.springframework.ai.mistralai.api.MistralAiApi

Creates a streaming chat response for the given chat conversation.

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

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory, org.springframework.ai.session.SessionService in spring-ai-session; the context key is MemoryAdvisor.CONVERSATION_ID in spring-ai-client-chat

ChatMemoryAutoConfiguration - Class in org.springframework.ai.model.chat.memory.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of the session memory auto-configuration, SessionServiceAutoConfiguration in spring-ai-autoconfigure-model-session

ChatMemoryAutoConfiguration() - Constructor for class org.springframework.ai.model.chat.memory.autoconfigure.ChatMemoryAutoConfiguration

Deprecated.

chatMemoryRepository(ChatMemoryRepository) - Method in class org.springframework.ai.chat.memory.MessageWindowChatMemory.Builder

Deprecated.

ChatMemoryRepository - Interface in org.springframework.ai.chat.memory

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of org.springframework.ai.session.SessionRepository in spring-ai-session

chatModel(ChatModel) - Method in class org.springframework.ai.chat.client.advisor.ChatModelCallAdvisor.Builder

chatModel(ChatModel) - Method in class org.springframework.ai.chat.client.advisor.ChatModelStreamAdvisor.Builder

ChatModel - Interface in org.springframework.ai.chat.model

ChatModelCallAdvisor - Class in org.springframework.ai.chat.client.advisor

A CallAdvisor that uses a ChatModel to generate a response.

ChatModelCallAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor

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

ChatModelStreamAdvisor - Class in org.springframework.ai.chat.client.advisor

A StreamAdvisor that uses a ChatModel to generate a streaming response.

ChatModelStreamAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor

ChatModelSummarizer - Class in org.springframework.ai.session.compaction

A CompactionSummarizer that asks a ChatModel for a rolling summary of the covered conversation: the prior summary is fed back as context, so each summary builds on its predecessors, and the first overlapSize preserved events are quoted for continuity.

ChatModelSummarizer.Builder - Class in org.springframework.ai.session.compaction

ChatObservationAutoConfiguration - Class in org.springframework.ai.model.chat.observation.autoconfigure

Auto-configuration for Spring AI chat model observations.

ChatObservationAutoConfiguration() - Constructor for class org.springframework.ai.model.chat.observation.autoconfigure.ChatObservationAutoConfiguration

ChatObservationProperties - Class in org.springframework.ai.model.chat.observation.autoconfigure

Configuration properties for chat model observations.

ChatObservationProperties() - Constructor for class org.springframework.ai.model.chat.observation.autoconfigure.ChatObservationProperties

chatOptions(ChatOptions) - Method in class org.springframework.ai.chat.prompt.Prompt.Builder

chatOptions(ChatOptions) - Method in class org.springframework.ai.session.compaction.ChatModelSummarizer.Builder

The options of the summarizing call, a smaller model for example; none by default.

ChatOptions - Interface in org.springframework.ai.chat.prompt

ModelOptions representing the common options that are portable across different chat models.

ChatOptions.Builder<B extends ChatOptions.Builder<B>> - 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<PromptTemplate>) - Constructor for class org.springframework.ai.chat.prompt.ChatPromptTemplate

ChatRequest(String, List<OllamaApi.Message>, Boolean, Object, String, List<OllamaApi.ChatRequest.Tool>, Map<String, Object>, ThinkOption) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest

Creates an instance of a ChatRequest record class.

chatResponse() - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

chatResponse() - Method in interface org.springframework.ai.chat.client.ChatClient.StreamResponseSpec

chatResponse() - Method in record class org.springframework.ai.chat.client.ChatClientResponse

Returns the value of the chatResponse record component.

chatResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

chatResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamResponseSpec

chatResponse(ChatResponse) - Method in class org.springframework.ai.chat.client.ChatClientResponse.Builder

ChatResponse - Class in org.springframework.ai.chat.model

The chat completion (e.g. generation) response returned by an AI provider.

ChatResponse(String, Instant, OllamaApi.Message, String, Boolean, Long, Long, Integer, Long, Integer, Long) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Creates an instance of a ChatResponse record class.

ChatResponse(List<Generation>) - Constructor for class org.springframework.ai.chat.model.ChatResponse

Construct a new ChatResponse instance without metadata.

ChatResponse(List<Generation>, 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

checkDimensions(String, int, int) - Static method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

Checks a caller-supplied vector's length against the length the store accepts, for use by doUpsert and the query-embedding doSimilaritySearch before they touch the database.

checkSchemaAgreement(CqlSession) - Static method in class org.springframework.ai.chat.memory.repository.cassandra.SchemaUtil

Deprecated.

checkSchemaAgreement(CqlSession) - Static method in class org.springframework.ai.vectorstore.cassandra.SchemaUtil

children() - Method in record class org.springframework.ai.reader.pdf.config.ParagraphManager.Paragraph

Returns the value of the children record component.

Choice(DeepSeekApi.ChatCompletionFinishReason, Integer, DeepSeekApi.ChatCompletionMessage, DeepSeekApi.LogProbs) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion.Choice

Creates an instance of a Choice record class.

Choice(Integer, MistralAiApi.ChatCompletionMessage, MistralAiApi.FinishReason, MistralAiApi.LogProbs) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion.Choice

Creates an instance of a Choice record class.

choices() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion

Returns the value of the choices record component.

choices() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk

Returns the value of the choices record component.

choices() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion

Returns the value of the choices record component.

choices() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk

Returns the value of the choices record component.

CHROMA - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by Chroma.

CHROMA - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

chromaApi(ChromaApiProperties, ObjectProvider<RestClient.Builder>, ChromaConnectionDetails, JsonMapper) - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaVectorStoreAutoConfiguration

ChromaApi - Class in org.springframework.ai.chroma.vectorstore

Single-class Chroma API implementation based on the (unofficial) Chroma REST API.

ChromaApi(String, RestClient.Builder, JsonMapper) - Constructor for class org.springframework.ai.chroma.vectorstore.ChromaApi

ChromaApi.AddEmbeddingsRequest - Record Class in org.springframework.ai.chroma.vectorstore

Add embeddings to the chroma data store.

ChromaApi.Builder - Class in org.springframework.ai.chroma.vectorstore

ChromaApi.Collection - Record Class in org.springframework.ai.chroma.vectorstore

Chroma embedding collection.

ChromaApi.CreateCollectionRequest - Record Class in org.springframework.ai.chroma.vectorstore

Request to create a new collection with the given name and metadata.

ChromaApi.CreateDatabaseRequest - Record Class in org.springframework.ai.chroma.vectorstore

Request to create a new database

ChromaApi.CreateTenantRequest - Record Class in org.springframework.ai.chroma.vectorstore

Request to create a new tenant

ChromaApi.Database - Record Class in org.springframework.ai.chroma.vectorstore

Chroma database.

ChromaApi.DeleteEmbeddingsRequest - Record Class in org.springframework.ai.chroma.vectorstore

Request to delete embedding from a collection.

ChromaApi.Embedding - Record Class in org.springframework.ai.chroma.vectorstore

Single query embedding response.

ChromaApi.GetEmbeddingResponse - Record Class in org.springframework.ai.chroma.vectorstore

Object containing the get embedding results.

ChromaApi.GetEmbeddingsRequest - Record Class in org.springframework.ai.chroma.vectorstore

Get embeddings from a collection.

ChromaApi.QueryRequest - Record Class in org.springframework.ai.chroma.vectorstore

Request to get the nResults nearest neighbor embeddings for provided queryEmbeddings.

ChromaApi.QueryRequest.Include - Enum Class in org.springframework.ai.chroma.vectorstore

ChromaApi.QueryResponse - Record Class in org.springframework.ai.chroma.vectorstore

A QueryResponse object containing the query results.

ChromaApi.Tenant - Record Class in org.springframework.ai.chroma.vectorstore

Chroma tenant.

ChromaApiConstants - Class in org.springframework.ai.chroma.vectorstore.common

Common value constants for Chroma api.

ChromaApiProperties - Class in org.springframework.ai.vectorstore.chroma.autoconfigure

Configuration properties for Chroma API client.

ChromaApiProperties() - Constructor for class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaApiProperties

ChromaConnectionDetails - Interface in org.springframework.ai.vectorstore.chroma.autoconfigure

Connection details for a Chroma service.

ChromaFilterExpressionConverter - Class in org.springframework.ai.chroma.vectorstore

Converts Filter.Expression into Chroma metadata filter expression format.

ChromaFilterExpressionConverter() - Constructor for class org.springframework.ai.chroma.vectorstore.ChromaFilterExpressionConverter

ChromaVectorStore - Class in org.springframework.ai.chroma.vectorstore

ChromaVectorStore is a concrete implementation of the VectorStore interface.

ChromaVectorStore(ChromaVectorStore.Builder) - Constructor for class org.springframework.ai.chroma.vectorstore.ChromaVectorStore

ChromaVectorStore.Builder - Class in org.springframework.ai.chroma.vectorstore

ChromaVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.chroma.autoconfigure

Auto-configuration for Chroma Vector Store.

ChromaVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaVectorStoreAutoConfiguration

ChromaVectorStoreProperties - Class in org.springframework.ai.vectorstore.chroma.autoconfigure

Configuration properties for Chroma Vector Store.

ChromaVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaVectorStoreProperties

ChunkChoice(DeepSeekApi.ChatCompletionFinishReason, Integer, DeepSeekApi.ChatCompletionMessage, DeepSeekApi.LogProbs) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk.ChunkChoice

Creates an instance of a ChunkChoice record class.

ChunkChoice(Integer, MistralAiApi.ChatCompletionMessage, MistralAiApi.FinishReason, MistralAiApi.LogProbs) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk.ChunkChoice

Creates an instance of a ChunkChoice record class.

chunkingStrategy(TranscriptionCreateParams.ChunkingStrategy) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder

Controls how the audio is cut into chunks.

CINEMATIC - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

Citation - Class in org.springframework.ai.anthropic

Represents a citation reference in a Claude response.

Citation.LocationType - Enum Class in org.springframework.ai.anthropic

Types of citation locations based on document format.

citationDocuments(List<AnthropicCitationDocument>) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

citationDocuments(AnthropicCitationDocument...) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

citationsEnabled(boolean) - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder

Enable or disable citations for this document.

city() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation

Returns the value of the city record component.

city() - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.Weather

Returns the value of the city record component.

city() - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.WeatherRequest

Returns the value of the city record component.

CLASSIFICATION - Enum constant in enum class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType

Use classification when using embeddings as an input to a text classifier.

CLASSIFICATION - Enum constant in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.TaskType

Specifies that the embeddings will be used for classification.

CLASSIFICATION - Enum constant in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.TaskType

Specifies that the embeddings will be used for classification.

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

cleanupExpired() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService

Removes all expired cached content.

clear() - Method in interface org.springframework.ai.chat.cache.semantic.SemanticCache

Removes all entries from the cache.

clear() - Method in class org.springframework.ai.model.MutableResponseMetadata

Clears the entries from the context.

clear() - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache

clear(String) - Method in interface org.springframework.ai.chat.memory.ChatMemory

Deprecated.

Clear the chat memory for the specified conversation.

clear(String) - Method in class org.springframework.ai.chat.memory.MessageWindowChatMemory

Deprecated.

clear(String) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

clearCache() - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser

clearContext() - Static method in class org.springframework.ai.model.tool.internal.ToolCallReactiveContextHolder

clearIndex(String) - Method in class org.springframework.ai.tool.toolsearch.index.lucene.LuceneToolIndex

clearIndex(String) - Method in class org.springframework.ai.tool.toolsearch.index.regex.RegexToolIndex

clearIndex(String) - Method in class org.springframework.ai.tool.toolsearch.index.vectorstore.VectorToolIndex

clearIndex(String) - Method in interface org.springframework.ai.tool.toolsearch.ToolIndex

Clears all indexed tools for the specified session.

client(Client) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionConnectionDetails.Builder

Sets a custom Client.

ClientAnnotatedBeanFactoryInitializationAotProcessor(Set<Class<? extends Annotation>>) - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.annotations.McpClientAnnotationScannerAutoConfiguration.ClientAnnotatedBeanFactoryInitializationAotProcessor

clientCapabilities() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

clientCapabilities() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

clientCapabilities() - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes

clientCapabilities() - Method in record class org.springframework.ai.mcp.McpConnectionInfo

Returns the value of the clientCapabilities record component.

clientCapabilities(McpSchema.ClientCapabilities) - Method in class org.springframework.ai.mcp.McpConnectionInfo.Builder

Sets the client capabilities.

clientInfo() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

clientInfo() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

clientInfo() - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes

clientInfo() - Method in record class org.springframework.ai.mcp.McpConnectionInfo

Returns the value of the clientInfo record component.

clientInfo(McpSchema.Implementation) - Method in class org.springframework.ai.mcp.McpConnectionInfo.Builder

Sets the client information.

ClientMcpAnnotatedBeans() - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.annotations.McpClientAnnotationScannerAutoConfiguration.ClientMcpAnnotatedBeans

clientMcpAsyncHandlersRegistry() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.annotations.McpClientAnnotationScannerAutoConfiguration

ClientMcpAsyncHandlersRegistry - Class in org.springframework.ai.mcp.annotation.spring

Registry of methods annotated with MCP Client annotations (sampling, logging, etc.).

ClientMcpAsyncHandlersRegistry() - Constructor for class org.springframework.ai.mcp.annotation.spring.ClientMcpAsyncHandlersRegistry

clientMcpSyncHandlersRegistry() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.annotations.McpClientAnnotationScannerAutoConfiguration

ClientMcpSyncHandlersRegistry - Class in org.springframework.ai.mcp.annotation.spring

Registry of methods annotated with MCP Client annotations (sampling, logging, etc.).

ClientMcpSyncHandlersRegistry() - Constructor for class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

clients() - Element in annotation interface org.springframework.ai.mcp.annotation.McpElicitation

Used as connection or client identifier to select the MCP clients, the elicitation method is associated with.

clients() - Element in annotation interface org.springframework.ai.mcp.annotation.McpLogging

Used as connection or clients identifier to select the MCP clients, the logging consumer is associated with.

clients() - Element in annotation interface org.springframework.ai.mcp.annotation.McpProgress

Used as connection or client identifier to select the MCP client, the progress consumer is associated with.

clients() - Element in annotation interface org.springframework.ai.mcp.annotation.McpPromptListChanged

Used as connection or client identifier to select the MCP client that the prompt change listener is associated with.

clients() - Element in annotation interface org.springframework.ai.mcp.annotation.McpResourceListChanged

Used as connection or client identifier to select the MCP clients that the resource change listener is associated with.

clients() - Element in annotation interface org.springframework.ai.mcp.annotation.McpSampling

Used as connection or client identifier to select the MCP client, the sampling method is associated with.

clients() - Element in annotation interface org.springframework.ai.mcp.annotation.McpToolListChanged

Used as connection or client identifier to select the MCP clients that the tool change listener is associated with.

clients() - Method in record class org.springframework.ai.mcp.annotation.method.changed.prompt.AsyncPromptListChangedSpecification

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.annotation.method.changed.prompt.SyncPromptListChangedSpecification

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.annotation.method.changed.resource.AsyncResourceListChangedSpecification

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.annotation.method.changed.resource.SyncResourceListChangedSpecification

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.annotation.method.changed.tool.AsyncToolListChangedSpecification

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.annotation.method.changed.tool.SyncToolListChangedSpecification

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.annotation.method.elicitation.AsyncElicitationSpecification

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.annotation.method.elicitation.SyncElicitationSpecification

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.annotation.method.logging.AsyncLoggingSpecification

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.annotation.method.logging.SyncLoggingSpecification

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.annotation.method.progress.AsyncProgressSpecification

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.annotation.method.progress.SyncProgressSpecification

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.annotation.method.sampling.AsyncSamplingSpecification

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.annotation.method.sampling.SyncSamplingSpecification

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration.CloseableMcpAsyncClients

Returns the value of the clients record component.

clients() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration.CloseableMcpSyncClients

Returns the value of the clients record component.

clipGuidancePreset() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

Returns the value of the clipGuidancePreset record component.

clipGuidancePreset(String) - Method in class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.Builder

clipGuidancePreset(String) - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions.Builder

clone() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

clone() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions.AbstractBuilder

clone() - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

clone() - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

clone() - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder

clone() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

clone() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

clone() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

clone() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder

clone() - Method in class org.springframework.ai.model.tool.DefaultStructuredOutputChatOptions.Builder

clone() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

clone() - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

clone() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

CLONED - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.CategoryEnum

clonedByCount() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the clonedByCount record component.

close() - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient

close() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration.CloseableMcpAsyncClients

close() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration.CloseableMcpSyncClients

close() - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient

close() - Method in class org.springframework.ai.tool.toolsearch.index.lucene.LuceneToolIndex

close() - Method in class org.springframework.ai.tool.toolsearch.index.regex.RegexToolIndex

close() - Method in class org.springframework.ai.tool.toolsearch.index.vectorstore.VectorToolIndex

close() - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

Release the native ONNX runtime session and tokenizer acquired in TransformersEmbeddingModel.afterPropertiesSet().

close() - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

close() - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore

CloseableMcpAsyncClients(List<McpAsyncClient>) - Constructor for record class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration.CloseableMcpAsyncClients

Creates an instance of a CloseableMcpAsyncClients record class.

CloseableMcpSyncClients(List<McpSyncClient>) - Constructor for record class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration.CloseableMcpSyncClients

Creates an instance of a CloseableMcpSyncClients record class.

closed() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ThinkChunk

Returns the value of the closed record component.

closeGracefully() - Method in class org.springframework.ai.mcp.client.webflux.transport.WebClientStreamableHttpTransport

closeGracefully() - Method in class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport

Deprecated.

Implements graceful shutdown of the transport.

closeGracefully() - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider

Deprecated.

Initiates a graceful shutdown of all the sessions.

closeGracefully() - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStatelessServerTransport

closeGracefully() - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider

closeGracefully() - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider

Deprecated.

Initiates a graceful shutdown of the transport.

closeGracefully() - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStatelessServerTransport

closeGracefully() - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider

Initiates a graceful shutdown of the transport.

CLUSTERING - Enum constant in enum class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType

Use clustering to cluster the embeddings.

CLUSTERING - Enum constant in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.TaskType

Specifies that the embeddings will be used for clustering.

CLUSTERING - Enum constant in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.TaskType

Specifies that the embeddings will be used for clustering.

clusteringKeys(List<CassandraVectorStore.SchemaColumn>) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

Sets the clustering keys.

CodeInterpreter() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.CodeInterpreter

CodeInterpreter(String) - Constructor for record class org.springframework.ai.openai.responses.HostedTool.CodeInterpreter

Creates an instance of a CodeInterpreter record class.

CODELLAMA - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Code Llama is based on Llama 2 model

CODESTRAL - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatModel

CODESTRAL_EMBED - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingModel

Codestral Embed model optimized for code embeddings.

COHERE_EMBED_ENGLISH_V3 - Enum constant in enum class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingModel

cohere.embed-english-v3

COHERE_EMBED_MULTILINGUAL_V3 - Enum constant in enum class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingModel

cohere.embed-multilingual-v3

cohereEmbeddingApi(AwsCredentialsProvider, AwsRegionProvider, BedrockCohereEmbeddingProperties, BedrockAwsConnectionProperties, JsonMapper) - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingAutoConfiguration

CohereEmbeddingBedrockApi - Class in org.springframework.ai.bedrock.cohere.api

Cohere Embedding API.

CohereEmbeddingBedrockApi(String, String) - Constructor for class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi

Create a new CohereEmbeddingBedrockApi instance using the default credentials provider chain, the default object mapper, default temperature and topP values.

CohereEmbeddingBedrockApi(String, String, Duration) - Constructor for class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi

Create a new CohereEmbeddingBedrockApi instance using the default credentials provider chain, the default object mapper, default temperature and topP values.

CohereEmbeddingBedrockApi(String, AwsCredentialsProvider, String, JsonMapper) - Constructor for class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi

Create a new CohereEmbeddingBedrockApi instance using the provided credentials provider, region and object mapper.

CohereEmbeddingBedrockApi(String, AwsCredentialsProvider, String, JsonMapper, Duration) - Constructor for class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi

Create a new CohereEmbeddingBedrockApi instance using the provided credentials provider, region and object mapper.

CohereEmbeddingBedrockApi(String, AwsCredentialsProvider, Region, JsonMapper, Duration) - Constructor for class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi

Create a new CohereEmbeddingBedrockApi instance using the provided credentials provider, region and JSON mapper.

CohereEmbeddingBedrockApi.CohereEmbeddingModel - Enum Class in org.springframework.ai.bedrock.cohere.api

Cohere Embedding model ids.

CohereEmbeddingBedrockApi.CohereEmbeddingRequest - Record Class in org.springframework.ai.bedrock.cohere.api

The Cohere Embed model request.

CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType - Enum Class in org.springframework.ai.bedrock.cohere.api

Cohere Embedding API input types.

CohereEmbeddingBedrockApi.CohereEmbeddingRequest.Truncate - Enum Class in org.springframework.ai.bedrock.cohere.api

Specifies how the API handles inputs longer than the maximum token length.

CohereEmbeddingBedrockApi.CohereEmbeddingResponse - Record Class in org.springframework.ai.bedrock.cohere.api

Cohere Embedding response.

cohereEmbeddingModel(CohereEmbeddingBedrockApi, BedrockCohereEmbeddingProperties) - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingAutoConfiguration

CohereEmbeddingRequest(List<String>, CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType, CohereEmbeddingBedrockApi.CohereEmbeddingRequest.Truncate) - Constructor for record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest

Creates an instance of a CohereEmbeddingRequest record class.

CohereEmbeddingResponse(String, List<float[]>, List<String>, String, AbstractBedrockApi.AmazonBedrockInvocationMetrics) - Constructor for record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingResponse

Creates an instance of a CohereEmbeddingResponse record class.

CoherenceFilterExpressionConverter - Class in org.springframework.ai.vectorstore.coherence

Converts Spring AI Filter.Expression into Coherence Filter.

CoherenceFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.coherence.CoherenceFilterExpressionConverter

CoherenceVectorStore - Class in org.springframework.ai.vectorstore.coherence

Integration of Coherence 24.09+ as a Vector Store.

CoherenceVectorStore(CoherenceVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore

Protected constructor that accepts a builder instance.

CoherenceVectorStore.Builder - Class in org.springframework.ai.vectorstore.coherence

Builder class for creating CoherenceVectorStore instances.

CoherenceVectorStore.DistanceType - Enum Class in org.springframework.ai.vectorstore.coherence

CoherenceVectorStore.IndexType - Enum Class in org.springframework.ai.vectorstore.coherence

coldStartSearchWithoutEmbeddingModel() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

Collection(String, String, Map<String, Object>) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.Collection

Creates an instance of a Collection record class.

COLLECTION - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ReaderResource.ResourceTypeEnum

collectionName(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

collectionName(String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaVectorStore.Builder

Sets the collection name.

collectionName(String) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.Builder

Configures the Couchbase collection storing Document.

collectionName(String) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore.Builder

Configures the Milvus collection name.

collectionName(String) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.Builder

Configures the collection name.

collectionName(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder

collectionName(String) - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore.Builder

Configures the Qdrant collection name.

collectionName(String) - Method in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore.Builder

Configures the collection name.

combineWith(ChatOptions.Builder<?>) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

combineWith(ChatOptions.Builder<?>) - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions.AbstractBuilder

combineWith(ChatOptions.Builder<?>) - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder

Mutate this builder by taking all other's values that are non-null, retaining this other values.

combineWith(ChatOptions.Builder<?>) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

combineWith(ChatOptions.Builder<?>) - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

combineWith(ChatOptions.Builder<?>) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

combineWith(ChatOptions.Builder<?>) - Method in class org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder

combineWith(ChatOptions.Builder<?>) - Method in class org.springframework.ai.model.tool.DefaultStructuredOutputChatOptions.Builder

combineWith(ChatOptions.Builder<?>) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

combineWith(ChatOptions.Builder<?>) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

combineWith(ChatOptions.Builder<?>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

combineWith(ChatOptions.Builder<?>) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

COMIC_BOOK - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

COMMA - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

COMMA - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

COMMA() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantArrayContext

COMMA(int) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantArrayContext

command() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStdioClientProperties.Parameters

Returns the value of the command record component.

commit() - Method in class org.springframework.ai.tool.toolsearch.index.lucene.LuceneToolIndex

Commits all pending changes to all session indexes.

commit(String) - Method in class org.springframework.ai.tool.toolsearch.index.lucene.LuceneToolIndex

Commits all pending changes to the index for the specified session.

CommonVectorStoreProperties - Class in org.springframework.ai.vectorstore.properties

Common properties for vector stores.

CommonVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.properties.CommonVectorStoreProperties

compact(String, List<SessionEvent>, List<SessionEvent>, List<SessionEvent>) - Method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

Records a compaction the way the service does: appends a boundary naming the pinned, summary and preserved events, followed by the summary events, under the current version.

compact(String, CompactionTrigger, CompactionStrategy) - Method in class org.springframework.ai.session.DefaultSessionService

compact(String, CompactionTrigger, CompactionStrategy) - Method in interface org.springframework.ai.session.SessionService

Evaluates the trigger on the active view and, when it fires, runs the strategy and records its result: one EventType.COMPACTION boundary event followed by the summary events, in one version-checked append.

compact(CompactionRequest) - Method in interface org.springframework.ai.session.compaction.CompactionStrategy

Decides how to compact the view.

compact(CompactionRequest) - Method in class org.springframework.ai.session.compaction.WindowCompactionStrategy

compaction(CompactionTrigger, CompactionStrategy) - Method in class org.springframework.ai.session.advisor.SessionAdvisors.Builder

Compacts the session once a turn has ended, when the trigger fires.

COMPACTION - Static variable in class org.springframework.ai.session.EventType

A compaction boundary: the payload names, by id, the events that make up the active view from here on; see CompactionBoundary.

CompactionBoundary - Record Class in org.springframework.ai.session.compaction

The record of one compaction: the payload of a EventType.COMPACTION event, typed.

CompactionBoundary(String, List<String>, List<String>, List<String>, int, int, String) - Constructor for record class org.springframework.ai.session.compaction.CompactionBoundary

Creates an instance of a CompactionBoundary record class.

CompactionRequest - Record Class in org.springframework.ai.session.compaction

What a CompactionTrigger and a CompactionStrategy decide on.

CompactionRequest(Session, List<SessionEvent>, int) - Constructor for record class org.springframework.ai.session.compaction.CompactionRequest

Creates an instance of a CompactionRequest record class.

CompactionResult - Record Class in org.springframework.ai.session.compaction

What a CompactionStrategy decided for the active view it was given: which events leave the view, which are kept, and the summary that stands in for the ones that leave.

CompactionResult(List<SessionEvent>, List<SessionEvent>, List<SessionEvent>, List<Message>, int, String) - Constructor for record class org.springframework.ai.session.compaction.CompactionResult

Creates an instance of a CompactionResult record class.

compactionStrategy(CompactionStrategy) - Method in class org.springframework.ai.session.advisor.SessionTurnAdvisor.Builder

How to compact; set together with SessionTurnAdvisor.Builder.compactionTrigger.

CompactionStrategy - Interface in org.springframework.ai.session.compaction

Decides what leaves a session's active view.

CompactionSummarizer - Interface in org.springframework.ai.session.compaction

Writes the summary that stands in for the events a WindowCompactionStrategy covers.

compactionTrigger(CompactionTrigger) - Method in class org.springframework.ai.session.advisor.SessionTurnAdvisor.Builder

When to compact once a turn has ended; set together with SessionTurnAdvisor.Builder.compactionStrategy.

CompactionTrigger - Interface in org.springframework.ai.session.compaction

Decides whether a session's active view is compacted.

CompactionWindow - Record Class in org.springframework.ai.session.compaction

The rule a WindowCompactionStrategy cuts by: how much of the recent conversation stays in the view, measured in events, in turns or in estimated tokens.

CompactionWindow(CompactionWindow.Rule, int) - Constructor for record class org.springframework.ai.session.compaction.CompactionWindow

Creates an instance of a CompactionWindow record class.

CompactionWindow.Rule - Enum Class in org.springframework.ai.session.compaction

What the size of a window counts.

compare() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

compare() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareExpressionContext

CompareContext(ParserRuleContext, int) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareContext

CompareExpressionContext(FiltersParser.BooleanExpressionContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareExpressionContext

complete(MessagePart, int) - Static method in class org.springframework.ai.chat.messages.part.StreamingParts

Marks a part as the complete content block at the given index.

complete(McpComplete) - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

Set the complete annotation.

CompleteAdapter - Class in org.springframework.ai.mcp.annotation.adapter

Utility class for adapting between McpComplete annotations and McpSchema.CompleteReference objects.

completed() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ProgressResponse

Returns the value of the completed record component.

completeReference - Variable in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback

completeSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

completeSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

completionsPath(String) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.Builder

completionTokens() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage

Returns the value of the completionTokens record component.

completionTokens() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.Usage

Returns the value of the completionTokens record component.

completionTokens() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.Usage

Returns the value of the completionTokens record component.

CompositeCompactionTrigger - Class in org.springframework.ai.session.compaction

Fires when any of its triggers fires.

CompositeEvictionStrategy - Class in org.springframework.ai.tool.toolsearch.eviction

A ToolIndexEvictionStrategy that delegates to multiple strategies and unions their eviction decisions.

CompositeEvictionStrategy(ToolIndexEvictionStrategy...) - Constructor for class org.springframework.ai.tool.toolsearch.eviction.CompositeEvictionStrategy

Creates a composite strategy from the given delegates.

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<ResponseTextCleaner>) - 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.

CompoundIdentifierContext(FiltersParser.IdentifierContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompoundIdentifierContext

CompressionQueryTransformer - Class in org.springframework.ai.rag.preretrieval.query.transformation

Uses a large language model to compress a conversation history and a follow-up query into a standalone query that captures the essence of the conversation.

CompressionQueryTransformer(ChatClient.Builder, PromptTemplate) - Constructor for class org.springframework.ai.rag.preretrieval.query.transformation.CompressionQueryTransformer

CompressionQueryTransformer.Builder - Class in org.springframework.ai.rag.preretrieval.query.transformation

computeFontHeight(PDFont) - Method in class org.springframework.ai.reader.pdf.layout.PDFLayoutTextStripperByArea

computeIfAbsent(String, Function<Object, ? extends T>) - Method in class org.springframework.ai.model.MutableResponseMetadata

Returns an element or calls a mapping function if entry not present.

concatenateEntries(Map<String, Object>) - Static method in class org.springframework.ai.observation.ObservabilityHelper

concatenateStrings(List<String>) - Static method in class org.springframework.ai.observation.ObservabilityHelper

ConcatenationDocumentJoiner - Class in org.springframework.ai.rag.retrieval.join

Combines documents retrieved based on multiple queries and from multiple data sources by concatenating them into a single collection of documents.

ConcatenationDocumentJoiner() - Constructor for class org.springframework.ai.rag.retrieval.join.ConcatenationDocumentJoiner

concurrentFirstUseResolvesTheSizeOnce() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

config() - Method in record class org.springframework.ai.google.genai.GoogleGenAiChatModel.GeminiRequest

Returns the value of the config record component.

CONFIG_PREFIX - Static variable in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.mcp.client.common.autoconfigure.annotations.McpClientAnnotationScannerProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpSseClientProperties

Deprecated.

CONFIG_PREFIX - Static variable in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStdioClientProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStreamableHttpClientProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.mcp.server.common.autoconfigure.annotations.McpServerAnnotationScannerProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerChangeNotificationProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerSseProperties

Deprecated.

CONFIG_PREFIX - Static variable in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerStreamableHttpProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicConnectionProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.audio.observation.autoconfigure.AudioSpeechObservationProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.audio.observation.autoconfigure.AudioTranscriptionObservationProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.bedrock.titan.autoconfigure.BedrockTitanEmbeddingProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated.

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure.CassandraChatMemoryRepositoryProperties

Deprecated.

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.chat.memory.repository.jdbc.autoconfigure.JdbcChatMemoryRepositoryProperties

Deprecated.

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.chat.memory.repository.mongo.autoconfigure.MongoChatMemoryProperties

Deprecated.

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryProperties

Deprecated.

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.chat.observation.autoconfigure.ChatObservationProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekConnectionProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsConnectionProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiConnectionProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiEmbeddingConnectionProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageConnectionProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionConnectionProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechConnectionProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.image.observation.autoconfigure.ImageObservationProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiCommonProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiModerationProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.ollama.autoconfigure.OllamaConnectionProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.openai.autoconfigure.OpenAiCommonProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.openai.autoconfigure.OpenAiModerationProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.session.autoconfigure.SessionServiceProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.session.jdbc.autoconfigure.JdbcSessionRepositoryProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiConnectionProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiEmbeddingConnectionProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultimodalEmbeddingProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaApiProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaVectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

Configuration prefix for Spring AI VectorStore GemFire.

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.mongodb.autoconfigure.MongoDBAtlasVectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.observation.autoconfigure.VectorStoreObservationProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties

Configuration prefix for Redis vector store properties.

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.s3.autoconfigure.S3VectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseServiceClientProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseVectorStoreProperties

CONFIG_PREFIX - Static variable in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

configure(String, McpClient.AsyncSpec) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.configurer.McpAsyncClientConfigurer

configure(String, McpClient.SyncSpec) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.configurer.McpSyncClientConfigurer

Configures an MCP sync client specification by applying all registered customizers.

configure(ChatClient.Builder) - Method in class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderConfigurer

Configure the specified ChatClient.Builder.

Confirmation() - Constructor for class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Confirmation

CONFIRMATION_CODE - Static variable in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT

The confirmation code the booking tool returns, to find in the model's answer.

confirmationCode() - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.Booking

Returns the value of the confirmationCode record component.

connect(Function<Mono<McpSchema.JSONRPCMessage>, Mono<McpSchema.JSONRPCMessage>>) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebClientStreamableHttpTransport

connect(Function<Mono<McpSchema.JSONRPCMessage>, Mono<McpSchema.JSONRPCMessage>>) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport

Deprecated.

Establishes a connection to the MCP server using Server-Sent Events (SSE).

connectionAcquisitionTimeout(Duration) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder

connectionDetails(GoogleGenAiTranscriptionConnectionDetails) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionModel.Builder

Sets the connection details used to access the Google Gen AI API.

connectionDetails(GoogleGenAiTextToSpeechConnectionDetails) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechModel.Builder

connectionDetails(VertexAiEmbeddingConnectionProperties) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiEmbeddingConnectionAutoConfiguration

ConnectionParameters(String, String) - Constructor for record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStreamableHttpClientProperties.ConnectionParameters

Creates an instance of a ConnectionParameters record class.

connectionTimeout(Duration) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder

connectorId() - Method in record class org.springframework.ai.openai.responses.HostedTool.Mcp

Returns the value of the connectorId record component.

consentAudio() - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.ReplicatedVoice

Returns the value of the consentAudio record component.

consentSignature() - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.ReplicatedVoice

Returns the value of the consentSignature record component.

consistencyLevel(WeaviateVectorStore.ConsistentLevel) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.Builder

Configures the consistency level for Weaviate operations.

constant() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareExpressionContext

constant() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

constant() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantArrayContext

constant(int) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantArrayContext

constantArray() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

constantArray() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.InExpressionContext

constantArray() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NinExpressionContext

ConstantArrayContext(ParserRuleContext, int) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantArrayContext

ConstantContext() - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantContext

ConstantContext(ParserRuleContext, int) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantContext

constraintName(String) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Builder

Sets the name of the unique constraint.

contactPoint(InetSocketAddress) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

Adds a contact point to the session builder.

containerId() - Method in record class org.springframework.ai.openai.responses.HostedTool.CodeInterpreter

Returns the value of the containerId record component.

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

containsText(String) - Static method in interface org.springframework.ai.session.MessageFilter

A filter that stores only the messages whose text contains the keyword, case-insensitively; a message without text is rejected.

content - Variable in class org.springframework.ai.chat.messages.AssistantMessage.Builder

The text set through AssistantMessage.Builder.content(String).

content - Variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextInstanceBuilder

content() - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

content() - Method in interface org.springframework.ai.chat.client.ChatClient.StreamResponseSpec

content() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

content() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamResponseSpec

content() - Method in record class org.springframework.ai.chat.memory.repository.mongo.Conversation.Message

Deprecated.

Returns the value of the content record component.

content() - Method in record class org.springframework.ai.chat.messages.part.ToolResultPart

Returns the value of the content record component.

content() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage

Returns the value of the content record component.

content() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs

Returns the value of the content record component.

content() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Returns the value of the content record component.

content() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs

Returns the value of the content record component.

content() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message

Returns the value of the content record component.

content() - Method in record class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.CouchbaseDocument

Returns the value of the content record component.

content() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Group

Returns the value of the content record component.

content() - Method in record class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBDocument

Returns the value of the content record component.

content() - Method in record class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.MongoDBDocument

Returns the value of the content record component.

content() - Method in record class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.OpenSearchDocument

Returns the value of the content record component.

content(String) - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder

content(String) - Method in class org.springframework.ai.chat.prompt.Prompt.Builder

content(String) - Method in class org.springframework.ai.ollama.api.OllamaApi.Message.Builder

Content - Interface in org.springframework.ai.content

Data structure that contains content and metadata.

Content(String, Float, List<Integer>, List<DeepSeekApi.LogProbs.Content.TopLogProbs>) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content

Creates an instance of a Content record class.

Content(String, Float, List<Integer>, List<MistralAiApi.LogProbs.Content.TopLogProbs>) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content

Creates an instance of a Content record class.

CONTENT_BLOCK_LOCATION - Enum constant in enum class org.springframework.ai.anthropic.Citation.LocationType

Block-based location for custom content documents

CONTENT_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

CONTENT_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

CONTENT_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore

CONTENT_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

CONTENT_FILTER - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionFinishReason

The content was omitted due to a flag from our content filters.

CONTENT_REF - Enum constant in enum class org.springframework.ai.document.DocumentMetadata

Metadata key holding a pointer to content kept outside the vector store.

contentColumnName(String) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

ContentDeserializer() - Constructor for class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ContentDeserializer

contentFieldName(String) - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore.Builder

Sets the content field name in the Azure Search index.

contentFieldName(String) - Method in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore.Builder

Sets the content field name.

contentFieldName(String) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBBuilder

Configures the name of the content field in the database.

contentFieldName(String) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore.Builder

Configures the name of the field used for document content.

contentFieldName(String) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgVectorStoreBuilder

Overrides the column name used for document content.

contentFieldName(String) - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore.Builder

Configures the Qdrant content field name.

contentFieldName(String) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the Redis content field name.

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<String>) - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata.Builder

Add content filters to the Generation result.

contentFilters(Set<String>) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadataBuilder

ContentFormatter - Interface in org.springframework.ai.document

Converts the Document text and metadata into an AI, prompt-friendly text representation.

ContentFormatTransformer - Class in org.springframework.ai.transformer

ContentFormatTransformer processes a list of documents by applying a content formatter to each document.

ContentFormatTransformer(ContentFormatter) - Constructor for class org.springframework.ai.transformer.ContentFormatTransformer

Creates a ContentFormatTransformer object with the given ContentFormatter.

ContentFormatTransformer(ContentFormatter, boolean) - Constructor for class org.springframework.ai.transformer.ContentFormatTransformer

The ContentFormatTransformer class is responsible for processing a list of documents by applying a content formatter to each document.

contentLengthFunction(Function<String, Integer>) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder

contentRefRoundTrip() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

contents() - Method in record class org.springframework.ai.google.genai.GoogleGenAiChatModel.GeminiRequest

Returns the value of the contents record component.

contents(List<Content>) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent.Builder

contents(List<Content>) - Method in class org.springframework.ai.google.genai.cache.CachedContentRequest.Builder

ContentSerializer() - Constructor for class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ContentSerializer

contentType - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

contentType - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

contentType() - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

Returns the content type of the resource.

contentType(AbstractMcpResourceMethodCallback.ContentType) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

Set the content type.

context() - Method in record class org.springframework.ai.chat.client.ChatClientRequest

Returns the value of the context record component.

context() - Method in record class org.springframework.ai.chat.client.ChatClientResponse

Returns the value of the context record component.

context() - Method in record class org.springframework.ai.rag.Query

Returns the value of the context record component.

context(String) - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder

Set the document context.

context(String, Object) - Method in class org.springframework.ai.chat.client.ChatClientRequest.Builder

context(String, Object) - Method in class org.springframework.ai.chat.client.ChatClientResponse.Builder

context(Map<String, ? extends Object>) - Method in class org.springframework.ai.chat.client.ChatClientRequest.Builder

context(Map<String, ? extends Object>) - Method in class org.springframework.ai.chat.client.ChatClientResponse.Builder

context(Map<String, Object>) - Method in class org.springframework.ai.rag.Query.Builder

CONTEXT_STR_PLACEHOLDER - Static variable in class org.springframework.ai.model.transformer.KeywordMetadataEnricher

contextExtractor(McpTransportContextExtractor<ServerRequest>) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider.Builder

Deprecated.

Sets the context extractor that allows providing the MCP feature implementations to inspect HTTP transport level metadata that was present at HTTP request processing time.

contextExtractor(McpTransportContextExtractor<ServerRequest>) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStatelessServerTransport.Builder

Sets the context extractor that allows providing the MCP feature implementations to inspect HTTP transport level metadata that was present at HTTP request processing time.

contextExtractor(McpTransportContextExtractor<ServerRequest>) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider.Builder

Sets the context extractor that allows providing the MCP feature implementations to inspect HTTP transport level metadata that was present at HTTP request processing time.

contextExtractor(McpTransportContextExtractor<ServerRequest>) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider.Builder

Deprecated.

Sets the context extractor that allows providing the MCP feature implementations to inspect HTTP transport level metadata that was present at HTTP request processing time.

contextExtractor(McpTransportContextExtractor<ServerRequest>) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStatelessServerTransport.Builder

Sets the context extractor that allows providing the MCP feature implementations to inspect HTTP transport level metadata that was present at HTTP request processing time.

contextExtractor(McpTransportContextExtractor<ServerRequest>) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider.Builder

Sets the context extractor that allows providing the MCP feature implementations to inspect HTTP transport level metadata that was present at HTTP request processing time.

ContextualQueryAugmenter - Class in org.springframework.ai.rag.generation.augmentation

Augments the user query with contextual data from the content of the provided documents.

ContextualQueryAugmenter(PromptTemplate, PromptTemplate, Boolean, Function<List<Document>, String>) - Constructor for class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter

ContextualQueryAugmenter.Builder - Class in org.springframework.ai.rag.generation.augmentation

Conversation - Record Class in org.springframework.ai.chat.memory.repository.mongo

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory: org.springframework.ai.session.SessionRepository in spring-ai-session, with a JDBC store in spring-ai-session-jdbc. There is no session store for MongoDB yet; one is planned before 3.0.0, when this module is removed.

Conversation(String, Conversation.Message, Instant) - Constructor for record class org.springframework.ai.chat.memory.repository.mongo.Conversation

Deprecated.

Creates an instance of a Conversation record class.

CONVERSATION_HISTORY - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCacheStrategy

Cache the entire conversation history up to (but not including) the current user question.

CONVERSATION_HISTORY - Enum constant in enum class org.springframework.ai.bedrock.converse.api.BedrockCacheStrategy

Cache the entire conversation history up to and including the current user question.

CONVERSATION_ID - Static variable in interface org.springframework.ai.chat.client.advisor.api.MemoryAdvisor

The advisor context key of the conversation a request belongs to.

CONVERSATION_ID - Static variable in interface org.springframework.ai.chat.memory.ChatMemory

Deprecated.

The key to retrieve the chat memory conversation id from the context.

CONVERSATION_TS - Static variable in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepository

Deprecated.

CONVERSATION_TS - Static variable in class org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepository

Deprecated.

Metadata key under which each message's creation timestamp (an Instant) is exposed when messages are read back from the repository.

Conversation.Message - Record Class in org.springframework.ai.chat.memory.repository.mongo

Deprecated.

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<Message>) - Method in class org.springframework.ai.model.tool.DefaultToolExecutionResult.Builder

conversationHistoryEnabled(boolean) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder

Sets whether internal conversation history is enabled.

conversationId() - Method in record class org.springframework.ai.chat.memory.repository.mongo.Conversation

Deprecated.

Returns the value of the conversationId record component.

conversationId() - Method in record class org.springframework.ai.chat.memory.repository.redis.AdvancedRedisChatMemoryRepository.MessageWithConversation

Deprecated.

Returns the value of the conversationId record component.

conversationId(KeyValues, ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

ConverseApiUtils - Class in org.springframework.ai.bedrock.converse.api

Amazon Bedrock Converse API utils.

ConverseChatResponseStream - Class in org.springframework.ai.bedrock.converse.api

Sends a ConverseStreamRequest to Bedrock and returns ChatResponse stream.

ConverseChatResponseStream(BedrockRuntimeAsyncClient, ConverseStreamRequest, Usage) - Constructor for class org.springframework.ai.bedrock.converse.api.ConverseChatResponseStream

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

convert(MediaPart.MediaDto) - Method in class org.springframework.ai.chat.messages.part.MediaPart.FromDto

convert(ToolContext) - Method in interface org.springframework.ai.mcp.ToolContextToMcpMetaConverter

Convert the given ToolContext to a Map<String, Object> as MCP tool call metadata.

convert(Media) - Method in class org.springframework.ai.chat.messages.part.MediaPart.ToDto

convert(Filter.Operand) - Method in class org.springframework.ai.vectorstore.coherence.CoherenceFilterExpressionConverter

convertArgumentValue(Object, Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback

Converts an argument value to the expected parameter type.

convertDocumentToObject(Document) - Static method in class org.springframework.ai.bedrock.converse.api.ConverseApiUtils

Converts an AWS SDK Document into a plain Java object (Map, List, String, Boolean, BigDecimal or null).

convertExpression(Filter.Expression) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseFilterExpressionConverter

Converts a Spring AI filter expression to a Bedrock RetrievalFilter.

convertExpression(Filter.Expression) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

convertExpression(Filter.Expression) - Method in interface org.springframework.ai.vectorstore.filter.FilterExpressionConverter

Convert the given Filter.Expression into a String representation.

convertExpression(Filter.Expression) - Method in class org.springframework.ai.vectorstore.oracle.SqlJsonPathFilterExpressionConverter

This is the entry point to this converter and returns a valid SQL fragment string.

convertExpression(Filter.Expression) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorFilterExpressionConverter

convertExpression(Filter.Expression) - Method in interface org.springframework.ai.vectorstore.s3.S3VectorFilterExpressionConverter

Convert the given Filter.Expression into a Document representation.

convertExpression(Filter.Expression) - Method in class org.springframework.ai.vectorstore.s3.S3VectorFilterSearchExpressionConverter

convertFromMap(Map<String, Object>, Class<T>) - Method in class org.springframework.ai.util.JsonHelper

Converts a map to a Java object.

convertFromMap(Map<String, Object>, ParameterizedTypeReference<T>) - Method in class org.springframework.ai.util.JsonHelper

Converts a map to a Java object.

convertObjectToDocument(Object) - Static method in class org.springframework.ai.bedrock.converse.api.ConverseApiUtils

convertOperand(Filter.Operand) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Convert the given operand into a string representation.

convertOperand(Filter.Operand) - Method in class org.springframework.ai.vectorstore.oracle.SqlJsonPathFilterExpressionConverter

Convert the filter operand to a json path expression.

convertOperand(Filter.Operand, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Convert the given operand into a string representation.

convertQueryToRegexPattern(String) - Method in class org.springframework.ai.tool.toolsearch.index.regex.RegexToolIndex

Converts a natural-language query into a case-insensitive OR regex pattern.

convertToCallToolResult(Object) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractAsyncMcpToolMethodCallback

Convert reactive types to Mono

convertToGetPromptResult(Object) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback

Converts a method result to a GetPromptResult.

convertToMap(Object) - Method in class org.springframework.ai.util.JsonHelper

convertToOpenApiSchema(ObjectNode) - Static method in class org.springframework.ai.google.genai.schema.JsonSchemaConverter

Converts a JSON Schema ObjectNode to OpenAPI schema format.

convertToReadResourceResult(Object, String, String, AbstractMcpResourceMethodCallback.ContentType) - Method in class org.springframework.ai.mcp.annotation.method.resource.DefaultMcpReadResourceResultConverter

Converts the method's return value to a McpSchema.ReadResourceResult.

convertToReadResourceResult(Object, String, String, AbstractMcpResourceMethodCallback.ContentType) - Method in interface org.springframework.ai.mcp.annotation.method.resource.McpReadResourceResultConverter

Converts the method's return value to a McpSchema.ReadResourceResult.

convertToReadResourceResult(Object, String, String, AbstractMcpResourceMethodCallback.ContentType, Map<String, Object>) - Method in class org.springframework.ai.mcp.annotation.method.resource.DefaultMcpReadResourceResultConverter

Converts the method's return value to a McpSchema.ReadResourceResult, propagating resource-level metadata to the content items.

convertToReadResourceResult(Object, String, String, AbstractMcpResourceMethodCallback.ContentType, Map<String, Object>) - Method in interface org.springframework.ai.mcp.annotation.method.resource.McpReadResourceResultConverter

Converts the method's return value to a McpSchema.ReadResourceResult, propagating resource-level metadata to the content items.

convertToTypedObject(Object, Class<?>) - Method in class org.springframework.ai.util.JsonHelper

Convert a Java Object to a typed Object.

convertTypeValuesToUpperCase(ObjectNode) - Static method in class org.springframework.ai.util.json.schema.JsonSchemaGenerator

convertValueToCallToolResult(Object) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractMcpToolMethodCallback

Converts a method result value to a CallToolResult based on the return mode and type.

COPIED - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.StatusEnum

COPIED_DISABLED - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.StatusEnum

copy() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder

Creates a shallow copy of this builder with all current settings.

copy() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor.Builder

copy() - Method in record class org.springframework.ai.chat.client.ChatClientRequest

copy() - Method in record class org.springframework.ai.chat.client.ChatClientResponse

copy() - Method in class org.springframework.ai.chat.messages.AssistantMessage

copy() - Method in class org.springframework.ai.chat.messages.SystemMessage

copy() - Method in class org.springframework.ai.chat.messages.UserMessage

copy() - Method in class org.springframework.ai.chat.prompt.Prompt

copy(CallAdvisor) - Method in interface org.springframework.ai.chat.client.advisor.api.CallAdvisorChain

Creates a new CallAdvisorChain copy that contains all advisors after the specified advisor.

copy(CallAdvisor) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain

copy(StreamAdvisor) - Method in interface org.springframework.ai.chat.client.advisor.api.StreamAdvisorChain

Creates a new StreamAdvisorChain copy that contains all advisors after the specified advisor.

copy(StreamAdvisor) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain

copyFrom(FiltersParser.BooleanExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.BooleanExpressionContext

copyFrom(FiltersParser.ConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantContext

copyFrom(FiltersParser.IdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IdentifierContext

copyModel(OllamaApi.CopyModelRequest) - Method in class org.springframework.ai.ollama.api.OllamaApi

Copy a model.

CopyModelRequest(String, String) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.CopyModelRequest

Creates an instance of a CopyModelRequest record class.

CORAL - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Voice

CORAL - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.Voice

cosine - Enum constant in enum class org.springframework.ai.vectorstore.elasticsearch.SimilarityFunction

COSINE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric

The cosine metric.

COSINE - Enum constant in enum class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Similarity

COSINE - Enum constant in enum class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore.DistanceType

Default dist.

COSINE - Enum constant in enum class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBDistanceType

COSINE - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusMetricType

Cosine distance

COSINE - Enum constant in enum class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Neo4jDistanceType

COSINE - Enum constant in enum class org.springframework.ai.vectorstore.oracle.OracleVectorStore.OracleVectorStoreDistanceType

Default metric.

COSINE - Enum constant in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.DistanceMetric

COSINE_DISTANCE - Enum constant in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgDistanceType

COSINE_SIMILARITY_FUNCTION - Static variable in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

cosineSimilarity(float[], float[]) - Static method in class org.springframework.ai.vectorstore.SimpleVectorStore.EmbeddingMath

costPriority(Double) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec.DefaultModelPreferenceSpec

costPriority(Double) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.ModelPreferenceSpec

COUCHBASE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by Couchbase.

CouchbaseAiSearchFilterExpressionConverter - Class in org.springframework.ai.vectorstore.couchbase

CouchbaseAiSearchFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.couchbase.CouchbaseAiSearchFilterExpressionConverter

CouchbaseDocument(String, String, Map<String, Object>, float[]) - Constructor for record class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.CouchbaseDocument

Creates an instance of a CouchbaseDocument record class.

CouchbaseIndexOptimization - Enum Class in org.springframework.ai.vectorstore.couchbase

Choose whether the Vector store should prioritize recall or latency when returning similar vectors in search results.

CouchbaseSearchVectorStore - Class in org.springframework.ai.vectorstore.couchbase

CouchbaseSearchVectorStore(CouchbaseSearchVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore

CouchbaseSearchVectorStore.Builder - Class in org.springframework.ai.vectorstore.couchbase

CouchbaseSearchVectorStore.CouchbaseDocument - Record Class in org.springframework.ai.vectorstore.couchbase

CouchbaseSearchVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.couchbase.autoconfigure

CouchbaseSearchVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreAutoConfiguration

CouchbaseSearchVectorStoreProperties - Class in org.springframework.ai.vectorstore.couchbase.autoconfigure

CouchbaseSearchVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

CouchbaseSimilarityFunction - Enum Class in org.springframework.ai.vectorstore.couchbase

Choose the method to calculate the similarity between the vector embedding in a Vector Search index and the vector embedding in a Vector Search query.

count() - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

Count all documents in the vector store.

count(String) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

Count documents that match a filter expression string.

count(Filter.Expression) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

Count documents that match a filter expression.

countEmbeddings(String, String, String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

country() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation

Returns the value of the country record component.

covered() - Method in record class org.springframework.ai.session.compaction.SummaryRequest

Returns the value of the covered record component.

coveredEventCount() - Method in record class org.springframework.ai.session.compaction.CompactionBoundary

Returns the value of the coveredEventCount record component.

coveredEventCount() - Method in record class org.springframework.ai.session.compaction.CompactionResult

The number of events that leave the view.

coveredEvents() - Method in record class org.springframework.ai.session.compaction.CompactionResult

Returns the value of the coveredEvents record component.

create() - Static method in interface org.springframework.ai.audio.transcription.AudioTranscriptionMetadata

Factory method used to construct a new AudioTranscriptionMetadata

create() - Static method in class org.springframework.ai.bedrock.MessageToPromptConverter

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(String) - Static method in class org.springframework.ai.bedrock.MessageToPromptConverter

create(Map<String, Object>) - Method in class org.springframework.ai.chat.prompt.AssistantPromptTemplate

create(Map<String, Object>) - Method in class org.springframework.ai.chat.prompt.ChatPromptTemplate

create(Map<String, Object>) - Method in class org.springframework.ai.chat.prompt.PromptTemplate

create(Map<String, Object>) - Method in interface org.springframework.ai.chat.prompt.PromptTemplateActions

create(Map<String, Object>) - Method in class org.springframework.ai.chat.prompt.SystemPromptTemplate

create(Map<String, Object>, ChatOptions) - Method in class org.springframework.ai.chat.prompt.ChatPromptTemplate

create(Map<String, Object>, ChatOptions) - Method in class org.springframework.ai.chat.prompt.PromptTemplate

create(Map<String, Object>, ChatOptions) - Method in interface org.springframework.ai.chat.prompt.PromptTemplateActions

create(CassandraChatMemoryRepositoryConfig) - Static method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepository

Deprecated.

create(ChatModel) - Static method in interface org.springframework.ai.chat.client.ChatClient

create(ChatModel, ObservationRegistry) - Static method in interface org.springframework.ai.chat.client.ChatClient

create(ChatModel, ObservationRegistry, ChatClientObservationConvention, AdvisorObservationConvention) - Static method in interface org.springframework.ai.chat.client.ChatClient

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

create(CachedContentRequest) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService

Creates cached content from the given request.

create(CreateSessionRequest) - Method in class org.springframework.ai.session.DefaultSessionService

create(CreateSessionRequest) - Method in interface org.springframework.ai.session.SessionService

Creates a session with the request's id, a random UUID when it has none, its time to live and its metadata.

createAsync(CachedContentRequest) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService

Asynchronously creates cached content from the given request.

createAsyncErrorResult(Exception) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractAsyncMcpToolMethodCallback

Creates an error result for exceptions that occur during method invocation.

createCollection(String, String, ChromaApi.CreateCollectionRequest) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

CreateCollectionRequest(String) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateCollectionRequest

CreateCollectionRequest(String, Map<String, Object>) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateCollectionRequest

Creates an instance of a CreateCollectionRequest record class.

created() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion

Returns the value of the created record component.

created() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk

Returns the value of the created record component.

created() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion

Returns the value of the created record component.

created() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk

Returns the value of the created record component.

CREATED_AT - Static variable in class org.springframework.ai.openai.responses.OpenAiResponsesMetadata

The response creation timestamp, in seconds since the epoch.

createdAt() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Returns the value of the createdAt record component.

createdAt() - Method in class org.springframework.ai.session.Session

When the session was created.

createdAt(Instant) - Method in class org.springframework.ai.session.Session.Builder

createDatabase(String, String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

CreateDatabaseRequest(String) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateDatabaseRequest

Creates an instance of a CreateDatabaseRequest record class.

createdAtUnix() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the createdAtUnix record component.

createDocument(String, Integer) - Method in class org.springframework.ai.test.vectorstore.BaseVectorStoreTests

createErrorMessage(Throwable) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractMcpToolMethodCallback

Creates the base error message for exceptions that occur during method invocation.

createIndex() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

Creates a new index in the GemFireVectorStore using specified parameters.

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<Media>) - Method in class org.springframework.ai.chat.prompt.PromptTemplate

createMessage(List<Media>) - Method in interface org.springframework.ai.chat.prompt.PromptTemplateMessageActions

createMessage(Map<String, Object>) - Method in class org.springframework.ai.chat.prompt.AssistantPromptTemplate

createMessage(Map<String, Object>) - Method in class org.springframework.ai.chat.prompt.PromptTemplate

createMessage(Map<String, Object>) - Method in interface org.springframework.ai.chat.prompt.PromptTemplateMessageActions

createMessage(Map<String, Object>) - 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<String, Object>) - Method in class org.springframework.ai.chat.prompt.ChatPromptTemplate

createMessages(Map<String, Object>) - Method in interface org.springframework.ai.chat.prompt.PromptTemplateChatActions

createObservationContextBuilder(String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

Create a new VectorStoreObservationContext.Builder instance.

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.s3.S3VectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.SimpleVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore

createRepository() - Method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

Returns the repository under test.

CreateRequest(String, int, int, String, String[], int) - Constructor for class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.CreateRequest

createRequestContext(McpTransportContext, McpSchema.CallToolRequest) - Method in class org.springframework.ai.mcp.annotation.method.tool.AsyncStatelessMcpToolMethodCallback

createRequestContext(McpTransportContext, McpSchema.CallToolRequest) - Method in class org.springframework.ai.mcp.annotation.method.tool.SyncStatelessMcpToolMethodCallback

createRequestContext(McpAsyncServerExchange, McpSchema.CallToolRequest) - Method in class org.springframework.ai.mcp.annotation.method.tool.AsyncMcpToolMethodCallback

createRequestContext(McpSyncServerExchange, McpSchema.CallToolRequest) - Method in class org.springframework.ai.mcp.annotation.method.tool.SyncMcpToolMethodCallback

createRequestContext(T, McpSchema.CallToolRequest) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractMcpToolMethodCallback

createReturnDirectWeatherToolCallback() - Method in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorAutoRegistrationIT

createReturnDirectWeatherToolCallback() - Method in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorIT

Creates a weather tool callback with returnDirect=true.

CreateSessionRequest - Class in org.springframework.ai.session

What SessionService.create(org.springframework.ai.session.CreateSessionRequest) needs: an id, a time to live and metadata, each optional.

CreateSessionRequest.Builder - Class in org.springframework.ai.session

createStoreOverExistingSchema(VectorStore, EmbeddingModel) - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

Build a second store over the schema that the store from AbstractVectorStoreUpsertTests.executeTest(Consumer) has already created, the way an application that only writes pre-computed vectors would: schema initialization off, no configured dimension, and the given embedding model.

createStoreWithConfiguredDimensions(VectorStore, EmbeddingModel, int) - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

Build and initialize a store over a new schema of its own, separate from the one used by AbstractVectorStoreUpsertTests.executeTest(Consumer), with schema initialization on and the given dimension configured.

createSyncErrorResult(Exception) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractSyncMcpToolMethodCallback

Creates an error result for exceptions that occur during method invocation.

createTenant(String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

CreateTenantRequest(String) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateTenantRequest

Creates an instance of a CreateTenantRequest record class.

createTime(Instant) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent.Builder

createToolDefinition(String, McpSchema.Tool) - Static method in class org.springframework.ai.mcp.McpToolUtils

Creates a Spring AI ToolDefinition from an MCP Tool.

createVectorStore(RedisClient, EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.redis.cache.semantic.RedisVectorStoreHelper

Creates a pre-configured RedisVectorStore suitable for semantic caching.

createVectorStore(RedisClient, EmbeddingModel, String, String) - Static method in class org.springframework.ai.vectorstore.redis.cache.semantic.RedisVectorStoreHelper

Creates a pre-configured RedisVectorStore with custom index name and prefix.

createWeatherToolCallback() - Method in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorAutoRegistrationIT

createWeatherToolCallback() - Method in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorIT

Creates the weather tool callback used in tests.

credential - Variable in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

credential - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

credential - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

credential(Credential) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

credential(Credential) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

credential(Credential) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

credentials(GoogleCredentials) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageConnectionDetails.Builder

Sets the GoogleCredentials to use for Vertex AI mode authentication.

credentials(GoogleCredentials) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionConnectionDetails.Builder

Sets the Google credentials (Vertex AI mode).

credentials(GoogleCredentials) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechConnectionDetails.Builder

credentialsProvider(BedrockAwsConnectionProperties) - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionConfiguration

credentialsProvider(AwsCredentialsProvider) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder

criminal() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Returns the value of the criminal record component.

criminal() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Returns the value of the criminal record component.

criminal(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder

criminal(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder

CurlyBracketEscaper - Class in org.springframework.ai.test

Utility class for escaping curly brackets in strings

CURRENT - Enum constant in enum class org.springframework.ai.model.transformer.SummaryMetadataEnricher.SummaryType

currentTurnCount() - Method in record class org.springframework.ai.session.compaction.CompactionRequest

Returns the value of the currentTurnCount record component.

CUSTOM - Enum constant in enum class org.springframework.ai.anthropic.AnthropicSkillType

Custom skills uploaded to the workspace.

CUSTOM_CONTENT - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCitationDocument.DocumentType

Custom content with user-defined blocks and block-based citations.

customContent(String...) - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder

Create a custom content document from text blocks.

customHeaders - Variable in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

customHeaders - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

customHeaders - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

customHeaders(Map<String, String>) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

customHeaders(Map<String, String>) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

customHeaders(Map<String, String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

customHeaders(Map<String, String>) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

customize(McpServer.AsyncSpecification<?>) - Method in interface org.springframework.ai.mcp.customizer.McpAsyncServerCustomizer

customize(McpServer.StatelessAsyncSpecification) - Method in interface org.springframework.ai.mcp.customizer.McpStatelessAsyncServerCustomizer

customize(McpServer.StatelessSyncSpecification) - Method in interface org.springframework.ai.mcp.customizer.McpStatelessSyncServerCustomizer

customize(McpServer.SyncSpecification<?>) - Method in interface org.springframework.ai.mcp.customizer.McpSyncServerCustomizer

customize(String, B) - Method in interface org.springframework.ai.mcp.customizer.McpClientCustomizer

Customizes an MCP client component.

customize(String, McpClient.AsyncSpec) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.McpAsyncToolsChangeEventEmmiter

customize(String, McpClient.SyncSpec) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.McpSyncToolsChangeEventEmmiter

customize(SpringAiAnthropicHttpClient.Builder) - Method in interface org.springframework.ai.anthropic.http.okhttp.AnthropicHttpClientBuilderCustomizer

Customize the SpringAiAnthropicHttpClient.Builder prior to building the underlying OkHttp client.

customize(ChatClient.Builder) - Method in interface org.springframework.ai.chat.client.ChatClientBuilderCustomizer

Callback to customize a ChatClient.Builder instance.

customize(ChatClient.Builder) - Method in interface org.springframework.ai.chat.client.ChatClientCustomizer

Deprecated.

Callback to customize a ChatClient.Builder instance.

customize(SpringAiOpenAiHttpClient.Builder) - Method in interface org.springframework.ai.openai.http.okhttp.OpenAiHttpClientBuilderCustomizer

Customize the SpringAiOpenAiHttpClient.Builder prior to building the underlying OkHttp client.

customObservationConvention - Variable in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

customObservationConvention(VectorStoreObservationConvention) - Method in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

customObservationConvention(ChatModelObservationConvention) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder

customObservationConvention(VectorStoreObservationConvention) - Method in interface org.springframework.ai.vectorstore.VectorStore.Builder

Sets a custom convention for creating observations.

D

dangerous() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Returns the value of the dangerous record component.

dangerous() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Returns the value of the dangerous record component.

dangerous(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder

dangerous(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder

dangerousAndCriminalContent(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder

Deprecated, for removal: This API element is subject to removal in a future version.

dangerousAndCriminalContent(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder

Deprecated, for removal: This API element is subject to removal in a future version.

data() - Method in record class org.springframework.ai.chat.messages.part.MediaPart.MediaDto

Returns the value of the data record component.

data() - Method in record class org.springframework.ai.chat.messages.part.OpaquePayload

Returns the value of the data record component.

data() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingList

Returns the value of the data record component.

data(byte[]) - Method in class org.springframework.ai.content.Media.Builder

Sets the media data from a byte array.

data(String) - Method in class org.springframework.ai.content.Media.Builder

Sets the media data from a String.

data(URI) - Method in class org.springframework.ai.content.Media.Builder

Sets the media data from a URI.

data(URL) - Method in class org.springframework.ai.content.Media.Builder

Sets the media data from a URL.

data(Resource) - Method in class org.springframework.ai.content.Media.Builder

Sets the media data from a Resource.

DATA - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.MediaAttributes

Deprecated.

Database(String) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.Database

Creates an instance of a Database record class.

databaseName(String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaVectorStore.Builder

Sets the database name.

databaseName(String) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore.Builder

Configures the Milvus database name.

databaseName(String) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Builder

Sets the database name.

dataKind() - Method in record class org.springframework.ai.chat.messages.part.MediaPart.MediaDto

Returns the value of the dataKind record component.

datasetDurationSeconds() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns the value of the datasetDurationSeconds record component.

dataSource(DataSource) - Method in class org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepository.Builder

Deprecated.

dataSource(DataSource) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository.Builder

The data source; the dialect is detected from it unless set.

date(String) - Static method in record class org.springframework.ai.vectorstore.azure.AzureVectorStore.MetadataField

dateCheckedUnix() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharingModerationCheck

Returns the value of the dateCheckedUnix record component.

dateUnix() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerificationAttempt

Returns the value of the dateUnix record component.

dateUnix() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the dateUnix record component.

DB_COLLECTION_NAME - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

The name of a collection (table, container) within the database.

DB_COLLECTION_NAME - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.HighCardinalityKeyNames

The name of a collection (table, container) within the database.

DB_NAMESPACE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

The name of the database, fully qualified within the server address and port.

DB_NAMESPACE - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.HighCardinalityKeyNames

The namespace of the database.

DB_OPERATION_NAME - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

The name of the operation or command being executed.

DB_OPERATION_NAME - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.LowCardinalityKeyNames

The name of the operation or command being executed.

DB_RECORD_ID - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

The record identifier if present.

DB_SEARCH_SIMILARITY_METRIC - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

The metric used in similarity search.

DB_SEARCH_SIMILARITY_METRIC - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.HighCardinalityKeyNames

The metric used in similarity search.

DB_SYSTEM - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

The database management system (DBMS) product as identified by the client instrumentation.

DB_SYSTEM - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.LowCardinalityKeyNames

The database management system (DBMS) product as identified by the client instrumentation.

DB_VECTOR_DIMENSION_COUNT - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

The dimension of the vector.

DB_VECTOR_DIMENSION_COUNT - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.HighCardinalityKeyNames

The dimension of the vector.

DB_VECTOR_FIELD_NAME - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

The name field of the vector (e.g. a field name).

DB_VECTOR_FIELD_NAME - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.HighCardinalityKeyNames

The name field as of the vector (e.g. a field name).

DB_VECTOR_QUERY_CONTENT - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

The content of the search query being executed.

DB_VECTOR_QUERY_CONTENT - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.HighCardinalityKeyNames

The content of the search query being executed.

DB_VECTOR_QUERY_FILTER - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

The metadata filters used in the search query.

DB_VECTOR_QUERY_FILTER - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.HighCardinalityKeyNames

The metadata filters used in the search query.

DB_VECTOR_QUERY_RESPONSE_DOCUMENTS - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

Returned documents from a similarity search query.

DB_VECTOR_QUERY_SIMILARITY_THRESHOLD - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

Similarity threshold that accepts all search scores.

DB_VECTOR_QUERY_SIMILARITY_THRESHOLD - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.HighCardinalityKeyNames

Similarity threshold that accepts all search scores.

DB_VECTOR_QUERY_TOP_K - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

The top-k most similar vectors returned by a query.

DB_VECTOR_QUERY_TOP_K - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.HighCardinalityKeyNames

The top-k most similar vectors returned by a query.

dbOperationName(VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

dbSystem(VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

debug(String) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

debug(String) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

debug(String) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

debug(String) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

decimal(String) - Static method in record class org.springframework.ai.vectorstore.azure.AzureVectorStore.MetadataField

DECIMAL_VALUE - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

DECIMAL_VALUE - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

DECIMAL_VALUE() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.DecimalConstantContext

DecimalConstantContext(FiltersParser.ConstantContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.DecimalConstantContext

decisionOn(String) - Method in record class org.springframework.ai.model.tool.ToolCallDecisions

The decision on the tool call with the key, or null when there is none.

decisions() - Method in record class org.springframework.ai.model.tool.ToolCallDecisions

Returns the value of the decisions record component.

DECLINED - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.ReviewStatusEnum

decode(SessionEventCodec.EncodedEvent) - Method in class org.springframework.ai.session.support.SessionEventCodec

Rebuilds an event from its persisted shape, as a builder: the codec restores the type, the message or the payload, and the caller adds identity, timestamp and metadata.

decorate(SessionService) - Method in interface org.springframework.ai.model.session.autoconfigure.SessionServiceDecorator

Returns the service to expose in place of the given one.

DEEPSEEK - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider

AI system provided by DeepSeek.

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

DEEPSEEK_CHAT - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatModel

Deprecated.

DeepSeek has announced this legacy model name will be deprecated. Prefer DeepSeekApi.ChatModel.DEEPSEEK_V4_FLASH or DeepSeekApi.ChatModel.DEEPSEEK_V4_PRO.

DEEPSEEK_REASONER - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatModel

Deprecated.

DeepSeek has announced this legacy model name will be deprecated. Prefer DeepSeekApi.ChatModel.DEEPSEEK_V4_FLASH / DeepSeekApi.ChatModel.DEEPSEEK_V4_PRO with provider-specific reasoning configuration.

DEEPSEEK_V4_FLASH - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatModel

DeepSeek-V4 Flash model.

DEEPSEEK_V4_PRO - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatModel

DeepSeek-V4 Pro model.

deepSeekApi(DeepSeekApi) - Method in class org.springframework.ai.deepseek.DeepSeekChatModel.Builder

DeepSeekApi - Class in org.springframework.ai.deepseek.api

Single class implementation of the DeepSeek Chat Completion API.

DeepSeekApi(String, String, RestClient, WebClient) - Constructor for class org.springframework.ai.deepseek.api.DeepSeekApi

Create a new chat completion api.

DeepSeekApi(String, ApiKey, HttpHeaders, String, String, RestClient.Builder, WebClient.Builder, ResponseErrorHandler) - Constructor for class org.springframework.ai.deepseek.api.DeepSeekApi

Create a new chat completion api.

DeepSeekApi.Builder - Class in org.springframework.ai.deepseek.api

DeepSeekApi.ChatCompletion - Record Class in org.springframework.ai.deepseek.api

Represents a chat completion response returned by model, based on the provided input.

DeepSeekApi.ChatCompletion.Choice - Record Class in org.springframework.ai.deepseek.api

Chat completion choice.

DeepSeekApi.ChatCompletionChunk - Record Class in org.springframework.ai.deepseek.api

Represents a streamed chunk of a chat completion response returned by model, based on the provided input.

DeepSeekApi.ChatCompletionChunk.ChunkChoice - Record Class in org.springframework.ai.deepseek.api

Chat completion choice.

DeepSeekApi.ChatCompletionFinishReason - Enum Class in org.springframework.ai.deepseek.api

The reason the model stopped generating tokens.

DeepSeekApi.ChatCompletionMessage - Record Class in org.springframework.ai.deepseek.api

Message comprising the conversation.

DeepSeekApi.ChatCompletionMessage.ChatCompletionFunction - Record Class in org.springframework.ai.deepseek.api

The function definition.

DeepSeekApi.ChatCompletionMessage.Role - Enum Class in org.springframework.ai.deepseek.api

The role of the author of this message.

DeepSeekApi.ChatCompletionMessage.ToolCall - Record Class in org.springframework.ai.deepseek.api

The relevant tool call.

DeepSeekApi.ChatCompletionRequest - Record Class in org.springframework.ai.deepseek.api

Creates a model response for the given chat conversation.

DeepSeekApi.ChatCompletionRequest.Builder - Class in org.springframework.ai.deepseek.api

Builder for creating DeepSeekApi.ChatCompletionRequest instances.

DeepSeekApi.ChatCompletionRequest.ReasoningEffort - Enum Class in org.springframework.ai.deepseek.api

Controls the reasoning effort level for the DeepSeek model.

DeepSeekApi.ChatCompletionRequest.Thinking - Record Class in org.springframework.ai.deepseek.api

Controls the switch between thinking mode and non-thinking mode.

DeepSeekApi.ChatCompletionRequest.Thinking.Type - Enum Class in org.springframework.ai.deepseek.api

The thinking mode type.

DeepSeekApi.ChatCompletionRequest.ToolChoiceBuilder - Class in org.springframework.ai.deepseek.api

Helper factory that creates a tool_choice of type 'none', 'auto' or selected function by name.

DeepSeekApi.ChatModel - Enum Class in org.springframework.ai.deepseek.api

DeepSeek Chat Completion Models

DeepSeekApi.FunctionTool - Class in org.springframework.ai.deepseek.api

Represents a tool the model may call.

DeepSeekApi.FunctionTool.Function - Class in org.springframework.ai.deepseek.api

Function definition.

DeepSeekApi.FunctionTool.Type - Enum Class in org.springframework.ai.deepseek.api

Create a tool of type 'function' and the given function definition.

DeepSeekApi.LogProbs - Record Class in org.springframework.ai.deepseek.api

Log probability information for the choice.

DeepSeekApi.LogProbs.Content - Record Class in org.springframework.ai.deepseek.api

Message content tokens with log probability information.

DeepSeekApi.LogProbs.Content.TopLogProbs - Record Class in org.springframework.ai.deepseek.api

The most likely tokens and their log probability, at this token position.

DeepSeekApi.Usage - Record Class in org.springframework.ai.deepseek.api

Usage statistics for the completion request.

DeepSeekApi.Usage.PromptTokensDetails - Record Class in org.springframework.ai.deepseek.api

Breakdown of tokens used in the prompt

DeepSeekAssistantMessage - Class in org.springframework.ai.deepseek

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0 for removal: read the reasoning through AssistantMessage.getReasoning(), and build a prefix message as an AssistantMessage whose metadata holds true under DeepSeekChatModel.PREFIX_METADATA_KEY

DeepSeekAssistantMessage(String, String, Boolean, Map<String, Object>, List<AssistantMessage.ToolCall>, List<Media>) - Constructor for class org.springframework.ai.deepseek.DeepSeekAssistantMessage

Deprecated.

DeepSeekAssistantMessage(List<MessagePart>, Map<String, Object>) - Constructor for class org.springframework.ai.deepseek.DeepSeekAssistantMessage

Deprecated.

Creates a message from an ordered list of parts.

DeepSeekAssistantMessage.AbstractBuilder<B extends DeepSeekAssistantMessage.AbstractBuilder<B>> - Class in org.springframework.ai.deepseek

Deprecated.

DeepSeekAssistantMessage.Builder - Class in org.springframework.ai.deepseek

Deprecated.

DeepSeekChatAutoConfiguration - Class in org.springframework.ai.model.deepseek.autoconfigure

Auto-configuration for DeepSeek Chat Model.

DeepSeekChatAutoConfiguration() - Constructor for class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatAutoConfiguration

deepSeekChatModel(DeepSeekConnectionProperties, DeepSeekChatProperties, ObjectProvider<RestClient.Builder>, ObjectProvider<WebClient.Builder>, ToolCallingManager, ObjectProvider<RetryTemplate>, ObjectProvider<ResponseErrorHandler>, ObjectProvider<ObservationRegistry>, ObjectProvider<ChatModelObservationConvention>) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatAutoConfiguration

DeepSeekChatModel - Class in org.springframework.ai.deepseek

ChatModel and StreamingChatModel implementation for DeepSeek backed by DeepSeekApi.

DeepSeekChatModel(DeepSeekApi, DeepSeekChatOptions, ToolCallingManager, RetryTemplate, ObservationRegistry) - Constructor for class org.springframework.ai.deepseek.DeepSeekChatModel

DeepSeekChatModel.Builder - Class in org.springframework.ai.deepseek

DeepSeekChatOptions - Class in org.springframework.ai.deepseek

Chat completions options for the DeepSeek chat API.

DeepSeekChatOptions(String, Double, Integer, Double, ResponseFormat, List<String>, Double, Double, Boolean, Integer, List<DeepSeekApi.FunctionTool>, Object, DeepSeekApi.ChatCompletionRequest.Thinking, DeepSeekApi.ChatCompletionRequest.ReasoningEffort, List<ToolCallback>, Map<String, Object>) - Constructor for class org.springframework.ai.deepseek.DeepSeekChatOptions

DeepSeekChatOptions.AbstractBuilder<B extends DeepSeekChatOptions.AbstractBuilder<B>> - Class in org.springframework.ai.deepseek

DeepSeekChatOptions.Builder - Class in org.springframework.ai.deepseek

DeepSeekChatProperties - Class in org.springframework.ai.model.deepseek.autoconfigure

Configuration properties for DeepSeek chat client.

DeepSeekChatProperties() - Constructor for class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

DeepSeekChatProperties.Options - Class in org.springframework.ai.model.deepseek.autoconfigure

DeepSeekConnectionProperties - Class in org.springframework.ai.model.deepseek.autoconfigure

Parent properties for DeepSeek.

DeepSeekConnectionProperties() - Constructor for class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekConnectionProperties

DeepSeekConstants - Class in org.springframework.ai.deepseek.api.common

DeepSeekParentProperties - Class in org.springframework.ai.model.deepseek.autoconfigure

Parent properties for DeepSeek.

DeepSeekParentProperties() - Constructor for class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekParentProperties

DeepSeekRuntimeHints - Class in org.springframework.ai.deepseek.aot

The DeepSeekRuntimeHints class is responsible for registering runtime hints for DeepSeek API classes.

DeepSeekRuntimeHints() - Constructor for class org.springframework.ai.deepseek.aot.DeepSeekRuntimeHints

DeepSeekStreamFunctionCallingHelper - Class in org.springframework.ai.deepseek.api

Helper class to support Streaming function calling.

DeepSeekStreamFunctionCallingHelper() - Constructor for class org.springframework.ai.deepseek.api.DeepSeekStreamFunctionCallingHelper

DEFAULT_ADD_CONCURRENCY - Static variable in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

DEFAULT_AUDIO_ENCODING - Static variable in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

The default audio encoding used for the synthesized audio.

DEFAULT_BASE_URL - Static variable in class org.springframework.ai.chroma.vectorstore.common.ChromaApiConstants

DEFAULT_BASE_URL - Static variable in class org.springframework.ai.deepseek.api.common.DeepSeekConstants

DEFAULT_BASE_URL - Static variable in class org.springframework.ai.elevenlabs.api.ElevenLabsApi

DEFAULT_BASE_URL - Static variable in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider

Deprecated.

DEFAULT_BASE_URL - Static variable in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider

Default base URL for the message endpoint.

DEFAULT_BASE_URL - Static variable in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekConnectionProperties

DEFAULT_BASE_URL - Static variable in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiCommonProperties

DEFAULT_BASE_URL - Static variable in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiConnectionProperties

DEFAULT_BASE_URL - Static variable in class org.springframework.ai.ollama.api.common.OllamaApiConstants

DEFAULT_BASE_URL - Static variable in class org.springframework.ai.stabilityai.api.StabilityAiApi

DEFAULT_BEAM_WIDTH - Static variable in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

DEFAULT_BETA_PATH - Static variable in class org.springframework.ai.deepseek.api.common.DeepSeekConstants

DEFAULT_BETA_PREFIX_PATH - Static variable in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

DEFAULT_BUCKETS - Static variable in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

DEFAULT_CACHE_DIRECTORY - Static variable in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties

DEFAULT_CHAT_MEMORY_PRECEDENCE_ORDER - Static variable in interface org.springframework.ai.chat.client.advisor.api.Advisor

Default order for chat-memory advisors.

DEFAULT_CHAT_MODEL - Static variable in class org.springframework.ai.deepseek.api.DeepSeekApi

DEFAULT_CHAT_MODEL - Static variable in class org.springframework.ai.openai.OpenAiChatOptions

DEFAULT_CHAT_MODEL - Static variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

DEFAULT_COLLECTION_NAME - Static variable in class org.springframework.ai.chroma.vectorstore.common.ChromaApiConstants

DEFAULT_COLLECTION_NAME - Static variable in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

DEFAULT_COLLECTION_NAME - Static variable in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

DEFAULT_COLLECTION_NAME - Static variable in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

DEFAULT_COLUMN_CONTENT - Static variable in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

DEFAULT_COLUMN_EMBEDDING - Static variable in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

DEFAULT_COLUMN_ID - Static variable in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

DEFAULT_COLUMN_METADATA - Static variable in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

DEFAULT_COMPLETIONS_PATH - Static variable in class org.springframework.ai.deepseek.api.common.DeepSeekConstants

DEFAULT_COMPLETIONS_PATH - Static variable in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

DEFAULT_CONSTRAINT_NAME - Static variable in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

DEFAULT_CONTENT_COLUMN_NAME - Static variable in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

DEFAULT_CONTENT_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

Default name of the content column.

DEFAULT_CONTENT_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

DEFAULT_CONTENT_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.redis.RedisVectorStore

DEFAULT_CONTENT_FORMATTER - Static variable in class org.springframework.ai.document.Document

DEFAULT_DATABASE_NAME - Static variable in class org.springframework.ai.chroma.vectorstore.common.ChromaApiConstants

DEFAULT_DATABASE_NAME - Static variable in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

DEFAULT_DENY_MESSAGE - Static variable in record class org.springframework.ai.model.tool.ToolCallDecision

The result a denied call answers the model with when the decision gives none.

DEFAULT_DIMENSIONS - Static variable in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

DEFAULT_DISTANCE_TYPE - Static variable in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore

DEFAULT_DISTANCE_TYPE - Static variable in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

DEFAULT_EF_CONSTRUCTION - Static variable in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties.HnswProperties

Default value for EF_CONSTRUCTION parameter.

DEFAULT_EF_RUNTIME - Static variable in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties.HnswProperties

Default value for EF_RUNTIME parameter.

DEFAULT_EMBEDDING_COLUMN_NAME - Static variable in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

DEFAULT_EMBEDDING_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

Default name of the embedding column.

DEFAULT_EMBEDDING_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.redis.RedisVectorStore

DEFAULT_EMBEDDING_MODEL - Static variable in class org.springframework.ai.mistralai.MistralAiEmbeddingOptions

DEFAULT_EMBEDDING_MODEL - Static variable in class org.springframework.ai.openai.OpenAiEmbeddingOptions

DEFAULT_EMBEDDING_PROPERTY - Static variable in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

DEFAULT_EMIT_FAILURE_HANDLER - Static variable in class org.springframework.ai.bedrock.api.AbstractBedrockApi

Default emit failure handler.

DEFAULT_EMIT_FAILURE_HANDLER - Static variable in class org.springframework.ai.bedrock.converse.api.ConverseChatResponseStream

DEFAULT_ENCODING_FORMAT - Static variable in class org.springframework.ai.mistralai.MistralAiEmbeddingOptions

DEFAULT_ENDPOINT - Static variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails

DEFAULT_ENDPOINT_SUFFIX - Static variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails

DEFAULT_EXCHANGE_ID_NAME - Static variable in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig

Deprecated.

DEFAULT_FIELDS - Static variable in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

DEFAULT_HOST - Static variable in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

DEFAULT_ID_NAME - Static variable in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

DEFAULT_ID_PROPERTY - Static variable in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

DEFAULT_ID_TYPE - Static variable in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

DEFAULT_IMAGE_MODEL - Static variable in class org.springframework.ai.openai.OpenAiImageOptions

DEFAULT_IMAGE_MODEL - Static variable in class org.springframework.ai.stabilityai.api.StabilityAiApi

DEFAULT_INDEX_NAME - Static variable in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig

Deprecated.

DEFAULT_INDEX_NAME - Static variable in class org.springframework.ai.vectorstore.azure.AzureVectorStore

DEFAULT_INDEX_NAME - Static variable in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

DEFAULT_INDEX_NAME - Static variable in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

DEFAULT_INDEX_NAME - Static variable in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

DEFAULT_INDEX_NAME - Static variable in class org.springframework.ai.vectorstore.redis.RedisVectorStore

DEFAULT_INDEX_SUFFIX - Static variable in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

DEFAULT_INDEX_TYPE - Static variable in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

DEFAULT_INDEXED_ATTRIBUTES - Static variable in class org.springframework.ai.session.jdbc.JdbcSessionRepository

The metadata keys every repository indexes: the principal.

DEFAULT_KEY_PREFIX - Static variable in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig

Deprecated.

DEFAULT_KEYSPACE_NAME - Static variable in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig

Deprecated.

DEFAULT_KEYSPACE_NAME - Static variable in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

DEFAULT_LABEL - Static variable in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

DEFAULT_LOCATION - Static variable in class org.springframework.ai.google.genai.embedding.GoogleGenAiEmbeddingConnectionDetails

DEFAULT_LOCATION - Static variable in class org.springframework.ai.google.genai.image.GoogleGenAiImageConnectionDetails

DEFAULT_LOCATION - Static variable in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionConnectionDetails

DEFAULT_LOCATION - Static variable in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechConnectionDetails

DEFAULT_M - Static variable in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties.HnswProperties

Default value for M parameter.

DEFAULT_MAP_NAME - Static variable in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore

DEFAULT_MAPPING_EMBEDDING_TYPE_KNN_VECTOR_DIMENSION - Static variable in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

DEFAULT_MAX_CALLS_PER_TOOL - Static variable in class org.springframework.ai.model.tool.DefaultToolCallingManager

Default cap applied to every tool name unless overridden via DefaultToolCallingManager.Builder.maxCallsPerTool(String, int), exempted via DefaultToolCallingManager.Builder.excludeToolFromLimit(String), or disabled entirely via DefaultToolCallingManager.Builder.unlimitedCallsPerTool().

DEFAULT_MAX_CONNECTIONS - Static variable in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

DEFAULT_MAX_FETCH_SIZE_BYTES - Static variable in class org.springframework.ai.bedrock.converse.api.MediaFetcher

Maximum number of bytes fetched from a media URL.

DEFAULT_MAX_RESULTS - Static variable in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig

Deprecated.

Default maximum number of results to return (1000 is Redis's default cursor read size).

DEFAULT_MAX_RETRIES - Static variable in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

Default maximum number of retries for the OpenAI client.

DEFAULT_MAX_RETRIES - Static variable in class org.springframework.ai.openai.AbstractOpenAiOptions

Default maximum number of retries for the OpenAI client.

DEFAULT_MAX_TOKENS - Static variable in class org.springframework.ai.anthropic.AnthropicChatOptions

Default max tokens for chat completions.

DEFAULT_MAX_TOTAL_TOOL_CALLS - Static variable in class org.springframework.ai.model.tool.DefaultToolCallingManager

Default cap on the total number of tool calls, across all tools combined, allowed within a turn, unless disabled entirely via DefaultToolCallingManager.Builder.unlimitedTotalToolCalls().

DEFAULT_MEDIA_LABEL - Static variable in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig

Deprecated.

DEFAULT_MESSAGE_ENDPOINT - Static variable in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider

Deprecated.

DEFAULT_MESSAGE_ENDPOINT - Static variable in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider

Deprecated.

DEFAULT_MESSAGE_LABEL - Static variable in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig

Deprecated.

DEFAULT_MESSAGES_COLUMN_NAME - Static variable in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig

Deprecated.

DEFAULT_METADATA_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

Default name of the metadata column.

DEFAULT_METADATA_LABEL - Static variable in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig

Deprecated.

DEFAULT_MODEL - Static variable in class org.springframework.ai.anthropic.AnthropicChatOptions

Default model to use for chat completions.

DEFAULT_MODEL - Static variable in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

The default Gemini-TTS model.

DEFAULT_MODEL_NAME - Static variable in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

DEFAULT_MODEL_NAME - Static variable in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions

DEFAULT_MODEL_NAME - Static variable in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

The default Gemini transcription model name.

DEFAULT_MODEL_NAME - Static variable in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions

DEFAULT_MODEL_NAME - Static variable in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions

DEFAULT_MODEL_OUTPUT_NAME - Static variable in class org.springframework.ai.transformers.TransformersEmbeddingModel

DEFAULT_MODERATION_MODEL - Static variable in class org.springframework.ai.openai.OpenAiModerationOptions

Default moderation model.

DEFAULT_NAME - Static variable in class org.springframework.ai.audio.transcription.observation.DefaultTranscriptionModelObservationConvention

DEFAULT_NAME - Static variable in class org.springframework.ai.audio.tts.observation.DefaultTextToSpeechModelObservationConvention

DEFAULT_NAME - Static variable in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention

DEFAULT_NAME - Static variable in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

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_NAME - Static variable in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

DEFAULT_OBSERVATION_CONVENTION - Static variable in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain

DEFAULT_ONNX_MODEL_URI - Static variable in class org.springframework.ai.transformers.TransformersEmbeddingModel

DEFAULT_ONNX_TOKENIZER_URI - Static variable in class org.springframework.ai.transformers.TransformersEmbeddingModel

DEFAULT_ORDER - Static variable in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

Default advisor order.

DEFAULT_ORDER - Static variable in class org.springframework.ai.session.advisor.SessionTurnAdvisor

Outside the tool-calling advisor (HIGHEST_PRECEDENCE + 300), so the loop runs inside the turn.

DEFAULT_OVERLAP_SIZE - Static variable in class org.springframework.ai.session.compaction.ChatModelSummarizer

Default number of preserved events quoted in the prompt for continuity.

DEFAULT_PORT - Static variable in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

DEFAULT_PREFIX - Static variable in class org.springframework.ai.vectorstore.redis.RedisVectorStore

DEFAULT_PUBLISHER - Static variable in class org.springframework.ai.google.genai.embedding.GoogleGenAiEmbeddingConnectionDetails

DEFAULT_PUBLISHER - Static variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails

DEFAULT_REQUEST_TO_STRING - Static variable in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

DEFAULT_RESPONSE_ERROR_HANDLER - Static variable in class org.springframework.ai.retry.RetryUtils

Default ResponseErrorHandler implementation.

DEFAULT_RESPONSE_FORMAT - Static variable in class org.springframework.ai.openai.OpenAiAudioSpeechOptions

DEFAULT_RESPONSE_FORMAT - Static variable in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

Default response format.

DEFAULT_RESPONSE_TO_STRING - Static variable in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

DEFAULT_RETRY_TEMPLATE - Static variable in class org.springframework.ai.retry.RetryUtils

Default RetryTemplate with exponential backoff configuration.

DEFAULT_SCHEDULER - Static variable in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor

DEFAULT_SCHEMA_NAME - Static variable in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

DEFAULT_SCHEMA_VALIDATION - Static variable in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

DEFAULT_SCHEMA_VALIDATION - Static variable in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

DEFAULT_SEARCH_ACCURACY - Static variable in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

DEFAULT_SESSION_ID_NAME - Static variable in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig

Deprecated.

DEFAULT_SESSION_LABEL - Static variable in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig

Deprecated.

DEFAULT_SHADOW_PROMPT - Static variable in class org.springframework.ai.session.compaction.ChatModelSummarizer

The synthetic user message that opens each summary turn.

DEFAULT_SIMILARITY_FUNCTION - Static variable in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

DEFAULT_SIMILARITY_THRESHOLD - Static variable in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore

DEFAULT_SPEECH_MODEL - Static variable in class org.springframework.ai.openai.OpenAiAudioSpeechOptions

DEFAULT_SPEED - Static variable in class org.springframework.ai.openai.OpenAiAudioSpeechOptions

DEFAULT_SSE_ENDPOINT - Static variable in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider

Deprecated.

Default SSE endpoint path as specified by the MCP transport specification.

DEFAULT_SSE_ENDPOINT - Static variable in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider

Deprecated.

Default SSE endpoint path as specified by the MCP transport specification.

DEFAULT_SSL_ENABLED - Static variable in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

DEFAULT_SUMMARY_EXTRACT_TEMPLATE - Static variable in class org.springframework.ai.model.transformer.SummaryMetadataEnricher

DEFAULT_TABLE_NAME - Static variable in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig

Deprecated.

DEFAULT_TABLE_NAME - Static variable in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

DEFAULT_TABLE_NAME - Static variable in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

DEFAULT_TABLE_NAME - Static variable in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

DEFAULT_TABLE_NAME - Static variable in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

DEFAULT_TENANT_NAME - Static variable in class org.springframework.ai.chroma.vectorstore.common.ChromaApiConstants

DEFAULT_TEXT_PROPERTY - Static variable in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

DEFAULT_TIMEOUT - Static variable in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

Default request timeout for the OpenAI client.

DEFAULT_TIMEOUT - Static variable in class org.springframework.ai.openai.AbstractOpenAiOptions

Default request timeout for the OpenAI client.

DEFAULT_TOOL_CALL_LABEL - Static variable in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig

Deprecated.

DEFAULT_TOOL_EXECUTION_ELIGIBILITY_CHECKER - Static variable in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

DEFAULT_TOOL_RESPONSE_LABEL - Static variable in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig

Deprecated.

DEFAULT_TOP_K - Static variable in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore

DEFAULT_TOP_K - Static variable in class org.springframework.ai.vectorstore.SearchRequest

Default value for the top 'k' similar results to return.

DEFAULT_TRANSACTION_SIZE - Static variable in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

DEFAULT_TRANSCRIPTION_MODEL - Static variable in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

Default transcription model (Whisper 1).

DEFAULT_TRANSCRIPTION_PROMPT - Static variable in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

The default instruction sent alongside the audio.

DEFAULT_TRANSFORMER_MODEL - Static variable in class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions

DEFAULT_VECTOR_ALGORITHM - Static variable in class org.springframework.ai.vectorstore.redis.RedisVectorStore

DEFAULT_VECTOR_COLLECTION_NAME - Static variable in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

DEFAULT_VECTOR_INDEX_NAME - Static variable in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

DEFAULT_VOICE - Static variable in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

The default prebuilt voice.

DEFAULT_VOICE - Static variable in class org.springframework.ai.openai.OpenAiAudioSpeechOptions

DEFAULT_WINDOW - Static variable in class org.springframework.ai.session.compaction.WindowCompactionStrategy

The window of a strategy built without one: the last 20 events.

DefaultAdvisorObservationConvention - Class in org.springframework.ai.chat.client.advisor.observation

Default implementation of the AdvisorObservationConvention.

DefaultAdvisorObservationConvention() - Constructor for class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention

DefaultAdvisorObservationConvention(String) - Constructor for class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention

defaultAdvisors(Consumer<ChatClient.AdvisorSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

defaultAdvisors(Consumer<ChatClient.AdvisorSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

defaultAdvisors(List<Advisor>) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

defaultAdvisors(List<Advisor>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

defaultAdvisors(Advisor...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

defaultAdvisors(Advisor...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

DefaultAdvisorSpec() - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec

DefaultAroundAdvisorChain - Class in org.springframework.ai.chat.client.advisor

Default implementation for the BaseAdvisorChain.

DefaultAroundAdvisorChain.Builder - Class in org.springframework.ai.chat.client.advisor

DefaultCallResponseSpec(ChatClientRequest, BaseAdvisorChain, ObservationRegistry, ChatClientObservationConvention) - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

DefaultChatClient - Class in org.springframework.ai.chat.client

The default implementation of ChatClient as created by the ChatClient.Builder.build() } method.

DefaultChatClient(DefaultChatClient.DefaultChatClientRequestSpec) - Constructor for class org.springframework.ai.chat.client.DefaultChatClient

DefaultChatClient.DefaultAdvisorSpec - Class in org.springframework.ai.chat.client

DefaultChatClient.DefaultCallResponseSpec - Class in org.springframework.ai.chat.client

DefaultChatClient.DefaultChatClientRequestSpec - Class in org.springframework.ai.chat.client

DefaultChatClient.DefaultEntityParamSpec - Class in org.springframework.ai.chat.client

Default implementation of ChatClient.EntityParamSpec.

DefaultChatClient.DefaultPromptSystemSpec - Class in org.springframework.ai.chat.client

DefaultChatClient.DefaultPromptUserSpec - Class in org.springframework.ai.chat.client

DefaultChatClient.DefaultStreamResponseSpec - Class in org.springframework.ai.chat.client

DefaultChatClientBuilder - Class in org.springframework.ai.chat.client

DefaultChatClientBuilder is a builder class for creating a ChatClient.

DefaultChatClientBuilder(ChatModel, ObservationRegistry, ChatClientObservationConvention, AdvisorObservationConvention) - Constructor for class org.springframework.ai.chat.client.DefaultChatClientBuilder

Deprecated, for removal: This API element is subject to removal in a future version.

DefaultChatClientBuilder(ChatModel, ObservationRegistry, ChatClientObservationConvention, AdvisorObservationConvention, ToolCallingAdvisor.Builder<?>) - Constructor for class org.springframework.ai.chat.client.DefaultChatClientBuilder

Creates a new DefaultChatClientBuilder.

DefaultChatClientObservationConvention - Class in org.springframework.ai.chat.client.observation

Default conventions to populate observations for chat client workflows.

DefaultChatClientObservationConvention() - Constructor for class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

DefaultChatClientObservationConvention(String) - Constructor for class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

DefaultChatClientRequestSpec(ChatModel, String, Map<String, Object>, Map<String, Object>, String, Map<String, Object>, Map<String, Object>, List<ToolCallback>, List<ToolCallbackProvider>, List<Message>, List<Media>, ChatOptions.Builder<?>, List<Advisor>, Map<String, Object>, ObservationRegistry, ChatClientObservationConvention, Map<String, Object>, TemplateRenderer, AdvisorObservationConvention, ToolCallingAdvisor.Builder<?>) - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

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(String, Double, Integer, Double, List<String>, Double, Integer, Double) - Constructor for class org.springframework.ai.chat.prompt.DefaultChatOptions

DefaultChatOptionsBuilder<B extends DefaultChatOptionsBuilder<B>> - Class in org.springframework.ai.chat.prompt

Implementation of ChatOptions.Builder to create DefaultChatOptions.

DefaultChatOptionsBuilder() - Constructor for class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

defaultConfig() - Static method in class org.springframework.ai.document.DefaultContentFormatter

Returns the default config.

defaultConfig() - Static method in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig

defaultConfig() - Static method in class org.springframework.ai.reader.markdown.config.MarkdownDocumentReaderConfig

defaultConfig() - Static method in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig

Returns the default config.

DefaultContentFormatter - Class in org.springframework.ai.document

Default implementation of ContentFormatter.

DefaultContentFormatter.Builder - Class in org.springframework.ai.document

defaultConverter() - Static method in interface org.springframework.ai.mcp.ToolContextToMcpMetaConverter

DefaultElicitationSpec - Class in org.springframework.ai.mcp.annotation.context

DefaultElicitationSpec() - Constructor for class org.springframework.ai.mcp.annotation.context.DefaultElicitationSpec

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(String, Integer) - Constructor for class org.springframework.ai.embedding.DefaultEmbeddingOptions

DefaultEmbeddingOptions.Builder - Class in org.springframework.ai.embedding

DefaultEmbeddingOptionsBuilder - Class in org.springframework.ai.embedding

Default implementation of EmbeddingOptions.Builder.

DefaultEmbeddingOptionsBuilder() - Constructor for class org.springframework.ai.embedding.DefaultEmbeddingOptionsBuilder

DefaultEntityParamSpec() - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultEntityParamSpec

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

DefaultLoggingSpec - Class in org.springframework.ai.mcp.annotation.context

DefaultLoggingSpec() - Constructor for class org.springframework.ai.mcp.annotation.context.DefaultLoggingSpec

DefaultMcpAsyncRequestContext - Class in org.springframework.ai.mcp.annotation.context

Async (Reactor) implementation of McpAsyncRequestContext that returns Mono of value types.

DefaultMcpAsyncRequestContext.Builder - Class in org.springframework.ai.mcp.annotation.context

DefaultMcpReadResourceResultConverter - Class in org.springframework.ai.mcp.annotation.method.resource

Default implementation of McpReadResourceResultConverter.

DefaultMcpReadResourceResultConverter() - Constructor for class org.springframework.ai.mcp.annotation.method.resource.DefaultMcpReadResourceResultConverter

DefaultMcpSyncRequestContext - Class in org.springframework.ai.mcp.annotation.context

DefaultMcpSyncRequestContext.Builder - Class in org.springframework.ai.mcp.annotation.context

defaultMcpToolNamePrefixGenerator() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.McpToolCallbackAutoConfiguration

DefaultMcpToolNamePrefixGenerator - Class in org.springframework.ai.mcp

Default implementation of McpToolNamePrefixGenerator that ensures unique tool names for all client/server connections.

DefaultMcpToolNamePrefixGenerator() - Constructor for class org.springframework.ai.mcp.DefaultMcpToolNamePrefixGenerator

DefaultMetaProvider - Class in org.springframework.ai.mcp.annotation.context

Default MetaProvider implementation that disables the "_meta" field in tool, prompt, resource declarations.

DefaultMetaProvider() - Constructor for class org.springframework.ai.mcp.annotation.context.DefaultMetaProvider

DefaultModelPreferenceSpec() - Constructor for class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec.DefaultModelPreferenceSpec

defaultOptions(ChatOptions.Builder) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

defaultOptions(ChatOptions.Builder) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

DefaultProgressSpec - Class in org.springframework.ai.mcp.annotation.context

DefaultProgressSpec() - Constructor for class org.springframework.ai.mcp.annotation.context.DefaultProgressSpec

DefaultPromptSystemSpec() - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec

DefaultPromptUserSpec() - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

defaultRangeThreshold(Double) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the default range threshold for range searches.

defaultRequest - Variable in class org.springframework.ai.chat.client.DefaultChatClientBuilder

defaults() - Static method in record class org.springframework.ai.ollama.management.ModelManagementOptions

defaults() - Static method in class org.springframework.ai.reader.ExtractedTextFormatter

Provides a default instance of the formatter.

DefaultSamplingSpec - Class in org.springframework.ai.mcp.annotation.context

DefaultSamplingSpec() - Constructor for class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

DefaultSamplingSpec.DefaultModelPreferenceSpec - Class in org.springframework.ai.mcp.annotation.context

DefaultSemanticCache - Class in org.springframework.ai.vectorstore.redis.cache.semantic

Default implementation of SemanticCache using Redis as the backing store.

DefaultSemanticCache.Builder - Class in org.springframework.ai.vectorstore.redis.cache.semantic

Builder for creating DefaultSemanticCache instances.

DefaultSessionService - Class in org.springframework.ai.session

The SessionService on a SessionRepository.

DefaultSessionService.Builder - Class in org.springframework.ai.session

defaultSimilarityThreshold(Double) - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore.Builder

Sets the default similarity threshold for returned documents.

DefaultStreamResponseSpec(ChatClientRequest, BaseAdvisorChain, ObservationRegistry, ChatClientObservationConvention) - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamResponseSpec

DefaultStructuredOutputChatOptions - Class in org.springframework.ai.model.tool

Default implementation of StructuredOutputChatOptions.

DefaultStructuredOutputChatOptions(String, Double, Integer, Double, List<String>, Double, Integer, Double, String) - Constructor for class org.springframework.ai.model.tool.DefaultStructuredOutputChatOptions

DefaultStructuredOutputChatOptions.Builder<B extends DefaultStructuredOutputChatOptions.Builder<B>> - Class in org.springframework.ai.model.tool

defaultSystem(String) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

defaultSystem(String) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

defaultSystem(Consumer<ChatClient.PromptSystemSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

defaultSystem(Consumer<ChatClient.PromptSystemSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

defaultSystem(Resource) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

defaultSystem(Resource) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

defaultSystem(Resource, Charset) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

defaultSystem(Resource, Charset) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

defaultTemplateRenderer(TemplateRenderer) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

defaultTemplateRenderer(TemplateRenderer) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

DefaultTextToSpeechModelObservationConvention - Class in org.springframework.ai.audio.tts.observation

Default conventions to populate observations for text-to-speech model operations.

DefaultTextToSpeechModelObservationConvention() - Constructor for class org.springframework.ai.audio.tts.observation.DefaultTextToSpeechModelObservationConvention

DefaultTextToSpeechOptions - Class in org.springframework.ai.audio.tts

Default implementation of the TextToSpeechOptions interface.

DefaultTextToSpeechOptions(String, String, String, Double) - Constructor for class org.springframework.ai.audio.tts.DefaultTextToSpeechOptions

DefaultTextToSpeechOptions.Builder - Class in org.springframework.ai.audio.tts

defaultTimeToLive(Duration) - Method in class org.springframework.ai.session.DefaultSessionService.Builder

The time to live of a session created without one; 60 days by default.

defaultToolCallbacks(List<ToolCallback>) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

Deprecated, for removal: This API element is subject to removal in a future version.

as of 2.0.0, in favor of ChatClient.Builder.defaultTools(Object...). To be removed in 3.0.0.

defaultToolCallbacks(List<ToolCallback>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

Deprecated, for removal: This API element is subject to removal in a future version.

as of 2.0.0, in favor of #defaultTools(Consumer). To be removed in 3.0.0.

defaultToolCallbacks(ToolCallback...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

Deprecated, for removal: This API element is subject to removal in a future version.

as of 2.0.0, in favor of ChatClient.Builder.defaultTools(Object...). To be removed in 3.0.0.

defaultToolCallbacks(ToolCallback...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

Deprecated, for removal: This API element is subject to removal in a future version.

as of 2.0.0, in favor of DefaultChatClientBuilder.defaultTools(Object...). To be removed in 3.0.0.

defaultToolCallbacks(ToolCallbackProvider...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

Deprecated, for removal: This API element is subject to removal in a future version.

as of 2.0.0, in favor of ChatClient.Builder.defaultTools(Object...). To be removed in 3.0.0.

defaultToolCallbacks(ToolCallbackProvider...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

Deprecated, for removal: This API element is subject to removal in a future version.

as of 2.0.0, in favor of #defaultTools(Consumer). To be removed in 3.0.0.

DefaultToolCallingChatOptions - Class in org.springframework.ai.model.tool

Default implementation of ToolCallingChatOptions.

DefaultToolCallingChatOptions(List<ToolCallback>, Map<String, Object>, String, Double, Integer, Double, List<String>, Double, Integer, Double) - Constructor for class org.springframework.ai.model.tool.DefaultToolCallingChatOptions

DefaultToolCallingChatOptions.Builder<B extends DefaultToolCallingChatOptions.Builder<B>> - 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

defaultToolContext(Map<String, Object>) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

defaultToolContext(Map<String, Object>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

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

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<Class<? extends RuntimeException>>) - 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<Message>, 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

Create metadata for a tool that needs no confirmation.

DefaultToolMetadata(boolean, 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

defaultTools(Object...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

Register one or more default tools that will be available to every request built from this ChatClient.Builder.

defaultTools(Object...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

defaultTopK(int) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor.Builder

Set the chat memory retrieve size.

defaultTopK(int) - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore.Builder

Sets the default maximum number of similar documents to return.

DefaultTranscriptionModelObservationConvention - Class in org.springframework.ai.audio.transcription.observation

Default conventions to populate observations for transcription model operations.

DefaultTranscriptionModelObservationConvention() - Constructor for class org.springframework.ai.audio.transcription.observation.DefaultTranscriptionModelObservationConvention

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, Integer, Object, Long, Long) - Constructor for class org.springframework.ai.chat.metadata.DefaultUsage

Create a new DefaultUsage with all fields including prompt cache metrics.

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.

defaultUser(String) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

defaultUser(String) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

defaultUser(Consumer<ChatClient.PromptUserSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

defaultUser(Consumer<ChatClient.PromptUserSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

defaultUser(Resource) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

defaultUser(Resource) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

defaultUser(Resource, Charset) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder

defaultUser(Resource, Charset) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder

DefaultVectorStoreObservationConvention - Class in org.springframework.ai.vectorstore.observation

Default conventions to populate observations for vector store operations.

DefaultVectorStoreObservationConvention() - Constructor for class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

DefaultVectorStoreObservationConvention(String) - Constructor for class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

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<ToolCallbackResolver>) - Constructor for class org.springframework.ai.tool.resolution.DelegatingToolCallbackResolver

delete(String) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService

Deletes cached content by name.

delete(String) - Method in class org.springframework.ai.session.DefaultSessionService

delete(String) - Method in class org.springframework.ai.session.InMemorySessionRepository

delete(String) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository

delete(String) - Method in interface org.springframework.ai.session.SessionRepository

Deletes the session and its events.

delete(String) - Method in interface org.springframework.ai.session.SessionService

Deletes the session and its events.

delete(String) - Method in interface org.springframework.ai.vectorstore.VectorStore

Deletes documents from the vector store using a string filter expression.

delete(String, String) - Method in class org.springframework.ai.tool.toolsearch.index.lucene.LuceneToolIndex

Deletes a tool from the index for the specified session by its ID.

delete(List<String>) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore

delete(List<String>) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

delete(List<String>) - Method in interface org.springframework.ai.vectorstore.VectorStore

Deletes documents from the vector store.

delete(List<String>, String) - Method in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore

Deletes a list of documents by their IDs based on the namespace.

delete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore

delete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

delete(Filter.Expression) - Method in interface org.springframework.ai.vectorstore.VectorStore

Deletes documents from the vector store based on filter criteria.

DELETE - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Operation

VectorStore delete operation.

deleteAsync(String) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService

Asynchronously deletes cached content by name.

deleteBottomTextLines(String, int, String) - Static method in class org.springframework.ai.reader.ExtractedTextFormatter

Removes the specified number of lines from the bottom part of the text.

deleteByConversationId(String) - Method in interface org.springframework.ai.chat.memory.ChatMemoryRepository

Deprecated.

deleteByConversationId(String) - Method in class org.springframework.ai.chat.memory.InMemoryChatMemoryRepository

Deprecated.

deleteByConversationId(String) - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepository

Deprecated.

deleteByConversationId(String) - Method in class org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepository

Deprecated.

deleteByConversationId(String) - Method in class org.springframework.ai.chat.memory.repository.mongo.MongoChatMemoryRepository

Deprecated.

deleteByConversationId(String) - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepository

Deprecated.

deleteByConversationId(String) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

deleteByFilter() - Method in class org.springframework.ai.test.vectorstore.BaseVectorStoreTests

deleteById() - Method in class org.springframework.ai.test.vectorstore.BaseVectorStoreTests

deleteCacheFolder() - Method in class org.springframework.ai.transformers.ResourceCacheService

deleteCollection(String, String, String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

Delete a collection with the given name.

deleteDatabase(String, String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

Delete a database with the given name.

deleteEmbeddings(String, String, String, ChromaApi.DeleteEmbeddingsRequest) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

DeleteEmbeddingsRequest(List<String>, Map<String, Object>) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.DeleteEmbeddingsRequest

Creates an instance of a DeleteEmbeddingsRequest record class.

DeleteEmbeddingsRequest(List<String>) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.DeleteEmbeddingsRequest

deleteExpiredSessions(Instant) - Method in class org.springframework.ai.session.DefaultSessionService

deleteExpiredSessions(Instant) - Method in class org.springframework.ai.session.InMemorySessionRepository

deleteExpiredSessions(Instant) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository

deleteExpiredSessions(Instant) - Method in interface org.springframework.ai.session.SessionRepository

Deletes every session that expired before the given instant, with their events, in one atomic step per session, so a session whose expiry was extended concurrently (SessionRepository.save(org.springframework.ai.session.Session)) is kept.

deleteExpiredSessions(Instant) - Method in interface org.springframework.ai.session.SessionService

Deletes every session that expired before the given instant, with their events, and returns how many.

deleteIndex() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

deleteModel(String) - Method in class org.springframework.ai.ollama.management.OllamaModelManager

deleteModel(OllamaApi.DeleteModelRequest) - Method in class org.springframework.ai.ollama.api.OllamaApi

Delete a model and its data.

DeleteModelRequest(String) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.DeleteModelRequest

Creates an instance of a DeleteModelRequest record class.

deleteTopTextLines(String, int, String) - Static method in class org.springframework.ai.reader.ExtractedTextFormatter

Removes a specified number of lines from the top part of the given text.

deleteWithStringFilterExpression() - Method in class org.springframework.ai.test.vectorstore.BaseVectorStoreTests

delta() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk.ChunkChoice

Returns the value of the delta record component.

delta() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk.ChunkChoice

Returns the value of the delta record component.

delta(String) - Method in class org.springframework.ai.bedrock.converse.api.StreamingToolCallBuilder

deny(String) - Static method in record class org.springframework.ai.model.tool.ToolCallDecision

Denies the tool call; the model receives the default message.

deny(String, String) - Static method in record class org.springframework.ai.model.tool.ToolCallDecision

Denies the tool call; the model receives the message as the call's result.

denyMessage() - Method in record class org.springframework.ai.model.tool.ToolCallDecision

The result a denied call answers the model with.

deploymentName(String) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

deploymentName(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

deploymentName(String) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

description - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

description - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

description() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the description record component.

description() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the description record component.

description() - Element in annotation interface org.springframework.ai.mcp.annotation.McpArg

Argument description.

description() - Element in annotation interface org.springframework.ai.mcp.annotation.McpPrompt

Optional human-readable description.

description() - Element in annotation interface org.springframework.ai.mcp.annotation.McpResource

A description of what this resource represents.

description() - Element in annotation interface org.springframework.ai.mcp.annotation.McpTool

The description of the tool.

description() - Element in annotation interface org.springframework.ai.mcp.annotation.McpToolParam

The description of the tool argument.

description() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool.Function

Returns the value of the description record component.

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.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

Set the description of the resource.

description(String) - Method in class org.springframework.ai.tool.definition.DefaultToolDefinition.Builder

description(String) - Method in class org.springframework.ai.tool.function.FunctionToolCallback.Builder

descriptionCheck() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharingModerationCheck

Returns the value of the descriptionCheck record component.

descriptionValue() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharingModerationCheck

Returns the value of the descriptionValue record component.

DescriptiveErrorListener() - Constructor for class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.DescriptiveErrorListener

deserialize(JsonParser, DeserializationContext) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ContentDeserializer

deserialize(JsonParser, DeserializationContext) - Method in class org.springframework.ai.ollama.api.ThinkOption.ThinkOptionDeserializer

destination() - Method in record class org.springframework.ai.ollama.api.OllamaApi.CopyModelRequest

Returns the value of the destination record component.

destroy() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatModel

destructiveHint() - Element in annotation interface org.springframework.ai.mcp.annotation.McpTool.McpAnnotations

If true, the tool may perform destructive updates to its environment.

detail() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl

Returns the value of the detail record component.

details() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model

Returns the value of the details record component.

details() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Returns the value of the details record component.

Details(String, String, String, List<String>, String, String) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.Model.Details

Creates an instance of a Details record class.

detectModelProvider(boolean, boolean, String, String, AzureOpenAIServiceVersion) - Static method in class org.springframework.ai.openai.setup.OpenAiSetup

dialect(JdbcChatMemoryRepositoryDialect) - Method in class org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepository.Builder

Deprecated.

dialect(JdbcSessionRepositoryDialect) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository.Builder

The SQL dialect; detected with JdbcSessionRepositoryDialect.from(DataSource) by default.

diarizedJsonWorkaroundEnabled(boolean) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder

Enables or disables the diarized_json misclassification workaround.

digest() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model

Returns the value of the digest record component.

digest() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ProgressResponse

Returns the value of the digest record component.

DIGITAL_ART - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

dimension(Integer) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.MultimodalInstanceBuilder

dimensions() - Method in class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingModel

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() - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModel

dimensions() - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingModel

dimensions() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPage

Returns the value of the dimensions record component.

dimensions() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsRequest

Returns the value of the dimensions record component.

dimensions() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests.CallCountingEmbeddingModel

dimensions() - Method in class org.springframework.ai.test.vectorstore.FixedDimensionEmbeddingModel

dimensions() - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingModel

dimensions() - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModel

dimensions(int) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBBuilder

Configures the dimension size of the embedding vectors.

dimensions(int) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.Builder

Sets the number of dimensions for the vector embeddings.

dimensions(int) - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore.Builder

Sets the number of dimensions for the vector space.

dimensions(int) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgVectorStoreBuilder

dimensions(int) - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore.Builder

Configures the vector size of the collection.

dimensions(int) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the vector size of the index.

dimensions(Integer) - Method in class org.springframework.ai.embedding.DefaultEmbeddingOptions.Builder

dimensions(Integer) - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.Builder

dimensions(Integer) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

dimensions(Integer) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder

dimensions(Integer) - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions.Builder

dimensions(Integer) - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.Builder

dimensions(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

dimensions(Integer) - Method in class org.springframework.ai.embedding.DefaultEmbeddingOptionsBuilder

dimensions(Integer) - Method in interface org.springframework.ai.embedding.EmbeddingOptions.Builder

dimensions(Integer) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.Builder

The number of dimensions in the vector.

dimensions(Integer) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder

dimensions(EmbeddingModel, String, String) - Static method in class org.springframework.ai.embedding.AbstractEmbeddingModel

Return the dimension of the requested embedding generative name.

disableAtUnix() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the disableAtUnix record component.

disabled() - Static method in class org.springframework.ai.anthropic.AnthropicCacheOptions

Returns a new disabled cache options instance with strategy NONE.

DISABLED - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Thinking.Type

Use the non-thinking mode.

DISABLED - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.StatusEnum

DISABLED - Static variable in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Thinking

Use the non-thinking mode.

DISABLED - Static variable in record class org.springframework.ai.ollama.api.ThinkOption.ThinkBoolean

Constant for disabled thinking.

disableInternalConversationHistory() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder

Disables internal conversation history.

disableParallelToolUse(Boolean) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

disableThinking() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

disableThinking() - Method in class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

Disable thinking mode for the model.

disableThinking() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

Disable thinking mode for the model.

disallowDelete(boolean) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider.Builder

Sets whether the session removal capability is disabled.

disallowDelete(boolean) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider.Builder

Sets whether to disallow DELETE requests on the endpoint.

disallowSchemaChanges() - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.Builder

Deprecated.

DISKANN - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

DISMAX - Enum constant in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.TextScorer

dispatcherExecutor(ExecutorService) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder

Sets the executor used by the underlying OkHttp dispatcher for both the sync and async clients.

dispatcherExecutorService(ExecutorService) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

Sets the executor used by the OkHttp dispatcher.

dispatcherExecutorService(ExecutorService) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

Sets the executor used by the OkHttp dispatcher.

displayName(String) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent.Builder

displayName(String) - Method in class org.springframework.ai.google.genai.cache.CachedContentRequest.Builder

DISTANCE - Enum constant in enum class org.springframework.ai.document.DocumentMetadata

Measure of distance between the document embedding and the query vector.

DISTANCE_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.redis.RedisVectorStore

distanceMetadataFieldName(String) - Method in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore.Builder

Sets the distance metadata field name.

distanceMetric(RedisVectorStore.DistanceMetric) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the distance metric for vector similarity.

distances() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Embedding

Returns the value of the distances record component.

distances() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryResponse

Returns the value of the distances record component.

DISTANCES - Enum constant in enum class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest.Include

distanceThreshold(double) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache.Builder

distanceType(CoherenceVectorStore.DistanceType) - Method in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore.Builder

Sets the distance type for vector similarity calculations.

distanceType(MariaDBVectorStore.MariaDBDistanceType) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBBuilder

Configures the distance type used for similarity calculations.

distanceType(Neo4jVectorStore.Neo4jDistanceType) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Builder

Sets the distance type for index storage and queries.

distanceType(OracleVectorStore.OracleVectorStoreDistanceType) - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore.Builder

Sets the distance type for vector similarity calculations.

distanceType(PgVectorStore.PgDistanceType) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgVectorStoreBuilder

doAdd(List<Document>) - Method in class org.springframework.ai.chroma.vectorstore.ChromaVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

Perform the actual add operation.

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore

Adds a list of documents to the vector store.

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

Adds a list of documents to the vector store.

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.s3.S3VectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.SimpleVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

doAdd(List<Document>) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore

doAddValueRangeSpitter(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchAiSearchFilterExpressionConverter

doAddValueRangeSpitter(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Convert the given value range into a string representation.

doAddValueRangeSpitter(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireAiSearchFilterExpressionConverter

doAddValueRangeSpitter(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchAiSearchFilterExpressionConverter

doAfterCall(ChatClientResponse, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

doAfterStream(ChatClientResponse, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

Hook method called after each streaming call in the tool call loop.

doBeforeCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

Hook method called before each call in the tool call loop.

doBeforeCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor

doBeforeStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

Hook method called before each streaming call in the tool call loop.

doBeforeStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor

DOC_CSV - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for text/csv.

DOC_DOC - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for application/msword.

DOC_DOCX - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for application/vnd.openxmlformats-officedocument.wordprocessingml.document.

DOC_HTML - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for text/html.

DOC_ID_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

DOC_ID_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

The name of the field that contains the document ID.

DOC_MD - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for text/markdown.

DOC_PDF - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for application/pdf.

DOC_TXT - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for text/plain.

DOC_XLS - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for application/vnd.ms-excel.

DOC_XLSX - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.

DOCSCORE - Enum constant in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.TextScorer

docSizeBytes() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRResponse

Returns the value of the docSizeBytes record component.

docSizeBytes() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRUsageInfo

Returns the value of the docSizeBytes record component.

document - Variable in class org.springframework.ai.reader.pdf.PagePdfDocumentReader

document - Variable in class org.springframework.ai.reader.pdf.ParagraphPdfDocumentReader

document() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Embedding

Returns the value of the document record component.

document() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest

Returns the value of the document record component.

document() - Method in record class org.springframework.ai.vectorstore.EmbeddedDocument

Returns the value of the document record component.

Document - Class in org.springframework.ai.document

A document is a container for the content and metadata of a document.

Document(String) - Constructor for class org.springframework.ai.document.Document

Creates a text document with a generated ID and empty metadata.

Document(String, Map<String, Object>) - Constructor for class org.springframework.ai.document.Document

Creates a text document with a generated ID and the given metadata.

Document(Media, Map<String, Object>) - Constructor for class org.springframework.ai.document.Document

Creates a media document with a generated ID and the given metadata.

Document(String, String, Map<String, Object>) - Constructor for class org.springframework.ai.document.Document

Creates a text document with an explicit ID and the given metadata.

Document(String, Media, Map<String, Object>) - Constructor for class org.springframework.ai.document.Document

Creates a media document with an explicit ID and the given metadata.

DOCUMENT_CONTEXT - Static variable in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor

DOCUMENT_MAP - Static variable in class org.springframework.ai.bedrock.converse.api.BedrockMediaFormat

Document.Builder - Class in org.springframework.ai.document

Builder for Document.

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<Document>) - Constructor for class org.springframework.ai.embedding.DocumentEmbeddingRequest

DocumentEmbeddingRequest(List<Document>, EmbeddingOptions) - Constructor for class org.springframework.ai.embedding.DocumentEmbeddingRequest

DocumentEmbeddingRequest(Document...) - Constructor for class org.springframework.ai.embedding.DocumentEmbeddingRequest

documentFormatter(Function<List<Document>, String>) - Method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter.Builder

documentIdTranslator(CassandraVectorStore.DocumentIdTranslator) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

Sets the document ID translator.

documentJoiner(DocumentJoiner) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder

DocumentJoiner - Interface in org.springframework.ai.rag.retrieval.join

A component for combining documents retrieved based on multiple queries and from multiple data sources into a single collection of documents.

DocumentMetadata - Enum Class in org.springframework.ai.document

Common set of metadata keys used in Documents by DocumentReaders and VectorStores.

documentName() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.DocumentURLChunk

Returns the value of the documentName record component.

DocumentPostProcessor - Interface in org.springframework.ai.rag.postretrieval.document

A component for post-processing retrieved documents based on a query, addressing challenges such as "lost-in-the-middle", context length restrictions from the model, and the need to reduce noise and redundancy in the retrieved information.

documentPostProcessors(List<DocumentPostProcessor>) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder

documentPostProcessors(DocumentPostProcessor...) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder

DocumentReader - Interface in org.springframework.ai.document

documentRetriever(DocumentRetriever) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder

DocumentRetriever - Interface in org.springframework.ai.rag.retrieval.search

Component responsible for retrieving Documents from an underlying data source, such as a search engine, a vector store, a database, or a knowledge graph.

documents() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.AddEmbeddingsRequest

Returns the value of the documents record component.

documents() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingResponse

Returns the value of the documents record component.

documents() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryResponse

Returns the value of the documents record component.

DOCUMENTS - Enum constant in enum class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest.Include

DocumentTransformer - Interface in org.springframework.ai.document

documentUrl() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.DocumentURLChunk

Returns the value of the documentUrl record component.

DocumentURLChunk(String) - Constructor for record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.DocumentURLChunk

Create a DocumentURLChunk.

DocumentURLChunk(String, String, String) - Constructor for record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.DocumentURLChunk

Creates an instance of a DocumentURLChunk record class.

DocumentUtils - Class in org.springframework.ai.vectorstore.s3

Helper class to convert from AWS SDK Document to Object and vice versa.

DocumentWriter - Interface in org.springframework.ai.document

Write a list of Document instances.

DOCX - Enum constant in enum class org.springframework.ai.anthropic.AnthropicSkill

Word document generation.

doDelete(List<String>) - Method in class org.springframework.ai.chroma.vectorstore.ChromaVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

Perform the actual delete operation.

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore

Deletes a list of documents by their IDs.

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

Deletes a list of documents by their IDs.

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.s3.S3VectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.SimpleVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

doDelete(List<String>) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.chroma.vectorstore.ChromaVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

Template method for concrete implementations to provide filter-based deletion logic.

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.s3.S3VectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.SimpleVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore

doEndGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.azure.AzureAiSearchFilterExpressionConverter

doEndGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseAiSearchFilterExpressionConverter

doEndGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchAiSearchFilterExpressionConverter

doEndGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Convert the given group into a string representation.

doEndGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.PrintFilterExpressionConverter

doEndGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireAiSearchFilterExpressionConverter

doEndGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBFilterExpressionConverter

doEndGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.milvus.MilvusFilterExpressionConverter

doEndGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.neo4j.filter.Neo4jVectorFilterExpressionConverter

doEndGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchAiSearchFilterExpressionConverter

doEndGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.oracle.SqlJsonPathFilterExpressionConverter

doEndGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorFilterExpressionConverter

doEndGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.redis.RedisFilterExpressionConverter

doEndValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.azure.AzureAiSearchFilterExpressionConverter

doEndValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchAiSearchFilterExpressionConverter

doEndValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Convert the given value range into a string representation.

doEndValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireAiSearchFilterExpressionConverter

doEndValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBFilterExpressionConverter

doEndValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchAiSearchFilterExpressionConverter

doEndValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.oracle.SqlJsonPathFilterExpressionConverter

doEstimateTokenCount(List<MediaContent>) - Method in class org.springframework.ai.chat.client.advisor.LastMaxTokenSizeContentPurger

doEstimateTokenCount(MediaContent) - Method in class org.springframework.ai.chat.client.advisor.LastMaxTokenSizeContentPurger

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.azure.AzureAiSearchFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseAiSearchFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchAiSearchFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Convert the given expression into a string representation.

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.PineconeFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.PrintFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireAiSearchFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.milvus.MilvusFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.neo4j.filter.Neo4jVectorFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchAiSearchFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.oracle.SqlJsonPathFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.redis.RedisFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.typesense.TypesenseFilterExpressionConverter

doExpression(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateFilterExpressionConverter

doFinalizeLoop(ChatClientResponse, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

doFinalizeLoopStream(Flux<ChatClientResponse>, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

Hook method called at the end of the streaming tool call loop to finalize the response.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.changed.prompt.AsyncMcpPromptListChangedProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.changed.prompt.SyncMcpPromptListChangedProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.changed.resource.AsyncMcpResourceListChangedProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.changed.resource.SyncMcpResourceListChangedProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.changed.tool.AsyncMcpToolListChangedProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.changed.tool.SyncMcpToolListChangedProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.complete.AsyncMcpCompleteProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.complete.AsyncStatelessMcpCompleteProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.complete.SyncMcpCompleteProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.complete.SyncStatelessMcpCompleteProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.elicitation.AsyncMcpElicitationProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.elicitation.SyncMcpElicitationProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.logging.AsyncMcpLoggingProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.logging.SyncMcpLoggingProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.logging.SyncMcpLogginProvider

Deprecated.

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.progress.AsyncMcpProgressProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.progress.SyncMcpProgressProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.prompt.AsyncMcpPromptProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.prompt.AsyncStatelessMcpPromptProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.prompt.SyncMcpPromptProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.prompt.SyncStatelessMcpPromptProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.resource.AsyncMcpResourceProvider

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.resource.AsyncStatelessMcpResourceProvider

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.resource.SyncMcpResourceProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.resource.SyncStatelessMcpResourceProvider

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.sampling.AsyncMcpSamplingProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.sampling.SyncMcpSamplingProvider

Returns the methods of the given bean class.

doGetClassMethods(Object) - Method in class org.springframework.ai.mcp.annotation.provider.tool.AbstractMcpToolProvider

doGetFilterExpression(Map<String, Object>) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor

doGetMcpResourceAnnotation(Method) - Method in class org.springframework.ai.mcp.annotation.provider.resource.AsyncMcpResourceProvider

doGetMcpResourceAnnotation(Method) - Method in class org.springframework.ai.mcp.annotation.provider.resource.AsyncStatelessMcpResourceProvider

doGetMcpResourceAnnotation(Method) - Method in class org.springframework.ai.mcp.annotation.provider.resource.SyncStatelessMcpResourceProvider

doGetMcpToolAnnotation(Method) - Method in class org.springframework.ai.mcp.annotation.provider.tool.AbstractMcpToolProvider

doGetNextInstructionsForToolCall(ChatClientRequest, ChatClientResponse, ToolExecutionResult) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

doGetNextInstructionsForToolCallStream(ChatClientRequest, ChatClientResponse, ToolExecutionResult) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

Hook method to determine the next instructions for a tool call iteration in streaming mode.

doGetSupportingData(EvaluationRequest) - Method in interface org.springframework.ai.evaluation.Evaluator

doGetToolCallException() - Method in class org.springframework.ai.mcp.annotation.provider.tool.AbstractMcpToolProvider

Deprecated.

no longer consulted. Exception handling now follows the @Tool contract based on the exception type, so the returned value has no effect. Retained for backward compatibility. Will be removed in 2.1.0.

doGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Convert the given group into a string representation.

doGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.typesense.TypesenseFilterExpressionConverter

doGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateFilterExpressionConverter

doInitializeLoop(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

doInitializeLoop(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor

doInitializeLoopStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

Hook method called at the start of the streaming tool call loop.

doInitializeLoopStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.azure.AzureAiSearchFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseAiSearchFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchAiSearchFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Convert the given key into a string representation.

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.PineconeFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.PrintFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireAiSearchFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.milvus.MilvusFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.neo4j.filter.Neo4jVectorFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchAiSearchFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.oracle.SqlJsonPathFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.redis.RedisFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.typesense.TypesenseFilterExpressionConverter

doKey(Filter.Key, StringBuilder) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateFilterExpressionConverter

DOLPHIN_PHI - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

The 2.7B uncensored Dolphin model

done() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Returns the value of the done record component.

doneReason() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Returns the value of the doneReason record component.

doNot(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Convert the given expression into a string representation.

doNot(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.neo4j.filter.Neo4jVectorFilterExpressionConverter

DONT_ALLOW - Enum constant in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.PersonGeneration

doResponseEntity(StructuredOutputConverter<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

doResponseEntity(StructuredOutputConverter<T>, BaseAdvisorChain) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

doSimilaritySearch(float[], SearchRequest) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore

doSimilaritySearch(float[], SearchRequest) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

Template method for concrete implementations to search with a caller-supplied query embedding.

doSimilaritySearch(float[], SearchRequest) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

doSimilaritySearch(float[], SearchRequest) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

doSimilaritySearch(float[], SearchRequest) - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

doSimilaritySearch(float[], SearchRequest) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.chroma.vectorstore.ChromaVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

Perform the actual similarity search operation.

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

Performs a similarity search on the vector store.

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.s3.S3VectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.SimpleVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

doSimilaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.azure.AzureAiSearchFilterExpressionConverter

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseAiSearchFilterExpressionConverter

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchAiSearchFilterExpressionConverter

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Convert the given single value into a string representation and append it to the context.

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.PineconeFilterExpressionConverter

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.PrintFilterExpressionConverter

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireAiSearchFilterExpressionConverter

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBFilterExpressionConverter

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.milvus.MilvusFilterExpressionConverter

Serialize values using JSON serialization for Milvus filter expressions.

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasFilterExpressionConverter

Serialize values using JSON serialization for MongoDB Atlas filter expressions.

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.neo4j.filter.Neo4jVectorFilterExpressionConverter

Serialize values using JSON serialization for Neo4j Cypher filter expressions.

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchAiSearchFilterExpressionConverter

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.oracle.SqlJsonPathFilterExpressionConverter

Serialize values for Oracle JSONPath expressions with proper escaping.

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorFilterExpressionConverter

Serialize values for PostgreSQL JSONPath expressions with proper escaping.

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.redis.RedisFilterExpressionConverter

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.typesense.TypesenseFilterExpressionConverter

Serialize values using JSON serialization for Typesense filter expressions.

doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateFilterExpressionConverter

doSplit(String, int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter

Splits text into chunks based on token count, using the overlap configured on this splitter.

doSplit(String, int, int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter

Splits text into chunks based on token count.

doStartGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.azure.AzureAiSearchFilterExpressionConverter

doStartGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseAiSearchFilterExpressionConverter

doStartGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchAiSearchFilterExpressionConverter

doStartGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Convert the given group into a string representation.

doStartGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.PrintFilterExpressionConverter

doStartGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireAiSearchFilterExpressionConverter

doStartGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBFilterExpressionConverter

doStartGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.milvus.MilvusFilterExpressionConverter

doStartGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.neo4j.filter.Neo4jVectorFilterExpressionConverter

doStartGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchAiSearchFilterExpressionConverter

doStartGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.oracle.SqlJsonPathFilterExpressionConverter

doStartGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorFilterExpressionConverter

doStartGroup(Filter.Group, StringBuilder) - Method in class org.springframework.ai.vectorstore.redis.RedisFilterExpressionConverter

doStartValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.azure.AzureAiSearchFilterExpressionConverter

doStartValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchAiSearchFilterExpressionConverter

doStartValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Convert the given value range into a string representation.

doStartValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireAiSearchFilterExpressionConverter

doStartValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBFilterExpressionConverter

doStartValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchAiSearchFilterExpressionConverter

doStartValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.oracle.SqlJsonPathFilterExpressionConverter

DOT - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric

The dot product metric.

DOT - Enum constant in enum class org.springframework.ai.vectorstore.oracle.OracleVectorStore.OracleVectorStoreDistanceType

Also called the inner product, calculates the negated dot product of two vectors.

DOT - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

DOT - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

DOT() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompoundIdentifierContext

dot_product - Enum constant in enum class org.springframework.ai.vectorstore.couchbase.CouchbaseSimilarityFunction

Dot product similarity is commonly used by Large Language Models (LLMs).

dot_product - Enum constant in enum class org.springframework.ai.vectorstore.elasticsearch.SimilarityFunction

DOT_PRODUCT - Enum constant in enum class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Similarity

dotProduct(float[], float[]) - Static method in class org.springframework.ai.vectorstore.SimpleVectorStore.EmbeddingMath

doubleToFloat(List<Double>) - Static method in class org.springframework.ai.model.EmbeddingUtils

doUpsert(List<EmbeddedDocument>) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore

doUpsert(List<EmbeddedDocument>) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

Template method for concrete implementations to provide upsert logic using caller-supplied embeddings.

doUpsert(List<EmbeddedDocument>) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

doUpsert(List<EmbeddedDocument>) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

doUpsert(List<EmbeddedDocument>) - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

doUpsert(List<EmbeddedDocument>) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

doValue(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.azure.AzureAiSearchFilterExpressionConverter

doValue(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchAiSearchFilterExpressionConverter

doValue(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Convert the given value into a string representation.

doValue(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireAiSearchFilterExpressionConverter

doValue(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchAiSearchFilterExpressionConverter

doValue(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateFilterExpressionConverter

downloadAllFiles(ChatResponse, AnthropicClient, Path) - Static method in class org.springframework.ai.anthropic.AnthropicSkillsResponseHelper

Download all files from a Skills response to a target directory.

dpi() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPageDimensions

Returns the value of the dpi record component.

DRIVER_PROFILE_SEARCH - Static variable in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

DRIVER_PROFILE_UPDATES - Static variable in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

driverConfigLoaderBuilderCustomizer() - Method in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreAutoConfiguration

E

ECHO - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Voice

ECHO - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.Voice

effort(OutputConfig.Effort) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

Convenience method to set the effort level for the model's response.

ELASTICSEARCH - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by Elasticsearch.

ELASTICSEARCH - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

ElasticsearchAiSearchFilterExpressionConverter - Class in org.springframework.ai.vectorstore.elasticsearch

ElasticsearchAiSearchFilterExpressionConverter is a class that converts Filter.Expression objects into Elasticsearch query string representation.

ElasticsearchAiSearchFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchAiSearchFilterExpressionConverter

ElasticsearchVectorStore - Class in org.springframework.ai.vectorstore.elasticsearch

Elasticsearch-based vector store implementation using the dense_vector field type.

ElasticsearchVectorStore(ElasticsearchVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore

ElasticsearchVectorStore.Builder - Class in org.springframework.ai.vectorstore.elasticsearch

ElasticsearchVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.elasticsearch.autoconfigure

Auto-configuration for Elasticsearch Vector Store.

ElasticsearchVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.elasticsearch.autoconfigure.ElasticsearchVectorStoreAutoConfiguration

ElasticsearchVectorStoreOptions - Class in org.springframework.ai.vectorstore.elasticsearch

Provided Elasticsearch vector option configuration.

ElasticsearchVectorStoreOptions() - Constructor for class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStoreOptions

ElasticsearchVectorStoreProperties - Class in org.springframework.ai.vectorstore.elasticsearch.autoconfigure

Configuration properties for Elasticsearch Vector Store.

ElasticsearchVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.elasticsearch.autoconfigure.ElasticsearchVectorStoreProperties

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

ELEVENLABS - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider

AI system provided by ElevenLabs.

elevenLabsApi(ElevenLabsApi) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel.Builder

elevenLabsApi(ElevenLabsConnectionProperties, ObjectProvider<RestClient.Builder>, ObjectProvider<WebClient.Builder>, ObjectProvider<ResponseErrorHandler>) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsAutoConfiguration

ElevenLabsApi - Class in org.springframework.ai.elevenlabs.api

Client for the ElevenLabs Text-to-Speech API.

ElevenLabsApi(RestClient, WebClient) - Constructor for class org.springframework.ai.elevenlabs.api.ElevenLabsApi

Create a new ElevenLabs API client.

ElevenLabsApi.Builder - Class in org.springframework.ai.elevenlabs.api

Builder to construct ElevenLabsApi instance.

ElevenLabsApi.OutputFormat - Enum Class in org.springframework.ai.elevenlabs.api

The output format of the generated audio.

ElevenLabsApi.SpeechRequest - Record Class in org.springframework.ai.elevenlabs.api

Represents a request to the ElevenLabs Text-to-Speech API.

ElevenLabsApi.SpeechRequest.Builder - Class in org.springframework.ai.elevenlabs.api

ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator - Record Class in org.springframework.ai.elevenlabs.api

Locator for a pronunciation dictionary.

ElevenLabsApi.SpeechRequest.TextNormalizationMode - Enum Class in org.springframework.ai.elevenlabs.api

Text normalization mode.

ElevenLabsApi.SpeechRequest.VoiceSettings - Record Class in org.springframework.ai.elevenlabs.api

Voice settings to override defaults for the given voice.

ElevenLabsAutoConfiguration - Class in org.springframework.ai.model.elevenlabs.autoconfigure

Auto-configuration for ElevenLabs.

ElevenLabsAutoConfiguration() - Constructor for class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsAutoConfiguration

ElevenLabsConnectionProperties - Class in org.springframework.ai.model.elevenlabs.autoconfigure

Configuration properties for the ElevenLabs API connection.

ElevenLabsConnectionProperties() - Constructor for class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsConnectionProperties

ElevenLabsRuntimeHints - Class in org.springframework.ai.elevenlabs.aot

The ElevenLabsRuntimeHints class is responsible for registering runtime hints for ElevenLabs API classes.

ElevenLabsRuntimeHints() - Constructor for class org.springframework.ai.elevenlabs.aot.ElevenLabsRuntimeHints

elevenLabsSpeechModel(ElevenLabsApi, ElevenLabsSpeechProperties, ObjectProvider<RetryTemplate>, ObjectProvider<ObservationRegistry>, ObjectProvider<TextToSpeechModelObservationConvention>) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsAutoConfiguration

ElevenLabsSpeechProperties - Class in org.springframework.ai.model.elevenlabs.autoconfigure

Configuration properties for the ElevenLabs Text-to-Speech API.

ElevenLabsSpeechProperties() - Constructor for class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

ElevenLabsSpeechProperties.Options - Class in org.springframework.ai.model.elevenlabs.autoconfigure

ElevenLabsTextToSpeechModel - Class in org.springframework.ai.elevenlabs

Implementation of the TextToSpeechModel interface for ElevenLabs TTS API.

ElevenLabsTextToSpeechModel(ElevenLabsApi, ElevenLabsTextToSpeechOptions) - Constructor for class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel

ElevenLabsTextToSpeechModel(ElevenLabsApi, ElevenLabsTextToSpeechOptions, RetryTemplate) - Constructor for class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel

ElevenLabsTextToSpeechModel(ElevenLabsApi, ElevenLabsTextToSpeechOptions, RetryTemplate, ObservationRegistry) - Constructor for class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel

Creates a model that reports its calls to the given observation registry.

ElevenLabsTextToSpeechModel.Builder - Class in org.springframework.ai.elevenlabs

ElevenLabsTextToSpeechOptions - Class in org.springframework.ai.elevenlabs

Options for ElevenLabs text-to-speech.

ElevenLabsTextToSpeechOptions(String, String, Boolean, String, ElevenLabsApi.SpeechRequest.VoiceSettings, String, List<ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator>, Integer, String, String, List<String>, List<String>, ElevenLabsApi.SpeechRequest.TextNormalizationMode, Boolean) - Constructor for class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

ElevenLabsTextToSpeechOptions.Builder - Class in org.springframework.ai.elevenlabs

ElevenLabsVoicesApi - Class in org.springframework.ai.elevenlabs.api

Client for the ElevenLabs Voices API.

ElevenLabsVoicesApi(String, ApiKey, HttpHeaders, RestClient.Builder, ResponseErrorHandler) - Constructor for class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi

Create a new ElevenLabs Voices API client.

ElevenLabsVoicesApi(RestClient) - Constructor for class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi

Create a new ElevenLabs Voices API client.

ElevenLabsVoicesApi.Builder - Class in org.springframework.ai.elevenlabs.api

Builder to construct ElevenLabsVoicesApi instance.

ElevenLabsVoicesApi.CategoryEnum - Enum Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.FineTuning - Record Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.ManualVerification - Record Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.ManualVerificationFile - Record Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.ReaderResource - Record Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.ReaderResource.ResourceTypeEnum - Enum Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.Recording - Record Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.SafetyControlEnum - Enum Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.Sample - Record Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.VerificationAttempt - Record Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.VerifiedVoiceLanguage - Record Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.Voice - Record Class in org.springframework.ai.elevenlabs.api

Represents a single voice from the ElevenLabs API.

ElevenLabsVoicesApi.Voices - Record Class in org.springframework.ai.elevenlabs.api

Represents the response from the /v1/voices endpoint.

ElevenLabsVoicesApi.VoiceSettings - Record Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.VoiceSharing - Record Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.VoiceSharing.CategoryEnum - Enum Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.VoiceSharing.ReviewStatusEnum - Enum Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.VoiceSharing.StatusEnum - Enum Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.VoiceSharingModerationCheck - Record Class in org.springframework.ai.elevenlabs.api

ElevenLabsVoicesApi.VoiceVerification - Record Class in org.springframework.ai.elevenlabs.api

elicit(McpSchema.ElicitRequest) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

elicit(McpSchema.ElicitRequest) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

elicit(McpSchema.ElicitRequest) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

elicit(McpSchema.ElicitRequest) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

elicit(Class<T>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

elicit(Class<T>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

elicit(Class<T>) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

elicit(Class<T>) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

elicit(Consumer<McpRequestContextTypes.ElicitationSpec>, Class<T>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

elicit(Consumer<McpRequestContextTypes.ElicitationSpec>, Class<T>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

elicit(Consumer<McpRequestContextTypes.ElicitationSpec>, Class<T>) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

elicit(Consumer<McpRequestContextTypes.ElicitationSpec>, Class<T>) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

elicit(Consumer<McpRequestContextTypes.ElicitationSpec>, ParameterizedTypeReference<T>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

elicit(Consumer<McpRequestContextTypes.ElicitationSpec>, ParameterizedTypeReference<T>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

elicit(Consumer<McpRequestContextTypes.ElicitationSpec>, ParameterizedTypeReference<T>) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

elicit(Consumer<McpRequestContextTypes.ElicitationSpec>, ParameterizedTypeReference<T>) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

elicit(ParameterizedTypeReference<T>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

elicit(ParameterizedTypeReference<T>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

elicit(ParameterizedTypeReference<T>) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

elicit(ParameterizedTypeReference<T>) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

elicitation(McpElicitation) - Method in class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback.AbstractBuilder

Set the elicitation annotation.

elicitationHandler() - Method in record class org.springframework.ai.mcp.annotation.method.elicitation.AsyncElicitationSpecification

Returns the value of the elicitationHandler record component.

elicitationHandler() - Method in record class org.springframework.ai.mcp.annotation.method.elicitation.SyncElicitationSpecification

Returns the value of the elicitationHandler record component.

elicitationInternal(String, Type, Map<String, Object>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

elicitationSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

elicitationSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

elicitEnabled() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

elicitEnabled() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

elicitEnabled() - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

elicitEnabled() - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

embed(String) - Method in interface org.springframework.ai.embedding.EmbeddingModel

Embeds the given text into a vector.

embed(String) - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingModel

embed(String) - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests.CallCountingEmbeddingModel

embed(String) - Method in class org.springframework.ai.test.vectorstore.FixedDimensionEmbeddingModel

embed(String) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

embed(List<String>) - Method in interface org.springframework.ai.embedding.EmbeddingModel

Embeds a batch of texts into vectors.

embed(List<String>) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

embed(List<Document>, 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 class org.springframework.ai.bedrock.cohere.BedrockCohereEmbeddingModel

embed(Document) - Method in class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingModel

embed(Document) - Method in interface org.springframework.ai.embedding.EmbeddingModel

Embeds the given document's content into a vector.

embed(Document) - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModel

embed(Document) - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingModel

embed(Document) - Method in class org.springframework.ai.ollama.OllamaEmbeddingModel

embed(Document) - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel

embed(Document) - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingModel

embed(Document) - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests.CallCountingEmbeddingModel

embed(Document) - Method in class org.springframework.ai.test.vectorstore.FixedDimensionEmbeddingModel

embed(Document) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

embed(Document) - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModel

embed(OllamaApi.EmbeddingsRequest) - Method in class org.springframework.ai.ollama.api.OllamaApi

Generate embeddings from a model.

EMBED - Enum constant in enum class org.springframework.ai.document.MetadataMode

EMBED - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingModel

Mistral Embed model for general text embeddings.

embeddedDocument(String, String, Map<String, Object>) - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

Build an EmbeddedDocument with a deterministic, correctly sized vector derived from the id so distinct ids get distinct vectors.

EmbeddedDocument - Record Class in org.springframework.ai.vectorstore

A Document paired with a pre-computed embedding vector, written to a VectorStore via VectorStore.upsert(java.util.List) without invoking the store's embedding model.

EmbeddedDocument(Document, float[]) - Constructor for record class org.springframework.ai.vectorstore.EmbeddedDocument

Creates an instance of a EmbeddedDocument record class.

embedding() - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingResponse

Returns the value of the embedding record component.

embedding() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Embedding

Returns the value of the embedding record component.

embedding() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.Embedding

Returns the value of the embedding record component.

embedding() - Method in record class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.CouchbaseDocument

Returns the value of the embedding record component.

embedding() - Method in record class org.springframework.ai.vectorstore.EmbeddedDocument

Returns a copy of the embedding vector.

embedding() - Method in record class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBDocument

Returns the value of the embedding record component.

embedding() - Method in record class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.MongoDBDocument

Returns the value of the embedding record component.

embedding() - Method in record class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.OpenSearchDocument

Returns the value of the embedding record component.

embedding(I) - Method in class org.springframework.ai.bedrock.api.AbstractBedrockApi

Compute the embedding for the given text.

embedding(CohereEmbeddingBedrockApi.CohereEmbeddingRequest) - Method in class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi

embedding(TitanEmbeddingBedrockApi.TitanEmbeddingRequest) - Method in class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi

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(Integer, float[]) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.Embedding

Create an embedding with the given index, embedding and object type set to 'embedding'.

Embedding(Integer, float[], String) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.Embedding

Creates an instance of a Embedding record class.

Embedding(String, float[], String, Map<String, Object>, Double) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.Embedding

Creates an instance of a Embedding record class.

EMBEDDING - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType

AI operation type for embedding.

EMBEDDING_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

EMBEDDING_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

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

embeddingColumnName(String) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

embeddingDimension(int) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore.Builder

Configures the dimension size of the embedding vectors.

embeddingDimension(int) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Builder

Sets the embedding dimension.

embeddingDimension(int) - Method in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore.Builder

Configures the dimension size of the embedding vectors.

embeddingDimensions - Variable in class org.springframework.ai.embedding.AbstractEmbeddingModel

Cached embedding dimensions.

embeddingDimensions() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

The embedding dimension the store under test expects, so the suite can build correctly sized caller vectors.

embeddingDistance(String) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

embeddingFieldName(String) - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore.Builder

Sets the embedding field name in the Azure Search index.

embeddingFieldName(String) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBBuilder

Configures the name of the embedding field in the database.

embeddingFieldName(String) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore.Builder

Configures the name of the field used for embedding vectors.

embeddingFieldName(String) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgVectorStoreBuilder

Overrides the column name used for the vector embedding.

embeddingFieldName(String) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the Redis embedding field name.

EmbeddingList(String, List<T>, String, MistralAiApi.Usage) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingList

Creates an instance of a EmbeddingList record class.

embeddingModel - Variable in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

embeddingModel - Variable in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

embeddingModel(EmbeddingModel) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache.Builder

embeddingModel(TransformersEmbeddingModelProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<EmbeddingModelObservationConvention>) - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelAutoConfiguration

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.

EmbeddingObservationAutoConfiguration - Class in org.springframework.ai.model.embedding.observation.autoconfigure

Auto-configuration for Spring AI embedding model observations.

EmbeddingObservationAutoConfiguration() - Constructor for class org.springframework.ai.model.embedding.observation.autoconfigure.EmbeddingObservationAutoConfiguration

EmbeddingOptions - Interface in org.springframework.ai.embedding

Options for embedding models.

EmbeddingOptions.Builder - Interface in org.springframework.ai.embedding

embeddingProperty(String) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Builder

Sets the property name for storing embeddings.

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<String>, EmbeddingOptions) - Constructor for class org.springframework.ai.embedding.EmbeddingRequest

EmbeddingRequest(T) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingRequest

Create an embedding request with the given input.

EmbeddingRequest(T, String) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingRequest

Create an embedding request with the given input, model and encoding format set to float.

EmbeddingRequest(T, String, String) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingRequest

Creates an instance of a EmbeddingRequest record class.

EmbeddingResponse - Class in org.springframework.ai.embedding

Embedding response object.

EmbeddingResponse(List<Embedding>) - Constructor for class org.springframework.ai.embedding.EmbeddingResponse

Creates a new EmbeddingResponse instance with empty metadata.

EmbeddingResponse(List<Embedding>, 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<String, Object>) - 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

embeddings() - Method in record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingResponse

Returns the value of the embeddings record component.

embeddings() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.AddEmbeddingsRequest

Returns the value of the embeddings record component.

embeddings() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingResponse

Returns the value of the embeddings record component.

embeddings() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryResponse

Returns the value of the embeddings record component.

embeddings() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsResponse

Returns the value of the embeddings record component.

embeddings(MistralAiApi.EmbeddingRequest<T>) - Method in class org.springframework.ai.mistralai.api.MistralAiApi

Creates an embedding vector representing the input text or token array.

EMBEDDINGS - Enum constant in enum class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest.Include

embeddingsByType() - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingResponse

Returns the value of the embeddingsByType record component.

EmbeddingsRequest(String, String) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsRequest

Shortcut constructor to create a EmbeddingRequest without options.

EmbeddingsRequest(String, List<String>, String, Map<String, Object>, Boolean, Integer) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsRequest

Creates an instance of a EmbeddingsRequest record class.

EmbeddingsResponse(String, List<float[]>, Long, Long, Integer) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsResponse

Creates an instance of a EmbeddingsResponse record class.

EmbeddingUtils - Class in org.springframework.ai.model

Utility methods for embedding related operations.

embedForResponse(List<String>) - Method in interface org.springframework.ai.embedding.EmbeddingModel

Embeds a batch of texts into vectors and returns the EmbeddingResponse.

embedForResponse(List<String>) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

emitJsonValue(Object, StringBuilder) - Static method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Emit a value formatted as JSON by appending its JSON representation to the provided context.

emitLuceneString(String, StringBuilder) - Static method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Emit a string value formatted for Lucene query syntax by appending escaped characters to the provided context.

emitODataString(String, StringBuilder) - Static method in class org.springframework.ai.vectorstore.azure.AzureAiSearchFilterExpressionConverter

Emit an OData-formatted string value with single quote wrapping and escaping by appending to the provided context.

emitSqlString(String, StringBuilder) - Static method in class org.springframework.ai.vectorstore.mariadb.MariaDBFilterExpressionConverter

Emit a SQL-formatted string value with single quote wrapping and escaping by appending to the provided context.

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

emptyBatchDoesNothing() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

emptyContextPromptTemplate(PromptTemplate) - Method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter.Builder

EmptyJsonMetadataGenerator - Class in org.springframework.ai.reader

EmptyJsonMetadataGenerator() - Constructor for class org.springframework.ai.reader.EmptyJsonMetadataGenerator

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

ENABLE_NATIVE_STRUCTURED_OUTPUT - Static variable in class org.springframework.ai.chat.client.AdvisorParams

Advisor parameter that enables provider-native structured output for all entity() calls on a prompt.

enabled() - Method in record class org.springframework.ai.ollama.api.ThinkOption.ThinkBoolean

Returns the value of the enabled record component.

ENABLED - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Thinking.Type

Use the thinking mode.

ENABLED - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.StatusEnum

ENABLED - Static variable in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Thinking

Use the thinking mode.

ENABLED - Static variable in record class org.springframework.ai.ollama.api.ThinkOption.ThinkBoolean

Constant for enabled thinking.

enabledInLibrary() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the enabledInLibrary record component.

EnabledSseServerCondition() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.McpServerAutoConfiguration.EnabledSseServerCondition

EnabledStatelessServerCondition() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.McpServerStatelessAutoConfiguration.EnabledStatelessServerCondition

EnabledStreamableServerCondition() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.McpServerAutoConfiguration.EnabledStreamableServerCondition

enableLogging(Boolean) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

enableThinking() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

enableThinking() - Method in class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

Enable thinking mode for the model.

enableThinking() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

Enable thinking mode for the model.

encode(SessionEvent) - Method in class org.springframework.ai.session.support.SessionEventCodec

Encodes an event into its persisted shape.

EncodedEvent(EventType, MessageType, String, String) - Constructor for record class org.springframework.ai.session.support.SessionEventCodec.EncodedEvent

Creates an instance of a EncodedEvent record class.

encodingFormat() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingRequest

Returns the value of the encodingFormat record component.

encodingFormat(String) - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingOptions.Builder

encodingFormat(OpenAiEmbeddingOptions.EncodingFormat) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder

ENCRYPTED_CONTENT_KIND - Static variable in class org.springframework.ai.openai.responses.OpenAiResponsesMetadata

The kind of the payload carried by a reasoning part: the encrypted_content of a reasoning item, which has to travel back verbatim for the model to keep its train of thought across a tool call or a follow-up turn.

END - Enum constant in enum class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest.Truncate

(default) Discards the end of the input.

endDelimiterToken(char) - Method in class org.springframework.ai.template.st.StTemplateRenderer.Builder

Sets the character used as the end delimiter for template expressions.

endOffsetSec - Variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

The end offset of the video segment in seconds.

endOffsetSec(Integer) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

endPageNumber() - Method in record class org.springframework.ai.reader.pdf.config.ParagraphManager.Paragraph

Returns the value of the endPageNumber record component.

endpoint() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStreamableHttpClientProperties.ConnectionParameters

Returns the value of the endpoint record component.

endpoint(String) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebClientStreamableHttpTransport.Builder

Configure the endpoint to make HTTP requests against.

ENDPOINT_EVENT_TYPE - Static variable in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider

Deprecated.

Event type for sending the message endpoint URI to clients.

ENDPOINT_EVENT_TYPE - Static variable in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider

Deprecated.

Event type for sending the message endpoint URI to clients.

ENDPOINT_EVENT_TYPE - Static variable in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider

Event type for sending the message endpoint URI to clients.

ENHANCE - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

ensureKeyspaceExists(CqlSession, String) - Static method in class org.springframework.ai.chat.memory.repository.cassandra.SchemaUtil

Deprecated.

ensureKeyspaceExists(CqlSession, String) - Static method in class org.springframework.ai.vectorstore.cassandra.SchemaUtil

ensureValidInputSchema(String) - Static method in class org.springframework.ai.util.json.schema.JsonSchemaUtils

Ensures that the input schema is valid for AI model APIs.

enterAndExpression(FiltersParser.AndExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the AndExpression labeled alternative in FiltersParser.booleanExpression().

enterAndExpression(FiltersParser.AndExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the AndExpression labeled alternative in FiltersParser.booleanExpression().

enterBooleanConstant(FiltersParser.BooleanConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the BooleanConstant labeled alternative in FiltersParser.constant().

enterBooleanConstant(FiltersParser.BooleanConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the BooleanConstant labeled alternative in FiltersParser.constant().

enterCompare(FiltersParser.CompareContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by FiltersParser.compare().

enterCompare(FiltersParser.CompareContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by FiltersParser.compare().

enterCompareExpression(FiltersParser.CompareExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the CompareExpression labeled alternative in FiltersParser.booleanExpression().

enterCompareExpression(FiltersParser.CompareExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the CompareExpression labeled alternative in FiltersParser.booleanExpression().

enterCompoundIdentifier(FiltersParser.CompoundIdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the CompoundIdentifier labeled alternative in FiltersParser.identifier().

enterCompoundIdentifier(FiltersParser.CompoundIdentifierContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the CompoundIdentifier labeled alternative in FiltersParser.identifier().

enterConstantArray(FiltersParser.ConstantArrayContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by FiltersParser.constantArray().

enterConstantArray(FiltersParser.ConstantArrayContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by FiltersParser.constantArray().

enterDecimalConstant(FiltersParser.DecimalConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the DecimalConstant labeled alternative in FiltersParser.constant().

enterDecimalConstant(FiltersParser.DecimalConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the DecimalConstant labeled alternative in FiltersParser.constant().

enterEveryRule(ParserRuleContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

enterGroupExpression(FiltersParser.GroupExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the GroupExpression labeled alternative in FiltersParser.booleanExpression().

enterGroupExpression(FiltersParser.GroupExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the GroupExpression labeled alternative in FiltersParser.booleanExpression().

enterInExpression(FiltersParser.InExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the InExpression labeled alternative in FiltersParser.booleanExpression().

enterInExpression(FiltersParser.InExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the InExpression labeled alternative in FiltersParser.booleanExpression().

enterIntegerConstant(FiltersParser.IntegerConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the IntegerConstant labeled alternative in FiltersParser.constant().

enterIntegerConstant(FiltersParser.IntegerConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the IntegerConstant labeled alternative in FiltersParser.constant().

enterIsNotNullExpression(FiltersParser.IsNotNullExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the IsNotNullExpression labeled alternative in FiltersParser.booleanExpression().

enterIsNotNullExpression(FiltersParser.IsNotNullExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the IsNotNullExpression labeled alternative in FiltersParser.booleanExpression().

enterIsNullExpression(FiltersParser.IsNullExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the IsNullExpression labeled alternative in FiltersParser.booleanExpression().

enterIsNullExpression(FiltersParser.IsNullExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the IsNullExpression labeled alternative in FiltersParser.booleanExpression().

enterLongConstant(FiltersParser.LongConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the LongConstant labeled alternative in FiltersParser.constant().

enterLongConstant(FiltersParser.LongConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the LongConstant labeled alternative in FiltersParser.constant().

enterNinExpression(FiltersParser.NinExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the NinExpression labeled alternative in FiltersParser.booleanExpression().

enterNinExpression(FiltersParser.NinExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the NinExpression labeled alternative in FiltersParser.booleanExpression().

enterNotExpression(FiltersParser.NotExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the NotExpression labeled alternative in FiltersParser.booleanExpression().

enterNotExpression(FiltersParser.NotExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the NotExpression labeled alternative in FiltersParser.booleanExpression().

enterOrExpression(FiltersParser.OrExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the OrExpression labeled alternative in FiltersParser.booleanExpression().

enterOrExpression(FiltersParser.OrExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the OrExpression labeled alternative in FiltersParser.booleanExpression().

ENTERPRISE_BAN - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.SafetyControlEnum

ENTERPRISE_CAPTCHA - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.SafetyControlEnum

enterQuotedIdentifier(FiltersParser.QuotedIdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the QuotedIdentifier labeled alternative in FiltersParser.identifier().

enterQuotedIdentifier(FiltersParser.QuotedIdentifierContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the QuotedIdentifier labeled alternative in FiltersParser.identifier().

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.AndExpressionContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.BooleanConstantContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareExpressionContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompoundIdentifierContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantArrayContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.DecimalConstantContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.GroupExpressionContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.InExpressionContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IntegerConstantContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNotNullExpressionContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNullExpressionContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.LongConstantContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NinExpressionContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NotExpressionContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.OrExpressionContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.QuotedIdentifierContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.SimpleIdentifierContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.TextConstantContext

enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.WhereContext

enterSimpleIdentifier(FiltersParser.SimpleIdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the SimpleIdentifier labeled alternative in FiltersParser.identifier().

enterSimpleIdentifier(FiltersParser.SimpleIdentifierContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the SimpleIdentifier labeled alternative in FiltersParser.identifier().

enterTextConstant(FiltersParser.TextConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by the TextConstant labeled alternative in FiltersParser.constant().

enterTextConstant(FiltersParser.TextConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by the TextConstant labeled alternative in FiltersParser.constant().

enterWhere(FiltersParser.WhereContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Enter a parse tree produced by FiltersParser.where().

enterWhere(FiltersParser.WhereContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Enter a parse tree produced by FiltersParser.where().

entity() - Method in record class org.springframework.ai.chat.client.ResponseEntity

Returns the value of the entity record component.

entity(Class<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

Deserializes the response into a T instance.

entity(Class<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

entity(Class<T>, Consumer<ChatClient.EntityParamSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

Deserializes the response into a T instance, with behaviour configured via the entityParamSpecConsumer.

entity(Class<T>, Consumer<ChatClient.EntityParamSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

entity(StructuredOutputConverter<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

Deserializes the response using the given converter.

entity(StructuredOutputConverter<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

entity(StructuredOutputConverter<T>, Consumer<ChatClient.EntityParamSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

Deserializes the response using the given converter, with behaviour configured via the entityParamSpecConsumer.

entity(StructuredOutputConverter<T>, Consumer<ChatClient.EntityParamSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

entity(ParameterizedTypeReference<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

Deserializes the response into a T instance.

entity(ParameterizedTypeReference<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

entity(ParameterizedTypeReference<T>, Consumer<ChatClient.EntityParamSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

Deserializes the response into a T instance, with behaviour configured via the entityParamSpecConsumer.

entity(ParameterizedTypeReference<T>, Consumer<ChatClient.EntityParamSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

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

env() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStdioClientProperties.Parameters

Returns the value of the env record component.

EOF() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.WhereContext

eq(String, Object) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

EQ - Enum constant in enum class org.springframework.ai.vectorstore.filter.Filter.ExpressionType

equals(Object) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions

equals(Object) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

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.bedrock.converse.BedrockChatOptions

equals(Object) - Method in class org.springframework.ai.chat.messages.AbstractMessage

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 class org.springframework.ai.chat.prompt.DefaultChatOptions

equals(Object) - Method in class org.springframework.ai.chat.prompt.Prompt

equals(Object) - Method in class org.springframework.ai.content.Media

Two media are equal when they have the same id, MIME type and data (byte arrays are compared by content).

equals(Object) - Method in class org.springframework.ai.deepseek.api.ResponseFormat

equals(Object) - Method in class org.springframework.ai.deepseek.DeepSeekAssistantMessage

Deprecated.

equals(Object) - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions

equals(Object) - Method in class org.springframework.ai.document.Document

equals(Object) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

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.evaluation.EvaluationRequest

equals(Object) - Method in class org.springframework.ai.evaluation.EvaluationResponse

equals(Object) - Method in class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting

equals(Object) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

equals(Object) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

equals(Object) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

equals(Object) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

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 class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

equals(Object) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.Embedding

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

equals(Object) - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions

equals(Object) - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.ExtractedImage

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in class org.springframework.ai.model.tool.DefaultStructuredOutputChatOptions

equals(Object) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions

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 class org.springframework.ai.ollama.api.OllamaChatOptions

equals(Object) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

equals(Object) - Method in class org.springframework.ai.openai.metadata.OpenAiImageGenerationMetadata

equals(Object) - Method in class org.springframework.ai.openai.metadata.OpenAiImageResponseMetadata

equals(Object) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions

equals(Object) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

equals(Object) - Method in class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat

equals(Object) - Method in class org.springframework.ai.openai.OpenAiChatOptions

equals(Object) - Method in class org.springframework.ai.openai.OpenAiImageOptions

equals(Object) - Method in class org.springframework.ai.openai.OpenAiModerationOptions

equals(Object) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

equals(Object) - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

equals(Object) - Method in class org.springframework.ai.stabilityai.StabilityAiImageGenerationMetadata

equals(Object) - Method in record class org.springframework.ai.vectorstore.EmbeddedDocument

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in class org.springframework.ai.vectorstore.SearchRequest

equals(Object) - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchResult

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.bedrock.api.AbstractBedrockApi.AmazonBedrockInvocationMetrics

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chat.client.ChatClientRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chat.client.ChatClientResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chat.client.ResponseEntity

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.SchemaColumn

Deprecated.

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chat.memory.repository.mongo.Conversation

Deprecated.

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chat.memory.repository.mongo.Conversation.Message

Deprecated.

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chat.memory.repository.redis.AdvancedRedisChatMemoryRepository.MessageWithConversation

Deprecated.

Indicates whether some other object is "equal to" this one.

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 record class org.springframework.ai.chat.messages.part.MediaPart

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chat.messages.part.MediaPart.MediaDto

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chat.messages.part.OpaquePayload

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chat.messages.part.ReasoningPart

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chat.messages.part.TextPart

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chat.messages.part.ToolCallPart

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chat.messages.part.ToolResultPart

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chat.messages.part.UnknownPart

Indicates whether some other object is "equal to" this one.

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 record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.AddEmbeddingsRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Collection

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateCollectionRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateDatabaseRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateTenantRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Database

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.DeleteEmbeddingsRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Embedding

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingsRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Tenant

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion.Choice

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk.ChunkChoice

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.ChatCompletionFunction

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.ToolCall

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Thinking

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content.TopLogProbs

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.Usage

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.Usage.PromptTokensDetails

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.VoiceSettings

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerificationFile

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ReaderResource

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Recording

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Sample

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerificationAttempt

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerifiedVoiceLanguage

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voices

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSettings

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharingModerationCheck

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceVerification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.google.genai.GoogleGenAiChatModel.GeminiRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageGenerationMetadata

equals(Object) - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.MultiSpeakerTurn

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.ReplicatedVoice

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.SpeakerVoiceConfig

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.context.StructuredElicitResult

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.McpMeta

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.method.changed.prompt.AsyncPromptListChangedSpecification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.method.changed.prompt.SyncPromptListChangedSpecification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.method.changed.resource.AsyncResourceListChangedSpecification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.method.changed.resource.SyncResourceListChangedSpecification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.method.changed.tool.AsyncToolListChangedSpecification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.method.changed.tool.SyncToolListChangedSpecification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.method.elicitation.AsyncElicitationSpecification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.method.elicitation.SyncElicitationSpecification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.method.logging.AsyncLoggingSpecification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.method.logging.SyncLoggingSpecification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.method.progress.AsyncProgressSpecification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.method.progress.SyncProgressSpecification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.method.sampling.AsyncSamplingSpecification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.annotation.method.sampling.SyncSamplingSpecification

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration.CloseableMcpAsyncClients

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration.CloseableMcpSyncClients

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.NamedClientMcpTransport

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpSseClientProperties.SseParameters

Deprecated.

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStdioClientProperties.Parameters

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStreamableHttpClientProperties.ConnectionParameters

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mcp.McpConnectionInfo

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion.Choice

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk.ChunkChoice

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ChatCompletionFunction

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ReferenceChunk

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.TextChunk

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ThinkChunk

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ToolCall

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingList

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content.TopLogProbs

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.Usage

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationResult

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPage

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPageDimensions

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.DocumentURLChunk

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.ImageURLChunk

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRUsageInfo

Indicates whether some other object is "equal to" this one.

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 record class org.springframework.ai.model.tool.ToolCallDecision

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.model.tool.ToolCallDecisions

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.observation.AiOperationMetadata

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool.Function

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.CopyModelRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.DeleteModelRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.ListModelResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message.ToolCall

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message.ToolCallFunction

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model.Details

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.ProgressResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.PullModelRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.ThinkOption.ThinkBoolean

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.api.ThinkOption.ThinkLevel

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.ollama.management.ModelManagementOptions

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.openai.responses.HostedTool.CodeInterpreter

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.openai.responses.HostedTool.FileSearch

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.openai.responses.HostedTool.ImageGeneration

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.openai.responses.HostedTool.Mcp

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.openai.responses.HostedTool.Raw

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.openai.responses.HostedTool.WebSearch

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.rag.Query

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.reader.pdf.config.ParagraphManager.Paragraph

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.session.compaction.CompactionBoundary

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.session.compaction.CompactionRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.session.compaction.CompactionResult

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.session.compaction.CompactionWindow

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.session.compaction.SummaryRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.session.EventFilter

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.session.EventFilter.Window.All

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.session.EventFilter.Window.Last

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in class org.springframework.ai.session.EventType

equals(Object) - Method in class org.springframework.ai.session.SessionEvent

equals(Object) - Method in record class org.springframework.ai.session.support.SessionEventCodec.EncodedEvent

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.session.support.SessionEventCodec.MessageBody

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.TextPrompts

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageResponse.Artifacts

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.Booking

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.BookingRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.Weather

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.WeatherRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Request

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Response

Indicates whether some other object is "equal to" this one.

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.

equals(Object) - Method in record class org.springframework.ai.tool.toolsearch.ToolReference

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchResponse.SearchMetadata

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.vectorstore.azure.AzureVectorStore.MetadataField

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.SchemaColumn

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.CouchbaseDocument

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.vectorstore.filter.Filter.Expression

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.vectorstore.filter.Filter.Group

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.vectorstore.filter.Filter.Key

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.vectorstore.filter.Filter.Value

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder.Op

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBDocument

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.MongoDBDocument

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.OpenSearchDocument

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.vectorstore.redis.RedisVectorStore.MetadataField

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.MetadataField

Indicates whether some other object is "equal to" this one.

EQUALS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

EQUALS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

EQUALS() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareContext

error(String) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

error(String) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

error(String) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

error(String) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

ERROR - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.FinishReason

ErrorLoggingObservationHandler - Class in org.springframework.ai.model.observation

An ObservationHandler that logs errors using a Tracer.

ErrorLoggingObservationHandler(Tracer, List<Class<? extends Observation.Context>>) - Constructor for class org.springframework.ai.model.observation.ErrorLoggingObservationHandler

ErrorLoggingObservationHandler(Tracer, List<Class<? extends Observation.Context>>, Consumer<Observation.Context>) - Constructor for class org.springframework.ai.model.observation.ErrorLoggingObservationHandler

errorMessages - Variable in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.DescriptiveErrorListener

ErrorUtils - Class in org.springframework.ai.mcp.annotation.common

escapeCurlyBrackets(String) - Static method in class org.springframework.ai.test.CurlyBracketEscaper

Escapes all curly brackets in the input string by adding a backslash before them

estimate(String) - Method in class org.springframework.ai.tokenizer.JTokkitTokenCountEstimator

estimate(String) - Method in interface org.springframework.ai.tokenizer.TokenCountEstimator

Estimates the number of tokens in the given text.

estimate(Iterable<MediaContent>) - Method in class org.springframework.ai.tokenizer.JTokkitTokenCountEstimator

estimate(Iterable<MediaContent>) - Method in interface org.springframework.ai.tokenizer.TokenCountEstimator

Estimates the number of tokens in the given messages.

estimate(MediaContent) - Method in class org.springframework.ai.tokenizer.JTokkitTokenCountEstimator

estimate(MediaContent) - Method in interface org.springframework.ai.tokenizer.TokenCountEstimator

Estimates the number of tokens in the given message.

EUCLIDEAN - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric

The euclidean distance metric.

EUCLIDEAN - Enum constant in enum class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Similarity

EUCLIDEAN - Enum constant in enum class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBDistanceType

EUCLIDEAN - Enum constant in enum class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Neo4jDistanceType

EUCLIDEAN - Enum constant in enum class org.springframework.ai.vectorstore.oracle.OracleVectorStore.OracleVectorStoreDistanceType

Also called L2_DISTANCE, calculates the Euclidean distance between two vectors.

EUCLIDEAN_DISTANCE - Enum constant in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgDistanceType

EUCLIDEAN_SQUARED - Enum constant in enum class org.springframework.ai.vectorstore.oracle.OracleVectorStore.OracleVectorStoreDistanceType

Also called L2_SQUARED is the Euclidean distance without taking the square root.

evalCount() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Returns the value of the evalCount record component.

evalDuration() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Returns the value of the evalDuration record component.

evaluate(EvaluationRequest) - Method in class org.springframework.ai.chat.evaluation.FactCheckingEvaluator

Evaluates whether the response content in the EvaluationRequest is factually supported by the context provided in the same request.

evaluate(EvaluationRequest) - Method in class org.springframework.ai.chat.evaluation.RelevancyEvaluator

evaluate(EvaluationRequest) - Method in interface org.springframework.ai.evaluation.Evaluator

evaluationPrompt(String) - Method in class org.springframework.ai.chat.evaluation.FactCheckingEvaluator.Builder

EvaluationRequest - Class in org.springframework.ai.evaluation

Represents an evaluation request, which includes the user's text, a list of content data, and a chat response.

EvaluationRequest(String, String) - Constructor for class org.springframework.ai.evaluation.EvaluationRequest

EvaluationRequest(String, List<Document>, String) - Constructor for class org.springframework.ai.evaluation.EvaluationRequest

EvaluationRequest(List<Document>, String) - Constructor for class org.springframework.ai.evaluation.EvaluationRequest

EvaluationResponse - Class in org.springframework.ai.evaluation

EvaluationResponse(boolean, float, String, Map<String, Object>) - Constructor for class org.springframework.ai.evaluation.EvaluationResponse

EvaluationResponse(boolean, String, Map<String, Object>) - Constructor for class org.springframework.ai.evaluation.EvaluationResponse

Evaluator - Interface in org.springframework.ai.evaluation

event(String, Message) - Static method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

EVENT_FILTER_CONTEXT_KEY - Static variable in class org.springframework.ai.session.advisor.SessionMemoryAdvisor

Context key of a per-request EventFilter, merged over the advisor's (see EventFilter.merge(EventFilter)).

eventFilter(EventFilter) - Method in class org.springframework.ai.session.advisor.SessionMemoryAdvisor.Builder

The filter of the history read into the prompt: always the active view, all of it or its newest N events, optionally only some message types or without synthetic events; EventFilter.all() by default.

EventFilter - Record Class in org.springframework.ai.session

Which events of a session's log a read returns: the view (the whole log or its active view), the per-event criteria (event and message types, synthetic events) and the retrieval EventFilter.Window.

EventFilter(Set<MessageType>, Set<EventType>, boolean, boolean, EventFilter.Window) - Constructor for record class org.springframework.ai.session.EventFilter

Creates an instance of a EventFilter record class.

EventFilter.Builder - Class in org.springframework.ai.session

Builds an EventFilter; nothing set is EventFilter.all().

EventFilter.Window - Interface in org.springframework.ai.session

The retrieval window: which of the matching events are returned.

EventFilter.Window.All - Record Class in org.springframework.ai.session

Every matching event.

EventFilter.Window.Last - Record Class in org.springframework.ai.session

The newest n matching events.

eventFormatter(Function<SessionEvent, String>) - Method in class org.springframework.ai.session.compaction.ChatModelSummarizer.Builder

How an event is rendered in the prompt; EventText.of(SessionEvent) by default.

events() - Method in record class org.springframework.ai.session.compaction.CompactionRequest

Returns the value of the events record component.

eventStream() - Method in class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport

Deprecated.

Initializes and starts the inbound SSE event processing.

EventText - Class in org.springframework.ai.session.compaction

One line of text for an event or a message: what compaction counts tokens on, and what a summarizer puts in its prompt.

EventType - Class in org.springframework.ai.session

What a SessionEvent records.

eventTypes() - Method in record class org.springframework.ai.session.EventFilter

Returns the value of the eventTypes record component.

eventTypes(Set<EventType>) - Method in class org.springframework.ai.session.EventFilter.Builder

Only include events whose SessionEvent.getType() is in this set.

Eviction() - Constructor for class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties.Eviction

evictionStrategy(ToolIndexEvictionStrategy) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor.Builder

Sets the eviction strategy that determines when session tool indexes are cleared from the advisor's cache.

evictSession(String) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor

Explicitly evicts a session's tool index and removes it from the advisor's cache.

EXCERPT_KEYWORDS_METADATA_KEY - Static variable in class org.springframework.ai.model.transformer.KeywordMetadataEnricher

exchange() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

exchange() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

exchange() - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes

exchange(McpAsyncServerExchange) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext.Builder

exchange(McpSyncServerExchange) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext.Builder

excludeSynthetic() - Method in record class org.springframework.ai.session.EventFilter

Returns the value of the excludeSynthetic record component.

excludeSynthetic(boolean) - Method in class org.springframework.ai.session.EventFilter.Builder

When true, the synthetic events a compaction wrote are left out.

excludeToolFromLimit(String) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder

Exempt the named tool from the per-tool call limit, so it can be called an unlimited number of times regardless of DefaultToolCallingManager.Builder.maxCallsPerTool(int) or a prior DefaultToolCallingManager.Builder.maxCallsPerTool(String, int) override for that tool.

execute(HttpRequest, RequestOptions) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient

execute(HttpRequest, RequestOptions) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient

execute(RetryTemplate, Retryable<R>) - Static method in class org.springframework.ai.retry.RetryUtils

Generic execute method to run retryable operations with the provided RetryTemplate.

EXECUTE_TOOL - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType

AI operation type for tool execution.

executeAsync(HttpRequest, RequestOptions) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient

executeAsync(HttpRequest, RequestOptions) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient

executeQuery(String, int) - Method in interface org.springframework.ai.chat.memory.repository.redis.AdvancedRedisChatMemoryRepository

Deprecated.

Execute a custom query using Redis Search syntax.

executeQuery(String, int) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

executeTest(Consumer<VectorStore>) - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

Execute a test function with a configured VectorStore instance.

executeTest(Consumer<VectorStore>) - Method in class org.springframework.ai.test.vectorstore.BaseVectorStoreTests

Execute a test function with a configured VectorStore instance.

executeToolCalls(Prompt, ChatResponse) - Method in class org.springframework.ai.google.genai.schema.GoogleGenAiToolCallingManager

Executes tool calls by delegating to the underlying tool calling manager.

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.

executeToolCalls(Prompt, ChatResponse, ToolCallDecisions) - Method in class org.springframework.ai.google.genai.schema.GoogleGenAiToolCallingManager

Executes tool calls as a person decided, by delegating to the underlying tool calling manager.

executeToolCalls(Prompt, ChatResponse, ToolCallDecisions) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager

executeToolCalls(Prompt, ChatResponse, ToolCallDecisions) - Method in interface org.springframework.ai.model.tool.ToolCallingManager

Execute the tool calls requested by the model as a person decided: an allowed call runs, a denied call does not and the model receives the decision's message as its result.

exists(String) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

exitAndExpression(FiltersParser.AndExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the AndExpression labeled alternative in FiltersParser.booleanExpression().

exitAndExpression(FiltersParser.AndExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the AndExpression labeled alternative in FiltersParser.booleanExpression().

exitBooleanConstant(FiltersParser.BooleanConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the BooleanConstant labeled alternative in FiltersParser.constant().

exitBooleanConstant(FiltersParser.BooleanConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the BooleanConstant labeled alternative in FiltersParser.constant().

exitCompare(FiltersParser.CompareContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by FiltersParser.compare().

exitCompare(FiltersParser.CompareContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by FiltersParser.compare().

exitCompareExpression(FiltersParser.CompareExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the CompareExpression labeled alternative in FiltersParser.booleanExpression().

exitCompareExpression(FiltersParser.CompareExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the CompareExpression labeled alternative in FiltersParser.booleanExpression().

exitCompoundIdentifier(FiltersParser.CompoundIdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the CompoundIdentifier labeled alternative in FiltersParser.identifier().

exitCompoundIdentifier(FiltersParser.CompoundIdentifierContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the CompoundIdentifier labeled alternative in FiltersParser.identifier().

exitConstantArray(FiltersParser.ConstantArrayContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by FiltersParser.constantArray().

exitConstantArray(FiltersParser.ConstantArrayContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by FiltersParser.constantArray().

exitDecimalConstant(FiltersParser.DecimalConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the DecimalConstant labeled alternative in FiltersParser.constant().

exitDecimalConstant(FiltersParser.DecimalConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the DecimalConstant labeled alternative in FiltersParser.constant().

exitEveryRule(ParserRuleContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

exitGroupExpression(FiltersParser.GroupExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the GroupExpression labeled alternative in FiltersParser.booleanExpression().

exitGroupExpression(FiltersParser.GroupExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the GroupExpression labeled alternative in FiltersParser.booleanExpression().

exitInExpression(FiltersParser.InExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the InExpression labeled alternative in FiltersParser.booleanExpression().

exitInExpression(FiltersParser.InExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the InExpression labeled alternative in FiltersParser.booleanExpression().

exitIntegerConstant(FiltersParser.IntegerConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the IntegerConstant labeled alternative in FiltersParser.constant().

exitIntegerConstant(FiltersParser.IntegerConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the IntegerConstant labeled alternative in FiltersParser.constant().

exitIsNotNullExpression(FiltersParser.IsNotNullExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the IsNotNullExpression labeled alternative in FiltersParser.booleanExpression().

exitIsNotNullExpression(FiltersParser.IsNotNullExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the IsNotNullExpression labeled alternative in FiltersParser.booleanExpression().

exitIsNullExpression(FiltersParser.IsNullExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the IsNullExpression labeled alternative in FiltersParser.booleanExpression().

exitIsNullExpression(FiltersParser.IsNullExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the IsNullExpression labeled alternative in FiltersParser.booleanExpression().

exitLongConstant(FiltersParser.LongConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the LongConstant labeled alternative in FiltersParser.constant().

exitLongConstant(FiltersParser.LongConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the LongConstant labeled alternative in FiltersParser.constant().

exitNinExpression(FiltersParser.NinExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the NinExpression labeled alternative in FiltersParser.booleanExpression().

exitNinExpression(FiltersParser.NinExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the NinExpression labeled alternative in FiltersParser.booleanExpression().

exitNotExpression(FiltersParser.NotExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the NotExpression labeled alternative in FiltersParser.booleanExpression().

exitNotExpression(FiltersParser.NotExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the NotExpression labeled alternative in FiltersParser.booleanExpression().

exitOrExpression(FiltersParser.OrExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the OrExpression labeled alternative in FiltersParser.booleanExpression().

exitOrExpression(FiltersParser.OrExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the OrExpression labeled alternative in FiltersParser.booleanExpression().

exitQuotedIdentifier(FiltersParser.QuotedIdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the QuotedIdentifier labeled alternative in FiltersParser.identifier().

exitQuotedIdentifier(FiltersParser.QuotedIdentifierContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the QuotedIdentifier labeled alternative in FiltersParser.identifier().

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.AndExpressionContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.BooleanConstantContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareExpressionContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompoundIdentifierContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantArrayContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.DecimalConstantContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.GroupExpressionContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.InExpressionContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IntegerConstantContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNotNullExpressionContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNullExpressionContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.LongConstantContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NinExpressionContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NotExpressionContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.OrExpressionContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.QuotedIdentifierContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.SimpleIdentifierContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.TextConstantContext

exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.WhereContext

exitSimpleIdentifier(FiltersParser.SimpleIdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the SimpleIdentifier labeled alternative in FiltersParser.identifier().

exitSimpleIdentifier(FiltersParser.SimpleIdentifierContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the SimpleIdentifier labeled alternative in FiltersParser.identifier().

exitTextConstant(FiltersParser.TextConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by the TextConstant labeled alternative in FiltersParser.constant().

exitTextConstant(FiltersParser.TextConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by the TextConstant labeled alternative in FiltersParser.constant().

exitWhere(FiltersParser.WhereContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

Exit a parse tree produced by FiltersParser.where().

exitWhere(FiltersParser.WhereContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener

Exit a parse tree produced by FiltersParser.where().

expand(Query) - Method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander

expand(Query) - Method in interface org.springframework.ai.rag.preretrieval.query.expansion.QueryExpander

Expands the given query into a list of queries.

expandIn(Filter.Expression, StringBuilder, FilterExpressionConverter) - Static method in class org.springframework.ai.vectorstore.filter.FilterHelper

Expands the IN into a semantically equivalent boolean expressions of ORs of EQs.

expandNin(Filter.Expression, StringBuilder, FilterExpressionConverter) - Static method in class org.springframework.ai.vectorstore.filter.FilterHelper

Expands the NIN (e.g.

expiresAt() - Method in class org.springframework.ai.session.Session

When the session expires, or null for never.

expiresAt(Instant) - Method in class org.springframework.ai.session.Session.Builder

Sets the expiry, or null for a session that never expires, the default.

expireTime(Instant) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent.Builder

expireTime(Instant) - Method in class org.springframework.ai.google.genai.cache.CachedContentRequest.Builder

expireTime(Instant) - Method in class org.springframework.ai.google.genai.cache.CachedContentUpdateRequest.Builder

explicitParts - Variable in class org.springframework.ai.chat.messages.AssistantMessage.Builder

expression() - Method in record class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder.Op

Returns the value of the expression record component.

Expression(Filter.ExpressionType, Filter.Operand) - Constructor for record class org.springframework.ai.vectorstore.filter.Filter.Expression

Expression(Filter.ExpressionType, Filter.Operand, Filter.Operand) - Constructor for record class org.springframework.ai.vectorstore.filter.Filter.Expression

Creates an instance of a Expression record class.

extendTtl(String, Duration) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService

Extends the TTL of cached content by the specified duration.

extraBody - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

extraBody - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

extraBody(Map<String, Object>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

extraBody(Map<String, Object>) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder

extraBody(Map<String, Object>) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

extractContainerId(ChatResponse) - Static method in class org.springframework.ai.anthropic.AnthropicSkillsResponseHelper

Extract container ID from a chat response for multi-turn conversation reuse.

ExtractedImage(String, Integer, Integer, Integer, Integer, String) - Constructor for record class org.springframework.ai.mistralai.ocr.MistralOcrApi.ExtractedImage

Creates an instance of a ExtractedImage record class.

ExtractedTextFormatter - Class in org.springframework.ai.reader

A utility to reformat extracted text content before encapsulating it in a Document.

ExtractedTextFormatter.Builder - Class in org.springframework.ai.reader

The Builder class is a nested static class of ExtractedTextFormatter designed to facilitate the creation and customization of instances of ExtractedTextFormatter.

extractFileIds(ChatResponse) - Static method in class org.springframework.ai.anthropic.AnthropicSkillsResponseHelper

Extract all file IDs from a chat response.

extractReferenceContent() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Extract text content as integers.

extractRegions(PDPage) - Method in class org.springframework.ai.reader.pdf.layout.PDFLayoutTextStripperByArea

Process the page to extract the region text.

extractTextContent() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Extract text content as string.

extractThinkingReferenceContent() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Extract thinking reference content as integers.

extractThinkingTextContent() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Extract thinking text content as string.

extraText() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerification

Returns the value of the extraText record component.

F

F - Enum constant in enum class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Unit

Fahrenheit.

f16KV - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

f16KV(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

f16KV(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

FABLE - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Voice

FABLE - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.Voice

FACT_VERIFICATION - Enum constant in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.TaskType

Specifies that the query embedding is used for fact verification.

FACT_VERIFICATION - Enum constant in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.TaskType

Specifies that the query embedding is used for fact verification.

FactCheckingEvaluator - Class in org.springframework.ai.chat.evaluation

Implementation of Evaluator used to evaluate the factual accuracy of Large Language Model (LLM) responses against provided context.

FactCheckingEvaluator(ChatClient.Builder, String) - Constructor for class org.springframework.ai.chat.evaluation.FactCheckingEvaluator

Constructs a new FactCheckingEvaluator with the provided ChatClient.Builder and evaluation prompt.

FactCheckingEvaluator.Builder - Class in org.springframework.ai.chat.evaluation

failureCount() - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingResponse

Returns the value of the failureCount record component.

failureResponse(String) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor.Builder

Fallback() - Constructor for class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Resolution.Fallback

FALSE - Enum constant in enum class org.springframework.ai.model.ollama.autoconfigure.OllamaThinkProperties

families() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model.Details

Returns the value of the families record component.

family() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model.Details

Returns the value of the family record component.

FAMOUS - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.CategoryEnum

FAMOUS - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.CategoryEnum

FANTASY_ART - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

featured() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the featured record component.

feels_like() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Response

Returns the value of the feels_like record component.

fetch(URI) - Method in class org.springframework.ai.bedrock.converse.api.MediaFetcher

Fetches the content at uri and returns it as a byte array.

fieldName(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder

fieldName(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

fields(String[]) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

Sets the fields array.

fieldType() - Method in record class org.springframework.ai.vectorstore.azure.AzureVectorStore.MetadataField

Returns the value of the fieldType record component.

fieldType() - Method in record class org.springframework.ai.vectorstore.redis.RedisVectorStore.MetadataField

Returns the value of the fieldType record component.

FileDocumentWriter - Class in org.springframework.ai.writer

Writes the content of a list of Documents into a file.

FileDocumentWriter(String) - Constructor for class org.springframework.ai.writer.FileDocumentWriter

FileDocumentWriter(String, boolean) - Constructor for class org.springframework.ai.writer.FileDocumentWriter

FileDocumentWriter(String, boolean, MetadataMode, boolean) - Constructor for class org.springframework.ai.writer.FileDocumentWriter

Writes the content of a list of Documents into a file.

fileId() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerificationFile

Returns the value of the fileId record component.

fileName() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerificationFile

Returns the value of the fileName record component.

fileName() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Sample

Returns the value of the fileName record component.

files() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerification

Returns the value of the files record component.

FileSearch() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.FileSearch

FileSearch(List<String>, Integer) - Constructor for record class org.springframework.ai.openai.responses.HostedTool.FileSearch

Creates an instance of a FileSearch record class.

filter(ClientRequest, ExchangeFunction) - Method in class org.springframework.ai.vectorstore.gemfire.BearerTokenAuthenticationFilterFunction

Filter - Class in org.springframework.ai.vectorstore.filter

Portable runtime generative for metadata filter expressions.

Filter() - Constructor for class org.springframework.ai.vectorstore.filter.Filter

FILTER_EXPRESSION - Static variable in class org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor

FILTER_EXPRESSION - Static variable in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever

FILTER_EXPRESSION_CONVERTER - Static variable in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore

Filter.Expression - Record Class in org.springframework.ai.vectorstore.filter

Triple that represents and filter boolean expression as left type right.

Filter.ExpressionType - Enum Class in org.springframework.ai.vectorstore.filter

Filter expression operations.

Filter.Group - Record Class in org.springframework.ai.vectorstore.filter

Represents expression grouping (e.g. (...) ) that indicates that the group needs to be evaluated with a precedence.

Filter.Key - Record Class in org.springframework.ai.vectorstore.filter

String identifier representing an expression key.

Filter.Operand - Interface in org.springframework.ai.vectorstore.filter

Mark interface representing the supported expression types: Filter.Key, Filter.Value, Filter.Expression and Filter.Group.

Filter.Value - Record Class in org.springframework.ai.vectorstore.filter

Represents expression value constant or constant array.

filterConverter(BedrockKnowledgeBaseFilterExpressionConverter) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore.Builder

Sets a custom filter expression converter.

filterExpression(String) - Method in class org.springframework.ai.vectorstore.SearchRequest.Builder

Document metadata filter expression.

filterExpression(Filter.Expression) - Method in class org.springframework.ai.vectorstore.SearchRequest.Builder

Retrieves documents by query embedding similarity and matching the filters.

filterExpression(String) - Method in class org.springframework.ai.vectorstore.milvus.MilvusSearchRequest.MilvusBuilder

SearchRequest.Builder.filterExpression(String)

filterExpression(Supplier<Filter.Expression>) - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever.Builder

filterExpression(Filter.Expression) - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever.Builder

filterExpression(Filter.Expression) - Method in class org.springframework.ai.vectorstore.milvus.MilvusSearchRequest.MilvusBuilder

SearchRequest.Builder.filterExpression(Filter.Expression)

FilterExpressionBuilder - Class in org.springframework.ai.vectorstore.filter

DSL builder for Filter.Expression instances.

FilterExpressionBuilder() - Constructor for class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

FilterExpressionBuilder.Op - Record Class in org.springframework.ai.vectorstore.filter

filterExpressionConverter - Variable in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

filterExpressionConverter - Variable in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

filterExpressionConverter - Variable in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

filterExpressionConverter - Variable in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

filterExpressionConverter - Variable in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore

filterExpressionConverter - Variable in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

filterExpressionConverter(FilterExpressionConverter) - Method in class org.springframework.ai.chroma.vectorstore.ChromaVectorStore.Builder

Sets the filter expression converter.

filterExpressionConverter(FilterExpressionConverter) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

Sets the filter expression converter.

filterExpressionConverter(FilterExpressionConverter) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore.Builder

Sets the filter expression converter.

filterExpressionConverter(FilterExpressionConverter) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Builder

Sets the FilterExpressionConverter to use when converting filter expressions to Neo4j Cypher queries.

filterExpressionConverter(FilterExpressionConverter) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.Builder

Sets the filter expression converter.

filterExpressionConverter(MongoDBAtlasFilterExpressionConverter) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.Builder

Sets the filter expression converter.

filterExpressionConverter(S3VectorFilterExpressionConverter) - Method in class org.springframework.ai.vectorstore.s3.S3VectorStore.Builder

FilterExpressionConverter - Interface in org.springframework.ai.vectorstore.filter

Converters a generic, portable Filter.Expression into a VectorStore specific expression language format.

FilterExpressionParseException(String, Throwable) - Constructor for exception org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionParseException

FilterExpressionTextParser - Class in org.springframework.ai.vectorstore.filter

Parse a textual, vector-store agnostic, filter expression language into Filter.Expression.

FilterExpressionTextParser() - Constructor for class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser

FilterExpressionTextParser(ANTLRErrorStrategy) - Constructor for class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser

FilterExpressionTextParser.DescriptiveErrorListener - Class in org.springframework.ai.vectorstore.filter

FilterExpressionTextParser.FilterExpressionParseException - Exception in org.springframework.ai.vectorstore.filter

FilterExpressionTextParser.FilterExpressionVisitor - Class in org.springframework.ai.vectorstore.filter

FilterExpressionVisitor() - Constructor for class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

FilterHelper - Class in org.springframework.ai.vectorstore.filter

Helper class providing various boolean transformation.

filterMetadataFields(List<AzureVectorStore.MetadataField>) - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore.Builder

Sets the metadata fields for filtering.

filterMetadataFields(List<WeaviateVectorStore.MetadataField>) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.Builder

Configures the filterable metadata fields.

filterMethodWithBidirectionalParameters() - Static method in class org.springframework.ai.mcp.annotation.common.McpPredicates

filterNonReactiveReturnTypeMethod() - Static method in class org.springframework.ai.mcp.annotation.common.McpPredicates

filterNonSupportedFields(Map<String, Object>) - Static method in class org.springframework.ai.ollama.api.OllamaChatOptions

Filter out the non-supported fields from the options.

filterNonSupportedFields(Map<String, Object>) - Static method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

Filter out the non-supported fields from the options.

filterReactiveReturnTypeMethod() - Static method in class org.springframework.ai.mcp.annotation.common.McpPredicates

FiltersBaseListener - Class in org.springframework.ai.vectorstore.filter.antlr4

This class provides an empty implementation of FiltersListener, which can be extended to create a listener which only needs to handle a subset of the available methods.

FiltersBaseListener() - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

FiltersBaseVisitor<T> - Class in org.springframework.ai.vectorstore.filter.antlr4

This class provides an empty implementation of FiltersVisitor, which can be extended to create a visitor which only needs to handle a subset of the available methods.

FiltersBaseVisitor() - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

FiltersLexer - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersLexer(CharStream) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

FiltersListener - Interface in org.springframework.ai.vectorstore.filter.antlr4

This interface defines a complete listener for a parse tree produced by FiltersParser.

FiltersParser - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser(TokenStream) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

FiltersParser.AndExpressionContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.BooleanConstantContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.BooleanExpressionContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.CompareContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.CompareExpressionContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.CompoundIdentifierContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.ConstantArrayContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.ConstantContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.DecimalConstantContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.GroupExpressionContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.IdentifierContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.InExpressionContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.IntegerConstantContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.IsNotNullExpressionContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.IsNullExpressionContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.LongConstantContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.NinExpressionContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.NotExpressionContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.OrExpressionContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.QuotedIdentifierContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.SimpleIdentifierContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.TextConstantContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersParser.WhereContext - Class in org.springframework.ai.vectorstore.filter.antlr4

FiltersVisitor<T> - Interface in org.springframework.ai.vectorstore.filter.antlr4

This interface defines a complete generic visitor for a parse tree produced by FiltersParser.

financial() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Returns the value of the financial record component.

financial() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Returns the value of the financial record component.

financial(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder

financial(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder

financialRewardsEnabled() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the financialRewardsEnabled record component.

find(String) - Method in class org.springframework.ai.bedrock.aot.BedrockRuntimeHints

findByContent(String, int) - Method in interface org.springframework.ai.chat.memory.repository.redis.AdvancedRedisChatMemoryRepository

Deprecated.

Find messages by content across all conversations.

findByContent(String, int) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

findByConversationId(String) - Method in interface org.springframework.ai.chat.memory.ChatMemoryRepository

Deprecated.

findByConversationId(String) - Method in class org.springframework.ai.chat.memory.InMemoryChatMemoryRepository

Deprecated.

findByConversationId(String) - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepository

Deprecated.

findByConversationId(String) - Method in class org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepository

Deprecated.

findByConversationId(String) - Method in class org.springframework.ai.chat.memory.repository.mongo.MongoChatMemoryRepository

Deprecated.

findByConversationId(String) - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepository

Deprecated.

findByConversationId(String) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

Finds all messages for a given conversation ID.

findById(String) - Method in class org.springframework.ai.session.DefaultSessionService

findById(String) - Method in class org.springframework.ai.session.InMemorySessionRepository

findById(String) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository

findById(String) - Method in interface org.springframework.ai.session.SessionRepository

findById(String) - Method in interface org.springframework.ai.session.SessionService

findByMetadata(String, Object, int) - Method in interface org.springframework.ai.chat.memory.repository.redis.AdvancedRedisChatMemoryRepository

Deprecated.

Find messages with a specific metadata key-value pair.

findByMetadata(String, Object, int) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

findByMetadata(String, String) - Method in class org.springframework.ai.session.DefaultSessionService

findByMetadata(String, String) - Method in class org.springframework.ai.session.InMemorySessionRepository

findByMetadata(String, String) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository

findByMetadata(String, String) - Method in interface org.springframework.ai.session.SessionRepository

The sessions whose metadata holds value under name, oldest first (creation time, then id).

findByMetadata(String, String) - Method in interface org.springframework.ai.session.SessionService

The sessions whose metadata holds value under name, oldest first, for the keys the store indexes; see SessionRepository.findByMetadata(java.lang.String, java.lang.String).

findByPromptIndex(int) - Method in interface org.springframework.ai.chat.metadata.PromptMetadata

Returns an Optional PromptMetadata.PromptFilterMetadata at the given index.

findByTimeRange(String, Instant, Instant, int) - Method in interface org.springframework.ai.chat.memory.repository.redis.AdvancedRedisChatMemoryRepository

Deprecated.

Find messages by timestamp range.

findByTimeRange(String, Instant, Instant, int) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

findByType(MessageType, int) - Method in interface org.springframework.ai.chat.memory.repository.redis.AdvancedRedisChatMemoryRepository

Deprecated.

Find messages by type across all conversations.

findByType(MessageType, int) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

findCauseUsingPlainJava(Throwable) - Static method in class org.springframework.ai.mcp.annotation.common.ErrorUtils

findCauseUsingPlainJava(Throwable) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractMcpToolMethodCallback

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

Deprecated.

findConversationIds() - Method in class org.springframework.ai.chat.memory.InMemoryChatMemoryRepository

Deprecated.

findConversationIds() - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepository

Deprecated.

findConversationIds() - Method in class org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepository

Deprecated.

findConversationIds() - Method in class org.springframework.ai.chat.memory.repository.mongo.MongoChatMemoryRepository

Deprecated.

findConversationIds() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepository

Deprecated.

findConversationIds() - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

Finds all unique conversation IDs using Redis aggregation.

findEvents(String, EventFilter) - Method in class org.springframework.ai.session.InMemorySessionRepository

findEvents(String, EventFilter) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository

findEvents(String, EventFilter) - Method in interface org.springframework.ai.session.SessionRepository

The events of the session the filter selects, oldest first; an empty list for a session that does not exist.

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.

findOrCreate(CreateSessionRequest) - Method in interface org.springframework.ai.session.SessionService

The session with the request's id, created from the request when there is none.

findSession(String) - Method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

The session with the given id, which must exist.

fineTuning() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the fineTuning record component.

FineTuning(Boolean, Map<String, String>, List<String>, Integer, Boolean, String, Map<String, Double>, Map<String, String>, Double, List<ElevenLabsVoicesApi.VerificationAttempt>, List<String>, ElevenLabsVoicesApi.ManualVerification, Integer, Long) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Creates an instance of a FineTuning record class.

FINISH_REASON - Static variable in exception org.springframework.ai.model.tool.ToolCallLimitExceededException

Generation.getMetadata() finish reason set on the Generation built by ToolCallLimitExceededException.buildGeneration(), distinguishing a forcibly aborted turn from a regular returnDirect completion.

FINISH_REASON - Static variable in interface org.springframework.ai.model.tool.ToolExecutionResult

finishReason() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion.Choice

Returns the value of the finishReason record component.

finishReason() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk.ChunkChoice

Returns the value of the finishReason record component.

finishReason() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion.Choice

Returns the value of the finishReason record component.

finishReason() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk.ChunkChoice

Returns the value of the finishReason record component.

finishReason() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageResponse.Artifacts

Returns the value of the finishReason record component.

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

firstByteLatency() - Method in record class org.springframework.ai.bedrock.api.AbstractBedrockApi.AmazonBedrockInvocationMetrics

Returns the value of the firstByteLatency record component.

firstIndexOf(List<MessagePart>, Class<? extends MessagePart>...) - Static method in class org.springframework.ai.chat.messages.AbstractMessage

The index of the first part that is an instance of any of the given types, for use as the fallbackIndex of AbstractMessage.replace(java.util.List<org.springframework.ai.chat.messages.part.MessagePart>, java.lang.Class<? extends org.springframework.ai.chat.messages.part.MessagePart>, java.util.List<? extends org.springframework.ai.chat.messages.part.MessagePart>, int).

FIVE_MINUTES - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCacheTtl

FIVE_MINUTES - Enum constant in enum class org.springframework.ai.bedrock.converse.api.BedrockCacheTtl

FixedDimensionEmbeddingModel - Class in org.springframework.ai.test.vectorstore

A minimal deterministic EmbeddingModel that returns a constant vector of a configured dimension, for tests that must not depend on a hosted embedding provider.

FixedDimensionEmbeddingModel(int) - Constructor for class org.springframework.ai.test.vectorstore.FixedDimensionEmbeddingModel

fixedThreadPoolExecutorSize(int) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

Executor to use when adding documents.

FLAC - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.AudioResponseFormat

FLAC - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.AudioResponseFormat

flagged() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationResult

flagged(boolean) - Method in class org.springframework.ai.moderation.ModerationResult.Builder

FLAT - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

FLAT - Enum constant in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.Algorithm

flatten() - Method in class org.springframework.ai.reader.pdf.config.ParagraphManager

FLEX - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiServiceTier

The flex service tier.

flightNumber() - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.Booking

Returns the value of the flightNumber record component.

flightNumber() - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.BookingRequest

Returns the value of the flightNumber record component.

FLOAT - Enum constant in enum class org.springframework.ai.openai.OpenAiEmbeddingOptions.EncodingFormat

forBespokeMinicheck(ChatClient.Builder) - Static method in class org.springframework.ai.chat.evaluation.FactCheckingEvaluator

Creates a FactCheckingEvaluator configured for use with the Bespoke Minicheck model.

forcedNormalization(boolean) - Method in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore.Builder

Sets whether to force vector normalization.

forcedNormalization(boolean) - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore.Builder

Sets whether to force vector normalization.

ForkPDFLayoutTextStripper - Class in org.springframework.ai.reader.pdf.layout

This class extends PDFTextStripper to provide custom text extraction and formatting capabilities for PDF pages.

ForkPDFLayoutTextStripper() - Constructor for class org.springframework.ai.reader.pdf.layout.ForkPDFLayoutTextStripper

Constructor

format - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

format() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest

Returns the value of the format record component.

format() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model.Details

Returns the value of the format record component.

format() - Method in record class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters

Returns the value of the format record component.

format(Object) - Method in class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

format(Object) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

format(String) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder

format(String) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.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.

format(String) - Static method in class org.springframework.ai.mcp.McpToolUtils

format(String) - Method in class org.springframework.ai.reader.ExtractedTextFormatter

Formats the provided text according to the formatter's configuration.

format(String, int) - Method in class org.springframework.ai.reader.ExtractedTextFormatter

Formats the provided text based on the formatter's configuration, considering the page number.

format(Document, MetadataMode) - Method in interface org.springframework.ai.document.ContentFormatter

format(Document, MetadataMode) - Method in class org.springframework.ai.document.DefaultContentFormatter

Format() - Constructor for class org.springframework.ai.content.Media.Format

FormatProvider - Interface in org.springframework.ai.converter

Implementations of this interface provide instructions for how the output of a language generative should be formatted.

forTools(String...) - Static method in interface org.springframework.ai.model.tool.ToolCallConfirmationPolicy

The calls of the named tools.

FRAMEWORK - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType

AI operation type for framework.

freeUsersAllowed() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the freeUsersAllowed record component.

frequencyPenalty - Variable in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

frequencyPenalty() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the frequencyPenalty record component.

frequencyPenalty() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the frequencyPenalty record component.

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

frequencyPenalty(Double) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set the frequency penalty.

frequencyPenalty(Double) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

frequencyPenalty(Double) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

frequencyPenalty(Float) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

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(CachedContent) - Static method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

Creates a GoogleGenAiCachedContent from the SDK's CachedContent.

from(GenerateContentResponseUsageMetadata) - Static method in class org.springframework.ai.google.genai.metadata.GoogleGenAiUsage

Creates a GoogleGenAiUsage instance from the Google GenAI SDK response metadata.

from(ModalityTokenCount) - Static method in class org.springframework.ai.google.genai.metadata.GoogleGenAiModalityTokenCount

Creates a GoogleGenAiModalityTokenCount from the SDK's ModalityTokenCount.

from(OpenAiChatOptions.StreamOptions) - Method in class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions.Builder

from(Headers) - Static method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

Parses Anthropic rate-limit headers from the given Headers.

from(TokenCredential) - Static method in class org.springframework.ai.openai.setup.AzureOpenAiCredentials

Adapt an Azure TokenCredential to an OpenAI Credential.

from(TrafficType) - Static method in enum class org.springframework.ai.google.genai.metadata.GoogleGenAiTrafficType

Creates a GoogleGenAiTrafficType from the SDK's TrafficType.

from(Headers) - Static method in class org.springframework.ai.openai.metadata.OpenAiAudioSpeechResponseMetadata

from(Headers) - Static method in class org.springframework.ai.openai.metadata.OpenAiRateLimit

Parses the OpenAI rate-limit headers from the given Headers.

from(EmbeddingCreateParams) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder

from(ImagesResponse) - Static method in class org.springframework.ai.openai.metadata.OpenAiImageResponseMetadata

Creates metadata from an ImagesResponse.

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<? extends ToolCallback>) - Static method in interface org.springframework.ai.tool.ToolCallbackProvider

from(DataSource) - Static method in interface org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepositoryDialect

Deprecated.

Detects the dialect from the DataSource.

from(DataSource) - Static method in interface org.springframework.ai.session.jdbc.JdbcSessionRepositoryDialect

The dialect of the database the data source connects to, from its product name: PostgreSQL, H2, MySQL or MariaDB.

from(AnthropicCacheOptions) - Static method in class org.springframework.ai.anthropic.CacheEligibilityResolver

from(ChatResponse) - Method in class org.springframework.ai.chat.model.ChatResponse.Builder

from(DefaultContentFormatter) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder

from(GoogleGenAiImageOptions) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

from(GoogleGenAiTextEmbeddingOptions) - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.Builder

from(GoogleGenAiAudioTranscriptionOptions) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

Initializes this builder with the values of the given options.

from(MistralAiApi.ChatCompletion) - Static method in class org.springframework.ai.mistralai.MistralAiChatModel

from(MistralAiApi.ChatCompletion, Usage) - Static method in class org.springframework.ai.mistralai.MistralAiChatModel

from(OpenAiAudioSpeechOptions) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder

from(OpenAiAudioTranscriptionOptions) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder

from(OpenAiEmbeddingOptions) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder

from(OpenAiImageOptions) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder

from(OpenAiModerationOptions) - Method in class org.springframework.ai.openai.OpenAiModerationOptions.Builder

from(SessionEvent) - Static method in record class org.springframework.ai.session.compaction.CompactionBoundary

Reads the boundary recorded by a EventType.COMPACTION event.

from(ToolCallback...) - Static method in interface org.springframework.ai.tool.ToolCallbackProvider

from(SearchRequest) - Static method in class org.springframework.ai.vectorstore.SearchRequest

Copy an existing SearchRequest.Builder instance.

from(VertexAiMultimodalEmbeddingOptions) - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions.Builder

from(VertexAiTextEmbeddingOptions) - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.Builder

fromDocument(Document) - Static method in class org.springframework.ai.vectorstore.s3.DocumentUtils

FromDto() - Constructor for class org.springframework.ai.chat.messages.part.MediaPart.FromDto

fromId(String) - Static method in enum class org.springframework.ai.anthropic.AnthropicSkill

Look up a pre-built Anthropic skill by its ID.

fromImageData(MimeType, byte[]) - Static method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl

Convert the bytes to a base64 encoded following the prefix pattern.

fromImageData(MimeType, byte[], MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl.ImageDetail) - Static method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl

Convert the bytes to a base64 encoded following the prefix pattern.

fromJson(Integer, Integer, Integer, Object, Long, Long) - Static method in class org.springframework.ai.chat.metadata.DefaultUsage

Create a new DefaultUsage with promptTokens, completionTokens, and totalTokens.

fromJson(String) - Static method in class org.springframework.ai.google.genai.schema.JsonSchemaConverter

Parses a JSON string into an ObjectNode.

fromJson(String, Class<T>) - Static method in class org.springframework.ai.util.json.JsonParser

Deprecated, for removal: This API element is subject to removal in a future version.

Use JsonHelper.fromJson(String, Class) instead

fromJson(String, Class<T>) - Method in class org.springframework.ai.util.JsonHelper

Converts a JSON string to a Java object.

fromJson(String, Type) - Static method in class org.springframework.ai.util.json.JsonParser

Deprecated, for removal: This API element is subject to removal in a future version.

Use JsonHelper.fromJson(String, Type) instead

fromJson(String, Type) - Method in class org.springframework.ai.util.JsonHelper

Converts a JSON string to a Java object.

fromJson(String, ParameterizedTypeReference<T>) - Method in class org.springframework.ai.util.JsonHelper

Converts a JSON string to a Java object.

fromJson(String, TypeReference<T>) - Static method in class org.springframework.ai.util.json.JsonParser

Deprecated, for removal: This API element is subject to removal in a future version.

Use JsonHelper.fromJson(String, org.springframework.core.ParameterizedTypeReference) instead

fromJsonMap(String) - Method in class org.springframework.ai.session.support.SessionEventCodec

Parses a JSON object into a map.

fromJsonToMap(String) - Method in class org.springframework.ai.util.JsonHelper

Converts the given JSON string to a Map of String and Object.

fromToolMetadata() - Static method in interface org.springframework.ai.model.tool.ToolCallConfirmationPolicy

The calls of tools whose metadata says so (ToolMetadata.requiresConfirmation(), @Tool(requiresConfirmation = true)).

fromValue(String) - Static method in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.Type

function() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.ToolCall

Returns the value of the function record component.

function() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ToolCall

Returns the value of the function record component.

function() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool

Returns the value of the function record component.

function() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message.ToolCall

Returns the value of the function record component.

Function(String, String, String) - Constructor for class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool.Function

Create tool function definition.

Function(String, String, String) - Constructor for class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool.Function

Create tool function definition.

Function(String, String, String) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool.Function

Create tool function definition.

Function(String, String, Map<String, Object>) - Constructor for class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool.Function

Create tool function definition.

Function(String, String, Map<String, Object>) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool.Function

Creates an instance of a Function record class.

Function(String, String, Map<String, Object>, Boolean) - Constructor for class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool.Function

Create tool function definition.

FUNCTION - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool.Type

Function tool type.

FUNCTION - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool.Type

Function tool type.

FUNCTION - Enum constant in enum class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool.Type

Function tool type.

FUNCTION(String) - Static method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.ToolChoiceBuilder

Specifying a particular function forces the model to call that function.

FunctionTool() - Constructor for class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool

FunctionTool(DeepSeekApi.FunctionTool.Function) - Constructor for class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool

Create a tool of type 'function' and the given function definition.

FunctionTool(DeepSeekApi.FunctionTool.Type, DeepSeekApi.FunctionTool.Function) - Constructor for class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool

Create a tool of type 'function' and the given function definition.

FunctionTool(MistralAiApi.FunctionTool.Function) - Constructor for class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool

Create a tool of type 'function' and the given function definition.

FunctionTool(MistralAiApi.FunctionTool.Type, MistralAiApi.FunctionTool.Function) - Constructor for class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool

FunctionToolCallback<I,O> - Class in org.springframework.ai.tool.function

A ToolCallback implementation to invoke functions as tools.

FunctionToolCallback(ToolDefinition, ToolMetadata, Type, BiFunction<I, ToolContext, O>, ToolCallResultConverter) - Constructor for class org.springframework.ai.tool.function.FunctionToolCallback

FunctionToolCallback.Builder<I,O> - Class in org.springframework.ai.tool.function

G

gcsUri - Variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.ImageBuilder

The Cloud Storage location of the image to perform the embedding.

gcsUri - Variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

The Cloud Storage location of the video on which to perform the embedding.

gcsUri(String) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.ImageBuilder

gcsUri(String) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

GE - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

GE - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

GE() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareContext

GEMFIRE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by GemFire.

GEMFIRE - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

GemFireAiSearchFilterExpressionConverter - Class in org.springframework.ai.vectorstore.gemfire

GemFireAiSearchFilterExpressionConverter is a class that converts Filter.Expression objects into GemFire VectorDB query string representation.

GemFireAiSearchFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.gemfire.GemFireAiSearchFilterExpressionConverter

GemFireConnectionDetails - Interface in org.springframework.ai.vectorstore.gemfire.autoconfigure

Connection details for a GemFire service.

gemfireVectorStore(EmbeddingModel, GemFireVectorStoreProperties, GemFireConnectionDetails, ObjectProvider<ObservationRegistry>, ObjectProvider<VectorStoreObservationConvention>, BatchingStrategy) - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreAutoConfiguration

GemFireVectorStore - Class in org.springframework.ai.vectorstore.gemfire

A VectorStore implementation backed by GemFire.

GemFireVectorStore(GemFireVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

Protected constructor that accepts a builder instance.

GemFireVectorStore.Builder - Class in org.springframework.ai.vectorstore.gemfire

Builder class for creating GemFireVectorStore instances.

GemFireVectorStore.CreateRequest - Class in org.springframework.ai.vectorstore.gemfire

GemFireVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.gemfire.autoconfigure

Auto-configuration for GemFire Vector Store.

GemFireVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreAutoConfiguration

GemFireVectorStoreProperties - Class in org.springframework.ai.vectorstore.gemfire.autoconfigure

Configuration properties for GemFire Vector Store.

GemFireVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

GEMINI_2_0_FLASH - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

Deprecated.

GEMINI_2_0_FLASH_LIGHT - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

Deprecated.

GEMINI_2_5_FLASH - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

gemini-2.5-flash is a thinking model that offers great, well-rounded capabilities.

GEMINI_2_5_FLASH_IMAGE - Enum constant in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageModelName

GEMINI_2_5_FLASH_LIGHT - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

gemini-2.5-flash-lite is the fastest and most cost efficient Flash model.

GEMINI_2_5_PRO - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

gemini-2.5-pro is the most advanced reasoning Gemini model, capable of solving complex problems.

GEMINI_3_0_PRO_PREVIEW - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

GEMINI_3_1_FLASH_IMAGE - Enum constant in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageModelName

GEMINI_3_1_FLASH_LITE - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

GEMINI_3_1_FLASH_LITE_IMAGE - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

GEMINI_3_1_PRO_PREVIEW - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

GEMINI_3_5_FLASH - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

GEMINI_3_5_FLASH_LITE - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

GEMINI_3_6_FLASH - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

GEMINI_3_FLASH_PREVIEW - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

GEMINI_3_PRO_IMAGE - Enum constant in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageModelName

GEMINI_3_PRO_PREVIEW - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

Deprecated.

Use GoogleGenAiChatModel.ChatModel.GEMINI_3_1_PRO_PREVIEW instead

GEMINI_EMBEDDING_001 - Enum constant in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModelName

Recommended embedding model for Gemini API.

GeminiRequest(List<Content>, String, GenerateContentConfig) - Constructor for record class org.springframework.ai.google.genai.GoogleGenAiChatModel.GeminiRequest

Creates an instance of a GeminiRequest record class.

GEMMA - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Gemma is a lightweight model with 2 billion and 7 billion

GEMMA3 - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

The current, most capable model that runs on a single GPU.

genAiClient(Client) - Method in class org.springframework.ai.google.genai.embedding.GoogleGenAiEmbeddingConnectionDetails.Builder

genAiClient(Client) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageConnectionDetails.Builder

genAiClient(Client) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechConnectionDetails.Builder

Sets an explicit Client to use.

genAiClient(Client) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatModel.Builder

generate(Map<String, Object>) - Method in class org.springframework.ai.reader.EmptyJsonMetadataGenerator

generate(Map<String, Object>) - Method in interface org.springframework.ai.reader.JsonMetadataGenerator

The input is the JSON document represented as a map, the output are the fields extracted from the input map that will be used as metadata.

generate(Usage, Observation.Context, MeterRegistry) - Static method in class org.springframework.ai.model.observation.ModelUsageMetricsGenerator

GENERATED - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.CategoryEnum

GENERATED - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.CategoryEnum

generateForMethodInput(Method) - Static method in class org.springframework.ai.mcp.annotation.method.tool.utils.McpJsonSchemaGenerator

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.

generateFromClass(Class<?>) - Static method in class org.springframework.ai.mcp.annotation.method.tool.utils.McpJsonSchemaGenerator

Generate a JSON Schema for a class type.

generateFromType(Type) - Static method in class org.springframework.ai.mcp.annotation.method.tool.utils.McpJsonSchemaGenerator

Generate a JSON Schema for a generic type.

generateId(Object...) - Method in interface org.springframework.ai.document.id.IdGenerator

Generate a unique ID for the given content.

generateId(Object...) - Method in class org.springframework.ai.document.id.JdkSha256HexIdGenerator

generateId(Object...) - Method in class org.springframework.ai.document.id.RandomIdGenerator

generateImage(StabilityAiApi.GenerateImageRequest) - Method in class org.springframework.ai.stabilityai.api.StabilityAiApi

GenerateImageRequest(List<StabilityAiApi.GenerateImageRequest.TextPrompts>, Integer, Integer, Float, String, String, Integer, Long, Integer, String) - Constructor for record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

Creates an instance of a GenerateImageRequest record class.

GenerateImageResponse(String, List<StabilityAiApi.GenerateImageResponse.Artifacts>) - Constructor for record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageResponse

Creates an instance of a GenerateImageResponse record class.

generateOutputSchema() - Element in annotation interface org.springframework.ai.mcp.annotation.McpTool

If true, the tool will generate an output schema for non-primitive output types.

generateParagraphs(ParagraphManager.Paragraph, PDOutlineNode, Integer, Set<COSDictionary>) - Method in class org.springframework.ai.reader.pdf.config.ParagraphManager

For given PDOutlineNode bookmark convert all sibling PDOutlineItem items into ParagraphManager.Paragraph instances under the parentParagraph.

generateSchema() - Method in class org.springframework.ai.converter.BeanOutputConverter

Generates the JSON schema for the target 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<Generation>) - Method in class org.springframework.ai.chat.model.ChatResponse.Builder

get() - Method in class org.springframework.ai.reader.JsonReader

get() - Method in class org.springframework.ai.reader.jsoup.JsoupDocumentReader

get() - Method in class org.springframework.ai.reader.markdown.MarkdownDocumentReader

Extracts and returns a list of documents from the resource.

get() - Method in class org.springframework.ai.reader.pdf.PagePdfDocumentReader

get() - Method in class org.springframework.ai.reader.pdf.ParagraphPdfDocumentReader

Reads and processes the PDF document to extract paragraphs.

get() - Method in class org.springframework.ai.reader.TextReader

get() - Method in class org.springframework.ai.reader.tika.TikaDocumentReader

Extracts and returns the list of documents from the resource.

get(String) - Method in interface org.springframework.ai.chat.cache.semantic.SemanticCache

Retrieves a cached response for a semantically similar query.

get(String) - Method in interface org.springframework.ai.chat.memory.ChatMemory

Deprecated.

Get the messages in the chat memory for the specified conversation.

get(String) - Method in class org.springframework.ai.chat.memory.MessageWindowChatMemory

Deprecated.

get(String) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

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.google.genai.cache.GoogleGenAiCachedContentService

Retrieves cached content by name.

get(String) - Method in record class org.springframework.ai.mcp.annotation.McpMeta

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.

get(String) - Method in class org.springframework.ai.reader.JsonReader

Retrieves documents from the JSON resource using a JSON Pointer.

get(String) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache

get(String, int) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

get(String, String) - Method in interface org.springframework.ai.chat.cache.semantic.SemanticCache

Retrieves a cached response for a semantically similar query, filtered by context.

get(String, String) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache

get(JsonNode) - Method in class org.springframework.ai.reader.JsonReader

getAccessKey() - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

getAccessKey() - Method in interface org.springframework.ai.vectorstore.opensearch.autoconfigure.AwsOpenSearchConnectionDetails

getActiveMessages(String) - Method in interface org.springframework.ai.session.SessionService

The messages of the active view, the context window to send to the model: getEvents(sessionId, EventFilter.active()) as messages.

getAdditionalModels() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties.ModelTypeInit

getAdvisorName() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext

getAdvisorOrder() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder

Returns the configured advisor order.

getAdvisorOrder() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

getAdvisorOrder() - Method in class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties.ToolCalling

getAdvisorParams() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

getAdvisors() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec

getAdvisors() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

getAdvisors() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext

getAllAnnotatedBeans() - Method in class org.springframework.ai.mcp.annotation.spring.scan.AbstractMcpAnnotatedBeans

getAllowedDomains() - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool

getAllowedDomains() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.WebSearch

getAllowedFunctionNames() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.ToolChoiceProperties

getAnthropicClient() - Method in class org.springframework.ai.anthropic.AnthropicChatModel

Returns the underlying synchronous Anthropic SDK client.

getAnthropicClientAsync() - Method in class org.springframework.ai.anthropic.AnthropicChatModel

Returns the underlying asynchronous Anthropic SDK client.

getApi() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getApiEndpoint() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiEmbeddingConnectionProperties

getApiKey() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getApiKey() - Method in class org.springframework.ai.google.genai.embedding.GoogleGenAiEmbeddingConnectionDetails

getApiKey() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageConnectionDetails

getApiKey() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechConnectionDetails

The Gemini Developer API key, or null when Vertex AI is used.

getApiKey() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicConnectionProperties

getApiKey() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekParentProperties

getApiKey() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsConnectionProperties

getApiKey() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiConnectionProperties

getApiKey() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiEmbeddingConnectionProperties

getApiKey() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageConnectionProperties

getApiKey() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionConnectionProperties

getApiKey() - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechConnectionProperties

getApiKey() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiParentProperties

getApiKey() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

getApiKey() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getApiKey() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

getApiKey() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions

getApiKey() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getApiKey() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getApiKey() - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

getApiKey() - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

getApiKey() - Method in interface org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantConnectionDetails

getApiKey() - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

getApiKey() - Method in interface org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseConnectionDetails

getApiKey() - Method in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseServiceClientProperties

getApiKey() - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

getApplyLanguageTextNormalization() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getApplyLanguageTextNormalization() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getApplyLanguageTextNormalization() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getApplyTextNormalization() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getApplyTextNormalization() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getApplyTextNormalization() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getAspectRatio() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getAspectRatio() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

getAsync(String) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService

Asynchronously retrieves cached content by name.

getAsyncReadTimeout() - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

getATN() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

getATN() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

getAudioEncoding() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

getAudioEncoding() - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

getAutoCacheThreshold() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getAutoCacheThreshold() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getAutoCacheThreshold() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getAutoCacheTtl() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getAutoCacheTtl() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getAutoCacheTtl() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getAutoTruncate() - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions

getAutoTruncate() - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions

getAws() - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

getB64Json() - Method in class org.springframework.ai.image.Image

getBackoff() - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties

getBaseUrl() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getBaseUrl() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerSseProperties

Deprecated.

getBaseUrl() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicConnectionProperties

getBaseUrl() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekParentProperties

getBaseUrl() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsConnectionProperties

getBaseUrl() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiParentProperties

getBaseUrl() - Method in interface org.springframework.ai.model.ollama.autoconfigure.OllamaConnectionDetails

getBaseUrl() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaConnectionProperties

getBaseUrl() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

getBaseUrl() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getBaseUrl() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

getBaseUrl() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions

getBaseUrl() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the frequency penalty parameter.

getBaseUrl() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getBatchingStrategy() - Method in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

getBeamWidth() - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

getBeamWidth() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.CreateRequest

getBeamWidth() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

getBeansByAnnotation(Class<? extends Annotation>) - Method in class org.springframework.ai.mcp.annotation.spring.scan.AbstractMcpAnnotatedBeans

getBeansByAnnotationType() - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

getBetaPrefixPath() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

getBiFunctionArgumentClass(Class<? extends BiFunction<?, ?, ?>>, 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<? extends BiFunction<?, ?, ?>>) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper

Returns the input class of a given function class.

getBlockedDomains() - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool

getBucketName() - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

getBuckets() - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

getBuckets() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.CreateRequest

getBuckets() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

getCache() - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties

getCachedContentName() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getCachedContentName() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getCachedContentName() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getCachedContentService() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatModel

Gets the cached content service for managing cached content.

getCachedContentTokenCount() - Method in class org.springframework.ai.google.genai.metadata.GoogleGenAiUsage

Returns the number of tokens in the cached content.

getCachedResource(String) - Method in class org.springframework.ai.transformers.ResourceCacheService

Get Resource representing the cached copy of the original resource.

getCachedResource(Resource) - Method in class org.springframework.ai.transformers.ResourceCacheService

Get Resource representing the cached copy of the original resource.

getCacheOptions() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getCacheOptions() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

getCacheOptions() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getCacheOptions() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getCacheOptions() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

getCacheOptions() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getCacheReadInputTokens() - Method in class org.springframework.ai.chat.metadata.DefaultUsage

getCacheReadInputTokens() - Method in interface org.springframework.ai.chat.metadata.Usage

Returns the number of input tokens read from the prompt cache, if the provider supports prompt caching.

getCacheReadInputTokens() - Method in class org.springframework.ai.google.genai.metadata.GoogleGenAiUsage

getCacheTokensDetails() - Method in class org.springframework.ai.google.genai.metadata.GoogleGenAiUsage

Returns the list of modalities of the cached content in the request input.

getCacheWriteInputTokens() - Method in class org.springframework.ai.chat.metadata.DefaultUsage

getCacheWriteInputTokens() - Method in interface org.springframework.ai.chat.metadata.Usage

Returns the number of input tokens written to the prompt cache, if the provider supports prompt caching.

getCallAdvisors() - Method in interface org.springframework.ai.chat.client.advisor.api.CallAdvisorChain

Returns the list of all the CallAdvisor instances included in this chain at the time of its creation.

getCallAdvisors() - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain

getCallCount() - Method in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorAutoRegistrationIT.ChainIterationCountingAdvisor

getCandidateCount() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getCandidateCount() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

getCandidateCount() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getCandidateCount() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getCandidateCount() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

getCandidatesTokensDetails() - Method in class org.springframework.ai.google.genai.metadata.GoogleGenAiUsage

Returns the list of modalities that were returned in the response.

getCapabilities() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

getCapabilities(String) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpAsyncHandlersRegistry

Obtain the MCP capabilities declared for a given MCP client.

getCapabilities(String) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

Obtain the MCP capabilities declared for a given MCP client.

getCaPemPath() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getCapturedRequests() - Method in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorAutoRegistrationIT.ChainIterationCountingAdvisor

getCategories() - Method in class org.springframework.ai.moderation.ModerationResult

getCategory() - Method in class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting

getCategoryScores() - Method in class org.springframework.ai.moderation.ModerationResult

getCfgScale() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

getCfgScale() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getCfgScale() - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

getChannelNames() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

getCharset() - Method in class org.springframework.ai.reader.TextReader

getChat() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties

getChatClientRequest() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext

getChatClientResponse() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext

getChatModel() - Method in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT

Returns the ChatModel instance to be used in tests.

getChatModel() - Method in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorAutoRegistrationIT

getChatModel() - Method in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorIT

Returns the ChatModel instance to be used in tests.

getChunkingStrategy() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

Controls how the audio is cut into chunks.

getChunkingStrategy() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

Controls how the audio is cut into chunks when streaming or when the model benefits from voice-activity-detection-based chunking.

getCitationDocuments() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getCitedText() - Method in class org.springframework.ai.anthropic.Citation

getClientKeyPath() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getClientPemPath() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getClipGuidancePreset() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

getClipGuidancePreset() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getClipGuidancePreset() - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

getCode() - Method in exception org.springframework.ai.openai.responses.OpenAiResponsesException

Return the OpenAI error code, or null if the error carried none.

getCodeInterpreter() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools

getCollection(String, String, String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

getCollectionName() - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaVectorStoreProperties

getCollectionName() - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

getCollectionName() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

getCollectionName() - Method in class org.springframework.ai.vectorstore.mongodb.autoconfigure.MongoDBAtlasVectorStoreProperties

getCollectionName() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

getCollectionName() - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

getCollectionName() - Method in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseVectorStoreProperties

getCompleteSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.complete.AsyncMcpCompleteProvider

Get the async completion specifications.

getCompleteSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.complete.AsyncStatelessMcpCompleteProvider

Get the async stateless completion specifications.

getCompleteSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.complete.SyncMcpCompleteProvider

getCompleteSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.complete.SyncStatelessMcpCompleteProvider

Get the stateless completion specifications.

getCompletionsPath() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

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

getConcreteOptionsClass() - Method in class org.springframework.ai.test.options.AbstractChatOptionsTests

Return the concrete options class being tested.

getConfig() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepository

Deprecated.

getConfigurationPath() - Method in class org.springframework.ai.model.bedrock.autoconfigure.ProfileProperties

getConfirmation() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties

getConnectionAcquisitionTimeout() - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

getConnectionName() - Method in class org.springframework.ai.mcp.McpToolsChangedEvent

getConnections() - Method in interface org.springframework.ai.mcp.client.common.autoconfigure.McpSseClientConnectionDetails

getConnections() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpSseClientProperties

Deprecated.

Returns the map of configured SSE connections.

getConnections() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStdioClientProperties

getConnections() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStreamableHttpClientProperties

Returns the map of configured Streamable Http connections.

getConnections() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.PropertiesMcpSseClientConnectionDetails

Deprecated.

getConnectionTimeout() - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

getConnectionTimeout() - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

getConnectTimeoutMs() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getConsistencyLevel() - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

getConstraintName() - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

getConsumerInputClass(Class<? extends Consumer<?>>) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper

Returns the input class of a given Consumer class.

getContainerId() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.CodeInterpreter

getContentColumnName() - Method in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreProperties

getContentFieldName() - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

getContentFieldName() - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

getContentFieldName() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

getContentFieldName() - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

getContentFieldName() - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

getContentFieldName() - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

getContentFieldName() - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

getContentFieldName() - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStoreOptions

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

getContentFormatter() - Method in class org.springframework.ai.document.Document

Returns the content formatter associated with this document.

getContentLengthFunction() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions

getContents() - Method in class org.springframework.ai.chat.prompt.Prompt

getContents() - Method in class org.springframework.ai.google.genai.cache.CachedContentRequest

getContents() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

getContents() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService.CachedContentPage

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(TranscriptionModelObservationContext) - Method in class org.springframework.ai.audio.transcription.observation.DefaultTranscriptionModelObservationConvention

getContextualName(TextToSpeechModelObservationContext) - Method in class org.springframework.ai.audio.tts.observation.DefaultTextToSpeechModelObservationConvention

getContextualName(AdvisorObservationContext) - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention

getContextualName(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

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

getContextualName(VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

getConversationId(Map<String, Object>) - Method in interface org.springframework.ai.chat.client.advisor.api.MemoryAdvisor

Retrieve the conversation ID from the given context.

getConversionService() - Method in class org.springframework.ai.converter.AbstractConversionServiceOutputConverter

Return the ConversionService used by this converter.

getCount() - Method in class org.springframework.ai.mcp.annotation.spring.scan.AbstractMcpAnnotatedBeans

getCreated() - Method in class org.springframework.ai.image.ImageResponseMetadata

getCreated() - Method in class org.springframework.ai.openai.metadata.OpenAiImageResponseMetadata

getCreateTime() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

getCredential() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

getCredential() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getCredential() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions

getCredential() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getCredential() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getCredentialsPath() - Method in class org.springframework.ai.model.bedrock.autoconfigure.ProfileProperties

getCredentialsUri() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiConnectionProperties

getCredentialsUri() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiEmbeddingConnectionProperties

getCredentialsUri() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageConnectionProperties

getCredentialsUri() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionConnectionProperties

getCredentialsUri() - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechConnectionProperties

getCredentialsUri() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiEmbeddingConnectionProperties

getCriminal() - Method in class org.springframework.ai.moderation.CategoryScores

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.

getCustomHeaders() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getCustomHeaders() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicConnectionProperties

getCustomHeaders() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

getCustomHeaders() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getCustomHeaders() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions

getCustomHeaders() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getCustomHeaders() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getCustomMetadata() - Method in class org.springframework.ai.reader.TextReader

Metadata associated with all documents created by the loader.

getCustomObservationConvention() - Method in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

getDangerous() - Method in class org.springframework.ai.moderation.CategoryScores

getDangerousAndCriminalContent() - Method in class org.springframework.ai.moderation.CategoryScores

Deprecated, for removal: This API element is subject to removal in a future version.

getData() - Method in class org.springframework.ai.content.Media

Get the media data object.

getDataAsByteArray() - Method in class org.springframework.ai.content.Media

Get the media data as a byte array

getDatabase(String, String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

getDatabaseName() - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaVectorStoreProperties

getDatabaseName() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

getDatabaseName() - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

getDatabaseSystem() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

getDataList() - Method in class org.springframework.ai.evaluation.EvaluationRequest

getDefaultJsonMapper() - Static method in class org.springframework.ai.util.JacksonUtils

Returns a default Jackson JsonMapper instance customized with DeserializationFeature.FAIL_ON_TRAILING_TOKENS disabled and the Jackson modules found by JacksonUtils.instantiateAvailableModules() configured.

getDefaultOptions() - Method in interface org.springframework.ai.audio.tts.TextToSpeechModel

Deprecated, for removal: This API element is subject to removal in a future version.

use TextToSpeechModel.getOptions() instead.

getDefaultOptions() - Method in interface org.springframework.ai.chat.model.ChatModel

Deprecated, for removal: This API element is subject to removal in a future version.

use ChatModel.getOptions() instead.

getDefaultOptions() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel

Deprecated, for removal: This API element is subject to removal in a future version.

use ElevenLabsTextToSpeechModel.getOptions() instead.

getDefaultOptions() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechModel

Deprecated, for removal: This API element is subject to removal in a future version.

use GoogleGenAiTextToSpeechModel.getOptions() instead.

getDefaultOptions() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel

Deprecated, for removal: This API element is subject to removal in a future version.

use OpenAiAudioSpeechModel.getOptions() instead.

getDefaultOptions() - Method in class org.springframework.ai.openai.OpenAiChatModel

Deprecated, for removal: This API element is subject to removal in a future version.

use OpenAiChatModel.getOptions() instead.

getDefaultSchemaLocation() - Method in class org.springframework.ai.model.chat.memory.repository.jdbc.autoconfigure.JdbcChatMemoryRepositoryProperties

Deprecated.

getDefaultSchemaLocation() - Method in class org.springframework.ai.model.session.jdbc.autoconfigure.JdbcSessionRepositoryProperties

getDefaultSimilarityThreshold() - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

getDefaultTopK() - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

getDefaultVoiceSettings() - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi

Gets the default settings for voices.

getDeleteMessagesSql() - Method in interface org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepositoryDialect

Deprecated.

Returns the SQL to delete all messages for a conversation.

getDeploymentName() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

Alias for getAzureDeploymentName()

getDeploymentName() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getDeploymentName() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions

Alias for getAzureDeploymentName()

getDeploymentName() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Alias for getAzureDeploymentName()

getDeploymentName() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

Alias for OpenAiResponsesChatOptions.getMicrosoftDeploymentName().

getDescription() - Method in enum class org.springframework.ai.anthropic.AnthropicSkill

getDescription() - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool.Function

getDescription() - Method in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageModelName

getDescription() - Method in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModelName

getDescription() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool.Function

getDescription() - Method in interface org.springframework.ai.model.ModelDescription

Returns the description of the model.

getDescription() - Method in enum class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingModelName

getDescription() - Method in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModelName

getDiarizedJsonWorkaroundEnabled() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

getDimensions() - Method in class org.springframework.ai.bedrock.cohere.BedrockCohereEmbeddingOptions

getDimensions() - Method in class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingOptions

getDimensions() - Method in class org.springframework.ai.embedding.DefaultEmbeddingOptions

getDimensions() - Method in interface org.springframework.ai.embedding.EmbeddingOptions

getDimensions() - Method in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModelName

getDimensions() - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions

getDimensions() - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingOptions

getDimensions() - Method in interface org.springframework.ai.model.EmbeddingModelDescription

getDimensions() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties

getDimensions() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getDimensions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

getDimensions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getDimensions() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getDimensions() - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions

getDimensions() - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions

getDimensions() - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

getDimensions() - Method in class org.springframework.ai.vectorstore.elasticsearch.autoconfigure.ElasticsearchVectorStoreProperties

getDimensions() - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStoreOptions

getDimensions() - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

getDimensions() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

getDimensions() - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

getDimensions() - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

getDimensions() - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

getDimensions() - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

getDimensions() - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties

Returns the vector size of the index.

getDimensions() - Method in enum class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingModelName

getDimensions() - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions

getDimensions() - Method in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModelName

getDimensions() - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions

getDirectory() - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Cache

getDisableParallelToolUse() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getDisableParallelToolUse() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getDisableParallelToolUse() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getDisplayName() - Method in class org.springframework.ai.google.genai.cache.CachedContentRequest

getDisplayName() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

getDistanceMetadataFieldName() - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

getDistanceMetric() - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

getDistanceType() - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

getDistanceType() - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

getDistanceType() - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

getDistanceType() - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

getDistanceType() - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

getDistanceType() - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

getDockerComposeConnectionDetails(DockerComposeConnectionSource) - Method in class org.springframework.ai.docker.compose.service.connection.typesense.TypesenseDockerComposeConnectionDetailsFactory

getDocumentData() - Method in class org.springframework.ai.embedding.EmbeddingResultMetadata

getDocumentFormat(MimeType) - Static method in class org.springframework.ai.bedrock.converse.api.BedrockMediaFormat

getDocumentId() - Method in class org.springframework.ai.embedding.EmbeddingResultMetadata

getDocumentIndex() - Method in class org.springframework.ai.anthropic.Citation

getDocumentTitle() - Method in class org.springframework.ai.anthropic.Citation

getDriver() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

getDriver() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig

Deprecated.

getDuplicateToolNames(List<ToolCallback>) - Static method in class org.springframework.ai.tool.support.ToolUtils

getDuplicateToolNames(ToolCallback...) - Static method in class org.springframework.ai.tool.support.ToolUtils

getDuration() - Method in class org.springframework.ai.openai.metadata.OpenAiAudioTranscriptionResponseMetadata

Returns the audio duration in seconds, or null if not returned by the API.

getEfConstruction() - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties.HnswProperties

Returns the EF_CONSTRUCTION parameter.

getEfRuntime() - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties.HnswProperties

Returns the EF_RUNTIME parameter.

getElicitationSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.elicitation.AsyncMcpElicitationProvider

Get the elicitation specifications.

getElicitationSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.elicitation.SyncMcpElicitationProvider

Get the elicitation specifications.

getEmbedding() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties

getEmbeddingColumnName() - Method in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreProperties

getEmbeddingContent(Document) - Method in interface org.springframework.ai.embedding.EmbeddingModel

Extracts the text content from a Document to be used for embedding.

getEmbeddingContent(Document) - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingModel

getEmbeddingContent(Document) - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel

getEmbeddingContent(Document) - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingModel

getEmbeddingContent(Document) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

getEmbeddingDimension() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

getEmbeddingDimension() - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

getEmbeddingDimension() - Method in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseVectorStoreProperties

getEmbeddingFieldName() - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

getEmbeddingFieldName() - Method in class org.springframework.ai.vectorstore.elasticsearch.autoconfigure.ElasticsearchVectorStoreProperties

getEmbeddingFieldName() - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStoreOptions

getEmbeddingFieldName() - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

getEmbeddingFieldName() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

getEmbeddingFieldName() - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

getEmbeddingModel() - Method in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

getEmbeddingProperty() - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

GetEmbeddingResponse(List<String>, List<float[]>, List<String>, List<Map<String, String>>) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingResponse

Creates an instance of a GetEmbeddingResponse record class.

getEmbeddings(String, String, String, ChromaApi.GetEmbeddingsRequest) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

GetEmbeddingsRequest(List<String>) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingsRequest

GetEmbeddingsRequest(List<String>, Map<String, Object>, Integer, Integer, List<ChromaApi.QueryRequest.Include>) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingsRequest

Creates an instance of a GetEmbeddingsRequest record class.

GetEmbeddingsRequest(List<String>, Map<String, Object>) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingsRequest

GetEmbeddingsRequest(List<String>, Map<String, Object>, Integer, Integer) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingsRequest

getEnableLogging() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getEnableLogging() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getEnableLogging() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getEncodingFormat() - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingOptions

getEncodingFormat() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties

getEncodingFormat() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getEncodingFormat() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

getEncodingFormat() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getEncodingFormat() - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions

getEndBlockIndex() - Method in class org.springframework.ai.anthropic.Citation

getEndCharIndex() - Method in class org.springframework.ai.anthropic.Citation

getEndPageNumber() - Method in class org.springframework.ai.anthropic.Citation

getEndpointName(String) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails

getEnhancedPrompt() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageGenerationMetadata

getEntity() - Method in record class org.springframework.ai.chat.client.ResponseEntity

getEnvironment() - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

getEvalDuration() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

getEvents(String) - Method in interface org.springframework.ai.session.SessionService

Every event of the log, oldest first.

getEvents(String, EventFilter) - Method in class org.springframework.ai.session.DefaultSessionService

getEvents(String, EventFilter) - Method in interface org.springframework.ai.session.SessionService

The events the filter selects, oldest first; see EventFilter.

getEventVersion(String) - Method in class org.springframework.ai.session.InMemorySessionRepository

getEventVersion(String) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository

getEventVersion(String) - Method in interface org.springframework.ai.session.SessionRepository

The version of the session's log, advanced on every SessionRepository.appendEvent(org.springframework.ai.session.SessionEvent) that appends a new event and on every successful SessionRepository.appendEvents(java.lang.String, java.util.List<org.springframework.ai.session.SessionEvent>, long); 0 for a session that does not exist or has no events.

getEviction() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

getExcludedEmbedMetadataKeys() - Method in class org.springframework.ai.document.DefaultContentFormatter

getExcludedInferenceMetadataKeys() - Method in class org.springframework.ai.document.DefaultContentFormatter

getExcludedTools() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Limits

getExcludeOnHttpCodes() - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties

getExpireTime() - Method in class org.springframework.ai.google.genai.cache.CachedContentRequest

getExpireTime() - Method in class org.springframework.ai.google.genai.cache.CachedContentUpdateRequest

getExpireTime() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

getExtraBody() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getExtraBody() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getExtraBody() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

getExtraBody() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getExtraBody() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getExtraBody() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getExtraBody() - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions

getExtraBody() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

Extra request body properties, for OpenAI-compatible providers and for API fields that are not modelled here.

getF16KV() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getF16KV() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getF16KV() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getF16KV() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getFallback() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Resolution

getFeedback() - Method in class org.springframework.ai.evaluation.EvaluationResponse

getFieldName() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

getFields() - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

getFields() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.CreateRequest

getFields() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

getFileSearch() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools

getFilterExpression() - Method in class org.springframework.ai.vectorstore.SearchRequest

getFilterField() - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

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

getFinishReason() - Method in class org.springframework.ai.stabilityai.StabilityAiImageGenerationMetadata

getFixedThreadPoolExecutorSize() - Method in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreProperties

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.chat.client.observation.ChatClientObservationContext

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

getFormat() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getFormat() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

The output format maps to audioEncoding.

getFormat() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getFormat() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getFormat() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getFormat() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getFormat() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getFormat() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions

getFormatAsString(MimeType) - Static method in class org.springframework.ai.bedrock.converse.api.BedrockMediaFormat

getFormattedContent() - Method in class org.springframework.ai.document.Document

Returns the formatted content of this document using MetadataMode.ALL, including both text and all metadata entries.

getFormattedContent(ContentFormatter, MetadataMode) - Method in class org.springframework.ai.document.Document

Helper content extractor that uses and external ContentFormatter.

getFormattedContent(MetadataMode) - Method in class org.springframework.ai.document.Document

Returns the formatted content of this document using the given MetadataMode.

getFrequencyPenalty() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getFrequencyPenalty() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

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.deepseek.DeepSeekChatOptions

getFrequencyPenalty() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getFrequencyPenalty() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

getFrequencyPenalty() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getFrequencyPenalty() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

getFrequencyPenalty() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getFrequencyPenalty() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

getFrequencyPenalty() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getFrequencyPenalty() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getFrequencyPenalty() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getFrequencyPenalty() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

getFrequencyPenalty() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

getFrequencyPenalty() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getFrequencyPenalty() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getFrequencyPenalty() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getFrequencyPenalty() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getFrequencyPenalty() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getFrequencyPenalty() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getFrequencyPenalty() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getFrequencyPenalty() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getFunction() - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool

getFunction() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool

getFunctionArgumentClass(Class<? extends Function<?, ?>>, 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<? extends Function<?, ?>>) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper

Returns the input class of a given function class.

getFunctionOutputClass(Class<? extends Function<?, ?>>) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper

Returns the output class of a given function class.

getGcsUri() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageGenerationMetadata

getGenAiClient() - Method in class org.springframework.ai.google.genai.embedding.GoogleGenAiEmbeddingConnectionDetails

getGenAiClient() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageConnectionDetails

getGenAiClient() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionConnectionDetails

getGenAiClient() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechConnectionDetails

getGitHubModels() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getGoogleSearchRetrieval() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getGoogleSearchRetrieval() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getGoogleSearchRetrieval() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getGpuDeviceId() - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Onnx

getGrammarFileName() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

getGrammarFileName() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

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

getHeaders() - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

getHealth() - Method in class org.springframework.ai.moderation.CategoryScores

getHeight() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

Image height is not directly configurable Use GoogleGenAiImageOptions.getAspectRatio() or GoogleGenAiImageOptions.getImageSize() instead.

getHeight() - Method in interface org.springframework.ai.image.ImageOptions

getHeight() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

getHeight() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getHeight() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

getHeight() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getHeight() - Method in class org.springframework.ai.openai.OpenAiImageOptions

getHeight() - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

getHighCardinalityKeyValues(TranscriptionModelObservationContext) - Method in class org.springframework.ai.audio.transcription.observation.DefaultTranscriptionModelObservationConvention

getHighCardinalityKeyValues(TextToSpeechModelObservationContext) - Method in class org.springframework.ai.audio.tts.observation.DefaultTextToSpeechModelObservationConvention

getHighCardinalityKeyValues(AdvisorObservationContext) - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention

getHighCardinalityKeyValues(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

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

getHighCardinalityKeyValues(VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

getHnsw() - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties

Returns the HNSW properties.

getHost() - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getHost() - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

getHost() - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaApiProperties

getHost() - Method in interface org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaConnectionDetails

getHost() - Method in interface org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireConnectionDetails

getHost() - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

getHost() - Method in interface org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientConnectionDetails

getHost() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getHost() - Method in interface org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantConnectionDetails

getHost() - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

getHost() - Method in interface org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseConnectionDetails

getHost() - Method in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseServiceClientProperties

getHost() - Method in interface org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateConnectionDetails

getHost() - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

getHost(String) - Method in interface org.springframework.ai.vectorstore.opensearch.autoconfigure.AwsOpenSearchConnectionDetails

getHostedTools() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getHostedTools() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

Tools OpenAI runs server-side within the request.

getHttpHeaders() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getHttpHeaders() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getHttpHeaders() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

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.content.Media

Get the media id

getId() - Method in class org.springframework.ai.document.Document

Returns the unique identifier for this document.

getId() - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions

getId() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

getId() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getId() - Method in class org.springframework.ai.moderation.Moderation

getId() - Method in class org.springframework.ai.session.SessionEvent

The identity of the event, unique across sessions.

getIdFieldName() - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

getIdFieldName() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

getIdleTimeoutMs() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getIdProperty() - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

getIdType() - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

getImageFormat(MimeType) - Static method in class org.springframework.ai.bedrock.converse.api.BedrockMediaFormat

getImageGeneration() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools

getImageLimit() - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions

getImageLimit() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

getImageLimit() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getImageMinSize() - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions

getImageMinSize() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

getImageMinSize() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getImageSize() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getImageSize() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

getInclude() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getInclude() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

Extra fields to include in the response, e.g.

getIncludeExtendedUsageMetadata() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getIncludeExtendedUsageMetadata() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getIncludeExtendedUsageMetadata() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getIncludeImageBase64() - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions

getIncludeImageBase64() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

getIncludeImageBase64() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getIncludeServerSideToolInvocations() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getIncludeServerSideToolInvocations() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getIncludeServerSideToolInvocations() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getIncludeThoughts() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getIncludeThoughts() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getIncludeThoughts() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getIndex() - Method in class org.springframework.ai.embedding.Embedding

getIndex() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

getIndexedAttributes() - Method in class org.springframework.ai.model.session.jdbc.autoconfigure.JdbcSessionRepositoryProperties

getIndexedAttributes() - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository

The metadata keys this repository indexes; see JdbcSessionRepository.findByMetadata(java.lang.String, java.lang.String).

getIndexName() - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig

Deprecated.

getIndexName() - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

Gets the index name used by this RedisChatMemory instance.

getIndexName() - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getIndexName() - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

getIndexName() - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

getIndexName() - Method in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreProperties

getIndexName() - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

getIndexName() - Method in class org.springframework.ai.vectorstore.elasticsearch.autoconfigure.ElasticsearchVectorStoreProperties

getIndexName() - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStoreOptions

getIndexName() - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

getIndexName() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.CreateRequest

getIndexName() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

getIndexName() - Method in class org.springframework.ai.vectorstore.mongodb.autoconfigure.MongoDBAtlasVectorStoreProperties

getIndexName() - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

getIndexName() - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

getIndexName() - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

getIndexName() - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties

Returns the index name.

getIndexName() - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure.RedisSemanticCacheProperties

getIndexName() - Method in class org.springframework.ai.vectorstore.s3.autoconfigure.S3VectorStoreProperties

getIndexParameters() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

getIndexType() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

getIndexType() - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

getIndexType() - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

getInferenceGeo() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getInferenceGeo() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getInferenceGeo() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getInitialInterval() - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties.Backoff

getInitializeSchema() - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getInitializeSchema() - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

getInput() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

getInput() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getInput() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions

getInputTokensLimit() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

Returns the maximum number of input tokens allowed within the rate-limit window.

getInputTokensRemaining() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

Returns the number of input tokens remaining within the current rate-limit window.

getInputTokensReset() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

Returns the duration until the input-token rate-limit window resets.

getInputType() - Method in class org.springframework.ai.bedrock.cohere.BedrockCohereEmbeddingOptions

getInputType() - Method in class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingOptions

getInputType() - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties

getInputType() - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getInputType() - Method in class org.springframework.ai.model.bedrock.titan.autoconfigure.BedrockTitanEmbeddingProperties

getInsertMessageSql() - Method in interface org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepositoryDialect

Deprecated.

Returns the SQL to insert a message.

getInsertMessageSql() - Method in class org.springframework.ai.chat.memory.repository.jdbc.MysqlChatMemoryRepositoryDialect

Deprecated.

getInsertMessageSql() - Method in class org.springframework.ai.chat.memory.repository.jdbc.OracleChatMemoryRepositoryDialect

Deprecated.

getInsertMessageSql() - Method in class org.springframework.ai.chat.memory.repository.jdbc.PostgresChatMemoryRepositoryDialect

Deprecated.

getInsertMessageSql() - Method in class org.springframework.ai.chat.memory.repository.jdbc.SqlServerChatMemoryRepositoryDialect

Deprecated.

getInsertSessionIfAbsentSql() - Method in interface org.springframework.ai.session.jdbc.JdbcSessionRepositoryDialect

Inserts a row into AI_SESSION only if its id does not exist, with the same four parameters as JdbcSessionRepositoryDialect.getUpsertSessionSql(): one row updated on insert, zero rows or a duplicate-key error when the id exists.

getInsertSessionIfAbsentSql() - Method in class org.springframework.ai.session.jdbc.PostgresJdbcSessionRepositoryDialect

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 class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

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.model.openai.autoconfigure.OpenAiAudioSpeechProperties

getInstructions() - Method in class org.springframework.ai.moderation.ModerationPrompt

getInstructions() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions

getJailbreaking() - Method in class org.springframework.ai.moderation.CategoryScores

getJedisClient() - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig

Deprecated.

getJedisClient() - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

getJsonMapper() - Method in class org.springframework.ai.converter.BeanOutputConverter

Configures and returns a JSON mapper for JSON operations.

getJsonMapper() - Method in class org.springframework.ai.mcp.annotation.provider.tool.AbstractMcpToolProvider

getJsonMapper() - Static method in class org.springframework.ai.util.json.JsonParser

Deprecated, for removal: This API element is subject to removal in a future version.

Use JacksonUtils.getDefaultJsonMapper() instead

getJsonSchema() - Method in class org.springframework.ai.converter.BeanOutputConverter

Provides the generated JSON schema for the target type.

getJsonSchema() - Method in interface org.springframework.ai.converter.StructuredOutputConverter

Returns the JSON schema for the structured output of an LLM call.

getJsonSchema() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

getJsonSchema() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool.Function

getJsonSchema() - Method in class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat

getJsonSchema(Type) - Static method in class org.springframework.ai.util.json.schema.JsonSchemaUtils

Generates JSON Schema (version 2020_12) for the given class.

getJsonSchemaMap() - Method in class org.springframework.ai.converter.BeanOutputConverter

getKeepAlive() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getKeepAlive() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getKeepAlive() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties

getKeepAlive() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getKeepAlive() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getKeepAlive() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getKeepAliveInterval() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerSseProperties

Deprecated.

getKeepAliveInterval() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerStreamableHttpProperties

getKeepAliveTimeMs() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getKeepAliveTimeoutMs() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getKey() - Method in enum class org.springframework.ai.chat.client.ChatClientAttributes

getKeyPrefix() - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig

Deprecated.

getKeyPrefix() - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getKeyPrefix() - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

getKeyspace() - Method in class org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure.CassandraChatMemoryRepositoryProperties

Deprecated.

getKeyspace() - Method in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreProperties

getKeyToken() - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaApiProperties

getKeyToken() - Method in interface org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaConnectionDetails

getKnowledgeBaseId() - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreProperties

getKnowledgeBaseId() - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore

Returns the Knowledge Base ID this store is configured to query.

getKnownSpeakerNames() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

Speaker identifiers (up to 4), positionally matching OpenAiAudioTranscriptionProperties.getKnownSpeakerReferences().

getKnownSpeakerNames() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

Speaker identifiers (up to 4) matching, positionally, the audio samples in OpenAiAudioTranscriptionOptions.getKnownSpeakerReferences().

getKnownSpeakerReferences() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

Audio samples (as data URLs) containing known speaker references, positionally matching OpenAiAudioTranscriptionProperties.getKnownSpeakerNames().

getKnownSpeakerReferences() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

Audio samples (as data URLs, e.g.

getKwargs() - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

getKwargs() - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getKwargs() - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions

getLabel() - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

getLabels() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getLabels() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getLabels() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getLabels() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getLabels() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

getLanguage() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

getLanguage() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

getLanguage() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

getLanguage() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getLanguage() - Method in class org.springframework.ai.openai.metadata.OpenAiAudioTranscriptionResponseMetadata

Returns the detected input language, or null if not returned by the API.

getLanguage() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

getLanguageCode() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getLanguageCode() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

getLanguageCode() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getLanguageCode() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getLanguageCode() - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

getLastPunctuationIndex(String) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter

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

getLimit() - Method in exception org.springframework.ai.model.tool.ToolCallLimitExceededException

The configured limit that was exceeded.

getLimits() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties

getLoadDuration() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

getLocation() - Method in class org.springframework.ai.google.genai.embedding.GoogleGenAiEmbeddingConnectionDetails

getLocation() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageConnectionDetails

getLocation() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechConnectionDetails

The Vertex AI location.

getLocation() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiConnectionProperties

getLocation() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiEmbeddingConnectionProperties

getLocation() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageConnectionProperties

getLocation() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionConnectionProperties

getLocation() - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechConnectionProperties

getLocation() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiEmbeddingConnectionProperties

getLocation() - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails

getLocationDescription() - Method in class org.springframework.ai.anthropic.Citation

Get a human-readable location description.

getLoggingSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.logging.AsyncMcpLoggingProvider

Get the list of logging consumer callbacks.

getLoggingSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.logging.SyncMcpLoggingProvider

Get the list of logging consumer callbacks.

getLoggingSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.logging.SyncMcpLogginProvider

Deprecated.

Get the list of logging consumer callbacks.

getLogitBias() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getLogitBias() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getLogitBias() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the logit bias map.

getLogitsAll() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getLogitsAll() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getLogitsAll() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getLogitsAll() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getLogprobs() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions

getLogprobs() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

getLogprobs() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getLogprobs() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getLogprobs() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getLogprobs() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets whether to return log probabilities.

getLowCardinalityKeyValues(TranscriptionModelObservationContext) - Method in class org.springframework.ai.audio.transcription.observation.DefaultTranscriptionModelObservationConvention

getLowCardinalityKeyValues(TextToSpeechModelObservationContext) - Method in class org.springframework.ai.audio.tts.observation.DefaultTextToSpeechModelObservationConvention

getLowCardinalityKeyValues(AdvisorObservationContext) - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention

getLowCardinalityKeyValues(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

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

getLowCardinalityKeyValues(VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

getLowVRAM() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getLowVRAM() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getLowVRAM() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getLowVRAM() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getLruMaxSessions() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties.Eviction

getLucene() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

getM() - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties.HnswProperties

Returns the M parameter.

getMainGPU() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getMainGPU() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMainGPU() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getMainGPU() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getMappingJson() - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

getMatchOutcome(ConditionContext, AnnotatedTypeMetadata) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.CachedContentServiceCondition

getMatchOutcome(ConditionContext, AnnotatedTypeMetadata) - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchNonAwsCondition

getMaxAttempts() - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties

getMaxCallsPerTool() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Limits

getMaxCallsPerToolDefault() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Limits

getMaxCompletionTokens() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getMaxCompletionTokens() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMaxCompletionTokens() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the maximum number of completion tokens.

getMaxConnections() - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

getMaxConnections() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.CreateRequest

getMaxConnections() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

getMaxConversationIds() - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig

Deprecated.

Gets the maximum number of conversation IDs to return.

getMaxConversationIds() - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getMaxConversationIds() - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

getMaxDocumentBatchSize() - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

getMaxDocumentBatchSize() - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

getMaxInterval() - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties.Backoff

getMaxMessagesPerConversation() - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig

Deprecated.

Gets the maximum number of messages to return per conversation.

getMaxMessagesPerConversation() - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getMaxMessagesPerConversation() - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

getMaxNumResults() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.FileSearch

getMaxOutputTokens() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getMaxOutputTokens() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getMaxOutputTokens() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

getMaxOutputTokens() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getMaxOutputTokens() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMaxOutputTokens() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

getMaxOutputTokens() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

getMaxOutputTokens() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getMaxOutputTokens() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

Maximum number of tokens the model may generate, max_output_tokens on the wire.

getMaxResults() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

getMaxRetries() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getMaxRetries() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicConnectionProperties

getMaxRetries() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties

getMaxRetries() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

getMaxRetries() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMaxRetries() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions

getMaxRetries() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getMaxRetries() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getMaxTokens() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getMaxTokens() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

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.deepseek.DeepSeekChatOptions

getMaxTokens() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getMaxTokens() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getMaxTokens() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getMaxTokens() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMaxTokens() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

getMaxTokens() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMaxTokens() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

getMaxTokens() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMaxTokens() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

getMaxTokens() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMaxTokens() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getMaxTokens() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMaxTokens() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getMaxTokens() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getMaxTokens() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getMaxToolCalls() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getMaxToolCalls() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getMaxTotalToolCalls() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Limits

getMaxTurns() - Method in class org.springframework.ai.session.compaction.TurnCountTrigger

getMaxUses() - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool

getMcpEndpoint() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerStreamableHttpProperties

getMcpExchange(ToolContext) - Static method in class org.springframework.ai.mcp.McpToolUtils

Retrieves the MCP exchange object from the provided tool context if it exists.

getMedia() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

getMedia() - Method in class org.springframework.ai.chat.messages.AssistantMessage

getMedia() - Method in class org.springframework.ai.chat.messages.UserMessage

getMedia() - Method in interface org.springframework.ai.content.MediaContent

Get the media associated with the content.

getMedia() - Method in class org.springframework.ai.document.Document

Returns the document's media content, if any.

getMedia() - Method in class org.springframework.ai.image.ImageMessage

getMediaLabel() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

getMediaLabel() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig

Deprecated.

getMediaLabel() - Method in class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryProperties

Deprecated.

getMessage() - Method in class org.springframework.ai.session.SessionEvent

The wrapped Spring AI message.

getMessageConverter() - Method in class org.springframework.ai.converter.AbstractMessageOutputConverter

Return the message converter used by this output converter.

getMessageLabel() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

getMessageLabel() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig

Deprecated.

getMessageLabel() - Method in class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryProperties

Deprecated.

getMessages() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

getMessages(String) - Method in interface org.springframework.ai.session.SessionService

The messages of the whole log, the events a compaction covered and the summaries included: the full history, not a prompt.

getMessagesColumn() - Method in class org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure.CassandraChatMemoryRepositoryProperties

Deprecated.

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.

getMessageType() - Method in class org.springframework.ai.session.SessionEvent

The type of the wrapped message.

getMessageTypeMinContentLengths() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions

getMessageTypeMinContentLengths() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicCacheProperties

getMessageTypeTtl() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions

getMessageTypeTtl() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicCacheProperties

getMeta() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMetaProvider

Returns null to indicate that no "_meta" field should be included in.

getMeta() - Method in interface org.springframework.ai.mcp.annotation.context.MetaProvider

Returns metadata key-value pairs that will be included in the "_meta" field.

getMeta(Class<? extends MetaProvider>) - Static method in class org.springframework.ai.mcp.annotation.common.MetaUtils

Instantiate the supplied MetaProvider type using a no-argument constructor and return the metadata it supplies.

getMetadata() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

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 interface org.springframework.ai.content.Content

Get the metadata associated with the content.

getMetadata() - Method in class org.springframework.ai.document.Document

Returns the metadata associated with this document.

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.evaluation.EvaluationResponse

getMetadata() - Method in class org.springframework.ai.image.ImageGeneration

getMetadata() - Method in class org.springframework.ai.image.ImageMessage

getMetadata() - Method in class org.springframework.ai.image.ImageResponse

getMetadata() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getMetadata() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

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.model.openai.autoconfigure.OpenAiChatProperties

getMetadata() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMetadata() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getMetadata() - Method in class org.springframework.ai.moderation.Generation

getMetadata() - Method in class org.springframework.ai.moderation.ModerationResponse

getMetadata() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the metadata map.

getMetadata() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getMetadata() - Method in class org.springframework.ai.session.SessionEvent

Framework flags such as SessionEvent.METADATA_SYNTHETIC and SessionEvent.METADATA_COMPACTION_SOURCE, and whatever the application adds.

getMetadataFieldName() - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

getMetadataFieldName() - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

getMetadataFieldName() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

getMetadataFieldName() - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

getMetadataFields() - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig

Deprecated.

Gets the metadata field definitions.

getMetadataFields() - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getMetadataFields() - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

getMetadataFieldsToFilter() - Method in class org.springframework.ai.vectorstore.mongodb.autoconfigure.MongoDBAtlasVectorStoreProperties

getMetadataLabel() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

getMetadataLabel() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig

Deprecated.

getMetadataLabel() - Method in class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryProperties

Deprecated.

getMetadataMode() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties

getMetadataMode() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

getMetadataMode() - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

getMetadataMode() - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMetadataMode() - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties

getMetadataMode() - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions

getMetadataSeparator() - Method in class org.springframework.ai.document.DefaultContentFormatter

getMetadataTemplate() - Method in class org.springframework.ai.document.DefaultContentFormatter

getMetaFieldPrefix() - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

getMetaFieldPrefix() - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStoreOptions

getMethod() - Method in class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting

getMetricType() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

getMicrosoftDeploymentName() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

getMicrosoftDeploymentName() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMicrosoftDeploymentName() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions

getMicrosoftDeploymentName() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getMicrosoftDeploymentName() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getMicrosoftFoundry() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMicrosoftFoundryServiceVersion() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

getMicrosoftFoundryServiceVersion() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMicrosoftFoundryServiceVersion() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions

getMicrosoftFoundryServiceVersion() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getMicrosoftFoundryServiceVersion() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getMimeType() - Method in class org.springframework.ai.content.Media

Get the media MIME type

getMimeType() - Method in class org.springframework.ai.embedding.EmbeddingResultMetadata

getMimeType() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageGenerationMetadata

getMimeType(File) - Static method in class org.springframework.ai.google.genai.MimeTypeDetector

getMimeType(String) - Static method in class org.springframework.ai.google.genai.MimeTypeDetector

getMimeType(URI) - Static method in class org.springframework.ai.google.genai.MimeTypeDetector

getMimeType(URL) - Static method in class org.springframework.ai.google.genai.MimeTypeDetector

getMimeType(Path) - Static method in class org.springframework.ai.google.genai.MimeTypeDetector

getMimeType(Resource) - Static method in class org.springframework.ai.google.genai.MimeTypeDetector

getMinP() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getMinP() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMinP() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getMinScoreThreshold() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties.Lucene

getMirostat() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getMirostat() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMirostat() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getMirostatEta() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getMirostatEta() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMirostatEta() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getMirostatTau() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getMirostatTau() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getMirostatTau() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getModality() - Method in class org.springframework.ai.google.genai.metadata.GoogleGenAiModalityTokenCount

Returns the modality type.

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.

getMode() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.ToolChoiceProperties

getModel() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

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.bedrock.cohere.BedrockCohereEmbeddingOptions

getModel() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

getModel() - Method in class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingOptions

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.deepseek.DeepSeekChatOptions

getModel() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

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 class org.springframework.ai.google.genai.cache.CachedContentRequest

getModel() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

getModel() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getModel() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getModel() - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions

getModel() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

getModel() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

getModel() - Method in interface org.springframework.ai.image.ImageOptions

getModel() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getModel() - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingOptions

getModel() - Method in class org.springframework.ai.mistralai.moderation.MistralAiModerationOptions

getModel() - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions

getModel() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getModel() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties

getModel() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

getModel() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.bedrock.titan.autoconfigure.BedrockTitanEmbeddingProperties

getModel() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

getModel() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getModel() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getModel() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties

getModel() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

getModel() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

getModel() - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

getModel() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

getModel() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties

getModel() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiModerationProperties

getModel() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiModerationProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

getModel() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getModel() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties

getModel() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

getModel() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

getModel() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

getModel() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getModel() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

getModel() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

getModel() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiModerationProperties

getModel() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiModerationProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.ImageGeneration

getModel() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

getModel() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultimodalEmbeddingProperties

getModel() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultimodalEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties

getModel() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModel() - Method in class org.springframework.ai.moderation.Moderation

getModel() - Method in interface org.springframework.ai.moderation.ModerationOptions

getModel() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getModel() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getModel() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions

getModel() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

getModel() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getModel() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getModel() - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions

getModel() - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

getModel() - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions

getModel() - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions

getModelEndpointName(String) - Method in class org.springframework.ai.google.genai.embedding.GoogleGenAiEmbeddingConnectionDetails

Constructs the model endpoint name in the format expected by the embedding models.

getModelEndpointName(String) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageConnectionDetails

Constructs the model endpoint name in the format expected by the image models.

getModelId() - Method in class org.springframework.ai.bedrock.api.AbstractBedrockApi

Get the model id.

getModelId() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getModelId() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getModelId() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getModelOutputName() - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Onnx

getModelUri() - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Onnx

getModelVersion() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionMetadata

Returns the name of the model that generated the transcription, if available.

getModeNames() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

getMultiBlockSystemCaching() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicCacheProperties

getMultiplier() - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties.Backoff

getMultiSpeakerTurns() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

getMultiSpeakerTurns() - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

getN() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getN() - Method in interface org.springframework.ai.image.ImageOptions

getN() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getN() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

getN() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

getN() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getN() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getN() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getN() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

getN() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getN() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

getN() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getN() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the number of completions to generate.

getN() - Method in class org.springframework.ai.openai.OpenAiImageOptions

getN() - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

getName() - Method in class org.springframework.ai.audio.transcription.observation.DefaultTranscriptionModelObservationConvention

getName() - Method in class org.springframework.ai.audio.tts.observation.DefaultTextToSpeechModelObservationConvention

getName() - Method in interface org.springframework.ai.chat.client.advisor.api.Advisor

Return the name of the advisor.

getName() - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor

getName() - Method in class org.springframework.ai.chat.client.advisor.ChatModelCallAdvisor

getName() - Method in class org.springframework.ai.chat.client.advisor.ChatModelStreamAdvisor

getName() - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention

getName() - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor

getName() - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

getName() - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor

getName() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

getName() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor

getName() - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

getName() - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention

getName() - Method in class org.springframework.ai.content.Media

Get the media name.

getName() - Method in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatModel

getName() - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool.Function

getName() - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention

getName() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

getName() - Method in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

getName() - Method in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageModelName

getName() - Method in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModelName

getName() - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention

getName() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

getName() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

getName() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema

getName() - Method in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatModel

getName() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool.Function

getName() - Method in class org.springframework.ai.model.bedrock.autoconfigure.ProfileProperties

getName() - Method in interface org.springframework.ai.model.ModelDescription

Returns the name of the model.

getName() - Method in enum class org.springframework.ai.ollama.api.OllamaModel

getName() - Method in class org.springframework.ai.session.advisor.SessionTurnAdvisor

getName() - Method in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention

getName() - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore

getName() - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

getName() - Method in interface org.springframework.ai.vectorstore.VectorStore

getName() - Method in enum class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingModelName

getName() - Method in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModelName

getNamespace() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

getNamespace() - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

getNativeClient() - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.s3.S3VectorStore

getNativeClient() - Method in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

getNativeClient() - Method in interface org.springframework.ai.vectorstore.VectorStore

Returns the native client if available in this vector store implementation.

getNativeClient() - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore

getNativeExpression() - Method in class org.springframework.ai.vectorstore.milvus.MilvusSearchRequest

Retrieves the native Milvus filter expression.

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

getNativeUsage() - Method in class org.springframework.ai.openai.metadata.OpenAiAudioTranscriptionResponseMetadata

Returns the provider-native usage object for this transcription, or null if not returned by the API.

getNextPageToken() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService.CachedContentPage

getNextRequestIds() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getNextRequestIds() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getNextRequestIds() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getNextText() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getNextText() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getNextText() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getNumBatch() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getNumBatch() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getNumBatch() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getNumBatch() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getNumCtx() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getNumCtx() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getNumCtx() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getNumCtx() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getNumGPU() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getNumGPU() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getNumGPU() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getNumGPU() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getNumKeep() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getNumKeep() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getNumKeep() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getNumPredict() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getNumPredict() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getNumPredict() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getNumThread() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getNumThread() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getNumThread() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getNumThread() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getObjectClass() - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

getObjectClass() - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStoreOptions

getObservationRegistry() - Method in interface org.springframework.ai.chat.client.advisor.api.AdvisorChain

getObservationRegistry() - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain

getObservationRegistry() - Method in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

getObservations() - Method in class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties

getObservations() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties

getOkHttpClient() - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient

getOnHttpCodes() - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties

getOnLimitExceeded() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Limits

getOnnx() - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties

getOperationMetadata() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext

getOperationMetadata() - Method in class org.springframework.ai.model.observation.ModelObservationContext

getOperationMetadata() - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext

getOperationName() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

getOperationType() - Method in class org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationContext

getOperationType() - Method in class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationContext

getOperationType() - Method in class org.springframework.ai.image.observation.ImageModelObservationContext

getOptimization() - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

getOptions() - Method in class org.springframework.ai.anthropic.AnthropicChatModel

Gets the chat options for this model.

getOptions() - Method in class org.springframework.ai.audio.transcription.AudioTranscriptionPrompt

getOptions() - Method in interface org.springframework.ai.audio.tts.TextToSpeechModel

Gets the options for this model.

getOptions() - Method in class org.springframework.ai.audio.tts.TextToSpeechPrompt

getOptions() - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel

getOptions() - Method in interface org.springframework.ai.chat.model.ChatModel

Gets the chat options for this model.

getOptions() - Method in class org.springframework.ai.chat.prompt.Prompt

getOptions() - Method in class org.springframework.ai.deepseek.DeepSeekChatModel

getOptions() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel

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.google.genai.GoogleGenAiChatModel

getOptions() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechModel

getOptions() - Method in class org.springframework.ai.image.ImagePrompt

getOptions() - Method in class org.springframework.ai.mistralai.MistralAiChatModel

getOptions() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiModerationProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in interface org.springframework.ai.model.ModelRequest

Retrieves the customizable options for AI model interactions.

getOptions() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiModerationProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Tokenizer

getOptions() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultimodalEmbeddingProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getOptions() - Method in class org.springframework.ai.moderation.ModerationPrompt

getOptions() - Method in class org.springframework.ai.ollama.OllamaChatModel

getOptions() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel

getOptions() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel

Gets the transcription options for this model.

getOptions() - Method in class org.springframework.ai.openai.OpenAiChatModel

Gets the chat options for this model.

getOptions() - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel

Gets the embedding options for this model.

getOptions() - Method in class org.springframework.ai.openai.OpenAiImageModel

Gets the image options for this model.

getOptions() - Method in class org.springframework.ai.openai.OpenAiModerationModel

getOptions() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatModel

getOptions() - Method in class org.springframework.ai.stabilityai.StabilityAiImageModel

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<T>) - 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

getOrder() - Method in class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor

getOrder() - Method in class org.springframework.ai.chat.client.advisor.ChatModelCallAdvisor

getOrder() - Method in class org.springframework.ai.chat.client.advisor.ChatModelStreamAdvisor

getOrder() - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor

Deprecated.

getOrder() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext

getOrder() - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor

getOrder() - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

getOrder() - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor

getOrder() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

getOrder() - Method in class org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor

getOrder() - Method in class org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor

getOrder() - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor

getOrder() - Method in class org.springframework.ai.session.advisor.SessionMemoryAdvisor

getOrder() - Method in class org.springframework.ai.session.advisor.SessionTurnAdvisor

getOrder() - Method in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallingAdvisorAutoRegistrationIT.ChainIterationCountingAdvisor

getOrganizationId() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

getOrganizationId() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getOrganizationId() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions

getOrganizationId() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getOrganizationId() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getOriginalToolName() - Method in class org.springframework.ai.mcp.AsyncMcpToolCallback

getOriginalToolName() - Method in class org.springframework.ai.mcp.SyncMcpToolCallback

Returns the original MCP tool name without prefixing.

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

getOutputAudio() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getOutputAudio() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getOutputAudio() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the output audio parameters.

getOutputCompressionQuality() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getOutputCompressionQuality() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

getOutputConfig() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getOutputConfig() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getOutputConfig() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getOutputDimensionality() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultimodalEmbeddingProperties

getOutputDimensionality() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultimodalEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getOutputDimensionality() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties

getOutputDimensionality() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getOutputFormat() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getOutputFormat() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getOutputFormat() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getOutputMimeType() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getOutputMimeType() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

getOutputModalities() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getOutputModalities() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getOutputModalities() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the output modalities.

getOutputSchema() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getOutputSchema() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

getOutputSchema() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getOutputSchema() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getOutputSchema() - Method in class org.springframework.ai.model.tool.DefaultStructuredOutputChatOptions

getOutputSchema() - Method in interface org.springframework.ai.model.tool.StructuredOutputChatOptions

getOutputSchema() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getOutputSchema() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getOutputSchema() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getOutputTokensLimit() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

Returns the maximum number of output tokens allowed within the rate-limit window.

getOutputTokensRemaining() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

Returns the number of output tokens remaining within the current rate-limit window.

getOutputTokensReset() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

Returns the duration until the output-token rate-limit window resets.

getPages() - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions

getPages() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

getPages() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getParagraphsByLevel(ParagraphManager.Paragraph, int, boolean) - Method in class org.springframework.ai.reader.pdf.config.ParagraphManager

getParallelToolCalls() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getParallelToolCalls() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getParallelToolCalls() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getParallelToolCalls() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets whether to enable parallel tool calls.

getParallelToolCalls() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getParameters() - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool.Function

getParameters() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool.Function

getParams() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec

getPartialToolExecutionResult() - Method in exception org.springframework.ai.model.tool.ToolCallLimitExceededException

The result assembled from the tool calls already executed in the current batch, including a synthesized error response for the call that exceeded the limit.

getPartitionName() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

getParts() - Method in class org.springframework.ai.chat.messages.AbstractMessage

The ordered content parts of this message.

getPassword() - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getPassword() - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

getPassword() - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaApiProperties

getPassword() - Method in interface org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireConnectionDetails

getPassword() - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

getPassword() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getPassword() - Method in interface org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchConnectionDetails

getPassword() - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

getPathName() - Method in class org.springframework.ai.vectorstore.mongodb.autoconfigure.MongoDBAtlasVectorStoreProperties

getPathPrefix() - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

getPayload() - Method in class org.springframework.ai.session.SessionEvent

The data of an event that is not a message, the ids a EventType.COMPACTION boundary names for example; empty for a message event.

getPenalizeNewline() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getPenalizeNewline() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getPenalizeNewline() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getPersonGeneration() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getPersonGeneration() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

getPii() - Method in class org.springframework.ai.moderation.CategoryScores

getPort() - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getPort() - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

getPort() - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaApiProperties

getPort() - Method in interface org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaConnectionDetails

getPort() - Method in interface org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireConnectionDetails

getPort() - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

getPort() - Method in interface org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientConnectionDetails

getPort() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getPort() - Method in interface org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantConnectionDetails

getPort() - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

getPort() - Method in interface org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseConnectionDetails

getPort() - Method in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseServiceClientProperties

getPredictionServiceSettings() - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails

getPredictRequestBuilder(EmbeddingRequest, EndpointName, VertexAiTextEmbeddingOptions) - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModel

getPrefix() - Method in class org.springframework.ai.deepseek.DeepSeekAssistantMessage

Deprecated.

The prefix completion flag, read from the DeepSeekChatModel.PREFIX_METADATA_KEY metadata entry.

getPrefix() - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties

Returns the key prefix.

getPrefix() - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure.RedisSemanticCacheProperties

getPresencePenalty() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getPresencePenalty() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

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.deepseek.DeepSeekChatOptions

getPresencePenalty() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getPresencePenalty() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

getPresencePenalty() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getPresencePenalty() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

getPresencePenalty() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getPresencePenalty() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

getPresencePenalty() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getPresencePenalty() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getPresencePenalty() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getPresencePenalty() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

getPresencePenalty() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

getPresencePenalty() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getPresencePenalty() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getPresencePenalty() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getPresencePenalty() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getPresencePenalty() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getPresencePenalty() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getPresencePenalty() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getPresencePenalty() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getPreviousRequestIds() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getPreviousRequestIds() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getPreviousRequestIds() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getPreviousText() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getPreviousText() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getPreviousText() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getProfile() - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

getProgressSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.progress.AsyncMcpProgressProvider

Get the list of progress specifications.

getProgressSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.progress.SyncMcpProgressProvider

Get the list of progress specifications.

getProjectId() - Method in class org.springframework.ai.google.genai.embedding.GoogleGenAiEmbeddingConnectionDetails

getProjectId() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageConnectionDetails

getProjectId() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechConnectionDetails

The Google Cloud project ID, or null when the Gemini Developer API (API key) is used.

getProjectId() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiConnectionProperties

getProjectId() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiEmbeddingConnectionProperties

getProjectId() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageConnectionProperties

getProjectId() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionConnectionProperties

getProjectId() - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechConnectionProperties

getProjectId() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiEmbeddingConnectionProperties

getProjectId() - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

getProjectId() - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails

getPrompt() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

getPrompt() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

getPrompt() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

getPrompt() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getPrompt() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

getPromptCacheKey() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getPromptCacheKey() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getPromptCacheKey() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getPromptCacheKey() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the prompt cache key.

getPromptCacheKey() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getPromptEvalDuration() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

getPromptIndex() - Method in interface org.springframework.ai.chat.metadata.PromptMetadata.PromptFilterMetadata

Index of the prompt filter metadata contained in the AI response.

getPromptListChangedSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.changed.prompt.AsyncMcpPromptListChangedProvider

Get the list of prompt list changed consumer specifications.

getPromptListChangedSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.changed.prompt.SyncMcpPromptListChangedProvider

Get the list of prompt list changed consumer specifications.

getPromptMetadata() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata

Returns the prompt metadata gathered by the AI during request processing.

getPromptSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.prompt.AsyncMcpPromptProvider

Get the async prompt specifications.

getPromptSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.prompt.AsyncStatelessMcpPromptProvider

Get the async stateless prompt specifications.

getPromptSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.prompt.SyncMcpPromptProvider

getPromptSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.prompt.SyncStatelessMcpPromptProvider

Get the stateless prompt specifications.

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

getPromptTokensDetails() - Method in class org.springframework.ai.google.genai.metadata.GoogleGenAiUsage

Returns the list of modalities that were processed in the request input.

getPronunciationDictionaryLocators() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getPronunciationDictionaryLocators() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getPronunciationDictionaryLocators() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getProtocol() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

getProtocol() - Method in interface org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseConnectionDetails

getProtocol() - Method in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseServiceClientProperties

getProxy() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getProxy() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicConnectionProperties

getProxy() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

getProxy() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getProxy() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions

getProxy() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getProxy() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getPublisher() - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails

getPullModelStrategy() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties

getQuality() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

getQuality() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getQuality() - Method in class org.springframework.ai.openai.OpenAiImageOptions

getQuery() - Method in class org.springframework.ai.vectorstore.SearchRequest

getQueryRequest() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

getQueryResponse() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

getRaiFilteredReason() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageGenerationMetadata

getRandomSeed() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getRandomSeed() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

getRandomSeed() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getRateLimit() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata

Returns AI provider specific metadata on rate limits.

getRateLimit() - Method in class org.springframework.ai.openai.metadata.OpenAiAudioSpeechResponseMetadata

getRawMap() - Method in class org.springframework.ai.model.MutableResponseMetadata

getReactiveReturnTypeArgument(Method) - Static method in class org.springframework.ai.mcp.annotation.method.tool.ReactiveUtils

getReadTimeout() - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

getReasoning() - Method in class org.springframework.ai.chat.messages.AssistantMessage

The reasoning parts of this message, in part order.

getReasoningContent() - Method in class org.springframework.ai.deepseek.DeepSeekAssistantMessage

Deprecated.

The reasoning content: the joined text of the ReasoningParts, unless it was overridden through DeepSeekAssistantMessage.setReasoningContent(String).

getReasoningEffort() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions

getReasoningEffort() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getReasoningEffort() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

getReasoningEffort() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getReasoningEffort() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

getReasoningEffort() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getReasoningEffort() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getReasoningEffort() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getReasoningEffort() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the reasoning effort level.

getReasoningEffort() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

How hard the model should think: none, minimal, low, medium, high, ...

getReasoningSummary() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getReasoningSummary() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

Whether and how to summarize the model's reasoning: auto, concise or detailed.

getRedisName() - Method in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.DistanceMetric

getRedisName() - Method in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.TextScorer

getRegion() - Method in class org.springframework.ai.bedrock.api.AbstractBedrockApi

Get the AWS region.

getRegion() - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

getRegion() - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreProperties

getRegion() - Method in interface org.springframework.ai.vectorstore.opensearch.autoconfigure.AwsOpenSearchConnectionDetails

getRegions() - Method in class org.springframework.ai.reader.pdf.layout.PDFLayoutTextStripperByArea

Get the list of regions that have been setup.

getRemainingTtl() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

Gets the remaining time to live for the cached content.

getRepeatLastN() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getRepeatLastN() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getRepeatLastN() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getRepeatPenalty() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getRepeatPenalty() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getRepeatPenalty() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getReplayReasoningContent() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getReplayReasoningContent() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getReplayReasoningContent() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets whether a previous assistant message's reasoning content is sent back as the reasoning_content property of the next request.

getReplicatedVoice() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

getRequest() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext

getRequest() - Method in class org.springframework.ai.model.observation.ModelObservationContext

getRequestMetadata(Map<String, Object>) - Static method in class org.springframework.ai.bedrock.converse.api.ConverseApiUtils

getRequestParameters() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

Additional Bedrock Converse additionalModelRequestFields, passed through verbatim to the underlying model.

getRequestParameters() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

Additional Bedrock Converse additionalModelRequestFields.

getRequestParameters() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getRequestsLimit() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

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.

getRequestsLimit() - Method in class org.springframework.ai.openai.metadata.OpenAiRateLimit

getRequestsRemaining() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

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.

getRequestsRemaining() - Method in class org.springframework.ai.openai.metadata.OpenAiRateLimit

getRequestsReset() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

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.

getRequestsReset() - Method in class org.springframework.ai.openai.metadata.OpenAiRateLimit

getRequestTimeout() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

getRequestTimeout() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

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.

getRerankingModelArn() - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreProperties

getResolution() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties

getResourceIdentifier(Resource) - Method in class org.springframework.ai.reader.TextReader

getResourceListChangedSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.changed.resource.AsyncMcpResourceListChangedProvider

Get the list of resource list changed consumer specifications.

getResourceListChangedSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.changed.resource.SyncMcpResourceListChangedProvider

Get the list of resource list changed consumer specifications.

getResourceSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.resource.AsyncMcpResourceProvider

Get the async resource specifications.

getResourceSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.resource.AsyncStatelessMcpResourceProvider

Get the async stateless resource specifications.

getResourceSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.resource.SyncMcpResourceProvider

getResourceSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.resource.SyncStatelessMcpResourceProvider

Get the stateless resource specifications.

getResourceTemplateSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.resource.AsyncMcpResourceProvider

getResourceTemplateSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.resource.AsyncStatelessMcpResourceProvider

getResourceTemplateSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.resource.SyncMcpResourceProvider

getResourceTemplateSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.resource.SyncStatelessMcpResourceProvider

getResponse() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext

getResponse() - Method in record class org.springframework.ai.chat.client.ResponseEntity

getResponse() - Method in class org.springframework.ai.model.observation.ModelObservationContext

getResponseContent() - Method in class org.springframework.ai.evaluation.EvaluationRequest

getResponseFormat() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions

getResponseFormat() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getResponseFormat() - Method in interface org.springframework.ai.image.ImageOptions

getResponseFormat() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getResponseFormat() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

getResponseFormat() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getResponseFormat() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

getResponseFormat() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getResponseFormat() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

getResponseFormat() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getResponseFormat() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

getResponseFormat() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getResponseFormat() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getResponseFormat() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getResponseFormat() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

getResponseFormat() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getResponseFormat() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getResponseFormat() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

getResponseFormat() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getResponseFormat() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions

getResponseFormat() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

getResponseFormat() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the response format configuration.

getResponseFormat() - Method in class org.springframework.ai.openai.OpenAiImageOptions

getResponseFormat() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getResponseFormat() - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

getResponseMimeType() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getResponseMimeType() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

getResponseMimeType() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getResponseMimeType() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getResponseMimeType() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

getResponses() - Method in class org.springframework.ai.chat.messages.ToolResponseMessage

The tool responses of this message: the text of each ToolResultPart, in part order.

getResponseSchema() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getResponseSchema() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getResponseSchema() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

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.messages.ToolResponseMessage

The tool results of this message, in part order.

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

getRevisedPrompt() - Method in class org.springframework.ai.openai.metadata.OpenAiImageGenerationMetadata

Gets the revised prompt that was used for image generation.

getRouterFunction() - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider

Deprecated.

Returns the WebFlux router function that defines the transport's HTTP endpoints.

getRouterFunction() - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStatelessServerTransport

Returns the WebFlux router function that defines the transport's HTTP endpoints.

getRouterFunction() - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider

Returns the WebFlux router function that defines the transport's HTTP endpoints.

getRouterFunction() - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider

Deprecated.

Returns the RouterFunction that defines the HTTP endpoints for this transport.

getRouterFunction() - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStatelessServerTransport

Returns the WebMVC router function that defines the transport's HTTP endpoints.

getRouterFunction() - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider

Returns the RouterFunction that defines the HTTP endpoints for this transport.

getRpcDeadlineMs() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getRuleIndex() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.BooleanExpressionContext

getRuleIndex() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareContext

getRuleIndex() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantArrayContext

getRuleIndex() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantContext

getRuleIndex() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IdentifierContext

getRuleIndex() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.WhereContext

getRuleNames() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

getRuleNames() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

getSafePrompt() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getSafePrompt() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

getSafePrompt() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getSafetyFilterLevel() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getSafetyFilterLevel() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

getSafetyIdentifier() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getSafetyIdentifier() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getSafetySettings() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getSafetySettings() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getSafetySettings() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getSampler() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

getSampler() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getSampler() - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

getSamplingSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.sampling.SyncMcpSamplingProvider

Get the sampling handler.

getSamplingSpecifictions() - Method in class org.springframework.ai.mcp.annotation.provider.sampling.AsyncMcpSamplingProvider

Get the sampling handler.

getScheduler() - Method in class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor

getScheduler() - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor

Scheduler used for processing the advisor logic when streaming.

getScheduler() - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor

Deprecated.

getScheduler() - Method in class org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor

getScheduler() - Method in class org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor

getScheduler() - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor

getScheduler() - Method in class org.springframework.ai.session.advisor.SessionMemoryAdvisor

getSchema() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

getSchema() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema

getSchemaName() - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

getSchemaName() - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

getScheme() - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

getScopeName() - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

getScore() - Method in class org.springframework.ai.document.Document

Returns the relevance score associated with this document, if any.

getScore() - Method in class org.springframework.ai.evaluation.EvaluationResponse

getSdkTtl() - Method in enum class org.springframework.ai.anthropic.AnthropicCacheTtl

getSearchAccuracy() - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

getSearchContextSize() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.WebSearch

getSearchParamsJson() - Method in class org.springframework.ai.vectorstore.milvus.MilvusSearchRequest

Retrieves the JSON-encoded search parameters.

getSearchType() - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreProperties

getSecretKey() - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

getSecretKey() - Method in interface org.springframework.ai.vectorstore.opensearch.autoconfigure.AwsOpenSearchConnectionDetails

getSeed() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getSeed() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getSeed() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

getSeed() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getSeed() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getSeed() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

getSeed() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

getSeed() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getSeed() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getSeed() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getSeed() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getSeed() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

getSeed() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getSeed() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getSeed() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the random seed for deterministic generation.

getSeed() - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

getSeed() - Method in class org.springframework.ai.stabilityai.StabilityAiImageGenerationMetadata

getSegments() - Method in class org.springframework.ai.openai.metadata.OpenAiAudioTranscriptionResponseMetadata

Returns the segment-level transcription breakdown, or null if not returned by the API.

getSelectConversationIdsSql() - Method in interface org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepositoryDialect

Deprecated.

Returns the SQL to fetch conversation IDs.

getSelectMessagesSql() - Method in interface org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepositoryDialect

Deprecated.

Returns the SQL to fetch messages for a conversation, ordered by sequence id.

getSelectMessagesSql() - Method in class org.springframework.ai.chat.memory.repository.jdbc.MysqlChatMemoryRepositoryDialect

Deprecated.

getSelectMessagesSql() - Method in class org.springframework.ai.chat.memory.repository.jdbc.OracleChatMemoryRepositoryDialect

Deprecated.

getSelectMessagesSql() - Method in class org.springframework.ai.chat.memory.repository.jdbc.PostgresChatMemoryRepositoryDialect

Deprecated.

getSelectMessagesSql() - Method in class org.springframework.ai.chat.memory.repository.jdbc.SqlServerChatMemoryRepositoryDialect

Deprecated.

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

getSerializedATN() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

getSerializedATN() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

getServerName() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getServerPemPath() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getServersConfiguration() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStdioClientProperties

getServerSideTimeout() - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

getServiceTier() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getServiceTier() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getServiceTier() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getServiceTier() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getServiceTier() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getServiceTier() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getServiceTier() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getServiceTier() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getServiceTier() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the service tier.

getServiceTier() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getSessionId() - Method in exception org.springframework.ai.session.SessionAlreadyExistsException

The id of the session that already exists.

getSessionId() - Method in class org.springframework.ai.session.SessionEvent

The session the event belongs to.

getSessionIdKeyName() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

getSessionLabel() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

getSessionLabel() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig

Deprecated.

getSessionLabel() - Method in class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryProperties

Deprecated.

getSessionToken() - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

getSexual() - Method in class org.springframework.ai.moderation.CategoryScores

getSexualMinors() - Method in class org.springframework.ai.moderation.CategoryScores

getSimilarity() - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

getSimilarity() - Method in class org.springframework.ai.vectorstore.elasticsearch.autoconfigure.ElasticsearchVectorStoreProperties

getSimilarity() - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStoreOptions

getSimilarity() - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

getSimilarityMetric() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

getSimilarityThreshold() - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreProperties

getSimilarityThreshold() - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure.RedisSemanticCacheProperties

getSimilarityThreshold() - Method in class org.springframework.ai.vectorstore.SearchRequest

getSize() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

getSize() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getSize() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.ImageGeneration

getSize() - Method in class org.springframework.ai.openai.OpenAiImageOptions

getSkillContainer() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getSkillId() - Method in enum class org.springframework.ai.anthropic.AnthropicSkill

getSkillId() - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord

getSkills() - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer

getSocketTimeout() - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

getSpeakerVoiceConfigs() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

getSpeakerVoiceConfigs() - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

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.

getSpeed() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getSpeed() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

The Gemini-TTS models do not expose a speaking-rate parameter; pacing is controlled through the style prompt.

getSpeed() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

getSpeed() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getSpeed() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions

getSseEndpoint() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerSseProperties

Deprecated.

getSseMessageEndpoint() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerSseProperties

Deprecated.

getSslBundle() - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

getStartBlockIndex() - Method in class org.springframework.ai.anthropic.Citation

getStartCharIndex() - Method in class org.springframework.ai.anthropic.Citation

getStartPageNumber() - Method in class org.springframework.ai.anthropic.Citation

getSteps() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

getSteps() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getSteps() - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

getStop() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions

getStop() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getStop() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

getStop() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getStop() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

getStop() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getStop() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getStop() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getStop() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getStop() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getStop() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getStop() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the stop sequences.

getStopSequences() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getStopSequences() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

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.deepseek.DeepSeekChatOptions

getStopSequences() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getStopSequences() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

getStopSequences() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getStopSequences() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getStopSequences() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getStopSequences() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

getStopSequences() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getStopSequences() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getStopSequences() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getStopSequences() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

getStopSequences() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getStopSequences() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getStopSequences() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getStore() - Method in interface org.springframework.ai.chat.cache.semantic.SemanticCache

Returns the underlying vector store used by this cache implementation.

getStore() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getStore() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getStore() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets whether to store the conversation.

getStore() - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache

getStrategy() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions

getStrategy() - Method in class org.springframework.ai.bedrock.converse.api.BedrockCacheOptions

Gets the caching strategy.

getStrategy() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicCacheProperties

getStrategy() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockCacheProperties

getStreamAdvisors() - Method in interface org.springframework.ai.chat.client.advisor.api.StreamAdvisorChain

Returns the list of all the StreamAdvisor instances included in this chain at the time of its creation.

getStreamAdvisors() - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain

getStreamOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getStreamOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getStreamOptions() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the stream options.

getStrict() - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool.Function

getStrict() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema

getStrict() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getStrict() - Method in class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat

Whether to enable strict schema adherence for JSON schema response format.

getStrict() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets whether OpenAI Tool/Function calling strict mode is enabled.

getStrict() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

Whether tool schemas are sent as strict.

getStyle() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getStyle() - Method in interface org.springframework.ai.image.ImageOptions

getStyle() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

getStyle() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getStyle() - Method in class org.springframework.ai.openai.OpenAiImageOptions

getStyle() - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

getStylePreset() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

getStylePreset() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getStylePreset() - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

getStylePrompt() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

getStylePrompt() - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

getSystemInstruction() - Method in class org.springframework.ai.google.genai.cache.CachedContentRequest

getSystemInstruction() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

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.

getSystemMessageSuffix() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

getSystemMetadata() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

getSystemParams() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

getSystemText() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

getTable() - Method in class org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure.CassandraChatMemoryRepositoryProperties

Deprecated.

getTable() - Method in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreProperties

getTableName() - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

getTableName() - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

getTableName() - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

getTableName() - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

getTaskType() - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions

getTaskType() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties

getTaskType() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTaskType() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties

getTaskType() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTaskType() - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions

getTemperature() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getTemperature() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

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.deepseek.DeepSeekChatOptions

getTemperature() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getTemperature() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getTemperature() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

getTemperature() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getTemperature() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getTemperature() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTemperature() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

getTemperature() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTemperature() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

getTemperature() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTemperature() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getTemperature() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTemperature() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

getTemperature() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

getTemperature() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

getTemperature() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTemperature() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getTemperature() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTemperature() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

getTemperature() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTemperature() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getTemperature() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTemperature() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getTemperature() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getTemperature() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

getTemperature() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getTemperature() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getTemplate() - Method in class org.springframework.ai.chat.prompt.PromptTemplate

getTemplateRenderer() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

getTenant(String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

getTenantName() - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaVectorStoreProperties

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.chat.messages.ToolResponseMessage

Tool response messages never had a null text, even with no responses at all; only AbstractMessage's generic rule for an empty parts list would say otherwise.

getText() - Method in interface org.springframework.ai.content.Content

Get the content of the message.

getText() - Method in class org.springframework.ai.document.Document

Returns the document's text content, if any.

getText() - Method in class org.springframework.ai.image.ImageMessage

getText() - Method in class org.springframework.ai.moderation.ModerationMessage

getText(String) - Static method in class org.springframework.ai.util.ResourceUtils

Retrieves the content of a resource as a UTF-8 encoded string.

getTextBetweenParagraphs(ParagraphManager.Paragraph, ParagraphManager.Paragraph) - Method in class org.springframework.ai.reader.pdf.ParagraphPdfDocumentReader

getTextForRegion(String) - Method in class org.springframework.ai.reader.pdf.layout.PDFLayoutTextStripperByArea

Get the text for the region, this should be called after extractRegions().

getTextProperty() - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

getTextTemplate() - Method in class org.springframework.ai.document.DefaultContentFormatter

getTfsZ() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getTfsZ() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTfsZ() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getThink() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getThinking() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getThinking() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions

getThinking() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getThinking() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getThinking() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

getThinking() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getThinkingBudget() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getThinkingBudget() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getThinkingBudget() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getThinkingLevel() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getThinkingLevel() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getThinkingLevel() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getThinkOption() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getThinkOption() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getThoughtsTokenCount() - Method in class org.springframework.ai.google.genai.metadata.GoogleGenAiUsage

Returns the number of tokens present in thoughts output for thinking-enabled models.

getThreshold() - Method in class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting

getThreshold() - Method in class org.springframework.ai.session.compaction.TokenCountTrigger

getTimeout() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getTimeout() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicConnectionProperties

getTimeout() - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

getTimeout() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties

getTimeout() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

Return the configured request timeout, or null when not set.

getTimeout() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAutoConfigurationUtil.ResolvedConnectionProperties

Unlike the properties it is resolved from, a resolved timeout is always present: it is what the OpenAI client is built with.

getTimeout() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTimeout() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions

Return the request timeout, or null to inherit the timeout configured on the OpenAI client.

getTimeout() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Return the request timeout, or null to inherit the timeout configured on the OpenAI client.

getTimeout() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

Return the request timeout, or null to inherit the timeout configured on the OpenAI client.

getTimestamp() - Method in class org.springframework.ai.session.SessionEvent

When the event was recorded.

getTimestampGranularities() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

getTimestampGranularities() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTimestampGranularities() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

getTimeToLive() - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getTimeToLive() - Method in class org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure.CassandraChatMemoryRepositoryProperties

Deprecated.

getTimeToLive() - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

getTimeToLive() - Method in class org.springframework.ai.model.session.autoconfigure.SessionServiceProperties

getTimeToLiveSeconds() - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig

Deprecated.

getTitle() - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions

getTitle() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties

getTitle() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTitle() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties

getTitle() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTitle() - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions

getToken() - Method in interface org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireConnectionDetails

getToken() - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

getToken() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getTokenCount() - Method in class org.springframework.ai.google.genai.metadata.GoogleGenAiModalityTokenCount

Returns the token count for this modality.

getTokenizer() - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties

getTokenNames() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

Deprecated.

getTokenNames() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

Deprecated.

getTokensLimit() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

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.

getTokensLimit() - Method in class org.springframework.ai.openai.metadata.OpenAiRateLimit

getTokensRemaining() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

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.

getTokensRemaining() - Method in class org.springframework.ai.openai.metadata.OpenAiRateLimit

getTokensReset() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

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.

getTokensReset() - Method in class org.springframework.ai.openai.metadata.OpenAiRateLimit

getToolCallArguments() - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext

getToolcallback() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

getToolCallbackProviders() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

getToolCallbacks() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getToolCallbacks() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

getToolCallbacks() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

getToolCallbacks() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions

getToolCallbacks() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getToolCallbacks() - Method in class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider

Discovers and returns all available tools from configured MCP servers.

getToolCallbacks() - Method in class org.springframework.ai.mcp.SyncMcpToolCallbackProvider

getToolCallbacks() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

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.ollama.api.OllamaChatOptions

getToolCallbacks() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getToolCallbacks() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

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

getToolCallbacksFromAsyncClients(McpAsyncClient...) - Static method in class org.springframework.ai.mcp.McpToolUtils

Convenience method to get tool callbacks from multiple asynchronous MCP clients.

getToolCallbacksFromAsyncClients(List<McpAsyncClient>) - Static method in class org.springframework.ai.mcp.McpToolUtils

Gets tool callbacks from a list of asynchronous MCP clients.

getToolCallbacksFromSyncClients(McpSyncClient...) - Static method in class org.springframework.ai.mcp.McpToolUtils

Convenience method to get tool callbacks from multiple synchronous MCP clients.

getToolCallbacksFromSyncClients(List<McpSyncClient>) - Static method in class org.springframework.ai.mcp.McpToolUtils

Gets tool callbacks from a list of synchronous MCP clients.

getToolCallId() - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext

getToolCallIds() - Method in exception org.springframework.ai.model.tool.ToolCallConfirmationRequiredException

The keys of the tool calls that need a confirmation (see ToolCallDecisions.toolCallKeys(org.springframework.ai.chat.messages.AssistantMessage)), in the order the model asked for them.

getToolCalling() - Method in class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties

getToolCallingManager() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder

Returns the configured ToolCallingManager.

getToolCallLabel() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

getToolCallLabel() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig

Deprecated.

getToolCallLabel() - Method in class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryProperties

Deprecated.

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

getToolChoice() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getToolChoice() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions

getToolChoice() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

Returns the tool choice configuration.

getToolChoice() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getToolChoice() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getToolChoice() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getToolChoice() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getToolChoice() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

getToolChoice() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getToolChoice() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getToolChoice() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getToolChoice() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getToolChoice() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the tool choice configuration.

getToolChoice() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

auto, none, required, a function name as {"type":"function","name":"..."}, or a hosted tool type as {"type":"web_search"}.

getToolContext() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getToolContext() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

getToolContext() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

getToolContext() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions

getToolContext() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getToolContext() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

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.

getToolContext() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getToolContext() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getToolContext() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getToolDefinition() - Method in class org.springframework.ai.mcp.AsyncMcpToolCallback

getToolDefinition() - Method in class org.springframework.ai.mcp.SyncMcpToolCallback

getToolDefinition() - Method in class org.springframework.ai.tool.augment.AugmentedToolCallback

getToolDefinition() - Method in exception 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

getToolExecutionEligibilityChecker() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder

Returns the configured ToolExecutionEligibilityChecker.

getToolIndexType() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

getToolListChangedSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.changed.tool.AsyncMcpToolListChangedProvider

Get the list of tool list changed consumer specifications.

getToolListChangedSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.changed.tool.SyncMcpToolListChangedProvider

Get the list of tool list changed consumer specifications.

getToolMetadata() - Method in class org.springframework.ai.tool.augment.AugmentedToolCallback

The delegate's metadata, so that augmenting the arguments keeps flags such as ToolMetadata.returnDirect() and ToolMetadata.requiresConfirmation().

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 in exception org.springframework.ai.model.tool.ToolCallLimitExceededException

The name of the tool whose per-tool limit was exceeded, or null when the total per-turn limit was exceeded instead.

getToolName(Method) - Static method in class org.springframework.ai.tool.support.ToolUtils

getToolRequiresConfirmation(Method) - Static method in class org.springframework.ai.tool.support.ToolUtils

Whether calls of the @Tool method need a person's confirmation before they run.

getToolResponseLabel() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

getToolResponseLabel() - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig

Deprecated.

getToolResponseLabel() - Method in class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryProperties

Deprecated.

getToolResponseMimeType() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

getToolReturnDirect(Method) - Static method in class org.springframework.ai.tool.support.ToolUtils

getTools() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions

getTools() - Method in class org.springframework.ai.mcp.McpToolsChangedEvent

getTools() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getTools() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

getTools() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTools() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Confirmation

getToolSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.tool.AsyncMcpToolProvider

Get the tool handler.

getToolSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.tool.AsyncStatelessMcpToolProvider

Get the async stateless tool specifications.

getToolSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.tool.SyncMcpToolProvider

Get the tool handler.

getToolSpecifications() - Method in class org.springframework.ai.mcp.annotation.provider.tool.SyncStatelessMcpToolProvider

Get the stateless tool specifications.

getToolType() - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext

getToolUsePromptTokenCount() - Method in class org.springframework.ai.google.genai.metadata.GoogleGenAiUsage

Returns the number of tokens present in tool-use prompts.

getToolUsePromptTokensDetails() - Method in class org.springframework.ai.google.genai.metadata.GoogleGenAiUsage

Returns the list of modalities that were processed for tool-use request inputs.

getTopK() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getTopK() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

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.deepseek.DeepSeekChatOptions

getTopK() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getTopK() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getTopK() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

getTopK() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getTopK() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getTopK() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTopK() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

getTopK() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTopK() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getTopK() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTopK() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

getTopK() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

getTopK() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getTopK() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTopK() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getTopK() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getTopK() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getTopK() - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreProperties

getTopK() - Method in class org.springframework.ai.vectorstore.SearchRequest

getTopLogprobs() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions

getTopLogprobs() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

getTopLogprobs() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTopLogprobs() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getTopLogprobs() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTopLogprobs() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the number of top log probabilities to return.

getTopP() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getTopP() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

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.deepseek.DeepSeekChatOptions

getTopP() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getTopP() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

getTopP() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

getTopP() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

getTopP() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getTopP() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTopP() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

getTopP() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTopP() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

getTopP() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTopP() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getTopP() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTopP() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

getTopP() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

getTopP() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

getTopP() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTopP() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getTopP() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTopP() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getTopP() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTopP() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getTopP() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getTopP() - Method in class org.springframework.ai.openai.OpenAiChatOptions

getTopP() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

getTotalDuration() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

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

getTrafficType() - Method in class org.springframework.ai.google.genai.metadata.GoogleGenAiUsage

Returns the traffic type showing whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.

getTransformer() - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

getTransformer() - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTransformer() - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions

getTruncate() - Method in class org.springframework.ai.bedrock.cohere.BedrockCohereEmbeddingOptions

getTruncate() - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties

getTruncate() - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTruncate() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getTruncate() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTruncate() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties

getTruncate() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTruncate() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getTruncate() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getTruncation() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getTruncation() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

auto to let OpenAI drop middle-of-conversation items when the context window overflows, or disabled to fail instead.

getTtl() - Method in class org.springframework.ai.bedrock.converse.api.BedrockCacheOptions

Gets the cache TTL.

getTtl() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties.Eviction

getTtl() - Method in class org.springframework.ai.google.genai.cache.CachedContentRequest

getTtl() - Method in class org.springframework.ai.google.genai.cache.CachedContentUpdateRequest

getTtl() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

getTtl() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockCacheProperties

getTtl() - Method in class org.springframework.ai.model.chat.memory.repository.mongo.autoconfigure.MongoChatMemoryProperties

Deprecated.

getType() - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord

getType() - Method in class org.springframework.ai.anthropic.Citation

getType() - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool

getType() - Method in class org.springframework.ai.deepseek.api.ResponseFormat

getType() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

getType() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

getType() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

getType() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool

getType() - Method in class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat

getType() - Method in class org.springframework.ai.session.SessionEvent

What the event records; EventType.MESSAGE for a conversation message.

getTypicalP() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getTypicalP() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getTypicalP() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getUpdateTime() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

getUpsertSessionSql() - Method in class org.springframework.ai.session.jdbc.H2JdbcSessionRepositoryDialect

getUpsertSessionSql() - Method in interface org.springframework.ai.session.jdbc.JdbcSessionRepositoryDialect

Inserts a row into AI_SESSION or updates the existing one, refreshing only expires_at and metadata: created_at keeps its value and event_version is never touched.

getUpsertSessionSql() - Method in class org.springframework.ai.session.jdbc.MysqlJdbcSessionRepositoryDialect

getUpsertSessionSql() - Method in class org.springframework.ai.session.jdbc.PostgresJdbcSessionRepositoryDialect

getUri() - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Tokenizer

getUri() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getUris() - Method in interface org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchConnectionDetails

getUris() - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

getUrl() - Method in class org.springframework.ai.anthropic.Citation

getUrl() - Method in class org.springframework.ai.image.Image

getUrl() - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

getUsage() - Method in class org.springframework.ai.audio.transcription.AudioTranscriptionResponseMetadata

Returns AI provider specific metadata on API usage.

getUsage() - Method in class org.springframework.ai.audio.tts.TextToSpeechResponseMetadata

Returns AI provider specific metadata on API usage.

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.

getUsage() - Method in class org.springframework.ai.image.ImageResponseMetadata

Return the token usage associated with the image response.

getUsageMetadata() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

getUseApproximateKnn() - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

getUseCachedContent() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

getUseCachedContent() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

getUseCachedContent() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getUseMLock() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getUseMLock() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getUseMLock() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getUseMLock() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getUseMMap() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getUseMMap() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getUseMMap() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getUseMMap() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getUseNUMA() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getUseNUMA() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getUseNUMA() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getUseNUMA() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getUser() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getUser() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getUser() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

getUser() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getUser() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

getUser() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getUser() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the user identifier.

getUser() - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions

getUser() - Method in class org.springframework.ai.openai.OpenAiImageOptions

getUserLocation() - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool

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.

getUserMetadata() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

getUsername() - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated, for removal: This API element is subject to removal in a future version.

getUsername() - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

getUsername() - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaApiProperties

getUsername() - Method in interface org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireConnectionDetails

getUsername() - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

getUsername() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

getUsername() - Method in interface org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchConnectionDetails

getUsername() - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

getUserParams() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

getUserText() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

getUserText() - Method in class org.springframework.ai.evaluation.EvaluationRequest

getValue() - Method in enum class org.springframework.ai.anthropic.AnthropicSkillType

getValue() - Method in enum class org.springframework.ai.bedrock.converse.api.BedrockCacheTtl

getValue() - Method in enum class org.springframework.ai.chat.memory.repository.neo4j.MediaAttributes

Deprecated.

getValue() - Method in enum class org.springframework.ai.chat.memory.repository.neo4j.MessageAttributes

Deprecated.

getValue() - Method in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolCallAttributes

Deprecated.

getValue() - Method in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolResponseAttributes

Deprecated.

getValue() - Method in enum class org.springframework.ai.chat.messages.MessageType

getValue() - Method in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatModel

getValue() - Method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

getValue() - Method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.TextNormalizationMode

getValue() - Method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.CategoryEnum

getValue() - Method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ReaderResource.ResourceTypeEnum

getValue() - Method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.SafetyControlEnum

getValue() - Method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.CategoryEnum

getValue() - Method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.ReviewStatusEnum

getValue() - Method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.StatusEnum

getValue() - Method in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmBlockMethod

getValue() - Method in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmBlockThreshold

getValue() - Method in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmCategory

getValue() - Method in enum class org.springframework.ai.google.genai.common.GoogleGenAiServiceTier

getValue() - Method in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

getValue() - Method in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.GeminiMessageType

getValue() - Method in enum class org.springframework.ai.google.genai.metadata.GoogleGenAiTrafficType

Returns the string value of the traffic type.

getValue() - Method in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.Type

getValue() - Method in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatModel

getValue() - Method in enum class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingModel

getValue() - Method in enum class org.springframework.ai.mistralai.api.MistralAiModerationApi.Model

getValue() - Method in enum class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRModel

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 enum class org.springframework.ai.model.ollama.autoconfigure.OllamaThinkProperties

getValue() - Method in record class org.springframework.ai.model.SimpleApiKey

getValue() - Method in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.AudioResponseFormat

getValue() - Method in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Voice

getValue() - Method in enum class org.springframework.ai.openai.OpenAiEmbeddingOptions.EncodingFormat

getVectorBucketName() - Method in class org.springframework.ai.vectorstore.s3.autoconfigure.S3VectorStoreProperties

getVectorSimilarityFunction() - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

getVectorSimilarityFunction() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.CreateRequest

getVectorSimilarityFunction() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

getVectorStoreIds() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.FileSearch

getVectorType() - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

getVectorType() - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getVectorType() - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions

getVerbosity() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

getVerbosity() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getVerbosity() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

getVerbosity() - Method in class org.springframework.ai.openai.OpenAiChatOptions

Gets the verbosity level.

getVerbosity() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

How verbose the answer should be: low, medium or high.

getVersion() - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord

getVersion() - Method in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModelName

getVersion() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

getVersion() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

getVersion() - Method in interface org.springframework.ai.model.ModelDescription

Returns the version of the model.

getVersion() - Method in enum class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingModelName

getVersion() - Method in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModelName

getVideoEndOffsetSec() - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions

getVideoFormat(MimeType) - Static method in class org.springframework.ai.bedrock.converse.api.BedrockMediaFormat

getVideoIntervalSec() - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions

getVideoStartOffsetSec() - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions

getViolence() - Method in class org.springframework.ai.moderation.CategoryScores

getViolenceGraphic() - Method in class org.springframework.ai.moderation.CategoryScores

getVocabOnly() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

getVocabOnly() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getVocabOnly() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

getVocabOnly() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

getVocabulary() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

getVocabulary() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

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.

getVoice() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getVoice() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

getVoice() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getVoice() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getVoice() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

getVoice() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getVoice() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions

getVoice(String) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi

Returns metadata about a specific voice.

getVoiceId() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getVoiceId() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getVoiceId() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getVoiceName() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

getVoiceName() - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

getVoices() - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi

Retrieves a list of all available voices from the ElevenLabs API.

getVoiceSettings() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

getVoiceSettings() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

getVoiceSettings() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getVoiceSettings(String) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi

Returns the settings for a specific voice.

getWebSearch() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools

getWebSearchTool() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

getWebSearchTool() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

getWebSearchTool() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getWeight() - Method in class org.springframework.ai.image.ImageMessage

getWidth() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

Image width is not directly configurable Use GoogleGenAiImageOptions.getAspectRatio() or GoogleGenAiImageOptions.getImageSize() instead.

getWidth() - Method in interface org.springframework.ai.image.ImageOptions

getWidth() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

getWidth() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getWidth() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

getWidth() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

getWidth() - Method in class org.springframework.ai.openai.OpenAiImageOptions

getWidth() - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

getWindow() - Method in class org.springframework.ai.session.compaction.WindowCompactionStrategy

The rule this strategy cuts by.

getWords() - Method in class org.springframework.ai.openai.metadata.OpenAiAudioTranscriptionResponseMetadata

Returns the word-level timestamps, or null if not returned by the API.

GITHUB_MODELS - Enum constant in enum class org.springframework.ai.openai.setup.OpenAiSetup.ModelProvider

gitHubModels(Boolean) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

gitHubModels(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

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

GOOGLE_GENAI_AI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider

AI system provided by Google Gen AI.

GOOGLE_PROVIDER - Static variable in class org.springframework.ai.google.genai.GoogleGenAiChatModel

The OpaquePayload.provider() of the parts produced by this model.

GoogleGenAiAudioSpeechOptions - Class in org.springframework.ai.google.genai.tts

Options for Google Gemini-TTS text-to-speech, backed by the Google GenAI SDK (com.google.genai).

GoogleGenAiAudioSpeechOptions() - Constructor for class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

GoogleGenAiAudioSpeechOptions.AudioEncoding - Enum Class in org.springframework.ai.google.genai.tts

The format of the audio byte stream returned by the synthesis.

GoogleGenAiAudioSpeechOptions.Builder - Class in org.springframework.ai.google.genai.tts

GoogleGenAiAudioSpeechOptions.MultiSpeakerTurn - Record Class in org.springframework.ai.google.genai.tts

A single speaker turn used for multi-speaker synthesis input.

GoogleGenAiAudioSpeechOptions.ReplicatedVoice - Record Class in org.springframework.ai.google.genai.tts

A cloned voice sample used to synthesize speech with a replicated voice (maps to speechConfig.voiceConfig.replicatedVoiceConfig).

GoogleGenAiAudioSpeechOptions.SpeakerVoiceConfig - Record Class in org.springframework.ai.google.genai.tts

A single speaker-to-voice mapping for multi-speaker synthesis.

GoogleGenAiAudioTranscriptionMetadata - Class in org.springframework.ai.google.genai.transcription

AudioTranscriptionResponseMetadata implementation for the Google GenAI (Gemini) transcription API.

GoogleGenAiAudioTranscriptionMetadata(String, Usage) - Constructor for class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionMetadata

GoogleGenAiAudioTranscriptionOptions - Class in org.springframework.ai.google.genai.transcription

Options for Google GenAI (Gemini) audio transcription.

GoogleGenAiAudioTranscriptionOptions(String, String, String, Float, Float, Float, Integer, Integer, List<String>, String, Float, Float, Integer) - Constructor for class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

GoogleGenAiAudioTranscriptionOptions.Builder - Class in org.springframework.ai.google.genai.transcription

GoogleGenAiCachedContent - Class in org.springframework.ai.google.genai.cache

Represents cached content in Google GenAI for reusing large contexts across multiple requests.

GoogleGenAiCachedContent.Builder - Class in org.springframework.ai.google.genai.cache

googleGenAiCachedContentService(GoogleGenAiChatModel) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatAutoConfiguration

GoogleGenAiCachedContentService - Class in org.springframework.ai.google.genai.cache

Service for managing cached content in Google GenAI.

GoogleGenAiCachedContentService(Client) - Constructor for class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService

GoogleGenAiCachedContentService.CachedContentException - Exception in org.springframework.ai.google.genai.cache

Exception thrown when cached content operations fail.

GoogleGenAiCachedContentService.CachedContentPage - Class in org.springframework.ai.google.genai.cache

Result of listing cached content with pagination support.

GoogleGenAiChatAutoConfiguration - Class in org.springframework.ai.model.google.genai.autoconfigure.chat

Auto-configuration for Google GenAI Chat.

GoogleGenAiChatAutoConfiguration() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatAutoConfiguration

googleGenAiChatModel(Client, GoogleGenAiChatProperties, ToolCallingManager, ObjectProvider<RetryTemplate>, ObjectProvider<ObservationRegistry>, ObjectProvider<ChatModelObservationConvention>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatAutoConfiguration

GoogleGenAiChatModel - Class in org.springframework.ai.google.genai

Google GenAI Chat Model implementation that provides access to Google's Gemini language models.

GoogleGenAiChatModel(Client, GoogleGenAiChatOptions, ToolCallingManager, RetryTemplate, ObservationRegistry) - Constructor for class org.springframework.ai.google.genai.GoogleGenAiChatModel

Creates a new instance of GoogleGenAiChatModel.

GoogleGenAiChatModel.Builder - Class in org.springframework.ai.google.genai

GoogleGenAiChatModel.ChatModel - Enum Class in org.springframework.ai.google.genai

GoogleGenAiChatModel.GeminiMessageType - Enum Class in org.springframework.ai.google.genai

GoogleGenAiChatModel.GeminiRequest - Record Class in org.springframework.ai.google.genai

GoogleGenAiChatOptions - Class in org.springframework.ai.google.genai

Options for the Google GenAI Chat API.

GoogleGenAiChatOptions(String, Double, Integer, Double, List<String>, Double, Integer, Double, GoogleGenAiChatOptions.ToolChoice, List<ToolCallback>, Map<String, Object>, Integer, String, String, Integer, Boolean, GoogleGenAiThinkingLevel, Boolean, String, Boolean, Integer, Duration, Boolean, Boolean, List<GoogleGenAiSafetySetting>, Map<String, String>, GoogleGenAiServiceTier) - Constructor for class org.springframework.ai.google.genai.GoogleGenAiChatOptions

GoogleGenAiChatOptions.AbstractBuilder<B extends GoogleGenAiChatOptions.AbstractBuilder<B>> - Class in org.springframework.ai.google.genai

GoogleGenAiChatOptions.Builder - Class in org.springframework.ai.google.genai

GoogleGenAiChatOptions.ToolChoice - Record Class in org.springframework.ai.google.genai

Configures function calling behavior when tools are provided.

GoogleGenAiChatOptions.ToolChoice.Builder - Class in org.springframework.ai.google.genai

GoogleGenAiChatOptions.ToolChoice.Mode - Enum Class in org.springframework.ai.google.genai

Controls how the model selects functions to call.

GoogleGenAiChatProperties - Class in org.springframework.ai.model.google.genai.autoconfigure.chat

Configuration properties for Google GenAI Chat.

GoogleGenAiChatProperties() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

GoogleGenAiChatProperties.Options - Class in org.springframework.ai.model.google.genai.autoconfigure.chat

GoogleGenAiChatProperties.ToolChoiceProperties - Class in org.springframework.ai.model.google.genai.autoconfigure.chat

Configuration properties for GoogleGenAiChatOptions.ToolChoice.

googleGenAiClient(GoogleGenAiConnectionProperties) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatAutoConfiguration

GoogleGenAiConnectionProperties - Class in org.springframework.ai.model.google.genai.autoconfigure.chat

Configuration properties for Google GenAI Chat.

GoogleGenAiConnectionProperties() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiConnectionProperties

GoogleGenAiConstants - Class in org.springframework.ai.google.genai.common

Constants for Google Gen AI.

GoogleGenAiEmbeddingConnectionAutoConfiguration - Class in org.springframework.ai.model.google.genai.autoconfigure.embedding

Auto-configuration for Google GenAI Embedding Connection.

GoogleGenAiEmbeddingConnectionAutoConfiguration() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiEmbeddingConnectionAutoConfiguration

googleGenAiEmbeddingConnectionDetails(GoogleGenAiEmbeddingConnectionProperties) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiEmbeddingConnectionAutoConfiguration

GoogleGenAiEmbeddingConnectionDetails - Class in org.springframework.ai.google.genai.embedding

GoogleGenAiEmbeddingConnectionDetails represents the details of a connection to the embedding service using the new Google Gen AI SDK.

GoogleGenAiEmbeddingConnectionDetails.Builder - Class in org.springframework.ai.google.genai.embedding

GoogleGenAiEmbeddingConnectionProperties - Class in org.springframework.ai.model.google.genai.autoconfigure.embedding

Configuration properties for Google GenAI Embedding Connection.

GoogleGenAiEmbeddingConnectionProperties() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiEmbeddingConnectionProperties

GoogleGenAiImageAutoConfiguration - Class in org.springframework.ai.model.google.genai.autoconfigure.image

Auto-configuration for Google GenAI Image.

GoogleGenAiImageAutoConfiguration() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageAutoConfiguration

GoogleGenAiImageConnectionAutoConfiguration - Class in org.springframework.ai.model.google.genai.autoconfigure.image

Auto-configuration for Google GenAI Image Connection.

GoogleGenAiImageConnectionAutoConfiguration() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageConnectionAutoConfiguration

googleGenAiImageConnectionDetails(GoogleGenAiImageConnectionProperties) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageConnectionAutoConfiguration

GoogleGenAiImageConnectionDetails - Class in org.springframework.ai.google.genai.image

GoogleGenAiImageConnectionDetails represents the details of a connection to the image service using the new Google Gen AI SDK.

GoogleGenAiImageConnectionDetails.Builder - Class in org.springframework.ai.google.genai.image

GoogleGenAiImageConnectionProperties - Class in org.springframework.ai.model.google.genai.autoconfigure.image

Connection properties for the Google GenAI Image.

GoogleGenAiImageConnectionProperties() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageConnectionProperties

GoogleGenAiImageGenerationMetadata - Class in org.springframework.ai.google.genai.image

Image generation metadata returned by the Google GenAI image API.

GoogleGenAiImageGenerationMetadata(String, String, String, String) - Constructor for class org.springframework.ai.google.genai.image.GoogleGenAiImageGenerationMetadata

googleGenAiImageModel(GoogleGenAiImageConnectionDetails, GoogleGenAiImageProperties, ObjectProvider<RetryTemplate>, ObjectProvider<ObservationRegistry>, ObjectProvider<ImageModelObservationConvention>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageAutoConfiguration

GoogleGenAiImageModel - Class in org.springframework.ai.google.genai.image

A class representing an Image Model using the new Google Gen AI SDK.

GoogleGenAiImageModel(GoogleGenAiImageConnectionDetails, GoogleGenAiImageOptions) - Constructor for class org.springframework.ai.google.genai.image.GoogleGenAiImageModel

GoogleGenAiImageModel(GoogleGenAiImageConnectionDetails, GoogleGenAiImageOptions, RetryTemplate) - Constructor for class org.springframework.ai.google.genai.image.GoogleGenAiImageModel

GoogleGenAiImageModel(GoogleGenAiImageConnectionDetails, GoogleGenAiImageOptions, RetryTemplate, ObservationRegistry) - Constructor for class org.springframework.ai.google.genai.image.GoogleGenAiImageModel

GoogleGenAiImageModelName - Enum Class in org.springframework.ai.google.genai.image

Known Google GenAI image generation model names.

GoogleGenAiImageOptions - Class in org.springframework.ai.google.genai.image

Options for the Image supported by the GenAI SDK

GoogleGenAiImageOptions(String, Integer, String, Integer, GoogleGenAiImageOptions.SafetyFilterLevel, GoogleGenAiImageOptions.PersonGeneration, String, Integer, Map<String, String>, String, Float, Float, Float, Integer) - Constructor for class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

GoogleGenAiImageOptions.Builder - Class in org.springframework.ai.google.genai.image

GoogleGenAiImageOptions.PersonGeneration - Enum Class in org.springframework.ai.google.genai.image

GoogleGenAiImageOptions.SafetyFilterLevel - Enum Class in org.springframework.ai.google.genai.image

GoogleGenAiImageProperties - Class in org.springframework.ai.model.google.genai.autoconfigure.image

Configuration properties for Google GenAI Image.

GoogleGenAiImageProperties() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

GoogleGenAiModalityTokenCount - Class in org.springframework.ai.google.genai.metadata

Represents token count information for a specific modality (text, image, audio, video).

GoogleGenAiModalityTokenCount(String, Integer) - Constructor for class org.springframework.ai.google.genai.metadata.GoogleGenAiModalityTokenCount

Creates a new modality token count instance.

GoogleGenAiRuntimeHints - Class in org.springframework.ai.google.genai.aot

The GoogleGenAiRuntimeHints class is responsible for registering runtime hints for Google GenAI classes.

GoogleGenAiRuntimeHints() - Constructor for class org.springframework.ai.google.genai.aot.GoogleGenAiRuntimeHints

GoogleGenAiSafetySetting - Class in org.springframework.ai.google.genai.common

GoogleGenAiSafetySetting() - Constructor for class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting

GoogleGenAiSafetySetting(GoogleGenAiSafetySetting.HarmCategory, GoogleGenAiSafetySetting.HarmBlockThreshold, GoogleGenAiSafetySetting.HarmBlockMethod) - Constructor for class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting

GoogleGenAiSafetySetting.Builder - Class in org.springframework.ai.google.genai.common

GoogleGenAiSafetySetting.HarmBlockMethod - Enum Class in org.springframework.ai.google.genai.common

Enum representing methods for evaluating harmful content.

GoogleGenAiSafetySetting.HarmBlockThreshold - Enum Class in org.springframework.ai.google.genai.common

Enum representing different threshold levels for blocking harmful content.

GoogleGenAiSafetySetting.HarmCategory - Enum Class in org.springframework.ai.google.genai.common

Enum representing different categories of harmful content.

GoogleGenAiServiceTier - Enum Class in org.springframework.ai.google.genai.common

The service tier to use for the request.

googleGenAiTextEmbedding(GoogleGenAiEmbeddingConnectionDetails, GoogleGenAiTextEmbeddingProperties, ObjectProvider<RetryTemplate>, ObjectProvider<ObservationRegistry>, ObjectProvider<EmbeddingModelObservationConvention>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingAutoConfiguration

GoogleGenAiTextEmbeddingAutoConfiguration - Class in org.springframework.ai.model.google.genai.autoconfigure.embedding

Auto-configuration for Google GenAI Text Embedding.

GoogleGenAiTextEmbeddingAutoConfiguration() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingAutoConfiguration

GoogleGenAiTextEmbeddingModel - Class in org.springframework.ai.google.genai.text

A class representing a Vertex AI Text Embedding Model using the new Google Gen AI SDK.

GoogleGenAiTextEmbeddingModel(GoogleGenAiEmbeddingConnectionDetails, GoogleGenAiTextEmbeddingOptions) - Constructor for class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModel

GoogleGenAiTextEmbeddingModel(GoogleGenAiEmbeddingConnectionDetails, GoogleGenAiTextEmbeddingOptions, RetryTemplate) - Constructor for class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModel

GoogleGenAiTextEmbeddingModel(GoogleGenAiEmbeddingConnectionDetails, GoogleGenAiTextEmbeddingOptions, RetryTemplate, ObservationRegistry) - Constructor for class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModel

GoogleGenAiTextEmbeddingModelName - Enum Class in org.springframework.ai.google.genai.text

VertexAI Embedding Models: - Text embeddings - Multimodal embeddings

GoogleGenAiTextEmbeddingOptions - Class in org.springframework.ai.google.genai.text

Options for the Embedding supported by the GenAI SDK

GoogleGenAiTextEmbeddingOptions(String, GoogleGenAiTextEmbeddingOptions.TaskType, Integer, String, Boolean) - Constructor for class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions

GoogleGenAiTextEmbeddingOptions.Builder - Class in org.springframework.ai.google.genai.text

GoogleGenAiTextEmbeddingOptions.TaskType - Enum Class in org.springframework.ai.google.genai.text

GoogleGenAiTextEmbeddingProperties - Class in org.springframework.ai.model.google.genai.autoconfigure.embedding

Configuration properties for Google GenAI Text Embedding.

GoogleGenAiTextEmbeddingProperties() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties

GoogleGenAiTextEmbeddingProperties.Options - Class in org.springframework.ai.model.google.genai.autoconfigure.embedding

GoogleGenAiTextToSpeechAutoConfiguration - Class in org.springframework.ai.model.google.genai.autoconfigure.tts

Auto-configuration for the Google GenAI Gemini-TTS text-to-speech model.

GoogleGenAiTextToSpeechAutoConfiguration() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechAutoConfiguration

GoogleGenAiTextToSpeechConnectionAutoConfiguration - Class in org.springframework.ai.model.google.genai.autoconfigure.tts

Auto-configuration for the Google GenAI Gemini-TTS connection.

GoogleGenAiTextToSpeechConnectionAutoConfiguration() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechConnectionAutoConfiguration

googleGenAiTextToSpeechConnectionDetails(GoogleGenAiTextToSpeechConnectionProperties) - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechConnectionAutoConfiguration

GoogleGenAiTextToSpeechConnectionDetails - Class in org.springframework.ai.google.genai.tts

Holds the connection details for the Gemini API used by Gemini-TTS and builds the underlying Google GenAI Client.

GoogleGenAiTextToSpeechConnectionDetails.Builder - Class in org.springframework.ai.google.genai.tts

GoogleGenAiTextToSpeechConnectionProperties - Class in org.springframework.ai.model.google.genai.autoconfigure.tts

Connection properties for the Google GenAI Gemini-TTS text-to-speech model, backed by the Google GenAI SDK (com.google.genai).

GoogleGenAiTextToSpeechConnectionProperties() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechConnectionProperties

googleGenAiTextToSpeechModel(GoogleGenAiTextToSpeechConnectionDetails, GoogleGenAiTextToSpeechProperties, ObjectProvider<RetryTemplate>, ObjectProvider<ObservationRegistry>, ObjectProvider<TextToSpeechModelObservationConvention>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechAutoConfiguration

GoogleGenAiTextToSpeechModel - Class in org.springframework.ai.google.genai.tts

Implementation of the TextToSpeechModel interface for Google Gemini-TTS, backed by the Google GenAI SDK (com.google.genai).

GoogleGenAiTextToSpeechModel(GoogleGenAiTextToSpeechConnectionDetails, GoogleGenAiAudioSpeechOptions) - Constructor for class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechModel

GoogleGenAiTextToSpeechModel(GoogleGenAiTextToSpeechConnectionDetails, GoogleGenAiAudioSpeechOptions, RetryTemplate) - Constructor for class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechModel

GoogleGenAiTextToSpeechModel(GoogleGenAiTextToSpeechConnectionDetails, GoogleGenAiAudioSpeechOptions, RetryTemplate, ObservationRegistry) - Constructor for class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechModel

GoogleGenAiTextToSpeechModel.Builder - Class in org.springframework.ai.google.genai.tts

GoogleGenAiTextToSpeechProperties - Class in org.springframework.ai.model.google.genai.autoconfigure.tts

Configuration properties for the Google GenAI Gemini-TTS text-to-speech model.

GoogleGenAiTextToSpeechProperties() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

GoogleGenAiThinkingLevel - Enum Class in org.springframework.ai.google.genai.common

Enum representing the level of thinking tokens the model should generate.

GoogleGenAiToolCallingManager - Class in org.springframework.ai.google.genai.schema

Implementation of ToolCallingManager specifically designed for Vertex AI Gemini.

GoogleGenAiToolCallingManager(ToolCallingManager) - Constructor for class org.springframework.ai.google.genai.schema.GoogleGenAiToolCallingManager

Creates a new instance of GoogleGenAiToolCallingManager.

GoogleGenAiTrafficType - Enum Class in org.springframework.ai.google.genai.metadata

Represents the traffic type for Google GenAI requests, indicating whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.

GoogleGenAiTranscriptionAutoConfiguration - Class in org.springframework.ai.model.google.genai.autoconfigure.transcription

Auto-configuration for Google GenAI Transcription.

GoogleGenAiTranscriptionAutoConfiguration() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionAutoConfiguration

GoogleGenAiTranscriptionConnectionAutoConfiguration - Class in org.springframework.ai.model.google.genai.autoconfigure.transcription

Auto-configuration for the Google GenAI Transcription connection.

GoogleGenAiTranscriptionConnectionAutoConfiguration() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionConnectionAutoConfiguration

googleGenAiTranscriptionConnectionDetails(GoogleGenAiTranscriptionConnectionProperties) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionConnectionAutoConfiguration

GoogleGenAiTranscriptionConnectionDetails - Class in org.springframework.ai.google.genai.transcription

GoogleGenAiTranscriptionConnectionDetails represents the details of a connection to the Google Gen AI (Gemini) API used for audio transcription.

GoogleGenAiTranscriptionConnectionDetails.Builder - Class in org.springframework.ai.google.genai.transcription

GoogleGenAiTranscriptionConnectionProperties - Class in org.springframework.ai.model.google.genai.autoconfigure.transcription

Connection properties for the Google GenAI speech-to-text model, backed by the Google GenAI SDK (com.google.genai).

GoogleGenAiTranscriptionConnectionProperties() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionConnectionProperties

googleGenAiTranscriptionModel(GoogleGenAiTranscriptionConnectionDetails, GoogleGenAiTranscriptionProperties, ObjectProvider<RetryTemplate>, ObjectProvider<ObservationRegistry>, ObjectProvider<TranscriptionModelObservationConvention>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionAutoConfiguration

GoogleGenAiTranscriptionModel - Class in org.springframework.ai.google.genai.transcription

A TranscriptionModel implementation that transcribes audio with Gemini transcription models (e.g.

GoogleGenAiTranscriptionModel(GoogleGenAiTranscriptionConnectionDetails, GoogleGenAiAudioTranscriptionOptions) - Constructor for class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionModel

GoogleGenAiTranscriptionModel(GoogleGenAiTranscriptionConnectionDetails, GoogleGenAiAudioTranscriptionOptions, RetryTemplate) - Constructor for class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionModel

GoogleGenAiTranscriptionModel(GoogleGenAiTranscriptionConnectionDetails, GoogleGenAiAudioTranscriptionOptions, RetryTemplate, ObservationRegistry) - Constructor for class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionModel

GoogleGenAiTranscriptionModel.Builder - Class in org.springframework.ai.google.genai.transcription

Builder for creating GoogleGenAiTranscriptionModel instances.

GoogleGenAiTranscriptionProperties - Class in org.springframework.ai.model.google.genai.autoconfigure.transcription

Configuration properties for Google GenAI (Gemini) Transcription.

GoogleGenAiTranscriptionProperties() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

GoogleGenAiUsage - Class in org.springframework.ai.google.genai.metadata

Extended usage metadata for Google GenAI responses that includes thinking tokens, cached content, tool-use tokens, and modality breakdowns.

GoogleGenAiUsage(Integer, Integer, Integer, Integer, Integer, Integer, List<GoogleGenAiModalityTokenCount>, List<GoogleGenAiModalityTokenCount>, List<GoogleGenAiModalityTokenCount>, List<GoogleGenAiModalityTokenCount>, GoogleGenAiTrafficType, GenerateContentResponseUsageMetadata) - Constructor for class org.springframework.ai.google.genai.metadata.GoogleGenAiUsage

Creates a new GoogleGenAiUsage instance with all extended metadata.

googleSearchRetrieval - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

googleSearchRetrieval(Boolean) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

GPU_IVF_FLAT - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

GPU_IVF_PQ - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

group(FilterExpressionBuilder.Op) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

Group(Filter.Expression) - Constructor for record class org.springframework.ai.vectorstore.filter.Filter.Group

Creates an instance of a Group record class.

groupByElement - Variable in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig

groupByElement(boolean) - Method in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig.Builder

Determines if on the selected element, the content will be read on per-element base.

GroupExpressionContext(FiltersParser.BooleanExpressionContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.GroupExpressionContext

gt(String, Object) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

GT - Enum constant in enum class org.springframework.ai.vectorstore.filter.Filter.ExpressionType

GT - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

GT - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

GT() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareContext

gte(String, Object) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

GTE - Enum constant in enum class org.springframework.ai.vectorstore.filter.Filter.ExpressionType

H

H2ChatMemoryRepositoryDialect - Class in org.springframework.ai.chat.memory.repository.jdbc

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of H2JdbcSessionRepositoryDialect in spring-ai-session-jdbc

H2ChatMemoryRepositoryDialect() - Constructor for class org.springframework.ai.chat.memory.repository.jdbc.H2ChatMemoryRepositoryDialect

Deprecated.

H2JdbcSessionRepositoryDialect - Class in org.springframework.ai.session.jdbc

The dialect of H2.

H2JdbcSessionRepositoryDialect() - Constructor for class org.springframework.ai.session.jdbc.H2JdbcSessionRepositoryDialect

HAMMING - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusMetricType

Hamming distance

handleElicitation(String, McpSchema.ElicitRequest) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpAsyncHandlersRegistry

Invoke the elicitation handler for a given MCP client.

handleElicitation(String, McpSchema.ElicitRequest) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

Invoke the elicitation handler for a given MCP client.

handleLogging(String, McpSchema.LoggingMessageNotification) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpAsyncHandlersRegistry

Invoke all elicitation handlers for a given MCP client, sequentially.

handleLogging(String, McpSchema.LoggingMessageNotification) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

Invoke all elicitation handlers for a given MCP client, sequentially.

handleProgress(String, McpSchema.ProgressNotification) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpAsyncHandlersRegistry

Invoke all progress handlers for a given MCP client, sequentially.

handleProgress(String, McpSchema.ProgressNotification) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

Invoke all progress handlers for a given MCP client, sequentially.

handlePromptListChanged(String, List<McpSchema.Prompt>) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpAsyncHandlersRegistry

Invoke all prompt list changed handlers for a given MCP client, sequentially.

handlePromptListChanged(String, List<McpSchema.Prompt>) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

Invoke all prompt list changed handlers for a given MCP client, sequentially.

handleResourceListChanged(String, List<McpSchema.Resource>) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpAsyncHandlersRegistry

Invoke all resource list changed handlers for a given MCP client, sequentially.

handleResourceListChanged(String, List<McpSchema.Resource>) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

Invoke all resource list changed handlers for a given MCP client, sequentially.

handleSampling(String, McpSchema.CreateMessageRequest) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpAsyncHandlersRegistry

Invoke the sampling handler for a given MCP client.

handleSampling(String, McpSchema.CreateMessageRequest) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

Invoke the sampling handler for a given MCP client.

handleToolListChanged(String, List<McpSchema.Tool>) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpAsyncHandlersRegistry

Invoke all tool list changed handlers for a given MCP client, sequentially.

handleToolListChanged(String, List<McpSchema.Tool>) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

Invoke all tool list changed handlers for a given MCP client, sequentially.

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

HARM_BLOCK_METHOD_UNSPECIFIED - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmBlockMethod

HARM_BLOCK_THRESHOLD_UNSPECIFIED - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmBlockThreshold

HARM_CATEGORY_DANGEROUS_CONTENT - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmCategory

HARM_CATEGORY_HARASSMENT - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmCategory

HARM_CATEGORY_HATE_SPEECH - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmCategory

HARM_CATEGORY_SEXUALLY_EXPLICIT - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmCategory

HARM_CATEGORY_UNSPECIFIED - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmCategory

hasCallToolRequestParameter(Method) - Static method in class org.springframework.ai.mcp.annotation.method.tool.utils.McpJsonSchemaGenerator

Check if a method has a CallToolRequest parameter.

hasFilterExpression() - Method in class org.springframework.ai.vectorstore.SearchRequest

hasFinishReasons(Set<String>) - Method in class org.springframework.ai.chat.model.ChatResponse

Whether the model has finished with any of the given finish reasons.

hash() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Sample

Returns the value of the hash record component.

hashCode() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions

hashCode() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

hashCode() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchResult

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation

Returns a hash code value for this object.

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 record class org.springframework.ai.bedrock.api.AbstractBedrockApi.AmazonBedrockInvocationMetrics

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingResponse

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

hashCode() - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingResponse

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.client.ChatClientRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.client.ChatClientResponse

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.client.ResponseEntity

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.SchemaColumn

Deprecated.

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.memory.repository.mongo.Conversation

Deprecated.

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.memory.repository.mongo.Conversation.Message

Deprecated.

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.memory.repository.redis.AdvancedRedisChatMemoryRepository.MessageWithConversation

Deprecated.

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.chat.messages.AbstractMessage

hashCode() - Method in record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.messages.part.MediaPart

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.messages.part.MediaPart.MediaDto

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.messages.part.OpaquePayload

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.messages.part.ReasoningPart

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.messages.part.TextPart

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.messages.part.ToolCallPart

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.messages.part.ToolResultPart

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chat.messages.part.UnknownPart

Returns a hash code value for this object.

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.DefaultChatOptions

hashCode() - Method in class org.springframework.ai.chat.prompt.Prompt

hashCode() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.AddEmbeddingsRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Collection

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateCollectionRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateDatabaseRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateTenantRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Database

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.DeleteEmbeddingsRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Embedding

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingResponse

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingsRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryResponse

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Tenant

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.content.Media

hashCode() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion.Choice

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk.ChunkChoice

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.ChatCompletionFunction

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.ToolCall

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Thinking

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content.TopLogProbs

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.Usage

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.Usage.PromptTokensDetails

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.deepseek.api.ResponseFormat

hashCode() - Method in class org.springframework.ai.deepseek.DeepSeekAssistantMessage

Deprecated.

hashCode() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions

hashCode() - Method in class org.springframework.ai.document.Document

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.VoiceSettings

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerificationFile

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ReaderResource

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Recording

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Sample

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerificationAttempt

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerifiedVoiceLanguage

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voices

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSettings

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharingModerationCheck

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceVerification

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

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.evaluation.EvaluationRequest

hashCode() - Method in class org.springframework.ai.evaluation.EvaluationResponse

hashCode() - Method in class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting

hashCode() - Method in record class org.springframework.ai.google.genai.GoogleGenAiChatModel.GeminiRequest

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

hashCode() - Method in record class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageGenerationMetadata

hashCode() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

hashCode() - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

hashCode() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

hashCode() - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.MultiSpeakerTurn

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.ReplicatedVoice

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.SpeakerVoiceConfig

Returns a hash code value for this object.

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.mcp.annotation.context.StructuredElicitResult

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.McpMeta

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.method.changed.prompt.AsyncPromptListChangedSpecification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.method.changed.prompt.SyncPromptListChangedSpecification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.method.changed.resource.AsyncResourceListChangedSpecification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.method.changed.resource.SyncResourceListChangedSpecification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.method.changed.tool.AsyncToolListChangedSpecification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.method.changed.tool.SyncToolListChangedSpecification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.method.elicitation.AsyncElicitationSpecification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.method.elicitation.SyncElicitationSpecification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.method.logging.AsyncLoggingSpecification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.method.logging.SyncLoggingSpecification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.method.progress.AsyncProgressSpecification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.method.progress.SyncProgressSpecification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.method.sampling.AsyncSamplingSpecification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.annotation.method.sampling.SyncSamplingSpecification

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration.CloseableMcpAsyncClients

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration.CloseableMcpSyncClients

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.NamedClientMcpTransport

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpSseClientProperties.SseParameters

Deprecated.

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStdioClientProperties.Parameters

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStreamableHttpClientProperties.ConnectionParameters

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mcp.McpConnectionInfo

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion.Choice

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk.ChunkChoice

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ChatCompletionFunction

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ReferenceChunk

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.TextChunk

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ThinkChunk

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ToolCall

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

hashCode() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.Embedding

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingList

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content.TopLogProbs

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.Usage

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationResponse

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationResult

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

hashCode() - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions

hashCode() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.ExtractedImage

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPage

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPageDimensions

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.DocumentURLChunk

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.ImageURLChunk

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRResponse

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRUsageInfo

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.model.SimpleApiKey

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.model.tool.DefaultStructuredOutputChatOptions

hashCode() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions

hashCode() - Method in record class org.springframework.ai.model.tool.DefaultToolExecutionResult

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.model.tool.ToolCallDecision

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.model.tool.ToolCallDecisions

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.observation.AiOperationMetadata

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool.Function

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.CopyModelRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.DeleteModelRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsResponse

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ListModelResponse

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message.ToolCall

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message.ToolCallFunction

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model.Details

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ProgressResponse

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.PullModelRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

hashCode() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

hashCode() - Method in record class org.springframework.ai.ollama.api.ThinkOption.ThinkBoolean

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.api.ThinkOption.ThinkLevel

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.ollama.management.ModelManagementOptions

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.openai.metadata.OpenAiImageGenerationMetadata

hashCode() - Method in class org.springframework.ai.openai.metadata.OpenAiImageResponseMetadata

hashCode() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions

hashCode() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

hashCode() - Method in class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat

hashCode() - Method in record class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.openai.OpenAiChatOptions

hashCode() - Method in record class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.openai.OpenAiImageOptions

hashCode() - Method in class org.springframework.ai.openai.OpenAiModerationOptions

hashCode() - Method in record class org.springframework.ai.openai.responses.HostedTool.CodeInterpreter

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.openai.responses.HostedTool.FileSearch

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.openai.responses.HostedTool.ImageGeneration

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.openai.responses.HostedTool.Mcp

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.openai.responses.HostedTool.Raw

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.openai.responses.HostedTool.WebSearch

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

hashCode() - Method in record class org.springframework.ai.rag.Query

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.reader.pdf.config.ParagraphManager.Paragraph

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.session.compaction.CompactionBoundary

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.session.compaction.CompactionRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.session.compaction.CompactionResult

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.session.compaction.CompactionWindow

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.session.compaction.SummaryRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.session.EventFilter

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.session.EventFilter.Window.All

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.session.EventFilter.Window.Last

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.session.EventType

hashCode() - Method in class org.springframework.ai.session.SessionEvent

hashCode() - Method in record class org.springframework.ai.session.support.SessionEventCodec.EncodedEvent

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.session.support.SessionEventCodec.MessageBody

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.TextPrompts

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageResponse.Artifacts

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageResponse

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

hashCode() - Method in class org.springframework.ai.stabilityai.StabilityAiImageGenerationMetadata

hashCode() - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.Booking

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.BookingRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.Weather

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.WeatherRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Request

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Response

Returns a hash code value for this object.

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.

hashCode() - Method in record class org.springframework.ai.tool.toolsearch.ToolReference

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchRequest

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchResponse

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchResponse.SearchMetadata

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.vectorstore.azure.AzureVectorStore.MetadataField

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.SchemaColumn

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.CouchbaseDocument

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.vectorstore.EmbeddedDocument

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Expression

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Group

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Key

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Value

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder.Op

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBDocument

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.MongoDBDocument

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.OpenSearchDocument

Returns a hash code value for this object.

hashCode() - Method in record class org.springframework.ai.vectorstore.redis.RedisVectorStore.MetadataField

Returns a hash code value for this object.

hashCode() - Method in class org.springframework.ai.vectorstore.SearchRequest

hashCode() - Method in record class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.MetadataField

Returns a hash code value for this object.

hasMessage() - Method in class org.springframework.ai.session.SessionEvent

Whether the event carries a message, so that SessionEvent.getMessage() can be called: a EventType.MESSAGE event does; see EventType.canCarryMessage().

hasNextPage() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService.CachedContentPage

hasOuterQuotes(String) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Check if the given string has outer quotes.

hasPageRanges() - Method in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig

Whether any page ranges are configured.

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.

hasToolCalls() - Method in class org.springframework.ai.session.SessionEvent

Whether the event is an assistant message with tool calls; false for an event without a message.

hate(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder

hate(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder

hateAndDiscrimination() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Returns the value of the hateAndDiscrimination record component.

hateAndDiscrimination() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Returns the value of the hateAndDiscrimination record component.

hateThreatening(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder

hateThreatening(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder

headers() - Method in record class org.springframework.ai.openai.responses.HostedTool.Mcp

Returns the value of the headers record component.

headers(HttpHeaders) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.Builder

headers(HttpHeaders) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.Builder

headers(HttpHeaders) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Builder

health() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Returns the value of the health record component.

health() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Returns the value of the health record component.

health(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder

health(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder

height() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPageDimensions

Returns the value of the height record component.

height() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

Returns the value of the height record component.

height(Integer) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder

height(Integer) - Method in class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.Builder

height(Integer) - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions.Builder

height(Integer) - Method in class org.springframework.ai.image.ImageOptionsBuilder

HIGH - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.ReasoningEffort

HIGH - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiThinkingLevel

High thinking level.

HIGH - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl.ImageDetail

HIGH - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ReasoningEffort

HIGH - Enum constant in enum class org.springframework.ai.model.ollama.autoconfigure.OllamaThinkProperties

HIGH - Static variable in record class org.springframework.ai.ollama.api.ThinkOption.ThinkLevel

High thinking level for GPT-OSS.

HIGH_QUALITY - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.CategoryEnum

HIGH_QUALITY - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.CategoryEnum

highQualityBaseModelIds() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the highQualityBaseModelIds record component.

history() - Method in record class org.springframework.ai.rag.Query

Returns the value of the history record component.

history(List<Message>) - Method in class org.springframework.ai.rag.Query.Builder

history(Message...) - Method in class org.springframework.ai.rag.Query.Builder

historyItemSampleId() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the historyItemSampleId record component.

HNSW - Enum constant in enum class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore.IndexType

Use HNSW-based vector index

HNSW - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

HNSW - Enum constant in enum class org.springframework.ai.vectorstore.oracle.OracleVectorStore.OracleVectorStoreIndexType

The default type of index created for an In-Memory Neighbor Graph vector index is Hierarchical Navigable Small World (HNSW).

HNSW - Enum constant in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgIndexType

An HNSW index creates a multilayer graph.

HNSW - Enum constant in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.Algorithm

hnswEfConstruction(Integer) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the EF_CONSTRUCTION parameter for HNSW algorithm.

hnswEfRuntime(Integer) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the EF_RUNTIME parameter for HNSW algorithm.

hnswM(Integer) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the M parameter for HNSW algorithm.

HnswProperties() - Constructor for class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties.HnswProperties

hoistDefsToRoot(ObjectNode, ObjectNode) - Static method in class org.springframework.ai.util.json.schema.JsonSchemaUtils

Moves any $defs block found on subSchema into the $defs block of rootSchema, creating one on the root if needed.

horizontalRuleCreateDocument - Variable in class org.springframework.ai.reader.markdown.config.MarkdownDocumentReaderConfig

host(String) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

Sets the host for the GemFire connection.

HOSTED_TOOL_CALLS - Static variable in class org.springframework.ai.openai.responses.OpenAiResponsesMetadata

Summary of the tools OpenAI executed server-side within the request, as a list of {type, id, status} maps.

HostedTool - Interface in org.springframework.ai.openai.responses

A tool that OpenAI executes server-side, inside the same request that generates the response.

HostedTool.CodeInterpreter - Record Class in org.springframework.ai.openai.responses

Run Python in a sandboxed container.

HostedTool.FileSearch - Record Class in org.springframework.ai.openai.responses

Search vector stores hosted at OpenAI.

HostedTool.ImageGeneration - Record Class in org.springframework.ai.openai.responses

Generate images.

HostedTool.Mcp - Record Class in org.springframework.ai.openai.responses

Call tools on a remote MCP server from inside OpenAI's request.

HostedTool.Raw - Record Class in org.springframework.ai.openai.responses

A tool declared as the raw request JSON, for tools this class does not type yet.

HostedTool.WebSearch - Record Class in org.springframework.ai.openai.responses

Search the public web.

hostedTools - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

hostedTools(List<HostedTool>) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

hostedTools(HostedTool...) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

HostedTools() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools

hostnameVerifier(HostnameVerifier) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

hostnameVerifier(HostnameVerifier) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

HsqldbChatMemoryRepositoryDialect - Class in org.springframework.ai.chat.memory.repository.jdbc

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of JdbcSessionRepository in spring-ai-session-jdbc. There is no session dialect for HSQLDB yet; one is planned before 3.0.0, and until then a dialect of your own implements JdbcSessionRepositoryDialect.

HsqldbChatMemoryRepositoryDialect() - Constructor for class org.springframework.ai.chat.memory.repository.jdbc.HsqldbChatMemoryRepositoryDialect

Deprecated.

httpClientBuilderCustomizer(AnthropicHttpClientBuilderCustomizer) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder

Registers an AnthropicHttpClientBuilderCustomizer that mutates the underlying OkHttp client builder before the Anthropic clients are constructed.

httpClientBuilderCustomizer(OpenAiHttpClientBuilderCustomizer) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel.Builder

Registers an OpenAiHttpClientBuilderCustomizer that mutates the underlying OkHttp client builder before the OpenAI clients are constructed.

httpClientBuilderCustomizer(OpenAiHttpClientBuilderCustomizer) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel.Builder

Registers an OpenAiHttpClientBuilderCustomizer that mutates the underlying OkHttp client builder before the OpenAI clients are constructed.

httpClientBuilderCustomizer(OpenAiHttpClientBuilderCustomizer) - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder

Registers an OpenAiHttpClientBuilderCustomizer that mutates the underlying OkHttp client builder before the OpenAI clients are constructed.

httpClientBuilderCustomizer(OpenAiHttpClientBuilderCustomizer) - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel.Builder

Registers an OpenAiHttpClientBuilderCustomizer that mutates the underlying OkHttp client builder before the OpenAI clients are constructed.

httpClientBuilderCustomizer(OpenAiHttpClientBuilderCustomizer) - Method in class org.springframework.ai.openai.OpenAiImageModel.Builder

Registers an OpenAiHttpClientBuilderCustomizer that mutates the underlying OkHttp client builder before the OpenAI clients are constructed.

httpClientBuilderCustomizer(OpenAiHttpClientBuilderCustomizer) - Method in class org.springframework.ai.openai.OpenAiModerationModel.Builder

Registers an OpenAiHttpClientBuilderCustomizer that mutates the underlying OkHttp client builder before the OpenAI clients are constructed.

httpClientBuilderCustomizer(OpenAiHttpClientBuilderCustomizer) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatModel.Builder

Registers an OpenAiHttpClientBuilderCustomizer that mutates the underlying OkHttp client builder before the OpenAI clients are constructed.

httpClientBuilderCustomizers(List<AnthropicHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder

Sets the full list of customizers to apply, replacing any customizers registered earlier on this builder.

httpClientBuilderCustomizers(List<OpenAiHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel.Builder

Sets the full list of customizers to apply, replacing any customizers registered earlier on this builder.

httpClientBuilderCustomizers(List<OpenAiHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel.Builder

Sets the full list of customizers to apply, replacing any customizers registered earlier on this builder.

httpClientBuilderCustomizers(List<OpenAiHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder

Sets the full list of customizers to apply, replacing any customizers registered earlier on this builder.

httpClientBuilderCustomizers(List<OpenAiHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel.Builder

Sets the full list of customizers to apply, replacing any customizers registered earlier on this builder.

httpClientBuilderCustomizers(List<OpenAiHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.openai.OpenAiImageModel.Builder

Sets the full list of customizers to apply, replacing any customizers registered earlier on this builder.

httpClientBuilderCustomizers(List<OpenAiHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.openai.OpenAiModerationModel.Builder

Sets the full list of customizers to apply, replacing any customizers registered earlier on this builder.

httpClientBuilderCustomizers(List<OpenAiHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatModel.Builder

Sets the full list of customizers to apply, replacing any registered earlier on this builder.

httpHeaders(Map<String, String>) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

humidity() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Response

Returns the value of the humidity record component.

I

id() - Method in enum class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingModel

id() - Method in record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingResponse

Returns the value of the id record component.

id() - Method in enum class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingModel

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.part.MediaPart.MediaDto

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.chat.messages.part.ToolResultPart

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() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Collection

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Embedding

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.ToolCall

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ToolCall

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationResponse

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.ExtractedImage

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message.ToolCall

Returns the value of the id record component.

id() - Method in enum class org.springframework.ai.ollama.api.OllamaModel

id() - Method in record class org.springframework.ai.session.compaction.CompactionBoundary

Returns the value of the id record component.

id() - Method in class org.springframework.ai.session.CreateSessionRequest

The requested session id, or null for one the service generates.

id() - Method in class org.springframework.ai.session.Session

The session's identifier.

id() - Method in record class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.CouchbaseDocument

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBDocument

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.MongoDBDocument

Returns the value of the id record component.

id() - Method in record class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.OpenSearchDocument

Returns the value of the id record component.

id(String) - Method in class org.springframework.ai.session.CreateSessionRequest.Builder

The session id; a random UUID when unset.

id(String) - Method in class org.springframework.ai.bedrock.converse.api.StreamingToolCallBuilder

id(String) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder

id(String) - Method in class org.springframework.ai.content.Media.Builder

Sets the ID for the media object.

id(String) - Method in class org.springframework.ai.document.Document.Builder

Sets an explicit ID for the document.

id(String) - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions.Builder

id(String) - Method in class org.springframework.ai.moderation.Moderation.Builder

id(String) - Method in class org.springframework.ai.session.Session.Builder

id(String) - Method in class org.springframework.ai.session.SessionEvent.Builder

The event id; a random UUID by default.

ID - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.MediaAttributes

Deprecated.

ID - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolCallAttributes

Deprecated.

ID - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolResponseAttributes

Deprecated.

ID_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

idempotentHint() - Element in annotation interface org.springframework.ai.mcp.annotation.McpTool.McpAnnotations

If true, calling the tool repeatedly with the same arguments will have no additional effect on its environment.

identifier() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareExpressionContext

identifier() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

identifier() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.InExpressionContext

identifier() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNotNullExpressionContext

identifier() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNullExpressionContext

identifier() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NinExpressionContext

IDENTIFIER - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

IDENTIFIER - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

IDENTIFIER() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompoundIdentifierContext

IDENTIFIER() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.SimpleIdentifierContext

IDENTIFIER(int) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompoundIdentifierContext

IdentifierContext() - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IdentifierContext

IdentifierContext(ParserRuleContext, int) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IdentifierContext

idFieldName(String) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBBuilder

Configures the name of the ID field in the database.

iDFieldName(String) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore.Builder

Configures the name of the field used for document IDs.

idGenerator(IdGenerator) - Method in class org.springframework.ai.document.Document.Builder

Sets the IdGenerator used to generate the document ID when none is provided explicitly.

IdGenerator - Interface in org.springframework.ai.document.id

Interface for generating unique document IDs.

idProperty(String) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Builder

Sets the property name for document IDs.

ids() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.AddEmbeddingsRequest

Returns the value of the ids record component.

ids() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.DeleteEmbeddingsRequest

Returns the value of the ids record component.

ids() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingResponse

Returns the value of the ids record component.

ids() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingsRequest

Returns the value of the ids record component.

ids() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryResponse

Returns the value of the ids record component.

ids(List<SessionEvent>, String...) - Static method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

The ids of the events with the given labels.

idType(PgVectorStore.PgIdType) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgVectorStoreBuilder

IDX - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.MediaAttributes

Deprecated.

IDX - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolCallAttributes

Deprecated.

IDX - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolResponseAttributes

Deprecated.

image(Struct) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.MultimodalInstanceBuilder

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.bedrock.titan.BedrockTitanEmbeddingModel.InputType

IMAGE - Enum constant in enum class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityType

IMAGE - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType

AI operation type for image.

IMAGE_GIF - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for image/gif.

IMAGE_JPEG - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for image/jpeg.

IMAGE_MAP - Static variable in class org.springframework.ai.bedrock.converse.api.BedrockMediaFormat

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

IMAGE_PNG - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for image/png.

IMAGE_WEBP - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for image/webp.

imageBase64() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.ExtractedImage

Returns the value of the imageBase64 record component.

ImageBuilder() - Constructor for class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.ImageBuilder

imageBytes - Variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.ImageBuilder

Image bytes to be encoded in a base64 string.

imageBytes(byte[]) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.ImageBuilder

imageData(Object) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.ImageBuilder

ImageGeneration - Class in org.springframework.ai.image

ImageGeneration() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.ImageGeneration

ImageGeneration(String, String) - Constructor for record class org.springframework.ai.openai.responses.HostedTool.ImageGeneration

Creates an instance of a ImageGeneration record class.

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

imageLimit() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest

Returns the value of the imageLimit record component.

imageLimit(Integer) - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions.Builder

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

ImageMessage(String, Float, Collection<Media>, Map<String, Object>) - Constructor for class org.springframework.ai.image.ImageMessage

Create a new ImageMessage.

imageMinSize() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest

Returns the value of the imageMinSize record component.

imageMinSize(Integer) - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions.Builder

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

imageName() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.ImageURLChunk

Returns the value of the imageName record component.

ImageObservationAutoConfiguration - Class in org.springframework.ai.model.image.observation.autoconfigure

Auto-configuration for Spring AI image model observations.

ImageObservationAutoConfiguration() - Constructor for class org.springframework.ai.model.image.observation.autoconfigure.ImageObservationAutoConfiguration

ImageObservationProperties - Class in org.springframework.ai.model.image.observation.autoconfigure

Configuration properties for image model observations.

ImageObservationProperties() - Constructor for class org.springframework.ai.model.image.observation.autoconfigure.ImageObservationProperties

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<ImageMessage>) - Constructor for class org.springframework.ai.image.ImagePrompt

ImagePrompt(List<ImageMessage>, 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<ImageGeneration>) - Constructor for class org.springframework.ai.image.ImageResponse

Construct a new ImageResponse instance without metadata.

ImageResponse(List<ImageGeneration>, 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

ImageResponseMetadata(Long, Usage) - Constructor for class org.springframework.ai.image.ImageResponseMetadata

Create a new ImageResponseMetadata.

images() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPage

Returns the value of the images record component.

images() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message

Returns the value of the images record component.

images(List<String>) - Method in class org.springframework.ai.ollama.api.OllamaApi.Message.Builder

imageSize(String) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

imageUrl() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the imageUrl record component.

imageUrl() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk

Returns the value of the imageUrl record component.

imageUrl() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.ImageURLChunk

Returns the value of the imageUrl record component.

ImageUrl(String, MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl.ImageDetail) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl

Creates an instance of a ImageUrl record class.

ImageUrlChunk(MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk

Creates an instance of a ImageUrlChunk record class.

ImageURLChunk(String) - Constructor for record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.ImageURLChunk

Create an ImageURLChunk.

ImageURLChunk(String, String, String) - Constructor for record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.ImageURLChunk

Creates an instance of a ImageURLChunk record class.

in(String, Object...) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

in(String, List<Object>) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

IN - Enum constant in enum class org.springframework.ai.vectorstore.filter.Filter.ExpressionType

IN - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

IN - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

IN() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.InExpressionContext

IN() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NinExpressionContext

include - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

include() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingsRequest

Returns the value of the include record component.

include() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest

Returns the value of the include record component.

include(List<String>) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

includeBlockquote - Variable in class org.springframework.ai.reader.markdown.config.MarkdownDocumentReaderConfig

includeCodeBlock - Variable in class org.springframework.ai.reader.markdown.config.MarkdownDocumentReaderConfig

includeContextStrategy - Variable in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

includeContextStrategy(McpSchema.CreateMessageRequest.ContextInclusionStrategy) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

includeContextStrategy(McpSchema.CreateMessageRequest.ContextInclusionStrategy) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

includeExtendedUsageMetadata - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

includeExtendedUsageMetadata(Boolean) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

includeImageBase64() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest

Returns the value of the includeImageBase64 record component.

includeImageBase64(Boolean) - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions.Builder

includeLinkUrls - Variable in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig

includeLinkUrls(boolean) - Method in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig.Builder

Enables the inclusion of link URLs in the document metadata.

includeObfuscation() - Method in record class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions

Returns the value of the includeObfuscation record component.

includeObfuscation(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions.Builder

includeOriginal(Boolean) - Method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander.Builder

includeServerSideToolInvocations - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

includeServerSideToolInvocations(Boolean) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

includeThoughts - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

includeThoughts(Boolean) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

includeUsage() - Method in record class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions

Returns the value of the includeUsage record component.

includeUsage(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions.Builder

INCOMPLETE_REASON - Static variable in class org.springframework.ai.openai.responses.OpenAiResponsesMetadata

Why an incomplete response stopped: max_output_tokens or content_filter.

index - Variable in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgDistanceType

index() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion.Choice

Returns the value of the index record component.

index() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk.ChunkChoice

Returns the value of the index record component.

index() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.ToolCall

Returns the value of the index record component.

index() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion.Choice

Returns the value of the index record component.

index() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk.ChunkChoice

Returns the value of the index record component.

index() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ToolCall

Returns the value of the index record component.

index() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.Embedding

Returns the value of the index record component.

index() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPage

Returns the value of the index record component.

index() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message.ToolCallFunction

Returns the value of the index record component.

index(String) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.Builder

Sets the index name.

indexed() - Method in record class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.SchemaColumn

INDEXED - Enum constant in enum class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.SchemaColumnTags

indexedAttributes(Set<String>) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository.Builder

The metadata keys indexed in AI_SESSION_INDEX, so that JdbcSessionRepository.findByMetadata(java.lang.String, java.lang.String) answers for them; the JdbcSessionRepository.DEFAULT_INDEXED_ATTRIBUTES, the principal, are always indexed.

indexExists() - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore

indexExists() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

Checks if the index exists in the GemFireVectorStore.

indexName(String) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

Sets the index name.

indexName(String) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig.Builder

Deprecated.

Sets the index name.

indexName(String) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository.Builder

Deprecated.

Sets the index name.

indexName(String) - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore.Builder

Sets the index name for the Azure Vector Store.

indexName(String) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

Sets the index name.

indexName(String) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Builder

Sets the name of the vector index.

indexName(String) - Method in interface org.springframework.ai.vectorstore.pinecone.PineconeVectorStore.Builder.BuilderWithIndexName

Sets the index name and returns the builder for optional configuration.

indexName(String) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache.Builder

indexName(String) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the Redis index name.

indexName(String) - Method in class org.springframework.ai.vectorstore.s3.S3VectorStore.Builder

indexOptimization(CouchbaseIndexOptimization) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.Builder

Choose to prioritize accuracy or latency.

indexParameters(String) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore.Builder

Configures the Milvus index parameters as a JSON string.

indexTool(String, ToolReference) - Method in class org.springframework.ai.tool.toolsearch.index.lucene.LuceneToolIndex

indexTool(String, ToolReference) - Method in class org.springframework.ai.tool.toolsearch.index.regex.RegexToolIndex

indexTool(String, ToolReference) - Method in class org.springframework.ai.tool.toolsearch.index.vectorstore.VectorToolIndex

indexTool(String, ToolReference) - Method in interface org.springframework.ai.tool.toolsearch.ToolIndex

Registers a tool in the search index for the specified session.

indexTools(String, List<ToolReference>) - Method in class org.springframework.ai.tool.toolsearch.index.lucene.LuceneToolIndex

indexTools(String, List<ToolReference>) - Method in class org.springframework.ai.tool.toolsearch.index.regex.RegexToolIndex

indexTools(String, List<ToolReference>) - Method in class org.springframework.ai.tool.toolsearch.index.vectorstore.VectorToolIndex

indexTools(String, List<ToolReference>) - Method in interface org.springframework.ai.tool.toolsearch.ToolIndex

Registers multiple tools in the search index for the specified session in a single batch operation.

indexType(IndexType) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore.Builder

Configures the Milvus index type to use for vector search optimization.

indexType(CoherenceVectorStore.IndexType) - Method in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore.Builder

Sets the index type for vector storage.

indexType(OracleVectorStore.OracleVectorStoreIndexType) - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore.Builder

Sets the vector index type.

indexType(PgVectorStore.PgIndexType) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgVectorStoreBuilder

InExpressionContext(FiltersParser.BooleanExpressionContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.InExpressionContext

INFERENCE - Enum constant in enum class org.springframework.ai.document.MetadataMode

inferenceGeo(String) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

Sets the geographic region for inference processing.

info(String) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

info(String) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

info(String) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

info(String) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

initCluster() - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore

initializeImmediately(boolean) - Method in class org.springframework.ai.chroma.vectorstore.ChromaVectorStore.Builder

Sets whether to initialize immediately.

initializeResult() - Method in record class org.springframework.ai.mcp.McpConnectionInfo

Returns the value of the initializeResult record component.

initializeResult(McpSchema.InitializeResult) - Method in class org.springframework.ai.mcp.McpConnectionInfo.Builder

Sets the initialize result.

initializeSchema(boolean) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig.Builder

Deprecated.

Sets whether to initialize the schema.

initializeSchema(boolean) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository.Builder

Deprecated.

Sets whether to initialize the schema.

initializeSchema(boolean) - Method in class org.springframework.ai.chroma.vectorstore.ChromaVectorStore.Builder

Sets whether to initialize the schema.

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore.Builder

Sets whether to initialize the schema.

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

Sets whether to initialize the schema.

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.Builder

Sets whether to initialize the schema.

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore.Builder

Sets whether to initialize the schema.

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

Sets whether to initialize the schema.

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBBuilder

Configures whether to initialize the database schema.

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore.Builder

Configures whether to initialize the collection schema automatically.

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.Builder

Sets whether to initialize the schema.

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Builder

Sets whether to initialize the schema.

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.Builder

Sets whether to initialize the schema.

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore.Builder

Sets whether to initialize the database schema.

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgVectorStoreBuilder

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore.Builder

Configures whether to initialize the collection schema.

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets whether to initialize the schema.

initializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore.Builder

Configures whether to initialize the collection schema automatically.

initIndicesAfterStartup() - Method in class org.springframework.ai.model.chat.memory.repository.mongo.autoconfigure.MongoChatMemoryIndexCreatorAutoConfiguration

Deprecated.

Initializes MongoDB indices after application context refresh.

InMemoryChatMemoryRepository - Class in org.springframework.ai.chat.memory

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of org.springframework.ai.session.SessionRepository in spring-ai-session

InMemoryChatMemoryRepository() - Constructor for class org.springframework.ai.chat.memory.InMemoryChatMemoryRepository

Deprecated.

InMemorySessionRepository - Class in org.springframework.ai.session

A thread-safe SessionRepository in memory, for tests and demos: the sessions are lost on restart and not shared across instances.

InMemorySessionRepository.Builder - Class in org.springframework.ai.session

Builds an InMemorySessionRepository.

inOrder(boolean) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets whether terms in text search should appear in order.

input() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingRequest

Returns the value of the input record component.

input() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsRequest

Returns the value of the input record component.

input(String) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder

INPUT - Enum constant in enum class org.springframework.ai.observation.conventions.AiTokenType

Input token.

inputImage() - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingRequest

Returns the value of the inputImage record component.

inputImage(String) - Method in class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingRequest.Builder

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

inputText() - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingRequest

Returns the value of the inputText record component.

inputText(String) - Method in class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingRequest.Builder

inputTextTokenCount() - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingResponse

Returns the value of the inputTextTokenCount record component.

inputTokenCount() - Method in record class org.springframework.ai.bedrock.api.AbstractBedrockApi.AmazonBedrockInvocationMetrics

Returns the value of the inputTokenCount record component.

inputType() - Method in record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest

Returns the value of the inputType record component.

inputType(CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType) - Method in class org.springframework.ai.bedrock.cohere.BedrockCohereEmbeddingOptions.Builder

inputType(Type) - Method in class org.springframework.ai.tool.function.FunctionToolCallback.Builder

inputType(BedrockTitanEmbeddingModel.InputType) - Method in class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingOptions.Builder

inputType(ParameterizedTypeReference<?>) - Method in class org.springframework.ai.tool.function.FunctionToolCallback.Builder

insecure() - Method in record class org.springframework.ai.ollama.api.OllamaApi.PullModelRequest

Returns the value of the insecure record component.

instagramUsername() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the instagramUsername record component.

INSTANCE - Static variable in class org.springframework.ai.tool.toolsearch.eviction.AlwaysEvictStrategy

Shared singleton instance.

INSTANCE - Static variable in class org.springframework.ai.tool.toolsearch.eviction.NeverEvictStrategy

Shared singleton instance.

INSTANCE - Static variable in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.DescriptiveErrorListener

instantiateAvailableModules() - Static method in class org.springframework.ai.util.JacksonUtils

Return the Jackson modules found by MapperBuilder.findModules(ClassLoader) using JDK ServiceLoader facility.

instructions(String) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder

Sets control instructions for the voice delivery (e.g. tone, pace).

int32(String) - Static method in record class org.springframework.ai.vectorstore.azure.AzureVectorStore.MetadataField

int64(String) - Static method in record class org.springframework.ai.vectorstore.azure.AzureVectorStore.MetadataField

INTEGER - Enum constant in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgIdType

INTEGER_VALUE - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

INTEGER_VALUE - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

INTEGER_VALUE() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IntegerConstantContext

INTEGER_VALUE() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.LongConstantContext

IntegerConstantContext(FiltersParser.ConstantContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IntegerConstantContext

intelligencePriority(Double) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec.DefaultModelPreferenceSpec

intelligencePriority(Double) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.ModelPreferenceSpec

interceptor(Interceptor) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

Adds an OkHttp application interceptor.

interceptor(Interceptor) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

Registers an OkHttp Interceptor to run at the end of the chain.

internalCall(Prompt, ChatResponse) - Method in class org.springframework.ai.anthropic.AnthropicChatModel

Internal method to handle synchronous chat completion calls with tool execution support.

internalInvocation(I, Class<O>) - Method in class org.springframework.ai.bedrock.api.AbstractBedrockApi

Internal method to invoke the model and return the response.

internalInvocationStream(I, Class<SO>) - Method in class org.springframework.ai.bedrock.api.AbstractBedrockApi

Internal method to invoke the model and return the response stream.

internalStream(Prompt, ChatResponse) - Method in class org.springframework.ai.anthropic.AnthropicChatModel

Internal method to handle streaming chat completion calls with tool execution support.

intervalSec - Variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

The interval of the video the embedding will be generated.

intervalSec(Integer) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

INVALID - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

INVALID - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusMetricType

Invalid metric type

INVALID_EMBEDDING_DIMENSION - Static variable in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

INVALID_EMBEDDING_DIMENSION - Static variable in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

INVALID_EMBEDDING_DIMENSION - Static variable in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

INVALID_EMBEDDING_DIMENSION - Static variable in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

invalidateCache() - Method in class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider

Invalidates the cached tool callbacks, forcing re-discovery on next request.

invalidateCache() - Method in class org.springframework.ai.mcp.SyncMcpToolCallbackProvider

Invalidates the cached tool callbacks, forcing re-discovery on next request.

invocationLatency() - Method in record class org.springframework.ai.bedrock.api.AbstractBedrockApi.AmazonBedrockInvocationMetrics

Returns the value of the invocationLatency record component.

IP - Enum constant in enum class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore.DistanceType

Inner product.

IP - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusMetricType

Inner product

IP - Enum constant in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.DistanceMetric

IS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

IS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

IS() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNotNullExpressionContext

IS() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNullExpressionContext

isAllowedToFineTune() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns the value of the isAllowedToFineTune record component.

isAllowSystemMessages() - Method in class org.springframework.ai.model.session.autoconfigure.SessionServiceProperties

isAutoId() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

isAwaitingDecision(ChatResponse) - Static method in record class org.springframework.ai.model.tool.ToolCallDecisions

Whether the response is a paused one, with tool calls waiting for a decision.

isBlockedAddress(InetAddress) - Static method in class org.springframework.ai.bedrock.converse.api.URLValidator

Returns true if the given address is a loopback, link-local, site-local, or wildcard address.

isCacheToolResults() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions

Whether a cache_control breakpoint is placed on the last tool result message of a request, so that tool outputs are written to (and read from) the cache across tool-calling rounds.

isCacheToolResults() - Method in class org.springframework.ai.bedrock.converse.api.BedrockCacheOptions

Returns whether prompt caching is enabled for tool result messages.

isCacheToolResults() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockCacheProperties

isCachingEnabled() - Method in class org.springframework.ai.anthropic.CacheEligibilityResolver

isCitationsEnabled() - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument

isCompletion() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.Capabilities

isConnectionPoolMetricsEnabled() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

isConnectionPoolMetricsEnabled() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

isConversationHistoryEnabled() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder

Returns whether internal conversation history is enabled.

isCopyContentFormatter() - Method in class org.springframework.ai.transformer.splitter.TextSplitter

isCreateExtension() - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

isCreateIndices() - Method in class org.springframework.ai.model.chat.memory.repository.mongo.autoconfigure.MongoChatMemoryProperties

Deprecated.

isCriminal() - Method in class org.springframework.ai.moderation.Categories

isDangerous() - Method in class org.springframework.ai.moderation.Categories

isDangerousAndCriminalContent() - Method in class org.springframework.ai.moderation.Categories

Deprecated, for removal: This API element is subject to removal in a future version.

isDiarizedJsonWorkaroundEnabled() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

Whether the diarized_json misclassification workaround is applied.

isDisallowDelete() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerStreamableHttpProperties

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.

isEnabled() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

isEnabled() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.annotations.McpClientAnnotationScannerProperties

isEnabled() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

isEnabled() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties.Toolcallback

isEnabled() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.annotations.McpServerAnnotationScannerProperties

isEnabled() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

isEnabled() - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties

isEnabled() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

isEnabled() - Method in class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties

isEnabled() - Method in class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties.ToolCalling

isEnabled() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

isEnabled() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.CodeInterpreter

isEnabled() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.ImageGeneration

isEnabled() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.WebSearch

isEnabled() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Confirmation

isEnabled() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Resolution.Fallback

isEnabled() - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Cache

isEnabled() - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure.RedisSemanticCacheProperties

isEnableNative() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultEntityParamSpec

isError() - Method in record class org.springframework.ai.chat.messages.part.ToolResultPart

Returns the value of the isError record component.

isExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

Checks if a parameter type is compatible with the exchange type.

isExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.resource.AsyncMcpResourceMethodCallback

Checks if a parameter type is compatible with the exchange type.

isExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.resource.AsyncStatelessMcpResourceMethodCallback

Checks if a parameter type is compatible with the exchange type.

isExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.resource.SyncMcpResourceMethodCallback

isExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.resource.SyncStatelessMcpResourceMethodCallback

isExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractAsyncMcpToolMethodCallback

Determines if the given parameter type is an exchange or context type that should be injected.

isExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractMcpToolMethodCallback

Determines if the given parameter type is an exchange or context type that should be injected.

isExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.tool.AsyncMcpToolMethodCallback

isExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.tool.AsyncStatelessMcpToolMethodCallback

isExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.tool.SyncMcpToolMethodCallback

isExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.tool.SyncStatelessMcpToolMethodCallback

isExchangeType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback

Checks if a parameter type is compatible with the exchange type.

isExchangeType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.complete.AsyncMcpCompleteMethodCallback

Checks if a parameter type is compatible with the exchange type.

isExchangeType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.complete.AsyncStatelessMcpCompleteMethodCallback

Checks if a parameter type is compatible with the exchange type.

isExchangeType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.complete.SyncMcpCompleteMethodCallback

Checks if a parameter type is compatible with the exchange type.

isExchangeType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.complete.SyncStatelessMcpCompleteMethodCallback

Checks if a parameter type is compatible with the exchange type.

isExchangeType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback

Checks if a parameter type is compatible with the exchange type.

isExchangeType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.elicitation.AsyncMcpElicitationMethodCallback

Checks if a parameter type is compatible with the exchange type.

isExchangeType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.elicitation.SyncMcpElicitationMethodCallback

Checks if a parameter type is compatible with the exchange type.

isExchangeType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback

Checks if a parameter type is compatible with the exchange type.

isExchangeType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.sampling.AsyncMcpSamplingMethodCallback

Checks if a parameter type is compatible with the exchange type.

isExchangeType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.sampling.SyncMcpSamplingMethodCallback

Checks if a parameter type is compatible with the exchange type.

isExpired() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

Checks if the cached content has expired.

isExposeMcpClientTools() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

isFinancial() - Method in class org.springframework.ai.moderation.Categories

isFlagged() - Method in class org.springframework.ai.moderation.ModerationResult

isForcedNormalization() - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

isGitHubModels - Variable in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

isGitHubModels - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

isGitHubModels() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

isGitHubModels() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions

isGitHubModels() - Method in class org.springframework.ai.openai.OpenAiChatOptions

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

isInclude() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties.ModelTypeInit

isIncludeContent() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Observations

isIncludeErrorLogging() - Method in class org.springframework.ai.model.chat.observation.autoconfigure.ChatObservationProperties

isInitialized() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

isInitializeSchema() - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig

Deprecated.

isInitializeSchema() - Method in class org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure.CassandraChatMemoryRepositoryProperties

Deprecated.

isInitializeSchema() - Method in class org.springframework.ai.vectorstore.properties.CommonVectorStoreProperties

isJailbreaking() - Method in class org.springframework.ai.moderation.Categories

isLaw() - Method in class org.springframework.ai.moderation.Categories

isLegacy() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the isLegacy record component.

isLogCompletion() - Method in class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties.Observations

isLogCompletion() - Method in class org.springframework.ai.model.chat.observation.autoconfigure.ChatObservationProperties

isLogPrompt() - Method in class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties.Observations

isLogPrompt() - Method in class org.springframework.ai.model.chat.observation.autoconfigure.ChatObservationProperties

isLogPrompt() - Method in class org.springframework.ai.model.image.observation.autoconfigure.ImageObservationProperties

isLogQueryResponse() - Method in class org.springframework.ai.vectorstore.observation.autoconfigure.VectorStoreObservationProperties

isLogText() - Method in class org.springframework.ai.model.audio.observation.autoconfigure.AudioSpeechObservationProperties

isLogTranscript() - Method in class org.springframework.ai.model.audio.observation.autoconfigure.AudioTranscriptionObservationProperties

isMicrosoftFoundry - Variable in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

isMicrosoftFoundry - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

isMicrosoftFoundry - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

isMicrosoftFoundry() - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

isMicrosoftFoundry() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions

isMicrosoftFoundry() - Method in class org.springframework.ai.openai.OpenAiChatOptions

isMicrosoftFoundry() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

isMixed() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the isMixed record component.

isModelAvailable(String) - Method in class org.springframework.ai.ollama.management.OllamaModelManager

isMultiBlockSystemCaching() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions

isMultiBlockSystemCaching() - Method in class org.springframework.ai.bedrock.converse.api.BedrockCacheOptions

Returns whether multi-block system message caching is enabled.

isNotNull(String) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

ISNOTNULL - Enum constant in enum class org.springframework.ai.vectorstore.filter.Filter.ExpressionType

IsNotNullExpressionContext(FiltersParser.BooleanExpressionContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNotNullExpressionContext

isNotReactiveReturnType - Static variable in class org.springframework.ai.mcp.annotation.common.McpPredicates

isNull(String) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

ISNULL - Enum constant in enum class org.springframework.ai.vectorstore.filter.Filter.ExpressionType

IsNullExpressionContext(FiltersParser.BooleanExpressionContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNullExpressionContext

ISO_DATE_FORMATTER - Static variable in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Formatter for parsing and normalizing ISO date strings.

ISO_DATE_PATTERN - Static variable in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Pattern for ISO-8601 date strings in UTC (yyyy-MM-dd'T'HH:mm:ss'Z') used to recognize and normalize date strings before passing to converters.

ISOMETRIC - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

isOnClientErrors() - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties

isOwner() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the isOwner record component.

isPageSelected(int) - Method in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig

Whether the given one-based page number should be read.

isPartial(MessagePart) - Static method in class org.springframework.ai.chat.messages.part.StreamingParts

Whether a streamed part is a delta.

isPass() - Method in class org.springframework.ai.evaluation.EvaluationResponse

isPii() - Method in class org.springframework.ai.moderation.Categories

isPrompt() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.Capabilities

isPromptChangeNotification() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerChangeNotificationProperties

isReactiveReturnType - Static variable in class org.springframework.ai.mcp.annotation.common.McpPredicates

isReactiveReturnTypeOfCallToolResult(Method) - Static method in class org.springframework.ai.mcp.annotation.method.tool.ReactiveUtils

Check if the given type is a reactive type containing CallToolResult (e.g., Mono, Flux, Publisher)

isReactiveReturnTypeOfVoid(Method) - Static method in class org.springframework.ai.mcp.annotation.method.tool.ReactiveUtils

Check if the given type is a reactive type containing Void (e.g., Mono, Flux, Publisher)

isReferenceToolNameAccumulation() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

isRemoveExistingVectorStoreTable() - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

isRemoveExistingVectorStoreTable() - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

isRemoveExistingVectorStoreTable() - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

isResource() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.Capabilities

isResourceChangeNotification() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerChangeNotificationProperties

isRootChangeNotification() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

isSchemaValidation() - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

isSchemaValidation() - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

isSecure() - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

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

isSslEnabled() - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

isStdio() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

isStream() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext

isStreaming() - Method in class org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationContext

Whether the request was made in streaming mode.

isStreaming() - Method in class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationContext

Whether the request was made in streaming mode.

isStreaming() - Method in class org.springframework.ai.chat.observation.ChatModelObservationContext

isStreamingDone(OllamaApi.ChatResponse) - Static method in class org.springframework.ai.ollama.api.OllamaApiHelper

isStreamingToolCall(OllamaApi.ChatResponse) - Static method in class org.springframework.ai.ollama.api.OllamaApiHelper

isStreamingToolFunctionCall(DeepSeekApi.ChatCompletionChunk) - Method in class org.springframework.ai.deepseek.api.DeepSeekStreamFunctionCallingHelper

isStreamingToolFunctionCall(MistralAiApi.ChatCompletionChunk) - Method in class org.springframework.ai.mistralai.api.MistralAiStreamFunctionCallingHelper

isStreamingToolFunctionCallFinish(DeepSeekApi.ChatCompletionChunk) - Method in class org.springframework.ai.deepseek.api.DeepSeekStreamFunctionCallingHelper

isStreamingToolFunctionCallFinish(MistralAiApi.ChatCompletionChunk) - Method in class org.springframework.ai.mistralai.api.MistralAiStreamFunctionCallingHelper

isSupportedDocumentFormat(MimeType) - Static method in class org.springframework.ai.bedrock.converse.api.BedrockMediaFormat

isSupportedExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback

Checks if a parameter type is compatible with the exchange type.

isSupportedExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AsyncMcpPromptMethodCallback

isSupportedExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AsyncStatelessMcpPromptMethodCallback

isSupportedExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.prompt.SyncMcpPromptMethodCallback

isSupportedExchangeOrContextType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.prompt.SyncStatelessMcpPromptMethodCallback

isSupportedImageFormat(MimeType) - Static method in class org.springframework.ai.bedrock.converse.api.BedrockMediaFormat

isSupportedVideoFormat(MimeType) - Static method in class org.springframework.ai.bedrock.converse.api.BedrockMediaFormat

isSynthetic() - Method in class org.springframework.ai.session.SessionEvent

Whether a compaction wrote this event, a summary rather than something a participant said.

isText() - Method in class org.springframework.ai.document.Document

Determines whether this document contains text or media content.

isThrowExceptionOnError() - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties

isTool() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.Capabilities

isToolCallResponse(ChatResponse) - Method in interface org.springframework.ai.model.tool.ToolExecutionEligibilityChecker

Determines if the response is a tool call message response.

isToolChangeNotification() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerChangeNotificationProperties

isTurnStart() - Method in class org.springframework.ai.session.SessionEvent

Whether the event starts a turn: a MessageType.USER message event.

isUnchanged() - Method in record class org.springframework.ai.session.compaction.CompactionResult

Whether no event leaves the view, so there is nothing to record.

isUriTemplate(String) - Static method in class org.springframework.ai.mcp.annotation.common.McpPredicates

isUseKeylessAuth() - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

isUseTls() - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

isUsingBasicAuthentication() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

isUsingTokenAuthentication() - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

isValidated() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultEntityParamSpec

isValidPattern(String) - Method in class org.springframework.ai.tool.toolsearch.index.regex.RegexToolIndex

Validates a regex pattern without performing a search.

isValidURLBasic(String) - Static method in class org.springframework.ai.bedrock.converse.api.URLValidator

Deprecated.

This method is not sufficient for security-sensitive URL validation and should not be relied upon for security-critical checks. Use URLValidator.isValidURLStrict(String) instead for robust validation.

isValidURLStrict(String) - Static method in class org.springframework.ai.bedrock.converse.api.URLValidator

Thorough validation using URL class More comprehensive but might be slower Validates protocol, host, port, and basic structure

isVerified() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceVerification

Returns the value of the isVerified record component.

isVertexAi() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiConnectionProperties

isVertexAi() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiEmbeddingConnectionProperties

isVertexAi() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageConnectionProperties

isVertexAi() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionConnectionProperties

isViolence() - Method in class org.springframework.ai.moderation.Categories

isViolenceGraphic() - Method in class org.springframework.ai.moderation.Categories

ITEM_ID_ATTRIBUTE - Static variable in class org.springframework.ai.openai.responses.OpenAiResponsesMetadata

Part attribute holding the id of the output item a part was mapped from, e.g.

ITEM_STATUS_ATTRIBUTE - Static variable in class org.springframework.ai.openai.responses.OpenAiResponsesMetadata

Part attribute holding the status of the output item a part was mapped from: in_progress, completed or incomplete.

IVF - Enum constant in enum class org.springframework.ai.vectorstore.oracle.OracleVectorStore.OracleVectorStoreIndexType

The default type of index created for a Neighbor Partition vector index is Inverted File Flat (IVF) vector index.

IVF_FLAT - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

IVF_PQ - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

IVF_SQ8 - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

IVFFLAT - Enum constant in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgIndexType

An IVFFlat index divides vectors into lists, and then searches a subset of those lists that are closest to the query vector.

J

JACCARD - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusMetricType

Jaccard distance

JacksonUtils - Class in org.springframework.ai.util

Utility methods for Jackson.

JacksonUtils() - Constructor for class org.springframework.ai.util.JacksonUtils

jailbreaking() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Returns the value of the jailbreaking record component.

jailbreaking() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Returns the value of the jailbreaking record component.

jailbreaking(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder

jailbreaking(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder

javaType() - Method in record class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.SchemaColumn

Deprecated.

javaType() - Method in record class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.SchemaColumn

JdbcChatMemoryRepository - Class in org.springframework.ai.chat.memory.repository.jdbc

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of JdbcSessionRepository in spring-ai-session-jdbc

JdbcChatMemoryRepository.Builder - Class in org.springframework.ai.chat.memory.repository.jdbc

Deprecated.

JdbcChatMemoryRepositoryAutoConfiguration - Class in org.springframework.ai.model.chat.memory.repository.jdbc.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of JdbcSessionRepositoryAutoConfiguration in spring-ai-autoconfigure-model-session-jdbc

JdbcChatMemoryRepositoryAutoConfiguration() - Constructor for class org.springframework.ai.model.chat.memory.repository.jdbc.autoconfigure.JdbcChatMemoryRepositoryAutoConfiguration

Deprecated.

JdbcChatMemoryRepositoryDialect - Interface in org.springframework.ai.chat.memory.repository.jdbc

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of JdbcSessionRepositoryDialect in spring-ai-session-jdbc

JdbcChatMemoryRepositoryProperties - Class in org.springframework.ai.model.chat.memory.repository.jdbc.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of JdbcSessionRepositoryProperties in spring-ai-autoconfigure-model-session-jdbc

JdbcChatMemoryRepositoryProperties() - Constructor for class org.springframework.ai.model.chat.memory.repository.jdbc.autoconfigure.JdbcChatMemoryRepositoryProperties

Deprecated.

JdbcSessionRepository - Class in org.springframework.ai.session.jdbc

The SessionRepository on a relational database: AI_SESSION (id, expiry, metadata JSON, event version), AI_SESSION_INDEX (the indexed metadata attributes, one row per attribute) and AI_SESSION_EVENT (the log, ordered by a database-assigned seq).

JdbcSessionRepository.Builder - Class in org.springframework.ai.session.jdbc

Builds a JdbcSessionRepository on a DataSource or a JdbcTemplate; everything else has a default.

JdbcSessionRepositoryAutoConfiguration - Class in org.springframework.ai.model.session.jdbc.autoconfigure

Auto-configuration of the JdbcSessionRepository on the single DataSource bean, and of the schema initialization.

JdbcSessionRepositoryAutoConfiguration() - Constructor for class org.springframework.ai.model.session.jdbc.autoconfigure.JdbcSessionRepositoryAutoConfiguration

JdbcSessionRepositoryDialect - Interface in org.springframework.ai.session.jdbc

The SQL that differs between databases, for JdbcSessionRepository: the upsert and the insert-if-absent of a session.

JdbcSessionRepositoryProperties - Class in org.springframework.ai.model.session.jdbc.autoconfigure

The properties of the JDBC session repository, under spring.ai.session.repository.jdbc: Spring Boot's schema initialization settings and the indexed attributes.

JdbcSessionRepositoryProperties() - Constructor for class org.springframework.ai.model.session.jdbc.autoconfigure.JdbcSessionRepositoryProperties

jdbcTemplate(JdbcTemplate) - Method in class org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepository.Builder

Deprecated.

jdbcTemplate(JdbcTemplate) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository.Builder

A configured JdbcTemplate, instead of one on the data source.

JdkSha256HexIdGenerator - Class in org.springframework.ai.document.id

A SHA-256 based ID generator that returns the hash as a UUID.

JdkSha256HexIdGenerator() - Constructor for class org.springframework.ai.document.id.JdkSha256HexIdGenerator

JdkSha256HexIdGenerator(String, Charset) - Constructor for class org.springframework.ai.document.id.JdkSha256HexIdGenerator

jedisClient(RedisChatMemoryRepositoryProperties) - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryAutoConfiguration

Deprecated.

jedisClient(JedisConnectionFactory) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure.RedisSemanticCacheAutoConfiguration

Creates a RedisClient client for Redis connections, honoring the SSL, password, client name, and timeout settings from the JedisConnectionFactory.

jedisClient(RedisClient) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig.Builder

Deprecated.

Sets the Redis client.

jedisClient(RedisClient) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository.Builder

Deprecated.

Sets the RedisClient client.

jedisClient(RedisClient) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache.Builder

join(Map<Query, List<List<Document>>>) - Method in class org.springframework.ai.rag.retrieval.join.ConcatenationDocumentJoiner

join(Map<Query, List<List<Document>>>) - Method in interface org.springframework.ai.rag.retrieval.join.DocumentJoiner

Joins documents retrieved across multiple queries and daa sources.

JSON_OBJECT - Enum constant in enum class org.springframework.ai.deepseek.api.ResponseFormat.Type

Enables JSON mode, which guarantees the message the model generates is valid JSON.

JSON_OBJECT - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.Type

Enables JSON mode, which guarantees the message the model generates is valid JSON.

JSON_OBJECT - Enum constant in enum class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat.Type

Enables JSON mode, which guarantees the message the model generates is valid JSON.

JSON_SCHEMA - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.Type

Enables Structured Outputs which guarantees the model will match your supplied JSON schema.

JSON_SCHEMA - Enum constant in enum class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat.Type

Enables Structured Outputs which guarantees the model will match your supplied JSON schema.

JSON_SCHEMA - Enum constant in enum class org.springframework.ai.util.json.schema.SchemaType

JSON schema.

JsonHelper - Class in org.springframework.ai.util

Helper for JSON processing.

JsonHelper() - Constructor for class org.springframework.ai.util.JsonHelper

JsonHelper(JsonMapper) - Constructor for class org.springframework.ai.util.JsonHelper

jsonMapper - Variable in class org.springframework.ai.mcp.annotation.provider.tool.AbstractMcpToolProvider

jsonMapper - Variable in class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport

Deprecated.

JSON mapper for serializing outbound messages and deserializing inbound messages.

jsonMapper(McpJsonMapper) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebClientStreamableHttpTransport.Builder

Configure the McpJsonMapper to use.

jsonMapper(McpJsonMapper) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport.Builder

Deprecated.

Sets the JSON mapper for serialization/deserialization.

jsonMapper(McpJsonMapper) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider.Builder

Deprecated.

Sets the McpJsonMapper to use for JSON serialization/deserialization of MCP messages.

jsonMapper(McpJsonMapper) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStatelessServerTransport.Builder

Sets the JsonMapper to use for JSON serialization/deserialization of MCP messages.

jsonMapper(McpJsonMapper) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider.Builder

Sets the McpJsonMapper to use for JSON serialization/deserialization of MCP messages.

jsonMapper(McpJsonMapper) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider.Builder

Deprecated.

Sets the JSON object mapper to use for message serialization/deserialization.

jsonMapper(McpJsonMapper) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStatelessServerTransport.Builder

Sets the ObjectMapper to use for JSON serialization/deserialization of MCP messages.

jsonMapper(McpJsonMapper) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider.Builder

Sets the McpJsonMapper to use for JSON serialization/deserialization of MCP messages.

jsonMapper(JsonMapper) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder

Sets the JsonMapper used for JSON parsing and validation.

jsonMapper(JsonMapper) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi.Builder

jsonMapper(JsonMapper) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository.Builder

The mapper of the metadata and payload JSON; JsonMapper.builder().build() by default.

JsonMetadataGenerator - Interface in org.springframework.ai.reader

jsonObject() - Static method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

Creates a ResponseFormat for JSON object output (JSON mode).

JsonParser - Class in org.springframework.ai.util.json

Deprecated, for removal: This API element is subject to removal in a future version.

Use JacksonUtils or JsonHelper instead

JsonReader - Class in org.springframework.ai.reader

A class that reads JSON documents and converts them into a list of Document objects.

JsonReader(Resource) - Constructor for class org.springframework.ai.reader.JsonReader

JsonReader(Resource, String...) - Constructor for class org.springframework.ai.reader.JsonReader

JsonReader(Resource, JsonMetadataGenerator, String...) - Constructor for class org.springframework.ai.reader.JsonReader

jsonSchema(Class<?>) - Static method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

Creates a ResponseFormat for JSON schema output with automatic schema generation from a class.

jsonSchema(String) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.Builder

jsonSchema(String) - Static method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

Creates a ResponseFormat for JSON schema output with a JSON schema string.

jsonSchema(String) - Method in class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat.Builder

jsonSchema(Map<String, Object>) - Static method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

Creates a ResponseFormat for JSON schema output with a JSON schema map.

jsonSchema(MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.Builder

JsonSchema() - Constructor for class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema

JsonSchemaConverter - Class in org.springframework.ai.google.genai.schema

Utility class for converting JSON Schema to OpenAPI schema format.

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.

jsonToValue(String) - Static method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils

JsoupDocumentReader - Class in org.springframework.ai.reader.jsoup

Reads HTML documents and extracts text content using JSoup.

JsoupDocumentReader(String) - Constructor for class org.springframework.ai.reader.jsoup.JsoupDocumentReader

JsoupDocumentReader(String, JsoupDocumentReaderConfig) - Constructor for class org.springframework.ai.reader.jsoup.JsoupDocumentReader

JsoupDocumentReader(Resource) - Constructor for class org.springframework.ai.reader.jsoup.JsoupDocumentReader

JsoupDocumentReader(Resource, JsoupDocumentReaderConfig) - Constructor for class org.springframework.ai.reader.jsoup.JsoupDocumentReader

JsoupDocumentReaderConfig - Class in org.springframework.ai.reader.jsoup.config

Common configuration for the JsoupDocumentReader.

JsoupDocumentReaderConfig.Builder - Class in org.springframework.ai.reader.jsoup.config

JTokkitTokenCountEstimator - Class in org.springframework.ai.tokenizer

Estimates the number of tokens in a given text or message using the JTokkit encoding library.

JTokkitTokenCountEstimator() - Constructor for class org.springframework.ai.tokenizer.JTokkitTokenCountEstimator

Creates a new JTokkitTokenCountEstimator with default CL100K_BASE encoding.

JTokkitTokenCountEstimator(EncodingType) - Constructor for class org.springframework.ai.tokenizer.JTokkitTokenCountEstimator

Creates a new JTokkitTokenCountEstimator with the specified encoding type.

K

keepAlive - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

keepAlive() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest

Returns the value of the keepAlive record component.

keepAlive() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsRequest

Returns the value of the keepAlive record component.

keepAlive(String) - Method in class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

keepAlive(String) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

keepAlive(String) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

keepAliveDuration(Duration) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

keepAliveDuration(Duration) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

keepAliveInterval(Duration) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider.Builder

Deprecated.

Sets the interval for sending keep-alive pings to clients.

keepAliveInterval(Duration) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider.Builder

Sets the keep-alive interval for the server transport.

keepAliveInterval(Duration) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider.Builder

Deprecated.

Sets the interval for keep-alive pings.

keepAliveInterval(Duration) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider.Builder

Sets the keep-alive interval for the transport.

key() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Key

Returns the value of the key record component.

Key(String) - Constructor for record class org.springframework.ai.vectorstore.filter.Filter.Key

Creates an instance of a Key record class.

keyPrefix(String) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig.Builder

Deprecated.

Sets the key prefix.

keyPrefix(String) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository.Builder

Deprecated.

Sets the key prefix.

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

keyspace(String) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

Sets the keyspace name.

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

kind() - Method in record class org.springframework.ai.chat.messages.part.OpaquePayload

Returns the value of the kind record component.

kind() - Method in record class org.springframework.ai.chat.messages.part.UnknownPart

Returns the value of the kind record component.

knownSpeakerNames(List<String>) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder

Speaker identifiers (up to 4), positionally matching OpenAiAudioTranscriptionOptions.Builder.knownSpeakerReferences.

knownSpeakerReferences(List<String>) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder

Audio samples (as data URLs) containing known speaker references, positionally matching OpenAiAudioTranscriptionOptions.Builder.knownSpeakerNames.

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

kwargs(Map<String, Object>) - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions.Builder

L

L2 - Enum constant in enum class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore.DistanceType

Euclidean distance between two vectors (squared).

L2 - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusMetricType

Euclidean distance

L2 - Enum constant in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.DistanceMetric

l2_norm - Enum constant in enum class org.springframework.ai.vectorstore.couchbase.CouchbaseSimilarityFunction

It’s best to use l2_norm similarity when your embeddings contain information about the count or measure of specific things, and your embedding model uses the same similarity metric.

l2_norm - Enum constant in enum class org.springframework.ai.vectorstore.elasticsearch.SimilarityFunction

label(String) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Builder

Sets the label for document nodes.

labels - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

labels() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the labels record component.

labels() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the labels record component.

labels(Map<String, String>) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

labels(Map<String, String>) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

labels(List<SessionEvent>) - Static method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

Event labels: the text, "Σ?"

language() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns the value of the language record component.

language() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerifiedVoiceLanguage

Returns the value of the language record component.

language() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceVerification

Returns the value of the language record component.

language(String) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

language(String) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder

languageCode() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Returns the value of the languageCode record component.

languageCode(String) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.Builder

languageCode(String) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

languageCode(String) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.Builder

last(int) - Static method in interface org.springframework.ai.session.EventFilter.Window

The newest n matching events, extended to the start of their turn.

Last(int) - Constructor for record class org.springframework.ai.session.EventFilter.Window.Last

Creates an instance of a Last record class.

LAST_EVENTS - Enum constant in enum class org.springframework.ai.session.compaction.CompactionWindow.Rule

The last size conversation events.

LAST_TURNS - Enum constant in enum class org.springframework.ai.session.compaction.CompactionWindow.Rule

The last size turns.

lastEvents(int) - Static method in record class org.springframework.ai.session.compaction.CompactionWindow

Keeps the last n conversation events.

lastEvents(int) - Method in class org.springframework.ai.session.compaction.WindowCompactionStrategy.Builder

Keeps the last n conversation events; see CompactionWindow.lastEvents(int).

LastMaxTokenSizeContentPurger - Class in org.springframework.ai.chat.client.advisor

Returns a new list of content (e.g list of messages of list of documents) that is a subset of the input list of contents and complies with the max token size constraint.

LastMaxTokenSizeContentPurger(TokenCountEstimator, int) - Constructor for class org.springframework.ai.chat.client.advisor.LastMaxTokenSizeContentPurger

lastModified() - Element in annotation interface org.springframework.ai.mcp.annotation.McpResource.McpAnnotations

The date and time (in ISO 8601 format) when the resource was last modified.

lastN(int) - Static method in record class org.springframework.ai.session.EventFilter

Returns the last n events of the whole log, extended to the start of their turn.

lastN(Integer) - Method in class org.springframework.ai.session.EventFilter.Builder

Keeps the newest n matching events, extended to the start of their turn: EventFilter.Window.last(int).

lastTurns(int) - Static method in record class org.springframework.ai.session.compaction.CompactionWindow

Keeps the last n turns: a user message and everything up to the next one.

lastTurns(int) - Method in class org.springframework.ai.session.compaction.WindowCompactionStrategy.Builder

Keeps the last n turns; see CompactionWindow.lastTurns(int).

lat() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Request

Returns the value of the lat record component.

latency - Enum constant in enum class org.springframework.ai.vectorstore.couchbase.CouchbaseIndexOptimization

latency: The Search Service prioritizes returning results with lower latency.

law() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Returns the value of the law record component.

law() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Returns the value of the law record component.

law(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder

law(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder

LE - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

LE - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

LE() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareContext

left - Variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.AndExpressionContext

left - Variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.OrExpressionContext

left() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Expression

Returns the value of the left record component.

LEFT_PARENTHESIS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

LEFT_PARENTHESIS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

LEFT_PARENTHESIS() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.GroupExpressionContext

LEFT_SQUARE_BRACKETS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

LEFT_SQUARE_BRACKETS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

LEFT_SQUARE_BRACKETS() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantArrayContext

legacyParts(String) - Static method in class org.springframework.ai.chat.messages.AbstractMessage

LENGTH - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionFinishReason

The maximum number of tokens specified in the request was reached.

LENGTH - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.FinishReason

The maximum number of tokens specified in the request was reached.

level - Variable in class org.springframework.ai.mcp.annotation.context.DefaultLoggingSpec

level() - Method in record class org.springframework.ai.ollama.api.ThinkOption.ThinkLevel

Returns the value of the level record component.

level() - Method in record class org.springframework.ai.reader.pdf.config.ParagraphManager.Paragraph

Returns the value of the level record component.

level(McpSchema.LoggingLevel) - Method in class org.springframework.ai.mcp.annotation.context.DefaultLoggingSpec

level(McpSchema.LoggingLevel) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.LoggingSpec

levenshteinDistance() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerificationAttempt

Returns the value of the levenshteinDistance record component.

license() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Returns the value of the license record component.

likedByCount() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the likedByCount record component.

limit() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingsRequest

Returns the value of the limit record component.

Limits() - Constructor for class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Limits

LINE_ART - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

LINEAR16 - Enum constant in enum class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.AudioEncoding

The 24 kHz, 16-bit, mono PCM audio wrapped in a WAV header.

list(Integer, String) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService

Lists all cached content with optional pagination.

listAll() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService

Lists all cached content without pagination.

listCollections(String, String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

ListModelResponse(List<OllamaApi.Model>) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.ListModelResponse

Creates an instance of a ListModelResponse record class.

listModels() - Method in class org.springframework.ai.ollama.api.OllamaApi

List models that are available locally on the machine where Ollama is running.

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

LIVE_MODEL_NAME - Static variable in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions

The Gemini live transcription model name, used with the Gemini Live API for real-time (streaming) speech-to-text.

liveModerationEnabled() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the liveModerationEnabled record component.

LLAMA2 - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Llama 2 is a collection of language models ranging from 7B to 70B parameters.

LLAMA2_UNCENSORED - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Uncensored Llama 2 model

LLAMA3 - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Llama 3 is a collection of language models ranging from 8B and 70B parameters.

LLAMA3_1 - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

The 8B language model from Meta.

LLAMA3_2 - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

The Llama 3.2 3B language model from Meta.

LLAMA3_2_1B - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

The Llama 3.2 1B language model from Meta.

LLAMA3_2_3B - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

The Llama 3.2 3B language model from Meta.

LLAMA3_2_VISION_11b - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

The Llama 3.2 Vision 11B language model from Meta.

LLAMA3_2_VISION_90b - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

The Llama 3.2 Vision 90B language model from Meta.

LLAVA - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Llava is a Large Language and Vision Assistant model

load(File) - Method in class org.springframework.ai.vectorstore.SimpleVectorStore

Deserialize the vector store content from a file in JSON format into memory.

load(Resource) - Method in class org.springframework.ai.vectorstore.SimpleVectorStore

Deserialize the vector store content from a resource in JSON format into memory.

loadDuration() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Returns the value of the loadDuration record component.

loadDuration() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsResponse

Returns the value of the loadDuration record component.

localDatacenter(String) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

Sets the local datacenter for the session builder.

location() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Request

Returns the value of the location record component.

location(String) - Method in class org.springframework.ai.google.genai.embedding.GoogleGenAiEmbeddingConnectionDetails.Builder

location(String) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageConnectionDetails.Builder

location(String) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionConnectionDetails.Builder

Sets the Google Cloud location (Vertex AI mode).

location(String) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechConnectionDetails.Builder

location(String) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails.Builder

log(Consumer<McpRequestContextTypes.LoggingSpec>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

log(Consumer<McpRequestContextTypes.LoggingSpec>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

log(Consumer<McpRequestContextTypes.LoggingSpec>) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

log(Consumer<McpRequestContextTypes.LoggingSpec>) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

logger - Static variable in interface org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepositoryDialect

Deprecated.

logger - Variable in class org.springframework.ai.mcp.annotation.context.DefaultLoggingSpec

logger - Static variable in interface org.springframework.ai.tool.ToolCallback

logger(String) - Method in class org.springframework.ai.mcp.annotation.context.DefaultLoggingSpec

logger(String) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.LoggingSpec

loggingConsumer(McpLogging) - Method in class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback.AbstractBuilder

Set the logging consumer annotation.

loggingHandler() - Method in record class org.springframework.ai.mcp.annotation.method.logging.AsyncLoggingSpecification

Returns the value of the loggingHandler record component.

loggingHandler() - Method in record class org.springframework.ai.mcp.annotation.method.logging.SyncLoggingSpecification

Returns the value of the loggingHandler record component.

loggingSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

loggingSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

logitBias - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

logitBias(Map<String, Integer>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

logitsAll - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

logitsAll(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

logitsAll(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

logprob() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content

Returns the value of the logprob record component.

logprob() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content.TopLogProbs

Returns the value of the logprob record component.

logprob() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content

Returns the value of the logprob record component.

logprob() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content.TopLogProbs

Returns the value of the logprob record component.

logprobs - Variable in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

logprobs - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

logprobs() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion.Choice

Returns the value of the logprobs record component.

logprobs() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk.ChunkChoice

Returns the value of the logprobs record component.

logprobs() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the logprobs record component.

logprobs() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion.Choice

Returns the value of the logprobs record component.

logprobs() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk.ChunkChoice

Returns the value of the logprobs record component.

logprobs(Boolean) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set whether to return log probabilities.

logprobs(Boolean) - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

logprobs(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

LogProbs(List<DeepSeekApi.LogProbs.Content>, List<DeepSeekApi.LogProbs.Content>) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs

Creates an instance of a LogProbs record class.

LogProbs(List<MistralAiApi.LogProbs.Content>) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs

Creates an instance of a LogProbs record class.

logRequest(ChatClientRequest) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

logResponse(ChatClientResponse) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

lon() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Request

Returns the value of the lon record component.

LONG_SUFFIX - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

LONG_SUFFIX - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

LONG_SUFFIX() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.LongConstantContext

LongConstantContext(FiltersParser.ConstantContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.LongConstantContext

LOW - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiThinkingLevel

Low thinking level.

LOW - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl.ImageDetail

LOW - Enum constant in enum class org.springframework.ai.model.ollama.autoconfigure.OllamaThinkProperties

LOW - Static variable in record class org.springframework.ai.ollama.api.ThinkOption.ThinkLevel

Low thinking level for GPT-OSS.

LOW_POLY - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

lowVRAM - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

lowVRAM(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

lowVRAM(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

LruEvictionStrategy - Class in org.springframework.ai.tool.toolsearch.eviction

A ToolIndexEvictionStrategy that evicts the least-recently-used session when the number of concurrently active sessions exceeds a configured maximum.

LruEvictionStrategy(int) - Constructor for class org.springframework.ai.tool.toolsearch.eviction.LruEvictionStrategy

Creates a new LruEvictionStrategy.

lt(String, Object) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

LT - Enum constant in enum class org.springframework.ai.vectorstore.filter.Filter.ExpressionType

LT - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

LT - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

LT() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareContext

lte(String, Object) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

LTE - Enum constant in enum class org.springframework.ai.vectorstore.filter.Filter.ExpressionType

Lucene() - Constructor for class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties.Lucene

LuceneToolIndex - Class in org.springframework.ai.tool.toolsearch.index.lucene

Lucene-based tool searcher for indexing and searching tool descriptions.

LuceneToolIndex() - Constructor for class org.springframework.ai.tool.toolsearch.index.lucene.LuceneToolIndex

Creates a new LuceneToolIndex with default settings.

LuceneToolIndex(float) - Constructor for class org.springframework.ai.tool.toolsearch.index.lucene.LuceneToolIndex

M

main(String[]) - Static method in class org.springframework.ai.utils.AudioPlayer

mainGPU - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

mainGPU(Integer) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

mainGPU(Integer) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

makeAsyncClientsClosable(List<McpAsyncClient>) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration

makeSyncClientsClosable(List<McpSyncClient>) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration

Creates a closeable wrapper for MCP sync clients to ensure proper resource cleanup.

manageDocumentIds(boolean) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.Builder

Sets whether to manage document IDs during indexing operations.

MANHATTAN - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric

The manhattan distance metric.

MANHATTAN - Enum constant in enum class org.springframework.ai.vectorstore.oracle.OracleVectorStore.OracleVectorStoreDistanceType

Also called L1_DISTANCE or taxicab distance, calculates the Manhattan distance.

manualVerification() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns the value of the manualVerification record component.

ManualVerification(String, Integer, List<ElevenLabsVoicesApi.ManualVerificationFile>) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerification

Creates an instance of a ManualVerification record class.

ManualVerificationFile(String, String, String, Integer, Integer) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerificationFile

Creates an instance of a ManualVerificationFile record class.

manualVerificationRequested() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns the value of the manualVerificationRequested record component.

map - Variable in class org.springframework.ai.model.AbstractResponseMetadata

Metadata map.

map(Observation.Context) - Method in class org.springframework.ai.tool.observation.ToolCallingContentObservationFilter

mapMessage(Conversation) - Static method in class org.springframework.ai.chat.memory.repository.mongo.MongoChatMemoryRepository

Deprecated.

mapName(String) - Method in class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore.Builder

Sets the map name for vector storage.

MapOutputConverter - Class in org.springframework.ai.converter

StructuredOutputConverter implementation that uses a pre-configured JacksonJsonMessageConverter to convert the LLM output into a java.util.Map<String, Object> instance.

MapOutputConverter() - Constructor for class org.springframework.ai.converter.MapOutputConverter

mappingJson(String) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.Builder

Sets the JSON mapping for the index.

mapValueToCallToolResult(Object) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractAsyncMcpToolMethodCallback

Map individual values to CallToolResult This method delegates to the parent class's convertValueToCallToolResult method to avoid code duplication.

MARIADB - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by MariaDB.

MARIADB - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

MariaDBDocument(String, String, Map<String, Object>, float[]) - Constructor for record class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBDocument

Creates an instance of a MariaDBDocument record class.

MariaDBFilterExpressionConverter - Class in org.springframework.ai.vectorstore.mariadb

Converts Filter.Expression into MariaDB SQL WHERE clause format using JSON_VALUE functions for metadata filtering.

MariaDBFilterExpressionConverter(String) - Constructor for class org.springframework.ai.vectorstore.mariadb.MariaDBFilterExpressionConverter

MariaDBSchemaValidator - Class in org.springframework.ai.vectorstore.mariadb

MariaDBSchemaValidator(JdbcTemplate) - Constructor for class org.springframework.ai.vectorstore.mariadb.MariaDBSchemaValidator

MariaDbStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.mariadb.autoconfigure

MariaDbStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreAutoConfiguration

MariaDbStoreProperties - Class in org.springframework.ai.vectorstore.mariadb.autoconfigure

MariaDbStoreProperties() - Constructor for class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

MariaDBVectorStore - Class in org.springframework.ai.vectorstore.mariadb

MariaDB-based vector store implementation using MariaDB's vector search capabilities.

MariaDBVectorStore(MariaDBVectorStore.MariaDBBuilder) - Constructor for class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

Protected constructor for creating a MariaDBVectorStore instance using the builder pattern.

MariaDBVectorStore.MariaDBBuilder - Class in org.springframework.ai.vectorstore.mariadb

Builder for creating instances of MariaDBVectorStore.

MariaDBVectorStore.MariaDBDistanceType - Enum Class in org.springframework.ai.vectorstore.mariadb

MariaDBVectorStore.MariaDBDocument - Record Class in org.springframework.ai.vectorstore.mariadb

The representation of Document along with its embedding.

markdown() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPage

Returns the value of the markdown record component.

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

MarkdownDocumentReader - Class in org.springframework.ai.reader.markdown

Reads the given Markdown resource and groups headers, paragraphs, or text divided by horizontal lines (depending on the MarkdownDocumentReaderConfig.horizontalRuleCreateDocument configuration) into Documents.

MarkdownDocumentReader(String) - Constructor for class org.springframework.ai.reader.markdown.MarkdownDocumentReader

Create a new MarkdownDocumentReader instance.

MarkdownDocumentReader(String, MarkdownDocumentReaderConfig) - Constructor for class org.springframework.ai.reader.markdown.MarkdownDocumentReader

Create a new MarkdownDocumentReader instance.

MarkdownDocumentReader(List<Resource>, MarkdownDocumentReaderConfig) - Constructor for class org.springframework.ai.reader.markdown.MarkdownDocumentReader

Create a new MarkdownDocumentReader instance using already resolved resources.

MarkdownDocumentReader(Resource, MarkdownDocumentReaderConfig) - Constructor for class org.springframework.ai.reader.markdown.MarkdownDocumentReader

Create a new MarkdownDocumentReader instance using a single Resource.

MarkdownDocumentReaderConfig - Class in org.springframework.ai.reader.markdown.config

Common configuration for the MarkdownDocumentReader.

MarkdownDocumentReaderConfig(MarkdownDocumentReaderConfig.Builder) - Constructor for class org.springframework.ai.reader.markdown.config.MarkdownDocumentReaderConfig

MarkdownDocumentReaderConfig.Builder - Class in org.springframework.ai.reader.markdown.config

matches(SessionEvent) - Method in record class org.springframework.ai.session.EventFilter

Whether the event passes the per-event criteria: the event and message types and the synthetic flag.

MAX - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.ReasoningEffort

MAX_DOCUMENT_BATCH_SIZE - Static variable in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

MAX_DOCUMENT_BATCH_SIZE - Static variable in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

MAX_INDEXED_VALUE_LENGTH - Static variable in class org.springframework.ai.session.jdbc.JdbcSessionRepository

The number of leading characters of a metadata value the index row holds: with four bytes per character on MySQL, the (attr_name, attr_value) index stays under InnoDB's key limit.

MAX_NAME_LENGTH - Static variable in class org.springframework.ai.session.EventType

The longest name; a store sizes its column for it.

maxCallsPerTool(int) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder

Default maximum number of times any single tool can be called within a turn, unless overridden for a specific tool name via DefaultToolCallingManager.Builder.maxCallsPerTool(String, int) or exempted via DefaultToolCallingManager.Builder.excludeToolFromLimit(String).

maxCallsPerTool(String, int) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder

Maximum number of times the named tool can be called within a turn, overriding the default set via DefaultToolCallingManager.Builder.maxCallsPerTool(int) for that tool only.

maxCompletionTokens - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

maxCompletionTokens(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

maxConnections(int) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

Sets the maximum number of connections.

maxConversationIds(int) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig.Builder

Deprecated.

Sets the maximum number of conversation IDs to return.

maxConversationIds(int) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository.Builder

Deprecated.

Sets the maximum number of conversation IDs to return.

maxDocumentBatchSize(int) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBBuilder

Configures the maximum batch size for document operations.

maxDocumentBatchSize(int) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgVectorStoreBuilder

maxIdleConnections(Integer) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

maxIdleConnections(Integer) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

maxMessages(int) - Method in class org.springframework.ai.chat.memory.MessageWindowChatMemory.Builder

Deprecated.

maxMessagesPerConversation(int) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig.Builder

Deprecated.

Sets the maximum number of messages to return per conversation.

maxMessagesPerConversation(int) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository.Builder

Deprecated.

Sets the maximum number of messages per conversation to return.

maxNumResults() - Method in record class org.springframework.ai.openai.responses.HostedTool.FileSearch

Returns the value of the maxNumResults record component.

maxOutputTokens(Integer) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

maxOutputTokens(Integer) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

maxOutputTokens(Integer) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

maxOutputTokens(Integer) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

Alias for DefaultChatOptionsBuilder.maxTokens(Integer), named after the wire field.

maxRepeatAttempts(int) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder

Sets the maximum number of retry attempts after a validation failure.

maxResults() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchRequest

Returns the value of the maxResults record component.

maxResults(Integer) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor.Builder

Sets the maximum number of tool references to return in tool search results.

maxRetries - Variable in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

maxRetries - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

maxRetries - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

maxRetries() - Method in record class org.springframework.ai.ollama.management.ModelManagementOptions

Returns the value of the maxRetries record component.

maxRetries(Integer) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

maxRetries(Integer) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

maxRetries(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

maxRetries(Integer) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

maxRetries(Integer) - Method in class org.springframework.ai.ollama.management.ModelManagementOptions.Builder

maxSessions(long) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider.Builder

Sets the maximum supported sessions for this provider.

maxSessions(long) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider.Builder

Sets the maximum supported sessions for this provider.

maxTokens - Variable in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

maxTokens - Variable in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

maxTokens() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the maxTokens record component.

maxTokens() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the maxTokens record component.

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

maxTokens(Integer) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set the maximum number of tokens that can be generated.

maxTokens(Integer) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

maxTokens(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

maxTokens(Integer) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

maxTokens(Integer) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

maxTokenSize - Variable in class org.springframework.ai.chat.client.advisor.LastMaxTokenSizeContentPurger

maxToolCalls - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

maxToolCalls(Integer) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

maxTotalToolCalls(int) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder

Maximum number of tool calls, across all tools combined, allowed within a turn.

maxUses(long) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool.Builder

maxVerificationAttempts() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns the value of the maxVerificationAttempts record component.

Mcp(String, String, String, List<String>, Map<String, String>, String) - Constructor for record class org.springframework.ai.openai.responses.HostedTool.Mcp

Creates an instance of a Mcp record class.

McpArg - Annotation Interface in org.springframework.ai.mcp.annotation

Marks a method parameter as a MCP Argument.

McpAsyncClientConfigurer - Class in org.springframework.ai.mcp.client.common.autoconfigure.configurer

McpAsyncClientConfigurer(List<McpClientCustomizer<McpClient.AsyncSpec>>) - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.configurer.McpAsyncClientConfigurer

mcpAsyncClients(McpAsyncClientConfigurer, McpClientCommonProperties, ObjectProvider<List<NamedClientMcpTransport>>, ObjectProvider<ClientMcpAsyncHandlersRegistry>) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration

McpAsyncRequestContext - Interface in org.springframework.ai.mcp.annotation.context

Async (Reactor) version of McpSyncRequestContext that returns Mono of value types.

mcpAsyncServer(McpServerTransportProviderBase, McpSchema.ServerCapabilities.Builder, McpServerProperties, McpServerChangeNotificationProperties, ObjectProvider<List<McpServerFeatures.AsyncToolSpecification>>, ObjectProvider<List<McpServerFeatures.AsyncResourceSpecification>>, ObjectProvider<List<McpServerFeatures.AsyncResourceTemplateSpecification>>, ObjectProvider<List<McpServerFeatures.AsyncPromptSpecification>>, ObjectProvider<List<McpServerFeatures.AsyncCompletionSpecification>>, ObjectProvider<BiConsumer<McpAsyncServerExchange, List<McpSchema.Root>>>, Optional<McpAsyncServerCustomizer>) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.McpServerAutoConfiguration

McpAsyncServerCustomizer - Interface in org.springframework.ai.mcp.customizer

Interface for customizing synchronous MCP server configurations.

mcpAsyncToolCallbacks(ObjectProvider<McpToolFilter>, ObjectProvider<List<McpAsyncClient>>, ObjectProvider<McpToolNamePrefixGenerator>, ObjectProvider<ToolContextToMcpMetaConverter>) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.McpToolCallbackAutoConfiguration

mcpAsyncToolChangeEventEmmiter(ApplicationEventPublisher) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration

McpAsyncToolsChangeEventEmmiter - Class in org.springframework.ai.mcp.client.common.autoconfigure

Emits McpToolsChangedEvent when the MCP Tools have changed for a given MCP connection.

McpAsyncToolsChangeEventEmmiter(ApplicationEventPublisher) - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.McpAsyncToolsChangeEventEmmiter

mcpClient(McpAsyncClient) - Method in class org.springframework.ai.mcp.AsyncMcpToolCallback.Builder

Sets the MCP client for tool execution.

mcpClient(McpSyncClient) - Method in class org.springframework.ai.mcp.SyncMcpToolCallback.Builder

Sets the MCP client for tool execution.

McpClientAnnotationScannerAutoConfiguration - Class in org.springframework.ai.mcp.client.common.autoconfigure.annotations

McpClientAnnotationScannerAutoConfiguration() - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.annotations.McpClientAnnotationScannerAutoConfiguration

McpClientAnnotationScannerAutoConfiguration.ClientAnnotatedBeanFactoryInitializationAotProcessor - Class in org.springframework.ai.mcp.client.common.autoconfigure.annotations

McpClientAnnotationScannerAutoConfiguration.ClientMcpAnnotatedBeans - Class in org.springframework.ai.mcp.client.common.autoconfigure.annotations

McpClientAnnotationScannerProperties - Class in org.springframework.ai.mcp.client.common.autoconfigure.annotations

McpClientAnnotationScannerProperties() - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.annotations.McpClientAnnotationScannerProperties

McpClientAutoConfiguration - Class in org.springframework.ai.mcp.client.common.autoconfigure

Auto-configuration for Model Context Protocol (MCP) client support.

McpClientAutoConfiguration() - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration

McpClientAutoConfiguration.CloseableMcpAsyncClients - Record Class in org.springframework.ai.mcp.client.common.autoconfigure

McpClientAutoConfiguration.CloseableMcpSyncClients - Record Class in org.springframework.ai.mcp.client.common.autoconfigure

Record class that implements AutoCloseable to ensure proper cleanup of MCP clients.

McpClientAutoConfigurationRuntimeHints - Class in org.springframework.ai.mcp.client.common.autoconfigure.aot

McpClientAutoConfigurationRuntimeHints - Class in org.springframework.ai.mcp.client.httpclient.autoconfigure.aot

McpClientAutoConfigurationRuntimeHints - Class in org.springframework.ai.mcp.client.webflux.autoconfigure.aot

McpClientAutoConfigurationRuntimeHints() - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.aot.McpClientAutoConfigurationRuntimeHints

McpClientAutoConfigurationRuntimeHints() - Constructor for class org.springframework.ai.mcp.client.httpclient.autoconfigure.aot.McpClientAutoConfigurationRuntimeHints

McpClientAutoConfigurationRuntimeHints() - Constructor for class org.springframework.ai.mcp.client.webflux.autoconfigure.aot.McpClientAutoConfigurationRuntimeHints

McpClientCommonProperties - Class in org.springframework.ai.mcp.client.common.autoconfigure.properties

Common Configuration properties for the Model Context Protocol (MCP) clients shared for all transport types.

McpClientCommonProperties() - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

McpClientCommonProperties.ClientType - Enum Class in org.springframework.ai.mcp.client.common.autoconfigure.properties

Client types supported by the MCP client.

McpClientCommonProperties.Toolcallback - Class in org.springframework.ai.mcp.client.common.autoconfigure.properties

Represents a callback configuration for tools.

McpClientCustomizer<B> - Interface in org.springframework.ai.mcp.customizer

Interface for customizing MCP client components.

mcpClients(McpAsyncClient...) - Method in class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider.Builder

Sets MCP clients.

mcpClients(McpSyncClient...) - Method in class org.springframework.ai.mcp.SyncMcpToolCallbackProvider.Builder

Sets MCP clients for tool discovery (replaces existing).

mcpClients(List<McpAsyncClient>) - Method in class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider.Builder

Sets MCP clients.

mcpClients(List<McpSyncClient>) - Method in class org.springframework.ai.mcp.SyncMcpToolCallbackProvider.Builder

Sets MCP clients for tool discovery (replaces existing).

McpComplete - Annotation Interface in org.springframework.ai.mcp.annotation

Annotates a method used for completion functionality in the MCP framework.

McpCompleteMethodException(String) - Constructor for exception org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.McpCompleteMethodException

Constructs a new exception with the specified detail message.

McpCompleteMethodException(String, Throwable) - Constructor for exception org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.McpCompleteMethodException

Constructs a new exception with the specified detail message and cause.

McpConnectionInfo - Record Class in org.springframework.ai.mcp

MCP connection info record containing the client and server related metadata.

McpConnectionInfo(McpSchema.ClientCapabilities, McpSchema.Implementation, McpSchema.InitializeResult) - Constructor for record class org.springframework.ai.mcp.McpConnectionInfo

Creates an instance of a McpConnectionInfo record class.

McpConnectionInfo.Builder - Class in org.springframework.ai.mcp

Builder class for constructing McpConnectionInfo instances.

McpElicitation - Annotation Interface in org.springframework.ai.mcp.annotation

Annotation for methods that handle elicitation requests from MCP servers.

McpElicitationMethodException(String) - Constructor for exception org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback.McpElicitationMethodException

Constructs a new exception with the specified detail message.

McpElicitationMethodException(String, Throwable) - Constructor for exception org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback.McpElicitationMethodException

Constructs a new exception with the specified detail message and cause.

mcpEndpoint(String) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider.Builder

Sets the endpoint URI where clients should send their JSON-RPC messages.

McpHints - Class in org.springframework.ai.mcp.aot

Runtime hints registrar for Model Context Protocol (MCP) schema classes.

McpHints() - Constructor for class org.springframework.ai.mcp.aot.McpHints

McpJsonSchemaGenerator - Class in org.springframework.ai.mcp.annotation.method.tool.utils

McpLogging - Annotation Interface in org.springframework.ai.mcp.annotation

Annotation for methods that handle logging message notifications from MCP servers.

McpLoggingConsumerMethodException(String) - Constructor for exception org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback.McpLoggingConsumerMethodException

Constructs a new exception with the specified detail message.

McpLoggingConsumerMethodException(String, Throwable) - Constructor for exception org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback.McpLoggingConsumerMethodException

Constructs a new exception with the specified detail message and cause.

McpMeta - Record Class in org.springframework.ai.mcp.annotation

Special object used to represent the McpSchema.Meta.meta(), McpSchema.Meta.meta() and McpSchema.Meta.meta() values as method argument in all client and server MCP request and notification handlers.

McpMeta(Map<String, Object>) - Constructor for record class org.springframework.ai.mcp.annotation.McpMeta

Creates an instance of a McpMeta record class.

McpPredicates - Class in org.springframework.ai.mcp.annotation.common

McpProgress - Annotation Interface in org.springframework.ai.mcp.annotation

Annotation for methods that handle progress notifications from MCP servers.

McpProgressMethodException(String) - Constructor for exception org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback.McpProgressMethodException

Constructs a new exception with the specified detail message.

McpProgressMethodException(String, Throwable) - Constructor for exception org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback.McpProgressMethodException

Constructs a new exception with the specified detail message and cause.

McpProgressToken - Annotation Interface in org.springframework.ai.mcp.annotation

Used to annotate method parameter that should hold the progress token value as received from the requester.

McpPrompt - Annotation Interface in org.springframework.ai.mcp.annotation

Marks a method as a MCP Prompt.

McpPromptListChanged - Annotation Interface in org.springframework.ai.mcp.annotation

Annotation for methods that handle prompt list change notifications from MCP servers.

McpPromptListChangedConsumerMethodException(String) - Constructor for exception org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback.McpPromptListChangedConsumerMethodException

Constructs a new exception with the specified detail message.

McpPromptListChangedConsumerMethodException(String, Throwable) - Constructor for exception org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback.McpPromptListChangedConsumerMethodException

Constructs a new exception with the specified detail message and cause.

McpReadResourceResultConverter - Interface in org.springframework.ai.mcp.annotation.method.resource

Interface for converting method return values to McpSchema.ReadResourceResult.

McpRequestContextTypes<ET> - Interface in org.springframework.ai.mcp.annotation.context

McpRequestContextTypes.ElicitationSpec - Interface in org.springframework.ai.mcp.annotation.context

McpRequestContextTypes.LoggingSpec - Interface in org.springframework.ai.mcp.annotation.context

McpRequestContextTypes.ModelPreferenceSpec - Interface in org.springframework.ai.mcp.annotation.context

McpRequestContextTypes.ProgressSpec - Interface in org.springframework.ai.mcp.annotation.context

McpRequestContextTypes.SamplingSpec - Interface in org.springframework.ai.mcp.annotation.context

McpResource - Annotation Interface in org.springframework.ai.mcp.annotation

Marks a method as a MCP Resource.

McpResource.McpAnnotations - Annotation Interface in org.springframework.ai.mcp.annotation

McpResourceListChanged - Annotation Interface in org.springframework.ai.mcp.annotation

Annotation for methods that handle resource list change notifications from MCP servers.

McpResourceListChangedConsumerMethodException(String) - Constructor for exception org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback.McpResourceListChangedConsumerMethodException

Constructs a new exception with the specified detail message.

McpResourceListChangedConsumerMethodException(String, Throwable) - Constructor for exception org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback.McpResourceListChangedConsumerMethodException

Constructs a new exception with the specified detail message and cause.

McpSampling - Annotation Interface in org.springframework.ai.mcp.annotation

Annotation for methods that handle sampling requests from MCP servers.

McpSamplingMethodException(String) - Constructor for exception org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback.McpSamplingMethodException

Constructs a new exception with the specified detail message.

McpSamplingMethodException(String, Throwable) - Constructor for exception org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback.McpSamplingMethodException

Constructs a new exception with the specified detail message and cause.

McpServerAnnotationScannerAutoConfiguration - Class in org.springframework.ai.mcp.server.common.autoconfigure.annotations

McpServerAnnotationScannerAutoConfiguration() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.annotations.McpServerAnnotationScannerAutoConfiguration

McpServerAnnotationScannerAutoConfiguration.ServerAnnotatedBeanFactoryInitializationAotProcessor - Class in org.springframework.ai.mcp.server.common.autoconfigure.annotations

McpServerAnnotationScannerAutoConfiguration.ServerAnnotatedMethodBeanPostProcessor - Class in org.springframework.ai.mcp.server.common.autoconfigure.annotations

McpServerAnnotationScannerAutoConfiguration.ServerMcpAnnotatedBeans - Class in org.springframework.ai.mcp.server.common.autoconfigure.annotations

McpServerAnnotationScannerProperties - Class in org.springframework.ai.mcp.server.common.autoconfigure.annotations

McpServerAnnotationScannerProperties() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.annotations.McpServerAnnotationScannerProperties

McpServerAutoConfiguration - Class in org.springframework.ai.mcp.server.common.autoconfigure

Auto-configuration for the Model Context Protocol (MCP) Server.

McpServerAutoConfiguration() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.McpServerAutoConfiguration

McpServerAutoConfiguration.EnabledSseServerCondition - Class in org.springframework.ai.mcp.server.common.autoconfigure

McpServerAutoConfiguration.EnabledStreamableServerCondition - Class in org.springframework.ai.mcp.server.common.autoconfigure

McpServerAutoConfiguration.NonStatelessServerCondition - Class in org.springframework.ai.mcp.server.common.autoconfigure

McpServerChangeNotificationProperties - Class in org.springframework.ai.mcp.server.common.autoconfigure.properties

McpServerChangeNotificationProperties() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerChangeNotificationProperties

mcpServerJsonMapper() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.McpServerJsonMapperAutoConfiguration

Creates a configured JsonMapper for MCP server JSON serialization.

McpServerJsonMapperAutoConfiguration - Class in org.springframework.ai.mcp.server.common.autoconfigure

McpServerJsonMapperAutoConfiguration() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.McpServerJsonMapperAutoConfiguration

McpServerProperties - Class in org.springframework.ai.mcp.server.common.autoconfigure.properties

Configuration properties for the Model Context Protocol (MCP) server.

McpServerProperties() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

McpServerProperties.ApiType - Enum Class in org.springframework.ai.mcp.server.common.autoconfigure.properties

API types supported by the MCP server.

McpServerProperties.Capabilities - Class in org.springframework.ai.mcp.server.common.autoconfigure.properties

McpServerProperties.ServerProtocol - Enum Class in org.springframework.ai.mcp.server.common.autoconfigure.properties

McpServerSpecificationFactoryAutoConfiguration - Class in org.springframework.ai.mcp.server.common.autoconfigure.annotations

McpServerSpecificationFactoryAutoConfiguration() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.annotations.McpServerSpecificationFactoryAutoConfiguration

McpServerSseProperties - Class in org.springframework.ai.mcp.server.common.autoconfigure.properties

Deprecated, for removal: This API element is subject to removal in a future version.

McpServerSseProperties() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerSseProperties

Deprecated.

McpServerSseWebFluxAutoConfiguration - Class in org.springframework.ai.mcp.server.webflux.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

McpServerSseWebFluxAutoConfiguration() - Constructor for class org.springframework.ai.mcp.server.webflux.autoconfigure.McpServerSseWebFluxAutoConfiguration

Deprecated.

McpServerSseWebMvcAutoConfiguration - Class in org.springframework.ai.mcp.server.webmvc.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

McpServerSseWebMvcAutoConfiguration() - Constructor for class org.springframework.ai.mcp.server.webmvc.autoconfigure.McpServerSseWebMvcAutoConfiguration

Deprecated.

McpServerStatelessAutoConfiguration - Class in org.springframework.ai.mcp.server.common.autoconfigure

McpServerStatelessAutoConfiguration() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.McpServerStatelessAutoConfiguration

McpServerStatelessAutoConfiguration.EnabledStatelessServerCondition - Class in org.springframework.ai.mcp.server.common.autoconfigure

McpServerStatelessWebFluxAutoConfiguration - Class in org.springframework.ai.mcp.server.webflux.autoconfigure

McpServerStatelessWebFluxAutoConfiguration() - Constructor for class org.springframework.ai.mcp.server.webflux.autoconfigure.McpServerStatelessWebFluxAutoConfiguration

McpServerStatelessWebMvcAutoConfiguration - Class in org.springframework.ai.mcp.server.webmvc.autoconfigure

McpServerStatelessWebMvcAutoConfiguration() - Constructor for class org.springframework.ai.mcp.server.webmvc.autoconfigure.McpServerStatelessWebMvcAutoConfiguration

McpServerStdioDisabledCondition - Class in org.springframework.ai.mcp.server.common.autoconfigure

This class defines a condition met when the MCP server is enabled and the STDIO Transport is disabled.

McpServerStdioDisabledCondition() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.McpServerStdioDisabledCondition

McpServerStreamableHttpProperties - Class in org.springframework.ai.mcp.server.common.autoconfigure.properties

McpServerStreamableHttpProperties() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerStreamableHttpProperties

McpServerStreamableHttpWebFluxAutoConfiguration - Class in org.springframework.ai.mcp.server.webflux.autoconfigure

McpServerStreamableHttpWebFluxAutoConfiguration() - Constructor for class org.springframework.ai.mcp.server.webflux.autoconfigure.McpServerStreamableHttpWebFluxAutoConfiguration

McpServerStreamableHttpWebMvcAutoConfiguration - Class in org.springframework.ai.mcp.server.webmvc.autoconfigure

McpServerStreamableHttpWebMvcAutoConfiguration() - Constructor for class org.springframework.ai.mcp.server.webmvc.autoconfigure.McpServerStreamableHttpWebMvcAutoConfiguration

McpSpringAiSchemaModule - Class in org.springframework.ai.mcp.annotation.method.tool.utils

JSON Schema Generator Module for Spring AI MCP.

McpSpringAiSchemaModule(AbstractSpringAiSchemaModule.Option...) - Constructor for class org.springframework.ai.mcp.annotation.method.tool.utils.McpSpringAiSchemaModule

McpSseClientConnectionDetails - Interface in org.springframework.ai.mcp.client.common.autoconfigure

Connection details for an MCP client.

McpSseClientProperties - Class in org.springframework.ai.mcp.client.common.autoconfigure.properties

Deprecated, for removal: This API element is subject to removal in a future version.

McpSseClientProperties() - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpSseClientProperties

Deprecated.

McpSseClientProperties.SseParameters - Record Class in org.springframework.ai.mcp.client.common.autoconfigure.properties

Deprecated.

Parameters for configuring an SSE connection to an MCP server.

mcpStatelessAsyncServer(McpStatelessServerTransport, McpSchema.ServerCapabilities.Builder, McpServerProperties, ObjectProvider<List<McpStatelessServerFeatures.AsyncToolSpecification>>, ObjectProvider<List<McpStatelessServerFeatures.AsyncResourceSpecification>>, ObjectProvider<List<McpStatelessServerFeatures.AsyncResourceTemplateSpecification>>, ObjectProvider<List<McpStatelessServerFeatures.AsyncPromptSpecification>>, ObjectProvider<List<McpStatelessServerFeatures.AsyncCompletionSpecification>>, ObjectProvider<McpStatelessAsyncServerCustomizer>) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.McpServerStatelessAutoConfiguration

McpStatelessAsyncServerCustomizer - Interface in org.springframework.ai.mcp.customizer

Interface for customizing stateless asynchronous MCP server configurations.

mcpStatelessSyncServer(McpStatelessServerTransport, McpSchema.ServerCapabilities.Builder, McpServerProperties, ObjectProvider<List<McpStatelessServerFeatures.SyncToolSpecification>>, ObjectProvider<List<McpStatelessServerFeatures.SyncResourceSpecification>>, ObjectProvider<List<McpStatelessServerFeatures.SyncResourceTemplateSpecification>>, ObjectProvider<List<McpStatelessServerFeatures.SyncPromptSpecification>>, ObjectProvider<List<McpStatelessServerFeatures.SyncCompletionSpecification>>, Environment, ObjectProvider<McpStatelessSyncServerCustomizer>) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.McpServerStatelessAutoConfiguration

McpStatelessSyncServerCustomizer - Interface in org.springframework.ai.mcp.customizer

Interface for customizing stateless synchronous MCP server configurations.

McpStdioClientProperties - Class in org.springframework.ai.mcp.client.common.autoconfigure.properties

Configuration properties for the Model Context Protocol (MCP) stdio client.

McpStdioClientProperties() - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStdioClientProperties

McpStdioClientProperties.Parameters - Record Class in org.springframework.ai.mcp.client.common.autoconfigure.properties

Record representing the parameters for an MCP server connection.

McpStreamableHttpClientProperties - Class in org.springframework.ai.mcp.client.common.autoconfigure.properties

Configuration properties for Streamable Http client connections.

McpStreamableHttpClientProperties() - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStreamableHttpClientProperties

McpStreamableHttpClientProperties.ConnectionParameters - Record Class in org.springframework.ai.mcp.client.common.autoconfigure.properties

Parameters for configuring an Streamable Http connection to an MCP server.

McpSyncClientConfigurer - Class in org.springframework.ai.mcp.client.common.autoconfigure.configurer

Configurer class for customizing MCP synchronous clients.

McpSyncClientConfigurer(List<McpClientCustomizer<McpClient.SyncSpec>>) - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.configurer.McpSyncClientConfigurer

mcpSyncClients(McpSyncClientConfigurer, McpClientCommonProperties, ObjectProvider<List<NamedClientMcpTransport>>, ObjectProvider<ClientMcpSyncHandlersRegistry>) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration

Creates a list of McpSyncClient instances based on the available transports.

McpSyncRequestContext - Interface in org.springframework.ai.mcp.annotation.context

mcpSyncServer(McpServerTransportProviderBase, McpSchema.ServerCapabilities.Builder, McpServerProperties, McpServerChangeNotificationProperties, ObjectProvider<List<McpServerFeatures.SyncToolSpecification>>, ObjectProvider<List<McpServerFeatures.SyncResourceSpecification>>, ObjectProvider<List<McpServerFeatures.SyncResourceTemplateSpecification>>, ObjectProvider<List<McpServerFeatures.SyncPromptSpecification>>, ObjectProvider<List<McpServerFeatures.SyncCompletionSpecification>>, ObjectProvider<BiConsumer<McpSyncServerExchange, List<McpSchema.Root>>>, Optional<McpSyncServerCustomizer>) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.McpServerAutoConfiguration

McpSyncServerCustomizer - Interface in org.springframework.ai.mcp.customizer

Interface for customizing synchronous MCP server configurations.

mcpSyncToolChangeEventEmmiter(ApplicationEventPublisher) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration

McpSyncToolsChangeEventEmmiter - Class in org.springframework.ai.mcp.client.common.autoconfigure

Emits McpToolsChangedEvent when the MCP Tools have changed for a given MCP connection.

McpSyncToolsChangeEventEmmiter(ApplicationEventPublisher) - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.McpSyncToolsChangeEventEmmiter

McpTool - Annotation Interface in org.springframework.ai.mcp.annotation

McpTool.McpAnnotations - Annotation Interface in org.springframework.ai.mcp.annotation

Additional properties describing a Tool to clients.

McpToolCallbackAutoConfiguration - Class in org.springframework.ai.mcp.client.common.autoconfigure

Responsible to convert MCP (sync and async) clients into Spring AI ToolCallbacksProviders.

McpToolCallbackAutoConfiguration() - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.McpToolCallbackAutoConfiguration

McpToolCallbackAutoConfiguration.McpToolCallbackAutoConfigurationCondition - Class in org.springframework.ai.mcp.client.common.autoconfigure

McpToolCallbackAutoConfigurationCondition() - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.McpToolCallbackAutoConfiguration.McpToolCallbackAutoConfigurationCondition

mcpToolCallbacks(ObjectProvider<McpToolFilter>, ObjectProvider<List<McpSyncClient>>, ObjectProvider<McpToolNamePrefixGenerator>, ObjectProvider<ToolContextToMcpMetaConverter>) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.McpToolCallbackAutoConfiguration

Creates tool callbacks for all configured MCP clients.

McpToolFilter - Interface in org.springframework.ai.mcp

A BiPredicate for SyncMcpToolCallbackProvider and the AsyncMcpToolCallbackProvider to filter the discovered tool for the given McpConnectionInfo.

McpToolListChanged - Annotation Interface in org.springframework.ai.mcp.annotation

Annotation for methods that handle tool list change notifications from MCP servers.

McpToolListChangedConsumerMethodException(String) - Constructor for exception org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback.McpToolListChangedConsumerMethodException

Constructs a new exception with the specified detail message.

McpToolListChangedConsumerMethodException(String, Throwable) - Constructor for exception org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback.McpToolListChangedConsumerMethodException

Constructs a new exception with the specified detail message and cause.

McpToolNamePrefixGenerator - Interface in org.springframework.ai.mcp

Strategy interface for generating prefixed tool name based on MCP client/server and Tool information.

McpToolParam - Annotation Interface in org.springframework.ai.mcp.annotation

McpToolsChangedEvent - Class in org.springframework.ai.mcp

Event published when the MCP Tools have changed for a given MCP connection.

McpToolsChangedEvent(String, List<McpSchema.Tool>) - Constructor for class org.springframework.ai.mcp.McpToolsChangedEvent

McpToolUtils - Class in org.springframework.ai.mcp

Utility class that provides helper methods for working with Model Context Protocol (MCP) tools in a Spring AI environment.

media - Variable in class org.springframework.ai.chat.messages.AssistantMessage.Builder

The media set through AssistantMessage.Builder.media(List).

media - Variable in class org.springframework.ai.chat.messages.AssistantMessage

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0 in favor of AssistantMessage.getMedia(); kept so existing subclasses that read the field keep compiling. Will be removed in a future release.

media - Variable in class org.springframework.ai.chat.messages.UserMessage

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0 in favor of UserMessage.getMedia(); kept so existing subclasses that read the field keep compiling. Will be removed in a future release.

media() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

media() - Method in record class org.springframework.ai.chat.messages.part.MediaPart

Returns the value of the media record component.

media(Media) - Method in class org.springframework.ai.document.Document.Builder

Sets the media content of the document.

media(List<Media>) - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder

media(List<Media>) - Method in class org.springframework.ai.chat.messages.UserMessage.Builder

media(Media...) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptUserSpec

media(Media...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

media(Media...) - Method in class org.springframework.ai.chat.messages.UserMessage.Builder

media(MimeType, URL) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptUserSpec

media(MimeType, URL) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

media(MimeType, Resource) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptUserSpec

media(MimeType, Resource) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

Media - Class in org.springframework.ai.content

The Media class represents the data and metadata of a media attachment in a message.

Media(MimeType, URI) - Constructor for class org.springframework.ai.content.Media

Create a new Media instance.

Media(MimeType, Resource) - Constructor for class org.springframework.ai.content.Media

Create a new Media instance.

Media.Builder - Class in org.springframework.ai.content

Builder class for Media.

Media.Format - Class in org.springframework.ai.content

Common media formats.

MediaAttributes - Enum Class in org.springframework.ai.chat.memory.repository.neo4j

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory: org.springframework.ai.session.SessionRepository in spring-ai-session, with a JDBC store in spring-ai-session-jdbc. There is no session store for Neo4j yet; one is planned before 3.0.0, when this module is removed.

MediaContent - Interface in org.springframework.ai.content

MediaDto(String, String, String, String, String) - Constructor for record class org.springframework.ai.chat.messages.part.MediaPart.MediaDto

Creates an instance of a MediaDto record class.

MediaFetcher - Class in org.springframework.ai.bedrock.converse.api

Fetches media content from HTTP/HTTPS URLs with SSRF and resource-exhaustion protections.

MediaFetcher() - Constructor for class org.springframework.ai.bedrock.converse.api.MediaFetcher

Creates a MediaFetcher with no host allowlist (blocklist-only protection).

MediaFetcher(Set<String>) - Constructor for class org.springframework.ai.bedrock.converse.api.MediaFetcher

Creates a MediaFetcher with an optional host allowlist.

MediaPart - Record Class in org.springframework.ai.chat.messages.part

A media element (image, audio, video, document) produced by the model or supplied by the caller.

MediaPart(Media, OpaquePayload, Map<String, String>) - Constructor for record class org.springframework.ai.chat.messages.part.MediaPart

Creates an instance of a MediaPart record class.

MediaPart.FromDto - Class in org.springframework.ai.chat.messages.part

Jackson converter from MediaPart.MediaDto to Media.

MediaPart.MediaDto - Record Class in org.springframework.ai.chat.messages.part

Serialized form of a Media.

MediaPart.ToDto - Class in org.springframework.ai.chat.messages.part

Jackson converter from Media to MediaPart.MediaDto.

MEDIUM - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiThinkingLevel

Balanced thinking for most tasks.

MEDIUM - Enum constant in enum class org.springframework.ai.model.ollama.autoconfigure.OllamaThinkProperties

MEDIUM - Static variable in record class org.springframework.ai.ollama.api.ThinkOption.ThinkLevel

Medium thinking level for GPT-OSS.

memory(Consumer<SessionMemoryAdvisor.Builder>) - Method in class org.springframework.ai.session.advisor.SessionAdvisors.Builder

Customizes the SessionMemoryAdvisor, its filters for example.

MemoryAdvisor - Interface in org.springframework.ai.chat.client.advisor.api

An advisor that owns the memory lifecycle: it stores, retrieves and updates the conversation a request belongs to, named by MemoryAdvisor.CONVERSATION_ID.

merge(AudioTranscriptionOptions) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

Merges the given runtime options into this builder.

merge(AudioTranscriptionOptions) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder

merge(TextToSpeechOptions) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder

merge(DeepSeekApi.ChatCompletionChunk, DeepSeekApi.ChatCompletionChunk) - Method in class org.springframework.ai.deepseek.api.DeepSeekStreamFunctionCallingHelper

merge(EmbeddingOptions) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder

merge(ImageOptions) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

merge(ImageOptions) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder

merge(MistralAiApi.ChatCompletionChunk, MistralAiApi.ChatCompletionChunk) - Method in class org.springframework.ai.mistralai.api.MistralAiStreamFunctionCallingHelper

Merge the previous and current ChatCompletionChunk into a single one.

merge(ModerationOptions) - Method in class org.springframework.ai.openai.OpenAiModerationOptions.Builder

merge(OllamaApi.ChatResponse, OllamaApi.ChatResponse) - Static method in class org.springframework.ai.ollama.api.OllamaApiHelper

merge(EventFilter) - Method in record class org.springframework.ai.session.EventFilter

Combines this filter with other, a configured filter with a per-request one over it: the types of other replace this filter's, its window too unless it is EventFilter.Window.ALL, and the excludeSynthetic and activeView flags are OR-ed, so either side can narrow the result.

mergeOption(T, T) - Static method in class org.springframework.ai.model.ModelOptionsUtils

Return the runtime value if not null, or else the default value.

mergeToolCallbacks(List<ToolCallback>, List<ToolCallback>) - Static method in interface org.springframework.ai.model.tool.ToolCallingChatOptions

mergeToolContext(Map<String, Object>, Map<String, Object>) - Static method in interface org.springframework.ai.model.tool.ToolCallingChatOptions

message - Variable in class org.springframework.ai.mcp.annotation.context.DefaultElicitationSpec

message - Variable in class org.springframework.ai.mcp.annotation.context.DefaultLoggingSpec

message - Variable in class org.springframework.ai.mcp.annotation.context.DefaultProgressSpec

message() - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingResponse

Returns the value of the message record component.

message() - Method in record class org.springframework.ai.chat.memory.repository.mongo.Conversation

Deprecated.

Returns the value of the message record component.

message() - Method in record class org.springframework.ai.chat.memory.repository.redis.AdvancedRedisChatMemoryRepository.MessageWithConversation

Deprecated.

Returns the value of the message record component.

message() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion.Choice

Returns the value of the message record component.

message() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns the value of the message record component.

message() - Method in class org.springframework.ai.mcp.annotation.context.DefaultElicitationSpec

message() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion.Choice

Returns the value of the message record component.

message() - Method in record class org.springframework.ai.model.tool.ToolCallDecision

Returns the value of the message record component.

message() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Returns the value of the message record component.

message(McpSchema.AudioContent...) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

message(McpSchema.AudioContent...) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

message(McpSchema.EmbeddedResource...) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

message(McpSchema.EmbeddedResource...) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

message(McpSchema.ImageContent...) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

message(McpSchema.ImageContent...) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

message(McpSchema.ResourceLink...) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

message(McpSchema.ResourceLink...) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

message(McpSchema.SamplingMessage...) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

message(McpSchema.SamplingMessage...) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

message(McpSchema.TextContent...) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

message(McpSchema.TextContent...) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

message(String) - Method in class org.springframework.ai.mcp.annotation.context.DefaultElicitationSpec

message(String) - Method in class org.springframework.ai.mcp.annotation.context.DefaultLoggingSpec

message(String) - Method in class org.springframework.ai.mcp.annotation.context.DefaultProgressSpec

message(String) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.ElicitationSpec

message(String) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.LoggingSpec

message(String) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.ProgressSpec

message(String...) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

message(Message) - Method in class org.springframework.ai.session.SessionEvent.Builder

The message a EventType.MESSAGE event wraps; required for that type, not allowed for any other.

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(String, String, Map<String, Object>) - Constructor for record class org.springframework.ai.chat.memory.repository.mongo.Conversation.Message

Deprecated.

Creates an instance of a Message record class.

Message(OllamaApi.Message.Role, String, List<String>, List<OllamaApi.Message.ToolCall>, String, String) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.Message

Creates an instance of a Message record class.

MESSAGE - Static variable in class org.springframework.ai.session.EventType

A conversation message; the event carries a Message.

MESSAGE_EVENT_TYPE - Static variable in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider

Deprecated.

Event type for JSON-RPC messages sent through the SSE connection.

MESSAGE_EVENT_TYPE - Static variable in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider

MESSAGE_EVENT_TYPE - Static variable in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider

Deprecated.

Event type for JSON-RPC messages sent through the SSE connection.

MESSAGE_EVENT_TYPE - Static variable in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider

Event type for JSON-RPC messages sent through the SSE connection.

MESSAGE_TYPE - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.MessageAttributes

Deprecated.

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

Default implementation of Usage for aggregated streaming responses.

MessageAttributes - Enum Class in org.springframework.ai.chat.memory.repository.neo4j

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory: org.springframework.ai.session.SessionRepository in spring-ai-session, with a JDBC store in spring-ai-session-jdbc. There is no session store for Neo4j yet; one is planned before 3.0.0, when this module is removed.

MessageBody(List<MessagePart>, Map<String, Object>) - Constructor for record class org.springframework.ai.session.support.SessionEventCodec.MessageBody

A body without an event payload, as a message event stores it.

MessageBody(List<MessagePart>, Map<String, Object>, Map<String, Object>) - Constructor for record class org.springframework.ai.session.support.SessionEventCodec.MessageBody

Creates an instance of a MessageBody record class.

MessageChatMemoryAdvisor - Class in org.springframework.ai.chat.client.advisor

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of SessionAdvisors and SessionMemoryAdvisor in spring-ai-session-advisor

MessageChatMemoryAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor

Deprecated.

messageEndpoint(String) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider.Builder

Deprecated.

Sets the endpoint URI where clients should send their JSON-RPC messages.

messageEndpoint(String) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStatelessServerTransport.Builder

Sets the endpoint URI where clients should send their JSON-RPC messages.

messageEndpoint(String) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider.Builder

Sets the endpoint URI where clients should send their JSON-RPC messages.

messageEndpoint(String) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider.Builder

Deprecated.

Sets the endpoint path where clients will send their messages.

messageEndpoint(String) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStatelessServerTransport.Builder

Sets the endpoint URI where clients should send their JSON-RPC messages.

messageEndpointSink - Variable in class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport

Deprecated.

Sink for managing the message endpoint URI provided by the server.

messageEndpointValidator(SseMessageEndpointValidator) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport.Builder

Deprecated.

Sets the validator that ensure the message endpoint returned over the SSE connection is valid.

messageFilter(MessageFilter) - Method in class org.springframework.ai.session.advisor.SessionMemoryAdvisor.Builder

The filter of what is stored: the request's user message and the reply's assistant messages; a rejected message is never stored and so never replayed, while the outgoing prompt is unaffected.

MessageFilter - Interface in org.springframework.ai.session

Decides which messages are stored in a session: the write-side counterpart of EventFilter, which selects the stored events a prompt reads.

MessagePart - Interface in org.springframework.ai.chat.messages.part

One element of the ordered content of a chat message.

messages - Variable in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

messages() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the messages record component.

messages() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the messages record component.

messages() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest

Returns the value of the messages record component.

messages() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Returns the value of the messages record component.

messages(List<Message>) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

messages(List<Message>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

messages(List<Message>) - Method in class org.springframework.ai.chat.prompt.Prompt.Builder

messages(List<DeepSeekApi.ChatCompletionMessage>) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set the messages comprising the conversation so far.

messages(List<OllamaApi.Message>) - Method in class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

messages(Message...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

messages(Message...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

messages(Message...) - Method in class org.springframework.ai.chat.prompt.Prompt.Builder

MessageToPromptConverter - Class in org.springframework.ai.bedrock

Converts a list of messages to a prompt for bedrock models.

messageToString(Message) - Method in class org.springframework.ai.bedrock.MessageToPromptConverter

messageType - Variable in class org.springframework.ai.chat.messages.AbstractMessage

The message type of the message.

messageType() - Method in record class org.springframework.ai.session.support.SessionEventCodec.EncodedEvent

Returns the value of the messageType record component.

MessageType - Enum Class in org.springframework.ai.chat.messages

Enumeration representing types of Messages in a chat application.

messageTypeMinContentLength(MessageType, Integer) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder

messageTypeMinContentLengths(Map<MessageType, Integer>) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder

messageTypes() - Method in record class org.springframework.ai.session.EventFilter

Returns the value of the messageTypes record component.

messageTypes(Set<MessageType>) - Method in class org.springframework.ai.session.EventFilter.Builder

Keeps only the events whose message is of one of these types; an event without a message never matches.

messageTypeTtl(Map<MessageType, AnthropicCacheTtl>) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder

messageTypeTtl(MessageType, AnthropicCacheTtl) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder

MessageWindowChatMemory - Class in org.springframework.ai.chat.memory

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory, org.springframework.ai.session.SessionService in spring-ai-session; a turn-aware window is EventFilter.lastN, and compaction replaces eviction

MessageWindowChatMemory.Builder - Class in org.springframework.ai.chat.memory

Deprecated.

MessageWithConversation(String, Message, long) - Constructor for record class org.springframework.ai.chat.memory.repository.redis.AdvancedRedisChatMemoryRepository.MessageWithConversation

Deprecated.

Creates an instance of a MessageWithConversation record class.

meta - Variable in class org.springframework.ai.mcp.annotation.context.DefaultElicitationSpec

meta - Variable in class org.springframework.ai.mcp.annotation.context.DefaultLoggingSpec

meta - Variable in class org.springframework.ai.mcp.annotation.context.DefaultProgressSpec

meta - Variable in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

meta - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

meta - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

meta() - Method in class org.springframework.ai.mcp.annotation.context.DefaultElicitationSpec

meta() - Method in record class org.springframework.ai.mcp.annotation.context.StructuredElicitResult

Returns the value of the meta record component.

meta() - Method in record class org.springframework.ai.mcp.annotation.McpMeta

Returns the value of the meta record component.

meta(String, Object) - Method in class org.springframework.ai.mcp.annotation.context.DefaultElicitationSpec

meta(String, Object) - Method in class org.springframework.ai.mcp.annotation.context.DefaultLoggingSpec

meta(String, Object) - Method in class org.springframework.ai.mcp.annotation.context.DefaultProgressSpec

meta(String, Object) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

meta(String, Object) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.ElicitationSpec

meta(String, Object) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.LoggingSpec

meta(String, Object) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.ProgressSpec

meta(String, Object) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

meta(Map<String, Object>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultElicitationSpec

meta(Map<String, Object>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultLoggingSpec

meta(Map<String, Object>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultProgressSpec

meta(Map<String, Object>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

meta(Map<String, Object>) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.ElicitationSpec

meta(Map<String, Object>) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.LoggingSpec

meta(Map<String, Object>) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.ProgressSpec

meta(Map<String, Object>) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

meta(Map<String, Object>) - Method in class org.springframework.ai.mcp.annotation.context.StructuredElicitResult.Builder

Sets the meta map.

metadata - Variable in class org.springframework.ai.chat.messages.AbstractMessage

Additional options for the message to influence the response, not a generative map.

metadata - Variable in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

metadata - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

metadata - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

metadata() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec

metadata() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

metadata() - Method in record class org.springframework.ai.chat.memory.repository.mongo.Conversation.Message

Deprecated.

Returns the value of the metadata record component.

metadata() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.AddEmbeddingsRequest

Returns the value of the metadata record component.

metadata() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Collection

Returns the value of the metadata record component.

metadata() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateCollectionRequest

Returns the value of the metadata record component.

metadata() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Embedding

Returns the value of the metadata record component.

metadata() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingResponse

Returns the value of the metadata record component.

metadata() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryResponse

Returns the value of the metadata record component.

metadata() - Method in class org.springframework.ai.session.CreateSessionRequest

metadata() - Method in class org.springframework.ai.session.Session

The metadata: the owner and agent attributes (SessionAttributes), tags, and whatever the application adds.

metadata() - Method in record class org.springframework.ai.session.support.SessionEventCodec.MessageBody

Returns the value of the metadata record component.

metadata() - Method in record class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.CouchbaseDocument

Returns the value of the metadata record component.

metadata() - Method in record class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBDocument

Returns the value of the metadata record component.

metadata() - Method in record class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.MongoDBDocument

Returns the value of the metadata record component.

metadata() - Method in record class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.OpenSearchDocument

Returns the value of the metadata record component.

metadata(Metadata) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

metadata(Map<String, String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

metadata(Map<String, String>) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

metadata(String, Object) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptSystemSpec

metadata(String, Object) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptUserSpec

metadata(String, Object) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec

metadata(String, Object) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

metadata(String, Object) - Method in class org.springframework.ai.chat.model.ChatResponse.Builder

metadata(String, Object) - Method in class org.springframework.ai.document.Document.Builder

Adds a single key-value pair to the metadata map.

metadata(String, Object) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

metadata(String, Object) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

metadata(String, Object) - Method in class org.springframework.ai.session.CreateSessionRequest.Builder

metadata(String, Object) - Method in class org.springframework.ai.session.Session.Builder

Adds one metadata entry.

metadata(String, Object) - Method in class org.springframework.ai.session.SessionEvent.Builder

Adds one metadata entry.

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<String, Object>) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptSystemSpec

metadata(Map<String, Object>) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptUserSpec

metadata(Map<String, Object>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec

metadata(Map<String, Object>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

metadata(Map<String, Object>) - Method in class org.springframework.ai.chat.messages.SystemMessage.Builder

metadata(Map<String, Object>) - Method in class org.springframework.ai.chat.messages.ToolResponseMessage.Builder

metadata(Map<String, Object>) - Method in class org.springframework.ai.chat.messages.UserMessage.Builder

metadata(Map<String, Object>) - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata.Builder

Add metadata to the Generation result.

metadata(Map<String, Object>) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder

metadata(Map<String, Object>) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadataBuilder

metadata(Map<String, Object>) - Method in class org.springframework.ai.document.Document.Builder

Replaces the metadata map with the given map.

metadata(Map<String, Object>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

metadata(Map<String, Object>) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

metadata(Map<String, Object>) - Method in class org.springframework.ai.session.CreateSessionRequest.Builder

metadata(Map<String, Object>) - Method in class org.springframework.ai.session.Session.Builder

Adds every entry of the map, keeping the ones already set.

metadata(Map<String, Object>) - Method in class org.springframework.ai.session.SessionEvent.Builder

Replaces the metadata.

metadata(ChatResponseMetadata) - Method in class org.springframework.ai.chat.model.ChatResponse.Builder

METADATA_COMPACTION_ID - Static variable in class org.springframework.ai.session.SessionEvent

Metadata key of a synthetic event: the id of the EventType.COMPACTION boundary it belongs to.

METADATA_COMPACTION_SOURCE - Static variable in class org.springframework.ai.session.SessionEvent

Metadata key naming the strategy that wrote a synthetic event.

METADATA_END_PAGE_NUMBER - Static variable in class org.springframework.ai.reader.pdf.PagePdfDocumentReader

METADATA_END_PAGE_NUMBER - Static variable in class org.springframework.ai.writer.FileDocumentWriter

METADATA_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

METADATA_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

METADATA_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

METADATA_FILE_NAME - Static variable in class org.springframework.ai.reader.pdf.PagePdfDocumentReader

METADATA_PARTIAL_TOOL_RESPONSES - Static variable in exception org.springframework.ai.model.tool.ToolCallLimitExceededException

ChatGenerationMetadata key under which the ToolResponseMessage.ToolResponses that completed successfully in the current batch before the limit was hit are attached to the Generation built by ToolCallLimitExceededException.buildGeneration().

METADATA_SOURCE - Static variable in class org.springframework.ai.reader.tika.TikaDocumentReader

Metadata key representing the source of the document.

METADATA_START_PAGE_NUMBER - Static variable in class org.springframework.ai.reader.pdf.PagePdfDocumentReader

METADATA_START_PAGE_NUMBER - Static variable in class org.springframework.ai.writer.FileDocumentWriter

METADATA_SYNTHETIC - Static variable in class org.springframework.ai.session.SessionEvent

Metadata key of the synthetic flag, a Boolean.

METADATA_TOOL_DESCRIPTION - Static variable in class org.springframework.ai.tool.toolsearch.index.vectorstore.VectorToolIndex

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

METADATA_TOOL_NAME - Static variable in class org.springframework.ai.tool.toolsearch.index.vectorstore.VectorToolIndex

MetadataField(String, SearchFieldDataType) - Constructor for record class org.springframework.ai.vectorstore.azure.AzureVectorStore.MetadataField

Creates an instance of a MetadataField record class.

MetadataField(String, WeaviateVectorStore.MetadataField.Type) - Constructor for record class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.MetadataField

Creates an instance of a MetadataField record class.

MetadataField(String, Schema.FieldType) - Constructor for record class org.springframework.ai.vectorstore.redis.RedisVectorStore.MetadataField

Creates an instance of a MetadataField record class.

metadataFieldName(String) - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore.Builder

Sets the metadata field name in the Azure Search index.

metadataFieldName(String) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBBuilder

Configures the name of the metadata field in the database.

metadataFieldName(String) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore.Builder

Configures the name of the field used for document metadata.

metadataFieldName(String) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgVectorStoreBuilder

Overrides the column name used for document metadata.

metadataFields(List<RedisVectorStore.MetadataField>) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the metadata fields.

metadataFields(List<Map<String, String>>) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig.Builder

Deprecated.

Sets the metadata field definitions for proper indexing.

metadataFields(List<Map<String, String>>) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository.Builder

Deprecated.

Sets the metadata field definitions for proper indexing.

metadataFields(RedisVectorStore.MetadataField...) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the metadata fields.

metadataFieldsToFilter(List<String>) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.Builder

Sets the metadata fields to filter in vector search.

metadataFilter(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

metadataMode - Variable in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties

metadataMode(MetadataMode) - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel.Builder

metadataMode(MetadataMode) - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions.Builder

metadataMode(MetadataMode) - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingModel.Builder

MetadataMode - Enum Class in org.springframework.ai.document

METADATAS - Enum constant in enum class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest.Include

metadataTag(String) - Method in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig.Builder

Adds a metadata tag name to extract from the HTML tags.

metadataTags - Variable in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig

metadataTags(List<String>) - Method in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig.Builder

Sets the metadata tags to extract from the HTML tags.

metaProvider() - Element in annotation interface org.springframework.ai.mcp.annotation.McpPrompt

Optional meta provider class that implements the MetaProvider interface.

metaProvider() - Element in annotation interface org.springframework.ai.mcp.annotation.McpResource

Optional meta provider class that supplies data for "_meta" field for this resource declaration.

metaProvider() - Element in annotation interface org.springframework.ai.mcp.annotation.McpTool

"_meta" field for the tool declaration.

MetaProvider - Interface in org.springframework.ai.mcp.annotation.context

Common interface for classes that provide metadata for the "_meta" field.

MetaUtils - Class in org.springframework.ai.mcp.annotation.common

Utility methods for working with MetaProvider metadata.

meterRegistry(MeterRegistry) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder

Sets the meter registry used to bind OkHttp connection-pool gauges (active/idle connections).

meterRegistry(MeterRegistry) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

Registers a meter registry to bind OkHttp connection-pool gauges (active/idle connections).

meterRegistry(MeterRegistry) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

Registers a meter registry to bind OkHttp connection-pool gauges (active/idle connections).

meterRegistry(MeterRegistry) - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder

meterRegistry(MeterRegistry) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatModel.Builder

meterTags(Iterable<Tag>) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

Tags applied to the connection-pool gauges registered with the MeterRegistry.

meterTags(Iterable<Tag>) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

Tags applied to the connection-pool gauges registered with the MeterRegistry.

method - Variable in class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback.AbstractBuilder

method - Variable in class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback

method - Variable in class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback.AbstractBuilder

method - Variable in class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback

method - Variable in class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback.AbstractBuilder

method - Variable in class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback

method - Variable in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

method - Variable in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback

method - Variable in class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback.AbstractBuilder

method - Variable in class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback

method - Variable in class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback.AbstractBuilder

method - Variable in class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback

method - Variable in class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback.AbstractBuilder

method - Variable in class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback

method - Variable in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback.AbstractBuilder

method - Variable in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback

method - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

method - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

method - Variable in class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback.AbstractBuilder

method - Variable in class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback

method(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback.AbstractBuilder

Set the method to create a callback for.

method(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback.AbstractBuilder

Set the method to create a callback for.

method(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback.AbstractBuilder

Set the method to create a callback for.

method(Method) - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

Set the method to create a callback for.

method(Method) - Method in class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback.AbstractBuilder

Set the method to create a callback for.

method(Method) - Method in class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback.AbstractBuilder

Set the method to create a callback for.

method(Method) - Method in class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback.AbstractBuilder

Set the method to create a callback for.

method(Method) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback.AbstractBuilder

Set the method to create a callback for.

method(Method) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

Set the method to create a callback for.

method(Method) - Method in class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback.AbstractBuilder

Set the method to create a callback for.

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

metricType(MetricType) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore.Builder

Configures the Milvus metric type to use for similarity calculations.

MICROSOFT_FOUNDRY - Enum constant in enum class org.springframework.ai.openai.setup.OpenAiSetup.ModelProvider

microsoftDeploymentName - Variable in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

microsoftDeploymentName - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

microsoftDeploymentName - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

microsoftFoundry(Boolean) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

microsoftFoundry(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

microsoftFoundry(Boolean) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

microsoftFoundryServiceVersion - Variable in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

microsoftFoundryServiceVersion - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

microsoftFoundryServiceVersion - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

microsoftFoundryServiceVersion(AzureOpenAIServiceVersion) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

microsoftFoundryServiceVersion(AzureOpenAIServiceVersion) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

microsoftFoundryServiceVersion(AzureOpenAIServiceVersion) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

MILVUS - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by Milvus.

MILVUS - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

milvusBuilder() - Static method in class org.springframework.ai.vectorstore.milvus.MilvusSearchRequest

Creates a new MilvusSearchRequest.MilvusBuilder for constructing a MilvusSearchRequest.

MilvusBuilder() - Constructor for class org.springframework.ai.vectorstore.milvus.MilvusSearchRequest.MilvusBuilder

milvusClient(MilvusVectorStoreProperties, MilvusServiceClientProperties, MilvusServiceClientConnectionDetails) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreAutoConfiguration

MilvusFilterExpressionConverter - Class in org.springframework.ai.vectorstore.milvus

Converts Filter.Expression into Milvus metadata filter expression format.

MilvusFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.milvus.MilvusFilterExpressionConverter

MilvusFilterExpressionConverter(String) - Constructor for class org.springframework.ai.vectorstore.milvus.MilvusFilterExpressionConverter

MilvusSearchRequest - Class in org.springframework.ai.vectorstore.milvus

A specialized SearchRequest for Milvus vector search, extending the base request with Milvus-specific parameters.

MilvusSearchRequest.MilvusBuilder - Class in org.springframework.ai.vectorstore.milvus

Builder class for constructing instances of MilvusSearchRequest.

MilvusServiceClientConnectionDetails - Interface in org.springframework.ai.vectorstore.milvus.autoconfigure

Connection details for a Milvus service client.

MilvusServiceClientProperties - Class in org.springframework.ai.vectorstore.milvus.autoconfigure

Parameters for Milvus client connection.

MilvusServiceClientProperties() - Constructor for class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

MilvusVectorStore - Class in org.springframework.ai.vectorstore.milvus

Milvus implementation of the VectorStore interface.

MilvusVectorStore(MilvusVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

MilvusVectorStore.Builder - Class in org.springframework.ai.vectorstore.milvus

MilvusVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.milvus.autoconfigure

Auto-configuration for Milvus Vector Store.

MilvusVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreAutoConfiguration

MilvusVectorStoreProperties - Class in org.springframework.ai.vectorstore.milvus.autoconfigure

Configuration properties for Milvus Vector Store.

MilvusVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

MilvusVectorStoreProperties.MilvusIndexType - Enum Class in org.springframework.ai.vectorstore.milvus.autoconfigure

MilvusVectorStoreProperties.MilvusMetricType - Enum Class in org.springframework.ai.vectorstore.milvus.autoconfigure

MIME_TYPE - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.MediaAttributes

Deprecated.

mimeType - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

mimeType - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

mimeType - Variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.ImageBuilder

The MIME type of the content of the image.

mimeType - Variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

mimeType() - Method in record class org.springframework.ai.chat.messages.part.MediaPart.MediaDto

Returns the value of the mimeType record component.

mimeType() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerificationFile

Returns the value of the mimeType record component.

mimeType() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Recording

Returns the value of the mimeType record component.

mimeType() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Sample

Returns the value of the mimeType record component.

mimeType() - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.ReplicatedVoice

Returns the value of the mimeType record component.

mimeType() - Element in annotation interface org.springframework.ai.mcp.annotation.McpResource

The MIME type of this resource, if known.

mimeType(String) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

Set the MIME type of the resource.

mimeType(MimeType) - Method in class org.springframework.ai.content.Media.Builder

Sets the MIME type for the media object.

MimeTypeDetector - Class in org.springframework.ai.google.genai

Gemini supports the following MIME types: image/gif image/png image/jpeg video/mov video/mpeg video/mp4 video/mpg video/avi video/wmv video/mpegps video/flv https://cloud.google.com/vertex-ai/docs/generative-ai/model-reference/gemini

MimeTypeDetector() - Constructor for class org.springframework.ai.google.genai.MimeTypeDetector

mimeTypeToStringConverter() - Method in class org.springframework.ai.vectorstore.mongodb.autoconfigure.MongoDBAtlasVectorStoreAutoConfiguration

MINIMAL - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiThinkingLevel

Matches the "no thinking" setting for most queries.

MINISTRAL_14B - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatModel

MINISTRAL_3B - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatModel

MINISTRAL_8B - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatModel

minP - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

minP(Double) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

MINUS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

MINUS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

MINUS() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.DecimalConstantContext

MINUS() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IntegerConstantContext

MINUS() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.LongConstantContext

mirostat - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

mirostat(Integer) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

mirostatEta - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

mirostatEta(Float) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

mirostatTau - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

mirostatTau(Float) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

MISTRAL - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

The 7B parameters model

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

MISTRAL_AI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider

AI system provided by Mistral.

MISTRAL_LARGE - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatModel

Deprecated, for removal: This API element is subject to removal in a future version.

MISTRAL_MEDIUM - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatModel

MISTRAL_MODERATION - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiModerationApi.Model

MISTRAL_NEMO - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

A 12B model with 128k context length, built by Mistral AI in collaboration with NVIDIA.

MISTRAL_OCR_LATEST - Enum constant in enum class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRModel

MISTRAL_SMALL - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatModel

mistralAiApi(MistralAiApi) - Method in class org.springframework.ai.mistralai.MistralAiChatModel.Builder

mistralAiApi(MistralAiApi) - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingModel.Builder

MistralAiApi - Class in org.springframework.ai.mistralai.api

Single-class, Java Client library for Mistral AI platform.

MistralAiApi(String, String, RestClient.Builder, WebClient.Builder, ResponseErrorHandler) - Constructor for class org.springframework.ai.mistralai.api.MistralAiApi

Create a new client API.

MistralAiApi.Builder - Class in org.springframework.ai.mistralai.api

MistralAiApi.ChatCompletion - Record Class in org.springframework.ai.mistralai.api

Represents a chat completion response returned by model, based on the provided input.

MistralAiApi.ChatCompletion.Choice - Record Class in org.springframework.ai.mistralai.api

Chat completion choice.

MistralAiApi.ChatCompletionChunk - Record Class in org.springframework.ai.mistralai.api

Represents a streamed chunk of a chat completion response returned by model, based on the provided input.

MistralAiApi.ChatCompletionChunk.ChunkChoice - Record Class in org.springframework.ai.mistralai.api

Chat completion choice.

MistralAiApi.ChatCompletionMessage - Record Class in org.springframework.ai.mistralai.api

Message comprising the conversation.

MistralAiApi.ChatCompletionMessage.ChatCompletionFunction - Record Class in org.springframework.ai.mistralai.api

The function definition.

MistralAiApi.ChatCompletionMessage.ContentChunk - Interface in org.springframework.ai.mistralai.api

Marker interface representing the different content chunks supported.

MistralAiApi.ChatCompletionMessage.ContentDeserializer - Class in org.springframework.ai.mistralai.api

MistralAiApi.ChatCompletionMessage.ContentSerializer - Class in org.springframework.ai.mistralai.api

MistralAiApi.ChatCompletionMessage.ImageUrlChunk - Record Class in org.springframework.ai.mistralai.api

MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl - Record Class in org.springframework.ai.mistralai.api

MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl.ImageDetail - Enum Class in org.springframework.ai.mistralai.api

MistralAiApi.ChatCompletionMessage.ReferenceChunk - Record Class in org.springframework.ai.mistralai.api

MistralAiApi.ChatCompletionMessage.Role - Enum Class in org.springframework.ai.mistralai.api

The role of the author of this message.

MistralAiApi.ChatCompletionMessage.TextChunk - Record Class in org.springframework.ai.mistralai.api

MistralAiApi.ChatCompletionMessage.ThinkChunk - Record Class in org.springframework.ai.mistralai.api

The reasoning of a reasoning model.

MistralAiApi.ChatCompletionMessage.ThinkingContentChunk - Interface in org.springframework.ai.mistralai.api

Marker interface representing the different thinking content chunks supported.

MistralAiApi.ChatCompletionMessage.ToolCall - Record Class in org.springframework.ai.mistralai.api

The relevant tool call.

MistralAiApi.ChatCompletionRequest - Record Class in org.springframework.ai.mistralai.api

Creates a model request for chat conversation.

MistralAiApi.ChatCompletionRequest.ReasoningEffort - Enum Class in org.springframework.ai.mistralai.api

Controls the reasoning effort level for adjustable reasoning models.

MistralAiApi.ChatCompletionRequest.ResponseFormat - Class in org.springframework.ai.mistralai.api

An object specifying the format that the model must output.

MistralAiApi.ChatCompletionRequest.ResponseFormat.Builder - Class in org.springframework.ai.mistralai.api

MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema - Class in org.springframework.ai.mistralai.api

JSON schema object that describes the format of the JSON object.

MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema.Builder - Class in org.springframework.ai.mistralai.api

MistralAiApi.ChatCompletionRequest.ResponseFormat.Type - Enum Class in org.springframework.ai.mistralai.api

MistralAiApi.ChatCompletionRequest.ToolChoice - Enum Class in org.springframework.ai.mistralai.api

Specifies a tool the model should use.

MistralAiApi.ChatModel - Enum Class in org.springframework.ai.mistralai.api

List of well-known Mistral chat models.

MistralAiApi.Embedding - Record Class in org.springframework.ai.mistralai.api

Represents an embedding vector returned by embedding endpoint.

MistralAiApi.EmbeddingList<T> - Record Class in org.springframework.ai.mistralai.api

List of multiple embedding responses.

MistralAiApi.EmbeddingModel - Enum Class in org.springframework.ai.mistralai.api

List of well-known Mistral embedding models.

MistralAiApi.EmbeddingRequest<T> - Record Class in org.springframework.ai.mistralai.api

Creates an embedding vector representing the input text.

MistralAiApi.FinishReason - Enum Class in org.springframework.ai.mistralai.api

The reason the model stopped generating tokens.

MistralAiApi.FunctionTool - Class in org.springframework.ai.mistralai.api

Represents a tool the model may call.

MistralAiApi.FunctionTool.Function - Class in org.springframework.ai.mistralai.api

Function definition.

MistralAiApi.FunctionTool.Type - Enum Class in org.springframework.ai.mistralai.api

Create a tool of type 'function' and the given function definition.

MistralAiApi.LogProbs - Record Class in org.springframework.ai.mistralai.api

Log probability information for the choice. anticipation of future changes.

MistralAiApi.LogProbs.Content - Record Class in org.springframework.ai.mistralai.api

Message content tokens with log probability information.

MistralAiApi.LogProbs.Content.TopLogProbs - Record Class in org.springframework.ai.mistralai.api

The most likely tokens and their log probability, at this token position.

MistralAiApi.Usage - Record Class in org.springframework.ai.mistralai.api

Usage statistics.

MistralAiChatAutoConfiguration - Class in org.springframework.ai.model.mistralai.autoconfigure

Chat Auto-configuration for Mistral AI.

MistralAiChatAutoConfiguration() - Constructor for class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatAutoConfiguration

mistralAiChatModel(MistralAiCommonProperties, MistralAiChatProperties, ObjectProvider<RestClient.Builder>, ObjectProvider<WebClient.Builder>, ToolCallingManager, ObjectProvider<RetryTemplate>, ObjectProvider<ResponseErrorHandler>, ObjectProvider<ObservationRegistry>, ObjectProvider<ChatModelObservationConvention>) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatAutoConfiguration

MistralAiChatModel - Class in org.springframework.ai.mistralai

Represents a Mistral AI Chat Model.

MistralAiChatModel(MistralAiApi, MistralAiChatOptions, ToolCallingManager, RetryTemplate, ObservationRegistry) - Constructor for class org.springframework.ai.mistralai.MistralAiChatModel

MistralAiChatModel.Builder - Class in org.springframework.ai.mistralai

MistralAiChatOptions - Class in org.springframework.ai.mistralai

Options for the Mistral AI Chat API.

MistralAiChatOptions(String, Double, Double, Integer, Boolean, Integer, MistralAiApi.ChatCompletionRequest.ResponseFormat, List<String>, MistralAiApi.ChatCompletionRequest.ReasoningEffort, Double, Double, Integer, List<MistralAiApi.FunctionTool>, MistralAiApi.ChatCompletionRequest.ToolChoice, List<ToolCallback>, Map<String, Object>) - Constructor for class org.springframework.ai.mistralai.MistralAiChatOptions

MistralAiChatOptions.AbstractBuilder<B extends MistralAiChatOptions.AbstractBuilder<B>> - Class in org.springframework.ai.mistralai

MistralAiChatOptions.Builder - Class in org.springframework.ai.mistralai

MistralAiChatProperties - Class in org.springframework.ai.model.mistralai.autoconfigure

Configuration properties for Mistral AI chat.

MistralAiChatProperties() - Constructor for class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

MistralAiChatProperties.Options - Class in org.springframework.ai.model.mistralai.autoconfigure

MistralAiCommonProperties - Class in org.springframework.ai.model.mistralai.autoconfigure

Common properties for Mistral AI.

MistralAiCommonProperties() - Constructor for class org.springframework.ai.model.mistralai.autoconfigure.MistralAiCommonProperties

MistralAiEmbeddingAutoConfiguration - Class in org.springframework.ai.model.mistralai.autoconfigure

Embedding Auto-configuration for Mistral AI.

MistralAiEmbeddingAutoConfiguration() - Constructor for class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingAutoConfiguration

mistralAiEmbeddingModel(MistralAiCommonProperties, MistralAiEmbeddingProperties, ObjectProvider<RestClient.Builder>, ObjectProvider<RetryTemplate>, ObjectProvider<ResponseErrorHandler>, ObjectProvider<ObservationRegistry>, ObjectProvider<EmbeddingModelObservationConvention>) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingAutoConfiguration

MistralAiEmbeddingModel - Class in org.springframework.ai.mistralai

Provides the Mistral AI Embedding Model.

MistralAiEmbeddingModel(MistralAiApi, MetadataMode, MistralAiEmbeddingOptions, RetryTemplate, ObservationRegistry) - Constructor for class org.springframework.ai.mistralai.MistralAiEmbeddingModel

MistralAiEmbeddingModel.Builder - Class in org.springframework.ai.mistralai

MistralAiEmbeddingOptions - Class in org.springframework.ai.mistralai

Options for the Mistral AI Embedding API.

MistralAiEmbeddingOptions(String, String) - Constructor for class org.springframework.ai.mistralai.MistralAiEmbeddingOptions

MistralAiEmbeddingOptions.Builder - Class in org.springframework.ai.mistralai

MistralAiEmbeddingProperties - Class in org.springframework.ai.model.mistralai.autoconfigure

Configuration properties for MistralAI embedding model.

MistralAiEmbeddingProperties() - Constructor for class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties

MistralAiEmbeddingProperties.Options - Class in org.springframework.ai.model.mistralai.autoconfigure

mistralAiModerationApi(MistralAiModerationApi) - Method in class org.springframework.ai.mistralai.moderation.MistralAiModerationModel.Builder

MistralAiModerationApi - Class in org.springframework.ai.mistralai.api

Mistral AI Moderation API.

MistralAiModerationApi(String, String, RestClient.Builder, ResponseErrorHandler) - Constructor for class org.springframework.ai.mistralai.api.MistralAiModerationApi

MistralAiModerationApi.Builder - Class in org.springframework.ai.mistralai.api

MistralAiModerationApi.Categories - Record Class in org.springframework.ai.mistralai.api

MistralAiModerationApi.CategoryScores - Record Class in org.springframework.ai.mistralai.api

MistralAiModerationApi.MistralAiModerationRequest - Record Class in org.springframework.ai.mistralai.api

MistralAiModerationApi.MistralAiModerationResponse - Record Class in org.springframework.ai.mistralai.api

MistralAiModerationApi.MistralAiModerationResult - Record Class in org.springframework.ai.mistralai.api

MistralAiModerationApi.Model - Enum Class in org.springframework.ai.mistralai.api

List of well-known Mistral moderation models.

MistralAiModerationAutoConfiguration - Class in org.springframework.ai.model.mistralai.autoconfigure

Moderation Auto-configuration for Mistral AI.

MistralAiModerationAutoConfiguration() - Constructor for class org.springframework.ai.model.mistralai.autoconfigure.MistralAiModerationAutoConfiguration

mistralAiModerationModel(MistralAiCommonProperties, MistralAiModerationProperties, ObjectProvider<RetryTemplate>, ObjectProvider<RestClient.Builder>, ObjectProvider<ResponseErrorHandler>) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiModerationAutoConfiguration

MistralAiModerationModel - Class in org.springframework.ai.mistralai.moderation

MistralAiModerationModel(MistralAiModerationApi, RetryTemplate, MistralAiModerationOptions) - Constructor for class org.springframework.ai.mistralai.moderation.MistralAiModerationModel

MistralAiModerationModel.Builder - Class in org.springframework.ai.mistralai.moderation

MistralAiModerationOptions - Class in org.springframework.ai.mistralai.moderation

MistralAiModerationOptions(String) - Constructor for class org.springframework.ai.mistralai.moderation.MistralAiModerationOptions

MistralAiModerationOptions.Builder - Class in org.springframework.ai.mistralai.moderation

MistralAiModerationProperties - Class in org.springframework.ai.model.mistralai.autoconfigure

MistralAiModerationProperties() - Constructor for class org.springframework.ai.model.mistralai.autoconfigure.MistralAiModerationProperties

MistralAiModerationProperties.Options - Class in org.springframework.ai.model.mistralai.autoconfigure

MistralAiModerationRequest(String, String) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationRequest

Creates an instance of a MistralAiModerationRequest record class.

MistralAiModerationResponse(String, String, MistralAiModerationApi.MistralAiModerationResult[]) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationResponse

Creates an instance of a MistralAiModerationResponse record class.

MistralAiModerationResult(MistralAiModerationApi.Categories, MistralAiModerationApi.CategoryScores) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationResult

Creates an instance of a MistralAiModerationResult record class.

MistralAiOcrAutoConfiguration - Class in org.springframework.ai.model.mistralai.autoconfigure

OCR Auto-configuration for Mistral AI OCR.

MistralAiOcrAutoConfiguration() - Constructor for class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrAutoConfiguration

MistralAiOcrOptions - Class in org.springframework.ai.mistralai.ocr

Options for Mistral AI OCR requests.

MistralAiOcrOptions(String, String, List<Integer>, Boolean, Integer, Integer) - Constructor for class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions

MistralAiOcrOptions.Builder - Class in org.springframework.ai.mistralai.ocr

MistralAiOcrProperties - Class in org.springframework.ai.model.mistralai.autoconfigure

Configuration properties for Mistral AI OCR.

MistralAiOcrProperties() - Constructor for class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

MistralAiOcrProperties.Options - Class in org.springframework.ai.model.mistralai.autoconfigure

MistralAiParentProperties - Class in org.springframework.ai.model.mistralai.autoconfigure

Parent properties for Mistral AI.

MistralAiParentProperties() - Constructor for class org.springframework.ai.model.mistralai.autoconfigure.MistralAiParentProperties

MistralAiRuntimeHints - Class in org.springframework.ai.mistralai.aot

The MistralAiRuntimeHints class is responsible for registering runtime hints for Mistral AI API classes.

MistralAiRuntimeHints() - Constructor for class org.springframework.ai.mistralai.aot.MistralAiRuntimeHints

MistralAiStreamFunctionCallingHelper - Class in org.springframework.ai.mistralai.api

Helper class to support Streaming function calling.

MistralAiStreamFunctionCallingHelper() - Constructor for class org.springframework.ai.mistralai.api.MistralAiStreamFunctionCallingHelper

mistralOcrApi(MistralAiCommonProperties, MistralAiOcrProperties, ObjectProvider<RestClient.Builder>, ObjectProvider<ResponseErrorHandler>) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrAutoConfiguration

MistralOcrApi - Class in org.springframework.ai.mistralai.ocr

Java Client library for the Mistral AI OCR API.

MistralOcrApi(String) - Constructor for class org.springframework.ai.mistralai.ocr.MistralOcrApi

Create a new MistralOcrApi instance.

MistralOcrApi(String, String) - Constructor for class org.springframework.ai.mistralai.ocr.MistralOcrApi

Create a new MistralOcrApi instance.

MistralOcrApi(String, String, RestClient.Builder) - Constructor for class org.springframework.ai.mistralai.ocr.MistralOcrApi

Create a new MistralOcrApi instance.

MistralOcrApi(String, String, RestClient.Builder, ResponseErrorHandler) - Constructor for class org.springframework.ai.mistralai.ocr.MistralOcrApi

Create a new MistralOcrApi instance.

MistralOcrApi.ExtractedImage - Record Class in org.springframework.ai.mistralai.ocr

Represents an extracted image from a page.

MistralOcrApi.OCRModel - Enum Class in org.springframework.ai.mistralai.ocr

List of well-known Mistral OCR models.

MistralOcrApi.OCRPage - Record Class in org.springframework.ai.mistralai.ocr

Represents OCR information for a single page.

MistralOcrApi.OCRPageDimensions - Record Class in org.springframework.ai.mistralai.ocr

Represents the dimensions of a PDF page's screenshot image.

MistralOcrApi.OCRRequest - Record Class in org.springframework.ai.mistralai.ocr

Represents the request for the OCR API.

MistralOcrApi.OCRRequest.Document - Interface in org.springframework.ai.mistralai.ocr

Represents the document to be processed, which can be either a document URL or an image URL.

MistralOcrApi.OCRRequest.DocumentURLChunk - Record Class in org.springframework.ai.mistralai.ocr

Represents a document URL chunk.

MistralOcrApi.OCRRequest.ImageURLChunk - Record Class in org.springframework.ai.mistralai.ocr

Represents an image URL chunk.

MistralOcrApi.OCRResponse - Record Class in org.springframework.ai.mistralai.ocr

Represents the response from the OCR API.

MistralOcrApi.OCRUsageInfo - Record Class in org.springframework.ai.mistralai.ocr

Represents usage information for the OCR request.

MockWeatherService - Class in org.springframework.ai.test.chat.client.advisor

Mock weather service for testing tool call functionality.

MockWeatherService() - Constructor for class org.springframework.ai.test.chat.client.advisor.MockWeatherService

MockWeatherService.Request - Record Class in org.springframework.ai.test.chat.client.advisor

Weather Function request.

MockWeatherService.Response - Record Class in org.springframework.ai.test.chat.client.advisor

Weather Function response.

MockWeatherService.Unit - Enum Class in org.springframework.ai.test.chat.client.advisor

Temperature units.

ModalityUtils() - Constructor for class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityUtils

mode() - Method in record class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice

Returns the value of the mode record component.

mode(GoogleGenAiChatOptions.ToolChoice.Mode) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice.Builder

model - Variable in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

model - Variable in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

model() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingList

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingRequest

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationRequest

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationResponse

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRResponse

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.ollama.api.OllamaApi.DeleteModelRequest

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsRequest

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsResponse

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.ollama.api.OllamaApi.PullModelRequest

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelRequest

Returns the value of the model record component.

model() - Method in record class org.springframework.ai.openai.responses.HostedTool.ImageGeneration

Returns the value of the model record component.

model(Model) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

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.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set the ID of the model to use.

model(String) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

Sets the model ID using the generic 'model' property.

model(String) - Method in class org.springframework.ai.embedding.DefaultEmbeddingOptions.Builder

model(String) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent.Builder

model(String) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

model(String) - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.Builder

model(String) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

model(String) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.Builder

model(String) - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingOptions.Builder

model(String) - Method in class org.springframework.ai.mistralai.moderation.MistralAiModerationOptions.Builder

model(String) - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions.Builder

model(String) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

model(String) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

model(String) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

model(String) - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions.Builder

model(String) - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions.Builder

model(String) - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.Builder

model(DeepSeekApi.ChatModel) - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

model(GoogleGenAiChatModel.ChatModel) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

model(MistralAiApi.ChatModel) - Method in class org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder

model(OllamaModel) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

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 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.google.genai.cache.CachedContentRequest.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(GoogleGenAiImageModelName) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

model(GoogleGenAiTextEmbeddingModelName) - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.Builder

model(OllamaModel) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

model(VertexAiMultimodalEmbeddingModelName) - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions.Builder

model(VertexAiTextEmbeddingModelName) - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.Builder

Model<TReq extends ModelRequest<?>,TRes extends ModelResponse<?>> - Interface in org.springframework.ai.model

The Model interface provides a generic API for invoking AI models.

Model(String, String, Instant, Long, String, OllamaApi.Model.Details) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.Model

Creates an instance of a Model record class.

MODEL - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.GeminiMessageType

MODEL_LENGTH - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.FinishReason

The content was omitted due to a flag from our content filters.

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.

modelfile() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Returns the value of the modelfile record component.

modelHint(String) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec.DefaultModelPreferenceSpec

modelHint(String) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.ModelPreferenceSpec

modelHints(String...) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec.DefaultModelPreferenceSpec

modelHints(String...) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.ModelPreferenceSpec

modelId() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Returns the value of the modelId record component.

modelId() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerifiedVoiceLanguage

Returns the value of the modelId record component.

modelId(String) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.Builder

modelId(String) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

Sets the model ID using the ElevenLabs specific 'modelId' property.

modelInfo() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Returns the value of the modelInfo record component.

MODELING_COMPOUND - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

modelManagementOptions(ModelManagementOptions) - Method in class org.springframework.ai.ollama.OllamaChatModel.Builder

modelManagementOptions(ModelManagementOptions) - Method in class org.springframework.ai.ollama.OllamaEmbeddingModel.Builder

ModelManagementOptions - Record Class in org.springframework.ai.ollama.management

Options for managing models in Ollama.

ModelManagementOptions(PullModelStrategy, List<String>, Duration, Integer) - Constructor for record class org.springframework.ai.ollama.management.ModelManagementOptions

Creates an instance of a ModelManagementOptions record class.

ModelManagementOptions.Builder - Class in org.springframework.ai.ollama.management

modelName() - Method in record class org.springframework.ai.google.genai.GoogleGenAiChatModel.GeminiRequest

Returns the value of the modelName record component.

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

modelPreferences - Variable in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

modelPreferences(Consumer<McpRequestContextTypes.ModelPreferenceSpec>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

modelPreferences(Consumer<McpRequestContextTypes.ModelPreferenceSpec>) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

ModelRequest<T> - Interface in org.springframework.ai.model

Interface representing a request to an AI model.

ModelResponse<T extends ModelResult<?>> - 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.

models() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ListModelResponse

Returns the value of the models record component.

ModelTypeInit() - Constructor for class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties.ModelTypeInit

ModelUsageMetricsGenerator - Class in org.springframework.ai.model.observation

Generate metrics about the model usage in the context of an AI operation.

modeNames - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

moderate(MistralAiModerationApi.MistralAiModerationRequest) - Method in class org.springframework.ai.mistralai.api.MistralAiModerationApi

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

moderationCheck() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the moderationCheck record component.

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

modifiedAt() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model

Returns the value of the modifiedAt record component.

modifiedAt() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Returns the value of the modifiedAt record component.

MongoChatMemoryAutoConfiguration - Class in org.springframework.ai.model.chat.memory.repository.mongo.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of the session memory auto-configuration, SessionServiceAutoConfiguration in spring-ai-autoconfigure-model-session. There is no session store for MongoDB yet; one is planned before 3.0.0, when this module is removed.

MongoChatMemoryAutoConfiguration() - Constructor for class org.springframework.ai.model.chat.memory.repository.mongo.autoconfigure.MongoChatMemoryAutoConfiguration

Deprecated.

MongoChatMemoryIndexCreatorAutoConfiguration - Class in org.springframework.ai.model.chat.memory.repository.mongo.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of the session memory auto-configuration, SessionServiceAutoConfiguration in spring-ai-autoconfigure-model-session. There is no session store for MongoDB yet; one is planned before 3.0.0, when this module is removed.

MongoChatMemoryIndexCreatorAutoConfiguration(MongoTemplate, MongoChatMemoryProperties) - Constructor for class org.springframework.ai.model.chat.memory.repository.mongo.autoconfigure.MongoChatMemoryIndexCreatorAutoConfiguration

Deprecated.

MongoChatMemoryProperties - Class in org.springframework.ai.model.chat.memory.repository.mongo.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of the session memory auto-configuration, SessionServiceAutoConfiguration in spring-ai-autoconfigure-model-session. There is no session store for MongoDB yet; one is planned before 3.0.0, when this module is removed.

MongoChatMemoryProperties() - Constructor for class org.springframework.ai.model.chat.memory.repository.mongo.autoconfigure.MongoChatMemoryProperties

Deprecated.

MongoChatMemoryRepository - Class in org.springframework.ai.chat.memory.repository.mongo

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory: org.springframework.ai.session.SessionRepository in spring-ai-session, with a JDBC store in spring-ai-session-jdbc. There is no session store for MongoDB yet; one is planned before 3.0.0, when this module is removed.

MongoChatMemoryRepository.Builder - Class in org.springframework.ai.chat.memory.repository.mongo

Deprecated.

mongoCustomConversions() - Method in class org.springframework.ai.vectorstore.mongodb.autoconfigure.MongoDBAtlasVectorStoreAutoConfiguration

MONGODB - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by MongoDB.

MONGODB_ATLAS - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

MongoDBAtlasFilterExpressionConverter - Class in org.springframework.ai.vectorstore.mongodb.atlas

Converts Filter.Expression into MongoDB Atlas metadata filter expression format.

MongoDBAtlasFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasFilterExpressionConverter

MongoDBAtlasVectorStore - Class in org.springframework.ai.vectorstore.mongodb.atlas

MongoDB Atlas-based vector store implementation using the Atlas Vector Search.

MongoDBAtlasVectorStore(MongoDBAtlasVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

MongoDBAtlasVectorStore.Builder - Class in org.springframework.ai.vectorstore.mongodb.atlas

MongoDBAtlasVectorStore.MongoDBDocument - Record Class in org.springframework.ai.vectorstore.mongodb.atlas

The representation of Document along with its embedding.

MongoDBAtlasVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.mongodb.autoconfigure

Auto-configuration for MongoDB Atlas Vector Store.

MongoDBAtlasVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.mongodb.autoconfigure.MongoDBAtlasVectorStoreAutoConfiguration

MongoDBAtlasVectorStoreProperties - Class in org.springframework.ai.vectorstore.mongodb.autoconfigure

Configuration properties for MongoDB Atlas Vector Store.

MongoDBAtlasVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.mongodb.autoconfigure.MongoDBAtlasVectorStoreProperties

MongoDBDocument(String, String, Map<String, Object>, float[]) - Constructor for record class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.MongoDBDocument

Creates an instance of a MongoDBDocument record class.

mongoTemplate(MongoTemplate) - Method in class org.springframework.ai.chat.memory.repository.mongo.MongoChatMemoryRepository.Builder

Deprecated.

MOONDREAM - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

A small vision language model designed to run efficiently on edge devices.

MP3 - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.AudioResponseFormat

MP3 - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.AudioResponseFormat

MP3_22050_32 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

MP3_44100_128 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

MP3_44100_192 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

MP3_44100_32 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

MP3_44100_64 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

MP3_44100_96 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

MULTI_BATCH_ENTRY_COUNT - Static variable in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

Number of distinct entries upserted by AbstractVectorStoreUpsertTests.pairingAcrossBatches().

MULTI_MODAL_EMBEDDING_MODEL - Static variable in class org.springframework.ai.model.SpringAIModelProperties

multiBlockSystemCaching(boolean) - Method in class org.springframework.ai.bedrock.converse.api.BedrockCacheOptions.Builder

Sets whether multi-block system message caching is enabled.

multiBlockSystemCaching(Boolean) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder

MULTIMODAL_EMBEDDING_001 - Enum constant in enum class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingModelName

Multimodal model.Expires on May 14, 2025.

multimodalEmbedding(VertexAiEmbeddingConnectionDetails, VertexAiMultimodalEmbeddingProperties) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultiModalEmbeddingAutoConfiguration

MultimodalInstanceBuilder() - Constructor for class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.MultimodalInstanceBuilder

MultiQueryExpander - Class in org.springframework.ai.rag.preretrieval.query.expansion

Uses a large language model to expand a query into multiple semantically diverse variations to capture different perspectives, useful for retrieving additional contextual information and increasing the chances of finding relevant results.

MultiQueryExpander(ChatClient.Builder, PromptTemplate, Boolean, Integer) - Constructor for class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander

MultiQueryExpander.Builder - Class in org.springframework.ai.rag.preretrieval.query.expansion

MultiSpeakerTurn(String, String) - Constructor for record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.MultiSpeakerTurn

Creates an instance of a MultiSpeakerTurn record class.

multiSpeakerTurns(List<GoogleGenAiAudioSpeechOptions.MultiSpeakerTurn>) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.Builder

MutableResponseMetadata - Class in org.springframework.ai.model

MutableResponseMetadata() - Constructor for class org.springframework.ai.model.MutableResponseMetadata

mutate() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

mutate() - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions

mutate() - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisorChain

Returns a new BaseAdvisorChain.Builder initialized with this chain's advisors and configuration, allowing it to be selectively modified before building a new chain.

mutate() - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain

mutate() - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

Return a ChatClient.Builder to create a new ChatClient whose settings are replicated from this ChatClientRequest.

mutate() - Method in interface org.springframework.ai.chat.client.ChatClient

Return a ChatClient.Builder to create a new ChatClient whose settings are replicated from the default ChatClient.ChatClientRequestSpec of this client.

mutate() - Method in record class org.springframework.ai.chat.client.ChatClientRequest

mutate() - Method in record class org.springframework.ai.chat.client.ChatClientResponse

mutate() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

Return a ChatClient.Builder to create a new ChatClient whose settings are replicated from this ChatClientRequest.

mutate() - Method in class org.springframework.ai.chat.client.DefaultChatClient

Return a ChatClient.Builder to create a new ChatClient whose settings are replicated from this ChatClientRequest.

mutate() - Method in class org.springframework.ai.chat.messages.AssistantMessage

A builder pre-populated with this message's parts and metadata.

mutate() - Method in class org.springframework.ai.chat.messages.SystemMessage

mutate() - Method in class org.springframework.ai.chat.messages.ToolResponseMessage

A builder pre-populated with this message's parts and metadata.

mutate() - Method in class org.springframework.ai.chat.messages.UserMessage

A builder pre-populated with this message's parts and metadata.

mutate() - Method in interface org.springframework.ai.chat.prompt.ChatOptions

Returns a new ChatOptions.Builder initialized with the values of this ChatOptions.

mutate() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions

mutate() - Method in class org.springframework.ai.chat.prompt.Prompt

mutate() - Method in class org.springframework.ai.chat.prompt.PromptTemplate

mutate() - Method in class org.springframework.ai.deepseek.DeepSeekAssistantMessage

Deprecated.

A builder pre-populated with this message's parts and metadata, the prefix flag included.

mutate() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions

mutate() - Method in class org.springframework.ai.document.Document

Returns a new Document.Builder pre-populated with all fields of this document, allowing selective modification without altering the original.

mutate() - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions

mutate() - Method in class org.springframework.ai.mistralai.MistralAiChatOptions

mutate() - Method in class org.springframework.ai.model.tool.DefaultStructuredOutputChatOptions

mutate() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions

mutate() - Method in interface org.springframework.ai.model.tool.StructuredOutputChatOptions

Returns a new StructuredOutputChatOptions.Builder initialized with the values of this StructuredOutputChatOptions.

mutate() - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions

Returns a new ToolCallingChatOptions.Builder initialized with the values of this ToolCallingChatOptions.

mutate() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

mutate() - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel

Creates a builder initialized with this model's configuration.

mutate() - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel

Creates a builder initialized with this model's configuration.

mutate() - Method in class org.springframework.ai.openai.OpenAiChatOptions

mutate() - Method in class org.springframework.ai.openai.OpenAiModerationModel

mutate() - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

mutate() - Method in record class org.springframework.ai.rag.Query

MXBAI_EMBED_LARGE - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

State-of-the-art large embedding model from mixedbread.ai

MysqlChatMemoryRepositoryDialect - Class in org.springframework.ai.chat.memory.repository.jdbc

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of MysqlJdbcSessionRepositoryDialect in spring-ai-session-jdbc

MysqlChatMemoryRepositoryDialect() - Constructor for class org.springframework.ai.chat.memory.repository.jdbc.MysqlChatMemoryRepositoryDialect

Deprecated.

MysqlJdbcSessionRepositoryDialect - Class in org.springframework.ai.session.jdbc

The dialect of MySQL and MariaDB.

MysqlJdbcSessionRepositoryDialect() - Constructor for class org.springframework.ai.session.jdbc.MysqlJdbcSessionRepositoryDialect

N

n - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

n() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the n record component.

n() - Method in record class org.springframework.ai.session.EventFilter.Window.Last

Returns the value of the n record component.

n(Integer) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

n(Integer) - Method in class org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder

n(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

n(Integer) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder

n(Integer) - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions.Builder

n(Integer) - Method in class org.springframework.ai.image.ImageOptionsBuilder

name - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

name - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

name - Variable in enum class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Neo4jDistanceType

name() - Method in record class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.SchemaColumn

Deprecated.

Returns the value of the name record component.

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.part.MediaPart.MediaDto

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.chat.messages.part.ToolResultPart

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() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Collection

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateCollectionRequest

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateDatabaseRequest

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateTenantRequest

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Database

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Tenant

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.ChatCompletionFunction

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the name record component.

name() - Element in annotation interface org.springframework.ai.mcp.annotation.McpArg

Argument name.

name() - Element in annotation interface org.springframework.ai.mcp.annotation.McpPrompt

Unique identifier for the prompt

name() - Element in annotation interface org.springframework.ai.mcp.annotation.McpResource

Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn’t present).

name() - Element in annotation interface org.springframework.ai.mcp.annotation.McpTool

The name of the tool.

name() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.NamedClientMcpTransport

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ChatCompletionFunction

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool.Function

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message.ToolCallFunction

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model

Returns the value of the name record component.

name() - Method in class org.springframework.ai.session.EventType

The name, as stores keep it and as JSON carries it.

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() - Method in record class org.springframework.ai.vectorstore.azure.AzureVectorStore.MetadataField

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.SchemaColumn

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.vectorstore.redis.RedisVectorStore.MetadataField

Returns the value of the name record component.

name() - Method in record class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.MetadataField

Returns the value of the name record component.

name(String) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent.Builder

name(String) - Method in class org.springframework.ai.bedrock.converse.api.StreamingToolCallBuilder

name(String) - Method in class org.springframework.ai.content.Media.Builder

Sets the name for the media object.

name(String) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

Set the name of the resource.

name(String) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema.Builder

name(String) - Method in class org.springframework.ai.tool.definition.DefaultToolDefinition.Builder

NAME - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.MediaAttributes

Deprecated.

NAME - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolCallAttributes

Deprecated.

NAME - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolResponseAttributes

Deprecated.

nameCheck() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharingModerationCheck

Returns the value of the nameCheck record component.

NamedClientMcpTransport - Record Class in org.springframework.ai.mcp.client.common.autoconfigure

A named MCP client transport.

NamedClientMcpTransport(String, McpClientTransport) - Constructor for record class org.springframework.ai.mcp.client.common.autoconfigure.NamedClientMcpTransport

Creates an instance of a NamedClientMcpTransport record class.

namespace(String) - Method in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore.Builder

Sets the Pinecone namespace.

namespace(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

namespace(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder

nameValue() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharingModerationCheck

Returns the value of the nameValue record component.

nativeExpression(String) - Method in class org.springframework.ai.vectorstore.milvus.MilvusSearchRequest.MilvusBuilder

Sets the native Milvus filter expression.

ne(String, Object) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

NE - Enum constant in enum class org.springframework.ai.vectorstore.filter.Filter.ExpressionType

NE - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

NE - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

NE() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.CompareContext

negate() - Method in interface org.springframework.ai.session.MessageFilter

A filter that stores what this filter rejects, and the other way round.

negate(Filter.Operand) - Static method in class org.springframework.ai.vectorstore.filter.FilterHelper

Transforms the input expression into a semantically equivalent one with negation operators propagated thought the expression tree by following the negation rules:

NEGATIVE_INNER_PRODUCT - Enum constant in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgDistanceType

NEO4J - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by Neo4j.

NEO4J - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

neo4jChatMemoryRepository(Neo4jChatMemoryRepositoryProperties, Driver) - Method in class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryAutoConfiguration

Deprecated.

Neo4jChatMemoryRepository - Class in org.springframework.ai.chat.memory.repository.neo4j

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory: org.springframework.ai.session.SessionRepository in spring-ai-session, with a JDBC store in spring-ai-session-jdbc. There is no session store for Neo4j yet; one is planned before 3.0.0, when this module is removed.

Neo4jChatMemoryRepository(Neo4jChatMemoryRepositoryConfig) - Constructor for class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepository

Deprecated.

Neo4jChatMemoryRepositoryAutoConfiguration - Class in org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of the session memory auto-configuration, SessionServiceAutoConfiguration in spring-ai-autoconfigure-model-session. There is no session store for Neo4j yet; one is planned before 3.0.0, when this module is removed.

Neo4jChatMemoryRepositoryAutoConfiguration() - Constructor for class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryAutoConfiguration

Deprecated.

Neo4jChatMemoryRepositoryConfig - Class in org.springframework.ai.chat.memory.repository.neo4j

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory: org.springframework.ai.session.SessionRepository in spring-ai-session, with a JDBC store in spring-ai-session-jdbc. There is no session store for Neo4j yet; one is planned before 3.0.0, when this module is removed.

Neo4jChatMemoryRepositoryConfig.Builder - Class in org.springframework.ai.chat.memory.repository.neo4j

Deprecated.

Neo4jChatMemoryRepositoryProperties - Class in org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of the session memory auto-configuration, SessionServiceAutoConfiguration in spring-ai-autoconfigure-model-session. There is no session store for Neo4j yet; one is planned before 3.0.0, when this module is removed.

Neo4jChatMemoryRepositoryProperties() - Constructor for class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryProperties

Deprecated.

Neo4jVectorFilterExpressionConverter - Class in org.springframework.ai.vectorstore.neo4j.filter

Converts Filter.Expression into Neo4j condition expression format.

Neo4jVectorFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.neo4j.filter.Neo4jVectorFilterExpressionConverter

Neo4jVectorStore - Class in org.springframework.ai.vectorstore.neo4j

Neo4j-based vector store implementation using Neo4j's vector search capabilities.

Neo4jVectorStore(Neo4jVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore

Neo4jVectorStore.Builder - Class in org.springframework.ai.vectorstore.neo4j

Neo4jVectorStore.Neo4jDistanceType - Enum Class in org.springframework.ai.vectorstore.neo4j

An enum to configure the distance function used in the Neo4j vector index.

Neo4jVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.neo4j.autoconfigure

Auto-configuration for Neo4j Vector Store.

Neo4jVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreAutoConfiguration

Neo4jVectorStoreProperties - Class in org.springframework.ai.vectorstore.neo4j.autoconfigure

Configuration properties for Neo4j Vector Store.

Neo4jVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

NEON_PUNK - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

NEURAL_CHAT - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

A fine-tuned Mistral model

NEVER - Enum constant in enum class org.springframework.ai.ollama.management.PullModelStrategy

Never pull the model.

NeverEvictStrategy - Class in org.springframework.ai.tool.toolsearch.eviction

A ToolIndexEvictionStrategy that never evicts sessions automatically.

newCopy() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder

Factory method called by ToolCallingAdvisor.Builder.copy() to create the blank builder instance that will receive the copied fields.

newCopy() - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor.Builder

newest(List<SessionEvent>) - Static method in record class org.springframework.ai.session.compaction.CompactionBoundary

The newest boundary of a log, or null when the log was never compacted.

newSession(String) - Method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

Saves a new session with a random id for the given principal.

NEXT - Enum constant in enum class org.springframework.ai.model.transformer.SummaryMetadataEnricher.SummaryType

nextCall(ChatClientRequest) - Method in interface org.springframework.ai.chat.client.advisor.api.CallAdvisorChain

Invokes the next CallAdvisor in the CallAdvisorChain with the given request.

nextCall(ChatClientRequest) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain

nextMaxVerificationAttemptsResetUnixMs() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns the value of the nextMaxVerificationAttemptsResetUnixMs record component.

nextRequestIds() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Returns the value of the nextRequestIds record component.

nextRequestIds(List<String>) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.Builder

nextRequestIds(List<String>) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

nextStream(ChatClientRequest) - Method in interface org.springframework.ai.chat.client.advisor.api.StreamAdvisorChain

Invokes the next StreamAdvisor in the StreamAdvisorChain with the given request.

nextStream(ChatClientRequest) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain

nextText() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Returns the value of the nextText record component.

nextText(String) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.Builder

nextText(String) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

nin(String, Object...) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

nin(String, List<Object>) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

NIN - Enum constant in enum class org.springframework.ai.vectorstore.filter.Filter.ExpressionType

NIN - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

NIN - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

NIN() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NinExpressionContext

NinExpressionContext(FiltersParser.BooleanExpressionContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NinExpressionContext

NO_JSON_SCHEMA - Static variable in interface org.springframework.ai.converter.StructuredOutputConverter

Constant for when there is no JSON schema available.

NOMIC_EMBED_TEXT - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

A high-performing open embedding model with a large token context window.

none() - Static method in interface org.springframework.ai.model.tool.ToolCallConfirmationPolicy

No call needs confirmation.

NONE - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCacheStrategy

No caching (default behavior).

NONE - Enum constant in enum class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest.Truncate

Returns an error when the input exceeds the maximum input token length.

NONE - Enum constant in enum class org.springframework.ai.bedrock.converse.api.BedrockCacheStrategy

No caching (default behavior).

NONE - Enum constant in enum class org.springframework.ai.document.MetadataMode

NONE - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.SafetyControlEnum

NONE - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice.Mode

Model will not call any functions.

NONE - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ReasoningEffort

NONE - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ToolChoice

NONE - Enum constant in enum class org.springframework.ai.template.ValidationMode

No validation is performed.

NONE - Enum constant in enum class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore.IndexType

No index, use brute force exact calculation.

NONE - Enum constant in enum class org.springframework.ai.vectorstore.oracle.OracleVectorStore.OracleVectorStoreIndexType

Performs exact nearest neighbor search.

NONE - Enum constant in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgIndexType

Performs exact nearest neighbor search, which provides perfect recall.

NONE - Static variable in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.ToolChoiceBuilder

Model will not call a function and instead generates a message

NonStatelessServerCondition() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.McpServerAutoConfiguration.NonStatelessServerCondition

NonTransientAiException - Exception in org.springframework.ai.retry

Root of the hierarchy of Model access exceptions that are considered non-transient - where a retry of the same operation would fail unless the cause of the Exception is corrected.

NonTransientAiException(String) - Constructor for exception org.springframework.ai.retry.NonTransientAiException

Constructor with message.

NonTransientAiException(String, Throwable) - Constructor for exception org.springframework.ai.retry.NonTransientAiException

Constructor with message and cause.

noOp() - Static method in interface org.springframework.ai.mcp.ToolContextToMcpMetaConverter

Static factory method to create a no-op converter that returns an empty map.

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

NoOpTemplateRenderer - Class in org.springframework.ai.template

No-op implementation of TemplateRenderer that returns the template unchanged.

NoOpTemplateRenderer() - Constructor for class org.springframework.ai.template.NoOpTemplateRenderer

noPrefix() - Static method in interface org.springframework.ai.mcp.McpToolNamePrefixGenerator

Static factory method to create a no-op prefix generator that returns the tool name

norm(float[]) - Static method in class org.springframework.ai.vectorstore.SimpleVectorStore.EmbeddingMath

normalizeDateString(Object) - Static method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

If the value is a string matching the ISO date pattern, parse and return as Date so that all converters that handle Date automatically support date strings.

normalizeURL(String) - Static method in class org.springframework.ai.bedrock.converse.api.URLValidator

Attempts to fix common URL issues Adds protocol if missing, removes extra spaces

not(FilterExpressionBuilder.Op) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

NOT - Enum constant in enum class org.springframework.ai.vectorstore.filter.Filter.ExpressionType

NOT - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

NOT - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

NOT() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNotNullExpressionContext

NOT() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NinExpressionContext

NOT() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NotExpressionContext

NOT_REQUESTED - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.ReviewStatusEnum

NOT_RUN_TOOL_RESULT - Static variable in class org.springframework.ai.session.advisor.SessionTurnAdvisor

The result a tool call gets in the log when the loop ended before it ran.

NotExpressionContext(FiltersParser.BooleanExpressionContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NotExpressionContext

noticePeriod() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the noticePeriod record component.

notifyClient(String, String, Object) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider

Deprecated.

Sends a JSON-RPC notification to a specific client session through its SSE connection.

notifyClient(String, String, Object) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider

notifyClient(String, String, Object) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider

Deprecated.

notifyClient(String, String, Object) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider

notifyClients(String, Object) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider

Deprecated.

Broadcasts a JSON-RPC message to all connected clients through their SSE connections.

notifyClients(String, Object) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider

notifyClients(String, Object) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider

Deprecated.

Broadcasts a notification to all connected clients through their SSE connections.

notifyClients(String, Object) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider

Broadcasts a notification to all connected clients through their SSE connections.

NOVA - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Voice

NOVA - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.Voice

nResults() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest

Returns the value of the nResults record component.

NULL - Static variable in interface org.springframework.ai.audio.transcription.AudioTranscriptionMetadata

NULL - Static variable in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata

NULL - Static variable in class org.springframework.ai.openai.metadata.OpenAiAudioSpeechResponseMetadata

NULL - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

NULL - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

NULL() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNotNullExpressionContext

NULL() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IsNullExpressionContext

numBatch - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

numBatch(Integer) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

numBatch(Integer) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

number(String) - Static method in record class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.MetadataField

Creates a metadata field of type NUMBER.

NUMBER - Enum constant in enum class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.MetadataField.Type

numberOfQueries(Integer) - Method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander.Builder

numCandidates(int) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.Builder

Sets the number of candidates for vector search.

numCtx - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

numCtx(Integer) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

numCtx(Integer) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

numeric(String) - Static method in record class org.springframework.ai.vectorstore.redis.RedisVectorStore.MetadataField

numGPU - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

numGPU(Integer) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

numGPU(Integer) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

numKeep - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

numKeep(Integer) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

numPredict(Integer) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

numThread - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

numThread(Integer) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

numThread(Integer) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

O

object() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion

Returns the value of the object record component.

object() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk

Returns the value of the object record component.

object() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion

Returns the value of the object record component.

object() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk

Returns the value of the object record component.

object() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.Embedding

Returns the value of the object record component.

object() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingList

Returns the value of the object record component.

objectFrom(Map<String, Object>, Class<T>) - Method in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolCallAttributes

Deprecated.

Extract and return this required attribute from the provided map, using type clazz.

ObservabilityHelper - Class in org.springframework.ai.observation

Utilities for observability.

observationConvention(AdvisorObservationConvention) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder

observationRegistry - Variable in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel.Builder

Sets the observation registry the model reports its calls to.

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel.Builder

Sets the observation registry the model reports its calls to.

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel.Builder

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.openai.OpenAiImageModel.Builder

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder

Sets the observation registry for metrics and tracing.

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

Registers the Micrometer observation registry used by the OkHttp interceptor.

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.deepseek.DeepSeekChatModel.Builder

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel.Builder

Sets the observation registry the model reports its calls to.

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatModel.Builder

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionModel.Builder

Sets the observation registry.

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechModel.Builder

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.mistralai.MistralAiChatModel.Builder

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingModel.Builder

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.ollama.OllamaChatModel.Builder

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.ollama.OllamaEmbeddingModel.Builder

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

Registers the Micrometer observation registry used by the OkHttp interceptor.

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder

Sets the observation registry for metrics and tracing.

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatModel.Builder

observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

observationRegistry(ObservationRegistry) - Method in interface org.springframework.ai.vectorstore.VectorStore.Builder

Sets the registry for collecting observations and metrics.

Observations() - Constructor for class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties.Observations

Observations() - Constructor for class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Observations

ObservationTestUtil - Class in org.springframework.ai.test.vectorstore

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

ocr(MistralOcrApi.OCRRequest) - Method in class org.springframework.ai.mistralai.ocr.MistralOcrApi

Performs OCR on a document and returns the extracted information.

OCRPage(Integer, String, List<MistralOcrApi.ExtractedImage>, MistralOcrApi.OCRPageDimensions) - Constructor for record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPage

Creates an instance of a OCRPage record class.

OCRPageDimensions(Integer, Integer, Integer) - Constructor for record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPageDimensions

Creates an instance of a OCRPageDimensions record class.

OCRRequest(String, String, MistralOcrApi.OCRRequest.Document, List<Integer>, Boolean, Integer, Integer) - Constructor for record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest

Creates an instance of a OCRRequest record class.

OCRResponse(List<MistralOcrApi.OCRPage>, String, MistralOcrApi.OCRUsageInfo, Integer, Integer) - Constructor for record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRResponse

Creates an instance of a OCRResponse record class.

OCRUsageInfo(Integer, Integer) - Constructor for record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRUsageInfo

Creates an instance of a OCRUsageInfo record class.

of() - Static method in record class org.springframework.ai.openai.responses.HostedTool.CodeInterpreter

of() - Static method in record class org.springframework.ai.openai.responses.HostedTool.ImageGeneration

of() - Static method in record class org.springframework.ai.openai.responses.HostedTool.WebSearch

of() - Static method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.MultimodalInstanceBuilder

of() - Static method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextParametersBuilder

of(Iterable<PromptMetadata.PromptFilterMetadata>) - 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(String) - Static method in record class org.springframework.ai.chat.messages.part.ReasoningPart

Creates a plain reasoning part with text only, replayable to any provider.

of(String) - Static method in record class org.springframework.ai.chat.messages.part.TextPart

Creates a text part without payload or attributes.

of(String) - Static method in class org.springframework.ai.session.EventType

The event type with the given name: a well-known one, or an application's own.

of(String) - Static method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextInstanceBuilder

of(String...) - Static method in record class org.springframework.ai.openai.responses.HostedTool.FileSearch

of(String, String) - Static method in record class org.springframework.ai.openai.responses.HostedTool.Mcp

of(AssistantMessage.ToolCall) - Static method in record class org.springframework.ai.chat.messages.part.ToolCallPart

Creates a tool call part without payload or attributes.

of(Message) - Static method in class org.springframework.ai.session.compaction.EventText

The text of a message.

of(ToolResponseMessage.ToolResponse) - Static method in record class org.springframework.ai.chat.messages.part.ToolResultPart

Wraps a legacy ToolResponseMessage.ToolResponse as a result part with a single text part.

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.

of(Media) - Static method in record class org.springframework.ai.chat.messages.part.MediaPart

Creates a media part without payload or attributes.

of(ToolCallDecision...) - Static method in record class org.springframework.ai.model.tool.ToolCallDecisions

The decisions, one per tool call.

of(SessionEvent) - Static method in class org.springframework.ai.session.compaction.EventText

The text of an event; empty for an event that carries no message.

of(Session, List<SessionEvent>) - Static method in record class org.springframework.ai.session.compaction.CompactionRequest

A request for the session and its view, counting the turns.

of(MimeType) - Static method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.ImageBuilder

of(MimeType) - Static method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

ofCharLocation(String, int, String, int, int) - Static method in class org.springframework.ai.anthropic.Citation

Create a character location citation for plain text documents.

ofContentBlockLocation(String, int, String, int, int) - Static method in class org.springframework.ai.anthropic.Citation

Create a content block location citation for custom content documents.

OFF - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.TextNormalizationMode

OFF - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmBlockThreshold

offset() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingsRequest

Returns the value of the offset record component.

ofPageLocation(String, int, String, int, int) - Static method in class org.springframework.ai.anthropic.Citation

Create a page location citation for PDF documents.

ofWebSearchResultLocation(String, String, String) - Static method in class org.springframework.ai.anthropic.Citation

Create a web search result location citation.

OLLAMA - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider

AI system provided by Ollama.

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

ollamaApi(OllamaConnectionDetails, ObjectProvider<RestClient.Builder>, ObjectProvider<WebClient.Builder>, ObjectProvider<ResponseErrorHandler>) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaApiAutoConfiguration

ollamaApi(OllamaApi) - Method in class org.springframework.ai.ollama.OllamaChatModel.Builder

ollamaApi(OllamaApi) - Method in class org.springframework.ai.ollama.OllamaEmbeddingModel.Builder

OllamaApi - Class in org.springframework.ai.ollama.api

Java Client for the Ollama API.

OllamaApi.Builder - Class in org.springframework.ai.ollama.api

OllamaApi.ChatRequest - Record Class in org.springframework.ai.ollama.api

Chat request object.

OllamaApi.ChatRequest.Builder - Class in org.springframework.ai.ollama.api

OllamaApi.ChatRequest.Tool - Record Class in org.springframework.ai.ollama.api

Represents a tool the model may call.

OllamaApi.ChatRequest.Tool.Function - Record Class in org.springframework.ai.ollama.api

Function definition.

OllamaApi.ChatRequest.Tool.Type - Enum Class in org.springframework.ai.ollama.api

Create a tool of type 'function' and the given function definition.

OllamaApi.ChatResponse - Record Class in org.springframework.ai.ollama.api

Ollama chat response object.

OllamaApi.CopyModelRequest - Record Class in org.springframework.ai.ollama.api

OllamaApi.DeleteModelRequest - Record Class in org.springframework.ai.ollama.api

OllamaApi.EmbeddingsRequest - Record Class in org.springframework.ai.ollama.api

Generate embeddings from a model.

OllamaApi.EmbeddingsResponse - Record Class in org.springframework.ai.ollama.api

The response object returned from the /embedding endpoint.

OllamaApi.ListModelResponse - Record Class in org.springframework.ai.ollama.api

OllamaApi.Message - Record Class in org.springframework.ai.ollama.api

Chat message object.

OllamaApi.Message.Builder - Class in org.springframework.ai.ollama.api

OllamaApi.Message.Role - Enum Class in org.springframework.ai.ollama.api

The role of the message in the conversation.

OllamaApi.Message.ToolCall - Record Class in org.springframework.ai.ollama.api

The relevant tool call.

OllamaApi.Message.ToolCallFunction - Record Class in org.springframework.ai.ollama.api

The function definition.

OllamaApi.Model - Record Class in org.springframework.ai.ollama.api

OllamaApi.Model.Details - Record Class in org.springframework.ai.ollama.api

OllamaApi.ProgressResponse - Record Class in org.springframework.ai.ollama.api

OllamaApi.PullModelRequest - Record Class in org.springframework.ai.ollama.api

OllamaApi.ShowModelRequest - Record Class in org.springframework.ai.ollama.api

OllamaApi.ShowModelResponse - Record Class in org.springframework.ai.ollama.api

OllamaApiAutoConfiguration - Class in org.springframework.ai.model.ollama.autoconfigure

Auto-configuration for Ollama API.

OllamaApiAutoConfiguration() - Constructor for class org.springframework.ai.model.ollama.autoconfigure.OllamaApiAutoConfiguration

OllamaApiConstants - Class in org.springframework.ai.ollama.api.common

Common value constants for Ollama api.

OllamaApiHelper - Class in org.springframework.ai.ollama.api

OllamaChatAutoConfiguration - Class in org.springframework.ai.model.ollama.autoconfigure

Auto-configuration for Ollama Chat model.

OllamaChatAutoConfiguration() - Constructor for class org.springframework.ai.model.ollama.autoconfigure.OllamaChatAutoConfiguration

ollamaChatModel(OllamaApi, OllamaChatProperties, OllamaInitializationProperties, ToolCallingManager, ObjectProvider<ObservationRegistry>, ObjectProvider<ChatModelObservationConvention>, ObjectProvider<RetryTemplate>) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatAutoConfiguration

OllamaChatModel - Class in org.springframework.ai.ollama

ChatModel implementation for Ollama.

OllamaChatModel(OllamaApi, OllamaChatOptions, ToolCallingManager, ObservationRegistry, ModelManagementOptions) - Constructor for class org.springframework.ai.ollama.OllamaChatModel

OllamaChatModel(OllamaApi, OllamaChatOptions, ToolCallingManager, ObservationRegistry, ModelManagementOptions, RetryTemplate) - Constructor for class org.springframework.ai.ollama.OllamaChatModel

OllamaChatModel.Builder - Class in org.springframework.ai.ollama

OllamaChatOptions - Class in org.springframework.ai.ollama.api

Helper class for creating strongly-typed Ollama options.

OllamaChatOptions(Boolean, Integer, Integer, Integer, Integer, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Integer, Integer, Integer, Integer, Integer, Double, Double, Float, Float, Integer, Double, Double, Double, Double, Integer, Float, Float, Boolean, List<String>, String, Object, String, Boolean, ThinkOption, List<ToolCallback>, Map<String, Object>) - Constructor for class org.springframework.ai.ollama.api.OllamaChatOptions

OllamaChatOptions.AbstractBuilder<B extends OllamaChatOptions.AbstractBuilder<B>> - Class in org.springframework.ai.ollama.api

OllamaChatOptions.Builder - Class in org.springframework.ai.ollama.api

OllamaChatProperties - Class in org.springframework.ai.model.ollama.autoconfigure

Ollama Chat autoconfiguration properties.

OllamaChatProperties() - Constructor for class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

OllamaChatProperties.Options - Class in org.springframework.ai.model.ollama.autoconfigure

OllamaConnectionDetails - Interface in org.springframework.ai.model.ollama.autoconfigure

Connection details for an Ollama service.

OllamaConnectionProperties - Class in org.springframework.ai.model.ollama.autoconfigure

Ollama connection autoconfiguration properties.

OllamaConnectionProperties() - Constructor for class org.springframework.ai.model.ollama.autoconfigure.OllamaConnectionProperties

OllamaEmbeddingAutoConfiguration - Class in org.springframework.ai.model.ollama.autoconfigure

Auto-configuration for Ollama Chat Client.

OllamaEmbeddingAutoConfiguration() - Constructor for class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingAutoConfiguration

ollamaEmbeddingModel(OllamaApi, OllamaEmbeddingProperties, OllamaInitializationProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<EmbeddingModelObservationConvention>) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingAutoConfiguration

OllamaEmbeddingModel - Class in org.springframework.ai.ollama

EmbeddingModel implementation for Ollama.

OllamaEmbeddingModel(OllamaApi, OllamaEmbeddingOptions, ObservationRegistry, ModelManagementOptions) - Constructor for class org.springframework.ai.ollama.OllamaEmbeddingModel

OllamaEmbeddingModel.Builder - Class in org.springframework.ai.ollama

OllamaEmbeddingOptions - Class in org.springframework.ai.ollama.api

Helper class for creating strongly-typed Ollama options.

OllamaEmbeddingOptions(String, String, Integer, Boolean, Boolean, Integer, Integer, Integer, Integer, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Integer) - Constructor for class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

OllamaEmbeddingOptions.Builder - Class in org.springframework.ai.ollama.api

OllamaEmbeddingProperties - Class in org.springframework.ai.model.ollama.autoconfigure

Ollama Embedding autoconfiguration properties.

OllamaEmbeddingProperties() - Constructor for class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties

OllamaEmbeddingProperties.Options - Class in org.springframework.ai.model.ollama.autoconfigure

OllamaInitializationProperties - Class in org.springframework.ai.model.ollama.autoconfigure

Ollama initialization configuration properties.

OllamaInitializationProperties() - Constructor for class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties

OllamaInitializationProperties.ModelTypeInit - Class in org.springframework.ai.model.ollama.autoconfigure

OllamaModel - Enum Class in org.springframework.ai.ollama.api

Helper class for common Ollama models.

OllamaModelManager - Class in org.springframework.ai.ollama.management

Manage the lifecycle of models in Ollama.

OllamaModelManager(OllamaApi) - Constructor for class org.springframework.ai.ollama.management.OllamaModelManager

OllamaModelManager(OllamaApi, ModelManagementOptions) - Constructor for class org.springframework.ai.ollama.management.OllamaModelManager

OllamaRuntimeHints - Class in org.springframework.ai.ollama.aot

The OllamaRuntimeHints class is responsible for registering runtime hints for Ollama AI API classes.

OllamaRuntimeHints() - Constructor for class org.springframework.ai.ollama.aot.OllamaRuntimeHints

OllamaThinkProperties - Enum Class in org.springframework.ai.model.ollama.autoconfigure

Ollama think properties.

ON - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.TextNormalizationMode

ON_DEMAND - Enum constant in enum class org.springframework.ai.google.genai.metadata.GoogleGenAiTrafficType

Pay-As-You-Go traffic type.

onAccess(String) - Method in class org.springframework.ai.tool.toolsearch.eviction.AlwaysEvictStrategy

Returns a set containing sessionId, causing the advisor to clear the session's index and remove its cached fingerprint before the fingerprint-comparison step.

onAccess(String) - Method in class org.springframework.ai.tool.toolsearch.eviction.CompositeEvictionStrategy

onAccess(String) - Method in class org.springframework.ai.tool.toolsearch.eviction.LruEvictionStrategy

onAccess(String) - Method in class org.springframework.ai.tool.toolsearch.eviction.NeverEvictStrategy

onAccess(String) - Method in interface org.springframework.ai.tool.toolsearch.eviction.ToolIndexEvictionStrategy

Called each time a session is accessed at the start of request processing.

onAccess(String) - Method in class org.springframework.ai.tool.toolsearch.eviction.TtlEvictionStrategy

onApplicationEvent(McpToolsChangedEvent) - Method in class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider

onApplicationEvent(McpToolsChangedEvent) - Method in class org.springframework.ai.mcp.SyncMcpToolCallbackProvider

ONE - Enum constant in enum class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.ConsistentLevel

Write must receive an acknowledgement from at least one replica node.

ONE_HOUR - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCacheTtl

ONE_HOUR - Enum constant in enum class org.springframework.ai.bedrock.converse.api.BedrockCacheTtl

onError(Observation.Context) - Method in class org.springframework.ai.model.observation.ErrorLoggingObservationHandler

onError(T) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler

onEvent(Observation.Event, T) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler

onFinishReason() - Static method in class org.springframework.ai.chat.client.advisor.AdvisorUtils

Checks whether the provided ChatClientResponse contains a ChatResponse with at least one result having a non-empty finish reason in its metadata.

onLimitExceeded(ToolCallLimitBehavior) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder

What to do when a configured limit is exceeded.

Onnx() - Constructor for class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Onnx

ONNX - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider

AI system provided by ONNX.

onRemoved(String) - Method in class org.springframework.ai.tool.toolsearch.eviction.AlwaysEvictStrategy

onRemoved(String) - Method in class org.springframework.ai.tool.toolsearch.eviction.CompositeEvictionStrategy

onRemoved(String) - Method in class org.springframework.ai.tool.toolsearch.eviction.LruEvictionStrategy

onRemoved(String) - Method in class org.springframework.ai.tool.toolsearch.eviction.NeverEvictStrategy

onRemoved(String) - Method in interface org.springframework.ai.tool.toolsearch.eviction.ToolIndexEvictionStrategy

Called after a session's tool index has been cleared — either because this strategy returned it from ToolIndexEvictionStrategy.onAccess(java.lang.String), or because of an explicit eviction request.

onRemoved(String) - Method in class org.springframework.ai.tool.toolsearch.eviction.TtlEvictionStrategy

onScopeClosed(T) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler

onScopeOpened(T) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler

onScopeReset(T) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler

onStart(T) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler

onStop(TranscriptionModelObservationContext) - Method in class org.springframework.ai.audio.transcription.observation.TranscriptionModelMeterObservationHandler

onStop(TranscriptionModelObservationContext) - Method in class org.springframework.ai.audio.transcription.observation.TranscriptionModelTranscriptObservationHandler

onStop(TextToSpeechModelObservationContext) - Method in class org.springframework.ai.audio.tts.observation.TextToSpeechModelMeterObservationHandler

onStop(TextToSpeechModelObservationContext) - Method in class org.springframework.ai.audio.tts.observation.TextToSpeechModelTextContentObservationHandler

onStop(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.ChatClientCompletionObservationHandler

onStop(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.ChatClientPromptContentObservationHandler

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

onStop(VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreQueryResponseObservationHandler

onStop(T) - Method in class org.springframework.ai.observation.TracingAwareLoggingObservationHandler

onSummarizationFailure(Consumer<SummaryRequest>) - Method in class org.springframework.ai.session.compaction.ChatModelSummarizer.Builder

Called with the request when the model call fails or returns a null or blank summary, after the warning is logged.

ONYX - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Voice

ONYX - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.Voice

Op(Filter.Operand) - Constructor for record class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder.Op

Creates an instance of a Op record class.

OpaquePayload - Record Class in org.springframework.ai.chat.messages.part

Provider-owned data attached to a MessagePart (or to a ReasoningPart) that Spring AI never interprets and that must be sent back unchanged to the provider that produced it.

OpaquePayload(String, String, String) - Constructor for record class org.springframework.ai.chat.messages.part.OpaquePayload

Creates an instance of a OpaquePayload record class.

OPEN_AI - Enum constant in enum class org.springframework.ai.openai.setup.OpenAiSetup.ModelProvider

OPEN_API_SCHEMA - Enum constant in enum class org.springframework.ai.util.json.schema.SchemaType

Open API schema.

OPENAI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider

AI system provided by OpenAI.

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

OPENAI_EMBEDDING_DIMENSION_SIZE - Static variable in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore

OPENAI_EMBEDDING_DIMENSION_SIZE - Static variable in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

OPENAI_EMBEDDING_DIMENSION_SIZE - Static variable in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

OPENAI_EMBEDDING_DIMENSION_SIZE - Static variable in class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

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

OpenAiAudioSpeechAutoConfiguration - Class in org.springframework.ai.model.openai.autoconfigure

Audio Speech Auto-configuration for OpenAI SDK.

OpenAiAudioSpeechAutoConfiguration() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechAutoConfiguration

OpenAiAudioSpeechModel - Class in org.springframework.ai.openai

OpenAI audio speech client implementation using the OpenAI Java SDK.

OpenAiAudioSpeechModel.Builder - Class in org.springframework.ai.openai

Builder for creating OpenAiAudioSpeechModel instances.

OpenAiAudioSpeechOptions - Class in org.springframework.ai.openai

Configuration options for OpenAI text-to-speech using the OpenAI Java SDK.

OpenAiAudioSpeechOptions(String, String, Credential, String, String, AzureOpenAIServiceVersion, String, Boolean, Boolean, Duration, Integer, Proxy, Map<String, String>, String, String, String, Double, String) - Constructor for class org.springframework.ai.openai.OpenAiAudioSpeechOptions

OpenAiAudioSpeechOptions.AudioResponseFormat - Enum Class in org.springframework.ai.openai

OpenAiAudioSpeechOptions.Builder - Class in org.springframework.ai.openai

OpenAiAudioSpeechOptions.Voice - Enum Class in org.springframework.ai.openai

OpenAiAudioSpeechProperties - Class in org.springframework.ai.model.openai.autoconfigure

OpenAI SDK Audio Speech autoconfiguration properties.

OpenAiAudioSpeechProperties() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

OpenAiAudioSpeechProperties.Options - Class in org.springframework.ai.model.openai.autoconfigure

OpenAiAudioSpeechResponseMetadata - Class in org.springframework.ai.openai.metadata

Audio speech metadata implementation for OpenAI using the OpenAI Java SDK.

OpenAiAudioSpeechResponseMetadata() - Constructor for class org.springframework.ai.openai.metadata.OpenAiAudioSpeechResponseMetadata

OpenAiAudioSpeechResponseMetadata(RateLimit) - Constructor for class org.springframework.ai.openai.metadata.OpenAiAudioSpeechResponseMetadata

OpenAiAudioTranscriptionAutoConfiguration - Class in org.springframework.ai.model.openai.autoconfigure

Auto-configuration for OpenAI SDK audio transcription.

OpenAiAudioTranscriptionAutoConfiguration() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionAutoConfiguration

OpenAiAudioTranscriptionModel - Class in org.springframework.ai.openai

OpenAI audio transcription model implementation using the OpenAI Java SDK.

OpenAiAudioTranscriptionModel.Builder - Class in org.springframework.ai.openai

Builder for creating OpenAiAudioTranscriptionModel instances.

OpenAiAudioTranscriptionOptions - Class in org.springframework.ai.openai

OpenAI SDK Audio Transcription Options.

OpenAiAudioTranscriptionOptions(String, String, Credential, String, String, AzureOpenAIServiceVersion, String, Boolean, Boolean, Duration, Integer, Proxy, Map<String, String>, AudioResponseFormat, String, String, Float, List<TranscriptionCreateParams.TimestampGranularity>, Boolean, TranscriptionCreateParams.ChunkingStrategy, List<String>, List<String>) - Constructor for class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions

OpenAiAudioTranscriptionOptions.Builder - Class in org.springframework.ai.openai

OpenAiAudioTranscriptionProperties - Class in org.springframework.ai.model.openai.autoconfigure

Configuration properties for OpenAI SDK audio transcription.

OpenAiAudioTranscriptionProperties() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

OpenAiAudioTranscriptionProperties.Options - Class in org.springframework.ai.model.openai.autoconfigure

OpenAiAudioTranscriptionResponseMetadata - Class in org.springframework.ai.openai.metadata

Audio transcription metadata implementation for OpenAI using the OpenAI Java SDK.

OpenAiAudioTranscriptionResponseMetadata() - Constructor for class org.springframework.ai.openai.metadata.OpenAiAudioTranscriptionResponseMetadata

OpenAiAudioTranscriptionResponseMetadata(Double, String, Object, List<?>, List<TranscriptionWord>) - Constructor for class org.springframework.ai.openai.metadata.OpenAiAudioTranscriptionResponseMetadata

OpenAiAutoConfigurationUtil - Class in org.springframework.ai.model.openai.autoconfigure

OpenAiAutoConfigurationUtil.ResolvedConnectionProperties - Class in org.springframework.ai.model.openai.autoconfigure

OpenAiChatAutoConfiguration - Class in org.springframework.ai.model.openai.autoconfigure

Chat Auto-configuration for OpenAI SDK.

OpenAiChatAutoConfiguration() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiChatAutoConfiguration

openAiChatModel(OpenAiCommonProperties, OpenAiChatProperties, ToolCallingManager, ObjectProvider<ObservationRegistry>, ObjectProvider<MeterRegistry>, ObjectProvider<ChatModelObservationConvention>, ObjectProvider<OpenAiHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatAutoConfiguration

OpenAiChatModel - Class in org.springframework.ai.openai

Chat Model implementation using the OpenAI Java SDK.

OpenAiChatModel.Builder - Class in org.springframework.ai.openai

Builder for creating OpenAiChatModel instances.

OpenAiChatModel.ResponseFormat - Class in org.springframework.ai.openai

Response format (text, json_object, json_schema) for OpenAiChatModel responses.

OpenAiChatModel.ResponseFormat.Builder - Class in org.springframework.ai.openai

OpenAiChatModel.ResponseFormat.Type - Enum Class in org.springframework.ai.openai

OpenAiChatOptions - Class in org.springframework.ai.openai

Configuration information for the Chat Model implementation using the OpenAI Java SDK.

OpenAiChatOptions(String, String, Credential, String, String, AzureOpenAIServiceVersion, String, Boolean, Boolean, Duration, Integer, Proxy, Map<String, String>, Double, Integer, Double, List<String>, Double, Double, List<ToolCallback>, Map<String, Object>, Map<String, Integer>, Boolean, Integer, Integer, Integer, List<String>, OpenAiChatOptions.AudioParameters, OpenAiChatModel.ResponseFormat, OpenAiChatOptions.StreamOptions, Integer, Object, String, Boolean, Boolean, Boolean, Map<String, String>, String, String, String, String, Boolean, Map<String, Object>) - Constructor for class org.springframework.ai.openai.OpenAiChatOptions

OpenAiChatOptions.AbstractBuilder<B extends OpenAiChatOptions.AbstractBuilder<B>> - Class in org.springframework.ai.openai

OpenAiChatOptions.AudioParameters - Record Class in org.springframework.ai.openai

OpenAiChatOptions.AudioParameters.AudioResponseFormat - Enum Class in org.springframework.ai.openai

Specifies the output audio format.

OpenAiChatOptions.AudioParameters.Voice - Enum Class in org.springframework.ai.openai

Specifies the voice type.

OpenAiChatOptions.Builder - Class in org.springframework.ai.openai

OpenAiChatOptions.StreamOptions - Record Class in org.springframework.ai.openai

OpenAiChatOptions.StreamOptions.Builder - Class in org.springframework.ai.openai

OpenAiChatProperties - Class in org.springframework.ai.model.openai.autoconfigure

OpenAI SDK Chat autoconfiguration properties.

OpenAiChatProperties() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

OpenAiChatProperties.Api - Enum Class in org.springframework.ai.model.openai.autoconfigure

The OpenAI endpoints a ChatModel bean can be backed by.

OpenAiChatProperties.Options - Class in org.springframework.ai.model.openai.autoconfigure

openAiClient(OpenAIClient) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel.Builder

Sets the OpenAIClient.

openAiClient(OpenAIClient) - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel.Builder

openAiClient(OpenAIClient) - Method in class org.springframework.ai.openai.OpenAiImageModel.Builder

openAiClient(OpenAIClient) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel.Builder

Sets the OpenAI client.

openAiClient(OpenAIClient) - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder

Sets the synchronous OpenAI client.

openAiClient(OpenAIClient) - Method in class org.springframework.ai.openai.OpenAiModerationModel.Builder

openAiClient(OpenAIClient) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatModel.Builder

openAiClientAsync(OpenAIClientAsync) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel.Builder

Sets the OpenAI client async.

openAiClientAsync(OpenAIClientAsync) - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder

Sets the asynchronous OpenAI client.

openAiClientAsync(OpenAIClientAsync) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatModel.Builder

OpenAiCommonProperties - Class in org.springframework.ai.model.openai.autoconfigure

OpenAiCommonProperties() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiCommonProperties

OpenAiEmbeddingAutoConfiguration - Class in org.springframework.ai.model.openai.autoconfigure

Embedding Auto-configuration for OpenAI SDK.

OpenAiEmbeddingAutoConfiguration() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingAutoConfiguration

openAiEmbeddingModel(OpenAiCommonProperties, OpenAiEmbeddingProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<MeterRegistry>, ObjectProvider<EmbeddingModelObservationConvention>, ObjectProvider<OpenAiHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingAutoConfiguration

OpenAiEmbeddingModel - Class in org.springframework.ai.openai

Embedding Model implementation using the OpenAI Java SDK.

OpenAiEmbeddingModel() - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingModel

Deprecated.

in favor of OpenAiEmbeddingModel.builder()

OpenAiEmbeddingModel(OpenAIClient) - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingModel

Deprecated.

in favor of OpenAiEmbeddingModel.builder()

OpenAiEmbeddingModel(OpenAIClient, MetadataMode) - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingModel

Deprecated.

in favor of OpenAiEmbeddingModel.builder()

OpenAiEmbeddingModel(OpenAIClient, MetadataMode, OpenAiEmbeddingOptions) - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingModel

Deprecated.

in favor of OpenAiEmbeddingModel.builder()

OpenAiEmbeddingModel(OpenAIClient, MetadataMode, OpenAiEmbeddingOptions, ObservationRegistry) - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingModel

Deprecated.

in favor of OpenAiEmbeddingModel.builder()

OpenAiEmbeddingModel(MetadataMode, OpenAiEmbeddingOptions) - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingModel

Deprecated.

in favor of OpenAiEmbeddingModel.builder()

OpenAiEmbeddingModel(MetadataMode, OpenAiEmbeddingOptions, ObservationRegistry) - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingModel

Deprecated.

in favor of OpenAiEmbeddingModel.builder()

OpenAiEmbeddingModel(OpenAiEmbeddingOptions) - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingModel

Deprecated.

in favor of OpenAiEmbeddingModel.builder()

OpenAiEmbeddingModel(OpenAiEmbeddingOptions, ObservationRegistry) - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingModel

Deprecated.

in favor of OpenAiEmbeddingModel.builder()

OpenAiEmbeddingModel.Builder - Class in org.springframework.ai.openai

OpenAiEmbeddingOptions - Class in org.springframework.ai.openai

Configuration information for the Embedding Model implementation using the OpenAI Java SDK.

OpenAiEmbeddingOptions(String, String, Credential, String, String, AzureOpenAIServiceVersion, String, Boolean, Boolean, Duration, Integer, Proxy, Map<String, String>, String, OpenAiEmbeddingOptions.EncodingFormat, Integer, Map<String, Object>) - Constructor for class org.springframework.ai.openai.OpenAiEmbeddingOptions

OpenAiEmbeddingOptions.Builder - Class in org.springframework.ai.openai

OpenAiEmbeddingOptions.EncodingFormat - Enum Class in org.springframework.ai.openai

The format to return the embeddings in.

OpenAiEmbeddingProperties - Class in org.springframework.ai.model.openai.autoconfigure

OpenAI SDK Embedding autoconfiguration properties.

OpenAiEmbeddingProperties() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

OpenAiEmbeddingProperties.Options - Class in org.springframework.ai.model.openai.autoconfigure

OpenAiHttpClientBuilderCustomizer - Interface in org.springframework.ai.openai.http.okhttp

Callback for customizing the SpringAiOpenAiHttpClient.Builder used by every OpenAI *Model before the underlying OkHttpClient is built.

OpenAiImageAutoConfiguration - Class in org.springframework.ai.model.openai.autoconfigure

Image Auto-configuration for OpenAI.

OpenAiImageAutoConfiguration() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiImageAutoConfiguration

OpenAiImageGenerationMetadata - Class in org.springframework.ai.openai.metadata

Represents the metadata for image generation using the OpenAI Java SDK.

OpenAiImageGenerationMetadata(String) - Constructor for class org.springframework.ai.openai.metadata.OpenAiImageGenerationMetadata

Creates a new OpenAiImageGenerationMetadata.

openAiImageModel(OpenAiCommonProperties, OpenAiImageProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<MeterRegistry>, ObjectProvider<ImageModelObservationConvention>, ObjectProvider<OpenAiHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageAutoConfiguration

OpenAiImageModel - Class in org.springframework.ai.openai

Image Model implementation using the OpenAI Java SDK.

OpenAiImageModel() - Constructor for class org.springframework.ai.openai.OpenAiImageModel

Deprecated.

use OpenAiImageModel.builder() instead.

OpenAiImageModel(OpenAIClient) - Constructor for class org.springframework.ai.openai.OpenAiImageModel

Deprecated.

use OpenAiImageModel.builder() instead.

OpenAiImageModel(OpenAIClient, ObservationRegistry) - Constructor for class org.springframework.ai.openai.OpenAiImageModel

Deprecated.

use OpenAiImageModel.builder() instead.

OpenAiImageModel(OpenAIClient, OpenAiImageOptions) - Constructor for class org.springframework.ai.openai.OpenAiImageModel

Deprecated.

use OpenAiImageModel.builder() instead.

OpenAiImageModel(OpenAIClient, OpenAiImageOptions, ObservationRegistry) - Constructor for class org.springframework.ai.openai.OpenAiImageModel

Deprecated.

use OpenAiImageModel.builder() instead.

OpenAiImageModel(ObservationRegistry) - Constructor for class org.springframework.ai.openai.OpenAiImageModel

Deprecated.

use OpenAiImageModel.builder() instead.

OpenAiImageModel(OpenAiImageOptions) - Constructor for class org.springframework.ai.openai.OpenAiImageModel

Deprecated.

use OpenAiImageModel.builder() instead.

OpenAiImageModel(OpenAiImageOptions, ObservationRegistry) - Constructor for class org.springframework.ai.openai.OpenAiImageModel

Deprecated.

use OpenAiImageModel.builder() instead.

OpenAiImageModel.Builder - Class in org.springframework.ai.openai

OpenAiImageOptions - Class in org.springframework.ai.openai

Configuration information for the Image Model implementation using the OpenAI Java SDK.

OpenAiImageOptions(String, String, Credential, String, String, AzureOpenAIServiceVersion, String, Boolean, Boolean, Duration, Integer, Proxy, Map<String, String>, Integer, Integer, Integer, String, String, String, String, String) - Constructor for class org.springframework.ai.openai.OpenAiImageOptions

OpenAiImageOptions.Builder - Class in org.springframework.ai.openai

OpenAiImageProperties - Class in org.springframework.ai.model.openai.autoconfigure

OpenAI SDK Image autoconfiguration properties.

OpenAiImageProperties() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

OpenAiImageProperties.Options - Class in org.springframework.ai.model.openai.autoconfigure

OpenAiImageResponseMetadata - Class in org.springframework.ai.openai.metadata

Represents the metadata for image response using the OpenAI Java SDK.

OpenAiImageResponseMetadata(Long) - Constructor for class org.springframework.ai.openai.metadata.OpenAiImageResponseMetadata

Creates a new OpenAiImageResponseMetadata.

OpenAiModerationAutoConfiguration - Class in org.springframework.ai.model.openai.autoconfigure

Moderation Auto-configuration for OpenAI SDK.

OpenAiModerationAutoConfiguration() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiModerationAutoConfiguration

OpenAiModerationModel - Class in org.springframework.ai.openai

OpenAI SDK Moderation Model implementation.

OpenAiModerationModel.Builder - Class in org.springframework.ai.openai

OpenAiModerationOptions - Class in org.springframework.ai.openai

OpenAI SDK Moderation Options.

OpenAiModerationOptions(String, String, Credential, String, String, AzureOpenAIServiceVersion, String, Boolean, Boolean, Duration, Integer, Proxy, Map<String, String>) - Constructor for class org.springframework.ai.openai.OpenAiModerationOptions

OpenAiModerationOptions.Builder - Class in org.springframework.ai.openai

OpenAiModerationProperties - Class in org.springframework.ai.model.openai.autoconfigure

OpenAI SDK Moderation autoconfiguration properties.

OpenAiModerationProperties() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiModerationProperties

OpenAiModerationProperties.Options - Class in org.springframework.ai.model.openai.autoconfigure

OpenAiRateLimit - Class in org.springframework.ai.openai.metadata

RateLimit implementation for OpenAI SDK.

OpenAiRateLimit(Long, Long, Duration, Long, Long, Duration) - Constructor for class org.springframework.ai.openai.metadata.OpenAiRateLimit

OpenAiResponsesChatAutoConfiguration - Class in org.springframework.ai.model.openai.autoconfigure

Chat Auto-configuration for the OpenAI Responses API.

OpenAiResponsesChatAutoConfiguration() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatAutoConfiguration

openAiResponsesChatModel(OpenAiCommonProperties, OpenAiResponsesChatProperties, ToolCallingManager, ObjectProvider<ObservationRegistry>, ObjectProvider<MeterRegistry>, ObjectProvider<ChatModelObservationConvention>, ObjectProvider<OpenAiHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatAutoConfiguration

OpenAiResponsesChatModel - Class in org.springframework.ai.openai.responses

A ChatModel backed by OpenAI's Responses API (/v1/responses), the endpoint where new OpenAI capability lands.

OpenAiResponsesChatModel.Builder - Class in org.springframework.ai.openai.responses

Builder for OpenAiResponsesChatModel instances.

OpenAiResponsesChatOptions - Class in org.springframework.ai.openai.responses

Configuration for OpenAiResponsesChatModel.

OpenAiResponsesChatOptions(OpenAiResponsesChatOptions.AbstractBuilder<?>) - Constructor for class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions

OpenAiResponsesChatOptions.AbstractBuilder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>> - Class in org.springframework.ai.openai.responses

OpenAiResponsesChatOptions.Builder - Class in org.springframework.ai.openai.responses

Public builder exposed to users, so they do not have to name the generic parameter.

OpenAiResponsesChatProperties - Class in org.springframework.ai.model.openai.autoconfigure

Configuration properties for the OpenAI Responses API chat model, selected with spring.ai.openai.chat.api=responses.

OpenAiResponsesChatProperties() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

OpenAiResponsesChatProperties.HostedTools - Class in org.springframework.ai.model.openai.autoconfigure

The subset of server-executed tools that is configurable declaratively.

OpenAiResponsesChatProperties.HostedTools.CodeInterpreter - Class in org.springframework.ai.model.openai.autoconfigure

OpenAiResponsesChatProperties.HostedTools.FileSearch - Class in org.springframework.ai.model.openai.autoconfigure

OpenAiResponsesChatProperties.HostedTools.ImageGeneration - Class in org.springframework.ai.model.openai.autoconfigure

OpenAiResponsesChatProperties.HostedTools.WebSearch - Class in org.springframework.ai.model.openai.autoconfigure

OpenAiResponsesException - Exception in org.springframework.ai.openai.responses

Thrown when the Responses API reports a failed response, or emits an error event mid-stream.

OpenAiResponsesException(String, String) - Constructor for exception org.springframework.ai.openai.responses.OpenAiResponsesException

OpenAiResponsesMetadata - Class in org.springframework.ai.openai.responses

Metadata keys published by OpenAiResponsesChatModel, and the part attributes it uses.

openAiSdkAudioSpeechModel(OpenAiCommonProperties, OpenAiAudioSpeechProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<MeterRegistry>, ObjectProvider<TextToSpeechModelObservationConvention>, ObjectProvider<OpenAiHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechAutoConfiguration

openAiSdkAudioTranscriptionModel(OpenAiCommonProperties, OpenAiAudioTranscriptionProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<MeterRegistry>, ObjectProvider<TranscriptionModelObservationConvention>, ObjectProvider<OpenAiHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionAutoConfiguration

openAiSdkModerationModel(OpenAiCommonProperties, OpenAiModerationProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<MeterRegistry>, ObjectProvider<OpenAiHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiModerationAutoConfiguration

OpenAiSetup - Class in org.springframework.ai.openai.setup

Helps configure the OpenAI Java SDK, depending on the platform used.

OpenAiSetup.ModelProvider - Enum Class in org.springframework.ai.openai.setup

openConnectionOnStartup(boolean) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebClientStreamableHttpTransport.Builder

Configure whether the client should open an SSE connection upon startup.

OPENSEARCH - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by OpenSearch.

OPENSEARCH - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

OpenSearchAiSearchFilterExpressionConverter - Class in org.springframework.ai.vectorstore.opensearch

A FilterExpressionConverter implementation for OpenSearch AI search filter expressions.

OpenSearchAiSearchFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.opensearch.OpenSearchAiSearchFilterExpressionConverter

OpenSearchConnectionDetails - Interface in org.springframework.ai.vectorstore.opensearch.autoconfigure

OpenSearchDocument(String, String, Map<String, Object>, float[]) - Constructor for record class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.OpenSearchDocument

Creates an instance of a OpenSearchDocument record class.

OpenSearchNonAwsCondition - Class in org.springframework.ai.vectorstore.opensearch.autoconfigure

Condition that matches if either: The property spring.ai.vectorstore.opensearch.aws.enabled is explicitly set to false. Required AWS SDK classes are missing from the classpath.

OpenSearchNonAwsCondition() - Constructor for class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchNonAwsCondition

OpenSearchVectorStore - Class in org.springframework.ai.vectorstore.opensearch

OpenSearch-based vector store implementation using OpenSearch's vector search capabilities.

OpenSearchVectorStore(OpenSearchVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

Creates a new OpenSearchVectorStore using the builder pattern.

OpenSearchVectorStore.Builder - Class in org.springframework.ai.vectorstore.opensearch

Builder class for creating OpenSearchVectorStore instances.

OpenSearchVectorStore.OpenSearchDocument - Record Class in org.springframework.ai.vectorstore.opensearch

The representation of Document along with its embedding.

OpenSearchVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.opensearch.autoconfigure

OpenSearchVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreAutoConfiguration

OpenSearchVectorStoreProperties - Class in org.springframework.ai.vectorstore.opensearch.autoconfigure

OpenSearchVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

openWorldHint() - Element in annotation interface org.springframework.ai.mcp.annotation.McpTool.McpAnnotations

If true, this tool may interact with an “open world” of external entities.

OPERATION_DURATION - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationMetricNames

The duration of the AI operation.

operationType() - Method in record class org.springframework.ai.observation.AiOperationMetadata

Returns the value of the operationType record component.

operationType(String) - Method in class org.springframework.ai.observation.AiOperationMetadata.Builder

Set the operation type.

operator - Variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.AndExpressionContext

operator - Variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.OrExpressionContext

operator - Variable in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgDistanceType

options - Variable in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModel

options - Variable in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingModel

options - Variable in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModel

options() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest

Returns the value of the options record component.

options() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsRequest

Returns the value of the options record component.

options() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelRequest

Returns the value of the options record component.

options(OpenAiAudioSpeechOptions) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel.Builder

Sets the default options.

options(OpenAiEmbeddingOptions) - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel.Builder

options(OpenAiImageOptions) - Method in class org.springframework.ai.openai.OpenAiImageModel.Builder

options(B) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

options(B) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

options(Map<String, Object>) - Method in class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

options(AnthropicChatOptions) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder

Sets the chat options.

options(BedrockChatOptions) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder

options(DeepSeekChatOptions) - Method in class org.springframework.ai.deepseek.DeepSeekChatModel.Builder

options(ElevenLabsTextToSpeechOptions) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel.Builder

options(GoogleGenAiChatOptions) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatModel.Builder

options(GoogleGenAiAudioTranscriptionOptions) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionModel.Builder

Sets the default transcription options.

options(GoogleGenAiAudioSpeechOptions) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechModel.Builder

options(MistralAiChatOptions) - Method in class org.springframework.ai.mistralai.MistralAiChatModel.Builder

options(MistralAiEmbeddingOptions) - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingModel.Builder

options(MistralAiModerationOptions) - Method in class org.springframework.ai.mistralai.moderation.MistralAiModerationModel.Builder

options(OllamaChatOptions) - Method in class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

options(OllamaChatOptions) - Method in class org.springframework.ai.ollama.OllamaChatModel.Builder

options(OllamaEmbeddingOptions) - Method in class org.springframework.ai.ollama.OllamaEmbeddingModel.Builder

options(OpenAiAudioTranscriptionOptions) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel.Builder

Sets the transcription options.

options(OpenAiChatOptions) - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder

Sets the chat options.

options(OpenAiModerationOptions) - Method in class org.springframework.ai.openai.OpenAiModerationModel.Builder

options(OpenAiResponsesChatOptions) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatModel.Builder

options(ElasticsearchVectorStoreOptions) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore.Builder

Sets the Elasticsearch vector store options.

options(WeaviateVectorStoreOptions) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.Builder

Configures the Weaviate vector store option.

Options() - Constructor for class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

Options() - Constructor for class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties.Options

Options() - Constructor for class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

Options() - Constructor for class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

Options() - Constructor for class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

Options() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

Options() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties.Options

Options() - Constructor for class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

Options() - Constructor for class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties.Options

Options() - Constructor for class org.springframework.ai.model.mistralai.autoconfigure.MistralAiModerationProperties.Options

Options() - Constructor for class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties.Options

Options() - Constructor for class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Options() - Constructor for class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties.Options

Options() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties.Options

Options() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties.Options

Options() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

Options() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties.Options

Options() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

Options() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiModerationProperties.Options

Options() - Constructor for class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties.Options

Options() - Constructor for class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

Options() - Constructor for class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultimodalEmbeddingProperties.Options

Options() - Constructor for class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties.Options

OPUS - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.AudioResponseFormat

OPUS - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.AudioResponseFormat

OPUS_48000_128 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

OPUS_48000_192 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

OPUS_48000_32 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

OPUS_48000_64 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

OPUS_48000_96 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

or(ToolCallConfirmationPolicy) - Method in interface org.springframework.ai.model.tool.ToolCallConfirmationPolicy

A call needs confirmation when either policy says so.

or(MessageFilter) - Method in interface org.springframework.ai.session.MessageFilter

A filter that stores a message if this filter or other accepts it.

or(FilterExpressionBuilder.Op, FilterExpressionBuilder.Op) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder

OR - Enum constant in enum class org.springframework.ai.vectorstore.filter.Filter.ExpressionType

OR - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

OR - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

OR() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.OrExpressionContext

ORACLE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by Oracle.

ORACLE - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

OracleChatMemoryRepositoryDialect - Class in org.springframework.ai.chat.memory.repository.jdbc

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of JdbcSessionRepository in spring-ai-session-jdbc. There is no session dialect for Oracle yet; one is planned before 3.0.0, and until then a dialect of your own implements JdbcSessionRepositoryDialect.

OracleChatMemoryRepositoryDialect() - Constructor for class org.springframework.ai.chat.memory.repository.jdbc.OracleChatMemoryRepositoryDialect

Deprecated.

OracleVectorStore - Class in org.springframework.ai.vectorstore.oracle

Integration of Oracle database 23ai as a Vector Store.

OracleVectorStore(OracleVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.oracle.OracleVectorStore

Protected constructor that accepts a builder instance.

OracleVectorStore.Builder - Class in org.springframework.ai.vectorstore.oracle

Builder class for creating OracleVectorStore instances.

OracleVectorStore.OracleVectorStoreDistanceType - Enum Class in org.springframework.ai.vectorstore.oracle

OracleVectorStore.OracleVectorStoreIndexType - Enum Class in org.springframework.ai.vectorstore.oracle

OracleVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.oracle.autoconfigure

Auto-configuration for Oracle Vector Store.

OracleVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreAutoConfiguration

OracleVectorStoreProperties - Class in org.springframework.ai.vectorstore.oracle.autoconfigure

Configuration properties for Oracle Vector Store.

OracleVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

ORCA_MINI - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Orca Mini is based on Llama and Llama 2 ranging from 3 billion parameters to 70 billion

order(int) - Method in class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor.Builder

Sets the advisor order.

order(int) - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor.Builder

Deprecated.

Set the order.

order(int) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder

order(int) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor.Builder

order(int) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor.Builder

order(int) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor.Builder

order(int) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor.Builder

Set the order.

order(int) - Method in class org.springframework.ai.session.advisor.SessionMemoryAdvisor.Builder

order(int) - Method in class org.springframework.ai.session.advisor.SessionTurnAdvisor.Builder

The order; SessionTurnAdvisor.DEFAULT_ORDER by default.

order(Integer) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder

OrExpressionContext(FiltersParser.BooleanExpressionContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.OrExpressionContext

org.springframework.ai.anthropic - package org.springframework.ai.anthropic

Spring AI integration with Anthropic's Claude models using the official Anthropic Java SDK.

org.springframework.ai.anthropic.http.okhttp - package org.springframework.ai.anthropic.http.okhttp

Spring AI's customized OkHttp-backed implementation of the Anthropic Java SDK's HttpClient contract.

org.springframework.ai.anthropic.metadata - package org.springframework.ai.anthropic.metadata

Metadata support classes for the Anthropic chat model.

org.springframework.ai.aot - package org.springframework.ai.aot

org.springframework.ai.audio.transcription - package org.springframework.ai.audio.transcription

org.springframework.ai.audio.transcription.observation - package org.springframework.ai.audio.transcription.observation

Provides classes for observing audio transcription data.

org.springframework.ai.audio.tts - package org.springframework.ai.audio.tts

org.springframework.ai.audio.tts.observation - package org.springframework.ai.audio.tts.observation

Provides classes for observing text-to-speech data.

org.springframework.ai.bedrock - package org.springframework.ai.bedrock

org.springframework.ai.bedrock.aot - package org.springframework.ai.bedrock.aot

org.springframework.ai.bedrock.api - package org.springframework.ai.bedrock.api

org.springframework.ai.bedrock.cohere - package org.springframework.ai.bedrock.cohere

org.springframework.ai.bedrock.cohere.api - package org.springframework.ai.bedrock.cohere.api

org.springframework.ai.bedrock.converse - package org.springframework.ai.bedrock.converse

org.springframework.ai.bedrock.converse.api - package org.springframework.ai.bedrock.converse.api

org.springframework.ai.bedrock.titan - package org.springframework.ai.bedrock.titan

org.springframework.ai.bedrock.titan.api - package org.springframework.ai.bedrock.titan.api

org.springframework.ai.chat.cache.semantic - package org.springframework.ai.chat.cache.semantic

org.springframework.ai.chat.client - package org.springframework.ai.chat.client

Chat client API.

org.springframework.ai.chat.client.advisor - package org.springframework.ai.chat.client.advisor

Provides classes for advising chat clients.

org.springframework.ai.chat.client.advisor.api - package org.springframework.ai.chat.client.advisor.api

Provides the API for chat client advisors.

org.springframework.ai.chat.client.advisor.observation - package org.springframework.ai.chat.client.advisor.observation

Provides the API for chat client advisors observations.

org.springframework.ai.chat.client.advisor.toolsearch - package org.springframework.ai.chat.client.advisor.toolsearch

Tool Search Tool Advisor package for dynamic tool discovery and search capabilities.

org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure - package org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure

org.springframework.ai.chat.client.advisor.vectorstore - package org.springframework.ai.chat.client.advisor.vectorstore

Spring AI chat client advisors package.

org.springframework.ai.chat.client.observation - package org.springframework.ai.chat.client.observation

Provides classes for observing chat data.

org.springframework.ai.chat.evaluation - package org.springframework.ai.chat.evaluation

The org.sf.ai.chat package represents the bounded context for the Chat Model within the AI generative model domain.

org.springframework.ai.chat.memory - package org.springframework.ai.chat.memory

org.springframework.ai.chat.memory.repository.cassandra - package org.springframework.ai.chat.memory.repository.cassandra

org.springframework.ai.chat.memory.repository.jdbc - package org.springframework.ai.chat.memory.repository.jdbc

org.springframework.ai.chat.memory.repository.jdbc.aot.hint - package org.springframework.ai.chat.memory.repository.jdbc.aot.hint

org.springframework.ai.chat.memory.repository.mongo - package org.springframework.ai.chat.memory.repository.mongo

org.springframework.ai.chat.memory.repository.neo4j - package org.springframework.ai.chat.memory.repository.neo4j

org.springframework.ai.chat.memory.repository.redis - package org.springframework.ai.chat.memory.repository.redis

org.springframework.ai.chat.messages - package org.springframework.ai.chat.messages

org.springframework.ai.chat.messages.part - package org.springframework.ai.chat.messages.part

Ordered, typed content parts carried by chat messages: text, tool calls, tool results, media and an opaque fallback for provider blocks that are not modeled yet.

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.chroma.vectorstore - package org.springframework.ai.chroma.vectorstore

Provides the API for embedding observations.

org.springframework.ai.chroma.vectorstore.common - package org.springframework.ai.chroma.vectorstore.common

org.springframework.ai.content - package org.springframework.ai.content

Core observation abstractions.

org.springframework.ai.converter - package org.springframework.ai.converter

Provides converters for transforming AI model text outputs into structured Java types.

org.springframework.ai.deepseek - package org.springframework.ai.deepseek

org.springframework.ai.deepseek.aot - package org.springframework.ai.deepseek.aot

org.springframework.ai.deepseek.api - package org.springframework.ai.deepseek.api

org.springframework.ai.deepseek.api.common - package org.springframework.ai.deepseek.api.common

org.springframework.ai.docker.compose.service.connection.chroma - package org.springframework.ai.docker.compose.service.connection.chroma

org.springframework.ai.docker.compose.service.connection.docker - package org.springframework.ai.docker.compose.service.connection.docker

org.springframework.ai.docker.compose.service.connection.milvus - package org.springframework.ai.docker.compose.service.connection.milvus

org.springframework.ai.docker.compose.service.connection.ollama - package org.springframework.ai.docker.compose.service.connection.ollama

org.springframework.ai.docker.compose.service.connection.opensearch - package org.springframework.ai.docker.compose.service.connection.opensearch

org.springframework.ai.docker.compose.service.connection.qdrant - package org.springframework.ai.docker.compose.service.connection.qdrant

org.springframework.ai.docker.compose.service.connection.typesense - package org.springframework.ai.docker.compose.service.connection.typesense

org.springframework.ai.docker.compose.service.connection.weaviate - package org.springframework.ai.docker.compose.service.connection.weaviate

org.springframework.ai.document - package org.springframework.ai.document

org.springframework.ai.document.id - package org.springframework.ai.document.id

org.springframework.ai.elevenlabs - package org.springframework.ai.elevenlabs

org.springframework.ai.elevenlabs.aot - package org.springframework.ai.elevenlabs.aot

org.springframework.ai.elevenlabs.api - package org.springframework.ai.elevenlabs.api

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.evaluation - package org.springframework.ai.evaluation

org.springframework.ai.google.genai - package org.springframework.ai.google.genai

org.springframework.ai.google.genai.aot - package org.springframework.ai.google.genai.aot

org.springframework.ai.google.genai.cache - package org.springframework.ai.google.genai.cache

org.springframework.ai.google.genai.common - package org.springframework.ai.google.genai.common

org.springframework.ai.google.genai.embedding - package org.springframework.ai.google.genai.embedding

org.springframework.ai.google.genai.image - package org.springframework.ai.google.genai.image

Google GenAI image generation support for Spring AI.

org.springframework.ai.google.genai.metadata - package org.springframework.ai.google.genai.metadata

org.springframework.ai.google.genai.schema - package org.springframework.ai.google.genai.schema

org.springframework.ai.google.genai.text - package org.springframework.ai.google.genai.text

org.springframework.ai.google.genai.transcription - package org.springframework.ai.google.genai.transcription

Google GenAI (Gemini) audio transcription model support.

org.springframework.ai.google.genai.tts - package org.springframework.ai.google.genai.tts

Google GenAI Gemini-TTS text-to-speech support for Spring AI.

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.mcp - package org.springframework.ai.mcp

Core support for Model Context Protocol (MCP) integration in Spring AI.

org.springframework.ai.mcp.annotation - package org.springframework.ai.mcp.annotation

Annotations for declaring MCP capabilities (tools, prompts, resources, completion, logging, progress, sampling, elicitation) and list-changed handlers.

org.springframework.ai.mcp.annotation.adapter - package org.springframework.ai.mcp.annotation.adapter

Adapters that bridge MCP annotation-based providers to the MCP SDK transport layer.

org.springframework.ai.mcp.annotation.common - package org.springframework.ai.mcp.annotation.common

Common utilities for working with MCP annotation metadata.

org.springframework.ai.mcp.annotation.context - package org.springframework.ai.mcp.annotation.context

Request context types, specifications (logging, progress, sampling, elicitation), and default implementations for MCP request handling.

org.springframework.ai.mcp.annotation.method.changed.prompt - package org.springframework.ai.mcp.annotation.method.changed.prompt

Method callbacks and specifications for MCP prompt list changed notifications.

org.springframework.ai.mcp.annotation.method.changed.resource - package org.springframework.ai.mcp.annotation.method.changed.resource

Method callbacks and specifications for MCP resource list changed notifications.

org.springframework.ai.mcp.annotation.method.changed.tool - package org.springframework.ai.mcp.annotation.method.changed.tool

Method callbacks and specifications for MCP tool list changed notifications.

org.springframework.ai.mcp.annotation.method.complete - package org.springframework.ai.mcp.annotation.method.complete

Method callbacks for MCP completion (chat) requests, sync and async.

org.springframework.ai.mcp.annotation.method.elicitation - package org.springframework.ai.mcp.annotation.method.elicitation

Method callbacks and specifications for MCP elicitation (user input) requests.

org.springframework.ai.mcp.annotation.method.logging - package org.springframework.ai.mcp.annotation.method.logging

Method callbacks and specifications for MCP logging.

org.springframework.ai.mcp.annotation.method.progress - package org.springframework.ai.mcp.annotation.method.progress

Method callbacks and specifications for MCP progress reporting.

org.springframework.ai.mcp.annotation.method.prompt - package org.springframework.ai.mcp.annotation.method.prompt

Method callbacks for MCP prompt template requests, sync and async.

org.springframework.ai.mcp.annotation.method.resource - package org.springframework.ai.mcp.annotation.method.resource

Method callbacks and result converters for MCP resource read requests.

org.springframework.ai.mcp.annotation.method.sampling - package org.springframework.ai.mcp.annotation.method.sampling

Method callbacks for MCP sampling (create message) requests.

org.springframework.ai.mcp.annotation.method.tool - package org.springframework.ai.mcp.annotation.method.tool

Method callbacks and utilities for MCP tool invocation (call_tool).

org.springframework.ai.mcp.annotation.method.tool.utils - package org.springframework.ai.mcp.annotation.method.tool.utils

Utilities for MCP tool support, such as JSON schema generation.

org.springframework.ai.mcp.annotation.provider.changed.prompt - package org.springframework.ai.mcp.annotation.provider.changed.prompt

MCP providers that expose prompt list changed handlers to the transport layer.

org.springframework.ai.mcp.annotation.provider.changed.resource - package org.springframework.ai.mcp.annotation.provider.changed.resource

MCP providers that expose resource list changed handlers to the transport layer.

org.springframework.ai.mcp.annotation.provider.changed.tool - package org.springframework.ai.mcp.annotation.provider.changed.tool

MCP providers that expose tool list changed handlers to the transport layer.

org.springframework.ai.mcp.annotation.provider.complete - package org.springframework.ai.mcp.annotation.provider.complete

MCP providers that expose completion (chat) handlers to the transport layer.

org.springframework.ai.mcp.annotation.provider.elicitation - package org.springframework.ai.mcp.annotation.provider.elicitation

MCP providers that expose elicitation handlers to the transport layer.

org.springframework.ai.mcp.annotation.provider.logging - package org.springframework.ai.mcp.annotation.provider.logging

MCP providers that expose logging handlers to the transport layer.

org.springframework.ai.mcp.annotation.provider.progress - package org.springframework.ai.mcp.annotation.provider.progress

MCP providers that expose progress handlers to the transport layer.

org.springframework.ai.mcp.annotation.provider.prompt - package org.springframework.ai.mcp.annotation.provider.prompt

MCP providers that expose prompt template handlers to the transport layer.

org.springframework.ai.mcp.annotation.provider.resource - package org.springframework.ai.mcp.annotation.provider.resource

MCP providers that expose resource read handlers to the transport layer.

org.springframework.ai.mcp.annotation.provider.sampling - package org.springframework.ai.mcp.annotation.provider.sampling

MCP providers that expose sampling (create message) handlers to the transport layer.

org.springframework.ai.mcp.annotation.provider.tool - package org.springframework.ai.mcp.annotation.provider.tool

MCP providers that expose tool (call_tool) handlers to the transport layer.

org.springframework.ai.mcp.annotation.spring - package org.springframework.ai.mcp.annotation.spring

org.springframework.ai.mcp.annotation.spring.scan - package org.springframework.ai.mcp.annotation.spring.scan

org.springframework.ai.mcp.aot - package org.springframework.ai.mcp.aot

org.springframework.ai.mcp.client.common.autoconfigure - package org.springframework.ai.mcp.client.common.autoconfigure

org.springframework.ai.mcp.client.common.autoconfigure.annotations - package org.springframework.ai.mcp.client.common.autoconfigure.annotations

org.springframework.ai.mcp.client.common.autoconfigure.aot - package org.springframework.ai.mcp.client.common.autoconfigure.aot

org.springframework.ai.mcp.client.common.autoconfigure.configurer - package org.springframework.ai.mcp.client.common.autoconfigure.configurer

org.springframework.ai.mcp.client.common.autoconfigure.properties - package org.springframework.ai.mcp.client.common.autoconfigure.properties

org.springframework.ai.mcp.client.httpclient.autoconfigure - package org.springframework.ai.mcp.client.httpclient.autoconfigure

org.springframework.ai.mcp.client.httpclient.autoconfigure.aot - package org.springframework.ai.mcp.client.httpclient.autoconfigure.aot

org.springframework.ai.mcp.client.webflux.autoconfigure - package org.springframework.ai.mcp.client.webflux.autoconfigure

org.springframework.ai.mcp.client.webflux.autoconfigure.aot - package org.springframework.ai.mcp.client.webflux.autoconfigure.aot

org.springframework.ai.mcp.client.webflux.transport - package org.springframework.ai.mcp.client.webflux.transport

org.springframework.ai.mcp.customizer - package org.springframework.ai.mcp.customizer

org.springframework.ai.mcp.server.common.autoconfigure - package org.springframework.ai.mcp.server.common.autoconfigure

org.springframework.ai.mcp.server.common.autoconfigure.annotations - package org.springframework.ai.mcp.server.common.autoconfigure.annotations

org.springframework.ai.mcp.server.common.autoconfigure.properties - package org.springframework.ai.mcp.server.common.autoconfigure.properties

org.springframework.ai.mcp.server.webflux.autoconfigure - package org.springframework.ai.mcp.server.webflux.autoconfigure

org.springframework.ai.mcp.server.webflux.transport - package org.springframework.ai.mcp.server.webflux.transport

org.springframework.ai.mcp.server.webmvc.autoconfigure - package org.springframework.ai.mcp.server.webmvc.autoconfigure

org.springframework.ai.mcp.server.webmvc.transport - package org.springframework.ai.mcp.server.webmvc.transport

org.springframework.ai.mistralai - package org.springframework.ai.mistralai

org.springframework.ai.mistralai.aot - package org.springframework.ai.mistralai.aot

org.springframework.ai.mistralai.api - package org.springframework.ai.mistralai.api

org.springframework.ai.mistralai.moderation - package org.springframework.ai.mistralai.moderation

org.springframework.ai.mistralai.ocr - package org.springframework.ai.mistralai.ocr

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.anthropic.autoconfigure - package org.springframework.ai.model.anthropic.autoconfigure

org.springframework.ai.model.audio.observation.autoconfigure - package org.springframework.ai.model.audio.observation.autoconfigure

Auto-configuration for text-to-speech and transcription model observations.

org.springframework.ai.model.bedrock.autoconfigure - package org.springframework.ai.model.bedrock.autoconfigure

org.springframework.ai.model.bedrock.cohere.autoconfigure - package org.springframework.ai.model.bedrock.cohere.autoconfigure

org.springframework.ai.model.bedrock.converse.autoconfigure - package org.springframework.ai.model.bedrock.converse.autoconfigure

org.springframework.ai.model.bedrock.titan.autoconfigure - package org.springframework.ai.model.bedrock.titan.autoconfigure

org.springframework.ai.model.chat.client.autoconfigure - package org.springframework.ai.model.chat.client.autoconfigure

org.springframework.ai.model.chat.memory.autoconfigure - package org.springframework.ai.model.chat.memory.autoconfigure

org.springframework.ai.model.chat.memory.redis.autoconfigure - package org.springframework.ai.model.chat.memory.redis.autoconfigure

org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure - package org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure

org.springframework.ai.model.chat.memory.repository.jdbc.autoconfigure - package org.springframework.ai.model.chat.memory.repository.jdbc.autoconfigure

org.springframework.ai.model.chat.memory.repository.mongo.autoconfigure - package org.springframework.ai.model.chat.memory.repository.mongo.autoconfigure

org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure - package org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure

org.springframework.ai.model.chat.memory.repository.redis.autoconfigure - package org.springframework.ai.model.chat.memory.repository.redis.autoconfigure

org.springframework.ai.model.chat.observation.autoconfigure - package org.springframework.ai.model.chat.observation.autoconfigure

Auto-configuration for chat observation.

org.springframework.ai.model.deepseek.autoconfigure - package org.springframework.ai.model.deepseek.autoconfigure

org.springframework.ai.model.elevenlabs.autoconfigure - package org.springframework.ai.model.elevenlabs.autoconfigure

org.springframework.ai.model.embedding.observation.autoconfigure - package org.springframework.ai.model.embedding.observation.autoconfigure

Auto-configuration for embedding observation.

org.springframework.ai.model.google.genai.autoconfigure.chat - package org.springframework.ai.model.google.genai.autoconfigure.chat

org.springframework.ai.model.google.genai.autoconfigure.embedding - package org.springframework.ai.model.google.genai.autoconfigure.embedding

org.springframework.ai.model.google.genai.autoconfigure.image - package org.springframework.ai.model.google.genai.autoconfigure.image

Auto-configuration for Google GenAI image generation.

org.springframework.ai.model.google.genai.autoconfigure.transcription - package org.springframework.ai.model.google.genai.autoconfigure.transcription

Auto-configuration for Google GenAI audio transcription.

org.springframework.ai.model.google.genai.autoconfigure.tts - package org.springframework.ai.model.google.genai.autoconfigure.tts

Auto-configuration for Google GenAI Gemini-TTS text-to-speech.

org.springframework.ai.model.image.observation.autoconfigure - package org.springframework.ai.model.image.observation.autoconfigure

Auto-configuration for image observation.

org.springframework.ai.model.mistralai.autoconfigure - package org.springframework.ai.model.mistralai.autoconfigure

org.springframework.ai.model.observation - package org.springframework.ai.model.observation

Provides classes for observing model data.

org.springframework.ai.model.ollama.autoconfigure - package org.springframework.ai.model.ollama.autoconfigure

org.springframework.ai.model.openai.autoconfigure - package org.springframework.ai.model.openai.autoconfigure

org.springframework.ai.model.postgresml.autoconfigure - package org.springframework.ai.model.postgresml.autoconfigure

org.springframework.ai.model.session.autoconfigure - package org.springframework.ai.model.session.autoconfigure

org.springframework.ai.model.session.jdbc.autoconfigure - package org.springframework.ai.model.session.jdbc.autoconfigure

org.springframework.ai.model.stabilityai.autoconfigure - package org.springframework.ai.model.stabilityai.autoconfigure

org.springframework.ai.model.tool - package org.springframework.ai.model.tool

org.springframework.ai.model.tool.autoconfigure - package org.springframework.ai.model.tool.autoconfigure

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.model.transformers.autoconfigure - package org.springframework.ai.model.transformers.autoconfigure

org.springframework.ai.model.vertexai.autoconfigure.embedding - package org.springframework.ai.model.vertexai.autoconfigure.embedding

org.springframework.ai.moderation - package org.springframework.ai.moderation

org.springframework.ai.observation - package org.springframework.ai.observation

Core observation abstractions.

org.springframework.ai.observation.conventions - package org.springframework.ai.observation.conventions

Conventions for observation-based AI.

org.springframework.ai.ollama - package org.springframework.ai.ollama

org.springframework.ai.ollama.aot - package org.springframework.ai.ollama.aot

org.springframework.ai.ollama.api - package org.springframework.ai.ollama.api

org.springframework.ai.ollama.api.common - package org.springframework.ai.ollama.api.common

org.springframework.ai.ollama.management - package org.springframework.ai.ollama.management

Management support for Ollama.

org.springframework.ai.openai - package org.springframework.ai.openai

org.springframework.ai.openai.http.okhttp - package org.springframework.ai.openai.http.okhttp

Spring AI's customized OkHttp-backed implementation of the OpenAi Java SDK's HttpClient contract.

org.springframework.ai.openai.metadata - package org.springframework.ai.openai.metadata

org.springframework.ai.openai.responses - package org.springframework.ai.openai.responses

org.springframework.ai.openai.setup - package org.springframework.ai.openai.setup

org.springframework.ai.postgresml - package org.springframework.ai.postgresml

org.springframework.ai.rag - package org.springframework.ai.rag

This package contains the core interfaces and classes supporting Retrieval Augmented Generation flows.

org.springframework.ai.rag.advisor - package org.springframework.ai.rag.advisor

org.springframework.ai.rag.generation - package org.springframework.ai.rag.generation

RAG Module: Generation.

org.springframework.ai.rag.generation.augmentation - package org.springframework.ai.rag.generation.augmentation

RAG Sub-Module: Query Augmentation.

org.springframework.ai.rag.postretrieval - package org.springframework.ai.rag.postretrieval

RAG Module: Post-Retrieval.

org.springframework.ai.rag.postretrieval.document - package org.springframework.ai.rag.postretrieval.document

org.springframework.ai.rag.preretrieval - package org.springframework.ai.rag.preretrieval

RAG Module: Pre-Retrieval.

org.springframework.ai.rag.preretrieval.query.expansion - package org.springframework.ai.rag.preretrieval.query.expansion

RAG Sub-Module: Query Expansion.

org.springframework.ai.rag.preretrieval.query.transformation - package org.springframework.ai.rag.preretrieval.query.transformation

RAG Sub-Module: Query Transformation.

org.springframework.ai.rag.retrieval.join - package org.springframework.ai.rag.retrieval.join

RAG Sub-Module: Document Join.

org.springframework.ai.rag.retrieval.search - package org.springframework.ai.rag.retrieval.search

RAG Sub-Module: Document Search.

org.springframework.ai.rag.util - package org.springframework.ai.rag.util

org.springframework.ai.reader - package org.springframework.ai.reader

org.springframework.ai.reader.jsoup - package org.springframework.ai.reader.jsoup

org.springframework.ai.reader.jsoup.config - package org.springframework.ai.reader.jsoup.config

org.springframework.ai.reader.markdown - package org.springframework.ai.reader.markdown

org.springframework.ai.reader.markdown.config - package org.springframework.ai.reader.markdown.config

org.springframework.ai.reader.pdf - package org.springframework.ai.reader.pdf

org.springframework.ai.reader.pdf.aot - package org.springframework.ai.reader.pdf.aot

org.springframework.ai.reader.pdf.config - package org.springframework.ai.reader.pdf.config

org.springframework.ai.reader.pdf.layout - package org.springframework.ai.reader.pdf.layout

org.springframework.ai.reader.tika - package org.springframework.ai.reader.tika

org.springframework.ai.retry - package org.springframework.ai.retry

org.springframework.ai.retry.autoconfigure - package org.springframework.ai.retry.autoconfigure

org.springframework.ai.session - package org.springframework.ai.session

org.springframework.ai.session.advisor - package org.springframework.ai.session.advisor

org.springframework.ai.session.compaction - package org.springframework.ai.session.compaction

org.springframework.ai.session.jdbc - package org.springframework.ai.session.jdbc

JDBC-backed implementation of SessionRepository.

org.springframework.ai.session.jdbc.aot.hint - package org.springframework.ai.session.jdbc.aot.hint

org.springframework.ai.session.support - package org.springframework.ai.session.support

Helpers for SessionRepository implementations.

org.springframework.ai.stabilityai - package org.springframework.ai.stabilityai

org.springframework.ai.stabilityai.api - package org.springframework.ai.stabilityai.api

org.springframework.ai.support - package org.springframework.ai.support

org.springframework.ai.template - package org.springframework.ai.template

org.springframework.ai.template.st - package org.springframework.ai.template.st

org.springframework.ai.test - package org.springframework.ai.test

org.springframework.ai.test.chat.client.advisor - package org.springframework.ai.test.chat.client.advisor

Test support classes for ChatClient advisor integration tests.

org.springframework.ai.test.options - package org.springframework.ai.test.options

org.springframework.ai.test.session - package org.springframework.ai.test.session

The contract tests of a SessionRepository implementation.

org.springframework.ai.test.vectorstore - package org.springframework.ai.test.vectorstore

org.springframework.ai.testcontainers.service.connection.chroma - package org.springframework.ai.testcontainers.service.connection.chroma

org.springframework.ai.testcontainers.service.connection.docker - package org.springframework.ai.testcontainers.service.connection.docker

org.springframework.ai.testcontainers.service.connection.milvus - package org.springframework.ai.testcontainers.service.connection.milvus

org.springframework.ai.testcontainers.service.connection.ollama - package org.springframework.ai.testcontainers.service.connection.ollama

org.springframework.ai.testcontainers.service.connection.opensearch - package org.springframework.ai.testcontainers.service.connection.opensearch

org.springframework.ai.testcontainers.service.connection.qdrant - package org.springframework.ai.testcontainers.service.connection.qdrant

org.springframework.ai.testcontainers.service.connection.typesense - package org.springframework.ai.testcontainers.service.connection.typesense

org.springframework.ai.testcontainers.service.connection.weaviate - package org.springframework.ai.testcontainers.service.connection.weaviate

org.springframework.ai.tokenizer - package org.springframework.ai.tokenizer

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.tool.toolsearch - package org.springframework.ai.tool.toolsearch

Tool Search Tool API: core interface and model types for dynamic tool discovery.

org.springframework.ai.tool.toolsearch.eviction - package org.springframework.ai.tool.toolsearch.eviction

org.springframework.ai.tool.toolsearch.index.lucene - package org.springframework.ai.tool.toolsearch.index.lucene

org.springframework.ai.tool.toolsearch.index.regex - package org.springframework.ai.tool.toolsearch.index.regex

org.springframework.ai.tool.toolsearch.index.vectorstore - package org.springframework.ai.tool.toolsearch.index.vectorstore

org.springframework.ai.transformer - package org.springframework.ai.transformer

org.springframework.ai.transformer.splitter - package org.springframework.ai.transformer.splitter

org.springframework.ai.transformers - package org.springframework.ai.transformers

org.springframework.ai.util - package org.springframework.ai.util

org.springframework.ai.util.json - package org.springframework.ai.util.json

org.springframework.ai.util.json.schema - package org.springframework.ai.util.json.schema

org.springframework.ai.utils - package org.springframework.ai.utils

org.springframework.ai.vectorstore - package org.springframework.ai.vectorstore

Provides interfaces and implementations for working with vector databases in Spring AI.

org.springframework.ai.vectorstore.azure - package org.springframework.ai.vectorstore.azure

Provides the API for embedding observations.

org.springframework.ai.vectorstore.azure.autoconfigure - package org.springframework.ai.vectorstore.azure.autoconfigure

org.springframework.ai.vectorstore.bedrockknowledgebase - package org.springframework.ai.vectorstore.bedrockknowledgebase

Provides the Amazon Bedrock Knowledge Base vector store implementation.

org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure - package org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure

Auto-configuration for Amazon Bedrock Knowledge Base VectorStore.

org.springframework.ai.vectorstore.cassandra - package org.springframework.ai.vectorstore.cassandra

Provides the API for embedding observations.

org.springframework.ai.vectorstore.cassandra.autoconfigure - package org.springframework.ai.vectorstore.cassandra.autoconfigure

org.springframework.ai.vectorstore.chroma.autoconfigure - package org.springframework.ai.vectorstore.chroma.autoconfigure

org.springframework.ai.vectorstore.coherence - package org.springframework.ai.vectorstore.coherence

Provides the API for embedding observations.

org.springframework.ai.vectorstore.couchbase - package org.springframework.ai.vectorstore.couchbase

org.springframework.ai.vectorstore.couchbase.autoconfigure - package org.springframework.ai.vectorstore.couchbase.autoconfigure

org.springframework.ai.vectorstore.elasticsearch - package org.springframework.ai.vectorstore.elasticsearch

Provides the API for embedding observations.

org.springframework.ai.vectorstore.elasticsearch.autoconfigure - package org.springframework.ai.vectorstore.elasticsearch.autoconfigure

org.springframework.ai.vectorstore.filter - package org.springframework.ai.vectorstore.filter

org.springframework.ai.vectorstore.filter.antlr4 - package org.springframework.ai.vectorstore.filter.antlr4

org.springframework.ai.vectorstore.filter.converter - package org.springframework.ai.vectorstore.filter.converter

org.springframework.ai.vectorstore.gemfire - package org.springframework.ai.vectorstore.gemfire

Provides the API for embedding observations.

org.springframework.ai.vectorstore.gemfire.autoconfigure - package org.springframework.ai.vectorstore.gemfire.autoconfigure

org.springframework.ai.vectorstore.mariadb - package org.springframework.ai.vectorstore.mariadb

Provides the API for embedding observations.

org.springframework.ai.vectorstore.mariadb.autoconfigure - package org.springframework.ai.vectorstore.mariadb.autoconfigure

org.springframework.ai.vectorstore.milvus - package org.springframework.ai.vectorstore.milvus

Provides the API for embedding observations.

org.springframework.ai.vectorstore.milvus.autoconfigure - package org.springframework.ai.vectorstore.milvus.autoconfigure

org.springframework.ai.vectorstore.mongodb.atlas - package org.springframework.ai.vectorstore.mongodb.atlas

Provides the API for embedding observations.

org.springframework.ai.vectorstore.mongodb.autoconfigure - package org.springframework.ai.vectorstore.mongodb.autoconfigure

org.springframework.ai.vectorstore.neo4j - package org.springframework.ai.vectorstore.neo4j

Provides the API for embedding observations.

org.springframework.ai.vectorstore.neo4j.autoconfigure - package org.springframework.ai.vectorstore.neo4j.autoconfigure

org.springframework.ai.vectorstore.neo4j.filter - package org.springframework.ai.vectorstore.neo4j.filter

org.springframework.ai.vectorstore.observation - package org.springframework.ai.vectorstore.observation

Provides classes for observing and storing vector data.

org.springframework.ai.vectorstore.observation.autoconfigure - package org.springframework.ai.vectorstore.observation.autoconfigure

org.springframework.ai.vectorstore.opensearch - package org.springframework.ai.vectorstore.opensearch

Provides the API for embedding observations.

org.springframework.ai.vectorstore.opensearch.autoconfigure - package org.springframework.ai.vectorstore.opensearch.autoconfigure

org.springframework.ai.vectorstore.oracle - package org.springframework.ai.vectorstore.oracle

Provides the API for embedding observations.

org.springframework.ai.vectorstore.oracle.autoconfigure - package org.springframework.ai.vectorstore.oracle.autoconfigure

org.springframework.ai.vectorstore.pgvector - package org.springframework.ai.vectorstore.pgvector

Provides the API for embedding observations.

org.springframework.ai.vectorstore.pgvector.autoconfigure - package org.springframework.ai.vectorstore.pgvector.autoconfigure

org.springframework.ai.vectorstore.pinecone - package org.springframework.ai.vectorstore.pinecone

Provides the API for embedding observations.

org.springframework.ai.vectorstore.pinecone.autoconfigure - package org.springframework.ai.vectorstore.pinecone.autoconfigure

org.springframework.ai.vectorstore.properties - package org.springframework.ai.vectorstore.properties

org.springframework.ai.vectorstore.qdrant - package org.springframework.ai.vectorstore.qdrant

Provides the API for embedding observations.

org.springframework.ai.vectorstore.qdrant.autoconfigure - package org.springframework.ai.vectorstore.qdrant.autoconfigure

org.springframework.ai.vectorstore.redis - package org.springframework.ai.vectorstore.redis

Provides the API for embedding observations.

org.springframework.ai.vectorstore.redis.autoconfigure - package org.springframework.ai.vectorstore.redis.autoconfigure

Auto-configuration for Redis Vector Store.

org.springframework.ai.vectorstore.redis.cache.semantic - package org.springframework.ai.vectorstore.redis.cache.semantic

org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure - package org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure

org.springframework.ai.vectorstore.s3 - package org.springframework.ai.vectorstore.s3

S3 Vector Store implementation for Spring AI.

org.springframework.ai.vectorstore.s3.autoconfigure - package org.springframework.ai.vectorstore.s3.autoconfigure

org.springframework.ai.vectorstore.typesense - package org.springframework.ai.vectorstore.typesense

Provides the API for embedding observations.

org.springframework.ai.vectorstore.typesense.autoconfigure - package org.springframework.ai.vectorstore.typesense.autoconfigure

org.springframework.ai.vectorstore.weaviate - package org.springframework.ai.vectorstore.weaviate

Provides the API for embedding observations.

org.springframework.ai.vectorstore.weaviate.autoconfigure - package org.springframework.ai.vectorstore.weaviate.autoconfigure

org.springframework.ai.vertexai.embedding - package org.springframework.ai.vertexai.embedding

org.springframework.ai.vertexai.embedding.multimodal - package org.springframework.ai.vertexai.embedding.multimodal

org.springframework.ai.vertexai.embedding.text - package org.springframework.ai.vertexai.embedding.text

org.springframework.ai.writer - package org.springframework.ai.writer

organizationId - Variable in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

organizationId - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

organizationId - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

organizationId(String) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

organizationId(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

organizationId(String) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

ORIGAMI - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

originalVoiceId() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the originalVoiceId record component.

OUTPUT - Enum constant in enum class org.springframework.ai.observation.conventions.AiTokenType

Output token.

OUTPUT_FORMAT - Enum constant in enum class org.springframework.ai.chat.client.ChatClientAttributes

OUTPUT_SAMPLE_RATE_HERTZ - Static variable in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

The sample rate (in hertz) of the audio returned by the Gemini-TTS models.

OUTPUT_SPACE_CHARACTER_WIDTH_IN_PT - Static variable in class org.springframework.ai.reader.pdf.layout.ForkPDFLayoutTextStripper

outputAudio - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

outputAudio(OpenAiChatOptions.AudioParameters) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

outputCompressionQuality(Integer) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

outputConfig(OutputConfig) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

Sets the output configuration for controlling response format and effort.

outputDimensionality - Variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextParametersBuilder

outputDimensionality(Integer) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextParametersBuilder

outputFormat(String) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

outputJsonSchema(String) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder

Sets a pre-generated JSON schema string to validate against.

outputMimeType(String) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

outputModalities - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

outputModalities(List<String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

outputSchema - Variable in class org.springframework.ai.model.tool.DefaultStructuredOutputChatOptions.Builder

outputSchema(String) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

outputSchema(String) - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions.AbstractBuilder

outputSchema(String) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

outputSchema(String) - Method in class org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder

outputSchema(String) - Method in class org.springframework.ai.model.tool.DefaultStructuredOutputChatOptions.Builder

outputSchema(String) - Method in interface org.springframework.ai.model.tool.StructuredOutputChatOptions.Builder

outputSchema(String) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

outputSchema(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

outputSchema(String) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

outputTokenCount() - Method in record class org.springframework.ai.bedrock.api.AbstractBedrockApi.AmazonBedrockInvocationMetrics

Returns the value of the outputTokenCount record component.

outputType(Type) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder

Sets the expected output type; the JSON schema is derived automatically.

outputType(ParameterizedTypeReference<T>) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder

Sets the expected output type; the JSON schema is derived automatically.

outputType(TypeReference<T>) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder

Sets the expected output type; the JSON schema is derived automatically.

overlapSize(int) - Method in class org.springframework.ai.session.compaction.ChatModelSummarizer.Builder

How many of the preserved events are quoted in the prompt for continuity; 2 by default, 0 for none.

overrideLineSeparator(String) - Method in class org.springframework.ai.reader.ExtractedTextFormatter.Builder

Set the line separator to use when formatting the text.

P

PAGE_LOCATION - Enum constant in enum class org.springframework.ai.anthropic.Citation.LocationType

Page-based location for PDF documents

pageAge() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchResult

Returns the value of the pageAge record component.

pageBottomMargin - Variable in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig

pageExtractedTextFormatter - Variable in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig

PagePdfDocumentReader - Class in org.springframework.ai.reader.pdf

Groups the parsed PDF pages into Documents.

PagePdfDocumentReader(String) - Constructor for class org.springframework.ai.reader.pdf.PagePdfDocumentReader

PagePdfDocumentReader(String, PdfDocumentReaderConfig) - Constructor for class org.springframework.ai.reader.pdf.PagePdfDocumentReader

PagePdfDocumentReader(Resource) - Constructor for class org.springframework.ai.reader.pdf.PagePdfDocumentReader

PagePdfDocumentReader(Resource, PdfDocumentReaderConfig) - Constructor for class org.springframework.ai.reader.pdf.PagePdfDocumentReader

pages() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest

Returns the value of the pages record component.

pages() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRResponse

Returns the value of the pages record component.

pages(List<Integer>) - Method in class org.springframework.ai.mistralai.ocr.MistralAiOcrOptions.Builder

pagesPerDocument - Variable in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig

pagesProcessed() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRResponse

Returns the value of the pagesProcessed record component.

pagesProcessed() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRUsageInfo

Returns the value of the pagesProcessed record component.

pageTopMargin - Variable in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig

pairingAcrossBatches() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

pairingKeepsEachVectorWithItsDocument() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

Paragraph(ParagraphManager.Paragraph, String, int, int, int, int) - Constructor for record class org.springframework.ai.reader.pdf.config.ParagraphManager.Paragraph

Paragraph(ParagraphManager.Paragraph, String, int, int, int, int, List<ParagraphManager.Paragraph>) - Constructor for record class org.springframework.ai.reader.pdf.config.ParagraphManager.Paragraph

Creates an instance of a Paragraph record class.

ParagraphManager - Class in org.springframework.ai.reader.pdf.config

The ParagraphManager class is responsible for managing the paragraphs and hierarchy of a PDF document.

ParagraphManager(PDDocument) - Constructor for class org.springframework.ai.reader.pdf.config.ParagraphManager

ParagraphManager.Paragraph - Record Class in org.springframework.ai.reader.pdf.config

Represents a document paragraph metadata and hierarchy.

ParagraphPdfDocumentReader - Class in org.springframework.ai.reader.pdf

Uses the PDF catalog (e.g.

ParagraphPdfDocumentReader(String) - Constructor for class org.springframework.ai.reader.pdf.ParagraphPdfDocumentReader

Constructs a ParagraphPdfDocumentReader using a resource URL.

ParagraphPdfDocumentReader(String, PdfDocumentReaderConfig) - Constructor for class org.springframework.ai.reader.pdf.ParagraphPdfDocumentReader

Constructs a ParagraphPdfDocumentReader using a resource URL and a configuration.

ParagraphPdfDocumentReader(Resource) - Constructor for class org.springframework.ai.reader.pdf.ParagraphPdfDocumentReader

Constructs a ParagraphPdfDocumentReader using a resource.

ParagraphPdfDocumentReader(Resource, PdfDocumentReaderConfig) - Constructor for class org.springframework.ai.reader.pdf.ParagraphPdfDocumentReader

Constructs a ParagraphPdfDocumentReader using a resource and a configuration.

parallelToolCalls - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

parallelToolCalls - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

parallelToolCalls(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

parallelToolCalls(Boolean) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

param(String, Object) - Method in interface org.springframework.ai.chat.client.ChatClient.AdvisorSpec

param(String, Object) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptSystemSpec

param(String, Object) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptUserSpec

param(String, Object) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec

param(String, Object) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec

param(String, Object) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

parameters() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool.Function

Returns the value of the parameters record component.

parameters() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Returns the value of the parameters record component.

Parameters(String, List<String>, Map<String, String>) - Constructor for record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStdioClientProperties.Parameters

Creates an instance of a Parameters record class.

parameterSize() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model.Details

Returns the value of the parameterSize record component.

params() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec

params() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

params(Map<String, Object>) - Method in interface org.springframework.ai.chat.client.ChatClient.AdvisorSpec

params(Map<String, Object>) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptSystemSpec

params(Map<String, Object>) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptUserSpec

params(Map<String, Object>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec

params(Map<String, Object>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec

params(Map<String, Object>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

parent() - Method in record class org.springframework.ai.reader.pdf.config.ParagraphManager.Paragraph

Returns the value of the parent record component.

parentModel() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model.Details

Returns the value of the parentModel record component.

parse(String) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser

parseToolChoice(JsonNode) - Static method in class org.springframework.ai.openai.OpenAiChatModel

ParsingUtils - Class in org.springframework.ai.util

Utility methods for String parsing.

part(MessagePart) - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder

Appends a content part.

part(MessagePart) - Method in class org.springframework.ai.chat.messages.UserMessage.Builder

Adds a part.

PART_INDEX_ATTRIBUTE - Static variable in class org.springframework.ai.chat.messages.part.StreamingParts

Attribute holding the zero-based content block index of a streamed part.

partial(MessagePart, int) - Static method in class org.springframework.ai.chat.messages.part.StreamingParts

Marks a part as a delta of the content block at the given index.

PARTIAL_ATTRIBUTE - Static variable in class org.springframework.ai.chat.messages.part.StreamingParts

Attribute set to true on a streamed part that is a delta.

partIndex(MessagePart) - Static method in class org.springframework.ai.chat.messages.part.StreamingParts

The content block index of a streamed part.

partitionKeys(List<CassandraVectorStore.SchemaColumn>) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

Sets the partition keys.

partitionName(String) - Method in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore.Builder

Configures the Milvus partition name for insert, delete, and search operations.

parts() - Method in record class org.springframework.ai.session.support.SessionEventCodec.MessageBody

Returns the value of the parts record component.

parts(List<MessagePart>) - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder

Appends content parts in order.

parts(List<MessagePart>) - Method in class org.springframework.ai.chat.messages.ToolResponseMessage.Builder

Adds parts, in order, for example when rebuilding a persisted message.

parts(List<MessagePart>) - Method in class org.springframework.ai.chat.messages.UserMessage.Builder

Adds parts, in order.

password() - Method in record class org.springframework.ai.ollama.api.OllamaApi.PullModelRequest

Returns the value of the password record component.

password(String) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

Sets the password to authenticate requests with

pathName(String) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.Builder

Configures the path name.

payload() - Method in record class org.springframework.ai.chat.messages.part.MediaPart

Returns the value of the payload record component.

payload() - Method in interface org.springframework.ai.chat.messages.part.MessagePart

Provider-owned data that must be replayed verbatim to the same provider, such as a thinking signature or encrypted reasoning, or null when the part carries none.

payload() - Method in record class org.springframework.ai.chat.messages.part.ReasoningPart

Returns the value of the payload record component.

payload() - Method in record class org.springframework.ai.chat.messages.part.TextPart

Returns the value of the payload record component.

payload() - Method in record class org.springframework.ai.chat.messages.part.ToolCallPart

Returns the value of the payload record component.

payload() - Method in record class org.springframework.ai.chat.messages.part.ToolResultPart

Returns the value of the payload record component.

payload() - Method in record class org.springframework.ai.chat.messages.part.UnknownPart

Returns the value of the payload record component.

payload() - Method in record class org.springframework.ai.session.support.SessionEventCodec.EncodedEvent

Returns the value of the payload record component.

payload() - Method in record class org.springframework.ai.session.support.SessionEventCodec.MessageBody

Returns the value of the payload record component.

payload(String, Object) - Method in class org.springframework.ai.session.SessionEvent.Builder

Adds one payload entry.

payload(Map<String, Object>) - Method in class org.springframework.ai.session.SessionEvent.Builder

Replaces the payload of an event that is not a message.

PAYLOAD_COVERED_COUNT - Static variable in record class org.springframework.ai.session.compaction.CompactionBoundary

Payload key: CompactionBoundary.coveredEventCount().

PAYLOAD_PINNED - Static variable in record class org.springframework.ai.session.compaction.CompactionBoundary

Payload key: CompactionBoundary.pinnedEventIds().

PAYLOAD_PRESERVED - Static variable in record class org.springframework.ai.session.compaction.CompactionBoundary

Payload key: CompactionBoundary.preservedEventIds().

PAYLOAD_REDACTED_CONTENT - Static variable in class org.springframework.ai.bedrock.converse.api.ConverseApiUtils

The OpaquePayload.kind() of a redacted reasoning block, whose reasoning Bedrock withheld: the reasoning part has no text and the payload data is the Base64 encoded redacted content, replayed unmodified.

PAYLOAD_REDACTED_THINKING - Static variable in class org.springframework.ai.anthropic.AnthropicChatModel

The OpaquePayload.kind() of a redacted thinking block, whose reasoning Anthropic withheld: the ReasoningPart has no text and the payload data is the opaque block data, replayed unmodified.

PAYLOAD_SIGNATURE - Static variable in class org.springframework.ai.anthropic.AnthropicChatModel

The OpaquePayload.kind() of a thinking block signature; the payload data is the signature, replayed unmodified.

PAYLOAD_SIGNATURE - Static variable in class org.springframework.ai.bedrock.converse.api.ConverseApiUtils

The OpaquePayload.kind() of a signed reasoning block; the payload data is the signature of the reasoning text, replayed unmodified.

PAYLOAD_STRATEGY - Static variable in record class org.springframework.ai.session.compaction.CompactionBoundary

Payload key: CompactionBoundary.strategy().

PAYLOAD_SUMMARY - Static variable in record class org.springframework.ai.session.compaction.CompactionBoundary

Payload key: CompactionBoundary.summaryEventIds().

PAYLOAD_THOUGHT_SIGNATURE - Static variable in class org.springframework.ai.google.genai.GoogleGenAiChatModel

The OpaquePayload.kind() of a Gemini thought signature; the payload data is the Base64 encoded signature, replayed unmodified on the part that carried it.

PAYLOAD_TOKENS_SAVED - Static variable in record class org.springframework.ai.session.compaction.CompactionBoundary

Payload key: CompactionBoundary.tokensEstimatedSaved().

PAYLOAD_TOOL_CALL_ADDITIONAL_PROPERTIES - Static variable in class org.springframework.ai.openai.OpenAiChatModel

The kind of a ToolCallPart payload that holds the extra fields an OpenAI-compatible server returned on that tool call, as a JSON object string.

PCM - Enum constant in enum class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.AudioEncoding

Raw 24 kHz, 16-bit, mono PCM, exactly as returned by the API.

PCM - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.AudioResponseFormat

PCM_16000 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

PCM_22050 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

PCM_24000 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

PCM_44100 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

PCM_48000 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

PCM_8000 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

PCM16 - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.AudioResponseFormat

pdf(byte[]) - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder

Create a PDF document from byte array.

PDF - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCitationDocument.DocumentType

PDF document with page-based citations.

PDF - Enum constant in enum class org.springframework.ai.anthropic.AnthropicSkill

PDF document creation.

PdfDocumentReaderConfig - Class in org.springframework.ai.reader.pdf.config

Common configuration builder for the PagePdfDocumentReader and the ParagraphPdfDocumentReader.

PdfDocumentReaderConfig.Builder - Class in org.springframework.ai.reader.pdf.config

pdfFile(String) - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder

Create a PDF document from file path.

PDFLayoutTextStripperByArea - Class in org.springframework.ai.reader.pdf.layout

Re-implement the PDFLayoutTextStripperByArea on top of the PDFLayoutTextStripper instead the original PDFTextStripper.

PDFLayoutTextStripperByArea() - Constructor for class org.springframework.ai.reader.pdf.layout.PDFLayoutTextStripperByArea

Constructor.

PdfReaderRuntimeHints - Class in org.springframework.ai.reader.pdf.aot

The PdfReaderRuntimeHints class is responsible for registering runtime hints for PDFBox resources.

PdfReaderRuntimeHints() - Constructor for class org.springframework.ai.reader.pdf.aot.PdfReaderRuntimeHints

penalizeNewline - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

penalizeNewline(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

PENDING - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.ReviewStatusEnum

percentage(int) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.ProgressSpec

permissionOnResource() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the permissionOnResource record component.

PERSON_GENERATION_UNSPECIFIED - Enum constant in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.PersonGeneration

personGeneration(GoogleGenAiImageOptions.PersonGeneration) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

PG_ARRAY - Enum constant in enum class org.springframework.ai.postgresml.PostgresMlEmbeddingModel.VectorType

PG_VECTOR - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by PGVector.

PG_VECTOR - Enum constant in enum class org.springframework.ai.postgresml.PostgresMlEmbeddingModel.VectorType

PGVECTOR - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

PgVectorFilterExpressionConverter - Class in org.springframework.ai.vectorstore.pgvector

Converts Filter.Expression into PgVector metadata filter expression format.

PgVectorFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.pgvector.PgVectorFilterExpressionConverter

PgVectorFilterExpressionConverter(String) - Constructor for class org.springframework.ai.vectorstore.pgvector.PgVectorFilterExpressionConverter

PgVectorStore - Class in org.springframework.ai.vectorstore.pgvector

PostgreSQL-based vector store implementation using the pgvector extension.

PgVectorStore(PgVectorStore.PgVectorStoreBuilder) - Constructor for class org.springframework.ai.vectorstore.pgvector.PgVectorStore

PgVectorStore.PgDistanceType - Enum Class in org.springframework.ai.vectorstore.pgvector

Defaults to CosineDistance.

PgVectorStore.PgIdType - Enum Class in org.springframework.ai.vectorstore.pgvector

The ID type for the Pg vector store schema.

PgVectorStore.PgIndexType - Enum Class in org.springframework.ai.vectorstore.pgvector

By default, pgvector performs exact nearest neighbor search, which provides perfect recall.

PgVectorStore.PgVectorStoreBuilder - Class in org.springframework.ai.vectorstore.pgvector

PgVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.pgvector.autoconfigure

Auto-configuration for PostgreSQL Vector Store.

PgVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreAutoConfiguration

PgVectorStoreProperties - Class in org.springframework.ai.vectorstore.pgvector.autoconfigure

Configuration properties for PostgreSQL Vector Store.

PgVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

PHASE_ATTRIBUTE - Static variable in class org.springframework.ai.openai.responses.OpenAiResponsesMetadata

Part attribute holding the phase of an assistant message item (commentary or final_answer), which GPT-5.5 and later return to mark whether a message was a final answer or an intermediate update.

PHI - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

The Phi-2 2.7B language model

PHI3 - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

The Phi-3 3.8B language model

PHOTOGRAPHIC - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

pii() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Returns the value of the pii record component.

pii() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Returns the value of the pii record component.

pii(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder

pii(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder

PINECONE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by Pinecone.

PINECONE - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

PineconeFilterExpressionConverter - Class in org.springframework.ai.vectorstore.filter.converter

Converts Filter.Expression into Pinecone metadata filter expression format

PineconeFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.filter.converter.PineconeFilterExpressionConverter

PineconeVectorStore - Class in org.springframework.ai.vectorstore.pinecone

A VectorStore implementation backed by Pinecone, a cloud-based vector database.

PineconeVectorStore(PineconeVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore

Creates a new PineconeVectorStore using the builder pattern.

PineconeVectorStore.Builder - Class in org.springframework.ai.vectorstore.pinecone

Builder class for creating PineconeVectorStore instances.

PineconeVectorStore.Builder.BuilderWithApiKey - Interface in org.springframework.ai.vectorstore.pinecone

First step interface requiring API key configuration.

PineconeVectorStore.Builder.BuilderWithIndexName - Interface in org.springframework.ai.vectorstore.pinecone

Final step interface requiring index name configuration.

PineconeVectorStore.Builder.StepBuilder - Class in org.springframework.ai.vectorstore.pinecone

Internal implementation of the step builder pattern using records for immutability.

PineconeVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.pinecone.autoconfigure

Auto-configuration for Pinecone Vector Store.

PineconeVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreAutoConfiguration

PineconeVectorStoreProperties - Class in org.springframework.ai.vectorstore.pinecone.autoconfigure

Configuration properties for Pinecone Vector Store.

PineconeVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

ping() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

ping() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

ping() - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

ping() - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

pinnedEventIds() - Method in record class org.springframework.ai.session.compaction.CompactionBoundary

Returns the value of the pinnedEventIds record component.

pinnedEvents() - Method in record class org.springframework.ai.session.compaction.CompactionResult

Returns the value of the pinnedEvents record component.

PIXEL_ART - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

PLAIN_TEXT - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCitationDocument.DocumentType

Plain text document with character-based citations.

plainText(String) - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder

Create a plain text document.

play(byte[]) - Static method in class org.springframework.ai.utils.AudioPlayer

play(InputStream) - Static method in class org.springframework.ai.utils.AudioPlayer

PLUS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

PLUS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

PLUS() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.DecimalConstantContext

PLUS() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IntegerConstantContext

PLUS() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.LongConstantContext

port(int) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

Sets the port for the GemFire connection.

position() - Method in record class org.springframework.ai.reader.pdf.config.ParagraphManager.Paragraph

Returns the value of the position record component.

POSITION_KEY_PREFIX - Static variable in record class org.springframework.ai.model.tool.ToolCallDecisions

The prefix of the key of a tool call that has no id of its own, followed by the call's position in the reply, starting at 0.

PostgresChatMemoryRepositoryDialect - Class in org.springframework.ai.chat.memory.repository.jdbc

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of PostgresJdbcSessionRepositoryDialect in spring-ai-session-jdbc

PostgresChatMemoryRepositoryDialect() - Constructor for class org.springframework.ai.chat.memory.repository.jdbc.PostgresChatMemoryRepositoryDialect

Deprecated.

PostgresJdbcSessionRepositoryDialect - Class in org.springframework.ai.session.jdbc

The dialect of PostgreSQL.

PostgresJdbcSessionRepositoryDialect() - Constructor for class org.springframework.ai.session.jdbc.PostgresJdbcSessionRepositoryDialect

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

PostgresMlEmbeddingAutoConfiguration - Class in org.springframework.ai.model.postgresml.autoconfigure

Auto-configuration class for PostgresMlEmbeddingModel.

PostgresMlEmbeddingAutoConfiguration() - Constructor for class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingAutoConfiguration

postgresMlEmbeddingModel(JdbcTemplate, PostgresMlEmbeddingProperties) - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingAutoConfiguration

PostgresMlEmbeddingModel - Class in org.springframework.ai.postgresml

PostgresML EmbeddingModel

PostgresMlEmbeddingModel(JdbcTemplate) - Constructor for class org.springframework.ai.postgresml.PostgresMlEmbeddingModel

a constructor

PostgresMlEmbeddingModel(JdbcTemplate, PostgresMlEmbeddingOptions) - Constructor for class org.springframework.ai.postgresml.PostgresMlEmbeddingModel

PostgresMlEmbeddingModel(JdbcTemplate, PostgresMlEmbeddingOptions, boolean) - Constructor for class org.springframework.ai.postgresml.PostgresMlEmbeddingModel

a PostgresMlEmbeddingModel constructor

PostgresMlEmbeddingModel.VectorType - Enum Class in org.springframework.ai.postgresml

PostgresMlEmbeddingOptions - Class in org.springframework.ai.postgresml

PostgresML Embedding Options.

PostgresMlEmbeddingOptions(String, PostgresMlEmbeddingModel.VectorType, Map<String, Object>, MetadataMode) - Constructor for class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions

PostgresMlEmbeddingOptions.Builder - Class in org.springframework.ai.postgresml

PostgresMlEmbeddingProperties - Class in org.springframework.ai.model.postgresml.autoconfigure

Configuration properties for Postgres ML.

PostgresMlEmbeddingProperties() - Constructor for class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

PostgresMlEmbeddingProperties.Options - Class in org.springframework.ai.model.postgresml.autoconfigure

postProcessAfterInitialization(Object, String) - Method in class org.springframework.ai.mcp.annotation.spring.scan.AbstractAnnotatedMethodBeanPostProcessor

postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

PPTX - Enum constant in enum class org.springframework.ai.anthropic.AnthropicSkill

PowerPoint presentation creation.

predictionServiceSettings(PredictionServiceSettings) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails.Builder

prefix - Variable in class org.springframework.ai.deepseek.DeepSeekAssistantMessage.AbstractBuilder

Deprecated.

prefix() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage

Returns the value of the prefix record component.

prefix(Boolean) - Method in class org.springframework.ai.deepseek.DeepSeekAssistantMessage.AbstractBuilder

Deprecated.

Sets the prefix completion flag, stored as the DeepSeekChatModel.PREFIX_METADATA_KEY metadata entry.

prefix(String) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache.Builder

prefix(String) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the Redis key prefix (default: "embedding:").

PREFIX_METADATA_KEY - Static variable in class org.springframework.ai.deepseek.DeepSeekChatModel

Message metadata key that marks an assistant message as the prefix the model completes, see the DeepSeek chat prefix completion feature.

prefixedToolName(String) - Method in class org.springframework.ai.mcp.AsyncMcpToolCallback.Builder

Sets the prefixed tool name for the tool definition.

prefixedToolName(String) - Method in class org.springframework.ai.mcp.SyncMcpToolCallback.Builder

Sets the prefixed tool name.

prefixedToolName(String, String, String) - Static method in class org.springframework.ai.mcp.McpToolUtils

prefixedToolName(String, String) - Static method in class org.springframework.ai.mcp.McpToolUtils

prefixedToolName(McpConnectionInfo, McpSchema.Tool) - Method in class org.springframework.ai.mcp.DefaultMcpToolNamePrefixGenerator

prefixedToolName(McpConnectionInfo, McpSchema.Tool) - Method in interface org.springframework.ai.mcp.McpToolNamePrefixGenerator

PREMADE - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.CategoryEnum

presencePenalty - Variable in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

presencePenalty() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the presencePenalty record component.

presencePenalty() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the presencePenalty record component.

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

presencePenalty(Double) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set the presence penalty.

presencePenalty(Double) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

presencePenalty(Double) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

presencePenalty(Float) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

preserved() - Method in record class org.springframework.ai.session.compaction.SummaryRequest

Returns the value of the preserved record component.

preservedEventIds() - Method in record class org.springframework.ai.session.compaction.CompactionBoundary

Returns the value of the preservedEventIds record component.

preservedEvents() - Method in record class org.springframework.ai.session.compaction.CompactionResult

Returns the value of the preservedEvents record component.

pressure() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Response

Returns the value of the pressure record component.

previewUrl() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the previewUrl record component.

PREVIOUS - Enum constant in enum class org.springframework.ai.model.transformer.SummaryMetadataEnricher.SummaryType

previousRequestIds() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Returns the value of the previousRequestIds record component.

previousRequestIds(List<String>) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.Builder

previousRequestIds(List<String>) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

previousText() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Returns the value of the previousText record component.

previousText(String) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.Builder

previousText(String) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

primaryKeyTranslator(CassandraVectorStore.PrimaryKeyTranslator) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

Sets the primary key translator.

PRINCIPAL_NAME - Static variable in class org.springframework.ai.session.SessionAttributes

The name of the principal a session belongs to, as Principal.getName() returns it in Spring Security.

principalName(Session) - Static method in class org.springframework.ai.session.SessionAttributes

The principal name of a session, or null when it has none.

principalSession(String, String) - Static method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

A session with the given id whose metadata names the principal.

PrintFilterExpressionConverter - Class in org.springframework.ai.vectorstore.filter.converter

Converts Filter.Expression into test string format.

PrintFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.filter.converter.PrintFilterExpressionConverter

priority() - Element in annotation interface org.springframework.ai.mcp.annotation.McpResource.McpAnnotations

Describes how important this data is for operating the server.

PRIORITY - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiServiceTier

The priority service tier.

priorSummary() - Method in record class org.springframework.ai.session.compaction.SummaryRequest

Returns the value of the priorSummary record component.

PROBABILITY - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmBlockMethod

probBytes() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content

Returns the value of the probBytes record component.

probBytes() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content.TopLogProbs

Returns the value of the probBytes record component.

probBytes() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content

Returns the value of the probBytes record component.

probBytes() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content.TopLogProbs

Returns the value of the probBytes record component.

process(Query, List<Document>) - Method in interface org.springframework.ai.rag.postretrieval.document.DocumentPostProcessor

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.

processAheadOfTime(ConfigurableListableBeanFactory) - Method in class org.springframework.ai.mcp.annotation.spring.scan.AbstractAnnotatedMethodBeanFactoryInitializationAotProcessor

processPage(PDPage) - Method in class org.springframework.ai.reader.pdf.layout.ForkPDFLayoutTextStripper

processResult(Object) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractSyncMcpToolMethodCallback

Processes the result of the method invocation and converts it to a CallToolResult.

processTextPosition(TextPosition) - Method in class org.springframework.ai.reader.pdf.layout.PDFLayoutTextStripperByArea

PROFESSIONAL - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.CategoryEnum

PROFESSIONAL - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.CategoryEnum

ProfileProperties - Class in org.springframework.ai.model.bedrock.autoconfigure

Configuration properties for Bedrock AWS connection using profile.

ProfileProperties() - Constructor for class org.springframework.ai.model.bedrock.autoconfigure.ProfileProperties

progress - Variable in class org.springframework.ai.mcp.annotation.context.DefaultProgressSpec

progress() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns the value of the progress record component.

progress(double) - Method in class org.springframework.ai.mcp.annotation.context.DefaultProgressSpec

progress(double) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.ProgressSpec

progress(int) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

progress(int) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

progress(int) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

progress(int) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

progress(McpSchema.ProgressNotification) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

progress(McpSchema.ProgressNotification) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

progress(McpSchema.ProgressNotification) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

progress(McpSchema.ProgressNotification) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

progress(Consumer<McpRequestContextTypes.ProgressSpec>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

progress(Consumer<McpRequestContextTypes.ProgressSpec>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

progress(Consumer<McpRequestContextTypes.ProgressSpec>) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

progress(Consumer<McpRequestContextTypes.ProgressSpec>) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

progress(McpProgress) - Method in class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback.AbstractBuilder

Set the progress annotation.

progressHandler() - Method in record class org.springframework.ai.mcp.annotation.method.progress.AsyncProgressSpecification

Returns the value of the progressHandler record component.

progressHandler() - Method in record class org.springframework.ai.mcp.annotation.method.progress.SyncProgressSpecification

Returns the value of the progressHandler record component.

ProgressResponse(String, String, Long, Long) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.ProgressResponse

Creates an instance of a ProgressResponse record class.

progressSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

progressSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

project(List<SessionEvent>) - Static method in record class org.springframework.ai.session.compaction.CompactionBoundary

The active view of a log, from its newest boundary: the pinned events, then the summary events, then the preserved events, then every event appended after the summary; a log without a boundary is its own view, and the boundary event is never in it.

projectId(String) - Method in class org.springframework.ai.google.genai.embedding.GoogleGenAiEmbeddingConnectionDetails.Builder

projectId(String) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageConnectionDetails.Builder

projectId(String) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionConnectionDetails.Builder

Sets the Google Cloud project ID (Vertex AI mode).

projectId(String) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechConnectionDetails.Builder

projectId(String) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails.Builder

projectorInfo() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Returns the value of the projectorInfo record component.

prompt - Variable in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

prompt - Variable in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback

prompt - Variable in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback.AbstractBuilder

prompt - Variable in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback

prompt() - Method in interface org.springframework.ai.chat.client.ChatClient

prompt() - Method in record class org.springframework.ai.chat.client.ChatClientRequest

Returns the value of the prompt record component.

prompt() - Method in class org.springframework.ai.chat.client.DefaultChatClient

prompt() - Element in annotation interface org.springframework.ai.mcp.annotation.McpComplete

The name reference to a prompt.

prompt() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationRequest

Returns the value of the prompt record component.

prompt(String) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

prompt(String) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder

prompt(McpSchema.Prompt) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback.AbstractBuilder

Set the prompt.

prompt(String) - Method in interface org.springframework.ai.chat.client.ChatClient

prompt(String) - Method in class org.springframework.ai.chat.client.DefaultChatClient

prompt(String) - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

Set the prompt reference.

prompt(AudioTranscriptionPrompt) - Method in class org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationContext.Builder

prompt(TextToSpeechPrompt) - Method in class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationContext.Builder

prompt(Prompt) - Method in interface org.springframework.ai.chat.client.ChatClient

prompt(Prompt) - Method in class org.springframework.ai.chat.client.ChatClientRequest.Builder

prompt(Prompt) - Method in class org.springframework.ai.chat.client.DefaultChatClient

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<Message>) - Constructor for class org.springframework.ai.chat.prompt.Prompt

Prompt(List<Message>, 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

PromptAdapter - Class in org.springframework.ai.mcp.annotation.adapter

Utility class for adapting between McpPrompt annotations and McpSchema.Prompt objects.

PromptAssert - Class in org.springframework.ai.rag.util

Assertion utility class that assists in validating arguments for prompt-related operations.

promptCacheKey - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

promptCacheKey - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

promptCacheKey(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

promptCacheKey(String) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

promptEvalCount() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Returns the value of the promptEvalCount record component.

promptEvalCount() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsResponse

Returns the value of the promptEvalCount record component.

promptEvalDuration() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Returns the value of the promptEvalDuration record component.

promptListChanged(McpPromptListChanged) - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback.AbstractBuilder

Set the prompt list changed annotation.

promptListChangedSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

promptListChangedSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

promptListChangeHandler() - Method in record class org.springframework.ai.mcp.annotation.method.changed.prompt.AsyncPromptListChangedSpecification

Returns the value of the promptListChangeHandler record component.

promptListChangeHandler() - Method in record class org.springframework.ai.mcp.annotation.method.changed.prompt.SyncPromptListChangedSpecification

Returns the value of the promptListChangeHandler record component.

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.

promptSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

promptSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

promptTemplate(PromptTemplate) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor.Builder

promptTemplate(PromptTemplate) - Method in class org.springframework.ai.chat.evaluation.RelevancyEvaluator.Builder

promptTemplate(PromptTemplate) - Method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter.Builder

promptTemplate(PromptTemplate) - Method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander.Builder

promptTemplate(PromptTemplate) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.CompressionQueryTransformer.Builder

promptTemplate(PromptTemplate) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer.Builder

promptTemplate(PromptTemplate) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer.Builder

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.

promptTokens() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.Usage

Returns the value of the promptTokens record component.

promptTokens() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.Usage

Returns the value of the promptTokens record component.

promptTokensDetails() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.Usage

Returns the value of the promptTokensDetails record component.

PromptTokensDetails(Integer) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.Usage.PromptTokensDetails

Creates an instance of a PromptTokensDetails record class.

pronunciationDictionaryId() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator

Returns the value of the pronunciationDictionaryId record component.

PronunciationDictionaryLocator(String, String) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator

Creates an instance of a PronunciationDictionaryLocator record class.

pronunciationDictionaryLocators() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Returns the value of the pronunciationDictionaryLocators record component.

pronunciationDictionaryLocators(List<ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator>) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.Builder

pronunciationDictionaryLocators(List<ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator>) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

properties - Variable in class org.springframework.ai.chat.messages.AssistantMessage.Builder

properties(Map<String, Object>) - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder

PropertiesMcpSseClientConnectionDetails - Class in org.springframework.ai.mcp.client.common.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

PropertiesMcpSseClientConnectionDetails(McpSseClientProperties) - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.PropertiesMcpSseClientConnectionDetails

Deprecated.

PROPERTY_REQUIRED_FALSE_BY_DEFAULT - Enum constant in enum class org.springframework.ai.util.json.schema.AbstractSpringAiSchemaModule.Option

Properties are only required if marked as such via one of the supported annotations.

protectFromBlocking(boolean) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor.Builder

protocolVersions() - Method in class org.springframework.ai.mcp.client.webflux.transport.WebClientStreamableHttpTransport

protocolVersions() - Method in class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport

Deprecated.

protocolVersions() - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider

Deprecated.

protocolVersions() - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider

protocolVersions() - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider

Deprecated.

protocolVersions() - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider

provider() - Method in record class org.springframework.ai.chat.messages.part.OpaquePayload

Returns the value of the provider record component.

provider() - Method in record class org.springframework.ai.chat.messages.part.UnknownPart

Returns the value of the provider record component.

provider() - Method in record class org.springframework.ai.observation.AiOperationMetadata

Returns the value of the provider record component.

provider(String) - Method in class org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationContext.Builder

provider(String) - Method in class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationContext.Builder

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

provider(String) - Method in class org.springframework.ai.observation.AiOperationMetadata.Builder

Set the provider.

PROVIDER - Static variable in class org.springframework.ai.openai.responses.OpenAiResponsesMetadata

The provider of every payload and every UnknownPart this model produces, and the only one it replays.

PROVIDER_ATTRIBUTE - Static variable in interface org.springframework.ai.chat.messages.part.MessagePart

Attribute naming the provider that produced a part, matching OpaquePayload.provider().

PROVIDER_NAME - Static variable in class org.springframework.ai.deepseek.api.common.DeepSeekConstants

PROVIDER_NAME - Static variable in class org.springframework.ai.google.genai.common.GoogleGenAiConstants

PROVIDER_NAME - Static variable in class org.springframework.ai.mistralai.api.MistralAiApi

PROVIDER_NAME - Static variable in class org.springframework.ai.ollama.api.common.OllamaApiConstants

PROVISIONED_THROUGHPUT - Enum constant in enum class org.springframework.ai.google.genai.metadata.GoogleGenAiTrafficType

Provisioned Throughput traffic type.

proxy - Variable in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

proxy - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

proxy - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

proxy(Proxy) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

proxy(Proxy) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

proxy(Proxy) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

proxy(Proxy) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

proxy(Proxy) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

proxy(Proxy) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

proxyAuthenticator(ProxyAuthenticator) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

proxyAuthenticator(ProxyAuthenticator) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

publicOwnerId() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the publicOwnerId record component.

publisher(String) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails.Builder

pullModel(String) - Method in class org.springframework.ai.ollama.management.OllamaModelManager

pullModel(String, PullModelStrategy) - Method in class org.springframework.ai.ollama.management.OllamaModelManager

pullModel(OllamaApi.PullModelRequest) - Method in class org.springframework.ai.ollama.api.OllamaApi

Download a model from the Ollama library.

PullModelRequest(String) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.PullModelRequest

PullModelRequest(String, boolean, String, String, boolean) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.PullModelRequest

Creates an instance of a PullModelRequest record class.

pullModelStrategy() - Method in record class org.springframework.ai.ollama.management.ModelManagementOptions

Returns the value of the pullModelStrategy record component.

pullModelStrategy(PullModelStrategy) - Method in class org.springframework.ai.ollama.management.ModelManagementOptions.Builder

PullModelStrategy - Enum Class in org.springframework.ai.ollama.management

Strategy for pulling Ollama models.

purgeExcess(List<MediaContent>, int) - Method in class org.springframework.ai.chat.client.advisor.LastMaxTokenSizeContentPurger

push(Advisor) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisorChain.Builder

Adds a single Advisor to the chain.

push(Advisor) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder

pushAll(List<? extends Advisor>) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisorChain.Builder

Adds multiple Advisor instances to the chain.

pushAll(List<? extends Advisor>) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder

put(String, T) - Method in class org.springframework.ai.model.MutableResponseMetadata

Puts an element to the context.

Q

QDRANT - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by Qdrant.

QDRANT - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

qdrantClient(QdrantVectorStoreProperties, QdrantConnectionDetails) - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreAutoConfiguration

QdrantConnectionDetails - Interface in org.springframework.ai.vectorstore.qdrant.autoconfigure

Connection details for a Qdrant service client.

QdrantVectorStore - Class in org.springframework.ai.vectorstore.qdrant

Qdrant vectorStore implementation.

QdrantVectorStore(QdrantVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

Protected constructor for creating a QdrantVectorStore instance using the builder pattern.

QdrantVectorStore.Builder - Class in org.springframework.ai.vectorstore.qdrant

Builder for creating instances of QdrantVectorStore.

QdrantVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.qdrant.autoconfigure

Auto-configuration for Qdrant Vector Store.

QdrantVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreAutoConfiguration

QdrantVectorStoreProperties - Class in org.springframework.ai.vectorstore.qdrant.autoconfigure

Configuration properties for Qdrant Vector Store.

QdrantVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

quality(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder

quantizationLevel() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model.Details

Returns the value of the quantizationLevel record component.

query() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchRequest

Returns the value of the query record component.

query() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchResponse.SearchMetadata

Returns the value of the query record component.

query(String) - Method in class org.springframework.ai.tool.toolsearch.ToolSearchResponse.SearchMetadata.Builder

query(String) - Method in class org.springframework.ai.vectorstore.milvus.MilvusSearchRequest.MilvusBuilder

SearchRequest.Builder.query(java.lang.String)

query(String) - Method in class org.springframework.ai.vectorstore.SearchRequest.Builder

Query - Record Class in org.springframework.ai.rag

Represents a query in the context of a Retrieval Augmented Generation (RAG) flow.

Query(String) - Constructor for record class org.springframework.ai.rag.Query

Query(String, List<Message>, Map<String, Object>) - Constructor for record class org.springframework.ai.rag.Query

Creates an instance of a Query record class.

QUERY - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Operation

VectorStore similarity search operation.

Query.Builder - Class in org.springframework.ai.rag

queryAugmenter(QueryAugmenter) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder

QueryAugmenter - Interface in org.springframework.ai.rag.generation.augmentation

A component for augmenting an input query with additional data, useful to provide a large language model with the necessary context to answer the user query.

queryCollection(String, String, String, ChromaApi.QueryRequest) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

queryContent(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

queryEmbeddingOfWrongDimensionRejected() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

queryEmbeddings() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest

Returns the value of the queryEmbeddings record component.

queryExpander(QueryExpander) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder

QueryExpander - Interface in org.springframework.ai.rag.preretrieval.query.expansion

A component for expanding the input query into a list of queries, addressing challenges such as poorly formed queries by providing alternative query formulations, or by breaking down complex problems into simpler sub-queries.

queryRequest(SearchRequest) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder

QueryRequest(float[], Integer) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest

Convenience to query for a single embedding instead of a batch of embeddings.

QueryRequest(float[], Integer, Map<String, Object>) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest

QueryRequest(List<float[]>, Integer, Map<String, Object>, List<ChromaApi.QueryRequest.Include>) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest

Creates an instance of a QueryRequest record class.

queryResponse(List<Document>) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder

QueryResponse(List<List<String>>, List<List<float[]>>, List<List<String>>, List<List<Map<String, Object>>>, List<List<Double>>) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryResponse

Creates an instance of a QueryResponse record class.

QueryTransformer - Interface in org.springframework.ai.rag.preretrieval.query.transformation

A component for transforming the input query to make it more effective for retrieval tasks, addressing challenges such as poorly formed queries, ambiguous terms, complex vocabulary, or unsupported languages.

queryTransformers(List<QueryTransformer>) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder

queryTransformers(QueryTransformer...) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder

QUESTION_ANSWERING - Enum constant in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.TaskType

Specifies that the query embedding is used for answering questions.

QUESTION_ANSWERING - Enum constant in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.TaskType

Specifies that the query embedding is used for answering questions.

QuestionAnswerAdvisor - Class in org.springframework.ai.chat.client.advisor.vectorstore

Context for the question is retrieved from a Vector Store and added to the prompt's user text.

QuestionAnswerAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor.vectorstore

QUORUM - Enum constant in enum class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.ConsistentLevel

Write must receive an acknowledgement from at least QUORUM replica nodes.

QUOTED_STRING - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

QUOTED_STRING - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

QUOTED_STRING() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.QuotedIdentifierContext

QUOTED_STRING() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.TextConstantContext

QuotedIdentifierContext(FiltersParser.IdentifierContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.QuotedIdentifierContext

QWEN_2_5_3B - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

QWEN_2_5_7B - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Qwen 2.5

QWEN_3_06B - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Qwen3 0.6b

QWEN_3_1_7_B - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Qwen3 1.7b

QWEN2_5_VL - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Flagship vision-language model of Qwen and also a significant leap from the previous Qwen2-VL.

QWEN3_4B - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Qwen3 4B

QWEN3_4B_THINKING - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Qwen3 4B with thinking support.

QWEN3_7B - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Qwen3 is the latest generation of large language models in Qwen series, offering a comprehensive suite of dense and mixture-of-experts (MoE) models.

QWEN3_EMBED_8B - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

A multilingual text embedding model with 8B parameters.

QWQ - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

QwQ is the reasoning model of the Qwen series.

R

RandomIdGenerator - Class in org.springframework.ai.document.id

A random ID generator that returns a UUID.

RandomIdGenerator() - Constructor for class org.springframework.ai.document.id.RandomIdGenerator

randomSeed() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the randomSeed record component.

randomSeed(Integer) - Method in class org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder

rate() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the rate record component.

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.

Raw(Map<String, Object>) - Constructor for record class org.springframework.ai.openai.responses.HostedTool.Raw

Creates an instance of a Raw record class.

rawInput() - Method in record class org.springframework.ai.tool.augment.AugmentedArgumentEvent

Returns the value of the rawInput record component.

rawJson() - Method in record class org.springframework.ai.chat.messages.part.UnknownPart

Returns the value of the rawJson record component.

ReactiveUtils - Class in org.springframework.ai.mcp.annotation.method.tool

read() - Method in interface org.springframework.ai.document.DocumentReader

READ - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ReaderResource.ResourceTypeEnum

readerAppEnabled() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the readerAppEnabled record component.

ReaderResource(ElevenLabsVoicesApi.ReaderResource.ResourceTypeEnum, String) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ReaderResource

Creates an instance of a ReaderResource record class.

readerRestrictedOn() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the readerRestrictedOn record component.

readOnlyHint() - Element in annotation interface org.springframework.ai.mcp.annotation.McpTool.McpAnnotations

If true, the tool does not modify its environment.

readyToBuildBuilder() - Method in class org.springframework.ai.test.options.AbstractChatOptionsTests

Return an instance of a builder that should not error when calling ChatOptions.Builder.build().

reasoning(List<ReasoningPart>) - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder

Appends reasoning parts in order.

reasoning(ReasoningPart) - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder

Appends a reasoning part.

REASONING_CONTENT - Static variable in class org.springframework.ai.openai.responses.OpenAiResponsesMetadata

Reasoning summary text, one line per reasoning item.

reasoningContent - Variable in class org.springframework.ai.deepseek.DeepSeekAssistantMessage.AbstractBuilder

Deprecated.

reasoningContent() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage

Returns the value of the reasoningContent record component.

reasoningContent(String) - Method in class org.springframework.ai.deepseek.DeepSeekAssistantMessage.AbstractBuilder

Deprecated.

Sets the reasoning content.

reasoningEffort - Variable in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

reasoningEffort - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

reasoningEffort - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

reasoningEffort() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the reasoningEffort record component.

reasoningEffort() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the reasoningEffort record component.

reasoningEffort(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

reasoningEffort(String) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

reasoningEffort(DeepSeekApi.ChatCompletionRequest.ReasoningEffort) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set the reasoning effort level.

reasoningEffort(DeepSeekApi.ChatCompletionRequest.ReasoningEffort) - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

reasoningEffort(MistralAiApi.ChatCompletionRequest.ReasoningEffort) - Method in class org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder

reasoningEffortHigh() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

reasoningEffortMax() - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

ReasoningPart - Record Class in org.springframework.ai.chat.messages.part

Model reasoning (thinking) that preceded or accompanied the answer.

ReasoningPart(String, String, OpaquePayload, Map<String, String>) - Constructor for record class org.springframework.ai.chat.messages.part.ReasoningPart

Creates an instance of a ReasoningPart record class.

reasoningSummary - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

reasoningSummary(String) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

recall - Enum constant in enum class org.springframework.ai.vectorstore.couchbase.CouchbaseIndexOptimization

recall: The Search Service prioritizes returning the most accurate result.

reConcatenateCamelCase(String, String) - Static method in class org.springframework.ai.util.ParsingUtils

Reconcatenates the given camel-case source String using the given delimiter.

recording() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerificationAttempt

Returns the value of the recording record component.

Recording(String, String, Integer, Integer, String) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Recording

Creates an instance of a Recording record class.

recordingId() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Recording

Returns the value of the recordingId record component.

REDIS - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by Redis.

REDIS - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

RedisChatMemoryAutoConfiguration - Class in org.springframework.ai.model.chat.memory.redis.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

Use RedisChatMemoryRepositoryAutoConfiguration instead.

RedisChatMemoryAutoConfiguration() - Constructor for class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryAutoConfiguration

Deprecated.

RedisChatMemoryConfig - Class in org.springframework.ai.chat.memory.repository.redis

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory: org.springframework.ai.session.SessionRepository in spring-ai-session, with a JDBC store in spring-ai-session-jdbc. There is no session store for Redis yet; one is planned before 3.0.0, when this module is removed.

RedisChatMemoryConfig.Builder - Class in org.springframework.ai.chat.memory.repository.redis

Deprecated.

Builder for RedisChatMemoryConfig.

RedisChatMemoryProperties - Class in org.springframework.ai.model.chat.memory.redis.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

Use RedisChatMemoryRepositoryProperties instead.

RedisChatMemoryProperties(RedisChatMemoryRepositoryProperties) - Constructor for class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated.

redisChatMemoryRepository(RedisClient, RedisChatMemoryRepositoryProperties) - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryAutoConfiguration

Deprecated.

RedisChatMemoryRepository - Class in org.springframework.ai.chat.memory.repository.redis

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory: org.springframework.ai.session.SessionRepository in spring-ai-session, with a JDBC store in spring-ai-session-jdbc. There is no session store for Redis yet; one is planned before 3.0.0, when this module is removed.

RedisChatMemoryRepository(RedisChatMemoryConfig) - Constructor for class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

RedisChatMemoryRepository.Builder - Class in org.springframework.ai.chat.memory.repository.redis

Deprecated.

Inner static builder class for constructing instances of RedisChatMemoryRepository.

RedisChatMemoryRepositoryAutoConfiguration - Class in org.springframework.ai.model.chat.memory.repository.redis.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of the session memory auto-configuration, SessionServiceAutoConfiguration in spring-ai-autoconfigure-model-session. There is no session store for Redis yet; one is planned before 3.0.0, when this module is removed.

RedisChatMemoryRepositoryAutoConfiguration() - Constructor for class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryAutoConfiguration

Deprecated.

redisChatMemoryRepositoryProperties(Environment) - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryAutoConfiguration

Deprecated.

Provides Redis chat memory repository configuration properties.

RedisChatMemoryRepositoryProperties - Class in org.springframework.ai.model.chat.memory.repository.redis.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of the session memory auto-configuration, SessionServiceAutoConfiguration in spring-ai-autoconfigure-model-session. There is no session store for Redis yet; one is planned before 3.0.0, when this module is removed.

RedisChatMemoryRepositoryProperties() - Constructor for class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

RedisFilterExpressionConverter - Class in org.springframework.ai.vectorstore.redis

Converts Filter.Expression into Redis search filter expression format

RedisFilterExpressionConverter(List<RedisVectorStore.MetadataField>) - Constructor for class org.springframework.ai.vectorstore.redis.RedisFilterExpressionConverter

RedisSemanticCacheAutoConfiguration - Class in org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure

Auto-configuration for Redis semantic cache.

RedisSemanticCacheAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure.RedisSemanticCacheAutoConfiguration

RedisSemanticCacheProperties - Class in org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure

Configuration properties for Redis semantic cache.

RedisSemanticCacheProperties() - Constructor for class org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure.RedisSemanticCacheProperties

RedisVectorStore - Class in org.springframework.ai.vectorstore.redis

Redis-based vector store implementation using Redis Stack with Redis Query Engine and RedisJSON.

RedisVectorStore(RedisVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.redis.RedisVectorStore

RedisVectorStore.Algorithm - Enum Class in org.springframework.ai.vectorstore.redis

RedisVectorStore.Builder - Class in org.springframework.ai.vectorstore.redis

RedisVectorStore.DistanceMetric - Enum Class in org.springframework.ai.vectorstore.redis

Supported distance metrics for vector similarity in Redis.

RedisVectorStore.MetadataField - Record Class in org.springframework.ai.vectorstore.redis

RedisVectorStore.TextScorer - Enum Class in org.springframework.ai.vectorstore.redis

Text scoring algorithms for text search in Redis.

RedisVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.redis.autoconfigure

Auto-configuration for Redis Vector Store.

RedisVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreAutoConfiguration

RedisVectorStoreHelper - Class in org.springframework.ai.vectorstore.redis.cache.semantic

Helper utility for creating and configuring Redis-based vector stores for semantic caching.

RedisVectorStoreProperties - Class in org.springframework.ai.vectorstore.redis.autoconfigure

Configuration properties for Redis Vector Store.

RedisVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties

RedisVectorStoreProperties.HnswProperties - Class in org.springframework.ai.vectorstore.redis.autoconfigure

HNSW (Hierarchical Navigable Small World) algorithm configuration.

reference(McpSchema.CompleteReference) - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

Set the complete reference.

REFERENCE_CONTENT_METADATA - Static variable in class org.springframework.ai.mistralai.MistralAiChatModel

REFERENCE_THINKING_CONTENT_METADATA - Static variable in class org.springframework.ai.mistralai.MistralAiChatModel

ReferenceChunk(List<Integer>) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ReferenceChunk

Creates an instance of a ReferenceChunk record class.

referenceIds() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ReferenceChunk

Returns the value of the referenceIds record component.

referenceToolNameAccumulation(boolean) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor.Builder

refreshExpiration(String, Duration) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService

Refreshes the expiration of cached content to the maximum TTL.

refusal() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs

Returns the value of the refusal record component.

REFUSAL - Static variable in class org.springframework.ai.openai.responses.OpenAiResponsesMetadata

The model's refusal text, or an empty string.

RegexToolIndex - Class in org.springframework.ai.tool.toolsearch.index.regex

Regex-based tool searcher that converts natural-language queries into case-insensitive OR patterns and matches them against tool names and descriptions.

RegexToolIndex() - Constructor for class org.springframework.ai.tool.toolsearch.index.regex.RegexToolIndex

region() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation

Returns the value of the region record component.

region(Region) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder

regionProvider(BedrockAwsConnectionProperties) - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionConfiguration

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

registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.bedrock.aot.BedrockRuntimeHints

registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.deepseek.aot.DeepSeekRuntimeHints

registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.elevenlabs.aot.ElevenLabsRuntimeHints

registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.google.genai.aot.GoogleGenAiRuntimeHints

registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.mcp.aot.McpHints

Registers runtime hints for MCP schema classes.

registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.aot.McpClientAutoConfigurationRuntimeHints

registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.mcp.client.httpclient.autoconfigure.aot.McpClientAutoConfigurationRuntimeHints

registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.mcp.client.webflux.autoconfigure.aot.McpClientAutoConfigurationRuntimeHints

registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.mistralai.aot.MistralAiRuntimeHints

registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.ollama.aot.OllamaRuntimeHints

registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.ai.reader.pdf.aot.PdfReaderRuntimeHints

relevanceScore() - Method in record class org.springframework.ai.tool.toolsearch.ToolReference

Returns the value of the relevanceScore record component.

relevanceScore(Double) - Method in class org.springframework.ai.tool.toolsearch.ToolReference.Builder

relevanceScore(Float) - Method in class org.springframework.ai.tool.toolsearch.ToolReference.Builder

RelevancyEvaluator - Class in org.springframework.ai.chat.evaluation

Evaluates the relevancy of a response to a query based on the context provided.

RelevancyEvaluator(ChatClient.Builder) - Constructor for class org.springframework.ai.chat.evaluation.RelevancyEvaluator

RelevancyEvaluator.Builder - Class in org.springframework.ai.chat.evaluation

remove(Object) - Method in class org.springframework.ai.model.MutableResponseMetadata

Removes an entry from the context.

removeExistingVectorStoreTable(boolean) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBBuilder

Configures whether to remove any existing vector store table.

removeExistingVectorStoreTable(boolean) - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore.Builder

Sets whether to remove existing vector store table before initialization.

removeExistingVectorStoreTable(boolean) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgVectorStoreBuilder

removeExtraArgumentsAfterProcessing(boolean) - Method in class org.springframework.ai.tool.augment.AugmentedToolCallbackProvider.Builder

Sets whether to remove extra arguments after processing

removeOuterQuotes(String) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter

Remove the outer quotes from the given string.

removeRegion(String) - Method in class org.springframework.ai.reader.pdf.layout.PDFLayoutTextStripperByArea

Delete a region to group text by.

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<String, Object>) - Method in class org.springframework.ai.chat.prompt.ChatPromptTemplate

render(Map<String, Object>) - Method in class org.springframework.ai.chat.prompt.PromptTemplate

render(Map<String, Object>) - 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

repeatLastN - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

repeatLastN(Integer) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

repeatPenalty - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

repeatPenalty(Double) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

replace(List<MessagePart>, Class<? extends MessagePart>, List<? extends MessagePart>, int) - Static method in class org.springframework.ai.chat.messages.AbstractMessage

Removes every part of the given type and inserts the replacements where the first one was, or at fallbackIndex when there was none.

replaceById() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

replaceChangesTheStoredVector() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

replayableTo(String) - Method in record class org.springframework.ai.chat.messages.part.ReasoningPart

Whether this part can be sent to the given provider without losing its payload: true when there is no payload, or when the payload was produced by that provider.

replayReasoningContent - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

replayReasoningContent(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

Sets whether a previous assistant message's reasoning content is sent back as the reasoning_content property of the next request.

replicatedVoice(GoogleGenAiAudioSpeechOptions.ReplicatedVoice) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.Builder

ReplicatedVoice(byte[], byte[], String, String) - Constructor for record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.ReplicatedVoice

Creates an instance of a ReplicatedVoice record class.

repository - Variable in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

request() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

request() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

request() - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes

request(McpSchema.Request) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext.Builder

request(McpSchema.Request) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext.Builder

request(ChatClientRequest) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder

Request(String, double, double, MockWeatherService.Unit) - Constructor for record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Request

Creates an instance of a Request record class.

REQUEST_AUDIO_RESPONSE_FORMAT - Enum constant in enum class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationDocumentation.HighCardinalityKeyNames

The format in which the synthesized audio is returned.

REQUEST_AUDIO_RESPONSE_FORMAT - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

The format in which the synthesized audio is returned.

REQUEST_AUDIO_SPEED - Enum constant in enum class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationDocumentation.HighCardinalityKeyNames

The speed of the synthesized speech.

REQUEST_AUDIO_SPEED - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

The speed of the synthesized speech.

REQUEST_AUDIO_VOICE - Enum constant in enum class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationDocumentation.HighCardinalityKeyNames

The voice to synthesize speech with.

REQUEST_AUDIO_VOICE - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

The voice to synthesize speech with.

REQUEST_BODY_NULL_ERROR - Static variable in class org.springframework.ai.ollama.api.OllamaApi

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_EMBEDDING_DIMENSIONS - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

The number of dimensions the resulting output embeddings have.

REQUEST_EVENT_ID_CONTEXT_KEY - Static variable in class org.springframework.ai.session.advisor.SessionMemoryAdvisor

Context key the advisor sets on the request it forwards, and so on the response: the id of the event that stores the request's trailing user or tool message; absent when none was stored.

REQUEST_FREQUENCY_PENALTY - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames

The frequency penalty setting for the model request.

REQUEST_FREQUENCY_PENALTY - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

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_RESPONSE_FORMAT - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

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_SIZE - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

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_IMAGE_STYLE - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

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_MAX_TOKENS - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

The maximum number of tokens the model generates for a request.

REQUEST_MODEL - Enum constant in enum class org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationDocumentation.LowCardinalityKeyNames

The name of the model a request is being made to.

REQUEST_MODEL - Enum constant in enum class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationDocumentation.LowCardinalityKeyNames

The name of the model a request is being made to.

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_MODEL - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

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_PRESENCE_PENALTY - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

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_STOP_SEQUENCES - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

List of sequences that the model will use to stop generating further tokens.

REQUEST_STREAM - Enum constant in enum class org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationDocumentation.HighCardinalityKeyNames

Whether the request was made in streaming mode.

REQUEST_STREAM - Enum constant in enum class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationDocumentation.HighCardinalityKeyNames

Whether the request was made in streaming mode.

REQUEST_STREAM - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames

Indicates whether the GenAI request was made in streaming mode.

REQUEST_STREAM - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

Indicates whether the GenAI request was made in streaming mode.

REQUEST_TEMPERATURE - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames

The temperature setting for the model request.

REQUEST_TEMPERATURE - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

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_TOOL_NAMES - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

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_K - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

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.

REQUEST_TOP_P - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

The top_p sampling setting for the model request.

requestAudioResponseFormat(KeyValues, TextToSpeechModelObservationContext) - Method in class org.springframework.ai.audio.tts.observation.DefaultTextToSpeechModelObservationConvention

requestAudioSpeed(KeyValues, TextToSpeechModelObservationContext) - Method in class org.springframework.ai.audio.tts.observation.DefaultTextToSpeechModelObservationConvention

requestAudioVoice(KeyValues, TextToSpeechModelObservationContext) - Method in class org.springframework.ai.audio.tts.observation.DefaultTextToSpeechModelObservationConvention

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

requestMeta() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

requestMeta() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

requestMeta() - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes

requestModel(TranscriptionModelObservationContext) - Method in class org.springframework.ai.audio.transcription.observation.DefaultTranscriptionModelObservationConvention

requestModel(TextToSpeechModelObservationContext) - Method in class org.springframework.ai.audio.tts.observation.DefaultTextToSpeechModelObservationConvention

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

requestParameters - Variable in class org.springframework.ai.bedrock.converse.BedrockChatOptions.AbstractBuilder

requestParameters(Map<String, Object>) - Method in class org.springframework.ai.bedrock.converse.BedrockChatOptions.AbstractBuilder

requestPresencePenalty(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention

requestStopSequences(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention

requestStream(KeyValues, TranscriptionModelObservationContext) - Method in class org.springframework.ai.audio.transcription.observation.DefaultTranscriptionModelObservationConvention

requestStream(KeyValues, TextToSpeechModelObservationContext) - Method in class org.springframework.ai.audio.tts.observation.DefaultTextToSpeechModelObservationConvention

requestStream(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention

requestTemperature(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention

requestTimeUnix() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerification

Returns the value of the requestTimeUnix record component.

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

requestToString(Function<ChatClientRequest, String>) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor.Builder

requireApproval() - Method in record class org.springframework.ai.openai.responses.HostedTool.Mcp

Returns the value of the requireApproval record component.

required() - Element in annotation interface org.springframework.ai.mcp.annotation.McpArg

True if this argument is required. false if this argument is optional.

required() - Element in annotation interface org.springframework.ai.mcp.annotation.McpToolParam

Whether the tool argument is required.

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.

requiresConfirmation() - Element in annotation interface org.springframework.ai.tool.annotation.Tool

Whether a call of the tool needs a person's confirmation before it runs.

requiresConfirmation() - Method in record class org.springframework.ai.tool.metadata.DefaultToolMetadata

Returns the value of the requiresConfirmation record component.

requiresConfirmation() - Method in interface org.springframework.ai.tool.metadata.ToolMetadata

Whether a call of the tool needs a person's confirmation before it runs.

requiresConfirmation(boolean) - Method in class org.springframework.ai.tool.metadata.DefaultToolMetadata.Builder

Whether a call of the tool needs a person's confirmation before it runs.

requiresConfirmation(AssistantMessage.ToolCall, ToolMetadata) - Method in interface org.springframework.ai.model.tool.ToolCallConfirmationPolicy

Whether the tool call needs a confirmation before it runs.

requiresVerification() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceVerification

Returns the value of the requiresVerification record component.

rerankingModelArn(String) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore.Builder

Enables reranking with a Bedrock reranking model.

Resolution() - Constructor for class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Resolution

resolutionFallbackEnabled(boolean) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder

Whether a call to a tool that is not part of the request's tool callbacks may still be executed by resolving it through the ToolCallbackResolver.

resolve(String) - Method in class org.springframework.ai.tool.resolution.DelegatingToolCallbackResolver

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.

resolve(MessageType, String) - Method in class org.springframework.ai.anthropic.CacheEligibilityResolver

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).

resolveCitationDocumentCacheControl() - Method in class org.springframework.ai.anthropic.CacheEligibilityResolver

Resolves the cache control for citation documents.

resolveCommonProperties(AbstractOpenAiProperties, AbstractOpenAiProperties) - Static method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAutoConfigurationUtil

ResolvedConnectionProperties() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiAutoConfigurationUtil.ResolvedConnectionProperties

resolveToolCacheControl() - Method in class org.springframework.ai.anthropic.CacheEligibilityResolver

resolveToolDefinitions(ToolCallingChatOptions) - Method in class org.springframework.ai.google.genai.schema.GoogleGenAiToolCallingManager

Resolves tool definitions and converts their input schemas to be compatible with Vertex AI's OpenAPI format.

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.

resolveToolParamDescription(MemberScope<?, ?>) - Method in class org.springframework.ai.mcp.annotation.method.tool.utils.McpSpringAiSchemaModule

resolveToolParamDescription(MemberScope<?, ?>) - Method in class org.springframework.ai.util.json.schema.AbstractSpringAiSchemaModule

Extract the description from the tool-param annotation for the given member, or return null if the annotation is absent or its description is blank.

resolveToolParamDescription(MemberScope<?, ?>) - Method in class org.springframework.ai.util.json.schema.SpringAiSchemaModule

resolveToolParamRequired(MemberScope<?, ?>) - Method in class org.springframework.ai.mcp.annotation.method.tool.utils.McpSpringAiSchemaModule

resolveToolParamRequired(MemberScope<?, ?>) - Method in class org.springframework.ai.util.json.schema.AbstractSpringAiSchemaModule

Extract the required flag from the tool-param annotation for the given member, or return null if the annotation is absent.

resolveToolParamRequired(MemberScope<?, ?>) - Method in class org.springframework.ai.util.json.schema.SpringAiSchemaModule

resolveTransportContext(McpTransportContext) - Method in class org.springframework.ai.mcp.annotation.method.tool.AsyncStatelessMcpToolMethodCallback

resolveTransportContext(McpTransportContext) - Method in class org.springframework.ai.mcp.annotation.method.tool.SyncStatelessMcpToolMethodCallback

resolveTransportContext(McpAsyncServerExchange) - Method in class org.springframework.ai.mcp.annotation.method.tool.AsyncMcpToolMethodCallback

resolveTransportContext(McpSyncServerExchange) - Method in class org.springframework.ai.mcp.annotation.method.tool.SyncMcpToolMethodCallback

resolveTransportContext(Object) - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback

Resolves the transport context from the exchange or context object.

resolveTransportContext(Object) - Method in class org.springframework.ai.mcp.annotation.method.complete.AsyncMcpCompleteMethodCallback

resolveTransportContext(Object) - Method in class org.springframework.ai.mcp.annotation.method.complete.AsyncStatelessMcpCompleteMethodCallback

resolveTransportContext(Object) - Method in class org.springframework.ai.mcp.annotation.method.complete.SyncMcpCompleteMethodCallback

resolveTransportContext(Object) - Method in class org.springframework.ai.mcp.annotation.method.complete.SyncStatelessMcpCompleteMethodCallback

resolveTransportContext(T) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractMcpToolMethodCallback

Resolves the McpTransportContext from the exchange or context object.

resource - Variable in class org.springframework.ai.chat.prompt.PromptTemplate.Builder

resource(McpSchema.Resource) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

Set the Mcp Schema resource.

resource(McpSchema.ResourceTemplate) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

Set the Mcp Schema resource template.

resource(Resource) - Method in class org.springframework.ai.chat.prompt.PromptTemplate.Builder

resource(Resource) - Method in class org.springframework.ai.chat.prompt.SystemPromptTemplate.Builder

ResourceAdapter - Class in org.springframework.ai.mcp.annotation.adapter

Utility class that converts McpResource annotations into MCP schema objects.

ResourceCacheService - Class in org.springframework.ai.transformers

Service that helps caching remote Resources on the local file system.

ResourceCacheService() - Constructor for class org.springframework.ai.transformers.ResourceCacheService

ResourceCacheService(File) - Constructor for class org.springframework.ai.transformers.ResourceCacheService

ResourceCacheService(String) - Constructor for class org.springframework.ai.transformers.ResourceCacheService

resourceFileName - Variable in class org.springframework.ai.reader.pdf.PagePdfDocumentReader

resourceFileName - Variable in class org.springframework.ai.reader.pdf.ParagraphPdfDocumentReader

resourceId() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ReaderResource

Returns the value of the resourceId record component.

resourceListChanged(McpResourceListChanged) - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback.AbstractBuilder

Set the resource list changed annotation.

resourceListChangedSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

resourceListChangedSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

resourceListChangeHandler() - Method in record class org.springframework.ai.mcp.annotation.method.changed.resource.AsyncResourceListChangedSpecification

Returns the value of the resourceListChangeHandler record component.

resourceListChangeHandler() - Method in record class org.springframework.ai.mcp.annotation.method.changed.resource.SyncResourceListChangedSpecification

Returns the value of the resourceListChangeHandler record component.

resourceSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

resourceSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

resourceTemplateSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

resourceTemplateSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

resourceType() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ReaderResource

Returns the value of the resourceType record component.

ResourceUtils - Class in org.springframework.ai.util

Miscellaneous Resource utility methods.

ResourceUtils() - Constructor for class org.springframework.ai.util.ResourceUtils

response() - Method in record class org.springframework.ai.chat.client.ResponseEntity

Returns the value of the response record component.

Response(double, double, double, double, int, int, MockWeatherService.Unit) - Constructor for record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Response

Creates an instance of a Response record class.

RESPONSE_DATA - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolResponseAttributes

Deprecated.

RESPONSE_EVENT_IDS_CONTEXT_KEY - Static variable in class org.springframework.ai.session.advisor.SessionMemoryAdvisor

Context key the advisor sets on the response: the ids of the events that store the reply's assistant messages, in reply order, a List<String>; empty when none was stored.

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_FINISH_REASONS - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

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_ID - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

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.

RESPONSE_MODEL - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

The name of the model that generated the response.

responseCandidateToGeneration(Candidate) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatModel

Converts a response candidate to a single generation whose message holds the Gemini parts, in order, as MessageParts: thought text as ReasoningPart, answer text as TextPart, function calls as ToolCallPart, inline data as MediaPart, and anything else (server-side tool calls and responses, executable code, code execution results, file data) as UnknownPart, kept verbatim for replay.

responseData() - Method in record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse

Returns the value of the responseData record component.

responseEntity(Class<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

Returns a ResponseEntity containing both the complete ChatResponse object and a specific entity type.

responseEntity(Class<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

responseEntity(Class<T>, Consumer<ChatClient.EntityParamSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

Returns a ResponseEntity containing both the complete ChatResponse object and a specific entity type, with behaviour configured via the entityParamSpecConsumer.

responseEntity(Class<T>, Consumer<ChatClient.EntityParamSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

responseEntity(StructuredOutputConverter<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

Returns a ResponseEntity containing both the complete ChatResponse object and an entity converted using a specified StructuredOutputConverter.

responseEntity(StructuredOutputConverter<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

responseEntity(StructuredOutputConverter<T>, Consumer<ChatClient.EntityParamSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

Returns a ResponseEntity containing both the complete ChatResponse object and an entity converted using a specified StructuredOutputConverter, with behaviour configured via the entityParamSpecConsumer.

responseEntity(StructuredOutputConverter<T>, Consumer<ChatClient.EntityParamSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

responseEntity(ParameterizedTypeReference<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

Returns a ResponseEntity containing both the complete ChatResponse object and a Collection of entity types.

responseEntity(ParameterizedTypeReference<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

responseEntity(ParameterizedTypeReference<T>, Consumer<ChatClient.EntityParamSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec

Returns a ResponseEntity containing both the complete ChatResponse object and a specific entity type, with behaviour configured via the entityParamSpecConsumer.

responseEntity(ParameterizedTypeReference<T>, Consumer<ChatClient.EntityParamSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

ResponseEntity<R,E> - Record Class in org.springframework.ai.chat.client

Represents a Model response that includes the entire response along with the specified response entity type.

ResponseEntity(R, E) - Constructor for record class org.springframework.ai.chat.client.ResponseEntity

Creates an instance of a ResponseEntity record class.

responseErrorHandler(SpringAiRetryProperties) - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryAutoConfiguration

responseErrorHandler(ResponseErrorHandler) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.Builder

responseErrorHandler(ResponseErrorHandler) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.Builder

responseErrorHandler(ResponseErrorHandler) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Builder

responseErrorHandler(ResponseErrorHandler) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.Builder

responseErrorHandler(ResponseErrorHandler) - Method in class org.springframework.ai.mistralai.api.MistralAiModerationApi.Builder

responseErrorHandler(ResponseErrorHandler) - Method in class org.springframework.ai.ollama.api.OllamaApi.Builder

responseFinishReasons(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention

responseFormat - Variable in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

responseFormat - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

responseFormat - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

responseFormat() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the responseFormat record component.

responseFormat() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the responseFormat record component.

responseFormat(AudioResponseFormat) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder

responseFormat(String) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder

responseFormat(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder

responseFormat(String) - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions.Builder

responseFormat(ResponseFormat) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set the response format.

responseFormat(ResponseFormat) - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

responseFormat(MistralAiApi.ChatCompletionRequest.ResponseFormat) - Method in class org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder

responseFormat(OpenAiAudioSpeechOptions.AudioResponseFormat) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder

responseFormat(OpenAiChatModel.ResponseFormat) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

responseFormat(OpenAiChatModel.ResponseFormat) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

responseFormat(String) - Method in class org.springframework.ai.image.ImageOptionsBuilder

ResponseFormat - Class in org.springframework.ai.deepseek.api

An object specifying the format that the model must output.

ResponseFormat() - Constructor for class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

ResponseFormat() - Constructor for class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat

ResponseFormat(String) - Constructor for class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

Deprecated.

Use MistralAiApi.ChatCompletionRequest.ResponseFormat.builder() or factory methods instead.

ResponseFormat(String, Map<String, Object>) - Constructor for class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

Deprecated.

Use MistralAiApi.ChatCompletionRequest.ResponseFormat.builder() or factory methods instead.

ResponseFormat(MistralAiApi.ChatCompletionRequest.ResponseFormat.Type, String) - Constructor for class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

ResponseFormat.Builder - Class in org.springframework.ai.deepseek.api

ResponseFormat.Type - Enum Class in org.springframework.ai.deepseek.api

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.

responseMimeType - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

responseMimeType(String) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

responseMimeType(String) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

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

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0 in favor of ToolResponseMessage.getResponses(); kept so existing subclasses that read the field keep compiling. Will be removed in a future release.

responses(List<ToolResponseMessage.ToolResponse>) - Method in class org.springframework.ai.chat.messages.ToolResponseMessage.Builder

RESPONSES - Enum constant in enum class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Api

/v1/responses, served by OpenAiResponsesChatModel.

responseSchema - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

responseSchema(String) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

ResponseTextCleaner - Interface in org.springframework.ai.converter

Strategy interface for cleaning LLM response text before parsing.

responseToString(Function<ChatResponse, String>) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor.Builder

responseType() - Method in record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingResponse

Returns the value of the responseType record component.

restClientBuilder(RestClient.Builder) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi.Builder

restClientBuilder(RestClient.Builder) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.Builder

restClientBuilder(RestClient.Builder) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.Builder

restClientBuilder(RestClient.Builder) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Builder

restClientBuilder(RestClient.Builder) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.Builder

restClientBuilder(RestClient.Builder) - Method in class org.springframework.ai.mistralai.api.MistralAiModerationApi.Builder

restClientBuilder(RestClient.Builder) - Method in class org.springframework.ai.ollama.api.OllamaApi.Builder

result() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageResponse

Returns the value of the result record component.

result(ToolResultPart) - Method in class org.springframework.ai.chat.messages.ToolResponseMessage.Builder

Adds a tool result.

resultConverter - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

resultConverter - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

resultConverter() - Element in annotation interface org.springframework.ai.tool.annotation.Tool

The class to use to convert the tool call result to a String.

resultConverter(McpReadResourceResultConverter) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

Set the result converter.

ResultMetadata - Interface in org.springframework.ai.model

Interface representing metadata associated with the results of an AI model.

results() - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingResponse

Returns the value of the results record component.

results() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationResponse

Returns the value of the results record component.

results(List<ToolResultPart>) - Method in class org.springframework.ai.chat.messages.ToolResponseMessage.Builder

Adds tool results, in order.

results(List<ModerationResult>) - Method in class org.springframework.ai.moderation.Moderation.Builder

resumableStreams(boolean) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebClientStreamableHttpTransport.Builder

Configure whether to use the stream resumability feature by keeping track of SSE event ids.

rethrowExceptions(List<Class<? extends RuntimeException>>) - 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.

RETRIEVAL_DOCUMENT - Enum constant in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.TaskType

Specifies the given text is a document in a search/retrieval setting.

RETRIEVAL_DOCUMENT - Enum constant in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.TaskType

Specifies the given text is a query in a search/retrieval setting.

RETRIEVAL_QUERY - Enum constant in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.TaskType

Specifies the given text is a query in a search/retrieval setting.

RETRIEVAL_QUERY - Enum constant in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.TaskType

Specifies the given text is a document in a search/retrieval setting.

RetrievalAugmentationAdvisor - Class in org.springframework.ai.rag.advisor

Advisor that implements common Retrieval Augmented Generation (RAG) flows using the building blocks defined in the org.springframework.ai.rag package and following the Modular RAG Architecture.

RetrievalAugmentationAdvisor.Builder - Class in org.springframework.ai.rag.advisor

retrieve(Query) - Method in interface org.springframework.ai.rag.retrieval.search.DocumentRetriever

Retrieves relevant documents from an underlying data source based on the given query.

retrieve(Query) - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever

RETRIEVED_DOCUMENTS - Static variable in class org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor

retryIdempotent() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

retryTemplate - Variable in class org.springframework.ai.deepseek.DeepSeekChatModel

The retry template used to retry the DeepSeek API calls.

retryTemplate(SpringAiRetryProperties) - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryAutoConfiguration

retryTemplate(RetryTemplate) - Method in class org.springframework.ai.deepseek.DeepSeekChatModel.Builder

retryTemplate(RetryTemplate) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel.Builder

retryTemplate(RetryTemplate) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatModel.Builder

retryTemplate(RetryTemplate) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionModel.Builder

Sets the retry template.

retryTemplate(RetryTemplate) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechModel.Builder

retryTemplate(RetryTemplate) - Method in class org.springframework.ai.mistralai.MistralAiChatModel.Builder

retryTemplate(RetryTemplate) - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingModel.Builder

retryTemplate(RetryTemplate) - Method in class org.springframework.ai.mistralai.moderation.MistralAiModerationModel.Builder

retryTemplate(RetryTemplate) - Method in class org.springframework.ai.ollama.OllamaChatModel.Builder

RetryUtils - Class in org.springframework.ai.retry

RetryUtils is a utility class for configuring and handling retry operations.

RetryUtils() - Constructor for class org.springframework.ai.retry.RetryUtils

RETURN_ERROR_RESPONSE - Enum constant in enum class org.springframework.ai.model.tool.ToolCallLimitBehavior

Skip invoking the tool callback and instead return a ToolResponseMessage.ToolResponse explaining that the limit was reached, letting the model see the rejection and decide how to proceed.

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

returnMode - Variable in class org.springframework.ai.mcp.annotation.method.tool.AbstractMcpToolMethodCallback

ReturnMode - Enum Class in org.springframework.ai.mcp.annotation.method.tool

reversedParagraphPosition - Variable in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig

reviewMessage() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the reviewMessage record component.

reviewStatus() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the reviewStatus record component.

RewriteQueryTransformer - Class in org.springframework.ai.rag.preretrieval.query.transformation

Uses a large language model to rewrite a user query to provide better results when querying a target system, such as a vector store or a web search engine.

RewriteQueryTransformer(ChatClient.Builder, PromptTemplate, String) - Constructor for class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer

RewriteQueryTransformer.Builder - Class in org.springframework.ai.rag.preretrieval.query.transformation

right - Variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.AndExpressionContext

right - Variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.OrExpressionContext

right() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Expression

Returns the value of the right record component.

RIGHT_PARENTHESIS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

RIGHT_PARENTHESIS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

RIGHT_PARENTHESIS() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.GroupExpressionContext

RIGHT_SQUARE_BRACKETS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

RIGHT_SQUARE_BRACKETS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

RIGHT_SQUARE_BRACKETS() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.ConstantArrayContext

role() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage

Returns the value of the role record component.

role() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Returns the value of the role record component.

role() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message

Returns the value of the role record component.

roots() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

roots() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

roots() - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

roots() - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

rootsEnabled() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

rootsEnabled() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

rootsEnabled() - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

rootsEnabled() - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

rule() - Method in record class org.springframework.ai.session.compaction.CompactionWindow

Returns the value of the rule record component.

RULE_booleanExpression - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

RULE_compare - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

RULE_constant - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

RULE_constantArray - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

RULE_identifier - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

RULE_where - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

ruleNames - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

ruleNames - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

S

S3 - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

S3_VECTOR - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by simple.

S3VectorFilterExpressionConverter - Interface in org.springframework.ai.vectorstore.s3

FilterExpression DLS converter specific for AWS S3 Vector Store since SDK required AWS Document object.

S3VectorFilterSearchExpressionConverter - Class in org.springframework.ai.vectorstore.s3

Default implementation of S3VectorFilterExpressionConverter

S3VectorFilterSearchExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.s3.S3VectorFilterSearchExpressionConverter

S3VectorStore - Class in org.springframework.ai.vectorstore.s3

S3VectorStore(S3VectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.s3.S3VectorStore

Creates a new S3VectorStore instance with the specified builder settings.

S3VectorStore.Builder - Class in org.springframework.ai.vectorstore.s3

S3VectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.s3.autoconfigure

Auto-configuration for S3 Vector Store.

S3VectorStoreProperties - Class in org.springframework.ai.vectorstore.s3.autoconfigure

S3VectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.s3.autoconfigure.S3VectorStoreProperties

SafeGuardAdvisor - Class in org.springframework.ai.chat.client.advisor

An advisor that blocks the call to the model provider if the user input contains any of the sensitive words.

SafeGuardAdvisor(List<String>) - Constructor for class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor

SafeGuardAdvisor(List<String>, String, int) - Constructor for class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor

SafeGuardAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor

safePrompt() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the safePrompt record component.

safePrompt(Boolean) - Method in class org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder

SAFETY_FILTER_LEVEL_UNSPECIFIED - Enum constant in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.SafetyFilterLevel

safetyControl() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the safetyControl record component.

safetyFilterLevel(GoogleGenAiImageOptions.SafetyFilterLevel) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

safetyIdentifier - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

safetyIdentifier(String) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

safetySettings - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

safetySettings(List<GoogleGenAiSafetySetting>) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

SAGE - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Voice

SAGE - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.Voice

sample(McpSchema.CreateMessageRequest) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

sample(McpSchema.CreateMessageRequest) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

sample(McpSchema.CreateMessageRequest) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

sample(McpSchema.CreateMessageRequest) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

sample(String...) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

sample(String...) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

sample(String...) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

sample(String...) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

sample(Consumer<McpRequestContextTypes.SamplingSpec>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

sample(Consumer<McpRequestContextTypes.SamplingSpec>) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

sample(Consumer<McpRequestContextTypes.SamplingSpec>) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

sample(Consumer<McpRequestContextTypes.SamplingSpec>) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

Sample(String, String, String, Integer, String) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Sample

Creates an instance of a Sample record class.

sampleChecks() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharingModerationCheck

Returns the value of the sampleChecks record component.

sampleEnabled() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

sampleEnabled() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

sampleEnabled() - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

sampleEnabled() - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

sampleId() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Sample

Returns the value of the sampleId record component.

sampleIds() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharingModerationCheck

Returns the value of the sampleIds record component.

sampler() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

Returns the value of the sampler record component.

sampler(String) - Method in class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.Builder

sampler(String) - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions.Builder

samples() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the samples record component.

samples() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

Returns the value of the samples record component.

samples(Integer) - Method in class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.Builder

sampling(McpSampling) - Method in class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback.AbstractBuilder

Set the sampling annotation.

samplingHandler() - Method in record class org.springframework.ai.mcp.annotation.method.sampling.AsyncSamplingSpecification

Returns the value of the samplingHandler record component.

samplingHandler() - Method in record class org.springframework.ai.mcp.annotation.method.sampling.SyncSamplingSpecification

Returns the value of the samplingHandler record component.

samplingSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

samplingSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

save(File) - Method in class org.springframework.ai.vectorstore.SimpleVectorStore

Serialize the vector store content into a file in JSON format.

save(Session) - Method in class org.springframework.ai.session.InMemorySessionRepository

save(Session) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository

save(Session) - Method in interface org.springframework.ai.session.SessionRepository

Persists session metadata (create or update).

saveAll(String, List<Message>) - Method in interface org.springframework.ai.chat.memory.ChatMemoryRepository

Deprecated.

Replaces all the existing messages for the given conversation ID with the provided messages.

saveAll(String, List<Message>) - Method in class org.springframework.ai.chat.memory.InMemoryChatMemoryRepository

Deprecated.

saveAll(String, List<Message>) - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepository

Deprecated.

saveAll(String, List<Message>) - Method in class org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepository

Deprecated.

saveAll(String, List<Message>) - Method in class org.springframework.ai.chat.memory.repository.mongo.MongoChatMemoryRepository

Deprecated.

saveAll(String, List<Message>) - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepository

Deprecated.

saveAll(String, List<Message>) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository

Deprecated.

saveIfAbsent(Session) - Method in class org.springframework.ai.session.InMemorySessionRepository

saveIfAbsent(Session) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository

saveIfAbsent(Session) - Method in interface org.springframework.ai.session.SessionRepository

Inserts the session unless one with the same id exists, atomically: a primary-key-guarded INSERT, or a compare-and-set put.

scan(Class<?>) - Method in class org.springframework.ai.mcp.annotation.spring.ClientMcpSyncHandlersRegistry

scan(Class<?>) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.annotations.McpClientAnnotationScannerAutoConfiguration.ClientAnnotatedBeanFactoryInitializationAotProcessor

SCANN - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

scheduler(Scheduler) - Method in class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor.Builder

Sets the scheduler for async operations.

scheduler(Scheduler) - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor.Builder

Deprecated.

scheduler(Scheduler) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor.Builder

scheduler(Scheduler) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor.Builder

scheduler(Scheduler) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder

scheduler(Scheduler) - Method in class org.springframework.ai.session.advisor.SessionAdvisors.Builder

The scheduler the session writes of a streamed call run on.

scheduler(Scheduler) - Method in class org.springframework.ai.session.advisor.SessionMemoryAdvisor.Builder

scheduler(Scheduler) - Method in class org.springframework.ai.session.advisor.SessionTurnAdvisor.Builder

The scheduler the session writes of a streamed call run on.

schema(String) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema.Builder

schema(Map<String, Object>) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema.Builder

SchemaColumn(String, DataType) - Constructor for record class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.SchemaColumn

Deprecated.

Creates an instance of a SchemaColumn record class.

SchemaColumn(String, DataType) - Constructor for record class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.SchemaColumn

SchemaColumn(String, DataType, CassandraVectorStore.SchemaColumnTags...) - Constructor for record class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.SchemaColumn

Creates an instance of a SchemaColumn record class.

schemaName(String) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBBuilder

Configures the schema name for the vector store table.

schemaName(String) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgVectorStoreBuilder

SchemaType - Enum Class in org.springframework.ai.util.json.schema

The type of schema to generate for a given Java type.

SchemaUtil - Class in org.springframework.ai.chat.memory.repository.cassandra

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory: org.springframework.ai.session.SessionRepository in spring-ai-session, with a JDBC store in spring-ai-session-jdbc. There is no session store for Cassandra yet; one is planned before 3.0.0, when this module is removed.

SchemaUtil - Class in org.springframework.ai.vectorstore.cassandra

Utility class for working with Cassandra schema.

schemaValidation(boolean) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBBuilder

Configures whether schema validation should be performed.

scopeName(String) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.Builder

Configures the Couchbase scope, parent of the selected collection.

score(Double) - Method in class org.springframework.ai.document.Document.Builder

Sets a score value for this document.

SCORE_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

search(ToolSearchRequest) - Method in class org.springframework.ai.tool.toolsearch.index.lucene.LuceneToolIndex

search(ToolSearchRequest) - Method in class org.springframework.ai.tool.toolsearch.index.regex.RegexToolIndex

search(ToolSearchRequest) - Method in class org.springframework.ai.tool.toolsearch.index.vectorstore.VectorToolIndex

search(ToolSearchRequest) - Method in interface org.springframework.ai.tool.toolsearch.ToolIndex

Searches for tools matching the given request criteria.

SEARCH_DOCUMENT - Enum constant in enum class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType

In search use-cases, use search_document when you encode documents for embeddings that you store in a vector database.

SEARCH_QUERY - Enum constant in enum class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType

Use search_query when querying your vector DB to find relevant documents.

searchAccuracy(int) - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore.Builder

Sets the search accuracy parameter.

searchByRange(String) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

Search for documents within a specific radius (distance) from the query embedding.

searchByRange(String, double) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

Search for documents within a specific radius (distance) from the query embedding.

searchByRange(String, double, String) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

Search for documents within a specific radius (distance) from the query embedding, with optional filter expression to narrow down results.

searchByRange(String, String) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

Search for documents within a specific radius (distance) from the query embedding, with optional filter expression to narrow down results.

searchByText(String, String) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

Search for documents matching a text query.

searchByText(String, String, int) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

Search for documents matching a text query.

searchByText(String, String, int, String) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

Search for documents matching a text query with optional filter expression.

searchContextSize() - Method in record class org.springframework.ai.openai.responses.HostedTool.WebSearch

Returns the value of the searchContextSize record component.

searchIndexClient(AzureVectorStoreProperties) - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreAutoConfiguration

searchMetadata() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchResponse

Returns the value of the searchMetadata record component.

searchMetadata(ToolSearchResponse.SearchMetadata) - Method in class org.springframework.ai.tool.toolsearch.ToolSearchResponse.Builder

SearchMetadata(String, String, Long) - Constructor for record class org.springframework.ai.tool.toolsearch.ToolSearchResponse.SearchMetadata

Creates an instance of a SearchMetadata record class.

searchParamsJson(String) - Method in class org.springframework.ai.vectorstore.milvus.MilvusSearchRequest.MilvusBuilder

Sets the JSON-encoded search parameters.

searchRequest(SearchRequest) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor.Builder

SearchRequest - Class in org.springframework.ai.vectorstore

Similarity search request.

SearchRequest() - Constructor for class org.springframework.ai.vectorstore.SearchRequest

SearchRequest(SearchRequest) - Constructor for class org.springframework.ai.vectorstore.SearchRequest

SearchRequest.Builder - Class in org.springframework.ai.vectorstore

SearchRequest Builder.

searchTimeMs() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchResponse.SearchMetadata

Returns the value of the searchTimeMs record component.

searchTimeMs(Long) - Method in class org.springframework.ai.tool.toolsearch.ToolSearchResponse.SearchMetadata.Builder

searchType() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchResponse.SearchMetadata

Returns the value of the searchType record component.

searchType(SearchType) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore.Builder

Sets the search type to use for queries.

searchType(String) - Method in class org.springframework.ai.tool.toolsearch.ToolSearchResponse.SearchMetadata.Builder

searchWithQueryEmbeddingAppliesFilter() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

searchWithQueryEmbeddingAppliesSimilarityThreshold() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

searchWithQueryEmbeddingRanksNearestFirst() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

searchWithQueryEmbeddingWithoutEmbeddingModel() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

secure - Variable in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

Secure the authorization for this connection, set to True to enable TLS.

securityValidator(ServerTransportSecurityValidator) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider.Builder

Deprecated.

Sets the security validator for validating HTTP requests.

securityValidator(ServerTransportSecurityValidator) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStatelessServerTransport.Builder

Sets the security validator for validating HTTP requests.

securityValidator(ServerTransportSecurityValidator) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider.Builder

Sets the security validator for validating HTTP requests.

securityValidator(ServerTransportSecurityValidator) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider.Builder

Deprecated.

Sets the security validator for validating HTTP requests.

securityValidator(ServerTransportSecurityValidator) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStatelessServerTransport.Builder

Sets the security validator for validating HTTP requests.

securityValidator(ServerTransportSecurityValidator) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider.Builder

Sets the security validator for validating HTTP requests.

seed - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

seed - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

seed() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Returns the value of the seed record component.

seed() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

Returns the value of the seed record component.

seed() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageResponse.Artifacts

Returns the value of the seed record component.

seed(Integer) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.Builder

seed(Integer) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

seed(Integer) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

seed(Integer) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

seed(Integer) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

seed(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

seed(Long) - Method in class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.Builder

seed(Long) - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions.Builder

select(Class<P>) - Method in class org.springframework.ai.chat.messages.AbstractMessage

selector - Variable in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig

selector(String) - Method in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig.Builder

Sets the CSS selector to use for extracting elements.

self() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder

Returns this builder cast to the appropriate type for method chaining.

self() - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder

self() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

self() - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

self() - Method in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder

Returns this builder cast to the concrete builder type.

selfHarm() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Returns the value of the selfHarm record component.

selfHarm() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Returns the value of the selfHarm record component.

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

SEMANTIC_SIMILARITY - Enum constant in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.TaskType

Specifies the given text will be used for semantic textual similarity (STS).

SEMANTIC_SIMILARITY - Enum constant in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.TaskType

Specifies the given text will be used for semantic textual similarity (STS).

semanticCache(RedisClient, EmbeddingModel, RedisSemanticCacheProperties) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure.RedisSemanticCacheAutoConfiguration

Creates the semantic cache instance.

SemanticCache - Interface in org.springframework.ai.chat.cache.semantic

Interface defining operations for a semantic cache implementation that stores and retrieves chat responses based on semantic similarity of queries.

semanticCacheAdvisor(SemanticCache) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure.RedisSemanticCacheAutoConfiguration

Creates the semantic cache advisor for ChatClient integration.

SemanticCacheAdvisor - Class in org.springframework.ai.chat.cache.semantic

An advisor implementation that provides semantic caching capabilities for chat responses.

SemanticCacheAdvisor(SemanticCache) - Constructor for class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor

Creates a new semantic cache advisor with default order and scheduler.

SemanticCacheAdvisor(SemanticCache, int) - Constructor for class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor

Creates a new semantic cache advisor with specified order and default scheduler.

SemanticCacheAdvisor(SemanticCache, int, Scheduler) - Constructor for class org.springframework.ai.chat.cache.semantic.SemanticCacheAdvisor

Creates a new semantic cache advisor with specified order and scheduler.

SemanticCacheAdvisor.Builder - Class in org.springframework.ai.chat.cache.semantic

Builder class for creating SemanticCacheAdvisor instances.

semanticCacheEmbeddingModel() - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure.RedisSemanticCacheAutoConfiguration

Provides a default EmbeddingModel using the redis/langcache-embed-v1 model.

sempred(RuleContext, int, int) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

sendMessage(McpSchema.JSONRPCMessage) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebClientStreamableHttpTransport

sendMessage(McpSchema.JSONRPCMessage) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport

Deprecated.

Sends a JSON-RPC message to the server using the endpoint provided during connection.

sensitiveWords(List<String>) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor.Builder

separator - Variable in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig

separator(String) - Method in class org.springframework.ai.reader.jsoup.config.JsoupDocumentReaderConfig.Builder

Sets the separator string to use when joining text from multiple elements.

SERIAL - Enum constant in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgIdType

serialize(Object, JsonGenerator, SerializationContext) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ContentSerializer

serialize(ThinkOption, JsonGenerator, SerializationContext) - Method in class org.springframework.ai.ollama.api.ThinkOption.ThinkOptionSerializer

serverAnnotatedBeanFactoryInitializationAotProcessor() - Static method in class org.springframework.ai.mcp.server.common.autoconfigure.annotations.McpServerAnnotationScannerAutoConfiguration

ServerAnnotatedBeanFactoryInitializationAotProcessor(Set<Class<? extends Annotation>>) - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.annotations.McpServerAnnotationScannerAutoConfiguration.ServerAnnotatedBeanFactoryInitializationAotProcessor

serverAnnotatedBeanRegistry() - Method in class org.springframework.ai.mcp.server.common.autoconfigure.annotations.McpServerAnnotationScannerAutoConfiguration

serverAnnotatedMethodBeanPostProcessor(McpServerAnnotationScannerAutoConfiguration.ServerMcpAnnotatedBeans, McpServerAnnotationScannerProperties) - Static method in class org.springframework.ai.mcp.server.common.autoconfigure.annotations.McpServerAnnotationScannerAutoConfiguration

ServerAnnotatedMethodBeanPostProcessor(McpServerAnnotationScannerAutoConfiguration.ServerMcpAnnotatedBeans, Set<Class<? extends Annotation>>) - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.annotations.McpServerAnnotationScannerAutoConfiguration.ServerAnnotatedMethodBeanPostProcessor

serverLabel() - Method in record class org.springframework.ai.openai.responses.HostedTool.Mcp

Returns the value of the serverLabel record component.

ServerMcpAnnotatedBeans() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.annotations.McpServerAnnotationScannerAutoConfiguration.ServerMcpAnnotatedBeans

serverUrl() - Method in record class org.springframework.ai.openai.responses.HostedTool.Mcp

Returns the value of the serverUrl record component.

serviceTier - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

serviceTier - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

serviceTier - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

serviceTier() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk

Returns the value of the serviceTier record component.

serviceTier(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

serviceTier(String) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

serviceTier(AnthropicServiceTier) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

Sets the service tier for capacity routing.

serviceTier(GoogleGenAiServiceTier) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

session() - Method in record class org.springframework.ai.session.compaction.CompactionRequest

Returns the value of the session record component.

session() - Method in record class org.springframework.ai.session.compaction.SummaryRequest

Returns the value of the session record component.

session(CqlSession) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

Sets the CQL session.

session(String) - Static method in class org.springframework.ai.session.advisor.SessionAdvisors

The request runs on the session: .advisors(SessionAdvisors.session(sessionId)).

Session - Class in org.springframework.ai.session

One continuous conversation between a user and an agent: its identity, its expiry and its metadata.

SESSION_ID - Static variable in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider

Deprecated.

SESSION_ID - Static variable in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider

Deprecated.

SESSION_ID_CONTEXT_KEY - Static variable in class org.springframework.ai.session.advisor.SessionMemoryAdvisor

Context key of the session a request runs on; MemoryAdvisor.CONVERSATION_ID, the conversation key of every memory advisor.

SESSION_METADATA_CONTEXT_KEY - Static variable in class org.springframework.ai.session.advisor.SessionMemoryAdvisor

Context key for the metadata of a session the advisor creates on first use.

Session.Builder - Class in org.springframework.ai.session

SessionAdvisors - Class in org.springframework.ai.session.advisor

The session advisors of a ChatClient, configured together: the SessionTurnAdvisor (the session, compaction) and the SessionMemoryAdvisor (the history, the messages), each at its default order around the tool-calling loop the ChatClient registers itself:

SessionAdvisors.Builder - Class in org.springframework.ai.session.advisor

SessionAlreadyExistsException - Exception in org.springframework.ai.session

Thrown by SessionService.create(org.springframework.ai.session.CreateSessionRequest) when a session with the requested id exists; the existing session is left untouched.

SessionAlreadyExistsException(String) - Constructor for exception org.springframework.ai.session.SessionAlreadyExistsException

SessionAttributes - Class in org.springframework.ai.session

The well-known metadata attributes of a Session, and the accessors that read them.

sessionConfig(SessionConfig) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Builder

Sets the session configuration directly.

SessionEvent - Class in org.springframework.ai.session

An entry of a session's log.

SessionEvent.Builder - Class in org.springframework.ai.session

Builds a SessionEvent.

SessionEventCodec - Class in org.springframework.ai.session.support

Encodes a SessionEvent into its persisted shape, an SessionEventCodec.EncodedEvent, and back.

SessionEventCodec() - Constructor for class org.springframework.ai.session.support.SessionEventCodec

Creates a codec with a default JsonMapper.

SessionEventCodec(JsonMapper) - Constructor for class org.springframework.ai.session.support.SessionEventCodec

Creates a codec that serializes with the given mapper.

SessionEventCodec.EncodedEvent - Record Class in org.springframework.ai.session.support

The persisted shape of an event.

SessionEventCodec.MessageBody - Record Class in org.springframework.ai.session.support

The JSON payload of an event that carries a message.

sessionId() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

sessionId() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

sessionId() - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes

sessionId() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchRequest

Returns the value of the sessionId record component.

sessionId(String) - Method in class org.springframework.ai.session.SessionEvent.Builder

The session the event belongs to; required.

sessionIdKeyName(String) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor.Builder

Sets the key name in the context where the conversation ID is stored.

sessionIdleTimeout(Duration) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider.Builder

Sets the idle timeout after which sessions with no client activity are evicted and closed.

sessionIdleTimeout(Duration) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider.Builder

Sets the idle timeout after which sessions with no client activity are evicted and closed.

SessionMemoryAdvisor - Class in org.springframework.ai.session.advisor

Keeps a ChatClient conversation in a session, on each model call: Reads the session's active view and prepends it to the prompt.

SessionMemoryAdvisor.Builder - Class in org.springframework.ai.session.advisor

sessionRepository(SessionRepository) - Method in class org.springframework.ai.session.DefaultSessionService.Builder

The store; required.

SessionRepository - Interface in org.springframework.ai.session

The store of sessions and their logs.

SessionService - Interface in org.springframework.ai.session

The sessions of an application and their conversations: creating and finding sessions, appending and reading their events, compacting them.

SessionServiceAutoConfiguration - Class in org.springframework.ai.model.session.autoconfigure

Auto-configuration of the SessionService: a DefaultSessionService on the single SessionRepository bean, whatever its implementation, wrapped by every SessionServiceDecorator bean in order.

SessionServiceAutoConfiguration() - Constructor for class org.springframework.ai.model.session.autoconfigure.SessionServiceAutoConfiguration

SessionServiceDecorator - Interface in org.springframework.ai.model.session.autoconfigure

Wraps the auto-configured SessionService in another one.

SessionServiceProperties - Class in org.springframework.ai.model.session.autoconfigure

The properties of the auto-configured SessionService, under spring.ai.session.

SessionServiceProperties() - Constructor for class org.springframework.ai.model.session.autoconfigure.SessionServiceProperties

SessionTurnAdvisor - Class in org.springframework.ai.session.advisor

Runs each ChatClient call as one turn of the session.

SessionTurnAdvisor.Builder - Class in org.springframework.ai.session.advisor

set(String, ChatResponse) - Method in interface org.springframework.ai.chat.cache.semantic.SemanticCache

Stores a query and its corresponding chat response in the cache.

set(String, ChatResponse) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache

set(String, ChatResponse, String) - Method in interface org.springframework.ai.chat.cache.semantic.SemanticCache

Stores a query and its corresponding chat response in the cache with an optional context identifier for isolation.

set(String, ChatResponse, String) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache

set(String, ChatResponse, Duration) - Method in interface org.springframework.ai.chat.cache.semantic.SemanticCache

Stores a query and response in the cache with a specified time-to-live duration.

set(String, ChatResponse, Duration) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache

setAccessKey(String) - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

setAdditionalModels(List<String>) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties.ModelTypeInit

setAdvisorOrder(int) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

setAdvisorOrder(int) - Method in class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties.ToolCalling

setAllowedDomains(List<String>) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool

setAllowedDomains(List<String>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.WebSearch

setAllowedFunctionNames(List<String>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.ToolChoiceProperties

setAllowedIdentifierNames(List<String>) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateFilterExpressionConverter

setAllowSystemMessages(boolean) - Method in class org.springframework.ai.model.session.autoconfigure.SessionServiceProperties

setApi(OpenAiChatProperties.Api) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setApiEndpoint(String) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiEmbeddingConnectionProperties

setApiKey(String) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicConnectionProperties

setApiKey(String) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekParentProperties

setApiKey(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsConnectionProperties

setApiKey(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiConnectionProperties

setApiKey(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiEmbeddingConnectionProperties

setApiKey(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageConnectionProperties

setApiKey(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionConnectionProperties

setApiKey(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechConnectionProperties

setApiKey(String) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiParentProperties

setApiKey(String) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

setApiKey(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setApiKey(String) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

setApiKey(String) - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

setApiKey(String) - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

setApiKey(String) - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

setApiKey(String) - Method in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseServiceClientProperties

setApiKey(String) - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

setApplyLanguageTextNormalization(Boolean) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setApplyLanguageTextNormalization(Boolean) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setApplyTextNormalization(ElevenLabsApi.SpeechRequest.TextNormalizationMode) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setApplyTextNormalization(ElevenLabsApi.SpeechRequest.TextNormalizationMode) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setAspectRatio(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

setAsyncReadTimeout(Duration) - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

setAudioEncoding(GoogleGenAiAudioSpeechOptions.AudioEncoding) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

setAudioEncoding(GoogleGenAiAudioSpeechOptions.AudioEncoding) - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

setAutoCacheThreshold(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setAutoCacheThreshold(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setAutoCacheTtl(Duration) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setAutoCacheTtl(Duration) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setAutoId(boolean) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

setAws(OpenSearchVectorStoreProperties.Aws) - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

setB64Json(String) - Method in class org.springframework.ai.image.Image

setBaseUrl(String) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicConnectionProperties

setBaseUrl(String) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekParentProperties

setBaseUrl(String) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiParentProperties

setBaseUrl(String) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

setBaseUrl(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setBaseUrl(String) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

setBaseUrl(String) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerSseProperties

Deprecated.

setBaseUrl(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsConnectionProperties

setBaseUrl(String) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaConnectionProperties

setBeamWidth(int) - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

setBetaPrefixPath(String) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setBlockedDomains(List<String>) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool

setBucketName(String) - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

setBuckets(int) - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

setCachedContentName(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setCachedContentName(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setCacheOptions(AnthropicCacheProperties) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setCacheOptions(AnthropicCacheProperties) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setCacheOptions(BedrockCacheProperties) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

setCacheOptions(BedrockCacheProperties) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

setCacheToolResults(boolean) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockCacheProperties

setCandidateCount(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setCandidateCount(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setCandidateCount(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

setCaPemPath(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setCategories(Categories) - Method in class org.springframework.ai.moderation.ModerationResult

setCategory(GoogleGenAiSafetySetting.HarmCategory) - Method in class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting

setCategoryScores(CategoryScores) - Method in class org.springframework.ai.moderation.ModerationResult

setCfgScale(Float) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

setCfgScale(Float) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

setCharset(Charset) - Method in class org.springframework.ai.reader.TextReader

setChatClientResponse(ChatClientResponse) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext

setChunkingStrategy(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

setClientKeyPath(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setClientPemPath(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setClipGuidancePreset(String) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

setClipGuidancePreset(String) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

setCodeInterpreter(OpenAiResponsesChatProperties.HostedTools.CodeInterpreter) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools

setCollectionName(String) - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

setCollectionName(String) - Method in class org.springframework.ai.vectorstore.mongodb.autoconfigure.MongoDBAtlasVectorStoreProperties

setCollectionName(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

setCollectionName(String) - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaVectorStoreProperties

setCollectionName(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

setCollectionName(String) - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

setCollectionName(String) - Method in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseVectorStoreProperties

setCompletion(boolean) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.Capabilities

setCompletionsPath(String) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setConfigurationPath(String) - Method in class org.springframework.ai.model.bedrock.autoconfigure.ProfileProperties

setConnectionAcquisitionTimeout(Duration) - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

setConnectionPoolMetricsEnabled(boolean) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setConnectionPoolMetricsEnabled(boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

setConnectionTimeout(Duration) - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

setConnectionTimeout(Duration) - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

setConnectTimeoutMs(long) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setConsistencyLevel(WeaviateVectorStore.ConsistentLevel) - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

setConstraintName(String) - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

setContainerId(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.CodeInterpreter

setContentColumnName(String) - Method in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreProperties

setContentFieldName(String) - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

setContentFieldName(String) - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

setContentFieldName(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

setContentFieldName(String) - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

setContentFieldName(String) - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

setContentFieldName(String) - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

setContentFieldName(String) - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

setContentFieldName(String) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStoreOptions

setContentFormatter(ContentFormatter) - Method in class org.springframework.ai.document.Document

Replace the document's ContentFormatter.

setContext(ContextView) - Static method in class org.springframework.ai.model.tool.internal.ToolCallReactiveContextHolder

setCopyContentFormatter(boolean) - Method in class org.springframework.ai.transformer.splitter.TextSplitter

setCreateExtension(boolean) - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

setCreateIndices(boolean) - Method in class org.springframework.ai.model.chat.memory.repository.mongo.autoconfigure.MongoChatMemoryProperties

Deprecated.

setCredential(Credential) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

setCredential(Credential) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setCredentialsPath(String) - Method in class org.springframework.ai.model.bedrock.autoconfigure.ProfileProperties

setCredentialsUri(Resource) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiConnectionProperties

setCredentialsUri(Resource) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiEmbeddingConnectionProperties

setCredentialsUri(Resource) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageConnectionProperties

setCredentialsUri(Resource) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionConnectionProperties

setCredentialsUri(Resource) - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechConnectionProperties

setCredentialsUri(Resource) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiEmbeddingConnectionProperties

setCustomHeaders(Map<String, String>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setCustomHeaders(Map<String, String>) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicConnectionProperties

setCustomHeaders(Map<String, String>) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

setDatabaseName(String) - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

setDatabaseName(String) - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaVectorStoreProperties

setDatabaseName(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

setDefaultSimilarityThreshold(double) - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

setDefaultTopK(int) - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

setDeploymentName(String) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

Alias for setAzureDeploymentName()

setDeploymentName(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setDescription(String) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool.Function

setDiarizedJsonWorkaroundEnabled(Boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

setDimensions(int) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStoreOptions

setDimensions(int) - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

setDimensions(int) - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

setDimensions(int) - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

setDimensions(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties.Options

setDimensions(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties

setDimensions(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties.Options

setDimensions(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

setDimensions(Integer) - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

setDimensions(Integer) - Method in class org.springframework.ai.vectorstore.elasticsearch.autoconfigure.ElasticsearchVectorStoreProperties

setDimensions(Integer) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

setDimensions(Integer) - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

setDimensions(Integer) - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

setDimensions(Integer) - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties

Sets the vector size of the index.

setDirectory(String) - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Cache

setDisableCaching(boolean) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

setDisableParallelToolUse(Boolean) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setDisableParallelToolUse(Boolean) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setDisallowDelete(boolean) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerStreamableHttpProperties

setDistanceMetadataFieldName(String) - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

setDistanceType(MariaDBVectorStore.MariaDBDistanceType) - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

setDistanceType(Neo4jVectorStore.Neo4jDistanceType) - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

setDistanceType(OracleVectorStore.OracleVectorStoreDistanceType) - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

setDistanceType(PgVectorStore.PgDistanceType) - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

setEfConstruction(Integer) - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties.HnswProperties

Sets the EF_CONSTRUCTION parameter.

setEfRuntime(Integer) - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties.HnswProperties

Sets the EF_RUNTIME parameter.

setEmbeddingColumnName(String) - Method in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreProperties

setEmbeddingDimension(int) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

setEmbeddingDimension(int) - Method in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseVectorStoreProperties

setEmbeddingDimension(Integer) - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

setEmbeddingFieldName(String) - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

setEmbeddingFieldName(String) - Method in class org.springframework.ai.vectorstore.elasticsearch.autoconfigure.ElasticsearchVectorStoreProperties

setEmbeddingFieldName(String) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStoreOptions

setEmbeddingFieldName(String) - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

setEmbeddingFieldName(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

setEmbeddingFieldName(String) - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

setEmbeddingProperty(String) - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

setEnabled(boolean) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

setEnabled(boolean) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.annotations.McpClientAnnotationScannerProperties

setEnabled(boolean) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

setEnabled(boolean) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties.Toolcallback

setEnabled(boolean) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.annotations.McpServerAnnotationScannerProperties

setEnabled(boolean) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

setEnabled(boolean) - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties

setEnabled(boolean) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

setEnabled(boolean) - Method in class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties

setEnabled(boolean) - Method in class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties.ToolCalling

setEnabled(boolean) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setEnabled(boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.CodeInterpreter

setEnabled(boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.ImageGeneration

setEnabled(boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.WebSearch

setEnabled(boolean) - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Confirmation

setEnabled(boolean) - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Resolution.Fallback

setEnabled(boolean) - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Cache

setEnabled(boolean) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure.RedisSemanticCacheProperties

setEnableLogging(Boolean) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setEnableLogging(Boolean) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setEncodingFormat(String) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties.Options

setEncodingFormat(String) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties

setEncodingFormat(OpenAiEmbeddingOptions.EncodingFormat) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties.Options

setEncodingFormat(OpenAiEmbeddingOptions.EncodingFormat) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

setEnvironment(String) - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

setExceptionHandler(Consumer<Throwable>) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebClientStreamableHttpTransport

setExcludedTools(List<String>) - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Limits

setExcludedUriSchemas(List<String>) - Method in class org.springframework.ai.transformers.ResourceCacheService

Overrides the excluded URI schemas list.

setExcludeOnHttpCodes(List<Integer>) - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties

setExposeMcpClientTools(boolean) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

setExtraBody(Map<String, Object>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setExtraBody(Map<String, Object>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setExtraBody(Map<String, Object>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties.Options

setExtraBody(Map<String, Object>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

setExtraBody(Map<String, Object>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setF16KV(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setF16KV(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setFieldName(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

setFields(String[]) - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

setFileSearch(OpenAiResponsesChatProperties.HostedTools.FileSearch) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools

setFilterField(Map<String, WeaviateVectorStore.MetadataField.Type>) - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

setFixedThreadPoolExecutorSize(int) - Method in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreProperties

setFlagged(boolean) - Method in class org.springframework.ai.moderation.ModerationResult

setForcedNormalization(boolean) - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

setFormat(Object) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setFormat(Object) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setFormat(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setFormat(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setFrequencyPenalty(Float) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

setFunction(DeepSeekApi.FunctionTool.Function) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool

setFunction(MistralAiApi.FunctionTool.Function) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool

setGitHubModels(boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

setGitHubModels(Boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setGoogleSearchRetrieval(Boolean) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setGoogleSearchRetrieval(Boolean) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setGpuDeviceId(int) - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Onnx

setGpuDeviceId(int) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

setHeaders(Map<String, String>) - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

setHeight(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

setHeight(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

setHeight(Integer) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

setHeight(Integer) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

setHnsw(RedisVectorStoreProperties.HnswProperties) - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties

Sets the HNSW properties.

setHost(String) - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated.

setHost(String) - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

setHost(String) - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaApiProperties

setHost(String) - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

setHost(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setHost(String) - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

setHost(String) - Method in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseServiceClientProperties

setHost(String) - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

setHostedTools(OpenAiResponsesChatProperties.HostedTools) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setHttpHeaders(Map<String, String>) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setHttpHeaders(Map<String, String>) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setId(String) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties.Options

setId(String) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

setIdFieldName(String) - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

setIdFieldName(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

setIdleTimeoutMs(long) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setIdProperty(String) - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

setIdType(PgVectorStore.PgIdType) - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

setImageGeneration(OpenAiResponsesChatProperties.HostedTools.ImageGeneration) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools

setImageLimit(Integer) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties.Options

setImageLimit(Integer) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

setImageMinSize(Integer) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties.Options

setImageMinSize(Integer) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

setImageSize(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

setInclude(boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties.ModelTypeInit

setInclude(List<String>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setIncludeContent(boolean) - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Observations

setIncludeErrorLogging(boolean) - Method in class org.springframework.ai.model.chat.observation.autoconfigure.ChatObservationProperties

setIncludeExtendedUsageMetadata(Boolean) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setIncludeExtendedUsageMetadata(Boolean) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setIncludeImageBase64(Boolean) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties.Options

setIncludeImageBase64(Boolean) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

setIncludeServerSideToolInvocations(Boolean) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setIncludeServerSideToolInvocations(Boolean) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setIncludeThoughts(Boolean) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setIncludeThoughts(Boolean) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setIndexedAttributes(Set<String>) - Method in class org.springframework.ai.model.session.jdbc.autoconfigure.JdbcSessionRepositoryProperties

setIndexName(String) - Method in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreProperties

setIndexName(String) - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

setIndexName(String) - Method in class org.springframework.ai.vectorstore.elasticsearch.autoconfigure.ElasticsearchVectorStoreProperties

setIndexName(String) - Method in class org.springframework.ai.vectorstore.mongodb.autoconfigure.MongoDBAtlasVectorStoreProperties

setIndexName(String) - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

setIndexName(String) - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

setIndexName(String) - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated.

setIndexName(String) - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

setIndexName(String) - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

setIndexName(String) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStoreOptions

setIndexName(String) - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

setIndexName(String) - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

setIndexName(String) - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties

Sets the index name.

setIndexName(String) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure.RedisSemanticCacheProperties

setIndexName(String) - Method in class org.springframework.ai.vectorstore.s3.autoconfigure.S3VectorStoreProperties

setIndexParameters(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

setIndexType(MilvusVectorStoreProperties.MilvusIndexType) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

setIndexType(OracleVectorStore.OracleVectorStoreIndexType) - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

setIndexType(PgVectorStore.PgIndexType) - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

setInferenceGeo(String) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setInferenceGeo(String) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setInitialInterval(Duration) - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties.Backoff

setInitialized(boolean) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

setInitializeSchema(boolean) - Method in class org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure.CassandraChatMemoryRepositoryProperties

Deprecated.

setInitializeSchema(boolean) - Method in class org.springframework.ai.vectorstore.properties.CommonVectorStoreProperties

setInitializeSchema(Boolean) - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated.

setInitializeSchema(Boolean) - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

setInput(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties.Options

setInput(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

setInputType(CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType) - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties.Options

setInputType(CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType) - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties

setInputType(BedrockTitanEmbeddingModel.InputType) - Method in class org.springframework.ai.model.bedrock.titan.autoconfigure.BedrockTitanEmbeddingProperties

setInstructions(String) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

setInstructions(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

setJsonMapper(McpJsonMapper) - Method in class org.springframework.ai.mcp.annotation.provider.tool.AbstractMcpToolProvider

setJsonSchema(String) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool.Function

setJsonSchema(String) - Method in class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat

setJsonSchema(MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

setKeepAlive(String) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setKeepAlive(String) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setKeepAlive(String) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties.Options

setKeepAlive(String) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties

setKeepAliveInterval(Duration) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerSseProperties

Deprecated.

setKeepAliveInterval(Duration) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerStreamableHttpProperties

setKeepAliveTimeMs(long) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setKeepAliveTimeoutMs(long) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setKeyPrefix(String) - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated.

setKeyPrefix(String) - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

setKeyspace(String) - Method in class org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure.CassandraChatMemoryRepositoryProperties

Deprecated.

setKeyspace(String) - Method in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreProperties

setKeyToken(String) - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaApiProperties

setKnowledgeBaseId(String) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreProperties

setKnownSpeakerNames(List<String>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

setKnownSpeakerReferences(List<String>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

setKwargs(Map<String, Object>) - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties.Options

setKwargs(Map<String, Object>) - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

setLabel(String) - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

setLabels(Map<String, String>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setLabels(Map<String, String>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setLabels(Map<String, String>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

setLanguage(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

setLanguage(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties.Options

setLanguage(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

setLanguageCode(String) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

setLanguageCode(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setLanguageCode(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setLanguageCode(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

setLocation(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiConnectionProperties

setLocation(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiEmbeddingConnectionProperties

setLocation(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageConnectionProperties

setLocation(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionConnectionProperties

setLocation(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechConnectionProperties

setLocation(String) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiEmbeddingConnectionProperties

setLogCompletion(boolean) - Method in class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties.Observations

setLogCompletion(boolean) - Method in class org.springframework.ai.model.chat.observation.autoconfigure.ChatObservationProperties

setLogitBias(Map<String, Integer>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setLogitBias(Map<String, Integer>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setLogitsAll(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setLogitsAll(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setLogprobs(Boolean) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

setLogprobs(Boolean) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setLogprobs(Boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setLogprobs(Boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setLogPrompt(boolean) - Method in class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties.Observations

setLogPrompt(boolean) - Method in class org.springframework.ai.model.chat.observation.autoconfigure.ChatObservationProperties

setLogPrompt(boolean) - Method in class org.springframework.ai.model.image.observation.autoconfigure.ImageObservationProperties

setLogQueryResponse(boolean) - Method in class org.springframework.ai.vectorstore.observation.autoconfigure.VectorStoreObservationProperties

setLogText(boolean) - Method in class org.springframework.ai.model.audio.observation.autoconfigure.AudioSpeechObservationProperties

setLogTranscript(boolean) - Method in class org.springframework.ai.model.audio.observation.autoconfigure.AudioTranscriptionObservationProperties

setLowVRAM(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setLowVRAM(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setLruMaxSessions(int) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties.Eviction

setM(Integer) - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties.HnswProperties

Sets the M parameter.

setMainGPU(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setMainGPU(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setMapIntegerToNumberValue(boolean) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateFilterExpressionConverter

setMappingJson(String) - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

setMaxAttempts(int) - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties

setMaxCallsPerTool(Map<String, Integer>) - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Limits

setMaxCallsPerToolDefault(Integer) - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Limits

setMaxCompletionTokens(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setMaxCompletionTokens(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setMaxConnections(int) - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

setMaxConversationIds(Integer) - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated.

setMaxConversationIds(Integer) - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

setMaxDocumentBatchSize(int) - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

setMaxDocumentBatchSize(int) - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

setMaxInterval(Duration) - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties.Backoff

setMaxMessagesPerConversation(Integer) - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated.

setMaxMessagesPerConversation(Integer) - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

setMaxNumResults(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.FileSearch

setMaxOutputTokens(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setMaxOutputTokens(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setMaxOutputTokens(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

setMaxOutputTokens(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

setMaxOutputTokens(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setMaxResults(Integer) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

setMaxRetries(int) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties

setMaxRetries(int) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

setMaxRetries(Integer) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicConnectionProperties

setMaxRetries(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setMaxTokens(Integer) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setMaxTokens(Integer) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setMaxTokens(Integer) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

setMaxTokens(Integer) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

setMaxTokens(Integer) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

setMaxTokens(Integer) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setMaxTokens(Integer) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

setMaxTokens(Integer) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setMaxTokens(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setMaxTokens(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setMaxToolCalls(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setMaxTotalToolCalls(Integer) - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Limits

setMaxUses(Long) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool

setMcpEndpoint(String) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerStreamableHttpProperties

setMcpHandler(McpStatelessServerHandler) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStatelessServerTransport

setMcpHandler(McpStatelessServerHandler) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStatelessServerTransport

setMediaLabel(String) - Method in class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryProperties

Deprecated.

setMessageLabel(String) - Method in class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryProperties

Deprecated.

setMessagesColumn(String) - Method in class org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure.CassandraChatMemoryRepositoryProperties

Deprecated.

setMessageTypeMinContentLengths(Map<MessageType, Integer>) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicCacheProperties

setMessageTypeTtl(Map<MessageType, AnthropicCacheTtl>) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicCacheProperties

setMetadata(Metadata) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setMetadata(Metadata) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setMetadata(Map<String, String>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setMetadata(Map<String, String>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setMetadata(Map<String, String>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setMetadataFieldName(String) - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

setMetadataFieldName(String) - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

setMetadataFieldName(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

setMetadataFieldName(String) - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

setMetadataFields(List<Map<String, String>>) - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated.

setMetadataFields(List<Map<String, String>>) - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

setMetadataFieldsToFilter(List<String>) - Method in class org.springframework.ai.vectorstore.mongodb.autoconfigure.MongoDBAtlasVectorStoreProperties

setMetadataLabel(String) - Method in class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryProperties

Deprecated.

setMetadataMode(MetadataMode) - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties.Options

setMetadataMode(MetadataMode) - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

setMetadataMode(MetadataMode) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties

setMetadataMode(MetadataMode) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

setMetadataMode(MetadataMode) - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties

setMetaFieldPrefix(String) - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

setMetaFieldPrefix(String) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStoreOptions

setMethod(GoogleGenAiSafetySetting.HarmBlockMethod) - Method in class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting

setMetricType(MilvusVectorStoreProperties.MilvusMetricType) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

setMicrosoftDeploymentName(String) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

setMicrosoftDeploymentName(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setMicrosoftFoundry(boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

setMicrosoftFoundry(Boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setMicrosoftFoundryServiceVersion(AzureOpenAIServiceVersion) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

setMicrosoftFoundryServiceVersion(AzureOpenAIServiceVersion) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setMinP(Double) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setMinP(Double) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setMinScoreThreshold(float) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties.Lucene

setMirostat(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setMirostat(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setMirostatEta(Float) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setMirostatEta(Float) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setMirostatTau(Float) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setMirostatTau(Float) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setMode(GoogleGenAiChatOptions.ToolChoice.Mode) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.ToolChoiceProperties

setModel(String) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

setModel(String) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setModel(String) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setModel(String) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

setModel(String) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

setModel(String) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

setModel(String) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setModel(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setModel(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setModel(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setModel(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setModel(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties.Options

setModel(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties

setModel(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

setModel(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

setModel(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

setModel(String) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

setModel(String) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setModel(String) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties.Options

setModel(String) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties

setModel(String) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiModerationProperties.Options

setModel(String) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiModerationProperties

setModel(String) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties.Options

setModel(String) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

setModel(String) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setModel(String) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setModel(String) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties.Options

setModel(String) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties

setModel(String) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

setModel(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties.Options

setModel(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

setModel(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties.Options

setModel(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

setModel(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setModel(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setModel(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties.Options

setModel(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

setModel(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

setModel(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

setModel(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiModerationProperties.Options

setModel(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiModerationProperties

setModel(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.ImageGeneration

setModel(String) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

setModel(String) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

setModel(String) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultimodalEmbeddingProperties.Options

setModel(String) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultimodalEmbeddingProperties

setModel(String) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties.Options

setModel(String) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties

setModel(String) - Method in class org.springframework.ai.embedding.EmbeddingResponseMetadata

setModel(String) - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties

setModel(String) - Method in class org.springframework.ai.model.bedrock.titan.autoconfigure.BedrockTitanEmbeddingProperties

setModelId(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setModelId(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setModelOutputName(String) - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Onnx

setModelOutputName(String) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

setModelResource(String) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

setModelResource(Resource) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

setModelUri(String) - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Onnx

setMultiBlockSystemCaching(Boolean) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicCacheProperties

setMultiplier(int) - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties.Backoff

setMultiSpeakerTurns(List<GoogleGenAiAudioSpeechOptions.MultiSpeakerTurn>) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

setMultiSpeakerTurns(List<GoogleGenAiAudioSpeechOptions.MultiSpeakerTurn>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

setN(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

setN(Integer) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

setN(Integer) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setN(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setN(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setN(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

setN(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

setN(Integer) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

setN(Integer) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

setName(String) - Method in class org.springframework.ai.model.bedrock.autoconfigure.ProfileProperties

setName(String) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

setName(String) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

setName(String) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool.Function

setNamespace(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

setNamespace(String) - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

setNextRequestIds(List<String>) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setNextRequestIds(List<String>) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setNextText(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setNextText(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setNumBatch(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setNumBatch(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setNumCtx(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setNumCtx(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setNumGPU(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setNumGPU(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setNumKeep(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setNumKeep(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setNumPredict(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setNumPredict(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setNumThread(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setNumThread(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setObjectClass(String) - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

setObjectClass(String) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStoreOptions

setObservationConvention(TranscriptionModelObservationConvention) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionModel

setObservationConvention(TextToSpeechModelObservationConvention) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechModel

setObservationConvention(EmbeddingModelObservationConvention) - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModel

Use the provided convention for reporting observation data

setObservationConvention(ImageModelObservationConvention) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageModel

setObservationConvention(TranscriptionModelObservationConvention) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel

Use the provided convention for reporting observation data.

setObservationConvention(TextToSpeechModelObservationConvention) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel

Use the provided convention for reporting observation data.

setObservationConvention(TextToSpeechModelObservationConvention) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel

Use the provided convention for reporting observation data.

setObservationConvention(ChatModelObservationConvention) - Method in class org.springframework.ai.anthropic.AnthropicChatModel

Use the provided convention for reporting observation data.

setObservationConvention(ChatModelObservationConvention) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel

Use the provided convention for reporting observation data

setObservationConvention(ChatModelObservationConvention) - Method in class org.springframework.ai.deepseek.DeepSeekChatModel

Use the provided convention for reporting observation data

setObservationConvention(ChatModelObservationConvention) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatModel

Use the provided convention for reporting observation data

setObservationConvention(ChatModelObservationConvention) - Method in class org.springframework.ai.mistralai.MistralAiChatModel

Use the provided convention for reporting observation data

setObservationConvention(ChatModelObservationConvention) - Method in class org.springframework.ai.ollama.OllamaChatModel

Use the provided convention for reporting observation data

setObservationConvention(ChatModelObservationConvention) - Method in class org.springframework.ai.openai.OpenAiChatModel

Use the provided convention for reporting observation data

setObservationConvention(ChatModelObservationConvention) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatModel

Use the provided convention for reporting observation data.

setObservationConvention(EmbeddingModelObservationConvention) - Method in class org.springframework.ai.mistralai.MistralAiEmbeddingModel

Use the provided convention for reporting observation data

setObservationConvention(EmbeddingModelObservationConvention) - Method in class org.springframework.ai.ollama.OllamaEmbeddingModel

Use the provided convention for reporting observation data

setObservationConvention(EmbeddingModelObservationConvention) - Method in class org.springframework.ai.openai.OpenAiEmbeddingModel

Use the provided convention for reporting observation data

setObservationConvention(EmbeddingModelObservationConvention) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

Use the provided convention for reporting observation data

setObservationConvention(EmbeddingModelObservationConvention) - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModel

Use the provided convention for reporting observation data

setObservationConvention(ImageModelObservationConvention) - Method in class org.springframework.ai.openai.OpenAiImageModel

Use the provided convention for reporting observation data

setObservationConvention(ImageModelObservationConvention) - Method in class org.springframework.ai.stabilityai.StabilityAiImageModel

Use the provided convention for reporting observation data.

setObservationConvention(ToolCallingObservationConvention) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager

setOnClientErrors(boolean) - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties

setOnHttpCodes(List<Integer>) - Method in class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties

setOnLimitExceeded(ToolCallLimitBehavior) - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Limits

setOptimization(CouchbaseIndexOptimization) - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

setOptions(TextToSpeechOptions) - Method in class org.springframework.ai.audio.tts.TextToSpeechPrompt

setOptions(AnthropicChatProperties.Options) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setOptions(BedrockCohereEmbeddingProperties.Options) - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties

setOptions(BedrockConverseProxyChatProperties.Options) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

setOptions(DeepSeekChatProperties.Options) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setOptions(ElevenLabsSpeechProperties.Options) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setOptions(GoogleGenAiChatProperties.Options) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setOptions(GoogleGenAiTextEmbeddingProperties.Options) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties

setOptions(MistralAiChatProperties.Options) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setOptions(MistralAiEmbeddingProperties.Options) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties

setOptions(MistralAiModerationProperties.Options) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiModerationProperties

setOptions(MistralAiOcrProperties.Options) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

setOptions(OllamaChatProperties.Options) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setOptions(OllamaEmbeddingProperties.Options) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties

setOptions(OpenAiAudioSpeechProperties.Options) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

setOptions(OpenAiAudioTranscriptionProperties.Options) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

setOptions(OpenAiChatProperties.Options) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setOptions(OpenAiEmbeddingProperties.Options) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

setOptions(OpenAiImageProperties.Options) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

setOptions(OpenAiModerationProperties.Options) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiModerationProperties

setOptions(PostgresMlEmbeddingProperties.Options) - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

setOptions(StabilityAiImageProperties.Options) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

setOptions(VertexAiMultimodalEmbeddingProperties.Options) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultimodalEmbeddingProperties

setOptions(VertexAiTextEmbeddingProperties.Options) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties

setOptions(ModerationOptions) - Method in class org.springframework.ai.moderation.ModerationPrompt

setOrganizationId(String) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

setOrganizationId(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setOutputAudio(OpenAiChatOptions.AudioParameters) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setOutputAudio(OpenAiChatOptions.AudioParameters) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setOutputCompressionQuality(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

setOutputConfig(OutputConfig) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setOutputConfig(OutputConfig) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setOutputDimensionality(Integer) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultimodalEmbeddingProperties.Options

setOutputDimensionality(Integer) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultimodalEmbeddingProperties

setOutputDimensionality(Integer) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties.Options

setOutputDimensionality(Integer) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties

setOutputFormat(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setOutputFormat(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setOutputMimeType(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

setOutputModalities(List<String>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setOutputModalities(List<String>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setPages(List<Integer>) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties.Options

setPages(List<Integer>) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

setParallelToolCalls(Boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setParallelToolCalls(Boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setParallelToolCalls(Boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setParameters(Map<String, Object>) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool.Function

setPartitionName(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties

setPassword(String) - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated.

setPassword(String) - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

setPassword(String) - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaApiProperties

setPassword(String) - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

setPassword(String) - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

setPassword(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setPathName(String) - Method in class org.springframework.ai.vectorstore.mongodb.autoconfigure.MongoDBAtlasVectorStoreProperties

setPathPrefix(String) - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

setPenalizeNewline(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setPenalizeNewline(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setPersonGeneration(GoogleGenAiImageOptions.PersonGeneration) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

setPort(int) - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated.

setPort(int) - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

setPort(int) - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaApiProperties

setPort(int) - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

setPort(int) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setPort(int) - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

setPort(int) - Method in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseServiceClientProperties

setPrefix(Boolean) - Method in class org.springframework.ai.deepseek.DeepSeekAssistantMessage

Deprecated.

Sets the prefix completion flag, as the DeepSeekChatModel.PREFIX_METADATA_KEY metadata entry.

setPrefix(String) - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreProperties

Sets the key prefix.

setPrefix(String) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure.RedisSemanticCacheProperties

setPresencePenalty(Double) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

setPresencePenalty(Double) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

setPresencePenalty(Double) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

setPresencePenalty(Double) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setPresencePenalty(Double) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setPresencePenalty(Double) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setPresencePenalty(Double) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

setPresencePenalty(Double) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setPresencePenalty(Double) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setPresencePenalty(Double) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setPresencePenalty(Double) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setPresencePenalty(Double) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setPresencePenalty(Float) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

setPreviousRequestIds(List<String>) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setPreviousRequestIds(List<String>) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setPreviousText(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setPreviousText(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setProfile(ProfileProperties) - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

setProjectId(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiConnectionProperties

setProjectId(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiEmbeddingConnectionProperties

setProjectId(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageConnectionProperties

setProjectId(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionConnectionProperties

setProjectId(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechConnectionProperties

setProjectId(String) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiEmbeddingConnectionProperties

setProjectId(String) - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

setPrompt(boolean) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.Capabilities

setPrompt(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

setPrompt(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties.Options

setPrompt(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

setPromptCacheKey(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setPromptCacheKey(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setPromptCacheKey(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setPromptChangeNotification(boolean) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerChangeNotificationProperties

setPronunciationDictionaryLocators(List<ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator>) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setPronunciationDictionaryLocators(List<ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator>) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setProtocol(String) - Method in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseServiceClientProperties

setProtocol(McpServerProperties.ServerProtocol) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

setProxy(Proxy) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicConnectionProperties

setProxy(Proxy) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

setProxy(Proxy) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setPullModelStrategy(PullModelStrategy) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties

setQuality(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

setQuality(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

setQueryRequest(SearchRequest) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

setQueryResponse(List<Document>) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

setRandomSeed(Integer) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

setRandomSeed(Integer) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setReadTimeout(Duration) - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

setReasoningContent(String) - Method in class org.springframework.ai.deepseek.DeepSeekAssistantMessage

Deprecated.

Overrides the reasoning content returned by DeepSeekAssistantMessage.getReasoningContent() and sent back to DeepSeek.

setReasoningEffort(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setReasoningEffort(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setReasoningEffort(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setReasoningEffort(DeepSeekApi.ChatCompletionRequest.ReasoningEffort) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

setReasoningEffort(DeepSeekApi.ChatCompletionRequest.ReasoningEffort) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setReasoningEffort(MistralAiApi.ChatCompletionRequest.ReasoningEffort) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setReasoningSummary(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setReferenceToolNameAccumulation(boolean) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

setRegion(String) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreProperties

setRegion(String) - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

setRemoveExistingVectorStoreTable(boolean) - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

setRemoveExistingVectorStoreTable(boolean) - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

setRemoveExistingVectorStoreTable(boolean) - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

setRepeatLastN(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setRepeatLastN(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setRepeatPenalty(Double) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setRepeatPenalty(Double) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setReplayReasoningContent(Boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setReplayReasoningContent(Boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setReplicatedVoice(GoogleGenAiAudioSpeechOptions.ReplicatedVoice) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

setRequestParameters(Map<String, Object>) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

setRequestParameters(Map<String, Object>) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

setRequestTimeout(Duration) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

setRequestTimeout(Duration) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

setRerankingModelArn(String) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreProperties

setResource(boolean) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.Capabilities

setResourceCacheDirectory(String) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

setResourceChangeNotification(boolean) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerChangeNotificationProperties

setResponse(ChatClientResponse) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext

setResponse(RES) - Method in class org.springframework.ai.model.observation.ModelObservationContext

setResponseFormat(AudioResponseFormat) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties.Options

setResponseFormat(AudioResponseFormat) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

setResponseFormat(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties.Options

setResponseFormat(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

setResponseFormat(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

setResponseFormat(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

setResponseFormat(String) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

setResponseFormat(String) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

setResponseFormat(ResponseFormat) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

setResponseFormat(ResponseFormat) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setResponseFormat(MistralAiApi.ChatCompletionRequest.ResponseFormat) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

setResponseFormat(MistralAiApi.ChatCompletionRequest.ResponseFormat) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setResponseFormat(OpenAiChatModel.ResponseFormat) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setResponseFormat(OpenAiChatModel.ResponseFormat) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setResponseFormat(OpenAiChatModel.ResponseFormat) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setResponseMimeType(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setResponseMimeType(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setResponseMimeType(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

setResponseSchema(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setResponseSchema(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setRootChangeNotification(boolean) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

setRpcDeadlineMs(long) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setSafePrompt(Boolean) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

setSafePrompt(Boolean) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setSafetyFilterLevel(GoogleGenAiImageOptions.SafetyFilterLevel) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

setSafetyIdentifier(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setSafetySettings(List<GoogleGenAiSafetySetting>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setSafetySettings(List<GoogleGenAiSafetySetting>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setSampler(String) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

setSampler(String) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

setSchema(String) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

setSchemaName(String) - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

setSchemaName(String) - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

setSchemaValidation(boolean) - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

setSchemaValidation(boolean) - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

setScheme(String) - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

setScopeName(String) - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

setSearchAccuracy(int) - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

setSearchContextSize(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.WebSearch

setSearchType(SearchType) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreProperties

setSecretKey(String) - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

setSecure(boolean) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setSeed(Integer) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setSeed(Integer) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setSeed(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

setSeed(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

setSeed(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setSeed(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setSeed(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setSeed(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setSeed(Long) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

setSeed(Long) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

setServerName(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setServerPemPath(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setServersConfiguration(Resource) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStdioClientProperties

setServerSideTimeout(Duration) - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreProperties

setServiceTier(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setServiceTier(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setServiceTier(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setServiceTier(AnthropicServiceTier) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setServiceTier(AnthropicServiceTier) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setServiceTier(GoogleGenAiServiceTier) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setSessionFactory(McpServerSession.Factory) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider

Deprecated.

setSessionFactory(McpServerSession.Factory) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider

Deprecated.

setSessionFactory(McpStreamableServerSession.Factory) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxStreamableServerTransportProvider

setSessionFactory(McpStreamableServerSession.Factory) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcStreamableServerTransportProvider

setSessionIdKeyName(String) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

setSessionLabel(String) - Method in class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryProperties

Deprecated.

setSessionToken(String) - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

setShouldSeparateByBeads(boolean) - Method in class org.springframework.ai.reader.pdf.layout.PDFLayoutTextStripperByArea

This method does nothing in this derived class, because beads and regions are incompatible.

setSimilarity(String) - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

setSimilarity(CouchbaseSimilarityFunction) - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreProperties

setSimilarity(SimilarityFunction) - Method in class org.springframework.ai.vectorstore.elasticsearch.autoconfigure.ElasticsearchVectorStoreProperties

setSimilarity(SimilarityFunction) - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStoreOptions

setSimilarityMetric(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

setSimilarityThreshold(double) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreProperties

setSimilarityThreshold(double) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.autoconfigure.RedisSemanticCacheProperties

setSize(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

setSize(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

setSize(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.ImageGeneration

setSocketTimeout(Duration) - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

setSpeakerVoiceConfigs(List<GoogleGenAiAudioSpeechOptions.SpeakerVoiceConfig>) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

setSpeakerVoiceConfigs(List<GoogleGenAiAudioSpeechOptions.SpeakerVoiceConfig>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

setSpeed(Double) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties.Options

setSpeed(Double) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

setSseEndpoint(String) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerSseProperties

Deprecated.

setSseMessageEndpoint(String) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerSseProperties

Deprecated.

setSslBundle(String) - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

setSslEnabled(boolean) - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

setStdio(boolean) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

setSteps(Integer) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

setSteps(Integer) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

setStop(List<String>) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

setStop(List<String>) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setStop(List<String>) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

setStop(List<String>) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setStop(List<String>) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setStop(List<String>) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setStop(List<String>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setStop(List<String>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setStopSequences(List<String>) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setStopSequences(List<String>) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setStopSequences(List<String>) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

setStopSequences(List<String>) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

setStopSequences(List<String>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setStopSequences(List<String>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setStopSequences(List<String>) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

setStore(Boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setStore(Boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setStrategy(AnthropicCacheStrategy) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicCacheProperties

setStrategy(BedrockCacheStrategy) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockCacheProperties

setStreamOptions(OpenAiChatOptions.StreamOptions) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setStreamOptions(OpenAiChatOptions.StreamOptions) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setStrict(Boolean) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setStrict(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat

setStyle(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

setStyle(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

setStylePreset(String) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

setStylePreset(String) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

setStylePrompt(String) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

setStylePrompt(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

setSystemMessageSuffix(String) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

setTable(String) - Method in class org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure.CassandraChatMemoryRepositoryProperties

Deprecated.

setTable(String) - Method in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreProperties

setTableName(String) - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreProperties

setTableName(String) - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreProperties

setTableName(String) - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreProperties

setTaskType(GoogleGenAiTextEmbeddingOptions.TaskType) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties.Options

setTaskType(GoogleGenAiTextEmbeddingOptions.TaskType) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties

setTaskType(VertexAiTextEmbeddingOptions.TaskType) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties.Options

setTaskType(VertexAiTextEmbeddingOptions.TaskType) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties

setTemperature(Double) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setTemperature(Double) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setTemperature(Double) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

setTemperature(Double) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

setTemperature(Double) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

setTemperature(Double) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setTemperature(Double) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setTemperature(Double) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setTemperature(Double) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

setTemperature(Double) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setTemperature(Double) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setTemperature(Double) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setTemperature(Double) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setTemperature(Double) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setTemperature(Double) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setTemperature(Float) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

setTemperature(Float) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

setTemperature(Float) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties.Options

setTemperature(Float) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

setTenantName(String) - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaVectorStoreProperties

setText(String) - Method in class org.springframework.ai.moderation.ModerationMessage

setTextProperty(String) - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreProperties

setTfsZ(Float) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setTfsZ(Float) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setThink(OllamaThinkProperties) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setThinking(ThinkingConfigParam) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setThinking(ThinkingConfigParam) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setThinking(DeepSeekApi.ChatCompletionRequest.Thinking) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

setThinking(DeepSeekApi.ChatCompletionRequest.Thinking) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setThinkingBudget(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setThinkingBudget(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setThinkingLevel(GoogleGenAiThinkingLevel) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setThinkingLevel(GoogleGenAiThinkingLevel) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setThinkOption(OllamaThinkProperties) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

Deprecated, for removal: This API element is subject to removal in a future version.

setThreshold(GoogleGenAiSafetySetting.HarmBlockThreshold) - Method in class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting

setThrowExceptionOnError(boolean) - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties

setTimeout(Duration) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicConnectionProperties

setTimeout(Duration) - Method in class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

setTimeout(Duration) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setTimeout(Duration) - Method in class org.springframework.ai.model.bedrock.autoconfigure.BedrockAwsConnectionProperties

setTimeout(Duration) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaInitializationProperties

setTimestampGranularities(List<TranscriptionCreateParams.TimestampGranularity>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties.Options

setTimestampGranularities(List<TranscriptionCreateParams.TimestampGranularity>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

setTimeToLive(Duration) - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated.

setTimeToLive(Duration) - Method in class org.springframework.ai.model.chat.memory.repository.cassandra.autoconfigure.CassandraChatMemoryRepositoryProperties

Deprecated.

setTimeToLive(Duration) - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

setTimeToLive(Duration) - Method in class org.springframework.ai.model.session.autoconfigure.SessionServiceProperties

settings() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the settings record component.

setTitle(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties.Options

setTitle(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties

setTitle(String) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties.Options

setTitle(String) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties

setToken(String) - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

setToken(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setTokenizerOptions(Map<String, String>) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

setTokenizerResource(String) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

setTokenizerResource(Resource) - Method in class org.springframework.ai.transformers.TransformersEmbeddingModel

setTool(boolean) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.Capabilities

setToolcallback(McpClientCommonProperties.Toolcallback) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

setToolCallLabel(String) - Method in class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryProperties

Deprecated.

setToolCallResult(String) - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext

setToolChangeNotification(boolean) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerChangeNotificationProperties

setToolChoice(ToolChoice) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setToolChoice(ToolChoice) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setToolChoice(Object) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setToolChoice(Object) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setToolChoice(Object) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setToolChoice(MistralAiApi.ChatCompletionRequest.ToolChoice) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

setToolChoice(MistralAiApi.ChatCompletionRequest.ToolChoice) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setToolChoice(GoogleGenAiChatProperties.ToolChoiceProperties) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setToolIndexType(String) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

setToolResponseLabel(String) - Method in class org.springframework.ai.model.chat.memory.repository.neo4j.autoconfigure.Neo4jChatMemoryRepositoryProperties

Deprecated.

setTools(List<MistralAiApi.FunctionTool>) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

setTools(List<MistralAiApi.FunctionTool>) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setTools(List<String>) - Method in class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties.Confirmation

setTopK(int) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.autoconfigure.BedrockKnowledgeBaseVectorStoreProperties

setTopK(Float) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

setTopK(Float) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

setTopK(Integer) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setTopK(Integer) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setTopK(Integer) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

setTopK(Integer) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

setTopK(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setTopK(Integer) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setTopK(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setTopK(Integer) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setTopLogprobs(Integer) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

setTopLogprobs(Integer) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setTopLogprobs(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setTopLogprobs(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setTopP(Double) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setTopP(Double) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setTopP(Double) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties.Options

setTopP(Double) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

setTopP(Double) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties.Options

setTopP(Double) - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

setTopP(Double) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setTopP(Double) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setTopP(Double) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties.Options

setTopP(Double) - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

setTopP(Double) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setTopP(Double) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setTopP(Double) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setTopP(Double) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setTopP(Double) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setTopP(Float) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

setTopP(Float) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

setTransformer(String) - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties.Options

setTransformer(String) - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

setTruncate(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setTruncate(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setTruncate(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties.Options

setTruncate(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties

setTruncate(CohereEmbeddingBedrockApi.CohereEmbeddingRequest.Truncate) - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties.Options

setTruncate(CohereEmbeddingBedrockApi.CohereEmbeddingRequest.Truncate) - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties

setTruncation(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setTtl(Duration) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties.Eviction

setTtl(BedrockCacheTtl) - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockCacheProperties

setTtl(Duration) - Method in class org.springframework.ai.model.chat.memory.repository.mongo.autoconfigure.MongoChatMemoryProperties

Deprecated.

setType(DeepSeekApi.FunctionTool.Type) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool

setType(ResponseFormat.Type) - Method in class org.springframework.ai.deepseek.api.ResponseFormat

setType(McpClientCommonProperties.ClientType) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

setType(McpServerProperties.ApiType) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

setType(MistralAiApi.ChatCompletionRequest.ResponseFormat.Type) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

setType(MistralAiApi.FunctionTool.Type) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool

setType(OpenAiChatModel.ResponseFormat.Type) - Method in class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat

setTypicalP(Float) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setTypicalP(Float) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setupAsyncClient(String, String, Credential, String, AzureOpenAIServiceVersion, String, boolean, boolean, String, Duration, int, Proxy, Map<String, String>, ObservationRegistry, MeterRegistry, List<OpenAiHttpClientBuilderCustomizer>) - Static method in class org.springframework.ai.openai.setup.OpenAiSetup

setupAsyncClient(String, String, Duration, Integer, Proxy, Map<String, String>) - Static method in class org.springframework.ai.anthropic.AnthropicSetup

Creates an asynchronous Anthropic client with the specified configuration.

setupAsyncClient(String, String, Duration, Integer, Proxy, Map<String, String>, ObservationRegistry, MeterRegistry) - Static method in class org.springframework.ai.anthropic.AnthropicSetup

Creates an asynchronous Anthropic client whose underlying OkHttp client is instrumented with Micrometer.

setupAsyncClient(String, String, Duration, Integer, Proxy, Map<String, String>, ObservationRegistry, MeterRegistry, ExecutorService) - Static method in class org.springframework.ai.anthropic.AnthropicSetup

Creates an asynchronous Anthropic client backed by a caller-supplied dispatcher executor.

setupAsyncClient(String, String, Duration, Integer, Proxy, Map<String, String>, ObservationRegistry, MeterRegistry, ExecutorService, List<AnthropicHttpClientBuilderCustomizer>) - Static method in class org.springframework.ai.anthropic.AnthropicSetup

Creates an asynchronous Anthropic client backed by a caller-supplied dispatcher executor and with optional HTTP client customizers.

setupSyncClient(String, String, Credential, String, AzureOpenAIServiceVersion, String, boolean, boolean, String, Duration, int, Proxy, Map<String, String>, ObservationRegistry, MeterRegistry, List<OpenAiHttpClientBuilderCustomizer>) - Static method in class org.springframework.ai.openai.setup.OpenAiSetup

Sets up a synchronous OpenAI client.

setupSyncClient(String, String, Duration, Integer, Proxy, Map<String, String>) - Static method in class org.springframework.ai.anthropic.AnthropicSetup

Creates a synchronous Anthropic client with the specified configuration.

setupSyncClient(String, String, Duration, Integer, Proxy, Map<String, String>, ObservationRegistry, MeterRegistry) - Static method in class org.springframework.ai.anthropic.AnthropicSetup

Creates a synchronous Anthropic client whose underlying OkHttp client is instrumented with Micrometer: each HTTP attempt emits an observation (span + metric + traceparent propagation), and, when a MeterRegistry is supplied, OkHttp connection-pool gauges are bound to it.

setupSyncClient(String, String, Duration, Integer, Proxy, Map<String, String>, ObservationRegistry, MeterRegistry, ExecutorService) - Static method in class org.springframework.ai.anthropic.AnthropicSetup

Creates a synchronous Anthropic client backed by a caller-supplied dispatcher executor (e.g. one built around Executors.newVirtualThreadPerTaskExecutor() on Java 21+).

setupSyncClient(String, String, Duration, Integer, Proxy, Map<String, String>, ObservationRegistry, MeterRegistry, ExecutorService, List<AnthropicHttpClientBuilderCustomizer>) - Static method in class org.springframework.ai.anthropic.AnthropicSetup

Creates a synchronous Anthropic client backed by a caller-supplied dispatcher executor and with optional HTTP client customizers.

setupTestDocuments(VectorStore) - Method in class org.springframework.ai.test.vectorstore.BaseVectorStoreTests

setUri(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setUri(String) - Method in class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Tokenizer

setUris(List<String>) - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

setUrl(String) - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

setUrl(String) - Method in class org.springframework.ai.image.Image

setUsage(Usage) - Method in class org.springframework.ai.audio.transcription.AudioTranscriptionResponseMetadata

Sets the AI provider specific metadata on API usage.

setUsage(Usage) - Method in class org.springframework.ai.audio.tts.TextToSpeechResponseMetadata

Sets the AI provider specific metadata on API usage.

setUsage(Usage) - Method in class org.springframework.ai.embedding.EmbeddingResponseMetadata

setUsage(Usage) - Method in class org.springframework.ai.image.ImageResponseMetadata

Set the token usage associated with the image response.

setUseApproximateKnn(Boolean) - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

setUseCachedContent(Boolean) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.Options

setUseCachedContent(Boolean) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

setUseKeylessAuth(boolean) - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreProperties

setUseMLock(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setUseMLock(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setUseMMap(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setUseMMap(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setUseNUMA(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setUseNUMA(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setUser(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setUser(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setUser(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties.Options

setUser(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

setUser(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

setUser(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

setUserLocation(AnthropicWebSearchTool.UserLocation) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool

setUsername(String) - Method in class org.springframework.ai.model.chat.memory.redis.autoconfigure.RedisChatMemoryProperties

Deprecated.

setUsername(String) - Method in class org.springframework.ai.model.chat.memory.repository.redis.autoconfigure.RedisChatMemoryRepositoryProperties

Deprecated.

setUsername(String) - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaApiProperties

setUsername(String) - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

setUsername(String) - Method in class org.springframework.ai.vectorstore.opensearch.autoconfigure.OpenSearchVectorStoreProperties

setUsername(String) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusServiceClientProperties

setUseTls(boolean) - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreProperties

setVectorBucketName(String) - Method in class org.springframework.ai.vectorstore.s3.autoconfigure.S3VectorStoreProperties

setVectorSimilarityFunction(String) - Method in class org.springframework.ai.vectorstore.gemfire.autoconfigure.GemFireVectorStoreProperties

setVectorStoreIds(List<String>) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.FileSearch

setVectorType(PostgresMlEmbeddingModel.VectorType) - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties.Options

setVectorType(PostgresMlEmbeddingModel.VectorType) - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

setVerbosity(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Options

setVerbosity(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

setVerbosity(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

setVersion(String) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties

setVersion(String) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties

setVertexAi(boolean) - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiConnectionProperties

setVertexAi(boolean) - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiEmbeddingConnectionProperties

setVertexAi(boolean) - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageConnectionProperties

setVertexAi(boolean) - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionConnectionProperties

setVocabOnly(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties.Options

setVocabOnly(Boolean) - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

setVoice(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setVoice(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setVoice(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties.Options

setVoice(String) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

setVoiceId(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setVoiceId(String) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setVoiceName(String) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

setVoiceName(String) - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

setVoiceSettings(ElevenLabsApi.SpeechRequest.VoiceSettings) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties.Options

setVoiceSettings(ElevenLabsApi.SpeechRequest.VoiceSettings) - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

setWebSearch(OpenAiResponsesChatProperties.HostedTools.WebSearch) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools

setWebSearchTool(AnthropicWebSearchTool) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties.Options

setWebSearchTool(AnthropicWebSearchTool) - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

setWidth(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties.Options

setWidth(Integer) - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

setWidth(Integer) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties.Options

setWidth(Integer) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

SEVERITY - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmBlockMethod

sexual() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Returns the value of the sexual record component.

sexual() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Returns the value of the sexual record component.

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

shadowPrompt(String) - Method in class org.springframework.ai.session.compaction.ChatModelSummarizer.Builder

Replaces the synthetic user message that opens each summary turn; ChatModelSummarizer.DEFAULT_SHADOW_PROMPT by default.

sharing() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the sharing record component.

SHIMMER - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Voice

SHIMMER - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.Voice

SHORT_RETRY_TEMPLATE - Static variable in class org.springframework.ai.retry.RetryUtils

Short RetryTemplate for testing scenarios.

shouldCompact(CompactionRequest) - Method in interface org.springframework.ai.session.compaction.CompactionTrigger

Whether the view should be compacted now.

shouldCompact(CompactionRequest) - Method in class org.springframework.ai.session.compaction.CompositeCompactionTrigger

shouldCompact(CompactionRequest) - Method in class org.springframework.ai.session.compaction.TokenCountTrigger

shouldCompact(CompactionRequest) - Method in class org.springframework.ai.session.compaction.TurnCountTrigger

shouldPersist(Message) - Method in interface org.springframework.ai.session.MessageFilter

Whether the message is stored.

showGlyph(Matrix, PDFont, int, Vector) - Method in class org.springframework.ai.reader.pdf.layout.PDFLayoutTextStripperByArea

showModel(OllamaApi.ShowModelRequest) - Method in class org.springframework.ai.ollama.api.OllamaApi

Show information about a model available locally on the machine where Ollama is running.

ShowModelRequest(String) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.ShowModelRequest

ShowModelRequest(String, String, Boolean, Map<String, Object>) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.ShowModelRequest

Creates an instance of a ShowModelRequest record class.

ShowModelResponse(String, String, String, String, String, OllamaApi.Model.Details, List<OllamaApi.Message>, Map<String, Object>, Map<String, Object>, List<String>, Instant) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Creates an instance of a ShowModelResponse record class.

signature() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ThinkChunk

Returns the value of the signature record component.

SIGNATURE_PAYLOAD_KIND - Static variable in class org.springframework.ai.mistralai.MistralAiChatModel

The kind of the payload that holds the signature of a thinking chunk.

similarity() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerificationAttempt

Returns the value of the similarity record component.

SIMILARITY_FIELD_NAME - Static variable in class org.springframework.ai.vectorstore.milvus.MilvusVectorStore

SIMILARITY_THRESHOLD_ACCEPT_ALL - Static variable in class org.springframework.ai.vectorstore.SearchRequest

Similarity threshold that accepts all search scores.

SIMILARITY_THRESHOLD_EXACT_MATCH - Static variable in class org.springframework.ai.vectorstore.oracle.OracleVectorStore

similarityBoost() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.VoiceSettings

Returns the value of the similarityBoost record component.

similarityBoost() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSettings

Returns the value of the similarityBoost record component.

similarityFunction(String) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.Builder

Sets the similarity function for vector comparison.

similarityFunction(CouchbaseSimilarityFunction) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.Builder

Choose the method to calculate the similarity between the vector embedding in a Vector Search index and the vector embedding in a Vector Search query.

SimilarityFunction - Enum Class in org.springframework.ai.vectorstore.elasticsearch

https://www.elastic.co/guide/en/elasticsearch/reference/master/dense-vector.html max_inner_product is currently not supported because the distance value is not normalized and would not comply with the requirement of being between 0 and 1

similarityMetric(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

similarityMetric(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder

similaritySearch(float[], int, double, Filter.Expression) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

similaritySearch(float[], SearchRequest) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

similaritySearch(float[], SearchRequest) - Method in interface org.springframework.ai.vectorstore.VectorStoreRetriever

Retrieves documents by similarity to a query embedding the caller has already computed, instead of embedding query text with the store's own embedding model.

similaritySearch(String) - Method in class org.springframework.ai.vectorstore.azure.AzureVectorStore

similaritySearch(String) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore

similaritySearch(String) - Method in interface org.springframework.ai.vectorstore.VectorStoreRetriever

Retrieves documents by query embedding similarity using the default SearchRequest's search criteria.

similaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore

similaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

similaritySearch(SearchRequest) - Method in interface org.springframework.ai.vectorstore.VectorStoreRetriever

Retrieves documents by query embedding similarity and metadata filters to retrieve exactly the number of nearest-neighbor results that match the request criteria.

similaritySearch(SearchRequest, String) - Method in class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore

similaritySearchSqlTemplate - Variable in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgDistanceType

similarityThreshold(double) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore.Builder

Sets the default similarity threshold for filtering results.

similarityThreshold(double) - Method in class org.springframework.ai.vectorstore.milvus.MilvusSearchRequest.MilvusBuilder

SearchRequest.Builder.similarityThreshold(double)

similarityThreshold(double) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache.Builder

similarityThreshold(double) - Method in class org.springframework.ai.vectorstore.SearchRequest.Builder

Similarity threshold score to filter the search response by.

similarityThreshold(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

similarityThreshold(Double) - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever.Builder

similarityThresholdAll() - Method in class org.springframework.ai.vectorstore.milvus.MilvusSearchRequest.MilvusBuilder

SearchRequest.Builder.similarityThresholdAll()

similarityThresholdAll() - Method in class org.springframework.ai.vectorstore.SearchRequest.Builder

Sets disables the similarity threshold by setting it to 0.0 - all results are accepted.

SIMPLE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by simple.

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.

SimpleIdentifierContext(FiltersParser.IdentifierContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.SimpleIdentifierContext

SimpleLoggerAdvisor - Class in org.springframework.ai.chat.client.advisor

A simple logger advisor that logs the request and response messages.

SimpleLoggerAdvisor() - Constructor for class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

SimpleLoggerAdvisor(int) - Constructor for class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

SimpleLoggerAdvisor(Function<ChatClientRequest, String>, Function<ChatResponse, String>, int) - Constructor for class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

SimpleLoggerAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor

SimpleVectorStore - Class in org.springframework.ai.vectorstore

A simple, in-memory implementation of the VectorStore interface.

SimpleVectorStore(SimpleVectorStore.SimpleVectorStoreBuilder) - Constructor for class org.springframework.ai.vectorstore.SimpleVectorStore

SimpleVectorStore.EmbeddingMath - Class in org.springframework.ai.vectorstore

SimpleVectorStore.SimpleVectorStoreBuilder - Class in org.springframework.ai.vectorstore

size() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model

Returns the value of the size record component.

size() - Method in record class org.springframework.ai.openai.responses.HostedTool.ImageGeneration

Returns the value of the size record component.

size() - Method in record class org.springframework.ai.session.compaction.CompactionWindow

Returns the value of the size record component.

size(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder

size(String) - Method in class org.springframework.ai.tool.toolsearch.index.lucene.LuceneToolIndex

Returns the number of documents in the index for the specified session.

size(String) - Method in class org.springframework.ai.tool.toolsearch.index.regex.RegexToolIndex

Returns the number of tools in the index for the specified session.

sizeBytes() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerificationFile

Returns the value of the sizeBytes record component.

sizeBytes() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Recording

Returns the value of the sizeBytes record component.

sizeBytes() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Sample

Returns the value of the sizeBytes record component.

skill(String) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

skill(String) - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder

Add a skill by its ID or name.

skill(String, String) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

skill(String, String) - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder

Add a skill by its ID or name with a specific version.

skill(AnthropicSkill) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

skill(AnthropicSkill) - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder

Add a pre-built Anthropic skill using the enum.

skill(AnthropicSkillRecord) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

skill(AnthropicSkillRecord) - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder

Add a skill record directly.

skill(AnthropicSkill, String) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

skill(AnthropicSkill, String) - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder

Add a pre-built Anthropic skill with a specific version.

skillContainer(AnthropicSkillContainer) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

skillId(String) - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord.Builder

skills(String...) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

skills(String...) - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder

Add multiple skills by their IDs or names.

skills(List<String>) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

skills(List<String>) - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder

Add multiple skills from a list of IDs or names.

skipEmptyMessages() - Static method in interface org.springframework.ai.session.MessageFilter

A filter that skips an AssistantMessage with no content, no text, no tool calls and no media, and stores every other message; the default of SessionMemoryAdvisor.

sliceIds() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns the value of the sliceIds record component.

socketTimeout(Duration) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder

source() - Method in record class org.springframework.ai.ollama.api.OllamaApi.CopyModelRequest

Returns the value of the source record component.

SOURCE_METADATA - Static variable in class org.springframework.ai.reader.TextReader

speaker() - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.MultiSpeakerTurn

Returns the value of the speaker record component.

speaker() - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.SpeakerVoiceConfig

Returns the value of the speaker record component.

SpeakerVoiceConfig(String, String) - Constructor for record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.SpeakerVoiceConfig

Creates an instance of a SpeakerVoiceConfig record class.

speakerVoiceConfigs(List<GoogleGenAiAudioSpeechOptions.SpeakerVoiceConfig>) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.Builder

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

SpeechRequest(String, String, String, ElevenLabsApi.SpeechRequest.VoiceSettings, List<ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator>, Integer, String, String, List<String>, List<String>, ElevenLabsApi.SpeechRequest.TextNormalizationMode, Boolean) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Creates an instance of a SpeechRequest record class.

speed() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.VoiceSettings

Returns the value of the speed record component.

speed() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSettings

Returns the value of the speed record component.

speed(Double) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

speed(Double) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder

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.

speedPriority(Double) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec.DefaultModelPreferenceSpec

speedPriority(Double) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.ModelPreferenceSpec

split(List<Document>) - Method in class org.springframework.ai.transformer.splitter.TextSplitter

split(Document) - Method in class org.springframework.ai.transformer.splitter.TextSplitter

splitCamelCase(String) - Static method in class org.springframework.ai.util.ParsingUtils

Splits up the given camel-case String.

splitCamelCaseToLower(String) - Static method in class org.springframework.ai.util.ParsingUtils

Splits up the given camel-case String and returns the parts in lower case.

splitText(String) - Method in class org.springframework.ai.transformer.splitter.TextSplitter

splitText(String) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter

SPRING_AI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider

AI system provided by Spring AI.

SPRING_AI_KIND - Enum constant in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.LowCardinalityKeyNames

Spring AI kind.

SPRING_AI_KIND - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.LowCardinalityKeyNames

Spring AI kind.

SPRING_AI_KIND - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.LowCardinalityKeyNames

Spring AI kind.

SPRING_AI_KIND - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.LowCardinalityKeyNames

Spring AI kind.

SPRING_AI_PROVIDER - Static variable in record class org.springframework.ai.chat.messages.part.UnknownPart

The provider of an unknown part produced by deserializing a type this version does not know.

SpringAiAnthropicHttpClient - Class in org.springframework.ai.anthropic.http.okhttp

OkHttp-backed HttpClient for the Anthropic Java SDK, with Micrometer's OkHttpObservationInterceptor attached so each HTTP attempt produces an observation (span + metric + traceparent propagation).

SpringAiAnthropicHttpClient.Builder - Class in org.springframework.ai.anthropic.http.okhttp

Builder for SpringAiAnthropicHttpClient.

SpringAiCoreRuntimeHints - Class in org.springframework.ai.aot

SpringAiCoreRuntimeHints() - Constructor for class org.springframework.ai.aot.SpringAiCoreRuntimeHints

springAiKind() - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention

springAiKind() - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

springAiKind() - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

springAiKind(ToolCallingObservationContext) - Method in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention

SpringAiKind - Enum Class in org.springframework.ai.observation.conventions

Types of Spring AI constructs which can be observed.

SpringAIModelProperties - Class in org.springframework.ai.model

SpringAIModels - Class in org.springframework.ai.model

SpringAiOpenAiHttpClient - Class in org.springframework.ai.openai.http.okhttp

OkHttp-backed HttpClient for the OpenAI Java SDK, with Micrometer's OkHttpObservationInterceptor attached so each HTTP attempt produces an observation (span + metric + traceparent propagation).

SpringAiOpenAiHttpClient.Builder - Class in org.springframework.ai.openai.http.okhttp

Builder for SpringAiOpenAiHttpClient.

SpringAiRetryAutoConfiguration - Class in org.springframework.ai.retry.autoconfigure

Auto-configuration for AI Retry.

SpringAiRetryAutoConfiguration() - Constructor for class org.springframework.ai.retry.autoconfigure.SpringAiRetryAutoConfiguration

SpringAiRetryProperties - Class in org.springframework.ai.retry.autoconfigure

Properties for AI Retry.

SpringAiRetryProperties() - Constructor for class org.springframework.ai.retry.autoconfigure.SpringAiRetryProperties

SpringAiRetryProperties.Backoff - Class in org.springframework.ai.retry.autoconfigure

Exponential Backoff properties.

SpringAiSchemaModule - Class in org.springframework.ai.util.json.schema

JSON Schema Generator Module for Spring AI.

SpringAiSchemaModule(AbstractSpringAiSchemaModule.Option...) - Constructor for class org.springframework.ai.util.json.schema.SpringAiSchemaModule

SpringAIVectorStoreTypes - Class in org.springframework.ai.vectorstore

SqliteChatMemoryRepositoryDialect - Class in org.springframework.ai.chat.memory.repository.jdbc

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of JdbcSessionRepository in spring-ai-session-jdbc. There is no session dialect for SQLite yet; one is planned before 3.0.0, and until then a dialect of your own implements JdbcSessionRepositoryDialect.

SqliteChatMemoryRepositoryDialect() - Constructor for class org.springframework.ai.chat.memory.repository.jdbc.SqliteChatMemoryRepositoryDialect

Deprecated.

SqlJsonPathFilterExpressionConverter - Class in org.springframework.ai.vectorstore.oracle

Converts a Filter into a JSON Path expression.

SqlJsonPathFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.oracle.SqlJsonPathFilterExpressionConverter

SqlJsonPathFilterExpressionConverter(String) - Constructor for class org.springframework.ai.vectorstore.oracle.SqlJsonPathFilterExpressionConverter

SqlServerChatMemoryRepositoryDialect - Class in org.springframework.ai.chat.memory.repository.jdbc

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of JdbcSessionRepository in spring-ai-session-jdbc. There is no session dialect for SQL Server yet; one is planned before 3.0.0, and until then a dialect of your own implements JdbcSessionRepositoryDialect.

SqlServerChatMemoryRepositoryDialect() - Constructor for class org.springframework.ai.chat.memory.repository.jdbc.SqlServerChatMemoryRepositoryDialect

Deprecated.

SSE - Enum constant in enum class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.ServerProtocol

sseEndpoint() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpSseClientProperties.SseParameters

Deprecated.

Returns the value of the sseEndpoint record component.

sseEndpoint(String) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport.Builder

Deprecated.

Sets the SSE endpoint path.

sseEndpoint(String) - Method in class org.springframework.ai.mcp.server.webflux.transport.WebFluxSseServerTransportProvider.Builder

Deprecated.

Sets the SSE endpoint path.

sseEndpoint(String) - Method in class org.springframework.ai.mcp.server.webmvc.transport.WebMvcSseServerTransportProvider.Builder

Deprecated.

Sets the endpoint path where clients will establish SSE connections.

SseHttpClientTransportAutoConfiguration - Class in org.springframework.ai.mcp.client.httpclient.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

SseHttpClientTransportAutoConfiguration() - Constructor for class org.springframework.ai.mcp.client.httpclient.autoconfigure.SseHttpClientTransportAutoConfiguration

Deprecated.

sseHttpClientTransports(McpSseClientConnectionDetails, ObjectProvider<JsonMapper>, ObjectProvider<McpClientCustomizer<HttpClientSseClientTransport.Builder>>) - Method in class org.springframework.ai.mcp.client.httpclient.autoconfigure.SseHttpClientTransportAutoConfiguration

Deprecated.

Creates a list of HTTP client-based SSE transports for MCP communication.

SseParameters(String, String) - Constructor for record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpSseClientProperties.SseParameters

Deprecated.

Creates an instance of a SseParameters record class.

sseWebFluxClientTransports(McpSseClientConnectionDetails, ObjectProvider<WebClient.Builder>, ObjectProvider<JsonMapper>, ObjectProvider<McpClientCustomizer<WebFluxSseClientTransport.Builder>>) - Method in class org.springframework.ai.mcp.client.webflux.autoconfigure.SseWebFluxTransportAutoConfiguration

Deprecated.

Creates a list of WebFlux-based SSE transports for MCP communication.

SseWebFluxTransportAutoConfiguration - Class in org.springframework.ai.mcp.client.webflux.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

SseWebFluxTransportAutoConfiguration() - Constructor for class org.springframework.ai.mcp.client.webflux.autoconfigure.SseWebFluxTransportAutoConfiguration

Deprecated.

sslEnabled(boolean) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

Sets whether SSL is enabled for the connection.

sslSocketFactory(SSLSocketFactory) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

sslSocketFactory(SSLSocketFactory) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

stability() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.VoiceSettings

Returns the value of the stability record component.

stability() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSettings

Returns the value of the stability record component.

STABILITY_AI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider

AI system provided by Stability AI.

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

stabilityAiApi(StabilityAiConnectionProperties, StabilityAiImageProperties, ObjectProvider<RestClient.Builder>) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageAutoConfiguration

StabilityAiApi - Class in org.springframework.ai.stabilityai.api

Represents the StabilityAI API.

StabilityAiApi(String) - Constructor for class org.springframework.ai.stabilityai.api.StabilityAiApi

Create a new StabilityAI API.

StabilityAiApi(String, String) - Constructor for class org.springframework.ai.stabilityai.api.StabilityAiApi

StabilityAiApi(String, String, String) - Constructor for class org.springframework.ai.stabilityai.api.StabilityAiApi

StabilityAiApi(String, String, String, RestClient.Builder) - Constructor for class org.springframework.ai.stabilityai.api.StabilityAiApi

Create a new StabilityAI API.

StabilityAiApi.GenerateImageRequest - Record Class in org.springframework.ai.stabilityai.api

StabilityAiApi.GenerateImageRequest.Builder - Class in org.springframework.ai.stabilityai.api

StabilityAiApi.GenerateImageRequest.TextPrompts - Record Class in org.springframework.ai.stabilityai.api

StabilityAiApi.GenerateImageResponse - Record Class in org.springframework.ai.stabilityai.api

StabilityAiApi.GenerateImageResponse.Artifacts - Record Class in org.springframework.ai.stabilityai.api

StabilityAiConnectionProperties - Class in org.springframework.ai.model.stabilityai.autoconfigure

StabilityAiConnectionProperties() - Constructor for class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiConnectionProperties

StabilityAiImageAutoConfiguration - Class in org.springframework.ai.model.stabilityai.autoconfigure

Auto-configuration for StabilityAI Image Model.

StabilityAiImageAutoConfiguration() - Constructor for class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageAutoConfiguration

StabilityAiImageGenerationMetadata - Class in org.springframework.ai.stabilityai

Represents metadata associated with the image generation process in the StabilityAI framework.

StabilityAiImageGenerationMetadata(String, Long) - Constructor for class org.springframework.ai.stabilityai.StabilityAiImageGenerationMetadata

stabilityAiImageModel(StabilityAiApi, StabilityAiImageProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<ImageModelObservationConvention>) - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageAutoConfiguration

StabilityAiImageModel - Class in org.springframework.ai.stabilityai

StabilityAiImageModel is a class that implements the ImageModel interface.

StabilityAiImageModel(StabilityAiApi) - Constructor for class org.springframework.ai.stabilityai.StabilityAiImageModel

StabilityAiImageModel(StabilityAiApi, StabilityAiImageOptions) - Constructor for class org.springframework.ai.stabilityai.StabilityAiImageModel

StabilityAiImageModel(StabilityAiApi, StabilityAiImageOptions, ObservationRegistry) - Constructor for class org.springframework.ai.stabilityai.StabilityAiImageModel

Creates a model that reports its calls to the given observation registry.

StabilityAiImageOptions - Class in org.springframework.ai.stabilityai.api

StabilityAiImageOptions is an interface that extends ImageOptions.

StabilityAiImageOptions(Integer, String, Integer, Integer, String, Float, String, String, Long, Integer, String) - Constructor for class org.springframework.ai.stabilityai.api.StabilityAiImageOptions

StabilityAiImageOptions.Builder - Class in org.springframework.ai.stabilityai.api

StabilityAiImageProperties - Class in org.springframework.ai.model.stabilityai.autoconfigure

Configuration properties for Stability AI image model.

StabilityAiImageProperties() - Constructor for class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

StabilityAiImageProperties.Options - Class in org.springframework.ai.model.stabilityai.autoconfigure

stamp(MessagePart) - Method in class org.springframework.ai.chat.messages.part.StreamingPartIndexer

Returns a copy of the part with its stream index set, and advances this indexer.

STANDARD - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiServiceTier

The standard service tier.

STANDARD_ONLY - Enum constant in enum class org.springframework.ai.anthropic.AnthropicServiceTier

Always use standard capacity.

STARLING_LM - Enum constant in enum class org.springframework.ai.ollama.api.OllamaModel

Starling-7B model

START - Enum constant in enum class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest.Truncate

Discards the start of the input.

startDelimiterToken(char) - Method in class org.springframework.ai.template.st.StTemplateRenderer.Builder

Sets the character used as the start delimiter for template expressions.

startOffsetSec - Variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

The start offset of the video segment in seconds.

startOffsetSec(Integer) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

startPageNumber() - Method in record class org.springframework.ai.reader.pdf.config.ParagraphManager.Paragraph

Returns the value of the startPageNumber record component.

state() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns the value of the state record component.

STATELESS - Enum constant in enum class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.ServerProtocol

statelessCompleteSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

statelessCompleteSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

statelessPromptSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

statelessPromptSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

statelessResourceSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

statelessResourceSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

statelessResourceTemplateSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

statelessResourceTemplateSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

StatelessServerSpecificationFactoryAutoConfiguration - Class in org.springframework.ai.mcp.server.common.autoconfigure.annotations

StatelessServerSpecificationFactoryAutoConfiguration() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.annotations.StatelessServerSpecificationFactoryAutoConfiguration

StatelessToolCallbackConverterAutoConfiguration - Class in org.springframework.ai.mcp.server.common.autoconfigure

StatelessToolCallbackConverterAutoConfiguration() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.StatelessToolCallbackConverterAutoConfiguration

StatelessToolCallbackConverterAutoConfiguration.ToolCallbackConverterCondition - Class in org.springframework.ai.mcp.server.common.autoconfigure

statelessToolSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

statelessToolSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

StaticToolCallbackProvider - Class in org.springframework.ai.tool

A simple implementation of ToolCallbackProvider that maintains a static array of ToolCallback objects.

StaticToolCallbackProvider(List<? extends ToolCallback>) - 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<ToolCallback>) - Constructor for class org.springframework.ai.tool.resolution.StaticToolCallbackResolver

status() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the status record component.

status() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ProgressResponse

Returns the value of the status record component.

status(String, String) - Static method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

A status event, the simplest event that is not a message.

STATUS - Static variable in class org.springframework.ai.openai.responses.OpenAiResponsesMetadata

The response status: completed, incomplete, failed, ...

stdioServerTransport(JsonMapper) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.McpServerAutoConfiguration

StdioTransportAutoConfiguration - Class in org.springframework.ai.mcp.client.common.autoconfigure

Auto-configuration for Standard Input/Output (stdio) transport in the Model Context Protocol (MCP).

StdioTransportAutoConfiguration() - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.StdioTransportAutoConfiguration

stdioTransports(McpStdioClientProperties) - Method in class org.springframework.ai.mcp.client.common.autoconfigure.StdioTransportAutoConfiguration

Creates a list of stdio-based transports for MCP communication.

StepBuilder() - Constructor for class org.springframework.ai.vectorstore.pinecone.PineconeVectorStore.Builder.StepBuilder

steps() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

Returns the value of the steps record component.

steps(Integer) - Method in class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.Builder

steps(Integer) - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions.Builder

STL_SORT - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

stop() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the stop record component.

stop() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the stop record component.

stop(List<String>) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set the stop sequences.

stop(List<String>) - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

stop(List<String>) - Method in class org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder

stop(List<String>) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

stop(List<String>) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

STOP - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionFinishReason

The model hit a natural stop point or a provided stop sequence.

STOP - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.FinishReason

The model hit a natural stop point or a provided stop sequence.

stopSequences - Variable in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

stopSequences - Variable in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

stopSequences(List<String>) - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder

Builds with the stop sequences to use for the chat.

stopSequences(List<String>) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

stopSequences(List<String>) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

stopSequences(List<String>) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

stopSequences(List<String>) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

stopSequences(String...) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

stopSequences(String...) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

stopwords(Set<String>) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the stopwords for text search.

store - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

store - Variable in class org.springframework.ai.vectorstore.SimpleVectorStore

store(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

strategy() - Method in record class org.springframework.ai.session.compaction.CompactionBoundary

Returns the value of the strategy record component.

strategy() - Method in record class org.springframework.ai.session.compaction.CompactionResult

Returns the value of the strategy record component.

strategy(AnthropicCacheStrategy) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder

strategy(BedrockCacheStrategy) - Method in class org.springframework.ai.bedrock.converse.api.BedrockCacheOptions.Builder

Sets the caching strategy.

stream() - Method in class org.springframework.ai.bedrock.converse.api.ConverseChatResponseStream

Invoke the model and return the chat response stream.

stream() - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

stream() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

stream() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the stream record component.

stream() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the stream record component.

stream() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest

Returns the value of the stream record component.

stream() - Method in record class org.springframework.ai.ollama.api.OllamaApi.PullModelRequest

Returns the value of the stream record component.

stream(boolean) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder

stream(boolean) - Method in class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

stream(Boolean) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set whether to stream the response.

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(AudioTranscriptionPrompt) - Method in interface org.springframework.ai.audio.transcription.StreamingTranscriptionModel

Streams a transcription request to the model, returning the transcription results incrementally as they become available.

stream(AudioTranscriptionPrompt) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiTranscriptionModel

stream(AudioTranscriptionPrompt) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionModel

stream(TextToSpeechPrompt) - Method in interface org.springframework.ai.audio.tts.StreamingTextToSpeechModel

stream(TextToSpeechPrompt) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel

stream(TextToSpeechPrompt) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiTextToSpeechModel

The Google GenAI SDK returns the full audio blob in a single response; true chunked streaming is not supported by the Gemini-TTS API.

stream(TextToSpeechPrompt) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel

stream(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

stream(Message...) - Method in interface org.springframework.ai.chat.model.StreamingChatModel

stream(Prompt) - Method in class org.springframework.ai.anthropic.AnthropicChatModel

Streams the chat completion as a Flux of ChatResponse events.

stream(Prompt) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel

Invoke the model and return the response stream.

stream(Prompt) - Method in interface org.springframework.ai.chat.model.ChatModel

stream(Prompt) - Method in interface org.springframework.ai.chat.model.StreamingChatModel

stream(Prompt) - Method in class org.springframework.ai.deepseek.DeepSeekChatModel

stream(Prompt) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatModel

stream(Prompt) - Method in class org.springframework.ai.mistralai.MistralAiChatModel

stream(Prompt) - Method in class org.springframework.ai.ollama.OllamaChatModel

stream(Prompt) - Method in class org.springframework.ai.openai.OpenAiChatModel

stream(Prompt) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatModel

stream(TReq) - Method in interface org.springframework.ai.model.StreamingModel

Executes a method call to the AI model.

STREAM - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.LowCardinalityKeyNames

Is the chat model response a stream.

STREAMABLE - Enum constant in enum class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.ServerProtocol

StreamableHttpHttpClientTransportAutoConfiguration - Class in org.springframework.ai.mcp.client.httpclient.autoconfigure

Auto-configuration for Streamable HTTP client transport in the Model Context Protocol (MCP).

StreamableHttpHttpClientTransportAutoConfiguration() - Constructor for class org.springframework.ai.mcp.client.httpclient.autoconfigure.StreamableHttpHttpClientTransportAutoConfiguration

streamableHttpHttpClientTransports(McpStreamableHttpClientProperties, ObjectProvider<JsonMapper>, ObjectProvider<McpSyncHttpClientRequestCustomizer>, ObjectProvider<McpAsyncHttpClientRequestCustomizer>, ObjectProvider<McpClientCustomizer<HttpClientStreamableHttpTransport.Builder>>) - Method in class org.springframework.ai.mcp.client.httpclient.autoconfigure.StreamableHttpHttpClientTransportAutoConfiguration

Creates a list of HTTP client-based Streamable HTTP transports for MCP communication.

streamableHttpWebFluxClientTransports(McpStreamableHttpClientProperties, ObjectProvider<WebClient.Builder>, ObjectProvider<JsonMapper>, ObjectProvider<McpClientCustomizer<WebClientStreamableHttpTransport.Builder>>) - Method in class org.springframework.ai.mcp.client.webflux.autoconfigure.StreamableHttpWebFluxTransportAutoConfiguration

Creates a list of WebFlux-based Streamable HTTP transports for MCP communication.

StreamableHttpWebFluxTransportAutoConfiguration - Class in org.springframework.ai.mcp.client.webflux.autoconfigure

Auto-configuration for WebFlux-based Streamable HTTP client transport in the Model Context Protocol (MCP).

StreamableHttpWebFluxTransportAutoConfiguration() - Constructor for class org.springframework.ai.mcp.client.webflux.autoconfigure.StreamableHttpWebFluxTransportAutoConfiguration

StreamAdvisor - Interface in org.springframework.ai.chat.client.advisor.api

Advisor for execution flows ultimately resulting in a streaming call to an AI model.

StreamAdvisorChain - Interface in org.springframework.ai.chat.client.advisor.api

A chain of StreamAdvisor instances orchestrating the execution of a ChatClientRequest on the next StreamAdvisor in the chain.

streaming(boolean) - Method in class org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationContext.Builder

Marks the request as made in streaming mode.

streaming(boolean) - Method in class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationContext.Builder

Marks the request as made in streaming mode.

streaming(boolean) - Method in class org.springframework.ai.chat.observation.ChatModelObservationContext.Builder

streamingChat(OllamaApi.ChatRequest) - Method in class org.springframework.ai.ollama.api.OllamaApi

Streaming response for the chat completion request.

StreamingChatModel - Interface in org.springframework.ai.chat.model

StreamingModel<TReq extends ModelRequest<?>,TResChunk extends ModelResponse<?>> - Interface in org.springframework.ai.model

The StreamingModel interface provides a generic API for invoking an AI models with streaming response.

StreamingPartIndexer - Class in org.springframework.ai.chat.messages.part

Synthesizes the StreamingParts index for providers that stream message content without a content block index, so that MessageAggregator can rebuild the complete parts from the chunks.

StreamingPartIndexer() - Constructor for class org.springframework.ai.chat.messages.part.StreamingPartIndexer

StreamingParts - Class in org.springframework.ai.chat.messages.part

Transport attributes that let a streaming chat model deliver a message part in increments and let MessageAggregator rebuild the ordered parts list.

StreamingTextToSpeechModel - Interface in org.springframework.ai.audio.tts

Interface for the streaming text to speech model.

StreamingToolCallBuilder - Class in org.springframework.ai.bedrock.converse.api

StreamingToolCallBuilder() - Constructor for class org.springframework.ai.bedrock.converse.api.StreamingToolCallBuilder

StreamingTranscriptionModel - Interface in org.springframework.ai.audio.transcription

Interface for the streaming transcription model.

streamOptions - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

streamOptions(OpenAiChatOptions.StreamOptions) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

StreamOptions(Boolean, Boolean, Map<String, Object>) - Constructor for record class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions

Creates an instance of a StreamOptions record class.

streamScheduler(Scheduler) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechModel.Builder

Sets the Scheduler for OpenAiAudioSpeechModel.stream(TextToSpeechPrompt).

streamTranscribe(Resource) - Method in interface org.springframework.ai.audio.transcription.StreamingTranscriptionModel

A convenience method for streaming the transcription of an audio resource.

streamTranscribe(Resource, AudioTranscriptionOptions) - Method in interface org.springframework.ai.audio.transcription.StreamingTranscriptionModel

A convenience method for streaming the transcription of an audio resource with the given options.

streamUsage(boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

strict - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

strict - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

strict(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat.Builder

Whether to enable strict schema adherence for JSON schema response format.

strict(Boolean) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

Whether to enable OpenAI Tool/Function calling strict mode.

strict(Boolean) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

strict(Boolean) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema.Builder

stringFrom(Map<String, Object>) - Method in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolCallAttributes

Deprecated.

Extract and return this required attribute from the provided map, as a String.

stringToMimeTypeConverter() - Method in class org.springframework.ai.vectorstore.mongodb.autoconfigure.MongoDBAtlasVectorStoreAutoConfiguration

strip(MessagePart) - Static method in class org.springframework.ai.chat.messages.part.StreamingParts

Removes the streaming attributes from a part.

STRUCTURED - Enum constant in enum class org.springframework.ai.mcp.annotation.method.tool.ReturnMode

STRUCTURED_OUTPUT_NATIVE - Enum constant in enum class org.springframework.ai.chat.client.ChatClientAttributes

STRUCTURED_OUTPUT_SCHEMA - Enum constant in enum class org.springframework.ai.chat.client.ChatClientAttributes

structuredContent() - Method in record class org.springframework.ai.mcp.annotation.context.StructuredElicitResult

Returns the value of the structuredContent record component.

structuredContent(U) - Method in class org.springframework.ai.mcp.annotation.context.StructuredElicitResult.Builder

Sets the structured content.

StructuredElicitResult<T> - Record Class in org.springframework.ai.mcp.annotation.context

A record representing the result of a structured elicit action.

StructuredElicitResult(McpSchema.ElicitResult.Action, T, Map<String, Object>) - Constructor for record class org.springframework.ai.mcp.annotation.context.StructuredElicitResult

Creates an instance of a StructuredElicitResult record class.

StructuredElicitResult.Builder<T> - Class in org.springframework.ai.mcp.annotation.context

StructuredOutputChatOptions - Interface in org.springframework.ai.model.tool

Mixin interface for ChatModels that support structured output.

StructuredOutputChatOptions.Builder<B extends StructuredOutputChatOptions.Builder<B>> - Interface in org.springframework.ai.model.tool

StructuredOutputConverter<T> - Interface in org.springframework.ai.converter

Converts the (raw) LLM output into a structured responses of type.

StructuredOutputValidationAdvisor - Class in org.springframework.ai.chat.client.advisor

Advisor that validates the structured JSON output of a chat client response against a JSON schema derived from the configured output type or a pre-supplied schema string.

StructuredOutputValidationAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor

Builder for StructuredOutputValidationAdvisor.

StTemplateRenderer - Class in org.springframework.ai.template.st

Renders a template using the StringTemplate (ST) v4 library.

StTemplateRenderer(char, char, ValidationMode, boolean) - Constructor for class org.springframework.ai.template.st.StTemplateRenderer

Constructs a new StTemplateRenderer with the specified delimiter tokens, validation mode, and function validation flag.

StTemplateRenderer.Builder - Class in org.springframework.ai.template.st

Builder for configuring and creating StTemplateRenderer instances.

style() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.VoiceSettings

Returns the value of the style record component.

style() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSettings

Returns the value of the style record component.

style(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder

style(String) - Method in class org.springframework.ai.image.ImageOptionsBuilder

StyleEnum - Enum Class in org.springframework.ai.stabilityai

Enum representing different styles for images.

stylePreset() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

Returns the value of the stylePreset record component.

stylePreset(String) - Method in class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.Builder

stylePreset(String) - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions.Builder

stylePreset(StyleEnum) - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions.Builder

stylePrompt(String) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.Builder

successCount() - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingResponse

Returns the value of the successCount record component.

summarize(SummaryRequest) - Method in class org.springframework.ai.session.compaction.ChatModelSummarizer

summarize(SummaryRequest) - Method in interface org.springframework.ai.session.compaction.CompactionSummarizer

Summarizes the events that leave the view.

summarizer(CompactionSummarizer) - Method in class org.springframework.ai.session.compaction.WindowCompactionStrategy.Builder

The summarizer that condenses the covered turns into a summary turn; none by default, so the covered turns leave the view without a stand-in.

summary() - Method in record class org.springframework.ai.chat.messages.part.ReasoningPart

Returns the value of the summary record component.

summary() - Method in record class org.springframework.ai.session.compaction.CompactionResult

Returns the value of the summary record component.

summary() - Method in record class org.springframework.ai.tool.toolsearch.ToolReference

Returns the value of the summary record component.

summary(String) - Method in class org.springframework.ai.tool.toolsearch.ToolReference.Builder

summaryEventIds() - Method in record class org.springframework.ai.session.compaction.CompactionBoundary

Returns the value of the summaryEventIds record component.

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<SummaryMetadataEnricher.SummaryType>) - Constructor for class org.springframework.ai.model.transformer.SummaryMetadataEnricher

SummaryMetadataEnricher(ChatModel, List<SummaryMetadataEnricher.SummaryType>, String, MetadataMode) - Constructor for class org.springframework.ai.model.transformer.SummaryMetadataEnricher

SummaryMetadataEnricher.SummaryType - Enum Class in org.springframework.ai.model.transformer

SummaryRequest - Record Class in org.springframework.ai.session.compaction

What a CompactionSummarizer is asked to summarize.

SummaryRequest(Session, List<SessionEvent>, List<SessionEvent>, List<SessionEvent>) - Constructor for record class org.springframework.ai.session.compaction.SummaryRequest

Creates an instance of a SummaryRequest record class.

summaryTurn(String, String) - Static method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

A synthetic shadow-prompt + summary pair, as the summarizing strategy produces.

supportedProtocolVersions(List<String>) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebClientStreamableHttpTransport.Builder

Sets the list of supported protocol versions used in version negotiation.

supportsContext(Observation.Context) - Method in class org.springframework.ai.audio.transcription.observation.TranscriptionModelMeterObservationHandler

supportsContext(Observation.Context) - Method in interface org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationConvention

supportsContext(Observation.Context) - Method in class org.springframework.ai.audio.transcription.observation.TranscriptionModelTranscriptObservationHandler

supportsContext(Observation.Context) - Method in class org.springframework.ai.audio.tts.observation.TextToSpeechModelMeterObservationHandler

supportsContext(Observation.Context) - Method in interface org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationConvention

supportsContext(Observation.Context) - Method in class org.springframework.ai.audio.tts.observation.TextToSpeechModelTextContentObservationHandler

supportsContext(Observation.Context) - Method in interface org.springframework.ai.chat.client.advisor.observation.AdvisorObservationConvention

supportsContext(Observation.Context) - Method in class org.springframework.ai.chat.client.observation.ChatClientCompletionObservationHandler

supportsContext(Observation.Context) - Method in interface org.springframework.ai.chat.client.observation.ChatClientObservationConvention

supportsContext(Observation.Context) - Method in class org.springframework.ai.chat.client.observation.ChatClientPromptContentObservationHandler

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 class org.springframework.ai.observation.TracingAwareLoggingObservationHandler

supportsContext(Observation.Context) - Method in interface org.springframework.ai.tool.observation.ToolCallingObservationConvention

supportsContext(Observation.Context) - Method in interface org.springframework.ai.vectorstore.observation.VectorStoreObservationConvention

supportsContext(Observation.Context) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreQueryResponseObservationHandler

supportsParts() - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder

Whether AssistantMessage.Builder.build() of this builder honors AssistantMessage.Builder.part(MessagePart), AssistantMessage.Builder.parts(List) and AssistantMessage.Builder.reasoning(ReasoningPart).

supportsParts() - Method in class org.springframework.ai.deepseek.DeepSeekAssistantMessage.AbstractBuilder

Deprecated.

supportsQueryEmbeddingSearch() - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore

supportsQueryEmbeddingSearch() - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

Tells whether this store implements AbstractObservationVectorStore.doSimilaritySearch(float[], SearchRequest).

supportsQueryEmbeddingSearch() - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

supportsQueryEmbeddingSearch() - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

supportsQueryEmbeddingSearch() - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

supportsQueryEmbeddingSearch() - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

supportsUpsert() - Method in class org.springframework.ai.vectorstore.elasticsearch.ElasticsearchVectorStore

supportsUpsert() - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

Tells whether this store implements AbstractObservationVectorStore.doUpsert(List).

supportsUpsert() - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

supportsUpsert() - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore

supportsUpsert() - Method in class org.springframework.ai.vectorstore.qdrant.QdrantVectorStore

supportsUpsert() - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore

SYNC - Enum constant in enum class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties.ClientType

Synchronous (McpSyncClient) client

SYNC - Enum constant in enum class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.ApiType

Synchronous (McpSyncServer) server

SyncElicitationSpecification - Record Class in org.springframework.ai.mcp.annotation.method.elicitation

SyncElicitationSpecification(String[], Function<McpSchema.ElicitRequest, McpSchema.ElicitResult>) - Constructor for record class org.springframework.ai.mcp.annotation.method.elicitation.SyncElicitationSpecification

Creates an instance of a SyncElicitationSpecification record class.

SyncLoggingSpecification - Record Class in org.springframework.ai.mcp.annotation.method.logging

SyncLoggingSpecification(String[], Consumer<McpSchema.LoggingMessageNotification>) - Constructor for record class org.springframework.ai.mcp.annotation.method.logging.SyncLoggingSpecification

Creates an instance of a SyncLoggingSpecification record class.

SyncMcpAnnotationProviders - Class in org.springframework.ai.mcp.annotation.spring

SyncMcpCompleteMethodCallback - Class in org.springframework.ai.mcp.annotation.method.complete

Class for creating BiFunction callbacks around complete methods.

SyncMcpCompleteMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.complete

Builder for creating SyncMcpCompleteMethodCallback instances.

SyncMcpCompleteProvider - Class in org.springframework.ai.mcp.annotation.provider.complete

SyncMcpCompleteProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.complete.SyncMcpCompleteProvider

SyncMcpElicitationMethodCallback - Class in org.springframework.ai.mcp.annotation.method.elicitation

Class for creating Function callbacks around elicitation methods.

SyncMcpElicitationMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.elicitation

Builder for creating SyncMcpElicitationMethodCallback instances.

SyncMcpElicitationProvider - Class in org.springframework.ai.mcp.annotation.provider.elicitation

Provider for synchronous elicitation callbacks.

SyncMcpElicitationProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.elicitation.SyncMcpElicitationProvider

Create a new SyncMcpElicitationProvider.

SyncMcpLoggingMethodCallback - Class in org.springframework.ai.mcp.annotation.method.logging

Class for creating Consumer callbacks around logging consumer methods.

SyncMcpLoggingMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.logging

Builder for creating SyncMcpLoggingConsumerMethodCallback instances.

SyncMcpLoggingProvider - Class in org.springframework.ai.mcp.annotation.provider.logging

Provider for synchronous logging consumer callbacks.

SyncMcpLoggingProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.logging.SyncMcpLoggingProvider

Create a new SyncMcpLoggingConsumerProvider.

SyncMcpLogginProvider - Class in org.springframework.ai.mcp.annotation.provider.logging

Deprecated.

Use SyncMcpLoggingProvider instead.

SyncMcpLogginProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.logging.SyncMcpLogginProvider

Deprecated.

Create a new SyncMcpLoggingConsumerProvider.

SyncMcpProgressMethodCallback - Class in org.springframework.ai.mcp.annotation.method.progress

Synchronous implementation of a progress method callback.

SyncMcpProgressMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.progress

Builder for creating SyncMcpProgressMethodCallback instances.

SyncMcpProgressProvider - Class in org.springframework.ai.mcp.annotation.provider.progress

Provider for synchronous progress callbacks.

SyncMcpProgressProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.progress.SyncMcpProgressProvider

Create a new SyncMcpProgressProvider.

SyncMcpPromptListChangedMethodCallback - Class in org.springframework.ai.mcp.annotation.method.changed.prompt

Class for creating Consumer callbacks around prompt list changed consumer methods.

SyncMcpPromptListChangedMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.changed.prompt

Builder for creating SyncMcpPromptListChangedMethodCallback instances.

SyncMcpPromptListChangedProvider - Class in org.springframework.ai.mcp.annotation.provider.changed.prompt

Provider for synchronous prompt list changed consumer callbacks.

SyncMcpPromptListChangedProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.changed.prompt.SyncMcpPromptListChangedProvider

Create a new SyncMcpPromptListChangedProvider.

SyncMcpPromptMethodCallback - Class in org.springframework.ai.mcp.annotation.method.prompt

Class for creating BiFunction callbacks around prompt methods.

SyncMcpPromptMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.prompt

Builder for creating SyncMcpPromptMethodCallback instances.

SyncMcpPromptProvider - Class in org.springframework.ai.mcp.annotation.provider.prompt

SyncMcpPromptProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.prompt.SyncMcpPromptProvider

SyncMcpResourceListChangedMethodCallback - Class in org.springframework.ai.mcp.annotation.method.changed.resource

Class for creating Consumer callbacks around resource list changed consumer methods.

SyncMcpResourceListChangedMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.changed.resource

Builder for creating SyncMcpResourceListChangedMethodCallback instances.

SyncMcpResourceListChangedProvider - Class in org.springframework.ai.mcp.annotation.provider.changed.resource

Provider for synchronous resource list changed consumer callbacks.

SyncMcpResourceListChangedProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.changed.resource.SyncMcpResourceListChangedProvider

Create a new SyncMcpResourceListChangedProvider.

SyncMcpResourceMethodCallback - Class in org.springframework.ai.mcp.annotation.method.resource

Class for creating BiFunction callbacks around resource methods.

SyncMcpResourceMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.resource

Builder for creating SyncMcpResourceMethodCallback instances.

SyncMcpResourceProvider - Class in org.springframework.ai.mcp.annotation.provider.resource

SyncMcpResourceProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.resource.SyncMcpResourceProvider

SyncMcpSamplingMethodCallback - Class in org.springframework.ai.mcp.annotation.method.sampling

Class for creating Function callbacks around sampling methods.

SyncMcpSamplingMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.sampling

Builder for creating SyncMcpSamplingMethodCallback instances.

SyncMcpSamplingProvider - Class in org.springframework.ai.mcp.annotation.provider.sampling

Provider for synchronous sampling callbacks.

SyncMcpSamplingProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.sampling.SyncMcpSamplingProvider

Create a new SyncMcpSamplingProvider.

SyncMcpToolCallback - Class in org.springframework.ai.mcp

Synchronous adapter bridging MCP tools to Spring AI's ToolCallback interface.

SyncMcpToolCallback(McpSyncClient, McpSchema.Tool) - Constructor for class org.springframework.ai.mcp.SyncMcpToolCallback

Deprecated.

use SyncMcpToolCallback.builder() instead

SyncMcpToolCallback.Builder - Class in org.springframework.ai.mcp

Builder for SyncMcpToolCallback instances.

SyncMcpToolCallbackProvider - Class in org.springframework.ai.mcp

Provides Spring AI tool callbacks by discovering tools from MCP servers.

SyncMcpToolCallbackProvider(McpSyncClient...) - Constructor for class org.springframework.ai.mcp.SyncMcpToolCallbackProvider

Deprecated.

use SyncMcpToolCallbackProvider.builder() instead

SyncMcpToolCallbackProvider(List<McpSyncClient>) - Constructor for class org.springframework.ai.mcp.SyncMcpToolCallbackProvider

Deprecated.

use SyncMcpToolCallbackProvider.builder() instead

SyncMcpToolCallbackProvider(McpToolFilter, List<McpSyncClient>) - Constructor for class org.springframework.ai.mcp.SyncMcpToolCallbackProvider

Deprecated.

use SyncMcpToolCallbackProvider.builder() instead

SyncMcpToolCallbackProvider(McpToolFilter, McpToolNamePrefixGenerator, McpSyncClient...) - Constructor for class org.springframework.ai.mcp.SyncMcpToolCallbackProvider

Deprecated.

use SyncMcpToolCallbackProvider.builder() instead

SyncMcpToolCallbackProvider.Builder - Class in org.springframework.ai.mcp

Builder for SyncMcpToolCallbackProvider.

SyncMcpToolListChangedMethodCallback - Class in org.springframework.ai.mcp.annotation.method.changed.tool

Class for creating Consumer callbacks around tool list changed consumer methods.

SyncMcpToolListChangedMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.changed.tool

Builder for creating SyncMcpToolListChangedMethodCallback instances.

SyncMcpToolListChangedProvider - Class in org.springframework.ai.mcp.annotation.provider.changed.tool

Provider for synchronous tool list changed consumer callbacks.

SyncMcpToolListChangedProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.changed.tool.SyncMcpToolListChangedProvider

Create a new SyncMcpToolListChangedProvider.

SyncMcpToolMethodCallback - Class in org.springframework.ai.mcp.annotation.method.tool

Class for creating Function callbacks around tool methods.

SyncMcpToolMethodCallback(ReturnMode, Method, Object) - Constructor for class org.springframework.ai.mcp.annotation.method.tool.SyncMcpToolMethodCallback

SyncMcpToolMethodCallback(ReturnMode, Method, Object, Class<? extends Throwable>) - Constructor for class org.springframework.ai.mcp.annotation.method.tool.SyncMcpToolMethodCallback

Deprecated.

use SyncMcpToolMethodCallback(ReturnMode, java.lang.reflect.Method, Object). The toolCallExceptionClass argument is ignored: exception handling now follows the @Tool contract based on the exception type. Will be removed in 2.1.0.

SyncMcpToolProvider - Class in org.springframework.ai.mcp.annotation.provider.tool

SyncMcpToolProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.tool.SyncMcpToolProvider

Create a new SyncMcpToolProvider.

SyncProgressSpecification - Record Class in org.springframework.ai.mcp.annotation.method.progress

Specification for synchronous progress handlers.

SyncProgressSpecification(String[], Consumer<McpSchema.ProgressNotification>) - Constructor for record class org.springframework.ai.mcp.annotation.method.progress.SyncProgressSpecification

Creates an instance of a SyncProgressSpecification record class.

SyncPromptListChangedSpecification - Record Class in org.springframework.ai.mcp.annotation.method.changed.prompt

SyncPromptListChangedSpecification(String[], Consumer<List<McpSchema.Prompt>>) - Constructor for record class org.springframework.ai.mcp.annotation.method.changed.prompt.SyncPromptListChangedSpecification

Creates an instance of a SyncPromptListChangedSpecification record class.

SyncResourceListChangedSpecification - Record Class in org.springframework.ai.mcp.annotation.method.changed.resource

SyncResourceListChangedSpecification(String[], Consumer<List<McpSchema.Resource>>) - Constructor for record class org.springframework.ai.mcp.annotation.method.changed.resource.SyncResourceListChangedSpecification

Creates an instance of a SyncResourceListChangedSpecification record class.

SyncSamplingSpecification - Record Class in org.springframework.ai.mcp.annotation.method.sampling

SyncSamplingSpecification(String[], Function<McpSchema.CreateMessageRequest, McpSchema.CreateMessageResult>) - Constructor for record class org.springframework.ai.mcp.annotation.method.sampling.SyncSamplingSpecification

Creates an instance of a SyncSamplingSpecification record class.

SyncStatelessMcpCompleteMethodCallback - Class in org.springframework.ai.mcp.annotation.method.complete

Class for creating BiFunction callbacks around complete methods for stateless contexts.

SyncStatelessMcpCompleteMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.complete

Builder for creating SyncStatelessMcpCompleteMethodCallback instances.

SyncStatelessMcpCompleteProvider - Class in org.springframework.ai.mcp.annotation.provider.complete

Provider for synchronous stateless MCP complete methods.

SyncStatelessMcpCompleteProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.complete.SyncStatelessMcpCompleteProvider

Create a new SyncStatelessMcpCompleteProvider.

SyncStatelessMcpPromptMethodCallback - Class in org.springframework.ai.mcp.annotation.method.prompt

Class for creating BiFunction callbacks around prompt methods for stateless contexts.

SyncStatelessMcpPromptMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.prompt

Builder for creating SyncStatelessMcpPromptMethodCallback instances.

SyncStatelessMcpPromptProvider - Class in org.springframework.ai.mcp.annotation.provider.prompt

Provider for synchronous stateless MCP prompt methods.

SyncStatelessMcpPromptProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.prompt.SyncStatelessMcpPromptProvider

Create a new SyncStatelessMcpPromptProvider.

SyncStatelessMcpResourceMethodCallback - Class in org.springframework.ai.mcp.annotation.method.resource

Class for creating BiFunction callbacks around resource methods for stateless contexts.

SyncStatelessMcpResourceMethodCallback.Builder - Class in org.springframework.ai.mcp.annotation.method.resource

Builder for creating SyncStatelessMcpResourceMethodCallback instances.

SyncStatelessMcpResourceProvider - Class in org.springframework.ai.mcp.annotation.provider.resource

Provider for synchronous stateless MCP resource methods.

SyncStatelessMcpResourceProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.resource.SyncStatelessMcpResourceProvider

Create a new SyncStatelessMcpResourceProvider.

SyncStatelessMcpToolMethodCallback - Class in org.springframework.ai.mcp.annotation.method.tool

Class for creating Function callbacks around tool methods.

SyncStatelessMcpToolMethodCallback(ReturnMode, Method, Object) - Constructor for class org.springframework.ai.mcp.annotation.method.tool.SyncStatelessMcpToolMethodCallback

SyncStatelessMcpToolMethodCallback(ReturnMode, Method, Object, Class<? extends Throwable>) - Constructor for class org.springframework.ai.mcp.annotation.method.tool.SyncStatelessMcpToolMethodCallback

Deprecated.

use SyncStatelessMcpToolMethodCallback(ReturnMode, java.lang.reflect.Method, Object). The toolCallExceptionClass argument is ignored: exception handling now follows the @Tool contract based on the exception type. Will be removed in 2.1.0.

SyncStatelessMcpToolProvider - Class in org.springframework.ai.mcp.annotation.provider.tool

Provider for synchronous stateless MCP tool methods.

SyncStatelessMcpToolProvider(List<Object>) - Constructor for class org.springframework.ai.mcp.annotation.provider.tool.SyncStatelessMcpToolProvider

Create a new SyncStatelessMcpToolProvider.

syncToolCallbacks(List<McpSyncClient>) - Static method in class org.springframework.ai.mcp.SyncMcpToolCallbackProvider

Creates tool callbacks from multiple MCP clients.

SyncToolListChangedSpecification - Record Class in org.springframework.ai.mcp.annotation.method.changed.tool

SyncToolListChangedSpecification(String[], Consumer<List<McpSchema.Tool>>) - Constructor for record class org.springframework.ai.mcp.annotation.method.changed.tool.SyncToolListChangedSpecification

Creates an instance of a SyncToolListChangedSpecification record class.

syncTools(ObjectProvider<List<ToolCallback>>, List<ToolCallback>, ObjectProvider<List<ToolCallbackProvider>>, ObjectProvider<ToolCallbackProvider>, McpServerProperties) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.StatelessToolCallbackConverterAutoConfiguration

syncTools(ObjectProvider<List<ToolCallback>>, List<ToolCallback>, ObjectProvider<List<ToolCallbackProvider>>, ObjectProvider<ToolCallbackProvider>, McpServerProperties) - Method in class org.springframework.ai.mcp.server.common.autoconfigure.ToolCallbackConverterAutoConfiguration

syntaxError(Recognizer<?, ?>, Object, int, int, String, RecognitionException) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.DescriptiveErrorListener

synthetic(String, Message) - Static method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

A synthetic event, as a compaction strategy would produce it.

system() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelRequest

Returns the value of the system record component.

system() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Returns the value of the system record component.

system(String) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

system(String) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

system(String) - Static method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

system(Consumer<ChatClient.PromptSystemSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

system(Consumer<ChatClient.PromptSystemSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

system(Resource) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

system(Resource) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

system(Resource, Charset) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

system(Resource, Charset) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

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.

SYSTEM - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.Role

System message.

SYSTEM - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.Role

SYSTEM - Enum constant in enum class org.springframework.ai.ollama.api.OllamaApi.Message.Role

System message type used as instructions to the model.

SYSTEM_AND_TOOLS - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCacheStrategy

Cache system instructions and tool definitions.

SYSTEM_AND_TOOLS - Enum constant in enum class org.springframework.ai.bedrock.converse.api.BedrockCacheStrategy

Cache both tool definitions and system instructions.

SYSTEM_ONLY - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCacheStrategy

Cache system instructions only.

SYSTEM_ONLY - Enum constant in enum class org.springframework.ai.bedrock.converse.api.BedrockCacheStrategy

Cache system instructions only.

systemFingerprint() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion

Returns the value of the systemFingerprint record component.

systemFingerprint() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk

Returns the value of the systemFingerprint record component.

systemInstruction(Content) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent.Builder

systemInstruction(Content) - Method in class org.springframework.ai.google.genai.cache.CachedContentRequest.Builder

systemInstruction(String) - Method in class org.springframework.ai.google.genai.cache.CachedContentRequest.Builder

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

systemMessageSuffix(String) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor.Builder

systemPrompt - Variable in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

systemPrompt(String) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

systemPrompt(String) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

systemPrompt(String) - Method in class org.springframework.ai.session.compaction.ChatModelSummarizer.Builder

Replaces the default system prompt of the summarizing call.

systemPromptTemplate(PromptTemplate) - Method in class org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor.Builder

Set the system prompt template.

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

table(String) - Method in class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Builder

Sets the table name.

tableName(String) - Method in class org.springframework.ai.vectorstore.oracle.OracleVectorStore.Builder

Sets the table name for vector storage.

tag(String) - Static method in record class org.springframework.ai.vectorstore.redis.RedisVectorStore.MetadataField

tags() - Method in record class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.SchemaColumn

Returns the value of the tags record component.

targetAnnotations - Variable in class org.springframework.ai.mcp.client.common.autoconfigure.annotations.McpClientAnnotationScannerAutoConfiguration.ClientAnnotatedBeanFactoryInitializationAotProcessor

targetLanguage(String) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer.Builder

targetSearchSystem(String) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer.Builder

taskExecutor(TaskExecutor) - Method in class org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.Builder

taskType - Variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextInstanceBuilder

taskType(GoogleGenAiTextEmbeddingOptions.TaskType) - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.Builder

taskType(VertexAiTextEmbeddingOptions.TaskType) - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.Builder

taskType(String) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextInstanceBuilder

temp() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Response

Returns the value of the temp record component.

temp_max() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Response

Returns the value of the temp_max record component.

temp_min() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Response

Returns the value of the temp_min record component.

temperature - Variable in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

temperature - Variable in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

temperature() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the temperature record component.

temperature() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the temperature record component.

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

temperature(Double) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set the sampling temperature.

temperature(Double) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

temperature(Float) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

temperature(Float) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

temperature(Float) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder

temperature(Double) - Method in class org.springframework.ai.mcp.annotation.context.DefaultSamplingSpec

temperature(Double) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.SamplingSpec

temperatureCelsius() - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.Weather

Returns the value of the temperatureCelsius record component.

template - Variable in class org.springframework.ai.chat.prompt.PromptTemplate.Builder

template() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Returns the value of the template record component.

template(String) - Method in class org.springframework.ai.chat.prompt.PromptTemplate.Builder

template(String) - Method in class org.springframework.ai.chat.prompt.SystemPromptTemplate.Builder

templateHasRequiredPlaceholders(PromptTemplate, String...) - Static method in class org.springframework.ai.rag.util.PromptAssert

Assert that the given prompt template contains the required placeholders.

templateRenderer(TemplateRenderer) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

templateRenderer(TemplateRenderer) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

TemplateRenderer - Interface in org.springframework.ai.template

Renders a template using a given strategy.

Tenant(String) - Constructor for record class org.springframework.ai.chroma.vectorstore.ChromaApi.Tenant

Creates an instance of a Tenant record class.

tenantName(String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaVectorStore.Builder

Sets the tenant name.

testMutateBehavior() - Method in class org.springframework.ai.test.options.AbstractChatOptionsTests

text() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec

text() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

text() - Method in record class org.springframework.ai.chat.messages.part.ReasoningPart

Returns the value of the text record component.

text() - Method in record class org.springframework.ai.chat.messages.part.TextPart

Returns the value of the text record component.

text() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Returns the value of the text record component.

text() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerificationAttempt

Returns the value of the text record component.

text() - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.MultiSpeakerTurn

Returns the value of the text record component.

text() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.TextChunk

Returns the value of the text record component.

text() - Static method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

Creates a ResponseFormat for text output.

text() - Method in record class org.springframework.ai.rag.Query

Returns the value of the text record component.

text() - Method in record class org.springframework.ai.session.support.SessionEventCodec.EncodedEvent

Returns the value of the text record component.

text() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.TextPrompts

Returns the value of the text record component.

text(String) - Method in class org.springframework.ai.document.Document.Builder

Sets the text content of the document.

text(String) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptSystemSpec

text(String) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptUserSpec

text(String) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec

text(String) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

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(String) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.Builder

text(String) - Method in class org.springframework.ai.rag.Query.Builder

text(String) - Static method in record class org.springframework.ai.vectorstore.azure.AzureVectorStore.MetadataField

text(String) - Static method in record class org.springframework.ai.vectorstore.redis.RedisVectorStore.MetadataField

text(String) - Static method in record class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.MetadataField

Creates a metadata field of type TEXT.

text(String) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.MultimodalInstanceBuilder

text(Resource) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptSystemSpec

text(Resource) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptUserSpec

text(Resource) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec

text(Resource) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

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(Resource, Charset) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptSystemSpec

text(Resource, Charset) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptUserSpec

text(Resource, Charset) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec

text(Resource, Charset) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec

TEXT - Enum constant in enum class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingModel.InputType

TEXT - Enum constant in enum class org.springframework.ai.deepseek.api.ResponseFormat.Type

Generates a text response.

TEXT - Enum constant in enum class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityType

TEXT - Enum constant in enum class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.ContentType

Text content type.

TEXT - Enum constant in enum class org.springframework.ai.mcp.annotation.method.tool.ReturnMode

TEXT - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.Type

Generates a text response.

TEXT - Enum constant in enum class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat.Type

Generates a text response.

TEXT - Enum constant in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgIdType

TEXT - Enum constant in enum class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.MetadataField.Type

TEXT_COMPLETION - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType

AI operation type for text completion.

TEXT_CONTENT - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.MessageAttributes

Deprecated.

TEXT_EMBEDDING_004 - Enum constant in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModelName

English model.

TEXT_EMBEDDING_004 - Enum constant in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModelName

English model.

TEXT_EMBEDDING_MODEL - Static variable in class org.springframework.ai.model.SpringAIModelProperties

TEXT_MULTILINGUAL_EMBEDDING_002 - Enum constant in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModelName

Multilingual model.

TEXT_MULTILINGUAL_EMBEDDING_002 - Enum constant in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModelName

Multilingual model.

TEXT_TO_SPEECH - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType

AI operation type for text-to-speech.

TEXT_TO_SPEECH_MODEL_OPERATION - Enum constant in enum class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationDocumentation

TextChunk(String) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.TextChunk

Creates an instance of a TextChunk record class.

TextConstantContext(FiltersParser.ConstantContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.TextConstantContext

textContent - Variable in class org.springframework.ai.chat.messages.AbstractMessage

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0 in favor of AbstractMessage.getText(); kept so existing subclasses that read the field keep compiling. Will be removed in a future release.

textEmbedding(VertexAiEmbeddingConnectionDetails, VertexAiTextEmbeddingProperties, ObjectProvider<RetryTemplate>, ObjectProvider<ObservationRegistry>, ObjectProvider<EmbeddingModelObservationConvention>) - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingAutoConfiguration

TextInstanceBuilder() - Constructor for class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextInstanceBuilder

TextParametersBuilder() - Constructor for class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextParametersBuilder

TextPart - Record Class in org.springframework.ai.chat.messages.part

A run of text produced by the model or supplied by the caller.

TextPart(String, OpaquePayload, Map<String, String>) - Constructor for record class org.springframework.ai.chat.messages.part.TextPart

Creates an instance of a TextPart record class.

textPrompts() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

Returns the value of the textPrompts record component.

textPrompts(List<StabilityAiApi.GenerateImageRequest.TextPrompts>) - Method in class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.Builder

TextPrompts(String, Float) - Constructor for record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.TextPrompts

Creates an instance of a TextPrompts record class.

textProperty(String) - Method in class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Builder

Sets the property name for text-content.

TextReader - Class in org.springframework.ai.reader

A DocumentReader that reads text from a Resource.

TextReader(String) - Constructor for class org.springframework.ai.reader.TextReader

TextReader(Resource) - Constructor for class org.springframework.ai.reader.TextReader

texts() - Method in record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest

Returns the value of the texts record component.

texts() - Method in record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingResponse

Returns the value of the texts record component.

texts(String, EventFilter) - Method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

The texts of the message events matching the filter, in the order returned.

textScorer(RedisVectorStore.TextScorer) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the text scoring algorithm for text search.

TextSplitter - Class in org.springframework.ai.transformer.splitter

TextSplitter() - Constructor for class org.springframework.ai.transformer.splitter.TextSplitter

textToSpeech(ElevenLabsApi.SpeechRequest, String, MultiValueMap<String, String>) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi

Convert text to speech using the specified voice and parameters.

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.

TextToSpeechModelMeterObservationHandler - Class in org.springframework.ai.audio.tts.observation

Handler for generating metrics from text-to-speech model observations.

TextToSpeechModelMeterObservationHandler(MeterRegistry) - Constructor for class org.springframework.ai.audio.tts.observation.TextToSpeechModelMeterObservationHandler

TextToSpeechModelObservationContext - Class in org.springframework.ai.audio.tts.observation

Context used to store metadata for text-to-speech model exchanges.

TextToSpeechModelObservationContext.Builder - Class in org.springframework.ai.audio.tts.observation

TextToSpeechModelObservationConvention - Interface in org.springframework.ai.audio.tts.observation

Interface for an ObservationConvention for text-to-speech model exchanges.

TextToSpeechModelObservationDocumentation - Enum Class in org.springframework.ai.audio.tts.observation

Documented conventions for text-to-speech model observations.

TextToSpeechModelObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.ai.audio.tts.observation

High-cardinality observation key names for text-to-speech model operations.

TextToSpeechModelObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.ai.audio.tts.observation

Low-cardinality observation key names for text-to-speech model operations.

TextToSpeechModelTextContentObservationHandler - Class in org.springframework.ai.audio.tts.observation

Handler for emitting the text given to a text-to-speech model to logs.

TextToSpeechModelTextContentObservationHandler() - Constructor for class org.springframework.ai.audio.tts.observation.TextToSpeechModelTextContentObservationHandler

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<Speech>) - Constructor for class org.springframework.ai.audio.tts.TextToSpeechResponse

TextToSpeechResponse(List<Speech>, 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

textToSpeechStream(ElevenLabsApi.SpeechRequest, String, MultiValueMap<String, String>) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi

Convert text to speech using the specified voice and parameters, streaming the results.

TFIDF - Enum constant in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.TextScorer

tfsZ - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

tfsZ(Float) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

think() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest

Returns the value of the think record component.

think(ThinkOption) - Method in class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

ThinkBoolean(boolean) - Constructor for record class org.springframework.ai.ollama.api.ThinkOption.ThinkBoolean

Creates an instance of a ThinkBoolean record class.

ThinkChunk(List<MistralAiApi.ChatCompletionMessage.ThinkingContentChunk>, Boolean) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ThinkChunk

Create a thinking chunk without a signature.

ThinkChunk(List<MistralAiApi.ChatCompletionMessage.ThinkingContentChunk>, Boolean, String) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ThinkChunk

Creates an instance of a ThinkChunk record class.

thinkHigh() - Method in class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

Set thinking level to "high" (for GPT-OSS model).

thinkHigh() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

Set thinking level to "high" (for GPT-OSS model).

thinking - Variable in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

thinking() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the thinking record component.

thinking() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ThinkChunk

Returns the value of the thinking record component.

thinking() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message

Returns the value of the thinking record component.

thinking(ThinkingConfigParam) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

thinking(String) - Method in class org.springframework.ai.ollama.api.OllamaApi.Message.Builder

thinking(DeepSeekApi.ChatCompletionRequest.Thinking) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set the thinking mode configuration.

thinking(DeepSeekApi.ChatCompletionRequest.Thinking) - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

Thinking(DeepSeekApi.ChatCompletionRequest.Thinking.Type) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Thinking

Creates an instance of a Thinking record class.

THINKING_CONTENT_METADATA - Static variable in class org.springframework.ai.mistralai.MistralAiChatModel

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0 in favor of AssistantMessage.getReasoning()

THINKING_LEVEL_UNSPECIFIED - Enum constant in enum class org.springframework.ai.google.genai.common.GoogleGenAiThinkingLevel

Unspecified thinking level.

THINKING_METADATA_KEY - Static variable in class org.springframework.ai.anthropic.AnthropicChatModel

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0; a thinking chunk holds a ReasoningPart, see AssistantMessage.getReasoning()

THINKING_TEXT_METADATA_KEY - Static variable in class org.springframework.ai.anthropic.AnthropicChatModel

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0; read the text of the chunk's ReasoningPart, see AssistantMessage.getReasoning()

thinkingAdaptive() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

Convenience method to let Claude adaptively decide whether to think.

thinkingAdaptive(ThinkingConfigAdaptive.Display) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

Convenience method to let Claude adaptively decide whether to think, with a display setting.

thinkingBudget - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

thinkingBudget(Integer) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

thinkingDisabled() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

Convenience method to explicitly disable thinking.

thinkingEnabled(long) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

Convenience method to enable thinking with a specific budget in tokens.

thinkingEnabled(long, ThinkingConfigEnabled.Display) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

Convenience method to enable thinking with a specific budget and display setting.

thinkingLevel - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

thinkingLevel(GoogleGenAiThinkingLevel) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

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<Pattern>) - 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.

ThinkLevel(String) - Constructor for record class org.springframework.ai.ollama.api.ThinkOption.ThinkLevel

models/spring-ai-ollama/src/main/java/org/springframework/ai/ollama/api/ThinkOption.java Creates a new ThinkLevel with validation.

thinkLow() - Method in class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

Set thinking level to "low" (for GPT-OSS model).

thinkLow() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

Set thinking level to "low" (for GPT-OSS model).

thinkMedium() - Method in class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

Set thinking level to "medium" (for GPT-OSS model).

thinkMedium() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

Set thinking level to "medium" (for GPT-OSS model).

thinkOption - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

thinkOption(ThinkOption) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

Set the think option explicitly.

ThinkOption - Interface in org.springframework.ai.ollama.api

Represents the thinking option for Ollama models.

ThinkOption.ThinkBoolean - Record Class in org.springframework.ai.ollama.api

Boolean-style think option for models that support simple enable/disable.

ThinkOption.ThinkLevel - Record Class in org.springframework.ai.ollama.api

String-level think option for the GPT-OSS model which requires explicit levels.

ThinkOption.ThinkOptionDeserializer - Class in org.springframework.ai.ollama.api

Deserializer that reads boolean or string values into ThinkOption instances.

ThinkOption.ThinkOptionSerializer - Class in org.springframework.ai.ollama.api

Serializer that writes ThinkOption as raw boolean or string values.

ThinkOptionDeserializer() - Constructor for class org.springframework.ai.ollama.api.ThinkOption.ThinkOptionDeserializer

ThinkOptionSerializer() - Constructor for class org.springframework.ai.ollama.api.ThinkOption.ThinkOptionSerializer

THREE_D_MODEL - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

threshold(int) - Method in class org.springframework.ai.session.compaction.TokenCountTrigger.Builder

THROW - Enum constant in enum class org.springframework.ai.model.tool.ToolCallLimitBehavior

Throw a ToolCallLimitExceededException carrying the tool calls executed so far, aborting the current batch of tool calls immediately.

THROW - Enum constant in enum class org.springframework.ai.template.ValidationMode

If the validation fails, an exception is thrown.

TikaDocumentReader - Class in org.springframework.ai.reader.tika

A document reader that leverages Apache Tika to extract text from a variety of document formats, such as PDF, DOC/DOCX, PPT/PPTX, and HTML.

TikaDocumentReader(String) - Constructor for class org.springframework.ai.reader.tika.TikaDocumentReader

Constructor initializing the reader with a given resource URL.

TikaDocumentReader(String, ExtractedTextFormatter) - Constructor for class org.springframework.ai.reader.tika.TikaDocumentReader

Constructor initializing the reader with a given resource URL and a text formatter.

TikaDocumentReader(Resource) - Constructor for class org.springframework.ai.reader.tika.TikaDocumentReader

Constructor initializing the reader with a resource.

TikaDocumentReader(Resource, ExtractedTextFormatter) - Constructor for class org.springframework.ai.reader.tika.TikaDocumentReader

Constructor initializing the reader with a resource and a text formatter.

TikaDocumentReader(Resource, ContentHandler, ExtractedTextFormatter) - Constructor for class org.springframework.ai.reader.tika.TikaDocumentReader

Constructor initializing the reader with a resource, content handler, and a text formatter.

tiktokUsername() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the tiktokUsername record component.

TILE_TEXTURE - Enum constant in enum class org.springframework.ai.stabilityai.StyleEnum

timeout - Variable in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

timeout - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

timeout - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

timeout() - Method in record class org.springframework.ai.ollama.management.ModelManagementOptions

Returns the value of the timeout record component.

timeout(Duration) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

timeout(Duration) - Method in class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

timeout(Duration) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

timeout(Duration) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

timeout(Timeout) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

timeout(Timeout) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

timeout(Duration) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

timeout(Duration) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder

timeout(Duration) - Method in class org.springframework.ai.ollama.management.ModelManagementOptions.Builder

timeout(Duration) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

timestamp() - Method in record class org.springframework.ai.chat.memory.repository.mongo.Conversation

Deprecated.

Returns the value of the timestamp record component.

timestamp() - Method in record class org.springframework.ai.chat.memory.repository.redis.AdvancedRedisChatMemoryRepository.MessageWithConversation

Deprecated.

Returns the value of the timestamp record component.

timestamp(Instant) - Method in class org.springframework.ai.session.SessionEvent.Builder

When the event was recorded; Instant.now() by default.

timestampGranularities(List<TranscriptionCreateParams.TimestampGranularity>) - Method in class org.springframework.ai.openai.OpenAiAudioTranscriptionOptions.Builder

timeToLive() - Method in class org.springframework.ai.session.CreateSessionRequest

timeToLive(Duration) - Method in class org.springframework.ai.session.CreateSessionRequest.Builder

timeToLive(Duration) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryConfig.Builder

Deprecated.

Sets the time-to-live duration.

timeToLive(Duration) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository.Builder

Deprecated.

Sets the time to live duration for messages stored in Redis.

timezone() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation

Returns the value of the timezone record component.

TITAN_EMBED_IMAGE_V1 - Enum constant in enum class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingModel

amazon.titan-embed-image-v1

TITAN_EMBED_TEXT_V1 - Enum constant in enum class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingModel

amazon.titan-embed-text-v1

TITAN_EMBED_TEXT_V2 - Enum constant in enum class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingModel

amazon.titan-embed-text-v2

titanEmbeddingBedrockApi(AwsCredentialsProvider, AwsRegionProvider, BedrockTitanEmbeddingProperties, BedrockAwsConnectionProperties, JsonMapper) - Method in class org.springframework.ai.model.bedrock.titan.autoconfigure.BedrockTitanEmbeddingAutoConfiguration

TitanEmbeddingBedrockApi - Class in org.springframework.ai.bedrock.titan.api

Java client for the Bedrock Titan Embedding model.

TitanEmbeddingBedrockApi(String, String, Duration) - Constructor for class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi

Create a new TitanEmbeddingBedrockApi instance using the default credentials provider and default object mapper.

TitanEmbeddingBedrockApi(String, AwsCredentialsProvider, String, JsonMapper, Duration) - Constructor for class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi

Create a new TitanEmbeddingBedrockApi instance.

TitanEmbeddingBedrockApi(String, AwsCredentialsProvider, Region, JsonMapper, Duration) - Constructor for class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi

Create a new TitanEmbeddingBedrockApi instance.

TitanEmbeddingBedrockApi.TitanEmbeddingModel - Enum Class in org.springframework.ai.bedrock.titan.api

Titan Embedding model ids.

TitanEmbeddingBedrockApi.TitanEmbeddingRequest - Record Class in org.springframework.ai.bedrock.titan.api

Titan Embedding request parameters.

TitanEmbeddingBedrockApi.TitanEmbeddingRequest.Builder - Class in org.springframework.ai.bedrock.titan.api

TitanEmbeddingRequest builder.

TitanEmbeddingBedrockApi.TitanEmbeddingResponse - Record Class in org.springframework.ai.bedrock.titan.api

Titan Embedding response.

titanEmbeddingModel(TitanEmbeddingBedrockApi, BedrockTitanEmbeddingProperties, ObjectProvider<ObservationRegistry>) - Method in class org.springframework.ai.model.bedrock.titan.autoconfigure.BedrockTitanEmbeddingAutoConfiguration

TitanEmbeddingRequest(String, String) - Constructor for record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingRequest

Creates an instance of a TitanEmbeddingRequest record class.

TitanEmbeddingResponse(float[], Integer, Integer, Integer, Map<String, Object>, Object, Object) - Constructor for record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingResponse

Creates an instance of a TitanEmbeddingResponse record class.

title - Variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextInstanceBuilder

title() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchResult

Returns the value of the title record component.

title() - Element in annotation interface org.springframework.ai.mcp.annotation.McpPrompt

Optional human-readable name of the prompt for display purposes.

title() - Element in annotation interface org.springframework.ai.mcp.annotation.McpResource

Optional human-readable name of the prompt for display purposes.

title() - Element in annotation interface org.springframework.ai.mcp.annotation.McpTool.McpAnnotations

A human-readable title for the tool.

title() - Element in annotation interface org.springframework.ai.mcp.annotation.McpTool

Intended for UI and end-user contexts — optimized to be human-readable and easily understood, even by those unfamiliar with domain-specific terminology.

title() - Method in record class org.springframework.ai.reader.pdf.config.ParagraphManager.Paragraph

Returns the value of the title record component.

title(String) - Method in class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.Builder

title(String) - Method in class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.Builder

title(String) - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder

Set the document title.

title(String) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.TextInstanceBuilder

toAsyncToolSpecification(ToolCallback) - Static method in class org.springframework.ai.mcp.McpToolUtils

Converts a Spring AI tool callback to an MCP asynchronous tool specification.

toAsyncToolSpecification(ToolCallback, MimeType) - Static method in class org.springframework.ai.mcp.McpToolUtils

Converts a Spring AI tool callback to an MCP asynchronous tool specification.

toAsyncToolSpecifications(List<ToolCallback>) - Static method in class org.springframework.ai.mcp.McpToolUtils

Converts a list of Spring AI tool callbacks to MCP asynchronous tool specification.

toAsyncToolSpecifications(ToolCallback...) - Static method in class org.springframework.ai.mcp.McpToolUtils

Convenience method to convert a variable number of tool callbacks to MCP asynchronous tool specification.

toAugmentedArgumentTypes(Class<T>) - Static method in class org.springframework.ai.tool.augment.ToolInputSchemaAugmenter

Extracts the tool argument types from a record class annotated with ToolParam.

toBuilder() - Method in record class org.springframework.ai.session.EventFilter

Returns a builder initialised with every criterion of this filter.

toChatCompletionAudioParam() - Method in record class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters

toDocument(Object) - Static method in class org.springframework.ai.vectorstore.s3.DocumentUtils

toDocument(String, int, int) - Method in class org.springframework.ai.reader.pdf.PagePdfDocumentReader

toDocument(ParagraphManager.Paragraph, ParagraphManager.Paragraph) - Method in class org.springframework.ai.reader.pdf.ParagraphPdfDocumentReader

toDocumentBlockParam() - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument

Convert this citation document to an SDK DocumentBlockParam.

ToDto() - Constructor for class org.springframework.ai.chat.messages.part.MediaPart.ToDto

toEmbeddingResponseList(ChromaApi.QueryResponse) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

toEvents(String) - Method in record class org.springframework.ai.session.compaction.CompactionResult

The events SessionService.compact(java.lang.String, org.springframework.ai.session.compaction.CompactionTrigger, org.springframework.ai.session.compaction.CompactionStrategy) appends for this result: the EventType.COMPACTION boundary, then one synthetic event per summary message, all with one timestamp.

toFloatArray(float[]) - Static method in class org.springframework.ai.model.EmbeddingUtils

toJson(Object) - Static method in class org.springframework.ai.util.json.JsonParser

Deprecated, for removal: This API element is subject to removal in a future version.

Use JsonHelper.toJson(Object, boolean) instead

toJson(Object) - Method in class org.springframework.ai.util.JsonHelper

Converts a Java object to a JSON string.

toJson(Object, boolean) - Method in class org.springframework.ai.util.JsonHelper

Converts a Java object to a JSON string.

toJson(Object) - Method in class org.springframework.ai.session.support.SessionEventCodec

Serializes a value, typically a metadata map, to JSON.

toJsonMap() - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord

Convert to a map suitable for JSON serialization via JsonValue.from().

toJsonValue() - Method in record class org.springframework.ai.ollama.api.ThinkOption.ThinkBoolean

toJsonValue() - Method in record class org.springframework.ai.ollama.api.ThinkOption.ThinkLevel

toJsonValue() - Method in interface org.springframework.ai.ollama.api.ThinkOption

Converts this think option to its JSON representation.

token() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content

Returns the value of the token record component.

token() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content.TopLogProbs

Returns the value of the token record component.

token() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content

Returns the value of the token record component.

token() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content.TopLogProbs

Returns the value of the token record component.

token(String) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

Sets the token to authenticate requests with

TOKEN_BUDGET - Enum constant in enum class org.springframework.ai.session.compaction.CompactionWindow.Rule

The newest events whose estimated tokens fit in size.

TOKEN_TYPE - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationMetricAttributes

The type of token being counted (input, output, total).

TOKEN_USAGE - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationMetricNames

The number of AI operations.

tokenBudget(int) - Static method in record class org.springframework.ai.session.compaction.CompactionWindow

Keeps what fits in maxTokens, counted from the newest event back: the pinned events come off the budget first, and the kept window is a contiguous suffix.

tokenBudget(int) - Method in class org.springframework.ai.session.compaction.WindowCompactionStrategy.Builder

Keeps what fits in maxTokens; see CompactionWindow.tokenBudget(int).

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.

tokenCountEstimator - Variable in class org.springframework.ai.chat.client.advisor.LastMaxTokenSizeContentPurger

tokenCountEstimator(TokenCountEstimator) - Method in class org.springframework.ai.session.compaction.TokenCountTrigger.Builder

tokenCountEstimator(TokenCountEstimator) - Method in class org.springframework.ai.session.compaction.WindowCompactionStrategy.Builder

The estimator of a token budget and of the tokens a pass saves, applied to EventText; a JTokkitTokenCountEstimator by default.

TokenCountEstimator - Interface in org.springframework.ai.tokenizer

Estimates the number of tokens in a given text or message.

TokenCountTrigger - Class in org.springframework.ai.session.compaction

Fires when the estimated tokens of the view reach a threshold: the latest stored system message, the summaries and the conversation, measured on EventText with a TokenCountEstimator, JTokkit by default.

TokenCountTrigger.Builder - Class in org.springframework.ai.session.compaction

Tokenizer() - Constructor for class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties.Tokenizer

tokenizerOptions - Variable in class org.springframework.ai.transformers.TransformersEmbeddingModel

tokenNames - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

Deprecated.

Use FiltersLexer.VOCABULARY instead.

tokenNames - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

Deprecated.

Use FiltersParser.VOCABULARY instead.

tokensEstimatedSaved() - Method in record class org.springframework.ai.session.compaction.CompactionBoundary

Returns the value of the tokensEstimatedSaved record component.

tokensEstimatedSaved() - Method in record class org.springframework.ai.session.compaction.CompactionResult

Returns the value of the tokensEstimatedSaved record component.

TokenTextSplitter - Class in org.springframework.ai.transformer.splitter

A TextSplitter that splits text into chunks of a target size in tokens.

TokenTextSplitter() - Constructor for class org.springframework.ai.transformer.splitter.TokenTextSplitter

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0-M3, use TokenTextSplitter.builder() instead.

TokenTextSplitter(boolean) - Constructor for class org.springframework.ai.transformer.splitter.TokenTextSplitter

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0-M3, use TokenTextSplitter.builder() instead.

TokenTextSplitter(int, int, int, int, boolean, List<Character>) - Constructor for class org.springframework.ai.transformer.splitter.TokenTextSplitter

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0-M3, use TokenTextSplitter.builder() instead.

TokenTextSplitter(EncodingType) - Constructor for class org.springframework.ai.transformer.splitter.TokenTextSplitter

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0-M3, use TokenTextSplitter.builder() instead.

TokenTextSplitter(EncodingType, boolean) - Constructor for class org.springframework.ai.transformer.splitter.TokenTextSplitter

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0-M3, use TokenTextSplitter.builder() instead.

TokenTextSplitter.Builder - Class in org.springframework.ai.transformer.splitter

toList(float[]) - Static method in class org.springframework.ai.model.EmbeddingUtils

toMap() - Method in class org.springframework.ai.ollama.api.OllamaChatOptions

Convert the OllamaChatOptions object to a Map of key/value pairs.

toMap() - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions

Convert the OllamaEmbeddingOptions object to a Map of key/value pairs.

tool() - Method in record class org.springframework.ai.openai.responses.HostedTool.Raw

Returns the value of the tool record component.

tool(McpSchema.Tool) - Method in class org.springframework.ai.mcp.AsyncMcpToolCallback.Builder

Sets the MCP tool to adapt.

tool(McpSchema.Tool) - Method in class org.springframework.ai.mcp.SyncMcpToolCallback.Builder

Sets the MCP tool to adapt.

Tool - Annotation Interface in org.springframework.ai.tool.annotation

Marks a method as a tool in Spring AI.

Tool(OllamaApi.ChatRequest.Tool.Function) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool

Create a tool of type 'function' and the given function definition.

Tool(OllamaApi.ChatRequest.Tool.Type, OllamaApi.ChatRequest.Tool.Function) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool

Creates an instance of a Tool record class.

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 - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.Role

Tool message.

TOOL - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.Role

TOOL - Enum constant in enum class org.springframework.ai.ollama.api.OllamaApi.Message.Role

Tool message.

TOOL_CALL - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionFinishReason

Only for compatibility with Mistral AI API.

TOOL_CALL - Enum constant in enum class org.springframework.ai.observation.conventions.SpringAiKind

Spring AI kind for tool calling.

TOOL_CALL - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation

Tool calling observations.

TOOL_CALL_ADVISOR_AUTO_REGISTER - Enum constant in enum class org.springframework.ai.chat.client.ChatClientAttributes

Deprecated, for removal: This API element is subject to removal in a future version.

TOOL_CALL_ARGUMENTS - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.HighCardinalityKeyNames

The input arguments to the tool call.

TOOL_CALL_ID - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.HighCardinalityKeyNames

The ID of the tool call.

TOOL_CALL_RESULT - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.HighCardinalityKeyNames

The result of the tool call.

TOOL_CALLING_ADVISOR_AUTO_REGISTER - Enum constant in enum class org.springframework.ai.chat.client.ChatClientAttributes

TOOL_CALLS - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionFinishReason

The model called a tool.

TOOL_CALLS - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.FinishReason

The model requested a tool call.

TOOL_CONTEXT_MCP_EXCHANGE_KEY - Static variable in class org.springframework.ai.mcp.McpToolUtils

The name of tool context key used to store the MCP exchange object.

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.

TOOL_SEARCH_TOOL_SESSION_ID_KEY - Static variable in class org.springframework.ai.tool.toolsearch.ToolSearchTool

TOOL_TYPE - Enum constant in enum class org.springframework.ai.tool.observation.ToolCallingObservationDocumentation.LowCardinalityKeyNames

The type of the tool.

ToolAdvisor - Interface in org.springframework.ai.chat.client.advisor.api

Marker interface for advisors that own the tool-call lifecycle.

toolCall() - Method in record class org.springframework.ai.chat.messages.part.ToolCallPart

Returns the value of the toolCall record component.

toolCall(String, String) - Static method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

An assistant message that calls one tool.

ToolCall(Integer, String, String, DeepSeekApi.ChatCompletionMessage.ChatCompletionFunction) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.ToolCall

Creates an instance of a ToolCall record class.

ToolCall(String, String, DeepSeekApi.ChatCompletionMessage.ChatCompletionFunction) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.ToolCall

ToolCall(String, String, String, String) - Constructor for record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall

Creates an instance of a ToolCall record class.

ToolCall(String, String, MistralAiApi.ChatCompletionMessage.ChatCompletionFunction, Integer) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ToolCall

Creates an instance of a ToolCall record class.

ToolCall(String, OllamaApi.Message.ToolCallFunction) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.Message.ToolCall

Creates an instance of a ToolCall record class.

ToolCallAdvisor - Class in org.springframework.ai.chat.client.advisor

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0 in favor of ToolCallingAdvisor. This is kept for backward compatibility and will be removed in a future release.

ToolCallAdvisor(ToolCallingManager, ToolExecutionEligibilityChecker, int, boolean) - Constructor for class org.springframework.ai.chat.client.advisor.ToolCallAdvisor

Deprecated.

ToolCallAdvisor.Builder<T extends ToolCallAdvisor.Builder<T>> - Class in org.springframework.ai.chat.client.advisor

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0 in favor of ToolCallingAdvisor.Builder.

toolCallAdvisorAutoRegister(boolean) - Static method in class org.springframework.ai.chat.client.AdvisorParams

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0 in favor of AdvisorParams.toolCallingAdvisorAutoRegister(boolean).

toolCallArguments(String) - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext.Builder

ToolCallAttributes - Enum Class in org.springframework.ai.chat.memory.repository.neo4j

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory: org.springframework.ai.session.SessionRepository in spring-ai-session, with a JDBC store in spring-ai-session-jdbc. There is no session store for Neo4j yet; one is planned before 3.0.0, when this module is removed.

Toolcallback() - Constructor for class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties.Toolcallback

ToolCallback - Interface in org.springframework.ai.tool

Represents a tool whose execution can be triggered by an AI model.

ToolCallbackConverterAutoConfiguration - Class in org.springframework.ai.mcp.server.common.autoconfigure

ToolCallbackConverterAutoConfiguration() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.ToolCallbackConverterAutoConfiguration

ToolCallbackConverterAutoConfiguration.ToolCallbackConverterCondition - Class in org.springframework.ai.mcp.server.common.autoconfigure

ToolCallbackConverterCondition() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.StatelessToolCallbackConverterAutoConfiguration.ToolCallbackConverterCondition

ToolCallbackConverterCondition() - Constructor for class org.springframework.ai.mcp.server.common.autoconfigure.ToolCallbackConverterAutoConfiguration.ToolCallbackConverterCondition

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 - Variable in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

toolCallbacks(List<ToolCallback>) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

toolCallbacks(List<ToolCallback>) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

ToolCallbacks to be registered with the ChatModel.

toolCallbacks(List<ToolCallback>) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

Deprecated, for removal: This API element is subject to removal in a future version.

as of 2.0.0, in favor of ChatClient.ChatClientRequestSpec.tools(Object...). To be removed in 3.0.0.

toolCallbacks(List<ToolCallback>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

toolCallbacks(ToolCallback...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

Deprecated, for removal: This API element is subject to removal in a future version.

as of 2.0.0, in favor of ChatClient.ChatClientRequestSpec.tools(Object...). To be removed in 3.0.0.

toolCallbacks(ToolCallback...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

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(ToolCallbackProvider...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

Deprecated, for removal: This API element is subject to removal in a future version.

as of 2.0.0, in favor of ChatClient.ChatClientRequestSpec.tools(Object...). To be removed in 3.0.0.

toolCallbacks(ToolCallbackProvider...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

ToolCallbacks - Class in org.springframework.ai.support

Provides ToolCallback instances for tools defined in different sources.

toolCallConfirmationPolicy(ToolCallConfirmationPolicy) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder

Which tool calls need a person's confirmation before they run.

ToolCallConfirmationPolicy - Interface in org.springframework.ai.model.tool

Decides which tool calls a person must confirm before they run.

ToolCallConfirmationRequiredException - Exception in org.springframework.ai.model.tool

Thrown by a ToolCallingManager when a tool call of the batch needs a person's confirmation before it runs (see ToolCallConfirmationPolicy) and no ToolCallDecisions were given.

ToolCallConfirmationRequiredException(List<String>) - Constructor for exception org.springframework.ai.model.tool.ToolCallConfirmationRequiredException

Create the exception for the calls that wait for a decision.

ToolCallDecision - Record Class in org.springframework.ai.model.tool

A caller's decision on one tool call that waits for confirmation: allow it to run, or deny it with a message that the model receives as the call's result.

ToolCallDecision(String, boolean, String) - Constructor for record class org.springframework.ai.model.tool.ToolCallDecision

Creates an instance of a ToolCallDecision record class.

ToolCallDecisions - Record Class in org.springframework.ai.model.tool

The decisions a person made on the tool calls of an AssistantMessage, for a ToolCallingManager to carry them out.

ToolCallDecisions(List<ToolCallDecision>) - Constructor for record class org.springframework.ai.model.tool.ToolCallDecisions

Creates an instance of a ToolCallDecisions record class.

toolCallExceptionClass - Variable in class org.springframework.ai.mcp.annotation.method.tool.AbstractAsyncMcpToolMethodCallback

Deprecated.

no longer consulted. Exception handling now follows the @Tool contract based on the exception type. Retained for backward compatibility. Will be removed in 2.1.0.

ToolCallFunction(String, Map<String, Object>) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.Message.ToolCallFunction

ToolCallFunction(String, Map<String, Object>, Integer) - Constructor for record class org.springframework.ai.ollama.api.OllamaApi.Message.ToolCallFunction

Creates an instance of a ToolCallFunction record class.

toolCallId() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage

Returns the value of the toolCallId record component.

toolCallId() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Returns the value of the toolCallId record component.

toolCallId() - Method in record class org.springframework.ai.model.tool.ToolCallDecision

Returns the value of the toolCallId record component.

toolCallId(KeyValues, ToolCallingObservationContext) - Method in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention

toolCallId(String) - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext.Builder

ToolCalling() - Constructor for class org.springframework.ai.model.chat.client.autoconfigure.ChatClientBuilderProperties.ToolCalling

ToolCallingAdvisor - Class in org.springframework.ai.chat.client.advisor

Recursive Advisor that disables the internal tool execution flow and instead implements the tool calling loop as part of the advisor chain.

ToolCallingAdvisor(ToolCallingManager, ToolExecutionEligibilityChecker, int, boolean) - Constructor for class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

ToolCallingAdvisor.Builder<T extends ToolCallingAdvisor.Builder<T>> - Class in org.springframework.ai.chat.client.advisor

Builder for creating instances of ToolCallingAdvisor.

toolCallingAdvisorAutoRegister(boolean) - Static method in class org.springframework.ai.chat.client.AdvisorParams

Controls whether a ToolCallingAdvisor is automatically added to the chain.

ToolCallingAutoConfiguration - Class in org.springframework.ai.model.tool.autoconfigure

Auto-configuration for common tool calling features of ChatModel.

ToolCallingAutoConfiguration() - Constructor for class org.springframework.ai.model.tool.autoconfigure.ToolCallingAutoConfiguration

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<B extends ToolCallingChatOptions.Builder<B>> - 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 - Variable in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor

toolCallingManager(ToolCallingManager) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0 for removal in 3.0.0 — internal tool execution in AnthropicChatModel is superseded by ToolCallingAdvisor used via ChatClient.

toolCallingManager(ToolCallingManager) - Method in class org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0 for removal in 3.0.0 — internal tool execution in BedrockProxyChatModel is superseded by ToolCallingAdvisor used via ChatClient.

toolCallingManager(ToolCallingManager) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder

Sets the ToolCallingManager to be used by the advisor.

toolCallingManager(ToolCallingManager) - Method in class org.springframework.ai.deepseek.DeepSeekChatModel.Builder

Sets the tool calling manager used to resolve the tool definitions sent to the model.

toolCallingManager(ToolCallingManager) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatModel.Builder

toolCallingManager(ToolCallingManager) - Method in class org.springframework.ai.mistralai.MistralAiChatModel.Builder

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0 for removal in 3.0.0 — internal tool execution in MistralAiChatModel is superseded by ToolCallingAdvisor used via ChatClient.

toolCallingManager(ToolCallingManager) - Method in class org.springframework.ai.ollama.OllamaChatModel.Builder

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0 for removal in 3.0.0 — internal tool execution in OllamaChatModel is superseded by ToolCallingAdvisor used via ChatClient.

toolCallingManager(ToolCallingManager) - Method in class org.springframework.ai.openai.OpenAiChatModel.Builder

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.0.0 for removal in 3.0.0 — internal tool execution in OpenAiChatModel is superseded by ToolCallingAdvisor used via ChatClient.

toolCallingManager(ToolCallingManager) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatModel.Builder

Sets the tool calling manager used to resolve tool definitions.

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.

ToolCallingProperties - Class in org.springframework.ai.model.tool.autoconfigure

Configuration properties for tool calling.

ToolCallingProperties() - Constructor for class org.springframework.ai.model.tool.autoconfigure.ToolCallingProperties

ToolCallingProperties.Confirmation - Class in org.springframework.ai.model.tool.autoconfigure

Which tool calls need a person's confirmation before they run.

ToolCallingProperties.Limits - Class in org.springframework.ai.model.tool.autoconfigure

ToolCallingProperties.Observations - Class in org.springframework.ai.model.tool.autoconfigure

ToolCallingProperties.Resolution - Class in org.springframework.ai.model.tool.autoconfigure

ToolCallingProperties.Resolution.Fallback - Class in org.springframework.ai.model.tool.autoconfigure

toolCallKeys(AssistantMessage) - Static method in record class org.springframework.ai.model.tool.ToolCallDecisions

The keys of the tool calls of the message, in the order the model asked for them: a call's id when it has one that no other call of the message shares, otherwise ToolCallDecisions.POSITION_KEY_PREFIX followed by the call's position, such as #1.

ToolCallLimitBehavior - Enum Class in org.springframework.ai.model.tool

Determines what DefaultToolCallingManager does when a configured tool call limit (per tool name or total per turn) is exceeded.

ToolCallLimitExceededException - Exception in org.springframework.ai.model.tool

Thrown by DefaultToolCallingManager when a configured tool call limit is exceeded and ToolCallLimitBehavior.THROW is in effect.

ToolCallLimitExceededException(String, int, ToolExecutionResult) - Constructor for exception org.springframework.ai.model.tool.ToolCallLimitExceededException

ToolCallPart - Record Class in org.springframework.ai.chat.messages.part

A tool call requested by the model.

ToolCallPart(AssistantMessage.ToolCall, OpaquePayload, Map<String, String>) - Constructor for record class org.springframework.ai.chat.messages.part.ToolCallPart

Creates an instance of a ToolCallPart record class.

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 - Variable in class org.springframework.ai.chat.messages.AssistantMessage.Builder

The tool calls set through AssistantMessage.Builder.toolCalls(List).

toolCalls() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage

Returns the value of the toolCalls record component.

toolCalls() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Returns the value of the toolCalls record component.

toolCalls() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message

Returns the value of the toolCalls record component.

toolCalls(List<OllamaApi.Message.ToolCall>) - Method in class org.springframework.ai.ollama.api.OllamaApi.Message.Builder

toolCalls(List<AssistantMessage.ToolCall>) - Method in class org.springframework.ai.chat.messages.AssistantMessage.Builder

toolChoice - Variable in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

toolChoice - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

toolChoice - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

toolChoice - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

toolChoice() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the toolChoice record component.

toolChoice() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the toolChoice record component.

toolChoice(ToolChoice) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

toolChoice(Object) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set the tool choice.

toolChoice(Object) - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

toolChoice(Object) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

toolChoice(Object) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

toolChoice(GoogleGenAiChatOptions.ToolChoice) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

toolChoice(MistralAiApi.ChatCompletionRequest.ToolChoice) - Method in class org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder

ToolChoice(GoogleGenAiChatOptions.ToolChoice.Mode, List<String>) - Constructor for record class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice

Creates an instance of a ToolChoice record class.

ToolChoiceBuilder() - Constructor for class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.ToolChoiceBuilder

ToolChoiceProperties() - Constructor for class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties.ToolChoiceProperties

toolContext - Variable in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

toolContext(Map<String, Object>) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

toolContext(Map<String, Object>) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

Add a Map of context values into tool context.

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<String, Object>) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

toolContext(Map<String, Object>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

ToolContext - Class in org.springframework.ai.chat.model

Represents the context for tool execution in a function calling scenario.

ToolContext(Map<String, Object>) - Constructor for class org.springframework.ai.chat.model.ToolContext

Constructs a new ToolContext with the given context map.

toolContextToMcpMetaConverter(ToolContextToMcpMetaConverter) - Method in class org.springframework.ai.mcp.AsyncMcpToolCallback.Builder

Sets the converter for tool context to MCP metadata transformation.

toolContextToMcpMetaConverter(ToolContextToMcpMetaConverter) - Method in class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider.Builder

Sets tool context to MCP metadata converter.

toolContextToMcpMetaConverter(ToolContextToMcpMetaConverter) - Method in class org.springframework.ai.mcp.SyncMcpToolCallback.Builder

Sets the converter for tool context to MCP metadata transformation.

toolContextToMcpMetaConverter(ToolContextToMcpMetaConverter) - Method in class org.springframework.ai.mcp.SyncMcpToolCallbackProvider.Builder

Sets tool context to MCP metadata converter.

ToolContextToMcpMetaConverter - Interface in org.springframework.ai.mcp

Strategy interface for converting a ToolContext to a map of metadata to be sent as part of an MCP tool call.

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(ToolExecutionEligibilityChecker) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder

Sets the checker that determines whether a model response should trigger tool execution.

ToolExecutionEligibilityChecker - Interface in org.springframework.ai.model.tool

Interface for determining when tool execution should be performed based on model responses.

ToolExecutionException - Exception in org.springframework.ai.tool.execution

An exception thrown when a tool execution fails.

ToolExecutionException(ToolDefinition, Throwable) - Constructor for exception 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.

toolFilter(McpToolFilter) - Method in class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider.Builder

Sets tool filter.

toolFilter(McpToolFilter) - Method in class org.springframework.ai.mcp.SyncMcpToolCallbackProvider.Builder

Sets tool filter.

toolIndex(ToolIndex) - Method in class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor.Builder

Sets the ToolIndex to be used for finding tools.

ToolIndex - Interface in org.springframework.ai.tool.toolsearch

Interface for searching and discovering tools on-demand.

ToolIndexEvictionStrategy - Interface in org.springframework.ai.tool.toolsearch.eviction

Strategy that decides which session tool indexes should be evicted.

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.

toolListChanged(McpToolListChanged) - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback.AbstractBuilder

Set the tool list changed annotation.

toolListChangedSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

toolListChangedSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

toolListChangeHandler() - Method in record class org.springframework.ai.mcp.annotation.method.changed.tool.AsyncToolListChangedSpecification

Returns the value of the toolListChangeHandler record component.

toolListChangeHandler() - Method in record class org.springframework.ai.mcp.annotation.method.changed.tool.SyncToolListChangedSpecification

Returns the value of the toolListChangeHandler record component.

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 - Variable in class org.springframework.ai.mcp.annotation.method.tool.AbstractMcpToolMethodCallback

toolMethod(Method) - Method in class org.springframework.ai.tool.method.MethodToolCallback.Builder

toolName() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message

Returns the value of the toolName record component.

toolName() - Method in record class org.springframework.ai.tool.toolsearch.ToolReference

Returns the value of the toolName record component.

toolName(String) - Method in class org.springframework.ai.ollama.api.OllamaApi.Message.Builder

toolName(String) - Method in class org.springframework.ai.tool.toolsearch.ToolReference.Builder

toolNamePrefixGenerator(McpToolNamePrefixGenerator) - Method in class org.springframework.ai.mcp.AsyncMcpToolCallbackProvider.Builder

Sets tool name prefix generator.

toolNamePrefixGenerator(McpToolNamePrefixGenerator) - Method in class org.springframework.ai.mcp.SyncMcpToolCallbackProvider.Builder

Sets tool name prefix generator.

toolObject - Variable in class org.springframework.ai.mcp.annotation.method.tool.AbstractMcpToolMethodCallback

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 - Variable in class org.springframework.ai.mcp.annotation.provider.tool.AbstractMcpToolProvider

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.

ToolReference - Record Class in org.springframework.ai.tool.toolsearch

Reference to a retrieved Tool with its name, relevance score, and summary.

ToolReference(String, Double, String) - Constructor for record class org.springframework.ai.tool.toolsearch.ToolReference

Creates an instance of a ToolReference record class.

ToolReference.Builder - Class in org.springframework.ai.tool.toolsearch

toolReferences() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchResponse

Returns the value of the toolReferences record component.

toolReferences(List<ToolReference>) - Method in class org.springframework.ai.tool.toolsearch.ToolSearchResponse.Builder

toolResponse(String, String, String) - Static method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

The result of one tool call.

ToolResponse(String, String, String) - Constructor for record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse

Creates an instance of a ToolResponse record class.

ToolResponseAttributes - Enum Class in org.springframework.ai.chat.memory.repository.neo4j

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0, for removal in 3.0.0, in favor of session memory: org.springframework.ai.session.SessionRepository in spring-ai-session, with a JDBC store in spring-ai-session-jdbc. There is no session store for Neo4j yet; one is planned before 3.0.0, when this module is removed.

ToolResponseMessage - Class in org.springframework.ai.chat.messages

The ToolResponseMessage class represents a message with a function content in a chat application.

ToolResponseMessage(List<ToolResponseMessage.ToolResponse>, Map<String, Object>) - Constructor for class org.springframework.ai.chat.messages.ToolResponseMessage

ToolResponseMessage(Map<String, Object>, List<MessagePart>) - Constructor for class org.springframework.ai.chat.messages.ToolResponseMessage

Creates a message from an ordered list of parts.

ToolResponseMessage.Builder - Class in org.springframework.ai.chat.messages

Builder for ToolResponseMessage.

ToolResponseMessage.ToolResponse - Record Class in org.springframework.ai.chat.messages

A tool response.

ToolResultPart - Record Class in org.springframework.ai.chat.messages.part

The result of one tool call.

ToolResultPart(String, String, List<MessagePart>, boolean, OpaquePayload, Map<String, String>) - Constructor for record class org.springframework.ai.chat.messages.part.ToolResultPart

Creates an instance of a ToolResultPart record class.

ToolRuntimeHints - Class in org.springframework.ai.aot

Registers runtime hints for the tool calling APIs.

ToolRuntimeHints() - Constructor for class org.springframework.ai.aot.ToolRuntimeHints

tools - Variable in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

tools() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the tools record component.

tools() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the tools record component.

tools() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest

Returns the value of the tools record component.

tools(List<DeepSeekApi.FunctionTool>) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set the tools the model may call.

tools(List<DeepSeekApi.FunctionTool>) - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

tools(List<MistralAiApi.FunctionTool>) - Method in class org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder

tools(KeyValues, ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

tools(Object...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

Register one or more tools for this chat request.

tools(Object...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

tools(List<OllamaApi.ChatRequest.Tool>) - Method in class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Builder

TOOLS_ONLY - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCacheStrategy

Cache tool definitions only.

TOOLS_ONLY - Enum constant in enum class org.springframework.ai.bedrock.converse.api.BedrockCacheStrategy

Cache tool definitions only.

ToolSearchAdvisorAutoConfiguration - Class in org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure

Auto-configuration for ToolSearchToolCallingAdvisor.

ToolSearchAdvisorAutoConfiguration(ToolSearchAdvisorProperties) - Constructor for class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorAutoConfiguration

ToolSearchAdvisorProperties - Class in org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure

Configuration properties for ToolSearchAdvisorAutoConfiguration.

ToolSearchAdvisorProperties() - Constructor for class org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure.ToolSearchAdvisorProperties

ToolSearchAdvisorProperties.Eviction - Class in org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure

Eviction strategy settings for the per-session tool-index cache.

ToolSearchAdvisorProperties.Lucene - Class in org.springframework.ai.chat.client.advisor.toolsearch.autoconfigure

Settings specific to the Lucene-backed ToolIndex.

ToolSearchRequest - Record Class in org.springframework.ai.tool.toolsearch

Request for searching tools within a session's index.

ToolSearchRequest(String, String, Integer, String) - Constructor for record class org.springframework.ai.tool.toolsearch.ToolSearchRequest

Creates an instance of a ToolSearchRequest record class.

ToolSearchResponse - Record Class in org.springframework.ai.tool.toolsearch

Response containing a list of ToolReferences matching the search criteria, total matches, and search metadata.

ToolSearchResponse(List<ToolReference>, Integer, ToolSearchResponse.SearchMetadata) - Constructor for record class org.springframework.ai.tool.toolsearch.ToolSearchResponse

Creates an instance of a ToolSearchResponse record class.

ToolSearchResponse.Builder - Class in org.springframework.ai.tool.toolsearch

ToolSearchResponse.SearchMetadata - Record Class in org.springframework.ai.tool.toolsearch

Metadata about how a search was performed.

ToolSearchResponse.SearchMetadata.Builder - Class in org.springframework.ai.tool.toolsearch

toolSearchTool(String, Integer, String, ToolContext) - Method in class org.springframework.ai.tool.toolsearch.ToolSearchTool

ToolSearchTool - Class in org.springframework.ai.tool.toolsearch

ToolSearchTool(ToolIndex, Integer) - Constructor for class org.springframework.ai.tool.toolsearch.ToolSearchTool

ToolSearchToolCallingAdvisor - Class in org.springframework.ai.chat.client.advisor.toolsearch

CallAdvisor that integrates a tool search mechanism into the tool calling workflow.

ToolSearchToolCallingAdvisor(ToolCallingManager, int, ToolExecutionEligibilityChecker, ToolIndex, String, boolean, Integer, boolean, String, ToolIndexEvictionStrategy) - Constructor for class org.springframework.ai.chat.client.advisor.toolsearch.ToolSearchToolCallingAdvisor

ToolSearchToolCallingAdvisor.Builder<T extends ToolSearchToolCallingAdvisor.Builder<T>> - Class in org.springframework.ai.chat.client.advisor.toolsearch

Builder for creating instances of ToolSearchToolCallingAdvisor.

toolSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.AsyncMcpAnnotationProviders

toolSpecifications(List<Object>) - Static method in class org.springframework.ai.mcp.annotation.spring.SyncMcpAnnotationProviders

toolType(String) - Method in class org.springframework.ai.tool.observation.ToolCallingObservationContext.Builder

toolType(ToolCallingObservationContext) - Method in class org.springframework.ai.tool.observation.DefaultToolCallingObservationConvention

ToolUtils - Class in org.springframework.ai.tool.support

Miscellaneous tool utility methods.

toOpenAiCreateParams(List<String>) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions

toOpenAiImageGenerateParams(ImagePrompt) - Method in class org.springframework.ai.openai.OpenAiImageOptions

toOptions() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicCacheProperties

toOptions() - Method in class org.springframework.ai.model.anthropic.autoconfigure.AnthropicChatProperties

toOptions() - Method in class org.springframework.ai.model.bedrock.cohere.autoconfigure.BedrockCohereEmbeddingProperties

toOptions() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockCacheProperties

toOptions() - Method in class org.springframework.ai.model.bedrock.converse.autoconfigure.BedrockConverseProxyChatProperties

toOptions() - Method in class org.springframework.ai.model.deepseek.autoconfigure.DeepSeekChatProperties

toOptions() - Method in class org.springframework.ai.model.elevenlabs.autoconfigure.ElevenLabsSpeechProperties

toOptions() - Method in class org.springframework.ai.model.google.genai.autoconfigure.chat.GoogleGenAiChatProperties

toOptions() - Method in class org.springframework.ai.model.google.genai.autoconfigure.embedding.GoogleGenAiTextEmbeddingProperties

toOptions() - Method in class org.springframework.ai.model.google.genai.autoconfigure.image.GoogleGenAiImageProperties

toOptions() - Method in class org.springframework.ai.model.google.genai.autoconfigure.transcription.GoogleGenAiTranscriptionProperties

toOptions() - Method in class org.springframework.ai.model.google.genai.autoconfigure.tts.GoogleGenAiTextToSpeechProperties

toOptions() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatProperties

toOptions() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingProperties

toOptions() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiModerationProperties

toOptions() - Method in class org.springframework.ai.model.mistralai.autoconfigure.MistralAiOcrProperties

toOptions() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaChatProperties

toOptions() - Method in class org.springframework.ai.model.ollama.autoconfigure.OllamaEmbeddingProperties

toOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioSpeechProperties

toOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiAudioTranscriptionProperties

toOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties

toOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

toOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

toOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiModerationProperties

toOptions() - Method in class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties

toOptions() - Method in class org.springframework.ai.model.postgresml.autoconfigure.PostgresMlEmbeddingProperties

toOptions() - Method in class org.springframework.ai.model.stabilityai.autoconfigure.StabilityAiImageProperties

toOptions() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultimodalEmbeddingProperties

toOptions() - Method in class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties

TOP_K - Static variable in class org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor

toPayload() - Method in record class org.springframework.ai.session.compaction.CompactionBoundary

The payload of the boundary event, as stored.

topK - Variable in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

topK(int) - Method in class org.springframework.ai.vectorstore.bedrockknowledgebase.BedrockKnowledgeBaseVectorStore.Builder

Sets the default number of results to return.

topK(int) - Method in class org.springframework.ai.vectorstore.milvus.MilvusSearchRequest.MilvusBuilder

SearchRequest.Builder.topK(int)

topK(int) - Method in class org.springframework.ai.vectorstore.SearchRequest.Builder

topK(Float) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

topK(Float) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.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

topK(Integer) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

topK(Integer) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

topK(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

topK(Integer) - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever.Builder

topLeftX() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.ExtractedImage

Returns the value of the topLeftX record component.

topLeftY() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.ExtractedImage

Returns the value of the topLeftY record component.

topLogprobs - Variable in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

topLogprobs - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

topLogprobs() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the topLogprobs record component.

topLogprobs() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content

Returns the value of the topLogprobs record component.

topLogprobs() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content

Returns the value of the topLogprobs record component.

topLogprobs(Integer) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set the number of most likely tokens to return log probabilities for.

topLogprobs(Integer) - Method in class org.springframework.ai.deepseek.DeepSeekChatOptions.AbstractBuilder

topLogprobs(Integer) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

TopLogProbs(String, Float, List<Integer>) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content.TopLogProbs

Creates an instance of a TopLogProbs record class.

TopLogProbs(String, Float, List<Integer>) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content.TopLogProbs

Creates an instance of a TopLogProbs record class.

topP - Variable in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

topP() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns the value of the topP record component.

topP() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns the value of the topP record component.

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

topP(Double) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Builder

Set the top_p value.

topP(Double) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

topP(Float) - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.Builder

topP(Float) - Method in class org.springframework.ai.google.genai.transcription.GoogleGenAiAudioTranscriptionOptions.Builder

toPrimitive(Float[]) - Static method in class org.springframework.ai.model.EmbeddingUtils

toPrimitive(List<Float>) - Static method in class org.springframework.ai.model.EmbeddingUtils

toPrompt(List<Message>) - Method in class org.springframework.ai.bedrock.MessageToPromptConverter

toSdkServiceTier() - Method in enum class org.springframework.ai.anthropic.AnthropicServiceTier

Converts this enum to the corresponding SDK MessageCreateParams.ServiceTier value.

toServerParameters() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStdioClientProperties.Parameters

toServerParameters() - Method in class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStdioClientProperties

toSkill() - Method in enum class org.springframework.ai.anthropic.AnthropicSkill

Convert to an AnthropicSkillRecord with latest version.

toSkill(String) - Method in enum class org.springframework.ai.anthropic.AnthropicSkill

Convert to an AnthropicSkillRecord with specific version.

toSkillsList() - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer

Convert to a list of maps suitable for JSON serialization via JsonValue.from(Map.of("skills", container.toSkillsList())).

toStatelessAsyncToolSpecification(ToolCallback, MimeType) - Static method in class org.springframework.ai.mcp.McpToolUtils

toStatelessSyncToolSpecification(ToolCallback, MimeType) - Static method in class org.springframework.ai.mcp.McpToolUtils

Converts a Spring AI ToolCallback to an MCP StatelessSyncToolSpecification.

toString() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchResult

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation

Returns a string representation of this record class.

toString() - Method in class org.springframework.ai.anthropic.Citation

toString() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit

toString() - Method in class org.springframework.ai.audio.transcription.AudioTranscription

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.bedrock.api.AbstractBedrockApi.AmazonBedrockInvocationMetrics

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingResponse

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingResponse

Returns a string representation of this record class.

toString() - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

toString() - Method in record class org.springframework.ai.chat.client.ChatClientRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chat.client.ChatClientResponse

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chat.client.ResponseEntity

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.SchemaColumn

Deprecated.

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chat.memory.repository.mongo.Conversation.Message

Deprecated.

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chat.memory.repository.mongo.Conversation

Deprecated.

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chat.memory.repository.redis.AdvancedRedisChatMemoryRepository.MessageWithConversation

Deprecated.

Returns a string representation of this record class.

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 record class org.springframework.ai.chat.messages.part.MediaPart.MediaDto

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chat.messages.part.MediaPart

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chat.messages.part.OpaquePayload

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chat.messages.part.ReasoningPart

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chat.messages.part.TextPart

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chat.messages.part.ToolCallPart

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chat.messages.part.ToolResultPart

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chat.messages.part.UnknownPart

Returns a string representation of this record class.

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 record class org.springframework.ai.chroma.vectorstore.ChromaApi.AddEmbeddingsRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Collection

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateCollectionRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateDatabaseRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.CreateTenantRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Database

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.DeleteEmbeddingsRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Embedding

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingResponse

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingsRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryResponse

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.Tenant

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion.Choice

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk.ChunkChoice

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.ChatCompletionFunction

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.ToolCall

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Thinking

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content.TopLogProbs

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs.Content

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.LogProbs

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.Usage.PromptTokensDetails

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.Usage

Returns a string representation of this record class.

toString() - Method in class org.springframework.ai.deepseek.api.ResponseFormat

toString() - Method in class org.springframework.ai.deepseek.DeepSeekAssistantMessage

Deprecated.

toString() - Method in class org.springframework.ai.deepseek.DeepSeekChatModel

toString() - Method in class org.springframework.ai.document.Document

toString() - Method in enum class org.springframework.ai.document.DocumentMetadata

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.VoiceSettings

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerificationFile

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ReaderResource

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Recording

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Sample

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerificationAttempt

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerifiedVoiceLanguage

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voices

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSettings

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharingModerationCheck

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceVerification

Returns a string representation of this record class.

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.evaluation.EvaluationRequest

toString() - Method in class org.springframework.ai.evaluation.EvaluationResponse

toString() - Method in class org.springframework.ai.google.genai.cache.CachedContentRequest

toString() - Method in class org.springframework.ai.google.genai.cache.CachedContentUpdateRequest

toString() - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent

toString() - Method in class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting

toString() - Method in record class org.springframework.ai.google.genai.GoogleGenAiChatModel.GeminiRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice

Returns a string representation of this record class.

toString() - Method in class org.springframework.ai.google.genai.image.GoogleGenAiImageGenerationMetadata

toString() - Method in class org.springframework.ai.google.genai.metadata.GoogleGenAiModalityTokenCount

toString() - Method in enum class org.springframework.ai.google.genai.metadata.GoogleGenAiTrafficType

toString() - Method in class org.springframework.ai.google.genai.metadata.GoogleGenAiUsage

toString() - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.MultiSpeakerTurn

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.ReplicatedVoice

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.SpeakerVoiceConfig

Returns a string representation of this record class.

toString() - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions

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.mcp.annotation.context.StructuredElicitResult

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.McpMeta

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.method.changed.prompt.AsyncPromptListChangedSpecification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.method.changed.prompt.SyncPromptListChangedSpecification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.method.changed.resource.AsyncResourceListChangedSpecification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.method.changed.resource.SyncResourceListChangedSpecification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.method.changed.tool.AsyncToolListChangedSpecification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.method.changed.tool.SyncToolListChangedSpecification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.method.elicitation.AsyncElicitationSpecification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.method.elicitation.SyncElicitationSpecification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.method.logging.AsyncLoggingSpecification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.method.logging.SyncLoggingSpecification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.method.progress.AsyncProgressSpecification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.method.progress.SyncProgressSpecification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.method.sampling.AsyncSamplingSpecification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.annotation.method.sampling.SyncSamplingSpecification

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration.CloseableMcpAsyncClients

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration.CloseableMcpSyncClients

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.NamedClientMcpTransport

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpSseClientProperties.SseParameters

Deprecated.

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStdioClientProperties.Parameters

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStreamableHttpClientProperties.ConnectionParameters

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mcp.McpConnectionInfo

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion.Choice

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk.ChunkChoice

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ChatCompletionFunction

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ReferenceChunk

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.TextChunk

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ThinkChunk

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ToolCall

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage

Returns a string representation of this record class.

toString() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema

toString() - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.Embedding

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingList

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content.TopLogProbs

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.LogProbs

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.Usage

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationResponse

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.MistralAiModerationResult

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.ExtractedImage

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPage

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPageDimensions

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.DocumentURLChunk

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.ImageURLChunk

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRResponse

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRUsageInfo

Returns a string representation of this record class.

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 record class org.springframework.ai.model.tool.ToolCallDecision

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.model.tool.ToolCallDecisions

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.observation.AiOperationMetadata

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool.Function

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.CopyModelRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.DeleteModelRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsResponse

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ListModelResponse

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message.ToolCall

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message.ToolCallFunction

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Message

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model.Details

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.Model

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ProgressResponse

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.PullModelRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelResponse

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.ThinkOption.ThinkBoolean

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.api.ThinkOption.ThinkLevel

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.ollama.management.ModelManagementOptions

Returns a string representation of this record class.

toString() - Method in class org.springframework.ai.openai.metadata.OpenAiAudioSpeechResponseMetadata

toString() - Method in class org.springframework.ai.openai.metadata.OpenAiAudioTranscriptionResponseMetadata

toString() - Method in class org.springframework.ai.openai.metadata.OpenAiImageGenerationMetadata

toString() - Method in class org.springframework.ai.openai.metadata.OpenAiImageResponseMetadata

toString() - Method in class org.springframework.ai.openai.metadata.OpenAiRateLimit

toString() - Method in record class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.openai.OpenAiChatOptions.StreamOptions

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.openai.responses.HostedTool.CodeInterpreter

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.openai.responses.HostedTool.FileSearch

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.openai.responses.HostedTool.ImageGeneration

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.openai.responses.HostedTool.Mcp

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.openai.responses.HostedTool.Raw

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.openai.responses.HostedTool.WebSearch

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.rag.Query

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.reader.pdf.config.ParagraphManager.Paragraph

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.session.compaction.CompactionBoundary

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.session.compaction.CompactionRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.session.compaction.CompactionResult

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.session.compaction.CompactionWindow

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.session.compaction.SummaryRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.session.EventFilter

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.session.EventFilter.Window.All

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.session.EventFilter.Window.Last

Returns a string representation of this record class.

toString() - Method in class org.springframework.ai.session.EventType

toString() - Method in record class org.springframework.ai.session.support.SessionEventCodec.EncodedEvent

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.session.support.SessionEventCodec.MessageBody

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.TextPrompts

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageResponse.Artifacts

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageResponse

Returns a string representation of this record class.

toString() - Method in class org.springframework.ai.stabilityai.StabilityAiImageGenerationMetadata

toString() - Method in enum class org.springframework.ai.stabilityai.StyleEnum

toString() - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.Booking

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.BookingRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.Weather

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.WeatherRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Request

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Response

Returns a string representation of this record class.

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

toString() - Method in record class org.springframework.ai.tool.toolsearch.ToolReference

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchRequest

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchResponse.SearchMetadata

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchResponse

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.vectorstore.azure.AzureVectorStore.MetadataField

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.SchemaColumn

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.CouchbaseDocument

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.vectorstore.EmbeddedDocument

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Expression

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Group

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Key

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Value

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder.Op

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBDocument

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.MongoDBDocument

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.OpenSearchDocument

Returns a string representation of this record class.

toString() - Method in record class org.springframework.ai.vectorstore.redis.RedisVectorStore.MetadataField

Returns a string representation of this record class.

toString() - Method in class org.springframework.ai.vectorstore.SearchRequest

toString() - Method in record class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.MetadataField

Returns a string representation of this record class.

toSyncToolSpecification(List<ToolCallback>) - Static method in class org.springframework.ai.mcp.McpToolUtils

Converts a list of Spring AI tool callbacks to MCP synchronous tool specification.

toSyncToolSpecification(ToolCallback) - Static method in class org.springframework.ai.mcp.McpToolUtils

Converts a Spring AI ToolCallback to an MCP SyncToolSpecification.

toSyncToolSpecification(ToolCallback, MimeType) - Static method in class org.springframework.ai.mcp.McpToolUtils

Converts a Spring AI ToolCallback to an MCP SyncToolSpecification.

toSyncToolSpecifications(ToolCallback...) - Static method in class org.springframework.ai.mcp.McpToolUtils

Convenience method to convert a variable number of tool callbacks to MCP synchronous tool specification.

total - Variable in class org.springframework.ai.mcp.annotation.context.DefaultProgressSpec

total() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ProgressResponse

Returns the value of the total record component.

total(double) - Method in class org.springframework.ai.mcp.annotation.context.DefaultProgressSpec

total(double) - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes.ProgressSpec

TOTAL - Enum constant in enum class org.springframework.ai.observation.conventions.AiTokenType

Total token.

totalDuration() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatResponse

Returns the value of the totalDuration record component.

totalDuration() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsResponse

Returns the value of the totalDuration record component.

totalMatches() - Method in record class org.springframework.ai.tool.toolsearch.ToolSearchResponse

Returns the value of the totalMatches record component.

totalMatches(Integer) - Method in class org.springframework.ai.tool.toolsearch.ToolSearchResponse.Builder

totalSize() - Method in class org.springframework.ai.tool.toolsearch.index.lucene.LuceneToolIndex

Returns the total number of documents across all session indexes.

totalSize() - Method in class org.springframework.ai.tool.toolsearch.index.regex.RegexToolIndex

Returns the total number of tools across all session indexes.

totalTokens() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage

Returns the value of the totalTokens record component.

totalTokens() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.Usage

Returns the value of the totalTokens record component.

totalTokens() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.Usage

Returns the value of the totalTokens record component.

toTool() - Method in record class org.springframework.ai.openai.responses.HostedTool.CodeInterpreter

toTool() - Method in record class org.springframework.ai.openai.responses.HostedTool.FileSearch

toTool() - Method in record class org.springframework.ai.openai.responses.HostedTool.ImageGeneration

toTool() - Method in record class org.springframework.ai.openai.responses.HostedTool.Mcp

toTool() - Method in record class org.springframework.ai.openai.responses.HostedTool.Raw

toTool() - Method in interface org.springframework.ai.openai.responses.HostedTool

Convert this tool to the SDK request representation.

toTool() - Method in record class org.springframework.ai.openai.responses.HostedTool.WebSearch

toToolResponse() - Method in record class org.springframework.ai.chat.messages.part.ToolResultPart

Converts this part back to a legacy ToolResponseMessage.ToolResponse by joining its text content.

toTypedObject(Object, Class<?>) - Static method in class org.springframework.ai.util.json.JsonParser

Deprecated, for removal: This API element is subject to removal in a future version.

Use JsonHelper.convertToTypedObject(java.lang.Object, java.lang.Class<?>) instead

toVector(Value) - Static method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils

TracingAwareLoggingObservationHandler<T extends io.micrometer.observation.Observation.Context> - Class in org.springframework.ai.observation

An ObservationHandler that can wrap another one and makes the tracing data available for the ObservationHandler.onStop(Observation.Context) method.

TracingAwareLoggingObservationHandler(ObservationHandler<T>, Tracer) - Constructor for class org.springframework.ai.observation.TracingAwareLoggingObservationHandler

Creates a new instance.

transactionManager(PlatformTransactionManager) - Method in class org.springframework.ai.chat.memory.repository.jdbc.JdbcChatMemoryRepository.Builder

Deprecated.

transactionManager(PlatformTransactionManager) - Method in class org.springframework.ai.session.jdbc.JdbcSessionRepository.Builder

The transaction manager; one on the data source by default.

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.

transcription() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Recording

Returns the value of the transcription record component.

TRANSCRIPTION - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType

AI operation type for audio transcription.

TRANSCRIPTION_MODEL_OPERATION - Enum constant in enum class org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationDocumentation

TranscriptionModel - Interface in org.springframework.ai.audio.transcription

A transcription model is a type of AI model that converts audio to text.

TranscriptionModelMeterObservationHandler - Class in org.springframework.ai.audio.transcription.observation

Handler for generating metrics from transcription model observations.

TranscriptionModelMeterObservationHandler(MeterRegistry) - Constructor for class org.springframework.ai.audio.transcription.observation.TranscriptionModelMeterObservationHandler

TranscriptionModelObservationContext - Class in org.springframework.ai.audio.transcription.observation

Context used to store metadata for transcription model exchanges.

TranscriptionModelObservationContext.Builder - Class in org.springframework.ai.audio.transcription.observation

TranscriptionModelObservationConvention - Interface in org.springframework.ai.audio.transcription.observation

Interface for an ObservationConvention for transcription model exchanges.

TranscriptionModelObservationDocumentation - Enum Class in org.springframework.ai.audio.transcription.observation

Documented conventions for transcription model observations.

TranscriptionModelObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.ai.audio.transcription.observation

High-cardinality observation key names for transcription model operations.

TranscriptionModelObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.ai.audio.transcription.observation

Low-cardinality observation key names for transcription model operations.

TranscriptionModelTranscriptObservationHandler - Class in org.springframework.ai.audio.transcription.observation

Handler for emitting the transcript a transcription model returned to logs.

TranscriptionModelTranscriptObservationHandler() - Constructor for class org.springframework.ai.audio.transcription.observation.TranscriptionModelTranscriptObservationHandler

transform(List<Document>) - Method in interface org.springframework.ai.document.DocumentTransformer

transform(Query) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.CompressionQueryTransformer

transform(Query) - Method in interface org.springframework.ai.rag.preretrieval.query.transformation.QueryTransformer

Transforms the given query according to the implemented strategy.

transform(Query) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer

transform(Query) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer

transformer(String) - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions.Builder

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

TransformersEmbeddingModel - Class in org.springframework.ai.transformers

An implementation of the AbstractEmbeddingModel that uses ONNX-based Transformer models for text embeddings.

TransformersEmbeddingModel() - Constructor for class org.springframework.ai.transformers.TransformersEmbeddingModel

TransformersEmbeddingModel(MetadataMode) - Constructor for class org.springframework.ai.transformers.TransformersEmbeddingModel

TransformersEmbeddingModel(MetadataMode, ObservationRegistry) - Constructor for class org.springframework.ai.transformers.TransformersEmbeddingModel

TransformersEmbeddingModelAutoConfiguration - Class in org.springframework.ai.model.transformers.autoconfigure

Auto-configuration for Transformers Embedding Model.

TransformersEmbeddingModelAutoConfiguration() - Constructor for class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelAutoConfiguration

TransformersEmbeddingModelProperties - Class in org.springframework.ai.model.transformers.autoconfigure

Configuration properties for the Transformer Embedding model.

TransformersEmbeddingModelProperties() - Constructor for class org.springframework.ai.model.transformers.autoconfigure.TransformersEmbeddingModelProperties

TransformersEmbeddingModelProperties.Cache - Class in org.springframework.ai.model.transformers.autoconfigure

TransformersEmbeddingModelProperties.Onnx - Class in org.springframework.ai.model.transformers.autoconfigure

TransformersEmbeddingModelProperties.Tokenizer - Class in org.springframework.ai.model.transformers.autoconfigure

Configurations for the HuggingFaceTokenizer used to convert sentences into tokens.

TransientAiException - Exception in org.springframework.ai.retry

Root of the hierarchy of Model access exceptions that are considered transient - where a previously failed operation might be able to succeed when the operation is retried without any intervention.

TransientAiException(String) - Constructor for exception org.springframework.ai.retry.TransientAiException

Constructor with message.

TransientAiException(String, Throwable) - Constructor for exception org.springframework.ai.retry.TransientAiException

Constructor with message and cause.

TranslationQueryTransformer - Class in org.springframework.ai.rag.preretrieval.query.transformation

Uses a large language model to translate a query to a target language that is supported by the embedding model used to generate the document embeddings.

TranslationQueryTransformer(ChatClient.Builder, PromptTemplate, String) - Constructor for class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer

TranslationQueryTransformer.Builder - Class in org.springframework.ai.rag.preretrieval.query.transformation

transport() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.NamedClientMcpTransport

Returns the value of the transport record component.

transportContext() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

transportContext() - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

transportContext() - Method in interface org.springframework.ai.mcp.annotation.context.McpRequestContextTypes

TRIE - Enum constant in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

trimAdjacentBlankLines(String) - Static method in class org.springframework.ai.reader.ExtractedTextFormatter

Replaces multiple, adjacent blank lines into a single blank line.

TRUE - Enum constant in enum class org.springframework.ai.model.ollama.autoconfigure.OllamaThinkProperties

truncate - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

truncate() - Method in record class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest

Returns the value of the truncate record component.

truncate() - Method in record class org.springframework.ai.ollama.api.OllamaApi.EmbeddingsRequest

Returns the value of the truncate record component.

truncate(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

truncate(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

truncate(CohereEmbeddingBedrockApi.CohereEmbeddingRequest.Truncate) - Method in class org.springframework.ai.bedrock.cohere.BedrockCohereEmbeddingOptions.Builder

truncation - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

truncation(String) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

trustManager(X509TrustManager) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder

trustManager(X509TrustManager) - Method in class org.springframework.ai.openai.http.okhttp.SpringAiOpenAiHttpClient.Builder

ttl(Duration) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent.Builder

ttl(BedrockCacheTtl) - Method in class org.springframework.ai.bedrock.converse.api.BedrockCacheOptions.Builder

Sets the cache TTL (Time To Live).

ttl(Duration) - Method in class org.springframework.ai.google.genai.cache.CachedContentRequest.Builder

ttl(Duration) - Method in class org.springframework.ai.google.genai.cache.CachedContentUpdateRequest.Builder

TtlEvictionStrategy - Class in org.springframework.ai.tool.toolsearch.eviction

A ToolIndexEvictionStrategy that evicts sessions whose last-access time is older than a configured time-to-live (TTL).

TtlEvictionStrategy(Duration) - Constructor for class org.springframework.ai.tool.toolsearch.eviction.TtlEvictionStrategy

Creates a new TtlEvictionStrategy.

ttlSeconds(long) - Method in class org.springframework.ai.chat.memory.repository.redis.RedisChatMemoryRepository.Builder

Deprecated.

Sets the time to live in seconds for messages stored in Redis.

TurnCountTrigger - Class in org.springframework.ai.session.compaction

Fires when the view holds more than a number of turns: a user message and everything up to the next one.

TurnCountTrigger(int) - Constructor for class org.springframework.ai.session.compaction.TurnCountTrigger

twitterUsername() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the twitterUsername record component.

type() - Method in record class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.SchemaColumn

Deprecated.

Returns the value of the type record component.

type() - Method in record class org.springframework.ai.chat.memory.repository.mongo.Conversation.Message

Deprecated.

Returns the value of the type record component.

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.deepseek.api.DeepSeekApi.ChatCompletionMessage.ToolCall

Returns the value of the type record component.

type() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Thinking

Returns the value of the type record component.

type() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ToolCall

Returns the value of the type record component.

type() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.DocumentURLChunk

Returns the value of the type record component.

type() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRRequest.ImageURLChunk

Returns the value of the type record component.

type() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool

Returns the value of the type record component.

type() - Method in record class org.springframework.ai.session.support.SessionEventCodec.EncodedEvent

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.

type() - Method in record class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.SchemaColumn

Returns the value of the type record component.

type() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Expression

Returns the value of the type record component.

type() - Method in record class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.MetadataField

Returns the value of the type record component.

type(AnthropicSkillType) - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord.Builder

type(ResponseFormat.Type) - Method in class org.springframework.ai.deepseek.api.ResponseFormat.Builder

type(MistralAiApi.ChatCompletionRequest.ResponseFormat.Type) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.Builder

type(OpenAiChatModel.ResponseFormat.Type) - Method in class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat.Builder

type(EventType) - Method in class org.springframework.ai.session.SessionEvent.Builder

What the event records; EventType.MESSAGE by default when a message is set.

TYPE - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolCallAttributes

Deprecated.

TYPE - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

TypeResolverHelper - Class in org.springframework.ai.tool.resolution

A utility class that provides methods for resolving types and classes related to functions.

TYPESENSE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by Typesense.

TYPESENSE - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

typesenseClient(TypesenseConnectionDetails) - Method in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseVectorStoreAutoConfiguration

TypesenseConnectionDetails - Interface in org.springframework.ai.vectorstore.typesense.autoconfigure

Connection details for a Typesense service client.

TypesenseDockerComposeConnectionDetailsFactory - Class in org.springframework.ai.docker.compose.service.connection.typesense

DockerComposeConnectionDetailsFactory for TypesenseConnectionDetails.

TypesenseDockerComposeConnectionDetailsFactory() - Constructor for class org.springframework.ai.docker.compose.service.connection.typesense.TypesenseDockerComposeConnectionDetailsFactory

TypesenseFilterExpressionConverter - Class in org.springframework.ai.vectorstore.typesense

Converts Filter.Expression into Typesense metadata filter expression format.

TypesenseFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.typesense.TypesenseFilterExpressionConverter

TypesenseServiceClientProperties - Class in org.springframework.ai.vectorstore.typesense.autoconfigure

Configuration properties for Typesense service client.

TypesenseServiceClientProperties() - Constructor for class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseServiceClientProperties

TypesenseVectorStore - Class in org.springframework.ai.vectorstore.typesense

A vector store implementation that uses Typesense as the backend.

TypesenseVectorStore(TypesenseVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

Protected constructor for creating a TypesenseVectorStore instance using the builder pattern.

TypesenseVectorStore.Builder - Class in org.springframework.ai.vectorstore.typesense

TypesenseVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.typesense.autoconfigure

Auto-configuration for Typesense Vector Store.

TypesenseVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseVectorStoreAutoConfiguration

TypesenseVectorStoreProperties - Class in org.springframework.ai.vectorstore.typesense.autoconfigure

Configuration properties for Typesense Vector Store.

TypesenseVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseVectorStoreProperties

typicalP - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

typicalP(Float) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

U

ULAW_8000 - Enum constant in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

unchanged() - Static method in record class org.springframework.ai.session.compaction.CompactionResult

The result of a pass that leaves the view as it is: nothing is written.

unescapeCurlyBrackets(String) - Static method in class org.springframework.ai.test.CurlyBracketEscaper

Unescapes previously escaped curly brackets by removing the backslashes

unit() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Request

Returns the value of the unit record component.

unit() - Method in record class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Response

Returns the value of the unit record component.

unitName - Variable in enum class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Unit

Human readable unit name.

UNKNOWN - Enum constant in enum class org.springframework.ai.google.genai.metadata.GoogleGenAiTrafficType

Unknown or unspecified traffic type.

UnknownPart - Record Class in org.springframework.ai.chat.messages.part

A part that neither an adapter nor this version of Spring AI recognizes, kept verbatim so nothing is silently dropped.

UnknownPart(String, String, String, OpaquePayload, Map<String, String>) - Constructor for record class org.springframework.ai.chat.messages.part.UnknownPart

Creates an instance of a UnknownPart record class.

unlimitedCallsPerTool() - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder

Disable the per-tool call limit entirely, undoing DefaultToolCallingManager.Builder.maxCallsPerTool(int) (or the DefaultToolCallingManager.DEFAULT_MAX_CALLS_PER_TOOL default), so that, absent a specific DefaultToolCallingManager.Builder.maxCallsPerTool(String, int) override, any tool can be called an unlimited number of times.

unlimitedTotalToolCalls() - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder

Disable the total tool call limit entirely, undoing DefaultToolCallingManager.Builder.maxTotalToolCalls(int) (or the DefaultToolCallingManager.DEFAULT_MAX_TOTAL_TOOL_CALLS default).

unmarshalFrom(Object, TypeRef<T>) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebClientStreamableHttpTransport

unmarshalFrom(Object, TypeRef<T>) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport

Deprecated.

Unmarshalls data from a generic Object into the specified type using the configured ObjectMapper.

update(String, CachedContentUpdateRequest) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService

Updates cached content with new TTL or expiration.

updateAsync(String, CachedContentUpdateRequest) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContentService

Asynchronously updates cached content with new TTL or expiration.

updateTime(Instant) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent.Builder

uploadDateUnix() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ManualVerificationFile

Returns the value of the uploadDateUnix record component.

uploadDateUnix() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Recording

Returns the value of the uploadDateUnix record component.

UPPER_BOUND_BEAM_WIDTH - Static variable in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore

UPPER_CASE_TYPE_VALUES - Enum constant in enum class org.springframework.ai.util.json.schema.JsonSchemaGenerator.SchemaOption

Convert all "type" values to upper case.

upsert(List<EmbeddedDocument>) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

Like AbstractObservationVectorStore.add(List), this path accepts text documents only, but for a different reason: add is restricted because it invokes the text embedding model, while upsert never embeds and is restricted because no store can persist a row that carries no text.

upsert(List<EmbeddedDocument>) - Method in interface org.springframework.ai.vectorstore.VectorStore

Upserts a list of EmbeddedDocuments into the vector store using caller-supplied embeddings, bypassing the store's own embedding model.

UPSERT - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Operation

VectorStore upsert operation.

upsertEmbeddings(String, String, String, ChromaApi.AddEmbeddingsRequest) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

upsertIntoExistingSchemaWithoutEmbeddingModel() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

upsertWithConfiguredDimensionsWithoutEmbeddingModel() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

uri - Variable in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

uri - Variable in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback

uri - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

uri - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

uri() - Element in annotation interface org.springframework.ai.mcp.annotation.McpComplete

The name reference to a resource template URI.

uri() - Element in annotation interface org.springframework.ai.mcp.annotation.McpResource

the URI of the resource.

uri(String) - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

Set the URI reference.

uri(String) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

Set the URI for the resource.

uriTemplateManager - Variable in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback

uriTemplateManager - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

uriTemplateManagerFactory - Variable in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

uriTemplateManagerFactory - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

uriTemplateManagerFactory(McpUriTemplateManagerFactory) - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

Set the URI template manager factory.

uriTemplateManagerFactory(McpUriTemplateManagerFactory) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

Set the URI template manager factory.

uriVariables - Variable in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback

uriVariables - Variable in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

url() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchResult

Returns the value of the url record component.

url() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpSseClientProperties.SseParameters

Deprecated.

Returns the value of the url record component.

url() - Method in record class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpStreamableHttpClientProperties.ConnectionParameters

Returns the value of the url record component.

url() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl

Returns the value of the url record component.

URL - Enum constant in enum class org.springframework.ai.chat.memory.repository.neo4j.MediaAttributes

Deprecated.

URLValidator - Class in org.springframework.ai.bedrock.converse.api

Utility class for detecting and normalizing URLs.

usage() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletion

Returns the value of the usage record component.

usage() - Method in record class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionChunk

Returns the value of the usage record component.

usage() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletion

Returns the value of the usage record component.

usage() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk

Returns the value of the usage record component.

usage() - Method in record class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingList

Returns the value of the usage record component.

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(Integer, Integer, Integer) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.Usage

Usage(Integer, Integer, Integer) - Constructor for record class org.springframework.ai.mistralai.api.MistralAiApi.Usage

Creates an instance of a Usage record class.

Usage(Integer, Integer, Integer, DeepSeekApi.Usage.PromptTokensDetails) - Constructor for record class org.springframework.ai.deepseek.api.DeepSeekApi.Usage

Creates an instance of a Usage record class.

USAGE_CACHE_READ_INPUT_TOKENS - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames

The number of input tokens served from a provider-managed cache.

USAGE_CACHE_READ_INPUT_TOKENS - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

The number of input tokens served from a provider-managed cache.

USAGE_CACHE_WRITE_INPUT_TOKENS - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames

The number of input tokens written to a provider-managed cache.

USAGE_CACHE_WRITE_INPUT_TOKENS - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

The number of input tokens written to a provider-managed cache.

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_INPUT_TOKENS - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

The number of tokens used in the model input.

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_OUTPUT_TOKENS - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

The number of tokens used in the model output.

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.

USAGE_TOTAL_TOKENS - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

The total number of tokens used in the model exchange.

UsageAccumulator - Class in org.springframework.ai.chat.client.advisor

Accumulates token Usage across the iterations of a recursive advisor (for example a tool-calling loop or a structured-output validation retry loop), so that the final response reports the cumulative usage of every model call rather than only the last one.

UsageAccumulator() - Constructor for class org.springframework.ai.chat.client.advisor.UsageAccumulator

usageCacheReadInputTokens(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention

usageCacheWriteInputTokens(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention

UsageCalculator - Class in org.springframework.ai.support

A utility class to provide support methods handling Usage.

usageInfo() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRResponse

Returns the value of the usageInfo record component.

usageInputTokens(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention

usageInputTokens(KeyValues, EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention

usageMetadata(CachedContentUsageMetadata) - Method in class org.springframework.ai.google.genai.cache.GoogleGenAiCachedContent.Builder

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

useApproximateKnn(boolean) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore.Builder

Sets whether to use approximate k-NN search.

useCacheBlock() - Method in class org.springframework.ai.anthropic.CacheEligibilityResolver

useCachedContent - Variable in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

useCachedContent(Boolean) - Method in class org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder

useMLock - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

useMLock(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

useMLock(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

useMMap - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

useMMap(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

useMMap(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

useNUMA - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

useNUMA(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

useNUMA(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

useProviderStructuredOutput() - Method in interface org.springframework.ai.chat.client.ChatClient.EntityParamSpec

Delivers the JSON schema to the AI provider as an API-level constraint rather than appending it as prompt text.

useProviderStructuredOutput() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultEntityParamSpec

user - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

user(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

user(String) - Method in class org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder

user(String) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder

user(String) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

user(String) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

user(String) - Static method in class org.springframework.ai.test.session.AbstractSessionRepositoryContractTests

user(Consumer<ChatClient.PromptUserSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

user(Consumer<ChatClient.PromptUserSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

user(Resource) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

user(Resource) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

user(Resource, Charset) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec

user(Resource, Charset) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

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.

USER - Enum constant in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.Role

User message.

USER - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.GeminiMessageType

USER - Enum constant in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.Role

USER - Enum constant in enum class org.springframework.ai.ollama.api.OllamaApi.Message.Role

User message type.

userLocation(String, String, String, String) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool.Builder

UserLocation(String, String, String, String) - Constructor for record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation

Creates an instance of a UserLocation record class.

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(List<MessagePart>, Map<String, Object>) - Constructor for class org.springframework.ai.chat.messages.UserMessage

Creates a message from an ordered list of parts.

UserMessage(Resource) - Constructor for class org.springframework.ai.chat.messages.UserMessage

UserMessage.Builder - Class in org.springframework.ai.chat.messages

Builder for UserMessage.

username() - Method in record class org.springframework.ai.ollama.api.OllamaApi.PullModelRequest

Returns the value of the username record component.

username(String) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

Sets the username to authenticate requests with

useSpeakerBoost() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.VoiceSettings

Returns the value of the useSpeakerBoost record component.

useSpeakerBoost() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSettings

Returns the value of the useSpeakerBoost record component.

UUID - Enum constant in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgIdType

V

validate() - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback.AbstractBuilder

Validate the builder state.

validate() - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback.AbstractBuilder

Validate the builder state.

validate() - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback.AbstractBuilder

Validate the builder state.

validate() - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback.AbstractBuilder

Validate the builder state.

validate() - Method in class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback.AbstractBuilder

Validate the builder state.

validate() - Method in class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback.AbstractBuilder

Validate the builder state.

validate() - Method in class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback.AbstractBuilder

Validate the builder state.

validate() - Method in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback.AbstractBuilder

Validate the builder state.

validate() - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.AbstractBuilder

Validate the builder state.

validate() - Method in class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback.AbstractBuilder

Validate the builder state.

validateAndEnquoteIdentifier(String, boolean) - Static method in class org.springframework.ai.vectorstore.mariadb.MariaDBSchemaValidator

Escaped identifier according to MariaDB requirement.

validateCitationConsistency() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions

Validate that all citation documents have consistent citation settings.

VALIDATED - Enum constant in enum class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice.Mode

Model predicts either a function call or a natural language response.

validateMethod(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback

Validates that the method signature is compatible with the prompt list changed consumer callback.

validateMethod(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback

Validates that the method signature is compatible with the resource list changed consumer callback.

validateMethod(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback

Validates that the method signature is compatible with the tool list changed consumer callback.

validateMethod(Method) - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback

Validates that the method signature is compatible with the complete callback.

validateMethod(Method) - Method in class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback

Validates that the method signature is compatible with the elicitation callback.

validateMethod(Method) - Method in class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback

Validates that the method signature is compatible with the logging consumer callback.

validateMethod(Method) - Method in class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback

Validates that the method signature is compatible with the progress callback.

validateMethod(Method) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback

Validates that the method signature is compatible with the prompt callback.

validateMethod(Method) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

Validates that the method signature is compatible with the resource callback.

validateMethod(Method) - Method in class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback

Validates that the method signature is compatible with the sampling callback.

validateParameters(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback

Validates method parameters.

validateParameters(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback

Validates method parameters.

validateParameters(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback

Validates method parameters.

validateParameters(Method) - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback

Validates method parameters.

validateParameters(Method) - Method in class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback

Validates method parameters.

validateParameters(Method) - Method in class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback

Validates method parameters.

validateParameters(Method) - Method in class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback

Validates method parameters.

validateParameters(Method) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback

Validates method parameters.

validateParameters(Method) - Method in class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback

Validates method parameters.

validateParametersWithoutUriVariables(Method) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

Validates method parameters when no URI variables are present.

validateParametersWithUriVariables(Method) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

Validates method parameters when URI variables are present.

validateParamType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback

validateParamType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AsyncMcpPromptMethodCallback

validateParamType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AsyncStatelessMcpPromptMethodCallback

validateParamType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.prompt.SyncMcpPromptMethodCallback

validateParamType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.prompt.SyncStatelessMcpPromptMethodCallback

validateParamType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

validateParamType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.resource.AsyncMcpResourceMethodCallback

validateParamType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.resource.AsyncStatelessMcpResourceMethodCallback

validateParamType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.resource.SyncMcpResourceMethodCallback

validateParamType(Class<?>) - Method in class org.springframework.ai.mcp.annotation.method.resource.SyncStatelessMcpResourceMethodCallback

validateRequest(McpSchema.CallToolRequest) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractAsyncMcpToolMethodCallback

Validates that the request is not null.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.AbstractMcpPromptListChangedMethodCallback

Validates that the method return type is compatible with the prompt list changed consumer callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.AsyncMcpPromptListChangedMethodCallback

Validates that the method return type is compatible with the prompt list changed consumer callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.prompt.SyncMcpPromptListChangedMethodCallback

Validates that the method return type is compatible with the prompt list changed consumer callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.AbstractMcpResourceListChangedMethodCallback

Validates that the method return type is compatible with the resource list changed consumer callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.AsyncMcpResourceListChangedMethodCallback

Validates that the method return type is compatible with the resource list changed consumer callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.resource.SyncMcpResourceListChangedMethodCallback

Validates that the method return type is compatible with the resource list changed consumer callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.AbstractMcpToolListChangedMethodCallback

Validates that the method return type is compatible with the tool list changed consumer callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.AsyncMcpToolListChangedMethodCallback

Validates that the method return type is compatible with the tool list changed consumer callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.changed.tool.SyncMcpToolListChangedMethodCallback

Validates that the method return type is compatible with the tool list changed consumer callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.complete.AbstractMcpCompleteMethodCallback

Validates that the method return type is compatible with the complete callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.complete.AsyncMcpCompleteMethodCallback

Validates that the method return type is compatible with the complete callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.complete.AsyncStatelessMcpCompleteMethodCallback

Validates that the method return type is compatible with the complete callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.complete.SyncMcpCompleteMethodCallback

Validates that the method return type is compatible with the complete callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.complete.SyncStatelessMcpCompleteMethodCallback

Validates that the method return type is compatible with the complete callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.elicitation.AbstractMcpElicitationMethodCallback

Validates that the method return type is compatible with the elicitation callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.elicitation.AsyncMcpElicitationMethodCallback

Validates that the method return type is compatible with the elicitation callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.elicitation.SyncMcpElicitationMethodCallback

Validates that the method return type is compatible with the elicitation callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.logging.AbstractMcpLoggingMethodCallback

Validates that the method return type is compatible with the logging consumer callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.logging.AsyncMcpLoggingMethodCallback

Validates that the method return type is compatible with the logging consumer callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.logging.SyncMcpLoggingMethodCallback

Validates that the method return type is compatible with the logging consumer callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.progress.AbstractMcpProgressMethodCallback

Validates that the method return type is compatible with the progress callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.progress.AsyncMcpProgressMethodCallback

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.progress.SyncMcpProgressMethodCallback

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AbstractMcpPromptMethodCallback

Validates that the method return type is compatible with the prompt callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AsyncMcpPromptMethodCallback

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.prompt.AsyncStatelessMcpPromptMethodCallback

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.prompt.SyncMcpPromptMethodCallback

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.prompt.SyncStatelessMcpPromptMethodCallback

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback

Validates that the method return type is compatible with the resource callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.resource.AsyncMcpResourceMethodCallback

Validates that the method return type is compatible with the resource callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.resource.AsyncStatelessMcpResourceMethodCallback

Validates that the method return type is compatible with the resource callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.resource.SyncMcpResourceMethodCallback

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.resource.SyncStatelessMcpResourceMethodCallback

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.sampling.AbstractMcpSamplingMethodCallback

Validates that the method return type is compatible with the sampling callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.sampling.AsyncMcpSamplingMethodCallback

Validates that the method return type is compatible with the sampling callback.

validateReturnType(Method) - Method in class org.springframework.ai.mcp.annotation.method.sampling.SyncMcpSamplingMethodCallback

Validates that the method return type is compatible with the sampling callback.

validateSchema() - Method in interface org.springframework.ai.chat.client.ChatClient.EntityParamSpec

Validates the model's JSON response against the entity schema and retries with the error feedback on failure, up to maxRepeatAttempts times (default: 3).

validateSchema() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultEntityParamSpec

validateStFunctions() - Method in class org.springframework.ai.template.st.StTemplateRenderer.Builder

Configures the renderer to support StringTemplate's built-in functions during validation.

validateSyncRequest(McpSchema.CallToolRequest) - Method in class org.springframework.ai.mcp.annotation.method.tool.AbstractSyncMcpToolMethodCallback

Validates that the request is not null.

validateToolCallbacks(List<ToolCallback>) - Static method in interface org.springframework.ai.model.tool.ToolCallingChatOptions

validationMode(ValidationMode) - Method in class org.springframework.ai.template.st.StTemplateRenderer.Builder

Sets the validation mode to control behavior when the provided variables do not match the variables required by the template.

ValidationMode - Enum Class in org.springframework.ai.template

Validation modes for template renderers.

value - Variable in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatModel

value - Variable in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.TextNormalizationMode

value - Variable in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.CategoryEnum

value - Variable in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ReaderResource.ResourceTypeEnum

value - Variable in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.SafetyControlEnum

value - Variable in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.CategoryEnum

value - Variable in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.ReviewStatusEnum

value - Variable in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.StatusEnum

value - Variable in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

value - Variable in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.GeminiMessageType

value - Variable in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Operation

value() - Method in enum class org.springframework.ai.document.DocumentMetadata

value() - Method in record class org.springframework.ai.model.SimpleApiKey

Returns the value of the value record component.

value() - Method in enum class org.springframework.ai.observation.conventions.AiObservationAttributes

Return the value of the attribute key.

value() - Method in enum class org.springframework.ai.observation.conventions.AiObservationMetricAttributes

Return the value of the metric attribute.

value() - Method in enum class org.springframework.ai.observation.conventions.AiObservationMetricNames

Return the value of the metric name.

value() - Method in enum class org.springframework.ai.observation.conventions.AiOperationType

Return the value of the operation type.

value() - Method in enum class org.springframework.ai.observation.conventions.AiProvider

Return the value of the provider.

value() - Method in enum class org.springframework.ai.observation.conventions.AiTokenType

Return the value of the token type.

value() - Method in enum class org.springframework.ai.observation.conventions.SpringAiKind

Return the value of the Spring AI kind.

value() - Method in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

Return the string value of the attribute.

value() - Method in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Return the value of the vector store provider.

value() - Method in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric

value() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Value

Returns the value of the value record component.

value() - Method in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Operation

Value(Object) - Constructor for record class org.springframework.ai.vectorstore.filter.Filter.Value

Creates an instance of a Value record class.

valueOf(boolean) - Static method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils

valueOf(int) - Static method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils

valueOf(Struct) - Static method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils

valueOf(String) - Static method in enum class org.springframework.ai.anthropic.AnthropicCacheStrategy

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.anthropic.AnthropicCacheTtl

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.anthropic.AnthropicCitationDocument.DocumentType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.anthropic.AnthropicServiceTier

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.anthropic.AnthropicSkill

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.anthropic.AnthropicSkillType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.anthropic.Citation.LocationType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationDocumentation.HighCardinalityKeyNames

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationDocumentation.LowCardinalityKeyNames

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.audio.transcription.observation.TranscriptionModelObservationDocumentation

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationDocumentation.HighCardinalityKeyNames

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationDocumentation.LowCardinalityKeyNames

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.audio.tts.observation.TextToSpeechModelObservationDocumentation

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingModel

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest.Truncate

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.bedrock.converse.api.BedrockCacheStrategy

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.bedrock.converse.api.BedrockCacheTtl

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingModel

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingModel.InputType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.HighCardinalityKeyNames

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.LowCardinalityKeyNames

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.chat.client.ChatClientAttributes

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.LowCardinalityKeyNames

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.chat.memory.repository.neo4j.MediaAttributes

Deprecated.

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.chat.memory.repository.neo4j.MessageAttributes

Deprecated.

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolCallAttributes

Deprecated.

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.chat.memory.repository.neo4j.ToolResponseAttributes

Deprecated.

Returns the enum constant of this class with the specified name.

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.chroma.vectorstore.ChromaApi.QueryRequest.Include

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionFinishReason

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.Role

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.ReasoningEffort

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.Thinking.Type

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatModel

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool.Type

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.deepseek.api.ResponseFormat.Type

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.document.DocumentMetadata

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.document.MetadataMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.OutputFormat

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.TextNormalizationMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.CategoryEnum

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.ReaderResource.ResourceTypeEnum

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.SafetyControlEnum

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.CategoryEnum

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.ReviewStatusEnum

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.StatusEnum

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.google.genai.common.GoogleGenAiSafetySetting.HarmBlockMethod

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmBlockThreshold

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.HarmCategory

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.google.genai.common.GoogleGenAiServiceTier

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.google.genai.common.GoogleGenAiThinkingLevel

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.ChatModel

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.GeminiMessageType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice.Mode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageModelName

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.PersonGeneration

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.google.genai.image.GoogleGenAiImageOptions.SafetyFilterLevel

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.google.genai.metadata.GoogleGenAiTrafficType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModelName

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingOptions.TaskType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.AudioEncoding

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.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.ContentType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mcp.annotation.method.tool.ReturnMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mcp.client.common.autoconfigure.properties.McpClientCommonProperties.ClientType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.ApiType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mcp.server.common.autoconfigure.properties.McpServerProperties.ServerProtocol

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl.ImageDetail

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.Role

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ReasoningEffort

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.Type

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ToolChoice

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatModel

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingModel

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mistralai.api.MistralAiApi.FinishReason

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mistralai.api.MistralAiApi.FunctionTool.Type

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mistralai.api.MistralAiModerationApi.Model

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRModel

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.model.ollama.autoconfigure.OllamaThinkProperties

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.model.openai.autoconfigure.OpenAiChatProperties.Api

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.model.tool.ToolCallLimitBehavior

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.observation.conventions.AiObservationAttributes

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.AiObservationMetricAttributes

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.AiObservationMetricNames

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.AiOperationType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.AiProvider

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.AiTokenType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.SpringAiKind

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.VectorStoreObservationAttributes

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.ollama.api.OllamaApi.ChatRequest.Tool.Type

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.ollama.api.OllamaApi.Message.Role

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.ollama.api.OllamaModel

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.ollama.management.PullModelStrategy

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.AudioResponseFormat

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Voice

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat.Type

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.AudioResponseFormat

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.Voice

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.openai.OpenAiEmbeddingOptions.EncodingFormat

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.openai.setup.OpenAiSetup.ModelProvider

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.postgresml.PostgresMlEmbeddingModel.VectorType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.session.compaction.CompactionWindow.Rule

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.stabilityai.StyleEnum

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.template.ValidationMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.test.chat.client.advisor.MockWeatherService.Unit

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.AbstractSpringAiSchemaModule.Option

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.vectorstore.cassandra.CassandraVectorStore.SchemaColumnTags

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.cassandra.CassandraVectorStore.Similarity

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore.DistanceType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.coherence.CoherenceVectorStore.IndexType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.couchbase.CouchbaseIndexOptimization

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.couchbase.CouchbaseSimilarityFunction

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.elasticsearch.SimilarityFunction

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.filter.Filter.ExpressionType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBDistanceType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusMetricType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.neo4j.Neo4jVectorStore.Neo4jDistanceType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Operation

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.HighCardinalityKeyNames

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.LowCardinalityKeyNames

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.oracle.OracleVectorStore.OracleVectorStoreDistanceType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.oracle.OracleVectorStore.OracleVectorStoreIndexType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgDistanceType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgIdType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgIndexType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.Algorithm

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.DistanceMetric

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.redis.RedisVectorStore.TextScorer

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.ConsistentLevel

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.MetadataField.Type

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingModelName

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModelName

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.TaskType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils

values() - Static method in enum class org.springframework.ai.anthropic.AnthropicCacheStrategy

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.anthropic.AnthropicCacheTtl

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.anthropic.AnthropicCitationDocument.DocumentType

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.anthropic.AnthropicServiceTier

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.anthropic.AnthropicSkill

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.anthropic.AnthropicSkillType

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.anthropic.Citation.LocationType

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.audio.transcription.observation.TranscriptionModelObservationDocumentation.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.audio.transcription.observation.TranscriptionModelObservationDocumentation.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.audio.transcription.observation.TranscriptionModelObservationDocumentation

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.audio.tts.observation.TextToSpeechModelObservationDocumentation.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.audio.tts.observation.TextToSpeechModelObservationDocumentation.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.audio.tts.observation.TextToSpeechModelObservationDocumentation

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.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingModel

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.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType

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.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest.Truncate

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.bedrock.converse.api.BedrockCacheStrategy

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.bedrock.converse.api.BedrockCacheTtl

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.bedrock.titan.api.TitanEmbeddingBedrockApi.TitanEmbeddingModel

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.bedrock.titan.BedrockTitanEmbeddingModel.InputType

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.client.advisor.observation.AdvisorObservationDocumentation.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.client.advisor.observation.AdvisorObservationDocumentation.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.client.advisor.observation.AdvisorObservationDocumentation

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.client.ChatClientAttributes

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.client.observation.ChatClientObservationDocumentation.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.client.observation.ChatClientObservationDocumentation.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.client.observation.ChatClientObservationDocumentation

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.memory.repository.neo4j.MediaAttributes

Deprecated.

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.memory.repository.neo4j.MessageAttributes

Deprecated.

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.memory.repository.neo4j.ToolCallAttributes

Deprecated.

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.memory.repository.neo4j.ToolResponseAttributes

Deprecated.

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.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.chroma.vectorstore.ChromaApi.QueryRequest.Include

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.deepseek.api.DeepSeekApi.ChatCompletionFinishReason

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionMessage.Role

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatCompletionRequest.ReasoningEffort

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.deepseek.api.DeepSeekApi.ChatCompletionRequest.Thinking.Type

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.deepseek.api.DeepSeekApi.ChatModel

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.deepseek.api.DeepSeekApi.FunctionTool.Type

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.deepseek.api.ResponseFormat.Type

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.document.DocumentMetadata

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.document.MetadataMode

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.elevenlabs.api.ElevenLabsApi.OutputFormat

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.elevenlabs.api.ElevenLabsApi.SpeechRequest.TextNormalizationMode

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.elevenlabs.api.ElevenLabsVoicesApi.CategoryEnum

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.elevenlabs.api.ElevenLabsVoicesApi.ReaderResource.ResourceTypeEnum

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.elevenlabs.api.ElevenLabsVoicesApi.SafetyControlEnum

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.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.CategoryEnum

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.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.ReviewStatusEnum

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.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing.StatusEnum

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.google.genai.common.GoogleGenAiSafetySetting.HarmBlockMethod

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.google.genai.common.GoogleGenAiSafetySetting.HarmBlockThreshold

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.google.genai.common.GoogleGenAiSafetySetting.HarmCategory

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.google.genai.common.GoogleGenAiServiceTier

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.google.genai.common.GoogleGenAiThinkingLevel

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.google.genai.GoogleGenAiChatModel.ChatModel

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.google.genai.GoogleGenAiChatModel.GeminiMessageType

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.google.genai.GoogleGenAiChatOptions.ToolChoice.Mode

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.google.genai.image.GoogleGenAiImageModelName

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.google.genai.image.GoogleGenAiImageOptions.PersonGeneration

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.google.genai.image.GoogleGenAiImageOptions.SafetyFilterLevel

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.google.genai.metadata.GoogleGenAiTrafficType

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.google.genai.text.GoogleGenAiTextEmbeddingModelName

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.google.genai.text.GoogleGenAiTextEmbeddingOptions.TaskType

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.google.genai.tts.GoogleGenAiAudioSpeechOptions.AudioEncoding

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.mcp.annotation.method.resource.AbstractMcpResourceMethodCallback.ContentType

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.mcp.annotation.method.tool.ReturnMode

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.mcp.client.common.autoconfigure.properties.McpClientCommonProperties.ClientType

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.mcp.server.common.autoconfigure.properties.McpServerProperties.ApiType

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.mcp.server.common.autoconfigure.properties.McpServerProperties.ServerProtocol

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.mistralai.api.MistralAiApi.ChatCompletionMessage.ImageUrlChunk.ImageUrl.ImageDetail

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.mistralai.api.MistralAiApi.ChatCompletionMessage.Role

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ReasoningEffort

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.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat.Type

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ToolChoice

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.mistralai.api.MistralAiApi.ChatModel

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingModel

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.mistralai.api.MistralAiApi.FinishReason

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.mistralai.api.MistralAiApi.FunctionTool.Type

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.mistralai.api.MistralAiModerationApi.Model

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.mistralai.ocr.MistralOcrApi.OCRModel

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.ollama.autoconfigure.OllamaThinkProperties

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.openai.autoconfigure.OpenAiChatProperties.Api

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.tool.ToolCallLimitBehavior

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.observation.conventions.AiObservationAttributes

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.observation.conventions.AiObservationMetricAttributes

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.observation.conventions.AiObservationMetricNames

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.observation.conventions.AiOperationType

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.observation.conventions.AiProvider

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.observation.conventions.AiTokenType

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.observation.conventions.SpringAiKind

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.observation.conventions.VectorStoreObservationAttributes

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.observation.conventions.VectorStoreProvider

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.observation.conventions.VectorStoreSimilarityMetric

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.ollama.api.OllamaApi.ChatRequest.Tool.Type

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.ollama.api.OllamaApi.Message.Role

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.ollama.api.OllamaModel

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.ollama.management.PullModelStrategy

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.AudioResponseFormat

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Voice

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.openai.OpenAiChatModel.ResponseFormat.Type

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.AudioResponseFormat

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.Voice

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.openai.OpenAiEmbeddingOptions.EncodingFormat

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.openai.setup.OpenAiSetup.ModelProvider

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.postgresml.PostgresMlEmbeddingModel.VectorType

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.session.compaction.CompactionWindow.Rule

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.stabilityai.StyleEnum

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.template.ValidationMode

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.test.chat.client.advisor.MockWeatherService.Unit

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.AbstractSpringAiSchemaModule.Option

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.vectorstore.cassandra.CassandraVectorStore.SchemaColumnTags

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.vectorstore.cassandra.CassandraVectorStore.Similarity

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.vectorstore.coherence.CoherenceVectorStore.DistanceType

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.vectorstore.coherence.CoherenceVectorStore.IndexType

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.vectorstore.couchbase.CouchbaseIndexOptimization

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.vectorstore.couchbase.CouchbaseSimilarityFunction

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.vectorstore.elasticsearch.SimilarityFunction

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.vectorstore.filter.Filter.ExpressionType

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.vectorstore.mariadb.MariaDBVectorStore.MariaDBDistanceType

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.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusIndexType

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.vectorstore.milvus.autoconfigure.MilvusVectorStoreProperties.MilvusMetricType

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.vectorstore.neo4j.Neo4jVectorStore.Neo4jDistanceType

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.vectorstore.observation.VectorStoreObservationContext.Operation

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.vectorstore.observation.VectorStoreObservationDocumentation.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.vectorstore.observation.VectorStoreObservationDocumentation.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.vectorstore.observation.VectorStoreObservationDocumentation

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.vectorstore.oracle.OracleVectorStore.OracleVectorStoreDistanceType

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.vectorstore.oracle.OracleVectorStore.OracleVectorStoreIndexType

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.vectorstore.pgvector.PgVectorStore.PgDistanceType

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.vectorstore.pgvector.PgVectorStore.PgIdType

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.vectorstore.pgvector.PgVectorStore.PgIndexType

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.vectorstore.redis.RedisVectorStore.Algorithm

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.vectorstore.redis.RedisVectorStore.DistanceMetric

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.vectorstore.redis.RedisVectorStore.TextScorer

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.vectorstore.weaviate.WeaviateVectorStore.ConsistentLevel

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.vectorstore.weaviate.WeaviateVectorStore.MetadataField.Type

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingModelName

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.vertexai.embedding.text.VertexAiTextEmbeddingModelName

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.vertexai.embedding.text.VertexAiTextEmbeddingOptions.TaskType

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<String, Object>) - Method in class org.springframework.ai.chat.prompt.PromptTemplate.Builder

variables(Map<String, Object>) - Method in class org.springframework.ai.chat.prompt.SystemPromptTemplate.Builder

VECTOR_STORE - Enum constant in enum class org.springframework.ai.observation.conventions.SpringAiKind

Spring AI kind for vector store.

VECTOR_STORE_PREFIX - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

vectorAlgorithm(RedisVectorStore.Algorithm) - Method in class org.springframework.ai.vectorstore.redis.RedisVectorStore.Builder

Sets the Redis vector algorithm.

vectorBucketName(String) - Method in class org.springframework.ai.vectorstore.s3.S3VectorStore.Builder

vectorIndexName(String) - Method in class org.springframework.ai.vectorstore.couchbase.CouchbaseSearchVectorStore.Builder

Configures the vector index name.

vectorIndexName(String) - Method in class org.springframework.ai.vectorstore.mongodb.atlas.MongoDBAtlasVectorStore.Builder

Configures the vector index name.

vectorSimilarityFunction(String) - Method in class org.springframework.ai.vectorstore.gemfire.GemFireVectorStore.Builder

Sets the vector similarity function.

vectorStore(SearchIndexClient, EmbeddingModel, AzureVectorStoreProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<VectorStoreObservationConvention>, BatchingStrategy) - Method in class org.springframework.ai.vectorstore.azure.autoconfigure.AzureVectorStoreAutoConfiguration

vectorStore(MilvusServiceClient, EmbeddingModel, MilvusVectorStoreProperties, BatchingStrategy, ObjectProvider<ObservationRegistry>, ObjectProvider<VectorStoreObservationConvention>) - Method in class org.springframework.ai.vectorstore.milvus.autoconfigure.MilvusVectorStoreAutoConfiguration

vectorStore(Driver, EmbeddingModel, Neo4jVectorStoreProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<VectorStoreObservationConvention>, BatchingStrategy) - Method in class org.springframework.ai.vectorstore.neo4j.autoconfigure.Neo4jVectorStoreAutoConfiguration

vectorStore(EmbeddingModel, WeaviateClient, WeaviateVectorStoreProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<VectorStoreObservationConvention>, BatchingStrategy) - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreAutoConfiguration

vectorStore(EmbeddingModel, ChromaApi, ChromaVectorStoreProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<VectorStoreObservationConvention>, BatchingStrategy) - Method in class org.springframework.ai.vectorstore.chroma.autoconfigure.ChromaVectorStoreAutoConfiguration

vectorStore(EmbeddingModel, CassandraVectorStoreProperties, CqlSession, ObjectProvider<ObservationRegistry>, ObjectProvider<VectorStoreObservationConvention>, BatchingStrategy) - Method in class org.springframework.ai.vectorstore.cassandra.autoconfigure.CassandraVectorStoreAutoConfiguration

vectorStore(EmbeddingModel, PineconeVectorStoreProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<VectorStoreObservationConvention>, BatchingStrategy) - Method in class org.springframework.ai.vectorstore.pinecone.autoconfigure.PineconeVectorStoreAutoConfiguration

vectorStore(EmbeddingModel, QdrantVectorStoreProperties, QdrantClient, ObjectProvider<ObservationRegistry>, ObjectProvider<VectorStoreObservationConvention>, BatchingStrategy) - Method in class org.springframework.ai.vectorstore.qdrant.autoconfigure.QdrantVectorStoreAutoConfiguration

vectorStore(EmbeddingModel, RedisVectorStoreProperties, JedisConnectionFactory, ObjectProvider<ObservationRegistry>, ObjectProvider<VectorStoreObservationConvention>, ObjectProvider<List<RedisVectorStore.MetadataField>>, BatchingStrategy) - Method in class org.springframework.ai.vectorstore.redis.autoconfigure.RedisVectorStoreAutoConfiguration

Creates a Redis vector store.

vectorStore(CouchbaseSearchVectorStoreProperties, Cluster, EmbeddingModel) - Method in class org.springframework.ai.vectorstore.couchbase.autoconfigure.CouchbaseSearchVectorStoreAutoConfiguration

vectorStore(VectorStore) - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever.Builder

vectorStore(VectorStore) - Method in class org.springframework.ai.vectorstore.redis.cache.semantic.DefaultSemanticCache.Builder

vectorStore(JdbcTemplate, EmbeddingModel, MariaDbStoreProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<VectorStoreObservationConvention>, BatchingStrategy) - Method in class org.springframework.ai.vectorstore.mariadb.autoconfigure.MariaDbStoreAutoConfiguration

vectorStore(JdbcTemplate, EmbeddingModel, OracleVectorStoreProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<VectorStoreObservationConvention>, BatchingStrategy) - Method in class org.springframework.ai.vectorstore.oracle.autoconfigure.OracleVectorStoreAutoConfiguration

vectorStore(JdbcTemplate, EmbeddingModel, PgVectorStoreProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<VectorStoreObservationConvention>, BatchingStrategy) - Method in class org.springframework.ai.vectorstore.pgvector.autoconfigure.PgVectorStoreAutoConfiguration

vectorStore(Client, EmbeddingModel, TypesenseVectorStoreProperties, ObjectProvider<ObservationRegistry>, ObjectProvider<VectorStoreObservationConvention>, BatchingStrategy) - Method in class org.springframework.ai.vectorstore.typesense.autoconfigure.TypesenseVectorStoreAutoConfiguration

VectorStore - Interface in org.springframework.ai.vectorstore

The VectorStore interface defines the operations for managing and querying documents in a vector database.

VectorStore.Builder<T extends VectorStore.Builder<T>> - Interface in org.springframework.ai.vectorstore

Builder interface for creating VectorStore instances.

VectorStoreChatMemoryAdvisor - Class in org.springframework.ai.chat.client.advisor.vectorstore

Memory is retrieved from a VectorStore added into the prompt's system text.

VectorStoreChatMemoryAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor.vectorstore

Builder for VectorStoreChatMemoryAdvisor.

VectorStoreDocumentRetriever - Class in org.springframework.ai.rag.retrieval.search

Retrieves documents from a vector store that are semantically similar to the input query.

VectorStoreDocumentRetriever(VectorStore, Double, Integer, Supplier<Filter.Expression>) - Constructor for class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever

VectorStoreDocumentRetriever.Builder - Class in org.springframework.ai.rag.retrieval.search

Builder for VectorStoreDocumentRetriever.

vectorStoreIds() - Method in record class org.springframework.ai.openai.responses.HostedTool.FileSearch

Returns the value of the vectorStoreIds record component.

VectorStoreObservationAttributes - Enum Class in org.springframework.ai.observation.conventions

Collection of attribute keys used in vector store observations (spans, metrics, events).

VectorStoreObservationAutoConfiguration - Class in org.springframework.ai.vectorstore.observation.autoconfigure

Auto-configuration for Spring AI vector store observations.

VectorStoreObservationAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.observation.autoconfigure.VectorStoreObservationAutoConfiguration

VectorStoreObservationContext - Class in org.springframework.ai.vectorstore.observation

Context used to store metadata for vector store operations.

VectorStoreObservationContext(String, String) - Constructor for class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

VectorStoreObservationContext.Builder - Class in org.springframework.ai.vectorstore.observation

VectorStoreObservationContext.Operation - Enum Class in org.springframework.ai.vectorstore.observation

VectorStoreObservationConvention - Interface in org.springframework.ai.vectorstore.observation

A ObservationConvention for VectorStoreObservationContext.

VectorStoreObservationDocumentation - Enum Class in org.springframework.ai.vectorstore.observation

Documented conventions for vector store observations.

VectorStoreObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.ai.vectorstore.observation

High-cardinality observation key names for vector store operations.

VectorStoreObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.ai.vectorstore.observation

Low-cardinality observation key names for vector store operations.

VectorStoreObservationProperties - Class in org.springframework.ai.vectorstore.observation.autoconfigure

Configuration properties for vector store observations.

VectorStoreObservationProperties() - Constructor for class org.springframework.ai.vectorstore.observation.autoconfigure.VectorStoreObservationProperties

VectorStoreProvider - Enum Class in org.springframework.ai.observation.conventions

Collection of systems providing vector store functionality.

VectorStoreQueryResponseObservationHandler - Class in org.springframework.ai.vectorstore.observation

Handler for emitting the query response content to logs.

VectorStoreQueryResponseObservationHandler() - Constructor for class org.springframework.ai.vectorstore.observation.VectorStoreQueryResponseObservationHandler

VectorStoreRetriever - Interface in org.springframework.ai.vectorstore

A functional interface that provides read-only access to vector store retrieval operations.

VectorStoreSimilarityMetric - Enum Class in org.springframework.ai.observation.conventions

Types of similarity metrics used in vector store operations.

vectorTableName(String) - Method in class org.springframework.ai.vectorstore.mariadb.MariaDBVectorStore.MariaDBBuilder

Configures the vector store table name.

vectorTableName(String) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgVectorStoreBuilder

vectorTableValidationsEnabled(boolean) - Method in class org.springframework.ai.vectorstore.pgvector.PgVectorStore.PgVectorStoreBuilder

VectorToolIndex - Class in org.springframework.ai.tool.toolsearch.index.vectorstore

Vector-based tool searcher for semantic search of tool descriptions.

VectorToolIndex(VectorStore) - Constructor for class org.springframework.ai.tool.toolsearch.index.vectorstore.VectorToolIndex

Creates a new VectorToolIndex with the given vector store.

vectorType(PostgresMlEmbeddingModel.VectorType) - Method in class org.springframework.ai.postgresml.PostgresMlEmbeddingOptions.Builder

verbose() - Method in record class org.springframework.ai.ollama.api.OllamaApi.ShowModelRequest

Returns the value of the verbose record component.

verbosity - Variable in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

verbosity - Variable in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

verbosity(String) - Method in class org.springframework.ai.openai.OpenAiChatOptions.AbstractBuilder

verbosity(String) - Method in class org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder

VerificationAttempt(String, Integer, Boolean, Double, Double, ElevenLabsVoicesApi.Recording) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerificationAttempt

Creates an instance of a VerificationAttempt record class.

verificationAttempts() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns the value of the verificationAttempts record component.

verificationAttempts() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceVerification

Returns the value of the verificationAttempts record component.

verificationAttemptsCount() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns the value of the verificationAttemptsCount record component.

verificationAttemptsCount() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceVerification

Returns the value of the verificationAttemptsCount record component.

verificationFailures() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.FineTuning

Returns the value of the verificationFailures record component.

verificationFailures() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceVerification

Returns the value of the verificationFailures record component.

verifiedLanguages() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the verifiedLanguages record component.

VerifiedVoiceLanguage(String, String, String) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VerifiedVoiceLanguage

Creates an instance of a VerifiedVoiceLanguage record class.

VERSE - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Voice

version(String) - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord.Builder

versionId() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator

Returns the value of the versionId record component.

VERTEX_AI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider

AI system provided by Vertex AI.

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

VertexAiEmbeddingConnectionAutoConfiguration - Class in org.springframework.ai.model.vertexai.autoconfigure.embedding

Auto-configuration for Vertex AI Embedding Connection.

VertexAiEmbeddingConnectionAutoConfiguration() - Constructor for class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiEmbeddingConnectionAutoConfiguration

VertexAiEmbeddingConnectionDetails - Class in org.springframework.ai.vertexai.embedding

VertexAiEmbeddingConnectionDetails represents the details of a connection to the Vertex AI embedding service.

VertexAiEmbeddingConnectionDetails(String, String, String, PredictionServiceSettings) - Constructor for class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingConnectionDetails

VertexAiEmbeddingConnectionDetails.Builder - Class in org.springframework.ai.vertexai.embedding

VertexAiEmbeddingConnectionProperties - Class in org.springframework.ai.model.vertexai.autoconfigure.embedding

Configuration properties for Vertex AI Embedding.

VertexAiEmbeddingConnectionProperties() - Constructor for class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiEmbeddingConnectionProperties

VertexAiEmbeddingUtils - Class in org.springframework.ai.vertexai.embedding

Utility class for constructing parameter objects for Vertex AI embedding requests.

VertexAiEmbeddingUtils() - Constructor for class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils

VertexAiEmbeddingUtils.ImageBuilder - Class in org.springframework.ai.vertexai.embedding

VertexAiEmbeddingUtils.MultimodalInstanceBuilder - Class in org.springframework.ai.vertexai.embedding

VertexAiEmbeddingUtils.TextInstanceBuilder - Class in org.springframework.ai.vertexai.embedding

VertexAiEmbeddingUtils.TextParametersBuilder - Class in org.springframework.ai.vertexai.embedding

VertexAiEmbeddingUtils.VideoBuilder - Class in org.springframework.ai.vertexai.embedding

VertexAiMultiModalEmbeddingAutoConfiguration - Class in org.springframework.ai.model.vertexai.autoconfigure.embedding

Auto-configuration for Vertex AI Gemini Chat.

VertexAiMultiModalEmbeddingAutoConfiguration() - Constructor for class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultiModalEmbeddingAutoConfiguration

VertexAiMultimodalEmbeddingModel - Class in org.springframework.ai.vertexai.embedding.multimodal

Implementation of the Vertex AI Multimodal Embedding Model.

VertexAiMultimodalEmbeddingModel(VertexAiEmbeddingConnectionDetails, VertexAiMultimodalEmbeddingOptions) - Constructor for class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingModel

VertexAiMultimodalEmbeddingModelName - Enum Class in org.springframework.ai.vertexai.embedding.multimodal

VertexAI Embedding Models: - Text embeddings - Multimodal embeddings

VertexAiMultimodalEmbeddingOptions - Class in org.springframework.ai.vertexai.embedding.multimodal

Class representing the options for Vertex AI Multimodal Embedding.

VertexAiMultimodalEmbeddingOptions(String, Integer, Integer, Integer, Integer) - Constructor for class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions

VertexAiMultimodalEmbeddingOptions.Builder - Class in org.springframework.ai.vertexai.embedding.multimodal

VertexAiMultimodalEmbeddingProperties - Class in org.springframework.ai.model.vertexai.autoconfigure.embedding

Configuration properties for Vertex AI Gemini Chat.

VertexAiMultimodalEmbeddingProperties() - Constructor for class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiMultimodalEmbeddingProperties

VertexAiMultimodalEmbeddingProperties.Options - Class in org.springframework.ai.model.vertexai.autoconfigure.embedding

VertexAiTextEmbeddingAutoConfiguration - Class in org.springframework.ai.model.vertexai.autoconfigure.embedding

Auto-configuration for Vertex AI Gemini Chat.

VertexAiTextEmbeddingAutoConfiguration() - Constructor for class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingAutoConfiguration

VertexAiTextEmbeddingModel - Class in org.springframework.ai.vertexai.embedding.text

A class representing a Vertex AI Text Embedding Model.

VertexAiTextEmbeddingModel(VertexAiEmbeddingConnectionDetails, VertexAiTextEmbeddingOptions) - Constructor for class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModel

VertexAiTextEmbeddingModel(VertexAiEmbeddingConnectionDetails, VertexAiTextEmbeddingOptions, RetryTemplate) - Constructor for class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModel

VertexAiTextEmbeddingModel(VertexAiEmbeddingConnectionDetails, VertexAiTextEmbeddingOptions, RetryTemplate, ObservationRegistry) - Constructor for class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingModel

VertexAiTextEmbeddingModelName - Enum Class in org.springframework.ai.vertexai.embedding.text

VertexAI Embedding Models: - Text embeddings - Multimodal embeddings

VertexAiTextEmbeddingOptions - Class in org.springframework.ai.vertexai.embedding.text

Options for the Vertex AI Text Embedding service.

VertexAiTextEmbeddingOptions(String, VertexAiTextEmbeddingOptions.TaskType, Integer, String, Boolean) - Constructor for class org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions

VertexAiTextEmbeddingOptions.Builder - Class in org.springframework.ai.vertexai.embedding.text

VertexAiTextEmbeddingOptions.TaskType - Enum Class in org.springframework.ai.vertexai.embedding.text

VertexAiTextEmbeddingProperties - Class in org.springframework.ai.model.vertexai.autoconfigure.embedding

Configuration properties for Vertex AI Gemini Chat.

VertexAiTextEmbeddingProperties() - Constructor for class org.springframework.ai.model.vertexai.autoconfigure.embedding.VertexAiTextEmbeddingProperties

VertexAiTextEmbeddingProperties.Options - Class in org.springframework.ai.model.vertexai.autoconfigure.embedding

video(Struct) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.MultimodalInstanceBuilder

VIDEO - Enum constant in enum class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityType

VIDEO_FLV - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for video/x-flv.

VIDEO_MAP - Static variable in class org.springframework.ai.bedrock.converse.api.BedrockMediaFormat

VIDEO_MKV - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for video/x-matros.

VIDEO_MOV - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for video/quicktime.

VIDEO_MP4 - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for video/mp4.

VIDEO_MPEG - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for video/mpeg.

VIDEO_MPG - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for video/mpeg.

VIDEO_THREE_GP - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for video/3gpp.

VIDEO_WEBM - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for video/webm.

VIDEO_WMV - Static variable in class org.springframework.ai.content.Media.Format

Public constant mime type for video/x-ms-wmv.

VideoBuilder() - Constructor for class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

videoBytes - Variable in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

Video bytes to be encoded in base64 string.

videoBytes(byte[]) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

videoData(Object) - Method in class org.springframework.ai.vertexai.embedding.VertexAiEmbeddingUtils.VideoBuilder

videoEndOffsetSec(Integer) - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions.Builder

videoIntervalSec(Integer) - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions.Builder

videoStartOffsetSec(Integer) - Method in class org.springframework.ai.vertexai.embedding.multimodal.VertexAiMultimodalEmbeddingOptions.Builder

violence(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder

violence(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder

violenceAndThreats() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.Categories

Returns the value of the violenceAndThreats record component.

violenceAndThreats() - Method in record class org.springframework.ai.mistralai.api.MistralAiModerationApi.CategoryScores

Returns the value of the violenceAndThreats record component.

violenceGraphic(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder

violenceGraphic(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder

visitAndExpression(FiltersParser.AndExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the AndExpression labeled alternative in FiltersParser.booleanExpression().

visitAndExpression(FiltersParser.AndExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the AndExpression labeled alternative in FiltersParser.booleanExpression().

visitAndExpression(FiltersParser.AndExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitBooleanConstant(FiltersParser.BooleanConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the BooleanConstant labeled alternative in FiltersParser.constant().

visitBooleanConstant(FiltersParser.BooleanConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the BooleanConstant labeled alternative in FiltersParser.constant().

visitBooleanConstant(FiltersParser.BooleanConstantContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitCompare(FiltersParser.CompareContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by FiltersParser.compare().

visitCompare(FiltersParser.CompareContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by FiltersParser.compare().

visitCompareExpression(FiltersParser.CompareExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the CompareExpression labeled alternative in FiltersParser.booleanExpression().

visitCompareExpression(FiltersParser.CompareExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the CompareExpression labeled alternative in FiltersParser.booleanExpression().

visitCompareExpression(FiltersParser.CompareExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitCompoundIdentifier(FiltersParser.CompoundIdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the CompoundIdentifier labeled alternative in FiltersParser.identifier().

visitCompoundIdentifier(FiltersParser.CompoundIdentifierContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the CompoundIdentifier labeled alternative in FiltersParser.identifier().

visitCompoundIdentifier(FiltersParser.CompoundIdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitConstantArray(FiltersParser.ConstantArrayContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by FiltersParser.constantArray().

visitConstantArray(FiltersParser.ConstantArrayContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by FiltersParser.constantArray().

visitConstantArray(FiltersParser.ConstantArrayContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitContentBlockDelta(ContentBlockDeltaEvent) - Method in class org.springframework.ai.bedrock.converse.api.ConverseChatResponseStream

visitContentBlockStart(ContentBlockStartEvent) - Method in class org.springframework.ai.bedrock.converse.api.ConverseChatResponseStream

visitContentBlockStop(ContentBlockStopEvent) - Method in class org.springframework.ai.bedrock.converse.api.ConverseChatResponseStream

visitDecimalConstant(FiltersParser.DecimalConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the DecimalConstant labeled alternative in FiltersParser.constant().

visitDecimalConstant(FiltersParser.DecimalConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the DecimalConstant labeled alternative in FiltersParser.constant().

visitDecimalConstant(FiltersParser.DecimalConstantContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitErrorNode(ErrorNode) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

visitGroupExpression(FiltersParser.GroupExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the GroupExpression labeled alternative in FiltersParser.booleanExpression().

visitGroupExpression(FiltersParser.GroupExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the GroupExpression labeled alternative in FiltersParser.booleanExpression().

visitGroupExpression(FiltersParser.GroupExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitInExpression(FiltersParser.InExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the InExpression labeled alternative in FiltersParser.booleanExpression().

visitInExpression(FiltersParser.InExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the InExpression labeled alternative in FiltersParser.booleanExpression().

visitInExpression(FiltersParser.InExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitIntegerConstant(FiltersParser.IntegerConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the IntegerConstant labeled alternative in FiltersParser.constant().

visitIntegerConstant(FiltersParser.IntegerConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the IntegerConstant labeled alternative in FiltersParser.constant().

visitIntegerConstant(FiltersParser.IntegerConstantContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitIsNotNullExpression(FiltersParser.IsNotNullExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the IsNotNullExpression labeled alternative in FiltersParser.booleanExpression().

visitIsNotNullExpression(FiltersParser.IsNotNullExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the IsNotNullExpression labeled alternative in FiltersParser.booleanExpression().

visitIsNotNullExpression(FiltersParser.IsNotNullExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitIsNullExpression(FiltersParser.IsNullExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the IsNullExpression labeled alternative in FiltersParser.booleanExpression().

visitIsNullExpression(FiltersParser.IsNullExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the IsNullExpression labeled alternative in FiltersParser.booleanExpression().

visitIsNullExpression(FiltersParser.IsNullExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitLongConstant(FiltersParser.LongConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the LongConstant labeled alternative in FiltersParser.constant().

visitLongConstant(FiltersParser.LongConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the LongConstant labeled alternative in FiltersParser.constant().

visitLongConstant(FiltersParser.LongConstantContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitMessageStop(MessageStopEvent) - Method in class org.springframework.ai.bedrock.converse.api.ConverseChatResponseStream

visitMetadata(ConverseStreamMetadataEvent) - Method in class org.springframework.ai.bedrock.converse.api.ConverseChatResponseStream

visitNinExpression(FiltersParser.NinExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the NinExpression labeled alternative in FiltersParser.booleanExpression().

visitNinExpression(FiltersParser.NinExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the NinExpression labeled alternative in FiltersParser.booleanExpression().

visitNinExpression(FiltersParser.NinExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitNotExpression(FiltersParser.NotExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the NotExpression labeled alternative in FiltersParser.booleanExpression().

visitNotExpression(FiltersParser.NotExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the NotExpression labeled alternative in FiltersParser.booleanExpression().

visitNotExpression(FiltersParser.NotExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitOrExpression(FiltersParser.OrExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the OrExpression labeled alternative in FiltersParser.booleanExpression().

visitOrExpression(FiltersParser.OrExpressionContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the OrExpression labeled alternative in FiltersParser.booleanExpression().

visitOrExpression(FiltersParser.OrExpressionContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitQuotedIdentifier(FiltersParser.QuotedIdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the QuotedIdentifier labeled alternative in FiltersParser.identifier().

visitQuotedIdentifier(FiltersParser.QuotedIdentifierContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the QuotedIdentifier labeled alternative in FiltersParser.identifier().

visitQuotedIdentifier(FiltersParser.QuotedIdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitSimpleIdentifier(FiltersParser.SimpleIdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the SimpleIdentifier labeled alternative in FiltersParser.identifier().

visitSimpleIdentifier(FiltersParser.SimpleIdentifierContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the SimpleIdentifier labeled alternative in FiltersParser.identifier().

visitSimpleIdentifier(FiltersParser.SimpleIdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitTerminal(TerminalNode) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener

visitTextConstant(FiltersParser.TextConstantContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by the TextConstant labeled alternative in FiltersParser.constant().

visitTextConstant(FiltersParser.TextConstantContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by the TextConstant labeled alternative in FiltersParser.constant().

visitTextConstant(FiltersParser.TextConstantContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

visitWhere(FiltersParser.WhereContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor

Visit a parse tree produced by FiltersParser.where().

visitWhere(FiltersParser.WhereContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor

Visit a parse tree produced by FiltersParser.where().

visitWhere(FiltersParser.WhereContext) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor

vocabOnly - Variable in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

vocabOnly(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder

vocabOnly(Boolean) - Method in class org.springframework.ai.ollama.api.OllamaEmbeddingOptions.Builder

VOCABULARY - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

VOCABULARY - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

voice() - Method in record class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters

Returns the value of the voice record component.

voice(String) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

Sets the voice ID using the generic 'voice' property.

voice(String) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder

voice(OpenAiAudioSpeechOptions.Voice) - Method in class org.springframework.ai.openai.OpenAiAudioSpeechOptions.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.

Voice(String, String, List<ElevenLabsVoicesApi.Sample>, ElevenLabsVoicesApi.CategoryEnum, ElevenLabsVoicesApi.FineTuning, Map<String, String>, String, String, List<String>, ElevenLabsVoicesApi.VoiceSettings, ElevenLabsVoicesApi.VoiceSharing, List<String>, List<ElevenLabsVoicesApi.VerifiedVoiceLanguage>, ElevenLabsVoicesApi.SafetyControlEnum, ElevenLabsVoicesApi.VoiceVerification, String, Boolean, Boolean, Boolean, Integer) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Creates an instance of a Voice record class.

voiceId() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the voiceId record component.

voiceId(String) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

Sets the voice ID using the ElevenLabs specific 'voiceId' property.

voiceMixingAllowed() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the voiceMixingAllowed record component.

voiceName() - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.SpeakerVoiceConfig

Returns the value of the voiceName record component.

voiceName(String) - Method in class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.Builder

voices() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voices

Returns the value of the voices record component.

Voices(List<ElevenLabsVoicesApi.Voice>) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voices

Creates an instance of a Voices record class.

voiceSampleAudio() - Method in record class org.springframework.ai.google.genai.tts.GoogleGenAiAudioSpeechOptions.ReplicatedVoice

Returns the value of the voiceSampleAudio record component.

voiceSettings() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest

Returns the value of the voiceSettings record component.

voiceSettings(ElevenLabsApi.SpeechRequest.VoiceSettings) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.Builder

voiceSettings(ElevenLabsApi.SpeechRequest.VoiceSettings) - Method in class org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions.Builder

VoiceSettings(Double, Double, Double, Boolean, Double) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsApi.SpeechRequest.VoiceSettings

Creates an instance of a VoiceSettings record class.

VoiceSettings(Double, Double, Double, Boolean, Double) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSettings

Creates an instance of a VoiceSettings record class.

VoiceSharing(ElevenLabsVoicesApi.VoiceSharing.StatusEnum, String, Integer, List<String>, String, String, Boolean, Boolean, Boolean, Double, Integer, Integer, Boolean, Boolean, ElevenLabsVoicesApi.VoiceSharing.CategoryEnum, Boolean, String, String, Integer, Integer, String, String, Map<String, String>, ElevenLabsVoicesApi.VoiceSharing.ReviewStatusEnum, String, Boolean, String, String, String, String, ElevenLabsVoicesApi.VoiceSharingModerationCheck, List<ElevenLabsVoicesApi.ReaderResource>) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Creates an instance of a VoiceSharing record class.

VoiceSharingModerationCheck(Integer, String, Boolean, String, Boolean, List<String>, List<Double>, List<String>, List<Double>) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharingModerationCheck

Creates an instance of a VoiceSharingModerationCheck record class.

voiceVerification() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.Voice

Returns the value of the voiceVerification record component.

VoiceVerification(Boolean, Boolean, List<String>, Integer, String, List<ElevenLabsVoicesApi.VerificationAttempt>) - Constructor for record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceVerification

Creates an instance of a VoiceVerification record class.

VOID - Enum constant in enum class org.springframework.ai.mcp.annotation.method.tool.ReturnMode

W

warn(String) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpAsyncRequestContext

warn(String) - Method in class org.springframework.ai.mcp.annotation.context.DefaultMcpSyncRequestContext

warn(String) - Method in interface org.springframework.ai.mcp.annotation.context.McpAsyncRequestContext

warn(String) - Method in interface org.springframework.ai.mcp.annotation.context.McpSyncRequestContext

WARN - Enum constant in enum class org.springframework.ai.template.ValidationMode

If the validation fails, a warning is logged.

WAV - Enum constant in enum class org.springframework.ai.openai.OpenAiAudioSpeechOptions.AudioResponseFormat

WAV - Enum constant in enum class org.springframework.ai.openai.OpenAiChatOptions.AudioParameters.AudioResponseFormat

Weather(String, int) - Constructor for record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.Weather

Creates an instance of a Weather record class.

WeatherRequest(String) - Constructor for record class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT.WeatherRequest

Creates an instance of a WeatherRequest record class.

weatherTool() - Method in class org.springframework.ai.test.chat.client.advisor.AbstractToolCallConfirmationIT

The weather tool, which needs no confirmation.

WEAVIATE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider

Vector store provided by Weaviate.

WEAVIATE - Static variable in class org.springframework.ai.vectorstore.SpringAIVectorStoreTypes

weaviateClient(WeaviateVectorStoreProperties, WeaviateConnectionDetails) - Method in class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreAutoConfiguration

WeaviateConnectionDetails - Interface in org.springframework.ai.vectorstore.weaviate.autoconfigure

WeaviateFilterExpressionConverter - Class in org.springframework.ai.vectorstore.weaviate

Converts Filter.Expression into Weaviate metadata filter expression format.

WeaviateFilterExpressionConverter(List<String>) - Constructor for class org.springframework.ai.vectorstore.weaviate.WeaviateFilterExpressionConverter

Constructs a new instance of the WeaviateFilterExpressionConverter class.

WeaviateFilterExpressionConverter(List<String>, String) - Constructor for class org.springframework.ai.vectorstore.weaviate.WeaviateFilterExpressionConverter

Constructs a new instance of the WeaviateFilterExpressionConverter class.

WeaviateVectorStore - Class in org.springframework.ai.vectorstore.weaviate

A vector store implementation that stores and retrieves vectors in a Weaviate database.

WeaviateVectorStore(WeaviateVectorStore.Builder) - Constructor for class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore

Protected constructor for creating a WeaviateVectorStore instance using the builder pattern.

WeaviateVectorStore.Builder - Class in org.springframework.ai.vectorstore.weaviate

WeaviateVectorStore.ConsistentLevel - Enum Class in org.springframework.ai.vectorstore.weaviate

Defines the consistency levels for Weaviate operations.

WeaviateVectorStore.MetadataField - Record Class in org.springframework.ai.vectorstore.weaviate

Represents a metadata field configuration for Weaviate vector store.

WeaviateVectorStore.MetadataField.Type - Enum Class in org.springframework.ai.vectorstore.weaviate

Defines the supported types for metadata fields.

WeaviateVectorStoreAutoConfiguration - Class in org.springframework.ai.vectorstore.weaviate.autoconfigure

Auto-configuration for Weaviate Vector Store.

WeaviateVectorStoreAutoConfiguration() - Constructor for class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreAutoConfiguration

WeaviateVectorStoreOptions - Class in org.springframework.ai.vectorstore.weaviate

Provided Weaviate vector option configuration.

WeaviateVectorStoreOptions() - Constructor for class org.springframework.ai.vectorstore.weaviate.WeaviateVectorStoreOptions

WeaviateVectorStoreProperties - Class in org.springframework.ai.vectorstore.weaviate.autoconfigure

Configuration properties for Weaviate Vector Store.

WeaviateVectorStoreProperties() - Constructor for class org.springframework.ai.vectorstore.weaviate.autoconfigure.WeaviateVectorStoreProperties

WEB_SEARCH_RESULT_LOCATION - Enum constant in enum class org.springframework.ai.anthropic.Citation.LocationType

URL-based location for web search results

webClientBuilder(WebClient.Builder) - Method in class org.springframework.ai.deepseek.api.DeepSeekApi.Builder

webClientBuilder(WebClient.Builder) - Method in class org.springframework.ai.elevenlabs.api.ElevenLabsApi.Builder

webClientBuilder(WebClient.Builder) - Method in class org.springframework.ai.mcp.client.webflux.transport.WebClientStreamableHttpTransport.Builder

Configure the WebClient.Builder to construct the WebClient.

webClientBuilder(WebClient.Builder) - Method in class org.springframework.ai.mistralai.api.MistralAiApi.Builder

webClientBuilder(WebClient.Builder) - Method in class org.springframework.ai.ollama.api.OllamaApi.Builder

WebClientStreamableHttpTransport - Class in org.springframework.ai.mcp.client.webflux.transport

An implementation of the Streamable HTTP protocol as defined by the 2025-03-26 version of the MCP specification.

WebClientStreamableHttpTransport.Builder - Class in org.springframework.ai.mcp.client.webflux.transport

Builder for WebClientStreamableHttpTransport.

WebFluxSseClientTransport - Class in org.springframework.ai.mcp.client.webflux.transport

Deprecated, for removal: This API element is subject to removal in a future version.

The SSE transport has been deprecated in the 2025-03-26 version of the spec, and should not be used anymore. We keep it for backwards compatibility.

WebFluxSseClientTransport(WebClient.Builder, McpJsonMapper) - Constructor for class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport

Deprecated.

Constructs a new SseClientTransport with the specified WebClient builder and ObjectMapper.

WebFluxSseClientTransport(WebClient.Builder, McpJsonMapper, String) - Constructor for class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport

Deprecated.

Constructs a new SseClientTransport with the specified WebClient builder and ObjectMapper.

WebFluxSseClientTransport(WebClient.Builder, McpJsonMapper, String, SseMessageEndpointValidator) - Constructor for class org.springframework.ai.mcp.client.webflux.transport.WebFluxSseClientTransport

Deprecated.

Constructs a new SseClientTransport with the specified WebClient builder and ObjectMapper.

WebFluxSseClientTransport.Builder - Class in org.springframework.ai.mcp.client.webflux.transport

Deprecated.

Builder for WebFluxSseClientTransport.

webfluxSseServerRouterFunction(WebFluxSseServerTransportProvider) - Method in class org.springframework.ai.mcp.server.webflux.autoconfigure.McpServerSseWebFluxAutoConfiguration

Deprecated.

WebFluxSseServerTransportProvider - Class in org.springframework.ai.mcp.server.webflux.transport

Deprecated, for removal: This API element is subject to removal in a future version.

The SSE transport has been deprecated in the 2025-03-26 version of the spec, and should not be used anymore. We keep it for backwards compatibility.

WebFluxSseServerTransportProvider.Builder - Class in org.springframework.ai.mcp.server.webflux.transport

Deprecated.

Builder for creating instances of WebFluxSseServerTransportProvider.

webFluxStatelessServerRouterFunction(WebFluxStatelessServerTransport) - Method in class org.springframework.ai.mcp.server.webflux.autoconfigure.McpServerStatelessWebFluxAutoConfiguration

webFluxStatelessServerTransport(JsonMapper, McpServerStreamableHttpProperties) - Method in class org.springframework.ai.mcp.server.webflux.autoconfigure.McpServerStatelessWebFluxAutoConfiguration

WebFluxStatelessServerTransport - Class in org.springframework.ai.mcp.server.webflux.transport

Implementation of a WebFlux based McpStatelessServerTransport.

WebFluxStatelessServerTransport.Builder - Class in org.springframework.ai.mcp.server.webflux.transport

Builder for creating instances of WebFluxStatelessServerTransport.

webFluxStreamableServerRouterFunction(WebFluxStreamableServerTransportProvider) - Method in class org.springframework.ai.mcp.server.webflux.autoconfigure.McpServerStreamableHttpWebFluxAutoConfiguration

webFluxStreamableServerTransportProvider(JsonMapper, McpServerStreamableHttpProperties) - Method in class org.springframework.ai.mcp.server.webflux.autoconfigure.McpServerStreamableHttpWebFluxAutoConfiguration

WebFluxStreamableServerTransportProvider - Class in org.springframework.ai.mcp.server.webflux.transport

Implementation of a WebFlux based McpStreamableServerTransportProvider.

WebFluxStreamableServerTransportProvider.Builder - Class in org.springframework.ai.mcp.server.webflux.transport

Builder for creating instances of WebFluxStreamableServerTransportProvider.

webFluxTransport(JsonMapper, McpServerSseProperties) - Method in class org.springframework.ai.mcp.server.webflux.autoconfigure.McpServerSseWebFluxAutoConfiguration

Deprecated.

webMvcSseServerRouterFunction(WebMvcSseServerTransportProvider) - Method in class org.springframework.ai.mcp.server.webmvc.autoconfigure.McpServerSseWebMvcAutoConfiguration

Deprecated.

webMvcSseServerTransportProvider(JsonMapper, McpServerSseProperties) - Method in class org.springframework.ai.mcp.server.webmvc.autoconfigure.McpServerSseWebMvcAutoConfiguration

Deprecated.

WebMvcSseServerTransportProvider - Class in org.springframework.ai.mcp.server.webmvc.transport

Deprecated, for removal: This API element is subject to removal in a future version.

The SSE transport has been deprecated in the 2025-03-26 version of the spec, and should not be used anymore. We keep it for backwards compatibility.

WebMvcSseServerTransportProvider.Builder - Class in org.springframework.ai.mcp.server.webmvc.transport

Deprecated.

Builder for creating instances of WebMvcSseServerTransportProvider.

webMvcStatelessServerRouterFunction(WebMvcStatelessServerTransport) - Method in class org.springframework.ai.mcp.server.webmvc.autoconfigure.McpServerStatelessWebMvcAutoConfiguration

webMvcStatelessServerTransport(JsonMapper, McpServerStreamableHttpProperties) - Method in class org.springframework.ai.mcp.server.webmvc.autoconfigure.McpServerStatelessWebMvcAutoConfiguration

WebMvcStatelessServerTransport - Class in org.springframework.ai.mcp.server.webmvc.transport

Implementation of a WebMVC based McpStatelessServerTransport.

WebMvcStatelessServerTransport.Builder - Class in org.springframework.ai.mcp.server.webmvc.transport

Builder for creating instances of WebMvcStatelessServerTransport.

webMvcStreamableServerRouterFunction(WebMvcStreamableServerTransportProvider) - Method in class org.springframework.ai.mcp.server.webmvc.autoconfigure.McpServerStreamableHttpWebMvcAutoConfiguration

webMvcStreamableServerTransportProvider(JsonMapper, McpServerStreamableHttpProperties) - Method in class org.springframework.ai.mcp.server.webmvc.autoconfigure.McpServerStreamableHttpWebMvcAutoConfiguration

WebMvcStreamableServerTransportProvider - Class in org.springframework.ai.mcp.server.webmvc.transport

Server-side implementation of the Model Context Protocol (MCP) streamable transport layer using HTTP with Server-Sent Events (SSE) through Spring WebMVC.

WebMvcStreamableServerTransportProvider.Builder - Class in org.springframework.ai.mcp.server.webmvc.transport

Builder for creating instances of WebMvcStreamableServerTransportProvider.

WebSearch() - Constructor for class org.springframework.ai.model.openai.autoconfigure.OpenAiResponsesChatProperties.HostedTools.WebSearch

WebSearch(String, List<String>) - Constructor for record class org.springframework.ai.openai.responses.HostedTool.WebSearch

Creates an instance of a WebSearch record class.

webSearchTool(AnthropicWebSearchTool) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder

Enables Anthropic's built-in web search tool with the given configuration.

weight() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.TextPrompts

Returns the value of the weight record component.

WHEN_MISSING - Enum constant in enum class org.springframework.ai.ollama.management.PullModelStrategy

Only pull the model if it's not already available.

where() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.DeleteEmbeddingsRequest

Returns the value of the where record component.

where() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.GetEmbeddingsRequest

Returns the value of the where record component.

where() - Method in record class org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest

Returns the value of the where record component.

where() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

where(String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

WHERE - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

WHERE - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

WHERE() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.WhereContext

WhereContext(ParserRuleContext, int) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.WhereContext

whitelistedEmails() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the whitelistedEmails record component.

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() - Method in record class org.springframework.ai.mistralai.ocr.MistralOcrApi.OCRPageDimensions

Returns the value of the width record component.

width() - Method in record class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest

Returns the value of the width record component.

width(Integer) - Method in class org.springframework.ai.openai.OpenAiImageOptions.Builder

width(Integer) - Method in class org.springframework.ai.stabilityai.api.StabilityAiApi.GenerateImageRequest.Builder

width(Integer) - Method in class org.springframework.ai.stabilityai.api.StabilityAiImageOptions.Builder

width(Integer) - Method in class org.springframework.ai.image.ImageOptionsBuilder

window() - Method in record class org.springframework.ai.session.EventFilter

Returns the value of the window record component.

window(CompactionWindow) - Method in class org.springframework.ai.session.compaction.WindowCompactionStrategy.Builder

The rule to cut by; WindowCompactionStrategy.DEFAULT_WINDOW by default.

window(EventFilter.Window) - Method in class org.springframework.ai.session.EventFilter.Builder

The retrieval window; defaults to EventFilter.Window.ALL.

WindowCompactionStrategy - Class in org.springframework.ai.session.compaction

Keeps the recent conversation in the view and covers the rest: the one compaction strategy, configured by a CompactionWindow, the last events, the last turns or a token budget, and optionally a CompactionSummarizer that condenses what leaves the view into a summary turn.

WindowCompactionStrategy.Builder - Class in org.springframework.ai.session.compaction

withAdditionalMetadata(String, Object) - Method in class org.springframework.ai.reader.markdown.config.MarkdownDocumentReaderConfig.Builder

Adds this additional metadata to the all built Documents.

withAdditionalMetadata(Map<String, Object>) - Method in class org.springframework.ai.reader.markdown.config.MarkdownDocumentReaderConfig.Builder

Adds this additional metadata to the all built Documents.

withAssistantPrompt(String) - Method in class org.springframework.ai.bedrock.MessageToPromptConverter

withAttributes(Map<String, String>) - Method in record class org.springframework.ai.chat.messages.part.MediaPart

withAttributes(Map<String, String>) - Method in interface org.springframework.ai.chat.messages.part.MessagePart

Returns a copy of this part with the given attributes replacing the current ones.

withAttributes(Map<String, String>) - Method in record class org.springframework.ai.chat.messages.part.ReasoningPart

withAttributes(Map<String, String>) - Method in record class org.springframework.ai.chat.messages.part.TextPart

withAttributes(Map<String, String>) - Method in record class org.springframework.ai.chat.messages.part.ToolCallPart

withAttributes(Map<String, String>) - Method in record class org.springframework.ai.chat.messages.part.ToolResultPart

withAttributes(Map<String, String>) - Method in record class org.springframework.ai.chat.messages.part.UnknownPart

withBasicAuthCredentials(String, String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

Configure access to ChromaDB secured with Basic Authentication: https://docs.trychroma.com/usage-guide#basic-authentication

withCategory(GoogleGenAiSafetySetting.HarmCategory) - Method in class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.Builder

withChatExchangeToPrimaryKeyTranslator(CassandraChatMemoryRepositoryConfig.SessionIdToPrimaryKeysTranslator) - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.Builder

Deprecated.

withChunkOverlap(int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder

withChunkSize(int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder

withClusteringKeys(List<CassandraChatMemoryRepositoryConfig.SchemaColumn>) - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.Builder

Deprecated.

withCqlSession(CqlSession) - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.Builder

Deprecated.

withDriver(Driver) - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

withEncodingType(EncodingType) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder

withExcludedEmbedMetadataKeys(String...) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder

withExcludedEmbedMetadataKeys(List<String>) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder

Configures the excluded Embed metadata keys to filter out from the generative.

withExcludedInferenceMetadataKeys(String...) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder

withExcludedInferenceMetadataKeys(List<String>) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder

Configures the excluded Inference metadata keys to filter out from the generative.

withHorizontalRuleCreateDocument(boolean) - Method in class org.springframework.ai.reader.markdown.config.MarkdownDocumentReaderConfig.Builder

Text divided by horizontal lines will create new Documents.

withHumanPrompt(String) - Method in class org.springframework.ai.bedrock.MessageToPromptConverter

withIncludeBlockquote(boolean) - Method in class org.springframework.ai.reader.markdown.config.MarkdownDocumentReaderConfig.Builder

Whatever to include blockquotes in Documents.

withIncludeCodeBlock(boolean) - Method in class org.springframework.ai.reader.markdown.config.MarkdownDocumentReaderConfig.Builder

Whatever to include code blocks in Documents.

withInputType(BedrockTitanEmbeddingModel.InputType) - Method in class org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingModel

Titan Embedding API input types.

withKeepSeparator(boolean) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder

withKeyspaceName(String) - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.Builder

Deprecated.

withKeyToken(String) - Method in class org.springframework.ai.chroma.vectorstore.ChromaApi

Configure access to ChromaDB secured with static API Token Authentication: https://docs.trychroma.com/usage-guide#static-api-token-authentication

withLeftAlignment(boolean) - Method in class org.springframework.ai.reader.ExtractedTextFormatter.Builder

Align the document text to the left.

withLocalDatacenter(String) - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.Builder

Deprecated.

withMaxNumChunks(int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder

withMediaLabel(String) - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

withMessageLabel(String) - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

withMessagesColumnName(String) - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.Builder

Deprecated.

withMetadataLabel(String) - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

withMetadataSeparator(String) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder

Configures the Document metadata separator.

withMetadataTemplate(String) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder

Configures the Document metadata template.

withMetaPrefix(String) - Method in class org.springframework.ai.vectorstore.azure.AzureAiSearchFilterExpressionConverter

Adds the metadata field prefix to the given identifier name.

withMetaPrefix(String) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchAiSearchFilterExpressionConverter

withMetaPrefix(String) - Method in class org.springframework.ai.vectorstore.weaviate.WeaviateFilterExpressionConverter

withMethod(GoogleGenAiSafetySetting.HarmBlockMethod) - Method in class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.Builder

withMinChunkLengthToEmbed(int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder

withMinChunkSizeChars(int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder

withNumberOfBottomTextLinesToDelete(int) - Method in class org.springframework.ai.reader.ExtractedTextFormatter.Builder

Remove the bottom N lines from the page text.

withNumberOfTopPagesToSkipBeforeDelete(int) - Method in class org.springframework.ai.reader.ExtractedTextFormatter.Builder

Withdraw the top N pages from the text top/bottom line deletion.

withNumberOfTopTextLinesToDelete(int) - Method in class org.springframework.ai.reader.ExtractedTextFormatter.Builder

Remove the top N lines from the page text.

withoutDefaultPatterns() - Method in class org.springframework.ai.converter.ThinkingTagCleaner.Builder

Disable default patterns.

withPageBottomMargin(int) - Method in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig.Builder

Configures the Pdf reader page bottom margin.

withPageExtractedTextFormatter(ExtractedTextFormatter) - Method in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig.Builder

Formatter of the extracted text.

withPagesPerDocument(int) - Method in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig.Builder

How many pages to put in a single Document instance. 0 stands for all pages.

withPageTopMargin(int) - Method in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig.Builder

Configures the Pdf reader page top margin.

withPartitionKeys(List<CassandraChatMemoryRepositoryConfig.SchemaColumn>) - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.Builder

Deprecated.

withPunctuationMarks(List<Character>) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder

withReversedParagraphPosition(boolean) - Method in class org.springframework.ai.reader.pdf.config.PdfDocumentReaderConfig.Builder

Configures the Pdf reader reverse paragraph position.

withSessionLabel(String) - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

withSimilarityFunction(String) - Method in class org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore

withTableName(String) - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.Builder

Deprecated.

withTextTemplate(String) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder

Configures the Document text template.

withThreshold(GoogleGenAiSafetySetting.HarmBlockThreshold) - Method in class org.springframework.ai.google.genai.common.GoogleGenAiSafetySetting.Builder

withTimeToLive(Duration) - Method in class org.springframework.ai.chat.memory.repository.cassandra.CassandraChatMemoryRepositoryConfig.Builder

Deprecated.

How long are messages kept for

withToolCallLabel(String) - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

withToolResponseLabel(String) - Method in class org.springframework.ai.chat.memory.repository.neo4j.Neo4jChatMemoryRepositoryConfig.Builder

Deprecated.

withTranscriptionMetadata(AudioTranscriptionMetadata) - Method in class org.springframework.ai.audio.transcription.AudioTranscription

withUsage(ChatResponse, Usage) - Static method in class org.springframework.ai.support.UsageCalculator

Returns a copy of the given chat response with its usage replaced by the provided Usage, preserving all other response metadata.

write(List<Document>) - Method in interface org.springframework.ai.document.DocumentWriter

writePage() - Method in class org.springframework.ai.reader.pdf.layout.ForkPDFLayoutTextStripper

writePage() - Method in class org.springframework.ai.reader.pdf.layout.PDFLayoutTextStripperByArea

This will print the processed page text to the output stream.

wrongDimensionRejectedBeforeWrite() - Method in class org.springframework.ai.test.vectorstore.AbstractVectorStoreUpsertTests

WS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

WS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

X

XLSX - Enum constant in enum class org.springframework.ai.anthropic.AnthropicSkill

Excel spreadsheet generation and manipulation.

Y

youtubeUsername() - Method in record class org.springframework.ai.elevenlabs.api.ElevenLabsVoicesApi.VoiceSharing

Returns the value of the youtubeUsername record component.

_

_ATN - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

_ATN - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

_decisionToDFA - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

_decisionToDFA - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

_serializedATN - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

_serializedATN - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

_sharedContextCache - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer

_sharedContextCache - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser

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