Index

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

A

AbstractBuilder(T) - Constructor for class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor.AbstractBuilder
Constructor to create a new AbstractChatMemoryAdvisor.AbstractBuilder instance.
AbstractChatMemoryAdvisor<T> - Class in org.springframework.ai.chat.client.advisor
Abstract class that serves as a base for chat memory advisors.
AbstractChatMemoryAdvisor(T) - Constructor for class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
Constructor to create a new AbstractChatMemoryAdvisor instance.
AbstractChatMemoryAdvisor(T, String, int, boolean) - Constructor for class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
Constructor to create a new AbstractChatMemoryAdvisor instance.
AbstractChatMemoryAdvisor(T, String, int, boolean, int) - Constructor for class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
Constructor to create a new AbstractChatMemoryAdvisor instance.
AbstractChatMemoryAdvisor.AbstractBuilder<T> - Class in org.springframework.ai.chat.client.advisor
Abstract builder for AbstractChatMemoryAdvisor.
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
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
Default constructor.
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.
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, Resource, Map<String, Object>) - Constructor for class org.springframework.ai.chat.messages.AbstractMessage
Create a new AbstractMessage with the given message type, resource, and metadata.
AbstractMessageOutputConverter<T> - Class in org.springframework.ai.converter
Abstract StructuredOutputConverter implementation that uses a pre-configured MessageConverter to convert the LLM output into the desired type format.
AbstractMessageOutputConverter(MessageConverter) - Constructor for class org.springframework.ai.converter.AbstractMessageOutputConverter
Create a new AbstractMessageOutputConverter.
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.
AbstractResponseMetadata - Class in org.springframework.ai.model
 
AbstractResponseMetadata() - Constructor for class org.springframework.ai.model.AbstractResponseMetadata
Create a new AbstractResponseMetadata instance.
AbstractToolCallSupport - Class in org.springframework.ai.chat.model
Deprecated.
Use ToolCallingManager instead.
AbstractToolCallSupport(FunctionCallbackResolver) - Constructor for class org.springframework.ai.chat.model.AbstractToolCallSupport
Deprecated.
AbstractToolCallSupport(FunctionCallbackResolver, FunctionCallingOptions, List<FunctionCallback>) - Constructor for class org.springframework.ai.chat.model.AbstractToolCallSupport
Deprecated.
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
 
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.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.IdentifierContext
 
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.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.TextConstantContext
 
accept(ParseTreeVisitor<? extends T>) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.WhereContext
 
add(String, Object) - Method in class org.springframework.ai.chat.prompt.PromptTemplate
 
add(String, List<Message>) - Method in interface org.springframework.ai.chat.memory.ChatMemory
 
add(String, List<Message>) - Method in class org.springframework.ai.chat.memory.InMemoryChatMemory
 
add(String, Message) - Method in interface org.springframework.ai.chat.memory.ChatMemory
 
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 - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Operation
VectorStore add operation.
adviseContext() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns the value of the adviseContext record component.
adviseContext() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedResponse
Returns the value of the adviseContext record component.
adviseContext(Map<String, Object>) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Set the advise context.
adviseContext(Map<String, Object>) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedResponse.Builder
Set the context to advise the response.
advisedRequest(AdvisedRequest) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder
Set the advised request.
AdvisedRequest - Record Class in org.springframework.ai.chat.client.advisor.api
The data of the chat client request that can be modified before the execution of the ChatClient's call method
AdvisedRequest(ChatModel, String, String, ChatOptions, List<Media>, List<String>, List<FunctionCallback>, List<Message>, Map<String, Object>, Map<String, Object>, List<Advisor>, Map<String, Object>, Map<String, Object>, Map<String, Object>) - Constructor for record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Creates an instance of a AdvisedRequest record class.
AdvisedRequest.Builder - Class in org.springframework.ai.chat.client.advisor.api
Builder for AdvisedRequest.
AdvisedResponse - Record Class in org.springframework.ai.chat.client.advisor.api
The data of the chat client response that can be modified before the call returns.
AdvisedResponse(ChatResponse, Map<String, Object>) - Constructor for record class org.springframework.ai.chat.client.advisor.api.AdvisedResponse
Create a new AdvisedResponse instance.
AdvisedResponse.Builder - Class in org.springframework.ai.chat.client.advisor.api
Builder for AdvisedResponse.
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.
ADVISOR_TYPE - Enum constant in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.LowCardinalityKeyNames
Advisor type: Before, After or Around.
advisorName(String) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder
Set the advisor name.
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(String, AdvisorObservationContext.Type, AdvisedRequest, Map<String, Object>, Map<String, Object>, int) - Constructor for class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
AdvisorObservationContext.Builder - Class in org.springframework.ai.chat.client.advisor.observation
AdvisorObservationContext.Type - Enum Class in org.springframework.ai.chat.client.advisor.observation
The type of the advisor.
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(AdvisorObservationContext) - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention
 
advisorParams() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns the value of the advisorParams record component.
advisorParams(Map<String, Object>) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Set the advisor params.
advisorRequestContext(Map<String, Object>) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder
Set the advisor request context.
advisorResponseContext(Map<String, Object>) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder
Set the advisor response context.
advisors() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns the value of the advisors record component.
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<Advisor>) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Set the advisors.
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
 
advisorType(AdvisorObservationContext) - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention
 
advisorType(AdvisorObservationContext.Type) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder
Set the advisor type.
after(AdvisedResponse) - 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(AdvisedResponse) - Method in class org.springframework.ai.chat.client.advisor.RetrievalAugmentationAdvisor
 
AFTER - Enum constant in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Type
The advisor is called after the advised request is executed.
aggregate(Flux<ChatResponse>, Consumer<ChatResponse>) - Method in class org.springframework.ai.chat.model.MessageAggregator
 
