Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- adviseCall(ChatClientRequest, CallAdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor
- adviseCall(ChatClientRequest, CallAdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.CallAdvisor
- adviseCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ChatModelCallAdvisor
- adviseCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor
- adviseCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
- adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor
- adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.StreamAdvisor
- adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ChatModelStreamAdvisor
- adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor
- adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor
- adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor
- adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
- Advisor - Interface in org.springframework.ai.chat.client.advisor.api
-
Parent advisor interface for all advisors.
- ADVISOR_NAME - Enum constant in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.LowCardinalityKeyNames
-
Advisor name.
- ADVISOR_ORDER - Enum constant in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.HighCardinalityKeyNames
-
Advisor order in the advisor chain.
- AdvisorChain - Interface in org.springframework.ai.chat.client.advisor.api
-
Defines the context for executing a chain of advisors as part of processing a chat request.
- advisorName(String) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder
- advisorName(AdvisorObservationContext) - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention
- AdvisorObservationContext - Class in org.springframework.ai.chat.client.advisor.observation
-
Context used to store metadata for chat client advisors.
- AdvisorObservationContext.Builder - Class in org.springframework.ai.chat.client.advisor.observation
-
Builder for
AdvisorObservationContext. - AdvisorObservationConvention - Interface in org.springframework.ai.chat.client.advisor.observation
-
Interface for an
ObservationConventionfor 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
- advisors(KeyValues, ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
- advisors(Consumer<ChatClient.AdvisorSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
- advisors(Consumer<ChatClient.AdvisorSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- advisors(List<? extends Advisor>) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder
- advisors(List<Advisor>) - Method in interface org.springframework.ai.chat.client.ChatClient.AdvisorSpec
- advisors(List<Advisor>) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
- advisors(List<Advisor>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec
- advisors(List<Advisor>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- advisors(Advisor...) - Method in interface org.springframework.ai.chat.client.ChatClient.AdvisorSpec
- advisors(Advisor...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
- advisors(Advisor...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec
- advisors(Advisor...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- AdvisorUtils - Class in org.springframework.ai.chat.client.advisor
-
Utilities to work with advisors.
- after(ChatClientResponse, AdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor
-
Logic to be executed after the rest of the advisor chain is called.
- after(ChatClientResponse, AdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor
- after(ChatClientResponse, AdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor
- aggregateChatClientResponse(Flux<ChatClientResponse>, Consumer<ChatClientResponse>) - Method in class org.springframework.ai.chat.client.ChatClientMessageAggregator
- AI_ADVISOR - Enum constant in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation
-
AI Advisor observations
- AI_CHAT_CLIENT - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation
-
AI Chat Client observations
- AI_OPERATION_TYPE - Enum constant in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.LowCardinalityKeyNames
-
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.
- 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
- 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
B
- BaseAdvisor - Interface in org.springframework.ai.chat.client.advisor.api
-
Base advisor that implements common aspects of the
CallAdvisorandStreamAdvisor, reducing the boilerplate code needed to implement an advisor. - BaseAdvisorChain - Interface in org.springframework.ai.chat.client.advisor.api
-
A base interface for advisor chains that can be used to chain multiple advisors together, both for call and stream advisors.
- BaseChatMemoryAdvisor - Interface in org.springframework.ai.chat.client.advisor.api
-
Base interface for chat memory advisors.
- before(ChatClientRequest, AdvisorChain) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor
-
Logic to be executed before the rest of the advisor chain is called.
- before(ChatClientRequest, AdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor
- before(ChatClientRequest, AdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor
- build() - Method in class org.springframework.ai.chat.client.advisor.ChatModelCallAdvisor.Builder
- build() - Method in class org.springframework.ai.chat.client.advisor.ChatModelStreamAdvisor.Builder
- build() - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder
- build() - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor.Builder
-
Build the advisor.
- build() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder
- build() - Method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor.Builder
-
Build the advisor.
- build() - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor.Builder
- build() - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor.Builder
- build() - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
- build() - Method in class org.springframework.ai.chat.client.ChatClientRequest.Builder
- build() - Method in class org.springframework.ai.chat.client.ChatClientResponse.Builder
- build() - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
- build() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder
- build() - Method in class org.springframework.ai.chat.evaluation.RelevancyEvaluator.Builder
- builder() - Static method in class org.springframework.ai.chat.client.advisor.ChatModelCallAdvisor
- builder() - Static method in class org.springframework.ai.chat.client.advisor.ChatModelStreamAdvisor
- builder() - Static method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
-
Create a new
AdvisorObservationContext.Builderinstance. - builder() - Static method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor
- builder() - Static method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
- builder() - Static method in record class org.springframework.ai.chat.client.ChatClientRequest
- builder() - Static method in record class org.springframework.ai.chat.client.ChatClientResponse
- builder() - Static method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext
- builder() - Static method in class org.springframework.ai.chat.evaluation.RelevancyEvaluator
- builder(ObservationRegistry) - Static method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
- 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(ObservationRegistry) - Constructor for class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder
C
- call() - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
- call() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- CallAdvisor - Interface in org.springframework.ai.chat.client.advisor.api
-
Advisor for execution flows ultimately resulting in a call to an AI model
- CallAdvisorChain - Interface in org.springframework.ai.chat.client.advisor.api
-
A chain of
CallAdvisorinstances orchestrating the execution of aChatClientRequeston the nextCallAdvisorin the chain. - CHAT_CLIENT_ADVISORS - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames
-
List of configured chat client advisors.
- CHAT_CLIENT_CONVERSATION_ID - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames
-
The identifier of the conversation.
- CHAT_CLIENT_TOOL_NAMES - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames
-
Names of the tools made available to the chat client.
- 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
- ChatClientAttributes - Enum Class in org.springframework.ai.chat.client
-
Common attributes used in
ChatClientcontext. - chatClientBuilder(ChatClient.Builder) - Method in class org.springframework.ai.chat.evaluation.RelevancyEvaluator.Builder
- ChatClientCustomizer - Interface in org.springframework.ai.chat.client
-
Callback interface that can be used to customize a
ChatClient.Builder. - ChatClientMessageAggregator - Class in org.springframework.ai.chat.client
-
Helper that for streaming chat responses, aggregate the chat response messages into a single AssistantMessage.
- ChatClientMessageAggregator() - Constructor for class org.springframework.ai.chat.client.ChatClientMessageAggregator
- ChatClientObservationContext - Class in org.springframework.ai.chat.client.observation
-
Context used to store metadata for chat client workflows.
- ChatClientObservationContext.Builder - Class in org.springframework.ai.chat.client.observation
- ChatClientObservationConvention - Interface in org.springframework.ai.chat.client.observation
-
Interface for an
ObservationConventionfor chat client workflows. - ChatClientObservationDocumentation - Enum Class in org.springframework.ai.chat.client.observation
-
Documented conventions for chat client observations.
- ChatClientObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.ai.chat.client.observation
- ChatClientObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.ai.chat.client.observation
- ChatClientPromptContentObservationHandler - Class in org.springframework.ai.chat.client.observation
-
Handler for emitting the chat client prompt content to logs.
- ChatClientPromptContentObservationHandler() - Constructor for class org.springframework.ai.chat.client.observation.ChatClientPromptContentObservationHandler
- chatClientRequest(ChatClientRequest) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder
- ChatClientRequest - Record Class in org.springframework.ai.chat.client
-
Represents a request processed by a
ChatClientthat ultimately is used to build aPromptto be sent to an AI model. - ChatClientRequest(Prompt, Map<String, Object>) - Constructor for record class org.springframework.ai.chat.client.ChatClientRequest
-
Creates an instance of a
ChatClientRequestrecord class. - ChatClientRequest.Builder - Class in org.springframework.ai.chat.client
- chatClientResponse() - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec
- chatClientResponse() - Method in interface org.springframework.ai.chat.client.ChatClient.StreamResponseSpec
- chatClientResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
- chatClientResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamResponseSpec
- ChatClientResponse - Record Class in org.springframework.ai.chat.client
-
Represents a response returned by a
ChatClient. - ChatClientResponse(ChatResponse, Map<String, Object>) - Constructor for record class org.springframework.ai.chat.client.ChatClientResponse
-
Creates an instance of a
ChatClientResponserecord class. - ChatClientResponse.Builder - Class in org.springframework.ai.chat.client
- chatModel(ChatModel) - Method in class org.springframework.ai.chat.client.advisor.ChatModelCallAdvisor.Builder
- chatModel(ChatModel) - Method in class org.springframework.ai.chat.client.advisor.ChatModelStreamAdvisor.Builder
- ChatModelCallAdvisor - Class in org.springframework.ai.chat.client.advisor
-
A
CallAdvisorthat uses aChatModelto generate a response. - ChatModelCallAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor
- ChatModelStreamAdvisor - Class in org.springframework.ai.chat.client.advisor
-
A
StreamAdvisorthat uses aChatModelto generate a streaming response. - ChatModelStreamAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor
- 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 record class org.springframework.ai.chat.client.ChatClientResponse
-
Returns the value of the
chatResponserecord component. - chatResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
- chatResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamResponseSpec
- chatResponse(ChatResponse) - Method in class org.springframework.ai.chat.client.ChatClientResponse.Builder
- clone() - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
- clone() - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
- 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.DefaultCallResponseSpec
- content() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamResponseSpec
- contents() - Method in interface org.springframework.ai.chat.client.ChatClient.CallPromptResponseSpec
- context() - Method in record class org.springframework.ai.chat.client.ChatClientRequest
-
Returns the value of the
contextrecord component. - context() - Method in record class org.springframework.ai.chat.client.ChatClientResponse
-
Returns the value of the
contextrecord component. - context(String, Object) - Method in class org.springframework.ai.chat.client.ChatClientRequest.Builder
- context(String, Object) - Method in class org.springframework.ai.chat.client.ChatClientResponse.Builder
- context(Map<String, Object>) - Method in class org.springframework.ai.chat.client.ChatClientRequest.Builder
- context(Map<String, Object>) - Method in class org.springframework.ai.chat.client.ChatClientResponse.Builder
- conversationId(KeyValues, ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
- conversationId(String) - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor.Builder
-
Set the conversation id.
- conversationId(String) - Method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor.Builder
-
Set the conversation id.
- copy() - Method in record class org.springframework.ai.chat.client.ChatClientRequest
- copy() - Method in record class org.springframework.ai.chat.client.ChatClientResponse
- 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
- customize(ChatClient.Builder) - Method in interface org.springframework.ai.chat.client.ChatClientCustomizer
-
Callback to customize a
ChatClient.Builderinstance.
D
- 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_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_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
- DefaultAdvisorObservationConvention - Class in org.springframework.ai.chat.client.advisor.observation
-
Default implementation of the
AdvisorObservationConvention. - DefaultAdvisorObservationConvention() - Constructor for class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention
- DefaultAdvisorObservationConvention(String) - Constructor for class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention
- defaultAdvisors(Consumer<ChatClient.AdvisorSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
- defaultAdvisors(Consumer<ChatClient.AdvisorSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
- defaultAdvisors(List<Advisor>) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
- defaultAdvisors(List<Advisor>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
- defaultAdvisors(Advisor...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
- defaultAdvisors(Advisor...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
- DefaultAdvisorSpec() - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec
- DefaultAroundAdvisorChain - Class in org.springframework.ai.chat.client.advisor
-
Default implementation for the
BaseAdvisorChain. - DefaultAroundAdvisorChain.Builder - Class in org.springframework.ai.chat.client.advisor
- DefaultCallResponseSpec(ChatClientRequest, BaseAdvisorChain, ObservationRegistry, ChatClientObservationConvention) - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
- DefaultChatClient - Class in org.springframework.ai.chat.client
-
The default implementation of
ChatClientas created by theChatClient.Builder.build()} method. - DefaultChatClient(DefaultChatClient.DefaultChatClientRequestSpec) - Constructor for class org.springframework.ai.chat.client.DefaultChatClient
- DefaultChatClient.DefaultAdvisorSpec - Class in org.springframework.ai.chat.client
- DefaultChatClient.DefaultCallResponseSpec - Class in org.springframework.ai.chat.client
- DefaultChatClient.DefaultChatClientRequestSpec - Class in org.springframework.ai.chat.client
- DefaultChatClient.DefaultPromptSystemSpec - Class in org.springframework.ai.chat.client
- DefaultChatClient.DefaultPromptUserSpec - Class in org.springframework.ai.chat.client
- DefaultChatClient.DefaultStreamResponseSpec - Class in org.springframework.ai.chat.client
- DefaultChatClientBuilder - Class in org.springframework.ai.chat.client
-
DefaultChatClientBuilder is a builder class for creating a ChatClient.
- DefaultChatClientBuilder(ChatModel, ObservationRegistry, ChatClientObservationConvention) - 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<ToolCallback>, List<Message>, List<String>, List<Media>, ChatOptions, List<Advisor>, Map<String, Object>, ObservationRegistry, ChatClientObservationConvention, Map<String, Object>, TemplateRenderer) - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- 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
- DefaultStreamResponseSpec(ChatClientRequest, BaseAdvisorChain, ObservationRegistry, ChatClientObservationConvention) - 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
- defaultTemplateRenderer(TemplateRenderer) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
- defaultTemplateRenderer(TemplateRenderer) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
- defaultToolCallbacks(List<ToolCallback>) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
- defaultToolCallbacks(List<ToolCallback>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
- defaultToolCallbacks(ToolCallback...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
- defaultToolCallbacks(ToolCallback...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
- defaultToolCallbacks(ToolCallbackProvider...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
- defaultToolCallbacks(ToolCallbackProvider...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
- 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
- defaultToolNames(String...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
- defaultToolNames(String...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
- defaultTools(Object...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
- defaultTools(Object...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
- 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
- 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
- doResponseEntity(StructuredOutputConverter<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
E
- entity() - Method in record class org.springframework.ai.chat.client.ResponseEntity
-
Returns the value of the
entityrecord 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
- equals(Object) - Method in record class org.springframework.ai.chat.client.ChatClientRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.ai.chat.client.ChatClientResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.ai.chat.client.ResponseEntity
-
Indicates whether some other object is "equal to" this one.
- evaluate(EvaluationRequest) - Method in class org.springframework.ai.chat.evaluation.FactCheckingEvaluator
-
Evaluates whether the response content in the EvaluationRequest is factually supported by the context provided in the same request.
- evaluate(EvaluationRequest) - Method in class org.springframework.ai.chat.evaluation.RelevancyEvaluator
F
- FactCheckingEvaluator - Class in org.springframework.ai.chat.evaluation
-
Implementation of
Evaluatorused to evaluate the factual accuracy of Large Language Model (LLM) responses against provided context. - FactCheckingEvaluator(ChatClient.Builder) - Constructor for class org.springframework.ai.chat.evaluation.FactCheckingEvaluator
-
Constructs a new FactCheckingEvaluator with the provided ChatClient.Builder.
- FactCheckingEvaluator(ChatClient.Builder, String) - Constructor for class org.springframework.ai.chat.evaluation.FactCheckingEvaluator
-
Constructs a new FactCheckingEvaluator with the provided ChatClient.Builder and evaluation prompt.
- failureResponse(String) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor.Builder
- forBespokeMinicheck(ChatClient.Builder) - Static method in class org.springframework.ai.chat.evaluation.FactCheckingEvaluator
-
Creates a FactCheckingEvaluator configured for use with the Bespoke Minicheck model.
- format(String) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder
G
- getAdvisorName() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
- getAdvisorParams() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- getAdvisors() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec
- getAdvisors() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- getAdvisors() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext
- getCallAdvisors() - Method in interface org.springframework.ai.chat.client.advisor.api.CallAdvisorChain
-
Returns the list of all the
CallAdvisorinstances included in this chain at the time of its creation. - getCallAdvisors() - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
- getChatClientRequest() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
- getChatClientResponse() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
- getChatOptions() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- 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
- getConversationId(Map<String, Object>, String) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseChatMemoryAdvisor
-
Retrieve the conversation ID from the given context or return the default conversation ID when not found.
- getEntity() - Method in record class org.springframework.ai.chat.client.ResponseEntity
- getFormat() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext
- 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
- getKey() - Method in enum class org.springframework.ai.chat.client.ChatClientAttributes
- 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
- getMedia() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- getMessages() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- getName() - Method in interface org.springframework.ai.chat.client.advisor.api.Advisor
-
Return the name of the advisor.
- getName() - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor
- getName() - Method in class org.springframework.ai.chat.client.advisor.ChatModelCallAdvisor
- getName() - Method in class org.springframework.ai.chat.client.advisor.ChatModelStreamAdvisor
- getName() - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention
- getName() - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor
- getName() - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
- getName() - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
- getObservationRegistry() - Method in interface org.springframework.ai.chat.client.advisor.api.AdvisorChain
- getObservationRegistry() - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
- getOperationMetadata() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext
- getOrder() - Method in class org.springframework.ai.chat.client.advisor.ChatModelCallAdvisor
- getOrder() - Method in class org.springframework.ai.chat.client.advisor.ChatModelStreamAdvisor
- getOrder() - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor
- getOrder() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
- getOrder() - Method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor
- getOrder() - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor
- getOrder() - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
- getParams() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec
- getRequest() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext
- getResponse() - Method in record class org.springframework.ai.chat.client.ResponseEntity
- getScheduler() - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisor
-
Scheduler used for processing the advisor logic when streaming.
- getScheduler() - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor
- getScheduler() - Method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor
- getStreamAdvisors() - Method in interface org.springframework.ai.chat.client.advisor.api.StreamAdvisorChain
-
Returns the list of all the
StreamAdvisorinstances included in this chain at the time of its creation. - getStreamAdvisors() - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
- getSystemParams() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- getSystemText() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- getTemplateRenderer() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- getToolCallbacks() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- getToolContext() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- getToolNames() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- getUserParams() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- getUserText() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
H
- hashCode() - Method in record class org.springframework.ai.chat.client.ChatClientRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.ai.chat.client.ChatClientResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.ai.chat.client.ResponseEntity
-
Returns a hash code value for this object.
I
- isStream() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext
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
M
- maxTokenSize - Variable in class org.springframework.ai.chat.client.advisor.LastMaxTokenSizeContentPurger
- media() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec
- 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
- MessageChatMemoryAdvisor - Class in org.springframework.ai.chat.client.advisor
-
Memory is retrieved added as a collection of messages to the prompt
- MessageChatMemoryAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor
- 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
- mutate() - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
-
Return a
ChatClient.Builderto create a newChatClientwhose settings are replicated from thisChatClientRequest. - mutate() - Method in interface org.springframework.ai.chat.client.ChatClient
-
Return a
ChatClient.Builderto create a newChatClientwhose settings are replicated from the defaultChatClient.ChatClientRequestSpecof this client. - mutate() - Method in record class org.springframework.ai.chat.client.ChatClientRequest
- mutate() - Method in record class org.springframework.ai.chat.client.ChatClientResponse
- mutate() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
-
Return a
ChatClient.Builderto create a newChatClientwhose settings are replicated from thisChatClientRequest. - mutate() - Method in class org.springframework.ai.chat.client.DefaultChatClient
-
Return a
ChatClient.Builderto create a newChatClientwhose settings are replicated from thisChatClientRequest.
N
- nextCall(ChatClientRequest) - Method in interface org.springframework.ai.chat.client.advisor.api.CallAdvisorChain
-
Invokes the next
CallAdvisorin theCallAdvisorChainwith the given request. - nextCall(ChatClientRequest) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
- nextStream(ChatClientRequest) - Method in interface org.springframework.ai.chat.client.advisor.api.StreamAdvisorChain
-
Invokes the next
StreamAdvisorin theStreamAdvisorChainwith the given request. - nextStream(ChatClientRequest) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
O
- onFinishReason() - Static method in class org.springframework.ai.chat.client.advisor.AdvisorUtils
-
Checks whether the provided
ChatClientResponsecontains aChatResponsewith at least one result having a non-empty finish reason in its metadata. - onStop(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.ChatClientPromptContentObservationHandler
- options(T) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
- options(T) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- order(int) - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor.Builder
-
Set the order.
- order(int) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder
- order(int) - Method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor.Builder
-
Set the order.
- order(int) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor.Builder
- order(int) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor.Builder
- 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.evaluation - package org.springframework.ai.chat.evaluation
- OUTPUT_FORMAT - Enum constant in enum class org.springframework.ai.chat.client.ChatClientAttributes
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
- prompt() - Method in interface org.springframework.ai.chat.client.ChatClient
- prompt() - Method in record class org.springframework.ai.chat.client.ChatClientRequest
-
Returns the value of the
promptrecord component. - 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(Prompt) - Method in interface org.springframework.ai.chat.client.ChatClient
- prompt(Prompt) - Method in class org.springframework.ai.chat.client.ChatClientRequest.Builder
- prompt(Prompt) - Method in class org.springframework.ai.chat.client.DefaultChatClient
- PromptChatMemoryAdvisor - Class in org.springframework.ai.chat.client.advisor
-
Memory is retrieved added into the prompt's system text.
- PromptChatMemoryAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor
-
Builder for PromptChatMemoryAdvisor.
- promptTemplate(PromptTemplate) - Method in class org.springframework.ai.chat.evaluation.RelevancyEvaluator.Builder
- 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
R
- RelevancyEvaluator - Class in org.springframework.ai.chat.evaluation
-
Evaluates the relevancy of a response to a query based on the context provided.
- RelevancyEvaluator(ChatClient.Builder) - Constructor for class org.springframework.ai.chat.evaluation.RelevancyEvaluator
- RelevancyEvaluator.Builder - Class in org.springframework.ai.chat.evaluation
- request(ChatClientRequest) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder
- requestToString(Function<ChatClientRequest, String>) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor.Builder
- response() - Method in record class org.springframework.ai.chat.client.ResponseEntity
-
Returns the value of the
responserecord 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
Modelresponse 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
ResponseEntityrecord class. - responseToString(Function<ChatResponse, String>) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor.Builder
S
- SafeGuardAdvisor - Class in org.springframework.ai.chat.client.advisor
-
An advisor that blocks the call to the model provider if the user input contains any of the sensitive words.
- SafeGuardAdvisor(List<String>) - Constructor for class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor
- SafeGuardAdvisor(List<String>, String, int) - Constructor for class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor
- SafeGuardAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor
- scheduler(Scheduler) - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor.Builder
- scheduler(Scheduler) - Method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor.Builder
- sensitiveWords(List<String>) - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor.Builder
- setChatClientResponse(ChatClientResponse) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext
- SimpleLoggerAdvisor - Class in org.springframework.ai.chat.client.advisor
-
A simple logger advisor that logs the request and response messages.
- SimpleLoggerAdvisor() - Constructor for class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
- SimpleLoggerAdvisor(int) - Constructor for class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
- SimpleLoggerAdvisor(Function<ChatClientRequest, String>, Function<ChatResponse, String>, int) - Constructor for class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
- SimpleLoggerAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor
- 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.
- springAiKind() - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention
- springAiKind() - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
- stream() - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
- stream() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- stream(boolean) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder
- stream(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
- STREAM - Enum constant in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.LowCardinalityKeyNames
-
Is the chat model response a stream.
- StreamAdvisor - Interface in org.springframework.ai.chat.client.advisor.api
-
Advisor for execution flows ultimately resulting in a streaming call to an AI model.
- StreamAdvisorChain - Interface in org.springframework.ai.chat.client.advisor.api
-
A chain of
StreamAdvisorinstances orchestrating the execution of aChatClientRequeston the nextStreamAdvisorin the chain. - 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.client.observation.ChatClientPromptContentObservationHandler
- 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
- systemPromptTemplate(PromptTemplate) - Method in class org.springframework.ai.chat.client.advisor.PromptChatMemoryAdvisor.Builder
-
Set the system prompt template.
T
- templateRenderer(TemplateRenderer) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder
- templateRenderer(TemplateRenderer) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
- templateRenderer(TemplateRenderer) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- text() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec
- text() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec
- 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(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
- tokenCountEstimator - Variable in class org.springframework.ai.chat.client.advisor.LastMaxTokenSizeContentPurger
- toolCallbacks(List<ToolCallback>) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
- toolCallbacks(List<ToolCallback>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- toolCallbacks(ToolCallback...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
- toolCallbacks(ToolCallback...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- toolCallbacks(ToolCallbackProvider...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
- toolCallbacks(ToolCallbackProvider...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- 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
- toolNames(String...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
- toolNames(String...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- tools(KeyValues, ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
- tools(Object...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
- tools(Object...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
- toString() - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
- toString() - Method in record class org.springframework.ai.chat.client.ChatClientRequest
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.ai.chat.client.ChatClientResponse
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.ai.chat.client.ResponseEntity
-
Returns a string representation of this record class.
U
- 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
V
- valueOf(String) - Static method in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.HighCardinalityKeyNames
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.LowCardinalityKeyNames
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.chat.client.ChatClientAttributes
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.LowCardinalityKeyNames
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.HighCardinalityKeyNames
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.LowCardinalityKeyNames
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.chat.client.ChatClientAttributes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.LowCardinalityKeyNames
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages|Constant Field Values