aggregateAdvisedResponse(Flux<AdvisedResponse>, Consumer<AdvisedResponse>) - Method in class org.springframework.ai.chat.model.MessageAggregator
 
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_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_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_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).
AiObservationEventNames - Enum Class in org.springframework.ai.observation.conventions
Collection of event names used in AI observations.
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.
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(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 - Enum Class in org.springframework.ai.observation.conventions
Types of operations performed by AI systems.
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 - 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.
alignToLeft(String) - Static method in class org.springframework.ai.reader.ExtractedTextFormatter
 
ALL - Enum constant in enum class org.springframework.ai.document.MetadataMode
 
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.
allowEmptyContext(Boolean) - Method in class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter.Builder
 
alwaysThrow(boolean) - Method in class org.springframework.ai.tool.execution.DefaultToolExecutionExceptionProcessor.Builder
 
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
 
ANTHROPIC - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
AI system provided by Anthropic.
ApiKey - Interface in org.springframework.ai.model
Some model providers API leverage short-lived api keys which must be renewed at regular intervals using another credential.
applicationContext(GenericApplicationContext) - Method in class org.springframework.ai.tool.resolution.SpringBeanToolCallbackResolver.Builder
 
apply(I, ToolContext) - Method in class org.springframework.ai.model.function.FunctionInvokingFunctionCallback
Deprecated.
 
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.KeywordMetadataEnricher
 
apply(List<Document>) - Method in class org.springframework.ai.transformer.splitter.TextSplitter
 
apply(List<Document>) - Method in class org.springframework.ai.transformer.SummaryMetadataEnricher
 
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.compression.DocumentCompressor
 
apply(Query, List<Document>) - Method in interface org.springframework.ai.rag.postretrieval.ranking.DocumentRanker
 
apply(Query, List<Document>) - Method in interface org.springframework.ai.rag.postretrieval.selection.DocumentSelector
 
applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class org.springframework.ai.model.KotlinModule
 
applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class org.springframework.ai.util.json.schema.SpringAiSchemaModule
 
arguments() - Method in record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall
Returns the value of the arguments record component.
AROUND - Enum constant in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Type
The advisor is called around the advised request.
aroundCall(AdvisedRequest, CallAroundAdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor
 
aroundCall(AdvisedRequest, CallAroundAdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.CallAroundAdvisor
Around advice that wraps the ChatModel#call(Prompt) method.
aroundCall(AdvisedRequest, CallAroundAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor
 
aroundCall(AdvisedRequest, CallAroundAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor
 
aroundCall(AdvisedRequest, CallAroundAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor
 
aroundCall(AdvisedRequest, CallAroundAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor
 
aroundCall(AdvisedRequest, CallAroundAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
 
aroundCall(AdvisedRequest, CallAroundAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.VectorStoreChatMemoryAdvisor
 
aroundStream(AdvisedRequest, StreamAroundAdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor
 
aroundStream(AdvisedRequest, StreamAroundAdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.StreamAroundAdvisor
Around advice that wraps the invocation of the advised request.
aroundStream(AdvisedRequest, StreamAroundAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor
 
aroundStream(AdvisedRequest, StreamAroundAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor
 
aroundStream(AdvisedRequest, StreamAroundAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor
 
aroundStream(AdvisedRequest, StreamAroundAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor
 
aroundStream(AdvisedRequest, StreamAroundAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
 
aroundStream(AdvisedRequest, StreamAroundAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.VectorStoreChatMemoryAdvisor
 
ASSISTANT - Enum constant in enum class org.springframework.ai.chat.messages.MessageType
A Message of type assistant passed in subsequent input Messages as the Message generated in response to the user.
AssistantMessage - Class in org.springframework.ai.chat.messages
Lets the generative know the content was generated as a response to the user.
AssistantMessage(String) - Constructor for class org.springframework.ai.chat.messages.AssistantMessage
 
AssistantMessage(String, Map<String, Object>) - Constructor for class org.springframework.ai.chat.messages.AssistantMessage
 
AssistantMessage(String, Map<String, Object>, List<AssistantMessage.ToolCall>) - 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.ToolCall - Record Class in org.springframework.ai.chat.messages
 
AssistantPromptTemplate - Class in org.springframework.ai.chat.prompt
 
AssistantPromptTemplate(String) - Constructor for class org.springframework.ai.chat.prompt.AssistantPromptTemplate
 
AssistantPromptTemplate(Resource) - Constructor for class org.springframework.ai.chat.prompt.AssistantPromptTemplate
 
AUDIO - Enum constant in enum class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityType
 
AudioTranscription - Class in org.springframework.ai.audio.transcription
Represents a response returned by the AI.
AudioTranscription(String) - Constructor for class org.springframework.ai.audio.transcription.AudioTranscription
 
AudioTranscriptionMetadata - Interface in org.springframework.ai.audio.transcription
Metadata associated with an audio transcription result.
AudioTranscriptionOptions - Interface in org.springframework.ai.audio.transcription
Options for audio transcription.
AudioTranscriptionPrompt - Class in org.springframework.ai.audio.transcription
Represents an audio transcription prompt for an AI model.
AudioTranscriptionPrompt(Resource) - Constructor for class org.springframework.ai.audio.transcription.AudioTranscriptionPrompt
Construct a new AudioTranscriptionPrompt given the resource representing the audio file.
AudioTranscriptionPrompt(Resource, AudioTranscriptionOptions) - Constructor for class org.springframework.ai.audio.transcription.AudioTranscriptionPrompt
Construct a new AudioTranscriptionPrompt given the resource representing the audio file.
AudioTranscriptionResponse - Class in org.springframework.ai.audio.transcription
A response containing an audio transcription result.
AudioTranscriptionResponse(AudioTranscription) - Constructor for class org.springframework.ai.audio.transcription.AudioTranscriptionResponse
 
AudioTranscriptionResponse(AudioTranscription, AudioTranscriptionResponseMetadata) - Constructor for class org.springframework.ai.audio.transcription.AudioTranscriptionResponse
 
AudioTranscriptionResponseMetadata - Class in org.springframework.ai.audio.transcription
Metadata associated with an audio transcription response.
AudioTranscriptionResponseMetadata() - Constructor for class org.springframework.ai.audio.transcription.AudioTranscriptionResponseMetadata
 
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.
AZURE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by Azure.
AZURE_OPENAI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
AI system provided by Azure.

B

BaseAdvisor - Interface in org.springframework.ai.chat.client.advisor.api
Base advisor that implements common aspects of the CallAroundAdvisor and StreamAroundAdvisor, reducing the boilerplate code needed to implement an advisor.
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.
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>, ObjectMapper) - Constructor for class org.springframework.ai.converter.BeanOutputConverter
Constructor to initialize with the target type's class, a custom object mapper, and a line endings normalizer to ensure consistent line endings on any platform.
BeanOutputConverter(ParameterizedTypeReference<T>) - Constructor for class org.springframework.ai.converter.BeanOutputConverter
Constructor to initialize with the target class type reference.
BeanOutputConverter(ParameterizedTypeReference<T>, ObjectMapper) - Constructor for class org.springframework.ai.converter.BeanOutputConverter
Constructor to initialize with the target class type reference, a custom object mapper, and a line endings normalizer to ensure consistent line endings on any platform.
BEDROCK_CONVERSE - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
AI system provided by Bedrock Converse.
before(AdvisedRequest) - 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(AdvisedRequest) - Method in class org.springframework.ai.chat.client.advisor.RetrievalAugmentationAdvisor
 
BEFORE - Enum constant in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Type
The advisor is called before the advised request is executed.
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
 
build() - Method in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor.AbstractBuilder
Build the advisor.
build() - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Build the AdvisedRequest instance.
build() - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedResponse.Builder
Build the AdvisedResponse.
build() - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder
 
build() - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor.Builder
 
build() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder
build() - Method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor.Builder
 
build() - Method in class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor.Builder
 
build() - Method in class org.springframework.ai.chat.client.advisor.RetrievalAugmentationAdvisor.Builder
 
build() - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor.Builder
 
build() - Method in class org.springframework.ai.chat.client.advisor.VectorStoreChatMemoryAdvisor.Builder
 
build() - Method in interface org.springframework.ai.chat.client.ChatClient.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 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.document.DefaultContentFormatter.Builder
Returns the immutable configuration.
build() - Method in class org.springframework.ai.document.Document.Builder
 
build() - Method in class org.springframework.ai.embedding.EmbeddingOptionsBuilder
 
build() - Method in class org.springframework.ai.embedding.observation.EmbeddingModelObservationContext.Builder
 
build() - Method in class org.springframework.ai.image.ImageOptionsBuilder
 
build() - Method in class org.springframework.ai.image.observation.ImageModelObservationContext.Builder
 
build() - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
build() - Method in interface org.springframework.ai.model.function.FunctionCallback.FunctionInvokingSpec
Deprecated.
Builds the FunctionCallback instance.
build() - Method in interface org.springframework.ai.model.function.FunctionCallback.MethodInvokingSpec
Deprecated.
Builds the FunctionCallback instance.
build() - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
build() - Method in class org.springframework.ai.model.Media.Builder
Builds a new Media instance with the configured properties.
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 class org.springframework.ai.model.tool.LegacyToolCallingManager.Builder
Deprecated.
 
build() - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.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.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.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.resolution.SpringBeanToolCallbackResolver.Builder
 
build() - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder
 
build() - Method in record class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder.Op
 
build() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder
 
build() - Method in class org.springframework.ai.vectorstore.SearchRequest.Builder
 
build() - Method in class org.springframework.ai.vectorstore.SimpleVectorStore.SimpleVectorStoreBuilder
 
build() - Method in interface org.springframework.ai.vectorstore.VectorStore.Builder
Builds and returns a new VectorStore instance with the configured settings.
builder() - Static method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
 
builder() - Static method in record class org.springframework.ai.chat.client.advisor.api.AdvisedResponse
Create a new AdvisedResponse.Builder instance.
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.RetrievalAugmentationAdvisor
 
builder() - Static method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor
 
builder() - Static method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext
 
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.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.embedding.EmbeddingOptionsBuilder
 
builder() - Static method in class org.springframework.ai.embedding.observation.EmbeddingModelObservationContext
 
builder() - Static method in class org.springframework.ai.image.ImageOptionsBuilder
 
builder() - Static method in class org.springframework.ai.image.observation.ImageModelObservationContext
 
builder() - Static method in interface org.springframework.ai.model.function.FunctionCallback
Deprecated.
Creates a new FunctionCallback.Builder instance used to build a default FunctionCallback instance.
builder() - Static method in interface org.springframework.ai.model.function.FunctionCallingOptions
Deprecated.
 
builder() - Static method in class org.springframework.ai.model.Media
Creates a new Media builder.
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 class org.springframework.ai.model.tool.LegacyToolCallingManager
Deprecated.
 
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.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 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.resolution.SpringBeanToolCallbackResolver
 
builder() - Static method in class org.springframework.ai.transformer.splitter.TokenTextSplitter
 
builder() - Static method in class org.springframework.ai.vectorstore.SearchRequest
Builder for creating the SearchRequest instance.
builder(ObservationRegistry) - Static method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
 
builder(Method) - Static method in interface org.springframework.ai.tool.definition.ToolDefinition
Create a default ToolDefinition builder from a Method.
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
builder(String, Consumer<I>) - Static method in class org.springframework.ai.tool.function.FunctionToolCallback
builder(String, Function<I, O>) - Static method in class org.springframework.ai.tool.function.FunctionToolCallback
builder(String, Supplier<O>) - Static method in class org.springframework.ai.tool.function.FunctionToolCallback
builder(String, VectorStoreObservationContext.Operation) - Static method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
builder(ChatMemory) - Static method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor
 
builder(ChatMemory) - Static method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor
 
builder(ChatModel) - Static method in interface org.springframework.ai.chat.client.ChatClient
 
builder(ChatModel, ObservationRegistry, ChatClientObservationConvention) - Static method in interface org.springframework.ai.chat.client.ChatClient
 
builder(EmbeddingModel) - Static method in class org.springframework.ai.vectorstore.SimpleVectorStore
Creates an instance of SimpleVectorStore builder.
builder(VectorStore) - Static method in class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor
 
builder(VectorStore) - Static method in class org.springframework.ai.chat.client.advisor.VectorStoreChatMemoryAdvisor
 
Builder() - Constructor for class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
 
Builder() - Constructor for class org.springframework.ai.document.Document.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.rag.generation.augmentation.ContextualQueryAugmenter.Builder
 
Builder() - Constructor for class org.springframework.ai.reader.ExtractedTextFormatter.Builder
 
Builder() - Constructor for class org.springframework.ai.tool.execution.DefaultToolExecutionExceptionProcessor.Builder
 
Builder() - Constructor for class org.springframework.ai.tool.resolution.SpringBeanToolCallbackResolver.Builder
 
Builder() - Constructor for class org.springframework.ai.vectorstore.SearchRequest.Builder
 
Builder(ObservationRegistry) - Constructor for class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder
 
Builder(String, String) - Constructor for class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder
 
Builder(ChatMemory) - Constructor for class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor.Builder
 
Builder(ChatMemory) - Constructor for class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor.Builder
 
Builder(VectorStore) - Constructor for class org.springframework.ai.chat.client.advisor.VectorStoreChatMemoryAdvisor.Builder
 
buildGenerations(ToolExecutionResult) - Static method in interface org.springframework.ai.model.tool.ToolExecutionResult
Build a list of Generation from the tool execution result, useful for sending the tool execution result to the client directly.
buildToolCallConversation(List<Message>, AssistantMessage, ToolResponseMessage) - Method in class org.springframework.ai.chat.model.AbstractToolCallSupport
Deprecated.
buildToolCallConversation(List<Message>, AssistantMessage, ToolResponseMessage) - Method in class org.springframework.ai.model.function.FunctionCallingHelper
Deprecated.
 

C

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.chat.model.ChatModel
 
call(String) - Method in class org.springframework.ai.model.function.FunctionInvokingFunctionCallback
Deprecated.
 
call(String) - Method in interface org.springframework.ai.model.function.FunctionCallback
Deprecated.
Called when a model detects and triggers a function call.
call(String) - Method in record class org.springframework.ai.model.function.FunctionCallingHelper.FunctionDefinition
Deprecated.
 
call(String) - Method in class org.springframework.ai.model.function.MethodInvokingFunctionCallback
Deprecated.
 
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.model.function.FunctionInvokingFunctionCallback
Deprecated.
 
call(String, ToolContext) - Method in interface org.springframework.ai.model.function.FunctionCallback
Deprecated.
Called when a model detects and triggers a function call.
call(String, ToolContext) - Method in class org.springframework.ai.model.function.MethodInvokingFunctionCallback
Deprecated.
 
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(Message...) - Method in interface org.springframework.ai.chat.model.ChatModel
 
call(Prompt) - Method in interface org.springframework.ai.chat.model.ChatModel
 
call(DocumentEmbeddingRequest) - Method in interface org.springframework.ai.embedding.DocumentEmbeddingModel
 
call(EmbeddingRequest) - Method in interface org.springframework.ai.embedding.EmbeddingModel
 
call(ImagePrompt) - Method in interface org.springframework.ai.image.ImageModel
 
call(ModerationPrompt) - Method in interface org.springframework.ai.moderation.ModerationModel
 
call(TReq) - Method in interface org.springframework.ai.model.Model
Executes a method call to the AI model.
CallAroundAdvisor - Interface in org.springframework.ai.chat.client.advisor.api
Around advisor that wraps the ChatModel#call(Prompt) method.
CallAroundAdvisorChain - Interface in org.springframework.ai.chat.client.advisor.api
The Call Around Advisor Chain is used to invoke the next Around Advisor in the chain.
CASSANDRA - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by Cassandra.
castToExpression(Filter.Operand) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.FilterExpressionVisitor
 
categories(Categories) - Method in class org.springframework.ai.moderation.ModerationResult.Builder
 
Categories - Class in org.springframework.ai.moderation
The Categories class represents a set of categories used to classify content.
Categories.Builder - Class in org.springframework.ai.moderation
 
categoryScores(CategoryScores) - Method in class org.springframework.ai.moderation.ModerationResult.Builder
 
CategoryScores - Class in org.springframework.ai.moderation
This class represents the scores for different categories of content.
CategoryScores.Builder - Class in org.springframework.ai.moderation
 
channelNames - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer
 
CHARSET_METADATA - Static variable in class org.springframework.ai.reader.TextReader
 
CHAT - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType
AI operation type for chat.
CHAT_CLIENT - Enum constant in enum class org.springframework.ai.observation.conventions.SpringAiKind
Spring AI kind for chat client.
CHAT_CLIENT_ADVISOR_PARAMS - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames
Map of advisor parameters.
CHAT_CLIENT_ADVISORS - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames
List of configured chat client advisors.
CHAT_CLIENT_SYSTEM_PARAM - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames
Chat client system parameters.
CHAT_CLIENT_SYSTEM_TEXT - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames
Chat client system text.
CHAT_CLIENT_TOOL_FUNCTION_CALLBACKS - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames
List of configured chat client function callbacks.
CHAT_CLIENT_TOOL_FUNCTION_NAMES - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames
Enabled tool function names.
CHAT_CLIENT_USER_PARAMS - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames
Chat client user parameters.
CHAT_CLIENT_USER_TEXT - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames
Chat client user text.
CHAT_MEMORY_CONVERSATION_ID_KEY - Static variable in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
The key to retrieve the chat memory conversation id from the context.
CHAT_MEMORY_RETRIEVE_SIZE_KEY - Static variable in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
The key to retrieve the chat memory response size from the context.
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.CallPromptResponseSpec - Interface in org.springframework.ai.chat.client
 
ChatClient.CallResponseSpec - Interface in org.springframework.ai.chat.client
 
ChatClient.ChatClientRequestSpec - Interface in org.springframework.ai.chat.client
 
ChatClient.PromptSystemSpec - Interface in org.springframework.ai.chat.client
Specification for a prompt system.
ChatClient.PromptUserSpec - Interface in org.springframework.ai.chat.client
 
ChatClient.StreamPromptResponseSpec - Interface in org.springframework.ai.chat.client
 
ChatClient.StreamResponseSpec - Interface in org.springframework.ai.chat.client
 
chatClientAdvisorNames(KeyValues, ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
 
chatClientAdvisorParams(KeyValues, ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
 
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
 
ChatClientCustomizer - Interface in org.springframework.ai.chat.client
Callback interface that can be used to customize a ChatClient.Builder.
ChatClientInputContentObservationFilter - Class in org.springframework.ai.chat.client.observation
An ObservationFilter to include the chat prompt content in the observation.
ChatClientInputContentObservationFilter() - Constructor for class org.springframework.ai.chat.client.observation.ChatClientInputContentObservationFilter
 
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
 
chatClientSystemParams(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.ChatClientInputContentObservationFilter
 
chatClientSystemText(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.ChatClientInputContentObservationFilter
 
chatClientUserParams(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.ChatClientInputContentObservationFilter
 
chatClientUserText(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.ChatClientInputContentObservationFilter
 
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 - Variable in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor.AbstractBuilder
The chat memory.
ChatMemory - Interface in org.springframework.ai.chat.memory
The ChatMemory interface represents a storage for chat conversation history.
chatMemoryRetrieveSize - Variable in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor.AbstractBuilder
The chat memory retrieve size.
chatMemoryRetrieveSize(int) - Method in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor.AbstractBuilder
Set the chat memory retrieve size.
chatMemoryStore - Variable in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
The chat memory store.
chatModel() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns the value of the chatModel record component.
chatModel(ChatModel) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Set the chat model.
ChatModel - Interface in org.springframework.ai.chat.model
 
ChatModelCompletionObservationFilter - Class in org.springframework.ai.chat.observation
An ObservationFilter to include the chat completion content in the observation.
ChatModelCompletionObservationFilter() - Constructor for class org.springframework.ai.chat.observation.ChatModelCompletionObservationFilter
 
ChatModelCompletionObservationHandler - Class in org.springframework.ai.chat.observation
Handler for including the chat completion content in the observation as a span event.
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
 
ChatModelObservationContentProcessor - Class in org.springframework.ai.chat.observation
Utilities to process the prompt and completion content in observations for chat models.
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.Events - Enum Class in org.springframework.ai.chat.observation
Events for chat model operations.
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.
ChatModelPromptContentObservationFilter - Class in org.springframework.ai.chat.observation
An ObservationFilter to include the chat prompt content in the observation.
ChatModelPromptContentObservationFilter() - Constructor for class org.springframework.ai.chat.observation.ChatModelPromptContentObservationFilter
 
ChatModelPromptContentObservationHandler - Class in org.springframework.ai.chat.observation
Handler for including the chat prompt content in the observation as a span event.
ChatModelPromptContentObservationHandler() - Constructor for class org.springframework.ai.chat.observation.ChatModelPromptContentObservationHandler
 
chatOptions() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns the value of the chatOptions record component.
chatOptions(ChatOptions) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Set the chat options.
ChatOptions - Interface in org.springframework.ai.chat.prompt
ModelOptions representing the common options that are portable across different chat models.
ChatOptions.Builder - Interface in org.springframework.ai.chat.prompt
Builder for creating ChatOptions instance.
ChatPromptTemplate - Class in org.springframework.ai.chat.prompt
A PromptTemplate that lets you specify the role as a string should the current implementations and their roles not suffice for your needs.
ChatPromptTemplate(List<PromptTemplate>) - Constructor for class org.springframework.ai.chat.prompt.ChatPromptTemplate
 
chatResponse() - Method in interface org.springframework.ai.chat.client.ChatClient.CallPromptResponseSpec
 
chatResponse() - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec
 
chatResponse() - Method in interface org.springframework.ai.chat.client.ChatClient.StreamPromptResponseSpec
 
chatResponse() - Method in interface org.springframework.ai.chat.client.ChatClient.StreamResponseSpec
 
chatResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallPromptResponseSpec
 
chatResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
 
chatResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamPromptResponseSpec
 
chatResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamResponseSpec
 
ChatResponse - Class in org.springframework.ai.chat.model
The chat completion (e.g.
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
 
CHROMA - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by Chroma.
clear() - Method in class org.springframework.ai.model.MutableResponseMetadata
Clears the entries from the context.
clear(String) - Method in interface org.springframework.ai.chat.memory.ChatMemory
 
clear(String) - Method in class org.springframework.ai.chat.memory.InMemoryChatMemory
 
clearCache() - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser
 
clone() - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
 
clone() - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
 
collectionName(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention
 
collectionName(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder
 
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
 
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
 
completion(ChatModelObservationContext) - Static method in class org.springframework.ai.chat.observation.ChatModelObservationContentProcessor
 
COMPLETION - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames
The full response received from the model.
COMPLETION - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
The full response received from the model.
completionTokens() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage
Returns the value of the completionTokens record component.
compress(Query, List<Document>) - Method in interface org.springframework.ai.rag.postretrieval.compression.DocumentCompressor
Compresses the content of each document.
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
 
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.
concatenateMaps(Map<String, Object>) - Static method in class org.springframework.ai.observation.tracing.TracingHelper
 
concatenateStrings(List<String>) - Static method in class org.springframework.ai.observation.tracing.TracingHelper
 
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
 
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
 
containsKey(Object) - Method in class org.springframework.ai.model.AbstractResponseMetadata
Checks if context contains a key.
containsKey(Object) - Method in class org.springframework.ai.model.MutableResponseMetadata
Checks if context contains a key.
containsKey(Object) - Method in interface org.springframework.ai.model.ResponseMetadata
Checks if context contains a key.
containsKey(String) - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata
 
containsKey(String) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
 
content() - Method in interface org.springframework.ai.chat.client.ChatClient.CallPromptResponseSpec
 
content() - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec
 
content() - Method in interface org.springframework.ai.chat.client.ChatClient.StreamPromptResponseSpec
 
content() - Method in interface org.springframework.ai.chat.client.ChatClient.StreamResponseSpec
 
content() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallPromptResponseSpec
 
content() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
 
content() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamPromptResponseSpec
 
content() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamResponseSpec
 
content() - Method in record class org.springframework.ai.vectorstore.filter.Filter.Group
Returns the value of the content record component.
Content - Interface in org.springframework.ai.model
Data structure that contains content and metadata.
CONTENT_COMPLETION - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.Events
Content of the completion returned by the model.
CONTENT_COMPLETION - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationEventNames
Completion of content generation.
CONTENT_PROMPT - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.Events
Content of the prompt sent to the model.
CONTENT_PROMPT - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.Events
Content of the prompt sent to the model.
CONTENT_PROMPT - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationEventNames
Prompt for content generation.
CONTENT_QUERY_RESPONSE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreObservationEventNames
Query for content in the vector store.
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.
contents() - Method in interface org.springframework.ai.chat.client.ChatClient.CallPromptResponseSpec
 
contents() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallPromptResponseSpec
 
context() - Method in record class org.springframework.ai.rag.Query
Returns the value of the context record component.
context(Map<String, Object>) - Method in class org.springframework.ai.rag.Query.Builder
 
CONTEXT_STR_PLACEHOLDER - Static variable in class org.springframework.ai.transformer.KeywordMetadataEnricher
 
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) - Constructor for class org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter
 
ContextualQueryAugmenter.Builder - Class in org.springframework.ai.rag.generation.augmentation
 
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
 
conversationId - Variable in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor.AbstractBuilder
The conversation id.
conversationId(String) - Method in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor.AbstractBuilder
Set the conversation id.
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
 
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.
convertOperand(Filter.Operand) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter
Convert the given operand into a string representation.
convertOperand(Filter.Operand, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter
Convert the given operand into a string representation.
convertTypeValuesToUpperCase(ObjectNode) - Static method in class org.springframework.ai.util.json.schema.JsonSchemaGenerator
 
copy() - Method in interface org.springframework.ai.chat.prompt.ChatOptions
Returns a copy of this ChatOptions.
copy() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
copy() - Method in class org.springframework.ai.chat.prompt.Prompt
 
copy() - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
copy() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
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
 
copyToTarget(S, Class<I>, Class<T>) - Static method in class org.springframework.ai.model.ModelOptionsUtils
Returns a new instance of the targetBeanClazz that copies the bean values from the sourceBean instance.
COSINE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric
The cosine metric.
cosineSimilarity(float[], float[]) - Static method in class org.springframework.ai.vectorstore.SimpleVectorStore.EmbeddingMath
 
COSMOSDB - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by CosmosDB.
create() - Static method in interface org.springframework.ai.audio.transcription.AudioTranscriptionMetadata
Factory method used to construct a new AudioTranscriptionMetadata
create() - Method in class org.springframework.ai.chat.prompt.AssistantPromptTemplate
 
create() - Method in class org.springframework.ai.chat.prompt.ChatPromptTemplate
 
create() - Method in class org.springframework.ai.chat.prompt.PromptTemplate
 
create() - Method in interface org.springframework.ai.chat.prompt.PromptTemplateActions
 
create() - Method in class org.springframework.ai.chat.prompt.SystemPromptTemplate
 
create(Map<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(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) - 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
 
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.vectorstore.observation.AbstractObservationVectorStore
createObservationContextBuilder(String) - Method in class org.springframework.ai.vectorstore.SimpleVectorStore
 
CURRENT - Enum constant in enum class org.springframework.ai.transformer.SummaryMetadataEnricher.SummaryType
 
customize(ChatClient.Builder) - Method in interface org.springframework.ai.chat.client.ChatClientCustomizer
Callback to customize a ChatClient.Builder instance.
customObservationConvention - Variable in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder
 
customObservationConvention(VectorStoreObservationConvention) - Method in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder
 
customObservationConvention(VectorStoreObservationConvention) - Method in interface org.springframework.ai.vectorstore.VectorStore.Builder
Sets a custom convention for creating observations.

D

data(Object) - Method in class org.springframework.ai.model.Media.Builder
Sets the media data from any Object.
data(URL) - Method in class org.springframework.ai.model.Media.Builder
Sets the media data from a URL.
data(Resource) - Method in class org.springframework.ai.model.Media.Builder
Sets the media data from a Resource.
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 as of the vector (e.g.
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.
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_RESPONSE_DOCUMENTS - Enum constant in enum class org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.HighCardinalityKeyNames
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
 
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
 
DEFAULT_CHAT_MEMORY_CONVERSATION_ID - Static variable in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
The default conversation id to use when no conversation id is provided.
DEFAULT_CHAT_MEMORY_PRECEDENCE_ORDER - Static variable in interface org.springframework.ai.chat.client.advisor.api.Advisor
Useful constant for the default Chat Memory precedence order.
DEFAULT_CHAT_MEMORY_RESPONSE_SIZE - Static variable in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
The default chat memory retrieve size to use when no retrieve size is provided.
DEFAULT_CONTENT_FORMATTER - Static variable in class org.springframework.ai.document.Document
 
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.vectorstore.observation.DefaultVectorStoreObservationConvention
 
DEFAULT_OBSERVATION_CONVENTION - Static variable in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
 
DEFAULT_REQUEST_TO_STRING - Static variable in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
 
DEFAULT_RESPONSE_TO_STRING - Static variable in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
 
DEFAULT_SCHEDULER - Static variable in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor
 
DEFAULT_SUMMARY_EXTRACT_TEMPLATE - Static variable in class org.springframework.ai.transformer.SummaryMetadataEnricher
 
DEFAULT_TOOL_EXECUTION_ENABLED - Static variable in interface org.springframework.ai.model.tool.ToolCallingChatOptions
 
DEFAULT_TOP_K - Static variable in class org.springframework.ai.vectorstore.SearchRequest
Default value for the top 'k' similar results to return.
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
DefaultAroundAdvisorChain.Builder - Class in org.springframework.ai.chat.client.advisor
 
DefaultCallPromptResponseSpec(ChatModel, Prompt) - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallPromptResponseSpec
 
DefaultCallResponseSpec(DefaultChatClient.DefaultChatClientRequestSpec) - 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.DefaultCallPromptResponseSpec - 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.DefaultPromptSystemSpec - Class in org.springframework.ai.chat.client
 
DefaultChatClient.DefaultPromptUserSpec - Class in org.springframework.ai.chat.client
 
DefaultChatClient.DefaultStreamPromptResponseSpec - 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) - Constructor for class org.springframework.ai.chat.client.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>, String, Map<String, Object>, List<FunctionCallback>, List<Message>, List<String>, List<Media>, ChatOptions, List<Advisor>, Map<String, Object>, ObservationRegistry, ChatClientObservationConvention, Map<String, Object>) - 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
 
defaultChatMemoryRetrieveSize - Variable in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
The default chat memory retrieve size.
DefaultChatModelObservationConvention - Class in org.springframework.ai.chat.observation
Default conventions to populate observations for chat model operations.
DefaultChatModelObservationConvention() - Constructor for class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
DefaultChatOptions - Class in org.springframework.ai.chat.prompt
Default implementation for the ChatOptions.
DefaultChatOptions() - Constructor for class org.springframework.ai.chat.prompt.DefaultChatOptions
 
DefaultChatOptionsBuilder - Class in org.springframework.ai.chat.prompt
Implementation of ChatOptions.Builder to create DefaultChatOptions.
DefaultChatOptionsBuilder() - Constructor for class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
 
DefaultChatOptionsBuilder(DefaultChatOptions) - Constructor for class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
 
DefaultCommonCallbackInvokingSpec<B extends FunctionCallback.CommonCallbackInvokingSpec<B>> - Class in org.springframework.ai.model.function
Deprecated.
Use specific builder for the type of tool you need, e.g. FunctionToolCallback.Builder and MethodToolCallback.Builder.
DefaultCommonCallbackInvokingSpec() - Constructor for class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
 
defaultConfig() - Static method in class org.springframework.ai.document.DefaultContentFormatter
Returns the default config.
DefaultContentFormatter - Class in org.springframework.ai.document
Default implementation of ContentFormatter.
DefaultContentFormatter.Builder - Class in org.springframework.ai.document
 
defaultConversationId - Variable in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
The default conversation id.
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
 
defaultFunction(String, String, BiFunction<I, ToolContext, O>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
Deprecated.
defaultFunction(String, String, Function<I, O>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
Deprecated.
DefaultFunctionCallbackBuilder - Class in org.springframework.ai.model.function
Deprecated.
Use specific builder for the type of tool you need, e.g. FunctionToolCallback.Builder and MethodToolCallback.Builder.
DefaultFunctionCallbackBuilder() - Constructor for class org.springframework.ai.model.function.DefaultFunctionCallbackBuilder
Deprecated.
 
DefaultFunctionCallbackResolver - Class in org.springframework.ai.model.function
Deprecated.
DefaultFunctionCallbackResolver() - Constructor for class org.springframework.ai.model.function.DefaultFunctionCallbackResolver
Deprecated.
 
DefaultFunctionCallingOptions - Class in org.springframework.ai.model.function
Deprecated.
DefaultFunctionCallingOptions() - Constructor for class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
DefaultFunctionCallingOptionsBuilder - Class in org.springframework.ai.model.function
Deprecated.
DefaultFunctionCallingOptionsBuilder() - Constructor for class org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
defaultFunctions(String...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
defaultFunctions(String...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
Deprecated.
defaultFunctions(FunctionCallback...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
defaultFunctions(FunctionCallback...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
Deprecated.
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
 
defaultOptions(ChatOptions) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
 
defaultOptions(ChatOptions) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
 
DefaultPromptSystemSpec() - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec
 
DefaultPromptUserSpec() - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec
 
defaultRequest - Variable in class org.springframework.ai.chat.client.DefaultChatClientBuilder
 
defaults() - Static method in class org.springframework.ai.reader.ExtractedTextFormatter
Provides a default instance of the formatter.
DefaultStreamPromptResponseSpec(StreamingChatModel, Prompt) - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamPromptResponseSpec
 
DefaultStreamResponseSpec(DefaultChatClient.DefaultChatClientRequestSpec) - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamResponseSpec
 
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
 
DefaultToolCallingChatOptions - Class in org.springframework.ai.model.tool
Default implementation of ToolCallingChatOptions.
DefaultToolCallingChatOptions() - Constructor for class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
DefaultToolCallingChatOptions.Builder - Class in org.springframework.ai.model.tool
Default implementation of ToolCallingChatOptions.Builder.
DefaultToolCallingManager - Class in org.springframework.ai.model.tool
Default implementation of ToolCallingManager.
DefaultToolCallingManager(ObservationRegistry, ToolCallbackResolver, ToolExecutionExceptionProcessor) - Constructor for class org.springframework.ai.model.tool.DefaultToolCallingManager
 
DefaultToolCallingManager.Builder - Class in org.springframework.ai.model.tool
 
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.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
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
 
defaultTools(Object...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
 
defaultTools(String...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
 
defaultTools(String...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
 
defaultTools(List<ToolCallback>) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
 
defaultTools(List<ToolCallback>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
 
defaultTools(FunctionCallback...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
 
defaultTools(FunctionCallback...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
 
defaultTools(ToolCallbackProvider...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
 
defaultTools(ToolCallbackProvider...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
 
DefaultUsage - Class in org.springframework.ai.chat.metadata
Default implementation of the Usage interface.
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.
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.
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
 
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 interface org.springframework.ai.vectorstore.VectorStore
Deletes documents from the vector store using a string filter expression.
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(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.
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.
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.
description - Variable in class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
The description of the function callback.
description() - Method in record class org.springframework.ai.model.function.FunctionCallingHelper.FunctionDefinition
Deprecated.
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.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.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
 
description(String) - Method in interface org.springframework.ai.model.function.FunctionCallback.CommonCallbackInvokingSpec
Deprecated.
Function description.
description(String) - Method in class org.springframework.ai.tool.definition.DefaultToolDefinition.Builder
 
description(String) - Method in class org.springframework.ai.tool.function.FunctionToolCallback.Builder
 
DescriptiveErrorListener() - Constructor for class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.DescriptiveErrorListener
 
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(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention
 
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.
DISTANCE - Enum constant in enum class org.springframework.ai.document.DocumentMetadata
Measure of distance between the document embedding and the query vector.
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.SimpleVectorStore
 
doAddValueRangeSpitter(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter
Convert the given value range into a string representation.
DOC_CSV - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for text/csv.
DOC_DOC - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for application/msword.
DOC_DOCX - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for application/vnd.openxmlformats-officedocument.wordprocessingml.document.
DOC_HTML - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for text/html.
DOC_MD - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for text/markdown.
DOC_PDF - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for application/pdf.
DOC_TXT - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for text/plain.
DOC_XLS - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for application/vnd.ms-excel.
DOC_XLSX - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.
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
 
Document(String, String, Map<String, Object>) - Constructor for class org.springframework.ai.document.Document
 
Document(String, Map<String, Object>) - Constructor for class org.springframework.ai.document.Document
 
Document(String, Media, Map<String, Object>) - Constructor for class org.springframework.ai.document.Document
 
Document(Media, Map<String, Object>) - Constructor for class org.springframework.ai.document.Document
 
DOCUMENT_CONTEXT - Static variable in class org.springframework.ai.chat.client.advisor.RetrievalAugmentationAdvisor
 
Document.Builder - Class in org.springframework.ai.document
 
DocumentCompressor - Interface in org.springframework.ai.rag.postretrieval.compression
A component for compressing the content of each document to reduce noise and redundancy in the retrieved information, addressing challenges such as "lost-in-the-middle" and context length restrictions from the model.
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
 
documentJoiner(DocumentJoiner) - Method in class org.springframework.ai.chat.client.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.
DocumentRanker - Interface in org.springframework.ai.rag.postretrieval.ranking
A component for ordering and ranking documents based on their relevance to a query to bring the most relevant documents to the top of the list, addressing challenges such as "lost-in-the-middle".
DocumentReader - Interface in org.springframework.ai.document
 
documentRetriever(DocumentRetriever) - Method in class org.springframework.ai.chat.client.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(VectorStoreObservationContext) - Static method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContentProcessor
 
DocumentSelector - Interface in org.springframework.ai.rag.postretrieval.selection
A component for removing irrelevant or redundant documents from a list of retrieved documents, addressing challenges such as "lost-in-the-middle" and context length restrictions from the model.
DocumentTransformer - Interface in org.springframework.ai.document
 
DocumentWriter - Interface in org.springframework.ai.document
Write a list of Document instances.
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.SimpleVectorStore
 
doDelete(Filter.Expression) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore
Template method for concrete implementations to provide filter-based deletion logic.
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
 
doEndValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter
Convert the given value range into a string representation.
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.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.filter.converter.SimpleVectorStoreFilterExpressionConverter
 
doGetChatMemoryRetrieveSize(Map<String, Object>) - Method in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
Get the default chat memory retrieve size.
doGetConversationId(Map<String, Object>) - Method in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
Get the default conversation id.
doGetFilterExpression(Map<String, Object>) - Method in class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor
 
doGetSupportingData(EvaluationRequest) - Method in interface org.springframework.ai.evaluation.Evaluator
 
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.filter.converter.SimpleVectorStoreFilterExpressionConverter
 
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.filter.converter.SimpleVectorStoreFilterExpressionConverter
 
doNextWithProtectFromBlockingBefore(AdvisedRequest, StreamAroundAdvisorChain, Function<AdvisedRequest, AdvisedRequest>) - Method in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
Execute the next advisor in the chain.
doNot(Filter.Expression, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter
Convert the given expression into a string representation.
doResponseEntity(StructuredOutputConverter<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
 
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.SimpleVectorStore
 
doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter
Convert the given value into a string representation.
doSingleValue(Object, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.SimpleVectorStoreFilterExpressionConverter
 
doSplit(String, int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter
 
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
 
doStartValueRange(Filter.Value, StringBuilder) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter
Convert the given value range into a string representation.
DOT - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric
The dot product metric.
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.IdentifierContext
 
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
 
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.filter.converter.SimpleVectorStoreFilterExpressionConverter
 

E

ELASTICSEARCH - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by Elasticsearch.
embed(String) - Method in interface org.springframework.ai.embedding.EmbeddingModel
Embeds the given text into a vector.
embed(List<String>) - Method in interface org.springframework.ai.embedding.EmbeddingModel
Embeds a batch of texts into vectors.
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 interface org.springframework.ai.embedding.EmbeddingModel
Embeds the given document's content into a vector.
EMBED - Enum constant in enum class org.springframework.ai.document.MetadataMode
 
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 - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType
AI operation type for embedding.
EMBEDDING_MODEL_OPERATION - Enum constant in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation
 
embeddingDimensions - Variable in class org.springframework.ai.embedding.AbstractEmbeddingModel
Cached embedding dimensions.
embeddingModel - Variable in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder
 
embeddingModel - Variable in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore
 
EmbeddingModel - Interface in org.springframework.ai.embedding
EmbeddingModel is a generic interface for embedding models.
EmbeddingModelDescription - Interface in org.springframework.ai.model
Description of an embedding model.
EmbeddingModelMeterObservationHandler - Class in org.springframework.ai.embedding.observation
Handler for generating metrics from embedding model observations.
EmbeddingModelMeterObservationHandler(MeterRegistry) - Constructor for class org.springframework.ai.embedding.observation.EmbeddingModelMeterObservationHandler
 
EmbeddingModelObservationContext - Class in org.springframework.ai.embedding.observation
Context used to store metadata for embedding model exchanges.
EmbeddingModelObservationContext.Builder - Class in org.springframework.ai.embedding.observation
 
EmbeddingModelObservationConvention - Interface in org.springframework.ai.embedding.observation
Interface for an ObservationConvention for embedding model exchanges.
EmbeddingModelObservationDocumentation - Enum Class in org.springframework.ai.embedding.observation
Documented conventions for embedding model observations.
EmbeddingModelObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.ai.embedding.observation
High-cardinality observation key names for embedding model operations.
EmbeddingModelObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.ai.embedding.observation
Low-cardinality observation key names for embedding model operations.
EmbeddingOptions - Interface in org.springframework.ai.embedding
Options for embedding models.
EmbeddingOptionsBuilder - Class in org.springframework.ai.embedding
Builder for EmbeddingOptions.
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
 
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
 
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.
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
 
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 EmpytUsage implementation that returns zero for all property getters
EmptyUsage() - Constructor for class org.springframework.ai.chat.metadata.EmptyUsage
 
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().
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().
enterIdentifier(FiltersParser.IdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener
Enter a parse tree produced by FiltersParser.identifier().
enterIdentifier(FiltersParser.IdentifierContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener
Enter a parse tree produced by FiltersParser.identifier().
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().
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().
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.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.IdentifierContext
 
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.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.TextConstantContext
 
enterRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.WhereContext
 
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
 
entity(Class<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
 
entity(StructuredOutputConverter<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec
 
entity(StructuredOutputConverter<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
 
entity(ParameterizedTypeReference<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec
 
entity(ParameterizedTypeReference<T>) - 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
 
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.audio.transcription.AudioTranscription
 
equals(Object) - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedResponse
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 class org.springframework.ai.chat.messages.AbstractMessage
 
equals(Object) - Method in class org.springframework.ai.chat.messages.AssistantMessage
 
equals(Object) - Method in record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.springframework.ai.chat.messages.SystemMessage
 
equals(Object) - Method in class org.springframework.ai.chat.messages.ToolResponseMessage
 
equals(Object) - Method in record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata
 
equals(Object) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
 
equals(Object) - Method in class org.springframework.ai.chat.metadata.DefaultUsage
 
equals(Object) - Method in class org.springframework.ai.chat.model.ChatResponse
 
equals(Object) - Method in class org.springframework.ai.chat.model.Generation
 
equals(Object) - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.springframework.ai.chat.prompt.Prompt
 
equals(Object) - Method in class org.springframework.ai.document.Document
 
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.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.model.function.FunctionInvokingFunctionCallback
Deprecated.
 
equals(Object) - Method in record class org.springframework.ai.model.function.FunctionCallingHelper.FunctionDefinition
Deprecated.
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 class org.springframework.ai.moderation.Categories
 
equals(Object) - Method in class org.springframework.ai.moderation.CategoryScores
 
equals(Object) - Method in class org.springframework.ai.moderation.Moderation
 
equals(Object) - Method in class org.springframework.ai.moderation.ModerationMessage
 
equals(Object) - Method in class org.springframework.ai.moderation.ModerationPrompt
 
equals(Object) - Method in class org.springframework.ai.moderation.ModerationResponse
 
equals(Object) - Method in class org.springframework.ai.moderation.ModerationResult
 
equals(Object) - Method in record class org.springframework.ai.observation.AiOperationMetadata
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.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.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 class org.springframework.ai.vectorstore.SearchRequest
 
equals(Object) - Method in class org.springframework.ai.vectorstore.SimpleVectorStoreContent
 
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
 
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
 
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(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(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.
evaluate(EvaluationRequest) - Method in interface org.springframework.ai.evaluation.Evaluator
 
evaluate(EvaluationRequest) - Method in class org.springframework.ai.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.evaluation.RelevancyEvaluator
 
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
Deprecated.
EvaluationResponse(boolean, String, Map<String, Object>) - Constructor for class org.springframework.ai.evaluation.EvaluationResponse
 
Evaluator - Interface in org.springframework.ai.evaluation
 
executeFunctions(AssistantMessage, ToolContext) - Method in class org.springframework.ai.chat.model.AbstractToolCallSupport
Deprecated.
executeToolCalls(Prompt, ChatResponse) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager
 
executeToolCalls(Prompt, ChatResponse) - Method in class org.springframework.ai.model.tool.LegacyToolCallingManager
Deprecated.
 
executeToolCalls(Prompt, ChatResponse) - Method in interface org.springframework.ai.model.tool.ToolCallingManager
Execute the tool calls requested by the model.
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().
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().
exitIdentifier(FiltersParser.IdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseListener
Exit a parse tree produced by FiltersParser.identifier().
exitIdentifier(FiltersParser.IdentifierContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersListener
Exit a parse tree produced by FiltersParser.identifier().
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().
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().
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.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.IdentifierContext
 
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.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.TextConstantContext
 
exitRule(ParseTreeListener) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.WhereContext
 
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.
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.
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.
extractOtelSpan(TracingObservationHandler.TracingContext) - Static method in class org.springframework.ai.observation.tracing.TracingHelper
 

F

FactCheckingEvaluator - Class in org.springframework.ai.evaluation
Implementation of Evaluator used to evaluate the factual accuracy of Large Language Model (LLM) responses against provided context.
FactCheckingEvaluator(ChatClient.Builder) - Constructor for class org.springframework.ai.evaluation.FactCheckingEvaluator
Constructs a new FactCheckingEvaluator with the provided ChatClient.Builder.
FactCheckingEvaluator(ChatClient.Builder, String) - Constructor for class org.springframework.ai.evaluation.FactCheckingEvaluator
Constructs a new FactCheckingEvaluator with the provided ChatClient.Builder and evaluation prompt.
failureResponse(String) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor.Builder
 
fieldName(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention
 
fieldName(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder
 
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.
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.QuestionAnswerAdvisor
 
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.
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.
filterExpression(String) - Method in class org.springframework.ai.vectorstore.SearchRequest.Builder
Document metadata filter expression.
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.SearchRequest.Builder
Retrieves documents by query embedding similarity and matching the filters.
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 - 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.
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.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.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.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.
findByPromptIndex(int) - Method in interface org.springframework.ai.chat.metadata.PromptMetadata
Returns an Optional PromptMetadata.PromptFilterMetadata at the given index.
findClassesInPackage(String, TypeFilter) - Static method in class org.springframework.ai.aot.AiRuntimeHints
Finds all classes in the specified package that match the given type filter.
findJsonAnnotatedClassesInPackage(Class<?>) - Static method in class org.springframework.ai.aot.AiRuntimeHints
Finds classes in a package that are annotated with JsonInclude or have Jackson annotations.
findJsonAnnotatedClassesInPackage(String) - Static method in class org.springframework.ai.aot.AiRuntimeHints
Finds classes in a package that are annotated with JsonInclude or have Jackson annotations.
FINISH_REASON - Static variable in interface org.springframework.ai.model.tool.ToolExecutionResult
 
finishReason(String) - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata.Builder
Set the reason this choice completed for the generation.
finishReason(String) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadataBuilder
 
flagged(boolean) - Method in class org.springframework.ai.moderation.ModerationResult.Builder
 
forBespokeMinicheck(ChatClient.Builder) - Static method in class org.springframework.ai.evaluation.FactCheckingEvaluator
Creates a FactCheckingEvaluator configured for use with the Bespoke Minicheck model.
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.model.Media.Format
 
FormatProvider - Interface in org.springframework.ai.converter
Implementations of this interface provides instructions for how the output of a language generative should be formatted.
FRAMEWORK - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType
AI operation type for framework.
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.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
frequencyPenalty(Double) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
 
frequencyPenalty(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
 
frequencyPenalty(Double) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.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(Object...) - Static method in class org.springframework.ai.tool.ToolCallbacks
 
from(Method) - Static method in interface org.springframework.ai.tool.definition.ToolDefinition
Create a default ToolDefinition instance from a Method.
from(Method) - Static method in interface org.springframework.ai.tool.metadata.ToolMetadata
Create a default ToolMetadata instance from a Method.
from(List<? extends FunctionCallback>) - Static method in interface org.springframework.ai.tool.ToolCallbackProvider
 
from(AdvisedRequest) - Static method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
 
from(AdvisedResponse) - Static method in record class org.springframework.ai.chat.client.advisor.api.AdvisedResponse
Create a new AdvisedResponse.Builder instance from the provided AdvisedResponse.
from(ChatResponse) - Method in class org.springframework.ai.chat.model.ChatResponse.Builder
 
from(DefaultContentFormatter) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder
 
from(FunctionCallback...) - 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.
fromJson(Integer, Integer, Long, Integer, Object) - Static method in class org.springframework.ai.chat.metadata.DefaultUsage
Create a new DefaultUsage with promptTokens, completionTokens, and totalTokens.
fromJson(String, TypeReference<T>) - Static method in class org.springframework.ai.util.json.JsonParser
Converts a JSON string to a Java object.
fromJson(String, Class<T>) - Static method in class org.springframework.ai.util.json.JsonParser
Converts a JSON string to a Java object.
fromJson(String, Type) - Static method in class org.springframework.ai.util.json.JsonParser
Converts a JSON string to a Java object.
fromValue(String) - Static method in enum class org.springframework.ai.chat.messages.MessageType
 
fromValue(String) - Static method in enum class org.springframework.ai.chat.prompt.TemplateFormat
 
function(String) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
function(String) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
The function name to be registered with the chat model.
function(String) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
Deprecated.
function(String) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
Deprecated.
function(String, BiFunction<I, ToolContext, O>) - Method in class org.springframework.ai.model.function.DefaultFunctionCallbackBuilder
Deprecated.
 
function(String, BiFunction<I, ToolContext, O>) - Method in interface org.springframework.ai.model.function.FunctionCallback.Builder
Deprecated.
Builds a BiFunction invoking FunctionCallback instance.
function(String, Consumer<I>) - Method in class org.springframework.ai.model.function.DefaultFunctionCallbackBuilder
Deprecated.
 
function(String, Consumer<I>) - Method in interface org.springframework.ai.model.function.FunctionCallback.Builder
Deprecated.
Builds a Consumer invoking FunctionCallback instance.
function(String, Function<I, O>) - Method in class org.springframework.ai.model.function.DefaultFunctionCallbackBuilder
Deprecated.
 
function(String, Function<I, O>) - Method in interface org.springframework.ai.model.function.FunctionCallback.Builder
Deprecated.
Builds a Function invoking FunctionCallback instance.
function(String, Supplier<O>) - Method in class org.springframework.ai.model.function.DefaultFunctionCallbackBuilder
Deprecated.
 
function(String, Supplier<O>) - Method in interface org.springframework.ai.model.function.FunctionCallback.Builder
Deprecated.
Builds a Supplier invoking FunctionCallback instance.
FunctionCallback - Interface in org.springframework.ai.model.function
Deprecated.
in favor of ToolCallback.
FunctionCallback.Builder - Interface in org.springframework.ai.model.function
Deprecated.
Use specific builder for the type of tool you need, e.g. FunctionToolCallback.Builder and MethodToolCallback.Builder.
FunctionCallback.CommonCallbackInvokingSpec<B extends FunctionCallback.CommonCallbackInvokingSpec<B>> - Interface in org.springframework.ai.model.function
Deprecated.
 
FunctionCallback.FunctionInvokingSpec<I,O> - Interface in org.springframework.ai.model.function
Deprecated.
Function invoking builder interface.
FunctionCallback.MethodInvokingSpec - Interface in org.springframework.ai.model.function
Deprecated.
Method invoking builder interface.
FunctionCallback.SchemaType - Enum Class in org.springframework.ai.model.function
Deprecated.
Describes the type of the schema used to describe the input parameters of the function.
functionCallbackRegister - Variable in class org.springframework.ai.chat.model.AbstractToolCallSupport
Deprecated.
The function callback register is used to resolve the function callbacks by name.
functionCallbackResolver - Variable in class org.springframework.ai.chat.model.AbstractToolCallSupport
Deprecated.
The function callback resolver is used to resolve the function callbacks by name from the Spring context.
functionCallbackResolver(FunctionCallbackResolver) - Method in class org.springframework.ai.model.tool.LegacyToolCallingManager.Builder
Deprecated.
 
FunctionCallbackResolver - Interface in org.springframework.ai.model.function
Deprecated.
functionCallbacks() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns the value of the functionCallbacks record component.
functionCallbacks(List<FunctionCallback>) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Set the function callbacks.
functionCallbacks(List<FunctionCallback>) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
functionCallbacks(List<FunctionCallback>) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
The list of Function Callbacks to be registered with the Chat model.
functionCallbacks(List<FunctionCallback>) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
Deprecated.
functionCallbacks(List<FunctionCallback>) - Method in class org.springframework.ai.model.tool.LegacyToolCallingManager.Builder
Deprecated.
 
functionCallbacks(List<FunctionCallback>) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
Deprecated.
functionCallbacks(FunctionCallback...) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
functionCallbacks(FunctionCallback...) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
The Function Callbacks to be registered with the Chat model.
functionCallbacks(FunctionCallback...) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
Deprecated.
functionCallbacks(FunctionCallback...) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
Deprecated.
FunctionCallingHelper - Class in org.springframework.ai.model.function
Deprecated.
Use ToolCallingManager instead.
FunctionCallingHelper() - Constructor for class org.springframework.ai.model.function.FunctionCallingHelper
Deprecated.
 
FunctionCallingHelper(FunctionCallbackResolver, FunctionCallingOptions, List<FunctionCallback>) - Constructor for class org.springframework.ai.model.function.FunctionCallingHelper
Deprecated.
 
FunctionCallingHelper.FunctionDefinition - Record Class in org.springframework.ai.model.function
Deprecated.
Helper used to provide only the function definition, without the actual function call implementation.
FunctionCallingOptions - Interface in org.springframework.ai.model.function
Deprecated.
FunctionCallingOptions.Builder - Interface in org.springframework.ai.model.function
Deprecated.
Builder for creating FunctionCallingOptions instance.
FunctionDefinition(String, String, String) - Constructor for record class org.springframework.ai.model.function.FunctionCallingHelper.FunctionDefinition
Deprecated.
Creates an instance of a FunctionDefinition record class.
FunctionInvokingFunctionCallback<I,O> - Class in org.springframework.ai.model.function
Deprecated.
functionNames() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns the value of the functionNames record component.
functionNames(List<String>) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Set the function names.
FunctionPromptTemplate - Class in org.springframework.ai.chat.prompt
 
FunctionPromptTemplate(String) - Constructor for class org.springframework.ai.chat.prompt.FunctionPromptTemplate
 
functions(String...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
Deprecated.
functions(String...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
Deprecated.
functions(Set<String>) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
functions(Set<String>) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
Set of function names to be registered with the Chat model.
functions(Set<String>) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
Deprecated.
functions(Set<String>) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
Deprecated.
functions(FunctionCallback...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
Deprecated.
functions(FunctionCallback...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
Deprecated.
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

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.
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
 
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.
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
 
generateJsonSchema(Map<String, Class<?>>) - Method in class org.springframework.ai.model.function.MethodInvokingFunctionCallback
Deprecated.
Generates a JSON schema from the given named classes.
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() - Constructor for class org.springframework.ai.moderation.Generation
 
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.TextReader
 
get(JsonNode) - Method in class org.springframework.ai.reader.JsonReader
 
get(String) - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata
 
get(String) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
 
get(String) - Method in class org.springframework.ai.model.AbstractResponseMetadata
Gets an entry from the context.
get(String) - Method in class org.springframework.ai.model.MutableResponseMetadata
Gets an entry from the context.
get(String) - Method in interface org.springframework.ai.model.ResponseMetadata
Gets an entry from the context.
get(String) - Method in class org.springframework.ai.reader.JsonReader
Retrieves documents from the JSON resource using a JSON Pointer.
get(String, int) - Method in interface org.springframework.ai.chat.memory.ChatMemory
 
get(String, int) - Method in class org.springframework.ai.chat.memory.InMemoryChatMemory
 
getAdvisedRequest() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
The order of the advisor in the advisor chain.
getAdvisorName() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
The advisor name.
getAdvisorParams() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
getAdvisorRequestContext() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
Get the shared data between the advisors in the chain.
getAdvisorResponseContext() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
Get the shared data between the advisors in the chain.
getAdvisors() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec
 
getAdvisors() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
getAdvisorType() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
The type of the advisor.
getATN() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer
 
getATN() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser
 
getB64Json() - Method in class org.springframework.ai.image.Image
 
getBatchingStrategy() - Method in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder
 
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.
getCategories() - Method in class org.springframework.ai.moderation.ModerationResult
 
getCategoryScores() - Method in class org.springframework.ai.moderation.ModerationResult
 
getChannelNames() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer
 
getCharset() - Method in class org.springframework.ai.reader.TextReader
 
getChatMemoryStore() - Method in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
Get the chat memory store.
getChatOptions() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
getCollectionName() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
getCompletionTokens() - Method in class org.springframework.ai.chat.metadata.DefaultUsage
 
getCompletionTokens() - Method in class org.springframework.ai.chat.metadata.EmptyUsage
 
getCompletionTokens() - Method in interface org.springframework.ai.chat.metadata.Usage
Returns the number of tokens returned in the generation (aka completion) of the AI's response.
getCompletionTokens() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage
 
getConsumerInputClass(Class<? extends Consumer<?>>) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper
Returns the input class of a given Consumer class.
getContentFilterMetadata() - Method in interface org.springframework.ai.chat.metadata.PromptMetadata.PromptFilterMetadata
Returns the underlying AI provider metadata for filtering applied to prompt content.
getContentFilters() - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata
 
getContentFilters() - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
 
getContentFormatter() - Method in class org.springframework.ai.document.Document
Deprecated.
We are considering getting rid of this, please comment on https://github.com/spring-projects/spring-ai/issues/1782
getContents() - Method in class org.springframework.ai.chat.prompt.Prompt
 
getContext() - Method in class org.springframework.ai.chat.model.ToolContext
Returns the immutable context map.
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(VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention
 
getConversionService() - Method in class org.springframework.ai.converter.AbstractConversionServiceOutputConverter
Return the ConversionService used by this converter.
getCreated() - Method in class org.springframework.ai.image.ImageResponseMetadata
 
getCumulativeUsage(Usage, ChatResponse) - Static method in class org.springframework.ai.chat.metadata.UsageUtils
Accumulate usage tokens from the previous chat response to the current usage tokens.
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
 
getData() - Method in class org.springframework.ai.model.Media
Get the media data object
getDataAsByteArray() - Method in class org.springframework.ai.model.Media
Get the media data as a byte array
getDatabaseSystem() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
getDataList() - Method in class org.springframework.ai.evaluation.EvaluationRequest
 
getDefaultOptions() - Method in interface org.springframework.ai.chat.model.ChatModel
 
getDescription() - Method in class org.springframework.ai.model.function.FunctionInvokingFunctionCallback
Deprecated.
 
getDescription() - Method in class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
 
getDescription() - Method in interface org.springframework.ai.model.function.FunctionCallback
Deprecated.
 
getDescription() - Method in record class org.springframework.ai.model.function.FunctionCallingHelper.FunctionDefinition
Deprecated.
 
getDescription() - Method in class org.springframework.ai.model.function.MethodInvokingFunctionCallback
Deprecated.
 
getDescription() - Method in interface org.springframework.ai.model.ModelDescription
Returns the description of the model.
getDescription() - Method in interface org.springframework.ai.tool.ToolCallback
Deprecated.
getDimensions() - Method in interface org.springframework.ai.embedding.EmbeddingOptions
 
getDimensions() - Method in interface org.springframework.ai.model.EmbeddingModelDescription
 
getDimensions() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
getDocumentData() - Method in class org.springframework.ai.embedding.EmbeddingResultMetadata
 
getDocumentId() - Method in class org.springframework.ai.embedding.EmbeddingResultMetadata
 
getDuplicateToolNames(List<FunctionCallback>) - Static method in class org.springframework.ai.tool.util.ToolUtils
 
getDuplicateToolNames(FunctionCallback...) - Static method in class org.springframework.ai.tool.util.ToolUtils
 
getEmbedding() - Method in class org.springframework.ai.vectorstore.SimpleVectorStoreContent
Returns a defensive copy of the embedding vector.
getEmbeddingModel() - Method in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder
 
getEntity() - Method in record class org.springframework.ai.chat.client.ResponseEntity
 
getExcludedEmbedMetadataKeys() - Method in class org.springframework.ai.document.DefaultContentFormatter
 
getExcludedInferenceMetadataKeys() - Method in class org.springframework.ai.document.DefaultContentFormatter
 
getFeedback() - Method in class org.springframework.ai.evaluation.EvaluationResponse
 
getFieldName() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
getFilterExpression() - Method in class org.springframework.ai.vectorstore.SearchRequest
 
getFinishReason() - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata
Get the reason this choice completed for the generation.
getFinishReason() - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
 
getFormat() - Method in class org.springframework.ai.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
 
getFormattedContent() - Method in class org.springframework.ai.document.Document
 
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
 
getFrequencyPenalty() - Method in interface org.springframework.ai.chat.prompt.ChatOptions
Returns the frequency penalty to use for the chat.
getFrequencyPenalty() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
getFrequencyPenalty() - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
getFrequencyPenalty() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
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.
getFunctionCallbackRegister() - Method in class org.springframework.ai.chat.model.AbstractToolCallSupport
Deprecated.
getFunctionCallbacks() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
getFunctionCallbacks() - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
getFunctionCallbacks() - Method in interface org.springframework.ai.model.function.FunctionCallingOptions
Deprecated.
Function Callbacks to be registered with the ChatModel.
getFunctionCallbacks() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
getFunctionInputClass(Class<? extends Function<?, ?>>) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper
Returns the input class of a given function class.
getFunctionNames() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
getFunctionOutputClass(Class<? extends Function<?, ?>>) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper
Returns the output class of a given function class.
getFunctions() - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
getFunctions() - Method in interface org.springframework.ai.model.function.FunctionCallingOptions
Deprecated.
 
getFunctions() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
getGenerationTokens() - Method in interface org.springframework.ai.chat.metadata.Usage
Deprecated, for removal: This API element is subject to removal in a future version.
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
 
getHeight() - Method in interface org.springframework.ai.image.ImageOptions
 
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(VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention
 
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.document.Document
Returns the unique identifier for this document.
getId() - Method in class org.springframework.ai.model.Media
Get the media id
getId() - Method in class org.springframework.ai.moderation.Moderation
 
getId() - Method in class org.springframework.ai.vectorstore.SimpleVectorStoreContent
 
getIndex() - Method in class org.springframework.ai.embedding.Embedding
 
getInputTypeSchema() - Method in class org.springframework.ai.model.function.FunctionInvokingFunctionCallback
Deprecated.
 
getInputTypeSchema() - Method in class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
 
getInputTypeSchema() - Method in interface org.springframework.ai.model.function.FunctionCallback
Deprecated.
 
getInputTypeSchema() - Method in record class org.springframework.ai.model.function.FunctionCallingHelper.FunctionDefinition
Deprecated.
 
getInputTypeSchema() - Method in class org.springframework.ai.model.function.MethodInvokingFunctionCallback
Deprecated.
 
getInputTypeSchema() - Method in interface org.springframework.ai.tool.ToolCallback
Deprecated.
getInputVariables() - Method in class org.springframework.ai.chat.prompt.PromptTemplate
 
getInstructions() - Method in class org.springframework.ai.audio.transcription.AudioTranscriptionPrompt
 
getInstructions() - Method in class org.springframework.ai.chat.prompt.Prompt
 
getInstructions() - Method in class org.springframework.ai.embedding.DocumentEmbeddingRequest
 
getInstructions() - Method in class org.springframework.ai.embedding.EmbeddingRequest
 
getInstructions() - Method in class org.springframework.ai.image.ImagePrompt
 
getInstructions() - Method in interface org.springframework.ai.model.ModelRequest
Retrieves the instructions or input required by the AI model.
getInstructions() - Method in class org.springframework.ai.moderation.ModerationPrompt
 
getJsonPropertyValues(Class<?>) - Static method in class org.springframework.ai.model.ModelOptionsUtils
Returns the list of name values of the JsonProperty annotations.
getJsonSchema() - Method in class org.springframework.ai.converter.BeanOutputConverter
Provides the generated JSON schema for the target type.
getJsonSchema(Type, boolean) - Static method in class org.springframework.ai.model.ModelOptionsUtils
Generates JSON Schema (version 2020_12) for the given class.
getJsonSchemaMap() - Method in class org.springframework.ai.converter.BeanOutputConverter
 
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(VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention
 
getMaxTokens() - Method in interface org.springframework.ai.chat.prompt.ChatOptions
Returns the maximum number of tokens to use for the chat.
getMaxTokens() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
getMaxTokens() - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
getMaxTokens() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
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 class org.springframework.ai.document.Document
Returns the document's media content, if any.
getMedia() - Method in interface org.springframework.ai.model.MediaContent
Get the media associated with the content.
getMessageConverter() - Method in class org.springframework.ai.converter.AbstractMessageOutputConverter
Return the message converter used by this output converter.
getMessages() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
getMessageType() - Method in class org.springframework.ai.chat.messages.AbstractMessage
Get the message type of the message.
getMessageType() - Method in interface org.springframework.ai.chat.messages.Message
Get the message type.
getMetadata() - Method in class org.springframework.ai.audio.transcription.AudioTranscription
 
getMetadata() - Method in class org.springframework.ai.audio.transcription.AudioTranscriptionResponse
 
getMetadata() - Method in class org.springframework.ai.chat.messages.AbstractMessage
Get the metadata of the message.
getMetadata() - Method in class org.springframework.ai.chat.model.ChatResponse
 
getMetadata() - Method in class org.springframework.ai.chat.model.Generation
 
getMetadata() - Method in class org.springframework.ai.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.ImageResponse
 
getMetadata() - Method in interface org.springframework.ai.model.Content
Get the metadata associated with the content.
getMetadata() - Method in interface org.springframework.ai.model.ModelResponse
Retrieves the response metadata associated with the AI model's response.
getMetadata() - Method in interface org.springframework.ai.model.ModelResult
Retrieves the metadata associated with the result of an AI model.
getMetadata() - Method in class org.springframework.ai.moderation.Generation
 
getMetadata() - Method in class org.springframework.ai.moderation.ModerationResponse
 
getMetadata() - Method in class org.springframework.ai.vectorstore.SimpleVectorStoreContent
 
getMetadataSeparator() - Method in class org.springframework.ai.document.DefaultContentFormatter
 
getMetadataTemplate() - Method in class org.springframework.ai.document.DefaultContentFormatter
 
getMimeType() - Method in class org.springframework.ai.embedding.EmbeddingResultMetadata
 
getMimeType() - Method in class org.springframework.ai.model.Media
Get the media MIME 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.
getModel() - Method in interface org.springframework.ai.audio.transcription.AudioTranscriptionOptions
 
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 interface org.springframework.ai.embedding.EmbeddingOptions
 
getModel() - Method in class org.springframework.ai.embedding.EmbeddingResponseMetadata
The model that handled the request.
getModel() - Method in interface org.springframework.ai.image.ImageOptions
 
getModel() - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
getModel() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
getModel() - Method in class org.springframework.ai.moderation.Moderation
 
getModel() - Method in interface org.springframework.ai.moderation.ModerationOptions
 
getModeNames() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer
 
getN() - Method in interface org.springframework.ai.image.ImageOptions
 
getName() - Method in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor
 
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.observation.DefaultAdvisorObservationConvention
 
getName() - Method in class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor
 
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.observation.DefaultChatClientObservationConvention
 
getName() - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
getName() - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
 
getName() - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
 
getName() - Method in class org.springframework.ai.model.function.FunctionInvokingFunctionCallback
Deprecated.
 
getName() - Method in interface org.springframework.ai.model.function.FunctionCallback
Deprecated.
 
getName() - Method in record class org.springframework.ai.model.function.FunctionCallingHelper.FunctionDefinition
Deprecated.
 
getName() - Method in class org.springframework.ai.model.function.MethodInvokingFunctionCallback
Deprecated.
 
getName() - Method in class org.springframework.ai.model.Media
 
getName() - Method in interface org.springframework.ai.model.ModelDescription
Returns the name of the model.
getName() - Method in interface org.springframework.ai.tool.ToolCallback
Deprecated.
getName() - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention
 
getName() - Method in interface org.springframework.ai.vectorstore.VectorStore
 
getNamespace() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
getNativeClient() - Method in interface org.springframework.ai.vectorstore.VectorStore
Returns the native client if available in this vector store implementation.
getNativeUsage() - Method in class org.springframework.ai.chat.metadata.DefaultUsage
 
getNativeUsage() - Method in class org.springframework.ai.chat.metadata.EmptyUsage
 
getNativeUsage() - Method in interface org.springframework.ai.chat.metadata.Usage
Return the usage data from the underlying model API response.
getNativeUsage() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage
 
getObjectMapper() - Method in class org.springframework.ai.converter.BeanOutputConverter
Configures and returns an object mapper for JSON operations.
getObjectMapper() - Method in class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
 
getObjectMapper() - Static method in class org.springframework.ai.util.json.JsonParser
Returns a Jackson ObjectMapper instance tailored for JSON-parsing operations for tool calling and structured output.
getObservationRegistry() - Method in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder
 
getOperationMetadata() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext
 
getOperationMetadata() - Method in class org.springframework.ai.model.observation.ModelObservationContext
 
getOperationName() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
getOperationType() - Method in class org.springframework.ai.image.observation.ImageModelObservationContext
 
getOptions() - Method in class org.springframework.ai.audio.transcription.AudioTranscriptionPrompt
 
getOptions() - Method in class org.springframework.ai.chat.prompt.Prompt
 
getOptions() - Method in class org.springframework.ai.embedding.DocumentEmbeddingRequest
 
getOptions() - Method in class org.springframework.ai.embedding.EmbeddingRequest
 
getOptions() - Method in class org.springframework.ai.image.ImagePrompt
 
getOptions() - Method in interface org.springframework.ai.model.ModelRequest
Retrieves the customizable options for AI model interactions.
getOptions() - Method in class org.springframework.ai.moderation.ModerationPrompt
 
getOrDefault(Object, T) - Method in class org.springframework.ai.model.AbstractResponseMetadata
Returns an element or default if not present.
getOrDefault(Object, T) - Method in class org.springframework.ai.model.MutableResponseMetadata
Returns an element or default if not present.
getOrDefault(Object, T) - Method in interface org.springframework.ai.model.ResponseMetadata
Returns an element or default if not present.
getOrDefault(String, Supplier<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.client.advisor.AbstractChatMemoryAdvisor
 
getOrder() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
The order of the advisor in the advisor chain.
getOrder() - Method in class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor
 
getOrder() - Method in class org.springframework.ai.chat.client.advisor.RetrievalAugmentationAdvisor
 
getOrder() - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor
 
getOrder() - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
 
getOutput() - Method in class org.springframework.ai.audio.transcription.AudioTranscription
 
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
 
getParams() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec
 
getPresencePenalty() - Method in interface org.springframework.ai.chat.prompt.ChatOptions
Returns the presence penalty to use for the chat.
getPresencePenalty() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
getPresencePenalty() - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
getPresencePenalty() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
getPromptIndex() - Method in interface org.springframework.ai.chat.metadata.PromptMetadata.PromptFilterMetadata
Index of the prompt filter metadata contained in the AI response.
getPromptMetadata() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata
Returns the prompt metadata gathered by the AI during request processing.
getPromptTokens() - Method in class org.springframework.ai.chat.metadata.DefaultUsage
 
getPromptTokens() - Method in class org.springframework.ai.chat.metadata.EmptyUsage
 
getPromptTokens() - Method in interface org.springframework.ai.chat.metadata.Usage
Returns the number of tokens used in the prompt of the AI request.
getPromptTokens() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage
 
getProxyToolCalls() - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
getProxyToolCalls() - Method in interface org.springframework.ai.model.function.FunctionCallingOptions
Deprecated.
 
getProxyToolCalls() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
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
 
getRateLimit() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata
Returns AI provider specific metadata on rate limits.
getRawMap() - Method in class org.springframework.ai.model.MutableResponseMetadata
 
getRequest() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext
 
getRequest() - Method in class org.springframework.ai.model.observation.ModelObservationContext
 
getRequestOptions() - Method in class org.springframework.ai.chat.observation.ChatModelObservationContext
Deprecated, for removal: This API element is subject to removal in a future version.
Use {@link #getRequest().getOptions()} instead.
getRequestOptions() - Method in class org.springframework.ai.embedding.observation.EmbeddingModelObservationContext
Deprecated, for removal: This API element is subject to removal in a future version.
Use {@link #getRequest().getOptions()} instead.
getRequestOptions() - Method in class org.springframework.ai.image.observation.ImageModelObservationContext
Deprecated, for removal: This API element is subject to removal in a future version.
Use {@link #getRequest().getOptions()} instead.
getRequestsLimit() - Method in class org.springframework.ai.chat.metadata.EmptyRateLimit
 
getRequestsLimit() - Method in interface org.springframework.ai.chat.metadata.RateLimit
Returns the maximum number of requests that are permitted before exhausting the rate limit.
getRequestsRemaining() - Method in class org.springframework.ai.chat.metadata.EmptyRateLimit
 
getRequestsRemaining() - Method in interface org.springframework.ai.chat.metadata.RateLimit
Returns the remaining number of requests that are permitted before exhausting the rate limit.
getRequestsReset() - Method in class org.springframework.ai.chat.metadata.EmptyRateLimit
 
getRequestsReset() - Method in interface org.springframework.ai.chat.metadata.RateLimit
Returns the time until the rate limit (based on requests) resets to its initial state.
getRequired(Object) - Method in class org.springframework.ai.model.AbstractResponseMetadata
Gets an entry from the context.
getRequired(Object) - Method in class org.springframework.ai.model.MutableResponseMetadata
Gets an entry from the context.
getRequired(Object) - Method in interface org.springframework.ai.model.ResponseMetadata
Gets an entry from the context.
getResourceIdentifier(Resource) - Method in class org.springframework.ai.reader.TextReader
 
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
 
getResponseConverter() - Method in class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
 
getResponseFormat() - Method in interface org.springframework.ai.image.ImageOptions
 
getResponses() - Method in class org.springframework.ai.chat.messages.ToolResponseMessage
 
getResult() - Method in class org.springframework.ai.audio.transcription.AudioTranscriptionResponse
 
getResult() - Method in class org.springframework.ai.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 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.chat.model.ChatResponse
getResults() - Method in class org.springframework.ai.embedding.EmbeddingResponse
 
getResults() - Method in class org.springframework.ai.image.ImageResponse
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
 
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
 
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.RetrievalAugmentationAdvisor
 
getSchemaType() - Method in class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
 
getSchemaType() - Method in class org.springframework.ai.tool.resolution.SpringBeanToolCallbackResolver
 
getScore() - Method in class org.springframework.ai.document.Document
 
getScore() - Method in class org.springframework.ai.evaluation.EvaluationResponse
 
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
 
getSexual() - Method in class org.springframework.ai.moderation.CategoryScores
 
getSexualMinors() - Method in class org.springframework.ai.moderation.CategoryScores
 
getSimilarityMetric() - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
getSimilarityThreshold() - Method in class org.springframework.ai.vectorstore.SearchRequest
 
getStopSequences() - Method in interface org.springframework.ai.chat.prompt.ChatOptions
Returns the stop sequences to use for the chat.
getStopSequences() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
getStopSequences() - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
getStopSequences() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
getStyle() - Method in interface org.springframework.ai.image.ImageOptions
 
getSystemParams() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
getSystemText() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
getTemperature() - Method in interface org.springframework.ai.chat.prompt.ChatOptions
Returns the temperature to use for the chat.
getTemperature() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
getTemperature() - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
getTemperature() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
getTemplate() - Method in class org.springframework.ai.chat.prompt.PromptTemplate
 
getTemplateFormat() - Method in class org.springframework.ai.chat.prompt.PromptTemplate
 
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.SystemMessage
 
getText() - Method in class org.springframework.ai.chat.messages.UserMessage
 
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 interface org.springframework.ai.model.Content
Get the content of the message.
getText() - Method in class org.springframework.ai.moderation.ModerationMessage
 
getText() - Method in class org.springframework.ai.vectorstore.SimpleVectorStoreContent
 
getText(String) - Static method in class org.springframework.ai.ResourceUtils
Retrieves the content of a resource as a UTF-8 encoded string.
getTextTemplate() - Method in class org.springframework.ai.document.DefaultContentFormatter
 
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.chat.metadata.EmptyRateLimit
 
getTokensLimit() - Method in interface org.springframework.ai.chat.metadata.RateLimit
Returns the maximum number of tokens that are permitted before exhausting the rate limit.
getTokensRemaining() - Method in class org.springframework.ai.chat.metadata.EmptyRateLimit
 
getTokensRemaining() - Method in interface org.springframework.ai.chat.metadata.RateLimit
Returns the remaining number of tokens that are permitted before exhausting the rate limit.
getTokensReset() - Method in class org.springframework.ai.chat.metadata.EmptyRateLimit
 
getTokensReset() - Method in interface org.springframework.ai.chat.metadata.RateLimit
Returns the time until the rate limit (based on tokens) resets to its initial state.
getToolCallbacks() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
getToolCallbacks() - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions
ToolCallbacks to be registered with the ChatModel.
getToolCallbacks() - Method in class org.springframework.ai.tool.method.MethodToolCallbackProvider
 
getToolCallbacks() - Method in class org.springframework.ai.tool.StaticToolCallbackProvider
Returns the array of function callbacks held by this provider.
getToolCallbacks() - Method in interface org.springframework.ai.tool.ToolCallbackProvider
 
getToolCallHistory() - Method in class org.springframework.ai.chat.model.ToolContext
Returns the tool call history from the context map.
getToolCallResultConverter(Method) - Static method in class org.springframework.ai.tool.util.ToolUtils
 
getToolCalls() - Method in class org.springframework.ai.chat.messages.AssistantMessage
 
getToolContext() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
getToolContext() - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
getToolContext() - Method in interface org.springframework.ai.model.function.FunctionCallingOptions
Deprecated.
 
getToolContext() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
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 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.util.ToolUtils
 
getToolDescriptionFromName(String) - Static method in class org.springframework.ai.tool.util.ToolUtils
 
getToolMetadata() - Method in class org.springframework.ai.tool.function.FunctionToolCallback
 
getToolMetadata() - Method in class org.springframework.ai.tool.method.MethodToolCallback
 
getToolMetadata() - Method in interface org.springframework.ai.tool.ToolCallback
Metadata providing additional information on how to handle the tool.
getToolName(Method) - Static method in class org.springframework.ai.tool.util.ToolUtils
 
getToolNames() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
getToolNames() - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions
Names of the tools to register with the ChatModel.
getToolReturnDirect(Method) - Static method in class org.springframework.ai.tool.util.ToolUtils
 
getTopK() - Method in interface org.springframework.ai.chat.prompt.ChatOptions
Returns the top K to use for the chat.
getTopK() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
getTopK() - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
getTopK() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
getTopK() - Method in class org.springframework.ai.vectorstore.SearchRequest
 
getTopP() - Method in interface org.springframework.ai.chat.prompt.ChatOptions
Returns the top P to use for the chat.
getTopP() - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
getTopP() - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
getTopP() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
getTotalTokens() - Method in class org.springframework.ai.chat.metadata.DefaultUsage
 
getTotalTokens() - Method in interface org.springframework.ai.chat.metadata.Usage
Return the total number of tokens from both the prompt of an AI request and generation of the AI's response.
getTotalTokens() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage
 
getUrl() - Method in class org.springframework.ai.image.Image
 
getUsage() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata
Returns AI provider specific metadata on API usage.
getUsage() - Method in class org.springframework.ai.embedding.EmbeddingResponseMetadata
The AI provider specific metadata on API usage.
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.chat.messages.MessageType
 
getValue() - Method in enum class org.springframework.ai.chat.prompt.TemplateFormat
 
getValue() - Method in interface org.springframework.ai.model.ApiKey
Returns an api key to use for a making request.
getValue() - Method in class org.springframework.ai.model.NoopApiKey
 
getValue() - Method in record class org.springframework.ai.model.SimpleApiKey
 
getVersion() - Method in interface org.springframework.ai.model.ModelDescription
Returns the version of the model.
getViolence() - Method in class org.springframework.ai.moderation.CategoryScores
 
getViolenceGraphic() - Method in class org.springframework.ai.moderation.CategoryScores
 
getVocabulary() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer
 
getVocabulary() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser
 
getWeight() - Method in class org.springframework.ai.image.ImageMessage
 
getWidth() - Method in interface org.springframework.ai.image.ImageOptions
 
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.
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

HANA - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by HANA.
handleToolCalls(Prompt, ChatResponse) - Method in class org.springframework.ai.chat.model.AbstractToolCallSupport
Deprecated.
handleToolCalls(Prompt, ChatResponse) - Method in class org.springframework.ai.model.function.FunctionCallingHelper
Deprecated.
 
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
 
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.
hashCode() - Method in class org.springframework.ai.audio.transcription.AudioTranscription
 
hashCode() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedResponse
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 class org.springframework.ai.chat.messages.AbstractMessage
 
hashCode() - Method in class org.springframework.ai.chat.messages.AssistantMessage
 
hashCode() - Method in record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall
Returns a hash code value for this object.
hashCode() - Method in class org.springframework.ai.chat.messages.SystemMessage
 
hashCode() - Method in class org.springframework.ai.chat.messages.ToolResponseMessage
 
hashCode() - Method in record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse
Returns a hash code value for this object.
hashCode() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata
 
hashCode() - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
 
hashCode() - Method in class org.springframework.ai.chat.metadata.DefaultUsage
 
hashCode() - Method in class org.springframework.ai.chat.model.ChatResponse
 
hashCode() - Method in class org.springframework.ai.chat.model.Generation
 
hashCode() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage
Returns a hash code value for this object.
hashCode() - Method in class org.springframework.ai.chat.prompt.Prompt
 
hashCode() - Method in class org.springframework.ai.document.Document
 
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.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 class org.springframework.ai.model.function.FunctionInvokingFunctionCallback
Deprecated.
 
hashCode() - Method in record class org.springframework.ai.model.function.FunctionCallingHelper.FunctionDefinition
Deprecated.
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 record class org.springframework.ai.model.tool.DefaultToolExecutionResult
Returns a hash code value for this object.
hashCode() - Method in class org.springframework.ai.moderation.Categories
 
hashCode() - Method in class org.springframework.ai.moderation.CategoryScores
 
hashCode() - Method in class org.springframework.ai.moderation.Moderation
 
hashCode() - Method in class org.springframework.ai.moderation.ModerationMessage
 
hashCode() - Method in class org.springframework.ai.moderation.ModerationPrompt
 
hashCode() - Method in class org.springframework.ai.moderation.ModerationResponse
 
hashCode() - Method in class org.springframework.ai.moderation.ModerationResult
 
hashCode() - Method in record class org.springframework.ai.observation.AiOperationMetadata
Returns a hash code value for this object.
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.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.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 class org.springframework.ai.vectorstore.SearchRequest
 
hashCode() - Method in class org.springframework.ai.vectorstore.SimpleVectorStoreContent
 
hasOuterQuotes(String) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter
Check if the given string has outer quotes.
hasToolCalls() - Method in class org.springframework.ai.chat.messages.AssistantMessage
 
hasToolCalls() - Method in class org.springframework.ai.chat.model.ChatResponse
Whether the model has requested the execution of a tool.
hate(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
 
hate(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
 
hateThreatening(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
 
hateThreatening(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
 
height(Integer) - Method in class org.springframework.ai.image.ImageOptionsBuilder
 
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
 

I

id() - Method in record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall
Returns the value of the id record component.
id() - Method in record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse
Returns the value of the id record component.
id(String) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
 
id(String) - Method in class org.springframework.ai.document.Document.Builder
 
id(String) - Method in class org.springframework.ai.model.Media.Builder
Sets the ID for the media object.
id(String) - Method in class org.springframework.ai.moderation.Moderation.Builder
 
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.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.IdentifierContext
 
IDENTIFIER(int) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IdentifierContext
 
IdentifierContext(ParserRuleContext, int) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IdentifierContext
 
idGenerator(IdGenerator) - Method in class org.springframework.ai.document.Document.Builder
 
IdGenerator - Interface in org.springframework.ai.document.id
Interface for generating unique document IDs.
Image - Class in org.springframework.ai.image
 
Image(String, String) - Constructor for class org.springframework.ai.image.Image
 
IMAGE - Enum constant in enum class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityType
 
IMAGE - 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.model.Media.Format
Public constant mime type for image/gif.
IMAGE_JPEG - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for image/jpeg.
IMAGE_MODEL_OPERATION - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation
 
IMAGE_PNG - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for image/png.
IMAGE_WEBP - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for image/webp.
ImageGeneration - Class in org.springframework.ai.image
 
ImageGeneration(Image) - Constructor for class org.springframework.ai.image.ImageGeneration
 
ImageGeneration(Image, ImageGenerationMetadata) - Constructor for class org.springframework.ai.image.ImageGeneration
 
ImageGenerationMetadata - Interface in org.springframework.ai.image
 
ImageMessage - Class in org.springframework.ai.image
 
ImageMessage(String) - Constructor for class org.springframework.ai.image.ImageMessage
 
ImageMessage(String, Float) - Constructor for class org.springframework.ai.image.ImageMessage
 
ImageModel - Interface in org.springframework.ai.image
 
ImageModelObservationContext - Class in org.springframework.ai.image.observation
Context used to store metadata for image model exchanges.
ImageModelObservationContext.Builder - Class in org.springframework.ai.image.observation
 
ImageModelObservationConvention - Interface in org.springframework.ai.image.observation
Interface for an ObservationConvention for image model exchanges.
ImageModelObservationDocumentation - Enum Class in org.springframework.ai.image.observation
Documented conventions for image model observations.
ImageModelObservationDocumentation.Events - Enum Class in org.springframework.ai.image.observation
Events for image model operations.
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.
ImageModelPromptContentObservationFilter - Class in org.springframework.ai.image.observation
An ObservationFilter to include the image prompt content in the observation.
ImageModelPromptContentObservationFilter() - Constructor for class org.springframework.ai.image.observation.ImageModelPromptContentObservationFilter
 
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.
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
 
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
 
includeOriginal(Boolean) - Method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander.Builder
 
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
 
InMemoryChatMemory - Class in org.springframework.ai.chat.memory
The InMemoryChatMemory class is an implementation of the ChatMemory interface that represents an in-memory storage for chat conversation history.
InMemoryChatMemory() - Constructor for class org.springframework.ai.chat.memory.InMemoryChatMemory
 
INPUT - Enum constant in enum class org.springframework.ai.observation.conventions.AiTokenType
Input token.
inputSchema() - Method in record class org.springframework.ai.tool.definition.DefaultToolDefinition
Returns the value of the inputSchema record component.
inputSchema() - Method in interface org.springframework.ai.tool.definition.ToolDefinition
The schema of the parameters used to call the tool.
inputSchema(String) - Method in class org.springframework.ai.tool.definition.DefaultToolDefinition.Builder
 
inputSchema(String) - Method in class org.springframework.ai.tool.function.FunctionToolCallback.Builder
 
inputType(Class<?>) - Method in interface org.springframework.ai.model.function.FunctionCallback.FunctionInvokingSpec
Deprecated.
Function input type.
inputType(Type) - Method in class org.springframework.ai.tool.function.FunctionToolCallback.Builder
 
inputType(ParameterizedTypeReference<?>) - Method in interface org.springframework.ai.model.function.FunctionCallback.FunctionInvokingSpec
Deprecated.
Function input type retaining generic types.
inputType(ParameterizedTypeReference<?>) - Method in class org.springframework.ai.tool.function.FunctionToolCallback.Builder
 
inputTypeSchema - Variable in class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
(Optional) Instead of generating the input type schema from the input type or method argument types, you can provide the schema directly.
inputTypeSchema() - Method in record class org.springframework.ai.model.function.FunctionCallingHelper.FunctionDefinition
Deprecated.
Returns the value of the inputTypeSchema record component.
inputTypeSchema(String) - Method in class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
 
inputTypeSchema(String) - Method in interface org.springframework.ai.model.function.FunctionCallback.CommonCallbackInvokingSpec
Deprecated.
You can provide the Input Type Schema directly.
INSTANCE - Static variable in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.DescriptiveErrorListener
 
instantiateAvailableModules() - Static method in class org.springframework.ai.util.JacksonUtils
Instantiate well-known Jackson modules available in the classpath.
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
 
IntegerConstantContext(FiltersParser.ConstantContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.IntegerConstantContext
 
internalToolExecutionEnabled(Boolean) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
 
internalToolExecutionEnabled(Boolean) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
IS_RUNTIME_CALL - Static variable in class org.springframework.ai.chat.model.AbstractToolCallSupport
Deprecated.
 
isCopyContentFormatter() - Method in class org.springframework.ai.transformer.splitter.TextSplitter
 
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.chat.metadata.UsageUtils
Check if the Usage is empty.
isFlagged() - Method in class org.springframework.ai.moderation.ModerationResult
 
isHarassment() - Method in class org.springframework.ai.moderation.Categories
 
isHarassmentThreatening() - Method in class org.springframework.ai.moderation.Categories
 
isHate() - Method in class org.springframework.ai.moderation.Categories
 
isHateThreatening() - Method in class org.springframework.ai.moderation.Categories
 
isInternalToolExecutionEnabled() - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
isInternalToolExecutionEnabled() - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions
Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
isInternalToolExecutionEnabled(ChatOptions) - Static method in interface org.springframework.ai.model.tool.ToolCallingChatOptions
 
isPass() - Method in class org.springframework.ai.evaluation.EvaluationResponse
 
isProxyToolCalls(Prompt, FunctionCallingOptions) - Method in class org.springframework.ai.chat.model.AbstractToolCallSupport
Deprecated.
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
 
isStream() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext
 
isText() - Method in class org.springframework.ai.document.Document
Determines whether this document contains text or media content.
isToolCall(ChatResponse, Set<String>) - Method in class org.springframework.ai.chat.model.AbstractToolCallSupport
Deprecated.
isToolCall(ChatResponse, Set<String>) - Method in class org.springframework.ai.model.function.FunctionCallingHelper
Deprecated.
 
isToolCall(Generation, Set<String>) - Method in class org.springframework.ai.chat.model.AbstractToolCallSupport
Deprecated.
isViolence() - Method in class org.springframework.ai.moderation.Categories
 
isViolenceGraphic() - Method in class org.springframework.ai.moderation.Categories
 

J

JacksonUtils - Class in org.springframework.ai.util
Utility methods for Jackson.
JacksonUtils() - Constructor for class org.springframework.ai.util.JacksonUtils
 
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
 
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_SCHEMA - Enum constant in enum class org.springframework.ai.model.function.FunctionCallback.SchemaType
Deprecated.
JSON schema
JSON_SCHEMA - Enum constant in enum class org.springframework.ai.util.json.schema.SchemaType
JSON schema.
JsonMetadataGenerator - Interface in org.springframework.ai.reader
 
JsonParser - Class in org.springframework.ai.util.json
Utilities to perform parsing operations between JSON and Java.
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
 
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.
jsonToMap(String) - Static method in class org.springframework.ai.model.ModelOptionsUtils
Converts the given JSON string to a Map of String and Object.
jsonToObject(String, Class<T>) - Static method in class org.springframework.ai.model.ModelOptionsUtils
Converts the given JSON string to an Object of the given type.
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
 
JTokkitTokenCountEstimator(EncodingType) - Constructor for class org.springframework.ai.tokenizer.JTokkitTokenCountEstimator
 

K

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.
keySet() - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata
 
keySet() - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
 
keySet() - Method in class org.springframework.ai.model.AbstractResponseMetadata
 
keySet() - Method in class org.springframework.ai.model.MutableResponseMetadata
 
keySet() - Method in interface org.springframework.ai.model.ResponseMetadata
 
keyValue(String, Object) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
 
KeywordMetadataEnricher - Class in org.springframework.ai.transformer
Keyword extractor that uses generative to extract 'excerpt_keywords' metadata field.
KeywordMetadataEnricher(ChatModel, int) - Constructor for class org.springframework.ai.transformer.KeywordMetadataEnricher
 
KEYWORDS_TEMPLATE - Static variable in class org.springframework.ai.transformer.KeywordMetadataEnricher
 
KnuddelsRuntimeHints - Class in org.springframework.ai.aot
 
KnuddelsRuntimeHints() - Constructor for class org.springframework.ai.aot.KnuddelsRuntimeHints
 
KotlinModule - Class in org.springframework.ai.model
 
KotlinModule() - Constructor for class org.springframework.ai.model.KotlinModule
 

L

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
 
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
 
LegacyToolCallingManager - Class in org.springframework.ai.model.tool
Deprecated.
Only to help moving away from AbstractToolCallSupport. It will be removed in the next milestone.
LegacyToolCallingManager(FunctionCallbackResolver, List<FunctionCallback>) - Constructor for class org.springframework.ai.model.tool.LegacyToolCallingManager
Deprecated.
 
LegacyToolCallingManager.Builder - Class in org.springframework.ai.model.tool
Deprecated.
 
ListOutputConverter - Class in org.springframework.ai.converter
StructuredOutputConverter implementation that uses a DefaultConversionService to convert the LLM output into a List instance.
ListOutputConverter(DefaultConversionService) - Constructor for class org.springframework.ai.converter.ListOutputConverter
 
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.
LoggingMarkers - Class in org.springframework.ai.util
Utility class that provides predefined SLF4J Marker instances used in logging operations within the application.
LoggingMarkers() - Constructor for class org.springframework.ai.util.LoggingMarkers
 
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
 

M

MANHATTAN - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric
The manhattan distance metric.
map - Variable in class org.springframework.ai.model.AbstractResponseMetadata
Metadata map.
map(Observation.Context) - Method in class org.springframework.ai.chat.client.observation.ChatClientInputContentObservationFilter
 
map(Observation.Context) - Method in class org.springframework.ai.chat.observation.ChatModelCompletionObservationFilter
 
map(Observation.Context) - Method in class org.springframework.ai.chat.observation.ChatModelPromptContentObservationFilter
 
map(Observation.Context) - Method in class org.springframework.ai.image.observation.ImageModelPromptContentObservationFilter
 
map(Observation.Context) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreQueryResponseObservationFilter
 
MapOutputConverter - Class in org.springframework.ai.converter
StructuredOutputConverter implementation that uses a pre-configured MappingJackson2MessageConverter to convert the LLM output into a java.util.Map<String, Object> instance.
MapOutputConverter() - Constructor for class org.springframework.ai.converter.MapOutputConverter
 
mapToClass(Map<String, Object>, Class<T>) - Static method in class org.springframework.ai.model.ModelOptionsUtils
Converts the given Map to the given class.
MARIADB - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by MariaDB.
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.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
maxTokens(Integer) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
 
maxTokens(Integer) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
 
maxTokens(Integer) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
 
maxTokenSize - Variable in class org.springframework.ai.chat.client.advisor.LastMaxTokenSizeContentPurger
 
media - Variable in class org.springframework.ai.chat.messages.AssistantMessage
 
media - Variable in class org.springframework.ai.chat.messages.UserMessage
 
media() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns the value of the media record component.
media() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec
 
media(List<Media>) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Set the media.
media(Media) - Method in class org.springframework.ai.document.Document.Builder
Sets the media content of the document.
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(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.model
The Media class represents the data and metadata of a media attachment in a message.
Media(MimeType, URL) - Constructor for class org.springframework.ai.model.Media
Create a new Media instance.
Media(MimeType, Resource) - Constructor for class org.springframework.ai.model.Media
Create a new Media instance.
Media.Builder - Class in org.springframework.ai.model
Builder class for Media.
Media.Format - Class in org.springframework.ai.model
Common media formats.
MediaContent - Interface in org.springframework.ai.model
 
merge(Object, Object, Class<T>) - Static method in class org.springframework.ai.model.ModelOptionsUtils
Merges the source object into the target object and returns an object represented by the given class.
merge(Object, Object, Class<T>, List<String>) - Static method in class org.springframework.ai.model.ModelOptionsUtils
Merges the source object into the target object and returns an object represented by the given class.
merge(ChatOptions) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
mergeBeans(S, T, Class<I>, boolean) - Static method in class org.springframework.ai.model.ModelOptionsUtils
Merges the source object into the target object.
mergeOption(T, T) - Static method in class org.springframework.ai.model.ModelOptionsUtils
Return the runtime value if not empty, or else the default value.
mergeToolCallbacks(List<FunctionCallback>, List<FunctionCallback>) - 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
 
mergeToolNames(Set<String>, Set<String>) - Static method in interface org.springframework.ai.model.tool.ToolCallingChatOptions
 
Message - Interface in org.springframework.ai.chat.messages
The Message interface represents a message that can be sent or received in a chat application.
MESSAGE_TYPE - Static variable in class org.springframework.ai.chat.messages.AbstractMessage
The key for the message type in the metadata.
MessageAggregator - Class in org.springframework.ai.chat.model
Helper that for streaming chat responses, aggregate the chat response messages into a single AssistantMessage.
MessageAggregator() - Constructor for class org.springframework.ai.chat.model.MessageAggregator
 
MessageAggregator.DefaultUsage - Record Class in org.springframework.ai.chat.model
 
MessageChatMemoryAdvisor - Class in org.springframework.ai.chat.client.advisor
Memory is retrieved added as a collection of messages to the prompt
MessageChatMemoryAdvisor(ChatMemory) - Constructor for class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor
 
MessageChatMemoryAdvisor(ChatMemory, String, int) - Constructor for class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor
 
MessageChatMemoryAdvisor(ChatMemory, String, int, int) - Constructor for class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor
 
MessageChatMemoryAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor
 
messages() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns the value of the messages record component.
messages(List<Message>) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Set the messages.
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(Message...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
 
messages(Message...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
messageType - Variable in class org.springframework.ai.chat.messages.AbstractMessage
The message type of the message.
MessageType - Enum Class in org.springframework.ai.chat.messages
Enumeration representing types of Messages in a chat application.
metadata - Variable in class org.springframework.ai.chat.messages.AbstractMessage
Additional options for the message to influence the response, not a generative map.
metadata(String, Object) - Method in class org.springframework.ai.chat.model.ChatResponse.Builder
 
metadata(String, Object) - Method in class org.springframework.ai.document.Document.Builder
 
metadata(String, T) - Method in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata.Builder
Add metadata to the Generation result.
metadata(String, T) - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadataBuilder
 
metadata(Map<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
 
metadata(ChatResponseMetadata) - Method in class org.springframework.ai.chat.model.ChatResponse.Builder
 
METADATA_END_PAGE_NUMBER - Static variable in class org.springframework.ai.writer.FileDocumentWriter
 
METADATA_START_PAGE_NUMBER - Static variable in class org.springframework.ai.writer.FileDocumentWriter
 
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
 
metadataFilter(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention
 
metadataFilter(Map<String, Object>, MetadataMode) - Method in class org.springframework.ai.document.DefaultContentFormatter
Filters the metadata by the configured MetadataMode.
MetadataMode - Enum Class in org.springframework.ai.document
 
method(String, Class<?>...) - Method in class org.springframework.ai.model.function.DefaultFunctionCallbackBuilder
Deprecated.
 
method(String, Class<?>...) - Method in interface org.springframework.ai.model.function.FunctionCallback.Builder
Deprecated.
Builds a Method invoking FunctionCallback instance.
MethodInvokingFunctionCallback - Class in org.springframework.ai.model.function
Deprecated.
in favor of MethodToolCallback.
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
 
MILVUS - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by Milvus.
mimeType(MimeType) - Method in class org.springframework.ai.model.Media.Builder
Sets the MIME type for the media object.
MINIMAX - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
AI system provided by Minimax.
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
 
MISTRAL_AI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
AI system provided by Mistral.
ModalityUtils() - Constructor for class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityUtils
 
model(String) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
 
model(String) - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder
Builds with the model to use for the chat.
model(String) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
 
model(String) - Method in class org.springframework.ai.image.ImageOptionsBuilder
 
model(String) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
model(String) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
 
model(String) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
 
model(String) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
 
model(String) - Method in class org.springframework.ai.moderation.Moderation.Builder
 
model(String) - Method in class org.springframework.ai.moderation.ModerationOptionsBuilder
 
Model<TReq extends ModelRequest<?>,TRes extends ModelResponse<?>> - Interface in org.springframework.ai.model
The Model interface provides a generic API for invoking AI models.
ModelDescription - Interface in org.springframework.ai.model
Describes an AI model's basic characteristics.
ModelObservationContext<REQ,RES> - Class in org.springframework.ai.model.observation
Context used when sending a request to a machine learning model and waiting for a response from the model provider.
ModelObservationContext(REQ, AiOperationMetadata) - Constructor for class org.springframework.ai.model.observation.ModelObservationContext
 
ModelOptions - Interface in org.springframework.ai.model
Interface representing the customizable options for AI model interactions.
ModelOptionsUtils - Class in org.springframework.ai.model
Utility class for manipulating ModelOptions objects.
ModelOptionsUtils() - Constructor for class org.springframework.ai.model.ModelOptionsUtils
 
ModelRequest<T> - Interface in org.springframework.ai.model
Interface representing a request to an AI model.
ModelResponse<T 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.
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
 
Moderation - Class in org.springframework.ai.moderation
The Moderation class represents the result of a moderation process.
Moderation.Builder - Class in org.springframework.ai.moderation
 
ModerationGenerationMetadata - Interface in org.springframework.ai.moderation
An interface that represents metadata associated with the results of a moderation generation process.
ModerationMessage - Class in org.springframework.ai.moderation
Represents a single message intended for moderation, encapsulating the text content.
ModerationMessage(String) - Constructor for class org.springframework.ai.moderation.ModerationMessage
 
ModerationModel - Interface in org.springframework.ai.moderation
The ModerationModel interface defines a generic AI model for moderation.
ModerationOptions - Interface in org.springframework.ai.moderation
Represents the options for moderation.
ModerationOptionsBuilder - Class in org.springframework.ai.moderation
A builder class for creating instances of ModerationOptions.
ModerationPrompt - Class in org.springframework.ai.moderation
Represents a prompt for moderation containing a single message and the options for the moderation model.
ModerationPrompt(String) - Constructor for class org.springframework.ai.moderation.ModerationPrompt
 
ModerationPrompt(String, ModerationOptions) - Constructor for class org.springframework.ai.moderation.ModerationPrompt
 
ModerationPrompt(ModerationMessage, ModerationOptions) - Constructor for class org.springframework.ai.moderation.ModerationPrompt
 
ModerationResponse - Class in org.springframework.ai.moderation
Represents a response from a moderation process, encapsulating the moderation metadata and the generated content.
ModerationResponse(Generation) - Constructor for class org.springframework.ai.moderation.ModerationResponse
 
ModerationResponse(Generation, ModerationResponseMetadata) - Constructor for class org.springframework.ai.moderation.ModerationResponse
 
ModerationResponseMetadata - Class in org.springframework.ai.moderation
Defines the metadata associated with a moderation response, extending a base response interface.
ModerationResponseMetadata() - Constructor for class org.springframework.ai.moderation.ModerationResponseMetadata
 
ModerationResult - Class in org.springframework.ai.moderation
Represents the result of a moderation process, indicating whether content was flagged, the categories of moderation, and detailed scores for each category.
ModerationResult.Builder - Class in org.springframework.ai.moderation
 
MONGODB - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by MongoDB.
MOONSHOT - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
AI system provided by Moonshot.
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
 
MutableResponseMetadata - Class in org.springframework.ai.model
 
MutableResponseMetadata() - Constructor for class org.springframework.ai.model.MutableResponseMetadata
 
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 class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
Return a ChatClient2Builder to create a new ChatClient2 whose settings are replicated from this ChatClientRequest.
mutate() - Method in class org.springframework.ai.chat.client.DefaultChatClient
Return a ChatClient2Builder to create a new ChatClient whose settings are replicated from this ChatClientRequest.
mutate() - Method in class org.springframework.ai.document.Document
 
mutate() - Method in record class org.springframework.ai.rag.Query
 

N

N(Integer) - Method in class org.springframework.ai.image.ImageOptionsBuilder
 
name() - Method in record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall
Returns the value of the name record component.
name() - Method in record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse
Returns the value of the name record component.
name() - Method in record class org.springframework.ai.model.function.FunctionCallingHelper.FunctionDefinition
Deprecated.
Returns the value of the name record component.
name() - Element in annotation interface org.springframework.ai.tool.annotation.Tool
The name of the tool.
name() - Method in record class org.springframework.ai.tool.definition.DefaultToolDefinition
Returns the value of the name record component.
name() - Method in interface org.springframework.ai.tool.definition.ToolDefinition
The tool name.
name(String) - Method in interface org.springframework.ai.model.function.FunctionCallback.MethodInvokingSpec
Deprecated.
Optional function name.
name(String) - Method in class org.springframework.ai.model.Media.Builder
Sets the name for the media object.
name(String) - Method in class org.springframework.ai.tool.definition.DefaultToolDefinition.Builder
 
namespace(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention
 
namespace(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder
 
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(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:
NEO4J - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by Neo4j.
NEXT - Enum constant in enum class org.springframework.ai.transformer.SummaryMetadataEnricher.SummaryType
 
nextAroundCall(AdvisedRequest) - Method in interface org.springframework.ai.chat.client.advisor.api.CallAroundAdvisorChain
Invokes the next Around Advisor in the CallAroundAdvisorChain with the given request.
nextAroundCall(AdvisedRequest) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
 
nextAroundStream(AdvisedRequest) - Method in interface org.springframework.ai.chat.client.advisor.api.StreamAroundAdvisorChain
This method delegates the call to the next StreamAroundAdvisor in the chain and is used for streaming responses.
nextAroundStream(AdvisedRequest) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
 
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
 
NONE - Enum constant in enum class org.springframework.ai.document.MetadataMode
 
NoopApiKey - Class in org.springframework.ai.model
This implementation of ApiKey indicates that no API key should be used, e.g.
NoopApiKey() - Constructor for class org.springframework.ai.model.NoopApiKey
 
norm(float[]) - Static method in class org.springframework.ai.vectorstore.SimpleVectorStore.EmbeddingMath
 
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.NinExpressionContext
 
NOT() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NotExpressionContext
 
NotExpressionContext(FiltersParser.BooleanExpressionContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.NotExpressionContext
 
NULL - Static variable in interface org.springframework.ai.audio.transcription.AudioTranscriptionMetadata
 
NULL - Static variable in interface org.springframework.ai.chat.metadata.ChatGenerationMetadata
 
numberOfQueries(Integer) - Method in class org.springframework.ai.rag.preretrieval.query.expansion.MultiQueryExpander.Builder
 

O

OBJECT_MAPPER - Static variable in class org.springframework.ai.model.ModelOptionsUtils
 
objectMapper - Variable in class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
 
objectMapper(ObjectMapper) - Method in class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
 
objectMapper(ObjectMapper) - Method in interface org.springframework.ai.model.function.FunctionCallback.CommonCallbackInvokingSpec
Deprecated.
Custom object mapper for JSON operations.
objectToMap(Object) - Static method in class org.springframework.ai.model.ModelOptionsUtils
Converts the given object to a Map.
observationRegistry - Variable in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder
 
observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.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.
OCI_GENAI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
AI system provided by Oracle OCI.
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(PromptMetadata.PromptFilterMetadata...) - Static method in interface org.springframework.ai.chat.metadata.PromptMetadata
Factory method used to create a new PromptMetadata composed of an array of PromptMetadata.PromptFilterMetadata.
OLLAMA - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
AI system provided by Ollama.
onError(Observation.Context) - Method in class org.springframework.ai.model.observation.ErrorLoggingObservationHandler
 
ONNX - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
AI system provided by ONNX.
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(VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreQueryResponseObservationHandler
 
Op(Filter.Operand) - Constructor for record class org.springframework.ai.vectorstore.filter.FilterExpressionBuilder.Op
Creates an instance of a Op record class.
OPEN_API_SCHEMA - Enum constant in enum class org.springframework.ai.model.function.FunctionCallback.SchemaType
Deprecated.
Open API schema
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.
OPENSEARCH - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by OpenSearch.
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
 
options - Variable in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
 
options(T) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
 
options(T) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
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.
order - Variable in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor.AbstractBuilder
The order of the advisor.
order(int) - Method in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor.AbstractBuilder
Set the order.
order(int) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder
Set the order of the advisor in the advisor chain.
order(int) - Method in class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor.Builder
 
order(int) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor.Builder
 
order(Integer) - Method in class org.springframework.ai.chat.client.advisor.RetrievalAugmentationAdvisor.Builder
 
OrExpressionContext(FiltersParser.BooleanExpressionContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.OrExpressionContext
 
org.springframework.ai - package org.springframework.ai
 
org.springframework.ai.aot - package org.springframework.ai.aot
 
org.springframework.ai.audio.transcription - package org.springframework.ai.audio.transcription
 
org.springframework.ai.chat - package org.springframework.ai.chat
The org.sf.ai.chat package represents the bounded context for the Chat Model within the AI generative model domain.
org.springframework.ai.chat.client - package org.springframework.ai.chat.client
Chat client.
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.observation - package org.springframework.ai.chat.client.observation
Provides classes for observing chat data.
org.springframework.ai.chat.memory - package org.springframework.ai.chat.memory
 
org.springframework.ai.chat.messages - package org.springframework.ai.chat.messages
 
org.springframework.ai.chat.metadata - package org.springframework.ai.chat.metadata
 
org.springframework.ai.chat.model - package org.springframework.ai.chat.model
 
org.springframework.ai.chat.observation - package org.springframework.ai.chat.observation
Provides the API for chat observations.
org.springframework.ai.chat.prompt - package org.springframework.ai.chat.prompt
 
org.springframework.ai.converter - package org.springframework.ai.converter
 
org.springframework.ai.document - package org.springframework.ai.document
 
org.springframework.ai.document.id - package org.springframework.ai.document.id
 
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.image - package org.springframework.ai.image
 
org.springframework.ai.image.observation - package org.springframework.ai.image.observation
Provides classes for observing image data.
org.springframework.ai.model - package org.springframework.ai.model
Provides a set of interfaces and classes for a generic API designed to interact with various AI models.
org.springframework.ai.model.function - package org.springframework.ai.model.function
 
org.springframework.ai.model.observation - package org.springframework.ai.model.observation
Provides classes for observing model data.
org.springframework.ai.model.tool - package org.springframework.ai.model.tool
 
org.springframework.ai.moderation - package org.springframework.ai.moderation
 
org.springframework.ai.observation - package org.springframework.ai.observation
Provides classes for observing events in the system.
org.springframework.ai.observation.conventions - package org.springframework.ai.observation.conventions
Conventions for observation-based AI.
org.springframework.ai.observation.tracing - package org.springframework.ai.observation.tracing
 
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.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.compression - package org.springframework.ai.rag.postretrieval.compression
RAG Sub-Module: Document Compression.
org.springframework.ai.rag.postretrieval.ranking - package org.springframework.ai.rag.postretrieval.ranking
RAG Sub-Module: Document Ranking.
org.springframework.ai.rag.postretrieval.selection - package org.springframework.ai.rag.postretrieval.selection
RAG Sub-Module: Document Selection.
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 - package org.springframework.ai.rag.retrieval
RAG Module: Information Retrieval.
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.reader - package org.springframework.ai.reader
 
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.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.resolution - package org.springframework.ai.tool.resolution
 
org.springframework.ai.tool.util - package org.springframework.ai.tool.util
 
org.springframework.ai.transformer - package org.springframework.ai.transformer
 
org.springframework.ai.transformer.splitter - package org.springframework.ai.transformer.splitter
 
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.vectorstore - package org.springframework.ai.vectorstore
 
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.observation - package org.springframework.ai.vectorstore.observation
Provides classes for observing and storing vector data.
org.springframework.ai.writer - package org.springframework.ai.writer
 
OUTPUT - Enum constant in enum class org.springframework.ai.observation.conventions.AiTokenType
Output token.
overrideLineSeparator(String) - Method in class org.springframework.ai.reader.ExtractedTextFormatter.Builder
Set the line separator to use when formatting the text.

P

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
 
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
 
parse(String) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser
 
ParsingUtils - Class in org.springframework.ai.util
Utility methods for String parsing.
PG_VECTOR - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by PGVector.
PINECONE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by Pinecone.
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
 
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
 
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.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
presencePenalty(Double) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
 
presencePenalty(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
 
presencePenalty(Double) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
 
PREVIOUS - Enum constant in enum class org.springframework.ai.transformer.SummaryMetadataEnricher.SummaryType
 
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
 
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.
processCall(ChatModel, Prompt, Set<String>, Function<AssistantMessage.ToolCall, String>) - Method in class org.springframework.ai.model.function.FunctionCallingHelper
Deprecated.
 
processStream(ChatModel, Prompt, Set<String>, Function<AssistantMessage.ToolCall, String>) - Method in class org.springframework.ai.model.function.FunctionCallingHelper
Deprecated.
 
prompt() - Method in interface org.springframework.ai.chat.client.ChatClient
 
prompt() - Method in class org.springframework.ai.chat.client.DefaultChatClient
 
prompt(String) - Method in interface org.springframework.ai.chat.client.ChatClient
 
prompt(String) - Method in class org.springframework.ai.chat.client.DefaultChatClient
 
prompt(ChatModelObservationContext) - Static method in class org.springframework.ai.chat.observation.ChatModelObservationContentProcessor
 
prompt(Prompt) - Method in interface org.springframework.ai.chat.client.ChatClient
 
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 - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames
The full prompt sent to the model.
PROMPT - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames
The full prompt sent to the model.
PROMPT - Enum constant in enum class org.springframework.ai.observation.conventions.AiObservationAttributes
The full prompt sent to the model.
PromptAssert - Class in org.springframework.ai.util
Assertion utility class that assists in validating arguments for prompt-related operations.
PromptChatMemoryAdvisor - Class in org.springframework.ai.chat.client.advisor
Memory is retrieved added into the prompt's system text.
PromptChatMemoryAdvisor(ChatMemory) - Constructor for class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor
 
PromptChatMemoryAdvisor(ChatMemory, String) - Constructor for class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor
 
PromptChatMemoryAdvisor(ChatMemory, String, int, String) - Constructor for class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor
 
PromptChatMemoryAdvisor(ChatMemory, String, int, String, int) - Constructor for class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor
 
PromptChatMemoryAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor
 
promptMetadata(PromptMetadata) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
 
PromptMetadata - Interface in org.springframework.ai.chat.metadata
Abstract Data Type (ADT) modeling metadata gathered by the AI during request processing.
PromptMetadata.PromptFilterMetadata - Interface in org.springframework.ai.chat.metadata
Abstract Data Type (ADT) modeling filter metadata for all prompts sent during an AI request.
promptTemplate(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
 
PromptTemplate(String) - Constructor for class org.springframework.ai.chat.prompt.PromptTemplate
 
PromptTemplate(String, Map<String, Object>) - Constructor for class org.springframework.ai.chat.prompt.PromptTemplate
 
PromptTemplate(Resource) - Constructor for class org.springframework.ai.chat.prompt.PromptTemplate
 
PromptTemplate(Resource, Map<String, Object>) - Constructor for class org.springframework.ai.chat.prompt.PromptTemplate
 
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.
PROPERTY_REQUIRED_FALSE_BY_DEFAULT - Enum constant in enum class org.springframework.ai.util.json.schema.SpringAiSchemaModule.Option
Properties are only required if marked as such via one of the supported annotations.
protectFromBlocking - Variable in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor.AbstractBuilder
Whether to protect from blocking.
protectFromBlocking(boolean) - Method in class org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor.AbstractBuilder
Set whether to protect from blocking.
protectFromBlocking(boolean) - Method in class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor.Builder
 
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.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.
proxyToolCalls(Boolean) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
proxyToolCalls(Boolean) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
Boolean flag to indicate if the proxy ToolCalls is enabled.
proxyToolCalls(Boolean) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
Deprecated.
proxyToolCalls(Boolean) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
Deprecated.
PUBLIC_DATA_MARKER - Static variable in class org.springframework.ai.util.LoggingMarkers
Marker used to identify log statements associated with public data, such as: Public documentation Marketing materials etc. There are no restriction for logging such information.
purgeExcess(List<MediaContent>, int) - Method in class org.springframework.ai.chat.client.advisor.LastMaxTokenSizeContentPurger
 
push(Advisor) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder
 
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 Qdrand.
QIANFAN - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
AI system provided by Qianfan.
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.chat.client.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.
queryContent(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention
 
queryExpander(QueryExpander) - Method in class org.springframework.ai.chat.client.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
 
queryResponse(List<Document>) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext.Builder
 
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.chat.client.advisor.RetrievalAugmentationAdvisor.Builder
 
queryTransformers(QueryTransformer...) - Method in class org.springframework.ai.chat.client.advisor.RetrievalAugmentationAdvisor.Builder
 
QuestionAnswerAdvisor - Class in org.springframework.ai.chat.client.advisor
Context for the question is retrieved from a Vector Store and added to the prompt's user text.
QuestionAnswerAdvisor(VectorStore) - Constructor for class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor
The QuestionAnswerAdvisor retrieves context information from a Vector Store and combines it with the user's text.
QuestionAnswerAdvisor(VectorStore, SearchRequest) - Constructor for class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor
The QuestionAnswerAdvisor retrieves context information from a Vector Store and combines it with the user's text.
QuestionAnswerAdvisor(VectorStore, SearchRequest, String) - Constructor for class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor
The QuestionAnswerAdvisor retrieves context information from a Vector Store and combines it with the user's text.
QuestionAnswerAdvisor(VectorStore, SearchRequest, String, boolean) - Constructor for class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor
The QuestionAnswerAdvisor retrieves context information from a Vector Store and combines it with the user's text.
QuestionAnswerAdvisor(VectorStore, SearchRequest, String, boolean, int) - Constructor for class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor
The QuestionAnswerAdvisor retrieves context information from a Vector Store and combines it with the user's text.
QuestionAnswerAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor
 
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.IdentifierContext
 
QUOTED_STRING() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.TextConstantContext
 
QUOTED_STRING(int) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.TextConstantContext
 

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
 
rank(Query, List<Document>) - Method in interface org.springframework.ai.rag.postretrieval.ranking.DocumentRanker
Ranks documents based on their relevance to the given query.
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.
read() - Method in interface org.springframework.ai.document.DocumentReader
 
reConcatenateCamelCase(String, String) - Static method in class org.springframework.ai.util.ParsingUtils
Reconcatenates the given camel-case source String using the given delimiter.
REDIS - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by Redis.
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
 
REGULATED_DATA_MARKER - Static variable in class org.springframework.ai.util.LoggingMarkers
Marker used to identify log statements associated with regulated data, such as: PCI (credit card data) PHI (health information) PII (personally identifiable info) Financial records Compliance-controlled data etc. Logging of such information should be avoided.
RelevancyEvaluator - Class in org.springframework.ai.evaluation
 
RelevancyEvaluator(ChatClient.Builder) - Constructor for class org.springframework.ai.evaluation.RelevancyEvaluator
 
remove(Object) - Method in class org.springframework.ai.model.MutableResponseMetadata
Removes an entry from the context.
removeOuterQuotes(String) - Method in class org.springframework.ai.vectorstore.filter.converter.AbstractFilterExpressionConverter
Remove the outer quotes from the given string.
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
 
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_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.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_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_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.
requestEmbeddingDimension(KeyValues, EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
 
requestFrequencyPenalty(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
requestImageFormat(KeyValues, ImageModelObservationContext) - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
 
requestImageSize(KeyValues, ImageModelObservationContext) - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
 
requestImageStyle(KeyValues, ImageModelObservationContext) - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
 
requestMaxTokens(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
requestModel(ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
requestModel(EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
 
requestModel(ImageModelObservationContext) - Method in class org.springframework.ai.image.observation.DefaultImageModelObservationConvention
 
requestOptions(ChatOptions) - Method in class org.springframework.ai.chat.observation.ChatModelObservationContext.Builder
Deprecated, for removal: This API element is subject to removal in a future version.
ChatOptions are passed in the Prompt object and should not be set separately anymore.
requestOptions(EmbeddingOptions) - Method in class org.springframework.ai.embedding.observation.EmbeddingModelObservationContext.Builder
Deprecated, for removal: This API element is subject to removal in a future version.
EmbeddingOptions are passed in the EmbeddingRequest object and should not be set separately anymore.
requestOptions(ImageOptions) - Method in class org.springframework.ai.image.observation.ImageModelObservationContext.Builder
Deprecated, for removal: This API element is subject to removal in a future version.
ImageOptions are passed in the ImagePrompt object and should not be set separately anymore.
requestPresencePenalty(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
requestStopSequences(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
requestTemperature(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
requestTopK(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
requestTopP(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
required() - Element in annotation interface org.springframework.ai.tool.annotation.ToolParam
Whether the tool argument is required.
resolve(String) - Method in class org.springframework.ai.model.function.DefaultFunctionCallbackResolver
Deprecated.
 
resolve(String) - Method in interface org.springframework.ai.model.function.FunctionCallbackResolver
Deprecated.
Resolve the FunctionCallback instance by its name.
resolve(String) - Method in class org.springframework.ai.tool.resolution.DelegatingToolCallbackResolver
 
resolve(String) - Method in class org.springframework.ai.tool.resolution.SpringBeanToolCallbackResolver
 
resolve(String) - Method in class org.springframework.ai.tool.resolution.StaticToolCallbackResolver
 
resolve(String) - Method in interface org.springframework.ai.tool.resolution.ToolCallbackResolver
Resolve the FunctionCallback for the given tool name.
resolveBeanType(GenericApplicationContext, String) - Static method in class org.springframework.ai.tool.resolution.TypeResolverHelper
Resolve bean type, either directly with BeanDefinition.getResolvableType() or by resolving the factory method (duplicating ConstructorResolver#resolveFactoryMethodIfPossible logic as it is not public).
resolveFunctionCallbacks(Set<String>) - Method in class org.springframework.ai.chat.model.AbstractToolCallSupport
Deprecated.
resolveToolDefinitions(ToolCallingChatOptions) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager
 
resolveToolDefinitions(ToolCallingChatOptions) - Method in class org.springframework.ai.model.tool.LegacyToolCallingManager
Deprecated.
 
resolveToolDefinitions(ToolCallingChatOptions) - Method in interface org.springframework.ai.model.tool.ToolCallingManager
Resolve the tool definitions from the model's tool calling options.
ResourceUtils - Class in org.springframework.ai
Miscellaneous Resource utility methods.
ResourceUtils() - Constructor for class org.springframework.ai.ResourceUtils
 
response() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedResponse
Returns the value of the response record component.
response() - Method in record class org.springframework.ai.chat.client.ResponseEntity
Returns the value of the response record component.
response(ChatResponse) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedResponse.Builder
Set the chat response.
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.
responseConverter - Variable in class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
The function to convert the response object to a string.
responseConverter(Function<Object, String>) - Method in class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
 
responseConverter(Function<Object, String>) - Method in interface org.springframework.ai.model.function.FunctionCallback.CommonCallbackInvokingSpec
Deprecated.
Function response converter.
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
 
responseEntity(Class<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
 
responseEntity(StructuredOutputConverter<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec
 
responseEntity(StructuredOutputConverter<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
 
responseEntity(ParameterizedTypeReference<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec
 
responseEntity(ParameterizedTypeReference<T>) - 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 withe 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.
responseFinishReasons(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
responseFormat(String) - Method in class org.springframework.ai.image.ImageOptionsBuilder
 
responseId(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
ResponseMetadata - Interface in org.springframework.ai.model
Interface representing metadata associated with an AI model's response.
responseModel(ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
responseModel(EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
 
responses - Variable in class org.springframework.ai.chat.messages.ToolResponseMessage
 
RESTRICTED_DATA_MARKER - Static variable in class org.springframework.ai.util.LoggingMarkers
Marker used to identify log statements associated with restricted data, such as: Authentication credentials Keys and secrets Core intellectual property Critical security configs Trade secrets etc. Logging of such information is usually prohibited in any circumstances.
resultConverter() - Element in annotation interface org.springframework.ai.tool.annotation.Tool
The class to use to convert the tool call result to a String.
ResultMetadata - Interface in org.springframework.ai.model
Interface representing metadata associated with the results of an AI model.
results(List<ModerationResult>) - Method in class org.springframework.ai.moderation.Moderation.Builder
 
RetrievalAugmentationAdvisor - Class in org.springframework.ai.chat.client.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(List<QueryTransformer>, QueryExpander, DocumentRetriever, DocumentJoiner, QueryAugmenter, TaskExecutor, Scheduler, Integer) - Constructor for class org.springframework.ai.chat.client.advisor.RetrievalAugmentationAdvisor
 
RetrievalAugmentationAdvisor.Builder - Class in org.springframework.ai.chat.client.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.QuestionAnswerAdvisor
 
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
 
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
 
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
 
runtimeFunctionCallbackConfigurations(FunctionCallingOptions) - Method in class org.springframework.ai.chat.model.AbstractToolCallSupport
Deprecated.

S

SafeGuardAdvisor - Class in org.springframework.ai.chat.client.advisor
A CallAroundAdvisor and StreamAroundAdvisor that filters out the response 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
 
save(File) - Method in class org.springframework.ai.vectorstore.SimpleVectorStore
Serialize the vector store content into a file in JSON format.
scheduler(Scheduler) - Method in class org.springframework.ai.chat.client.advisor.RetrievalAugmentationAdvisor.Builder
 
schemaType - Variable in class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
The schema type to use for the input type schema generation.
schemaType(FunctionCallback.SchemaType) - Method in class org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec
Deprecated.
 
schemaType(FunctionCallback.SchemaType) - Method in interface org.springframework.ai.model.function.FunctionCallback.CommonCallbackInvokingSpec
Deprecated.
Specifies what FunctionCallback.SchemaType is used by the AI model to validate the function input arguments.
schemaType(SchemaType) - Method in class org.springframework.ai.tool.resolution.SpringBeanToolCallbackResolver.Builder
 
SchemaType - Enum Class in org.springframework.ai.util.json.schema
The type of schema to generate for a given Java type.
score(Double) - Method in class org.springframework.ai.document.Document.Builder
Sets a score value for this document.
searchRequest(SearchRequest) - Method in class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor.Builder
 
SearchRequest - Class in org.springframework.ai.vectorstore
Similarity search request.
SearchRequest() - Constructor for class org.springframework.ai.vectorstore.SearchRequest
 
SearchRequest.Builder - Class in org.springframework.ai.vectorstore
SearchRequest Builder.
select(Query, List<Document>) - Method in interface org.springframework.ai.rag.postretrieval.selection.DocumentSelector
Removes irrelevant or redundant documents from a list of retrieved documents.
self() - Method in class org.springframework.ai.vectorstore.AbstractVectorStoreBuilder
Returns this builder cast to the concrete builder type.
selfHarm(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
 
selfHarm(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
 
selfHarmInstructions(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
 
selfHarmInstructions(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
 
selfHarmIntent(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
 
selfHarmIntent(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
 
sempred(RuleContext, int, int) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser
 
SENSITIVE_DATA_MARKER - Static variable in class org.springframework.ai.util.LoggingMarkers
Marker used to identify log statements associated with sensitive data, such as: Internal business information Employee data Customer non-regulated data Business processes and logic etc. Typically, logging this information should be avoided.
sensitiveWords(List<String>) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor.Builder
 
setAdvisedRequest(AdvisedRequest) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
Set the AdvisedRequest data to be advised.
setAdvisorRequestContext(Map<String, Object>) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
Set the shared data between the advisors in the chain.
setAdvisorResponseContext(Map<String, Object>) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
Set the shared data between the advisors in the chain.
setApplicationContext(ApplicationContext) - Method in class org.springframework.ai.model.function.DefaultFunctionCallbackResolver
Deprecated.
 
setB64Json(String) - Method in class org.springframework.ai.image.Image
 
setCategories(Categories) - Method in class org.springframework.ai.moderation.ModerationResult
 
setCategoryScores(CategoryScores) - Method in class org.springframework.ai.moderation.ModerationResult
 
setCharset(Charset) - Method in class org.springframework.ai.reader.TextReader
 
setCollectionName(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
setContentFormatter(ContentFormatter) - Method in class org.springframework.ai.document.Document
Replace the document's ContentFormatter.
setCopyContentFormatter(boolean) - Method in class org.springframework.ai.transformer.splitter.TextSplitter
 
setDimensions(Integer) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
setFieldName(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
setFlagged(boolean) - Method in class org.springframework.ai.moderation.ModerationResult
 
setFormat(String) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext
 
setFrequencyPenalty(Double) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
setFrequencyPenalty(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setFunctionCallbacks(List<FunctionCallback>) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
setFunctionCallbacks(List<FunctionCallback>) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions
Deprecated.
Set the Function Callbacks to be registered with the ChatModel.
setFunctionCallbacks(List<FunctionCallback>) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setFunctions(Set<String>) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
setFunctions(Set<String>) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions
Deprecated.
Set the list of function names from the ChatModel registry to be used in the next chat completion requests.
setFunctions(Set<String>) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setInternalToolExecutionEnabled(Boolean) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setInternalToolExecutionEnabled(Boolean) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions
Set whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
setMaxTokens(Integer) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
setMaxTokens(Integer) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
setMaxTokens(Integer) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setModel(String) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
setModel(String) - Method in class org.springframework.ai.embedding.EmbeddingResponseMetadata
 
setModel(String) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
setModel(String) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setNamespace(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
setOptions(ModerationOptions) - Method in class org.springframework.ai.moderation.ModerationPrompt
 
setPresencePenalty(Double) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
setPresencePenalty(Double) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
setPresencePenalty(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setProxyToolCalls(Boolean) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
setProxyToolCalls(Boolean) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions
Deprecated.
 
setProxyToolCalls(Boolean) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setQueryRequest(SearchRequest) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
setQueryResponse(List<Document>) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
setResponse(RES) - Method in class org.springframework.ai.model.observation.ModelObservationContext
 
setSchemaType(FunctionCallback.SchemaType) - Method in class org.springframework.ai.model.function.DefaultFunctionCallbackResolver
Deprecated.
 
setSimilarityMetric(String) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreObservationContext
 
setStopSequences(List<String>) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
setStopSequences(List<String>) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
setStopSequences(List<String>) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setTemperature(Double) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
setTemperature(Double) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
setTemperature(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setText(String) - Method in class org.springframework.ai.moderation.ModerationMessage
 
setToolCallbacks(List<FunctionCallback>) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setToolCallbacks(List<FunctionCallback>) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions
Set the ToolCallbacks to be registered with the ChatModel.
setToolContext(Map<String, Object>) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
setToolContext(Map<String, Object>) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions
Deprecated.
 
setToolContext(Map<String, Object>) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setToolNames(Set<String>) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setToolNames(Set<String>) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions
Set the names of the tools to register with the ChatModel.
setTopK(Integer) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
setTopK(Integer) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
setTopK(Integer) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setTopP(Double) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptions
 
setTopP(Double) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptions
Deprecated.
 
setTopP(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions
 
setUrl(String) - Method in class org.springframework.ai.image.Image
 
setUsage(Usage) - Method in class org.springframework.ai.embedding.EmbeddingResponseMetadata
 
sexual(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
 
sexual(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
 
sexualMinors(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
 
sexualMinors(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
 
SIMILARITY_THRESHOLD_ACCEPT_ALL - Static variable in class org.springframework.ai.vectorstore.SearchRequest
Similarity threshold that accepts all search scores.
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(String) - Method in interface org.springframework.ai.vectorstore.VectorStore
Retrieves documents by query embedding similarity using the default SearchRequest's' search criteria.
similaritySearch(SearchRequest) - Method in class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore
 
similaritySearch(SearchRequest) - Method in interface org.springframework.ai.vectorstore.VectorStore
Retrieves documents by query embedding similarity and metadata filters to retrieve exactly the number of nearest-neighbor results that match the request criteria.
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.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.
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<AdvisedRequest, String>, Function<ChatResponse, String>, int) - Constructor for class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
 
SimpleVectorStore - Class in org.springframework.ai.vectorstore
SimpleVectorStore is a simple 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
 
SimpleVectorStoreContent - Class in org.springframework.ai.vectorstore
An immutable Content implementation representing content, metadata, and its embeddings.
SimpleVectorStoreContent(String, float[]) - Constructor for class org.springframework.ai.vectorstore.SimpleVectorStoreContent
Creates a new instance with the given content, empty metadata, and embedding vector.
SimpleVectorStoreContent(String, String, Map<String, Object>, float[]) - Constructor for class org.springframework.ai.vectorstore.SimpleVectorStoreContent
Creates a new instance with all fields specified.
SimpleVectorStoreContent(String, Map<String, Object>, float[]) - Constructor for class org.springframework.ai.vectorstore.SimpleVectorStoreContent
Creates a new instance with the given content, metadata, and embedding vector.
SimpleVectorStoreContent(String, Map<String, Object>, IdGenerator, float[]) - Constructor for class org.springframework.ai.vectorstore.SimpleVectorStoreContent
Creates a new instance with the given content, metadata, custom ID generator, and embedding vector.
SimpleVectorStoreFilterExpressionConverter - Class in org.springframework.ai.vectorstore.filter.converter
Converts Filter.Expression into SpEL metadata filter expression format.
SimpleVectorStoreFilterExpressionConverter() - Constructor for class org.springframework.ai.vectorstore.filter.converter.SimpleVectorStoreFilterExpressionConverter
 
SOURCE_METADATA - Static variable in class org.springframework.ai.reader.TextReader
 
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.vectorstore.observation.VectorStoreObservationDocumentation.LowCardinalityKeyNames
Spring AI kind.
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 - Enum Class in org.springframework.ai.observation.conventions
Types of Spring AI constructs which can be observed.
SpringAiSchemaModule - Class in org.springframework.ai.util.json.schema
JSON Schema Generator Module for Spring AI.
SpringAiSchemaModule(SpringAiSchemaModule.Option...) - Constructor for class org.springframework.ai.util.json.schema.SpringAiSchemaModule
 
SpringAiSchemaModule.Option - Enum Class in org.springframework.ai.util.json.schema
Options for customizing the behavior of the module.
SpringBeanToolCallbackResolver - Class in org.springframework.ai.tool.resolution
A Spring ApplicationContext-based implementation that provides a way to retrieve a bean from the Spring context and wrap it into a ToolCallback.
SpringBeanToolCallbackResolver(GenericApplicationContext, SchemaType) - Constructor for class org.springframework.ai.tool.resolution.SpringBeanToolCallbackResolver
 
SpringBeanToolCallbackResolver.Builder - Class in org.springframework.ai.tool.resolution
 
ST - Enum constant in enum class org.springframework.ai.chat.prompt.TemplateFormat
 
StaticToolCallbackProvider - Class in org.springframework.ai.tool
A simple implementation of ToolCallbackProvider that maintains a static array of FunctionCallback objects.
StaticToolCallbackProvider(List<? extends FunctionCallback>) - Constructor for class org.springframework.ai.tool.StaticToolCallbackProvider
Constructs a new StaticToolCallbackProvider with the specified list of function callbacks.
StaticToolCallbackProvider(FunctionCallback...) - 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<FunctionCallback>) - Constructor for class org.springframework.ai.tool.resolution.StaticToolCallbackResolver
 
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.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
stopSequences(List<String>) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
 
stopSequences(List<String>) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
 
stopSequences(List<String>) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
 
store - Variable in class org.springframework.ai.vectorstore.SimpleVectorStore
 
stream() - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
 
stream() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
stream(String) - Method in interface org.springframework.ai.chat.model.StreamingChatModel
 
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 interface org.springframework.ai.chat.model.ChatModel
 
stream(Prompt) - Method in interface org.springframework.ai.chat.model.StreamingChatModel
 
stream(TReq) - Method in interface org.springframework.ai.model.StreamingModel
Executes a method call to the AI model.
STREAM - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.LowCardinalityKeyNames
Is the chat model response a stream.
StreamAroundAdvisor - Interface in org.springframework.ai.chat.client.advisor.api
Around advisor that runs around stream based requests.
StreamAroundAdvisorChain - Interface in org.springframework.ai.chat.client.advisor.api
The StreamAroundAdvisorChain is used to delegate the call to the next StreamAroundAdvisor in the chain.
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.
StructuredOutputConverter<T> - Interface in org.springframework.ai.converter
Converts the (raw) LLM output into a structured responses of type.
style(String) - Method in class org.springframework.ai.image.ImageOptionsBuilder
 
SummaryMetadataEnricher - Class in org.springframework.ai.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.transformer.SummaryMetadataEnricher
 
SummaryMetadataEnricher(ChatModel, List<SummaryMetadataEnricher.SummaryType>, String, MetadataMode) - Constructor for class org.springframework.ai.transformer.SummaryMetadataEnricher
 
SummaryMetadataEnricher.SummaryType - Enum Class in org.springframework.ai.transformer
 
supportsContext(Observation.Context) - Method in interface org.springframework.ai.chat.client.advisor.observation.AdvisorObservationConvention
 
supportsContext(Observation.Context) - Method in interface org.springframework.ai.chat.client.observation.ChatClientObservationConvention
 
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.model.observation.ErrorLoggingObservationHandler
 
supportsContext(Observation.Context) - Method in interface org.springframework.ai.vectorstore.observation.VectorStoreObservationConvention
 
supportsContext(Observation.Context) - Method in class org.springframework.ai.vectorstore.observation.VectorStoreQueryResponseObservationHandler
 
syntaxError(Recognizer<?, ?>, Object, int, int, String, RecognitionException) - Method in class org.springframework.ai.vectorstore.filter.FilterExpressionTextParser.DescriptiveErrorListener
 
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(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.
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
 
systemParams() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns the value of the systemParams record component.
systemParams(Map<String, Object>) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Set the system params.
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
 
systemText() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns the value of the systemText record component.
systemText(String) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Set the system text.
systemTextAdvise(String) - Method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor.Builder
 
systemTextAdvise(String) - Method in class org.springframework.ai.chat.client.advisor.VectorStoreChatMemoryAdvisor.Builder
 

T

targetClass(Class<?>) - Method in interface org.springframework.ai.model.function.FunctionCallback.MethodInvokingSpec
Deprecated.
Target class where the method is defined.
targetLanguage(String) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.TranslationQueryTransformer.Builder
 
targetObject(Object) - Method in interface org.springframework.ai.model.function.FunctionCallback.MethodInvokingSpec
Deprecated.
For non-static objects the target object is used to invoke the method.
targetSearchSystem(String) - Method in class org.springframework.ai.rag.preretrieval.query.transformation.RewriteQueryTransformer.Builder
 
taskExecutor(TaskExecutor) - Method in class org.springframework.ai.chat.client.advisor.RetrievalAugmentationAdvisor.Builder
 
temperature(Double) - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder
Builds with the temperature to use for the chat.
temperature(Double) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
 
temperature(Double) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
temperature(Double) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
 
temperature(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
 
temperature(Double) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
 
template - Variable in class org.springframework.ai.chat.prompt.PromptTemplate
 
templateFormat - Variable in class org.springframework.ai.chat.prompt.PromptTemplate
 
TemplateFormat - Enum Class in org.springframework.ai.chat.prompt
 
templateHasRequiredPlaceholders(PromptTemplate, String...) - Static method in class org.springframework.ai.util.PromptAssert
Assert that the given prompt template contains the required placeholders.
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.rag.Query
Returns the value of the text record component.
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.document.Document.Builder
Sets the text content of the document.
text(String) - Method in class org.springframework.ai.rag.Query.Builder
 
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, 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.embedding.EmbeddingResultMetadata.ModalityType
 
TEXT_COMPLETION - Enum constant in enum class org.springframework.ai.observation.conventions.AiOperationType
AI operation type for text completion.
TextConstantContext(FiltersParser.ConstantContext) - Constructor for class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.TextConstantContext
 
textContent - Variable in class org.springframework.ai.chat.messages.AbstractMessage
The content of the message.
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
 
TextSplitter - Class in org.springframework.ai.transformer.splitter
 
TextSplitter() - Constructor for class org.springframework.ai.transformer.splitter.TextSplitter
 
toDefaultChatClientRequestSpec(AdvisedRequest, ObservationRegistry, ChatClientObservationConvention) - Static method in class org.springframework.ai.chat.client.DefaultChatClient
 
toDocument(Double) - Method in class org.springframework.ai.vectorstore.SimpleVectorStoreContent
 
toFloatArray(float[]) - Static method in class org.springframework.ai.model.EmbeddingUtils
 
toJavaType(Object, Class<?>) - Method in class org.springframework.ai.model.function.MethodInvokingFunctionCallback
Deprecated.
Converts the given value to the specified Java type.
toJson(Object) - Static method in class org.springframework.ai.util.json.JsonParser
Converts a Java object to a JSON string.
toJsonString(Object) - Static method in class org.springframework.ai.model.ModelOptionsUtils
Converts the given object to a JSON string.
toJsonStringPrettyPrinter(Object) - Static method in class org.springframework.ai.model.ModelOptionsUtils
Converts the given object to a JSON string.
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.
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 - Interface in org.springframework.ai.tokenizer
Estimates the number of tokens in a given text or message.
tokenNames - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer
Deprecated.
tokenNames - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser
Deprecated.
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
 
TokenTextSplitter(boolean) - Constructor for class org.springframework.ai.transformer.splitter.TokenTextSplitter
 
TokenTextSplitter(int, int, int, int, boolean) - Constructor for class org.springframework.ai.transformer.splitter.TokenTextSplitter
 
TokenTextSplitter.Builder - Class in org.springframework.ai.transformer.splitter
 
toList(float[]) - Static method in class org.springframework.ai.model.EmbeddingUtils
 
Tool - Annotation Interface in org.springframework.ai.tool.annotation
Marks a method as a tool in Spring AI.
TOOL - Enum constant in enum class org.springframework.ai.chat.messages.MessageType
A Message of type function passed as input Messages with function content in a chat application.
TOOL_CALL_HISTORY - Static variable in class org.springframework.ai.chat.model.ToolContext
The key for the running, tool call history stored in the context map.
ToolCall(String, String, String, String) - Constructor for record class org.springframework.ai.chat.messages.AssistantMessage.ToolCall
Creates an instance of a ToolCall record class.
ToolCallback - Interface in org.springframework.ai.tool
Represents a tool whose execution can be triggered by an AI model.
ToolCallbackProvider - Interface in org.springframework.ai.tool
Provides ToolCallback instances for tools defined in different sources.
toolCallbackResolver(ToolCallbackResolver) - Method in class org.springframework.ai.model.tool.DefaultToolCallingManager.Builder
 
ToolCallbackResolver - Interface in org.springframework.ai.tool.resolution
A resolver for ToolCallback instances.
toolCallbacks(List<FunctionCallback>) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
 
toolCallbacks(List<FunctionCallback>) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
ToolCallbacks to be registered with the ChatModel.
toolCallbacks(FunctionCallback...) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
 
toolCallbacks(FunctionCallback...) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
ToolCallbacks to be registered with the ChatModel.
ToolCallbacks - Class in org.springframework.ai.tool
Provides ToolCallback instances for tools defined in different sources.
ToolCallingChatOptions - Interface in org.springframework.ai.model.tool
A set of options that can be used to configure the interaction with a chat model, including tool calling.
ToolCallingChatOptions.Builder - Interface in org.springframework.ai.model.tool
A builder to create a ToolCallingChatOptions instance.
ToolCallingManager - Interface in org.springframework.ai.model.tool
Service responsible for managing the tool calling process for a chat model.
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.
toolContext - Variable in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
 
toolContext() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns the value of the toolContext record component.
toolContext(String, Object) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
toolContext(String, Object) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
Add a specific key/value pair to the 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
 
toolContext(Map<String, Object>) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Set 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(Map<String, Object>) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
toolContext(Map<String, Object>) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
Add a Map of context values into tool context.
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
 
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.
toolDefinition(ToolDefinition) - Method in class org.springframework.ai.tool.method.MethodToolCallback.Builder
 
ToolDefinition - Interface in org.springframework.ai.tool.definition
Definition used by the AI model to determine when and how to call the tool.
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.
toolFunctionCallbacks(KeyValues, ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
 
toolFunctionNames(KeyValues, ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
 
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 - Interface in org.springframework.ai.tool.metadata
Metadata about a tool specification and execution.
toolMethod(Method) - Method in class org.springframework.ai.tool.method.MethodToolCallback.Builder
 
toolNames(String...) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
 
toolNames(String...) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
Names of the tools to register with the ChatModel.
toolNames(Set<String>) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
 
toolNames(Set<String>) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
Names of the tools to register with the ChatModel.
toolObject(Object) - Method in class org.springframework.ai.tool.method.MethodToolCallback.Builder
 
toolObjects(Object...) - Method in class org.springframework.ai.tool.method.MethodToolCallbackProvider.Builder
 
ToolParam - Annotation Interface in org.springframework.ai.tool.annotation
Marks a tool argument.
ToolResponse(String, String, String) - Constructor for record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse
Creates an instance of a ToolResponse record class.
ToolResponseMessage - Class in org.springframework.ai.chat.messages
The ToolResponseMessage class represents a message with a function content in a chat application.
ToolResponseMessage(List<ToolResponseMessage.ToolResponse>) - Constructor for class org.springframework.ai.chat.messages.ToolResponseMessage
 
ToolResponseMessage(List<ToolResponseMessage.ToolResponse>, Map<String, Object>) - Constructor for class org.springframework.ai.chat.messages.ToolResponseMessage
 
ToolResponseMessage.ToolResponse - Record Class in org.springframework.ai.chat.messages
 
ToolRuntimeHints - Class in org.springframework.ai.aot
Registers runtime hints for the tool calling APIs.
ToolRuntimeHints() - Constructor for class org.springframework.ai.aot.ToolRuntimeHints
 
tools(Object...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
 
tools(Object...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
tools(String...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
 
tools(String...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
tools(List<ToolCallback>) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
 
tools(List<ToolCallback>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
tools(FunctionCallback...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
 
tools(FunctionCallback...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
tools(ToolCallbackProvider...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
 
tools(ToolCallbackProvider...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
 
ToolUtils - Class in org.springframework.ai.tool.util
Miscellaneous tool utility methods.
topK(int) - Method in class org.springframework.ai.vectorstore.SearchRequest.Builder
 
topK(KeyValues, VectorStoreObservationContext) - Method in class org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention
 
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 class org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
topK(Integer) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
 
topK(Integer) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
 
topK(Integer) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
 
topK(Integer) - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever.Builder
 
topP(Double) - Method in interface org.springframework.ai.chat.prompt.ChatOptions.Builder
Builds with the top P to use for the chat.
topP(Double) - Method in class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
 
topP(Double) - Method in class org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder
Deprecated.
 
topP(Double) - Method in interface org.springframework.ai.model.function.FunctionCallingOptions.Builder
Deprecated.
 
topP(Double) - Method in class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
 
topP(Double) - Method in interface org.springframework.ai.model.tool.ToolCallingChatOptions.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() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
 
toString() - Method in class org.springframework.ai.audio.transcription.AudioTranscription
 
toString() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns a string representation of this record class.
toString() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedResponse
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.ResponseEntity
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 class org.springframework.ai.chat.messages.SystemMessage
 
toString() - Method in record class org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse
Returns a string representation of this record class.
toString() - Method in class org.springframework.ai.chat.messages.ToolResponseMessage
 
toString() - Method in class org.springframework.ai.chat.messages.UserMessage
 
toString() - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata
 
toString() - Method in class org.springframework.ai.chat.metadata.DefaultChatGenerationMetadata
 
toString() - Method in class org.springframework.ai.chat.metadata.DefaultUsage
 
toString() - Method in class org.springframework.ai.chat.model.ChatResponse
 
toString() - Method in class org.springframework.ai.chat.model.Generation
 
toString() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage
Returns a string representation of this record class.
toString() - Method in class org.springframework.ai.chat.prompt.Prompt
 
toString() - Method in class org.springframework.ai.document.Document
 
toString() - Method in enum class org.springframework.ai.document.DocumentMetadata
 
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.image.Image
 
toString() - Method in class org.springframework.ai.image.ImageGeneration
 
toString() - Method in class org.springframework.ai.image.ImageMessage
 
toString() - Method in class org.springframework.ai.image.ImagePrompt
 
toString() - Method in class org.springframework.ai.image.ImageResponse
 
toString() - Method in record class org.springframework.ai.model.function.FunctionCallingHelper.FunctionDefinition
Deprecated.
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 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.rag.Query
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.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 class org.springframework.ai.vectorstore.SearchRequest
 
toString() - Method in class org.springframework.ai.vectorstore.SimpleVectorStoreContent
 
TOTAL - Enum constant in enum class org.springframework.ai.observation.conventions.AiTokenType
Total token.
totalTokens() - Method in record class org.springframework.ai.chat.model.MessageAggregator.DefaultUsage
Returns the value of the totalTokens record component.
toTypedObject(Object, Class<?>) - Static method in class org.springframework.ai.util.json.JsonParser
Convert a Java Object to a typed Object.
toUpperCaseTypeValues(ObjectNode) - Static method in class org.springframework.ai.model.ModelOptionsUtils
 
TracingHelper - Class in org.springframework.ai.observation.tracing
Utilities to prepare and process traces for observability.
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
 
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
 
trimAdjacentBlankLines(String) - Static method in class org.springframework.ai.reader.ExtractedTextFormatter
Replaces multiple, adjacent blank lines into a single blank line.
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.vectorstore.filter.Filter.Expression
Returns the value of the type record component.
TypeResolverHelper - Class in org.springframework.ai.tool.resolution
A utility class that provides methods for resolving types and classes related to functions.
TypeResolverHelper() - Constructor for class org.springframework.ai.tool.resolution.TypeResolverHelper
 
TYPESENSE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by Typesense.

U

updateContext(Function<Map<String, Object>, Map<String, Object>>) - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
 
updateContext(Function<Map<String, Object>, Map<String, Object>>) - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedResponse
Update the context of the advised response.
UPPER_CASE_TYPE_VALUES - Enum constant in enum class org.springframework.ai.util.json.schema.JsonSchemaGenerator.SchemaOption
Convert all "type" values to upper case.
usage(Usage) - Method in class org.springframework.ai.chat.metadata.ChatResponseMetadata.Builder
 
Usage - Interface in org.springframework.ai.chat.metadata
Abstract Data Type (ADT) encapsulating metadata on the usage of an AI provider's API per AI request.
USAGE_INPUT_TOKENS - Enum constant in enum class org.springframework.ai.chat.observation.ChatModelObservationDocumentation.HighCardinalityKeyNames
The number of tokens used in the model input (prompt).
USAGE_INPUT_TOKENS - Enum constant in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation.HighCardinalityKeyNames
The number of tokens used in the model input.
USAGE_INPUT_TOKENS - Enum constant in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames
The number of tokens used in the model input (prompt).
USAGE_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.
usageInputTokens(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
usageInputTokens(KeyValues, EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
 
usageOutputTokens(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
usageTotalTokens(KeyValues, ChatModelObservationContext) - Method in class org.springframework.ai.chat.observation.DefaultChatModelObservationConvention
 
usageTotalTokens(KeyValues, EmbeddingModelObservationContext) - Method in class org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention
 
UsageUtils - Class in org.springframework.ai.chat.metadata
An utility class to provide support methods handling Usage.
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(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.
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(String, Collection<Media>, Map<String, Object>) - Constructor for class org.springframework.ai.chat.messages.UserMessage
 
UserMessage(String, List<Media>) - Constructor for class org.springframework.ai.chat.messages.UserMessage
 
UserMessage(String, Media...) - Constructor for class org.springframework.ai.chat.messages.UserMessage
 
UserMessage(MessageType, String, Collection<Media>, Map<String, Object>) - Constructor for class org.springframework.ai.chat.messages.UserMessage
 
UserMessage(Resource) - Constructor for class org.springframework.ai.chat.messages.UserMessage
 
userParams() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns the value of the userParams record component.
userParams(Map<String, Object>) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Set the user params.
userText() - Method in record class org.springframework.ai.chat.client.advisor.api.AdvisedRequest
Returns the value of the userText record component.
userText(String) - Method in class org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder
Set the user text.
userTextAdvise(String) - Method in class org.springframework.ai.chat.client.advisor.QuestionAnswerAdvisor.Builder
 

V

validate(Map<String, Object>) - Method in class org.springframework.ai.chat.prompt.PromptTemplate
 
validateToolCallbacks(List<FunctionCallback>) - Static method in interface org.springframework.ai.model.tool.ToolCallingChatOptions
 
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.AiObservationEventNames
Return the value of the event name.
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.VectorStoreObservationEventNames
Return the value of the event name.
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(String) - Static method in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Type
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.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.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.Events
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.chat.prompt.TemplateFormat
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.embedding.EmbeddingResultMetadata.ModalityType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation.HighCardinalityKeyNames
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation.LowCardinalityKeyNames
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.Events
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.LowCardinalityKeyNames
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.model.function.FunctionCallback.SchemaType
Deprecated.
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.AiObservationEventNames
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.VectorStoreObservationEventNames
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.transformer.SummaryMetadataEnricher.SummaryType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.util.json.schema.JsonSchemaGenerator.SchemaOption
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.util.json.schema.SchemaType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.ai.util.json.schema.SpringAiSchemaModule.Option
Returns the enum constant of this class with the specified name.
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.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.
values() - Static method in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.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.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.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.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.Events
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.chat.prompt.TemplateFormat
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.embedding.EmbeddingResultMetadata.ModalityType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation.HighCardinalityKeyNames
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation.LowCardinalityKeyNames
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.Events
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation.LowCardinalityKeyNames
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.image.observation.ImageModelObservationDocumentation
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.model.function.FunctionCallback.SchemaType
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.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.AiObservationEventNames
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.VectorStoreObservationEventNames
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.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.util.json.schema.JsonSchemaGenerator.SchemaOption
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.util.json.schema.SchemaType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.ai.util.json.schema.SpringAiSchemaModule.Option
Returns an array containing the constants of this enum class, in the order they are declared.
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.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.
VECTOR_STORE - Enum constant in enum class org.springframework.ai.observation.conventions.SpringAiKind
Spring AI kind for vector store.
vectorStore(VectorStore) - Method in class org.springframework.ai.rag.retrieval.search.VectorStoreDocumentRetriever.Builder
 
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
Memory is retrieved from a VectorStore added into the prompt's system text.
VectorStoreChatMemoryAdvisor(VectorStore) - Constructor for class org.springframework.ai.chat.client.advisor.VectorStoreChatMemoryAdvisor
Deprecated, for removal: This API element is subject to removal in a future version.
VectorStoreChatMemoryAdvisor(VectorStore, String) - Constructor for class org.springframework.ai.chat.client.advisor.VectorStoreChatMemoryAdvisor
Deprecated, for removal: This API element is subject to removal in a future version.
VectorStoreChatMemoryAdvisor(VectorStore, String, int) - Constructor for class org.springframework.ai.chat.client.advisor.VectorStoreChatMemoryAdvisor
Deprecated, for removal: This API element is subject to removal in a future version.
VectorStoreChatMemoryAdvisor(VectorStore, String, int, int) - Constructor for class org.springframework.ai.chat.client.advisor.VectorStoreChatMemoryAdvisor
Deprecated, for removal: This API element is subject to removal in a future version.
VectorStoreChatMemoryAdvisor(VectorStore, String, int, String) - Constructor for class org.springframework.ai.chat.client.advisor.VectorStoreChatMemoryAdvisor
Deprecated, for removal: This API element is subject to removal in a future version.
VectorStoreChatMemoryAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor
 
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
VectorStoreObservationAttributes - Enum Class in org.springframework.ai.observation.conventions
Collection of attribute keys used in vector store observations (spans, metrics, events).
VectorStoreObservationContentProcessor - Class in org.springframework.ai.vectorstore.observation
Utilities to process the query content in observations for vector store operations.
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.
VectorStoreObservationEventNames - Enum Class in org.springframework.ai.observation.conventions
Collection of event names used in vector store observations.
VectorStoreProvider - Enum Class in org.springframework.ai.observation.conventions
Collection of systems providing vector store functionality.
VectorStoreQueryResponseObservationFilter - Class in org.springframework.ai.vectorstore.observation
An ObservationFilter to include the Vector Store search response content in the observation.
VectorStoreQueryResponseObservationFilter() - Constructor for class org.springframework.ai.vectorstore.observation.VectorStoreQueryResponseObservationFilter
 
VectorStoreQueryResponseObservationHandler - Class in org.springframework.ai.vectorstore.observation
Handler for including the query response content in the observation as a span event.
VectorStoreQueryResponseObservationHandler() - Constructor for class org.springframework.ai.vectorstore.observation.VectorStoreQueryResponseObservationHandler
 
VectorStoreSimilarityMetric - Enum Class in org.springframework.ai.observation.conventions
Types of similarity metrics used in vector store operations.
VERTEX_AI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
AI system provided by Vertex AI.
VIDEO - Enum constant in enum class org.springframework.ai.embedding.EmbeddingResultMetadata.ModalityType
 
VIDEO_FLV - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for video/x-flv.
VIDEO_MKV - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for video/x-matros.
VIDEO_MOV - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for video/quicktime.
VIDEO_MP4 - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for video/mp4.
VIDEO_MPEG - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for video/mpeg.
VIDEO_MPG - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for video/mpeg.
VIDEO_THREE_GP - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for video/3gpp.
VIDEO_WEBM - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for video/webm.
VIDEO_WMV - Static variable in class org.springframework.ai.model.Media.Format
Public constant mime type for video/x-ms-wmv.
violence(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
 
violence(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
 
violenceGraphic(boolean) - Method in class org.springframework.ai.moderation.Categories.Builder
 
violenceGraphic(double) - Method in class org.springframework.ai.moderation.CategoryScores.Builder
 
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
 
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
 
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
 
visitIdentifier(FiltersParser.IdentifierContext) - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersBaseVisitor
Visit a parse tree produced by FiltersParser.identifier().
visitIdentifier(FiltersParser.IdentifierContext) - Method in interface org.springframework.ai.vectorstore.filter.antlr4.FiltersVisitor
Visit a parse tree produced by FiltersParser.identifier().
visitIdentifier(FiltersParser.IdentifierContext) - 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
 
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
 
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
 
VOCABULARY - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer
 
VOCABULARY - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser
 

W

WEAVIATE - Enum constant in enum class org.springframework.ai.observation.conventions.VectorStoreProvider
Vector store provided by Weaviate.
where() - Method in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser
 
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
 
width(Integer) - Method in class org.springframework.ai.image.ImageOptionsBuilder
 
withChunkSize(int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder
 
withDimensions(Integer) - Method in class org.springframework.ai.embedding.EmbeddingOptionsBuilder
 
withEmbedding(float[]) - Method in class org.springframework.ai.vectorstore.SimpleVectorStoreContent
Creates a new instance with an updated embedding vector.
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.
withFormat(String) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder
 
withKeepSeparator(boolean) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder
 
withLeftAlignment(boolean) - Method in class org.springframework.ai.reader.ExtractedTextFormatter.Builder
Align the document text to the left.
withMaxNumChunks(int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder
 
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.
withMinChunkLengthToEmbed(int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder
 
withMinChunkSizeChars(int) - Method in class org.springframework.ai.transformer.splitter.TokenTextSplitter.Builder
 
withModel(String) - Method in class org.springframework.ai.embedding.EmbeddingOptionsBuilder
 
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.
withRequest(DefaultChatClient.DefaultChatClientRequestSpec) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder
 
withStream(boolean) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder
 
withTextTemplate(String) - Method in class org.springframework.ai.document.DefaultContentFormatter.Builder
Configures the Document text template.
withTranscriptionMetadata(AudioTranscriptionMetadata) - Method in class org.springframework.ai.audio.transcription.AudioTranscription
 
write(List<Document>) - Method in interface org.springframework.ai.document.DocumentWriter
 
WS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer
 
WS - Static variable in class org.springframework.ai.vectorstore.filter.antlr4.FiltersParser
 

Z

ZHIPUAI - Enum constant in enum class org.springframework.ai.observation.conventions.AiProvider
AI system provided by Zhipuai.

_

_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 Z _ 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form