Index (Spring AI Chat Client 2.0.0 API)

A B C D E F G H I J L M N O P R S T U V
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
adviseCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor
adviseCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor
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.SafeGuardAdvisor
adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor
adviseStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor
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 ObservationConvention for chat client advisors.
AdvisorObservationDocumentation - Enum Class in org.springframework.ai.chat.client.advisor.observation: AI Advisor observation documentation.
AdvisorObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.ai.chat.client.advisor.observation: High cardinality key names.
AdvisorObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.ai.chat.client.advisor.observation: Low cardinality key names.
advisorOrder(int) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder: Sets the advisor order.
advisorOrder(int) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder: Sets the order of the advisor in the advisor chain.
advisorOrder(AdvisorObservationContext) - Method in class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention
AdvisorParams - Class in org.springframework.ai.chat.client: Configuration options for the ChatClient request.
advisors(KeyValues, ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
advisors(Consumer<ChatClient.AdvisorSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
advisors(Consumer<ChatClient.AdvisorSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
advisors(List<? extends Advisor>) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder
advisors(List<Advisor>) - Method in interface org.springframework.ai.chat.client.ChatClient.AdvisorSpec
advisors(List<Advisor>) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
advisors(List<Advisor>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec
advisors(List<Advisor>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
advisors(Advisor...) - Method in interface org.springframework.ai.chat.client.ChatClient.AdvisorSpec
advisors(Advisor...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
advisors(Advisor...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec
advisors(Advisor...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
AdvisorUtils - Class in org.springframework.ai.chat.client.advisor: Utilities to work with advisors.
after(ChatClientResponse, AdvisorChain) - Method in 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
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 CallAdvisor and StreamAdvisor, reducing the boilerplate code needed to implement an advisor.
BaseAdvisorChain - Interface in org.springframework.ai.chat.client.advisor.api: A base interface for advisor chains that can be used to chain multiple advisors together, both for call and stream advisors.
BaseAdvisorChain.Builder<B extends BaseAdvisorChain.Builder<B>> - Interface in org.springframework.ai.chat.client.advisor.api: Builder for creating a BaseAdvisorChain instance.
BaseChatMemoryAdvisor - Interface in org.springframework.ai.chat.client.advisor.api: Base interface for chat memory advisors.
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
build() - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisorChain.Builder: Builds and returns the BaseAdvisorChain.
build() - Method in class org.springframework.ai.chat.client.advisor.ChatModelCallAdvisor.Builder
build() - Method in class org.springframework.ai.chat.client.advisor.ChatModelStreamAdvisor.Builder
build() - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder
build() - Method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor.Builder: Build the advisor.
build() - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder
build() - Method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor.Builder
build() - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor.Builder
build() - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder: Builds the StructuredOutputValidationAdvisor.
build() - Method in class org.springframework.ai.chat.client.advisor.ToolCallAdvisor.Builder: Deprecated, for removal: This API element is subject to removal in a future version.
build() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder: Builds and returns a new ToolCallingAdvisor instance with the configured properties.
build() - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
build() - Method in class org.springframework.ai.chat.client.ChatClientRequest.Builder
build() - Method in class org.springframework.ai.chat.client.ChatClientResponse.Builder
build() - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
build() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder
build() - Method in class org.springframework.ai.chat.evaluation.FactCheckingEvaluator.Builder
build() - Method in class org.springframework.ai.chat.evaluation.RelevancyEvaluator.Builder
builder() - Static method in class org.springframework.ai.chat.client.advisor.ChatModelCallAdvisor
builder() - Static method in class org.springframework.ai.chat.client.advisor.ChatModelStreamAdvisor
builder() - Static method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext: Create a new AdvisorObservationContext.Builder instance.
builder() - Static method in class org.springframework.ai.chat.client.advisor.SafeGuardAdvisor
builder() - Static method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
builder() - Static method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor: Returns a new StructuredOutputValidationAdvisor.Builder.
builder() - Static method in class org.springframework.ai.chat.client.advisor.ToolCallAdvisor: Deprecated, for removal: This API element is subject to removal in a future version.
since 2.0.0 in favor of ToolCallingAdvisor.builder().
builder() - Static method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor: Creates a new Builder instance for constructing a ToolCallingAdvisor.
builder() - Static method in 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 interface org.springframework.ai.chat.client.advisor.api.BaseAdvisorChain: Creates a new BaseAdvisorChain.Builder for the default BaseAdvisorChain implementation.
builder(ObservationRegistry) - Static method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
builder(ChatClient.Builder) - Static method in class org.springframework.ai.chat.evaluation.FactCheckingEvaluator
builder(ChatMemory) - Static method in class org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor
builder(ChatModel) - Static method in interface org.springframework.ai.chat.client.ChatClient
builder(ChatModel, ObservationRegistry, ChatClientObservationConvention, AdvisorObservationConvention) - Static method in interface org.springframework.ai.chat.client.ChatClient
builder(ChatModel, ObservationRegistry, ChatClientObservationConvention, AdvisorObservationConvention, ToolCallingAdvisor.Builder<?>) - Static method in interface org.springframework.ai.chat.client.ChatClient: Creates a ChatClient.Builder for constructing a ChatClient.
Builder() - Constructor for class org.springframework.ai.chat.client.advisor.ToolCallAdvisor.Builder: Deprecated, for removal: This API element is subject to removal in a future version.
Builder() - Constructor for class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder
Builder(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 CallAdvisor instances orchestrating the execution of a ChatClientRequest on the next CallAdvisor in 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.CallResponseSpec - Interface in org.springframework.ai.chat.client
ChatClient.ChatClientRequestSpec - Interface in org.springframework.ai.chat.client
ChatClient.EntityParamSpec - Interface in org.springframework.ai.chat.client: Configures optional behaviour for entity(...) calls.
ChatClient.PromptSystemSpec - Interface in org.springframework.ai.chat.client: Specification for a prompt system.
ChatClient.PromptUserSpec - Interface in org.springframework.ai.chat.client
ChatClient.StreamResponseSpec - Interface in org.springframework.ai.chat.client
ChatClientAttributes - Enum Class in org.springframework.ai.chat.client: Common attributes used in ChatClient context.
chatClientBuilder(ChatClient.Builder) - Method in class org.springframework.ai.chat.evaluation.FactCheckingEvaluator.Builder
chatClientBuilder(ChatClient.Builder) - Method in class org.springframework.ai.chat.evaluation.RelevancyEvaluator.Builder
ChatClientBuilderCustomizer - Interface in org.springframework.ai.chat.client: Callback interface that can be used to customize a ChatClient.Builder.
ChatClientCompletionObservationHandler - Class in org.springframework.ai.chat.client.observation: Handler for emitting the chat client completion content to logs.
ChatClientCompletionObservationHandler() - Constructor for class org.springframework.ai.chat.client.observation.ChatClientCompletionObservationHandler
ChatClientCustomizer - Interface in org.springframework.ai.chat.client: Deprecated, for removal: This API element is subject to removal in a future version.
in favor of ChatClientBuilderCustomizer
ChatClientMessageAggregator - Class in org.springframework.ai.chat.client: Helper that for streaming chat responses, aggregate the chat response messages into a single AssistantMessage.
ChatClientMessageAggregator() - Constructor for class org.springframework.ai.chat.client.ChatClientMessageAggregator
ChatClientObservationContext - Class in org.springframework.ai.chat.client.observation: Context used to store metadata for chat client workflows.
ChatClientObservationContext.Builder - Class in org.springframework.ai.chat.client.observation
ChatClientObservationConvention - Interface in org.springframework.ai.chat.client.observation: Interface for an ObservationConvention for chat client workflows.
ChatClientObservationDocumentation - Enum Class in org.springframework.ai.chat.client.observation: Documented conventions for chat client observations.
ChatClientObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.ai.chat.client.observation
ChatClientObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.ai.chat.client.observation
ChatClientPromptContentObservationHandler - Class in org.springframework.ai.chat.client.observation: Handler for emitting the chat client prompt content to logs.
ChatClientPromptContentObservationHandler() - Constructor for class org.springframework.ai.chat.client.observation.ChatClientPromptContentObservationHandler
chatClientRequest(ChatClientRequest) - Method in class org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder
ChatClientRequest - Record Class in org.springframework.ai.chat.client: Represents a request processed by a ChatClient that ultimately is used to build a Prompt to be sent to an AI model.
ChatClientRequest(Prompt, Map<String, Object>) - Constructor for record class org.springframework.ai.chat.client.ChatClientRequest: Creates an instance of a ChatClientRequest record class.
ChatClientRequest.Builder - Class in org.springframework.ai.chat.client
chatClientResponse() - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec
chatClientResponse() - Method in interface org.springframework.ai.chat.client.ChatClient.StreamResponseSpec
chatClientResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
chatClientResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamResponseSpec
ChatClientResponse - Record Class in org.springframework.ai.chat.client: Represents a response returned by a ChatClient.
ChatClientResponse(ChatResponse, Map<String, Object>) - Constructor for record class org.springframework.ai.chat.client.ChatClientResponse: Creates an instance of a ChatClientResponse record class.
ChatClientResponse.Builder - Class in org.springframework.ai.chat.client
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 CallAdvisor that uses a ChatModel to generate a response.
ChatModelCallAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor
ChatModelStreamAdvisor - Class in org.springframework.ai.chat.client.advisor: A StreamAdvisor that uses a ChatModel to generate a streaming response.
ChatModelStreamAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor
chatResponse() - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec
chatResponse() - Method in interface org.springframework.ai.chat.client.ChatClient.StreamResponseSpec
chatResponse() - Method in record class org.springframework.ai.chat.client.ChatClientResponse: Returns the value of the chatResponse record component.
chatResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
chatResponse() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamResponseSpec
chatResponse(ChatResponse) - Method in class org.springframework.ai.chat.client.ChatClientResponse.Builder
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.CallResponseSpec
content() - Method in interface org.springframework.ai.chat.client.ChatClient.StreamResponseSpec
content() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
content() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamResponseSpec
context() - Method in record class org.springframework.ai.chat.client.ChatClientRequest: Returns the value of the context record component.
context() - Method in record class org.springframework.ai.chat.client.ChatClientResponse: Returns the value of the context record component.
context(String, Object) - Method in class org.springframework.ai.chat.client.ChatClientRequest.Builder
context(String, Object) - Method in class org.springframework.ai.chat.client.ChatClientResponse.Builder
context(Map<String, ? extends Object>) - Method in class org.springframework.ai.chat.client.ChatClientRequest.Builder
context(Map<String, ? extends Object>) - Method in class org.springframework.ai.chat.client.ChatClientResponse.Builder
conversationHistoryEnabled(boolean) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder: Sets whether internal conversation history is enabled.
conversationId(KeyValues, ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
copy() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder: Creates a shallow copy of this builder with all current settings.
copy() - Method in record class org.springframework.ai.chat.client.ChatClientRequest
copy() - Method in record class org.springframework.ai.chat.client.ChatClientResponse
copy(CallAdvisor) - Method in interface org.springframework.ai.chat.client.advisor.api.CallAdvisorChain: Creates a new CallAdvisorChain copy that contains all advisors after the specified advisor.
copy(CallAdvisor) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
copy(StreamAdvisor) - Method in interface org.springframework.ai.chat.client.advisor.api.StreamAdvisorChain: Creates a new StreamAdvisorChain copy that contains all advisors after the specified advisor.
copy(StreamAdvisor) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
create(ChatModel) - Static method in interface org.springframework.ai.chat.client.ChatClient
create(ChatModel, ObservationRegistry) - Static method in interface org.springframework.ai.chat.client.ChatClient
create(ChatModel, ObservationRegistry, ChatClientObservationConvention, AdvisorObservationConvention) - Static method in interface org.springframework.ai.chat.client.ChatClient
customize(ChatClient.Builder) - Method in interface org.springframework.ai.chat.client.ChatClientBuilderCustomizer: Callback to customize a ChatClient.Builder instance.
customize(ChatClient.Builder) - Method in interface org.springframework.ai.chat.client.ChatClientCustomizer: Deprecated.

Callback to customize a ChatClient.Builder instance.

D

DEFAULT_CHAT_MEMORY_PRECEDENCE_ORDER - Static variable in interface org.springframework.ai.chat.client.advisor.api.Advisor: Default order for chat-memory advisors.
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_ORDER - Static variable in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor: Default advisor order.
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_TOOL_EXECUTION_ELIGIBILITY_CHECKER - Static variable in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor
DefaultAdvisorObservationConvention - Class in org.springframework.ai.chat.client.advisor.observation: Default implementation of the AdvisorObservationConvention.
DefaultAdvisorObservationConvention() - Constructor for class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention
DefaultAdvisorObservationConvention(String) - Constructor for class org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention
defaultAdvisors(Consumer<ChatClient.AdvisorSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
defaultAdvisors(Consumer<ChatClient.AdvisorSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
defaultAdvisors(List<Advisor>) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
defaultAdvisors(List<Advisor>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
defaultAdvisors(Advisor...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
defaultAdvisors(Advisor...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
DefaultAdvisorSpec() - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultAdvisorSpec
DefaultAroundAdvisorChain - Class in org.springframework.ai.chat.client.advisor: Default implementation for the BaseAdvisorChain.
DefaultAroundAdvisorChain.Builder - Class in org.springframework.ai.chat.client.advisor
DefaultCallResponseSpec(ChatClientRequest, BaseAdvisorChain, ObservationRegistry, ChatClientObservationConvention) - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
DefaultChatClient - Class in org.springframework.ai.chat.client: The default implementation of ChatClient as created by the ChatClient.Builder.build() } method.
DefaultChatClient(DefaultChatClient.DefaultChatClientRequestSpec) - Constructor for class org.springframework.ai.chat.client.DefaultChatClient
DefaultChatClient.DefaultAdvisorSpec - Class in org.springframework.ai.chat.client
DefaultChatClient.DefaultCallResponseSpec - Class in org.springframework.ai.chat.client
DefaultChatClient.DefaultChatClientRequestSpec - Class in org.springframework.ai.chat.client
DefaultChatClient.DefaultEntityParamSpec - Class in org.springframework.ai.chat.client: Default implementation of ChatClient.EntityParamSpec.
DefaultChatClient.DefaultPromptSystemSpec - Class in org.springframework.ai.chat.client
DefaultChatClient.DefaultPromptUserSpec - Class in org.springframework.ai.chat.client
DefaultChatClient.DefaultStreamResponseSpec - Class in org.springframework.ai.chat.client
DefaultChatClientBuilder - Class in org.springframework.ai.chat.client: DefaultChatClientBuilder is a builder class for creating a ChatClient.
DefaultChatClientBuilder(ChatModel, ObservationRegistry, ChatClientObservationConvention, AdvisorObservationConvention) - Constructor for class org.springframework.ai.chat.client.DefaultChatClientBuilder: Deprecated, for removal: This API element is subject to removal in a future version.
DefaultChatClientBuilder(ChatModel, ObservationRegistry, ChatClientObservationConvention, AdvisorObservationConvention, ToolCallingAdvisor.Builder<?>) - Constructor for class org.springframework.ai.chat.client.DefaultChatClientBuilder: Creates a new DefaultChatClientBuilder.
DefaultChatClientObservationConvention - Class in org.springframework.ai.chat.client.observation: Default conventions to populate observations for chat client workflows.
DefaultChatClientObservationConvention() - Constructor for class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
DefaultChatClientObservationConvention(String) - Constructor for class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
DefaultChatClientRequestSpec(ChatModel, String, Map<String, Object>, Map<String, Object>, String, Map<String, Object>, Map<String, Object>, List<ToolCallback>, List<ToolCallbackProvider>, List<Message>, List<Media>, ChatOptions.Builder<?>, List<Advisor>, Map<String, Object>, ObservationRegistry, ChatClientObservationConvention, Map<String, Object>, TemplateRenderer, AdvisorObservationConvention, ToolCallingAdvisor.Builder<?>) - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
DefaultEntityParamSpec() - Constructor for class org.springframework.ai.chat.client.DefaultChatClient.DefaultEntityParamSpec
defaultOptions(ChatOptions.Builder) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder
defaultOptions(ChatOptions.Builder) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
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: Deprecated, for removal: This API element is subject to removal in a future version.
as of 2.0.0, in favor of ChatClient.Builder.defaultTools(Object...). To be removed in 3.0.0.
defaultToolCallbacks(List<ToolCallback>) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder: Deprecated, for removal: This API element is subject to removal in a future version.
as of 2.0.0, in favor of #defaultTools(Consumer). To be removed in 3.0.0.
defaultToolCallbacks(ToolCallback...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder: Deprecated, for removal: This API element is subject to removal in a future version.
as of 2.0.0, in favor of ChatClient.Builder.defaultTools(Object...). To be removed in 3.0.0.
defaultToolCallbacks(ToolCallback...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder: Deprecated, for removal: This API element is subject to removal in a future version.
as of 2.0.0, in favor of DefaultChatClientBuilder.defaultTools(Object...). To be removed in 3.0.0.
defaultToolCallbacks(ToolCallbackProvider...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder: Deprecated, for removal: This API element is subject to removal in a future version.
as of 2.0.0, in favor of ChatClient.Builder.defaultTools(Object...). To be removed in 3.0.0.
defaultToolCallbacks(ToolCallbackProvider...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder: Deprecated, for removal: This API element is subject to removal in a future version.
as of 2.0.0, in favor of #defaultTools(Consumer). To be removed in 3.0.0.
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
defaultTools(Object...) - Method in interface org.springframework.ai.chat.client.ChatClient.Builder: Register one or more default tools that will be available to every request built from this ChatClient.Builder.
defaultTools(Object...) - Method in class org.springframework.ai.chat.client.DefaultChatClientBuilder
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
disableInternalConversationHistory() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder: Disables internal conversation history.
doAfterCall(ChatClientResponse, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor
doAfterStream(ChatClientResponse, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor: Hook method called after each streaming call in the tool call loop.
doBeforeCall(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor
doBeforeStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor: Hook method called before each streaming call in the tool call loop.
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
doFinalizeLoop(ChatClientResponse, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor
doFinalizeLoopStream(Flux<ChatClientResponse>, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor: Hook method called at the end of the streaming tool call loop to finalize the response.
doGetNextInstructionsForToolCall(ChatClientRequest, ChatClientResponse, ToolExecutionResult) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor
doGetNextInstructionsForToolCallStream(ChatClientRequest, ChatClientResponse, ToolExecutionResult) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor: Hook method to determine the next instructions for a tool call iteration in streaming mode.
doInitializeLoop(ChatClientRequest, CallAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor
doInitializeLoopStream(ChatClientRequest, StreamAdvisorChain) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor: Hook method called at the start of the streaming tool call loop.
doResponseEntity(StructuredOutputConverter<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
doResponseEntity(StructuredOutputConverter<T>, BaseAdvisorChain) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

E

ENABLE_NATIVE_STRUCTURED_OUTPUT - Static variable in class org.springframework.ai.chat.client.AdvisorParams: Advisor parameter that enables provider-native structured output for all entity() calls on a prompt.
entity() - Method in record class org.springframework.ai.chat.client.ResponseEntity: Returns the value of the entity record component.
entity(Class<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec: Deserializes the response into a T instance.
entity(Class<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
entity(Class<T>, Consumer<ChatClient.EntityParamSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec: Deserializes the response into a T instance, with behaviour configured via the entityParamSpecConsumer.
entity(Class<T>, Consumer<ChatClient.EntityParamSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
entity(StructuredOutputConverter<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec: Deserializes the response using the given converter.
entity(StructuredOutputConverter<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
entity(StructuredOutputConverter<T>, Consumer<ChatClient.EntityParamSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec: Deserializes the response using the given converter, with behaviour configured via the entityParamSpecConsumer.
entity(StructuredOutputConverter<T>, Consumer<ChatClient.EntityParamSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
entity(ParameterizedTypeReference<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec: Deserializes the response into a T instance.
entity(ParameterizedTypeReference<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
entity(ParameterizedTypeReference<T>, Consumer<ChatClient.EntityParamSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec: Deserializes the response into a T instance, with behaviour configured via the entityParamSpecConsumer.
entity(ParameterizedTypeReference<T>, Consumer<ChatClient.EntityParamSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
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
evaluationPrompt(String) - Method in class org.springframework.ai.chat.evaluation.FactCheckingEvaluator.Builder

F

FactCheckingEvaluator - Class in org.springframework.ai.chat.evaluation: Implementation of Evaluator used to evaluate the factual accuracy of Large Language Model (LLM) responses against provided context.
FactCheckingEvaluator(ChatClient.Builder, String) - Constructor for class org.springframework.ai.chat.evaluation.FactCheckingEvaluator: Constructs a new FactCheckingEvaluator with the provided ChatClient.Builder and evaluation prompt.
FactCheckingEvaluator.Builder - Class in org.springframework.ai.chat.evaluation
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
getAdvisorOrder() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder: Returns the configured advisor order.
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 CallAdvisor instances 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
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>) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseChatMemoryAdvisor: Retrieve the conversation ID from the given context.
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.advisor.StructuredOutputValidationAdvisor
getName() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor
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.SafeGuardAdvisor
getOrder() - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
getOrder() - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor
getOrder() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor
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 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
getStreamAdvisors() - Method in interface org.springframework.ai.chat.client.advisor.api.StreamAdvisorChain: Returns the list of all the StreamAdvisor instances included in this chain at the time of its creation.
getStreamAdvisors() - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
getSystemMetadata() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
getSystemParams() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
getSystemText() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
getTemplateRenderer() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
getToolCallbackProviders() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
getToolCallbacks() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
getToolCallingManager() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder: Returns the configured ToolCallingManager.
getToolContext() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
getToolExecutionEligibilityChecker() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder: Returns the configured ToolExecutionEligibilityChecker.
getUserMetadata() - 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

isConversationHistoryEnabled() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder: Returns whether internal conversation history is enabled.
isEnableNative() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultEntityParamSpec
isStream() - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext
isValidated() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultEntityParamSpec

J

jsonMapper(JsonMapper) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder: Sets the JsonMapper used for JSON parsing and validation.

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
logRequest(ChatClientRequest) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor
logResponse(ChatClientResponse) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

M

maxRepeatAttempts(int) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder: Sets the maximum number of retry attempts after a validation failure.
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
MemoryAdvisor - Interface in org.springframework.ai.chat.client.advisor.api: Marker interface for advisors that own the memory lifecycle.
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
metadata() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec
metadata() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec
metadata(String, Object) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptSystemSpec
metadata(String, Object) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptUserSpec
metadata(String, Object) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec
metadata(String, Object) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec
metadata(Map<String, Object>) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptSystemSpec
metadata(Map<String, Object>) - Method in interface org.springframework.ai.chat.client.ChatClient.PromptUserSpec
metadata(Map<String, Object>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptSystemSpec
metadata(Map<String, Object>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultPromptUserSpec
mutate() - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisorChain: Returns a new BaseAdvisorChain.Builder initialized with this chain's advisors and configuration, allowing it to be selectively modified before building a new chain.
mutate() - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
mutate() - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec: Return a ChatClient.Builder to create a new ChatClient whose settings are replicated from this ChatClientRequest.
mutate() - Method in interface org.springframework.ai.chat.client.ChatClient: Return a ChatClient.Builder to create a new ChatClient whose settings are replicated from the default ChatClient.ChatClientRequestSpec of this client.
mutate() - Method in record class org.springframework.ai.chat.client.ChatClientRequest
mutate() - Method in record class org.springframework.ai.chat.client.ChatClientResponse
mutate() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec: Return a ChatClient.Builder to create a new ChatClient whose settings are replicated from this ChatClientRequest.
mutate() - Method in class org.springframework.ai.chat.client.DefaultChatClient: Return a ChatClient.Builder to create a new ChatClient whose settings are replicated from this ChatClientRequest.

N

newCopy() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder: Factory method called by ToolCallingAdvisor.Builder.copy() to create the blank builder instance that will receive the copied fields.
nextCall(ChatClientRequest) - Method in interface org.springframework.ai.chat.client.advisor.api.CallAdvisorChain: Invokes the next CallAdvisor in the CallAdvisorChain with the given request.
nextCall(ChatClientRequest) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain
nextStream(ChatClientRequest) - Method in interface org.springframework.ai.chat.client.advisor.api.StreamAdvisorChain: Invokes the next StreamAdvisor in the StreamAdvisorChain with the given request.
nextStream(ChatClientRequest) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain

O

observationConvention(AdvisorObservationConvention) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder
onFinishReason() - Static method in class org.springframework.ai.chat.client.advisor.AdvisorUtils: Checks whether the provided ChatClientResponse contains a ChatResponse with at least one result having a non-empty finish reason in its metadata.
onStop(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.ChatClientCompletionObservationHandler
onStop(ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.ChatClientPromptContentObservationHandler
options(B) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec
options(B) - 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.SafeGuardAdvisor.Builder
order(int) - Method in class org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor.Builder
org.springframework.ai.chat.client - package org.springframework.ai.chat.client: Chat client API.
org.springframework.ai.chat.client.advisor - package org.springframework.ai.chat.client.advisor: Provides classes for advising chat clients.
org.springframework.ai.chat.client.advisor.api - package org.springframework.ai.chat.client.advisor.api: Provides the API for chat client advisors.
org.springframework.ai.chat.client.advisor.observation - package org.springframework.ai.chat.client.advisor.observation: Provides the API for chat client advisors observations.
org.springframework.ai.chat.client.observation - package org.springframework.ai.chat.client.observation: Provides classes for observing chat data.
org.springframework.ai.chat.evaluation - package org.springframework.ai.chat.evaluation: The org.sf.ai.chat package represents the bounded context for the Chat Model within the AI generative model domain.
OUTPUT_FORMAT - Enum constant in enum class org.springframework.ai.chat.client.ChatClientAttributes
outputJsonSchema(String) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder: Sets a pre-generated JSON schema string to validate against.
outputType(Type) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder: Sets the expected output type; the JSON schema is derived automatically.
outputType(ParameterizedTypeReference<T>) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder: Sets the expected output type; the JSON schema is derived automatically.
outputType(TypeReference<T>) - Method in class org.springframework.ai.chat.client.advisor.StructuredOutputValidationAdvisor.Builder: Sets the expected output type; the JSON schema is derived automatically.

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 prompt record 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
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 interface org.springframework.ai.chat.client.advisor.api.BaseAdvisorChain.Builder: Adds a single Advisor to the chain.
push(Advisor) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder
pushAll(List<? extends Advisor>) - Method in interface org.springframework.ai.chat.client.advisor.api.BaseAdvisorChain.Builder: Adds multiple Advisor instances to the chain.
pushAll(List<? extends Advisor>) - Method in class org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.Builder

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 response record component.
responseEntity(Class<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec: Returns a ResponseEntity containing both the complete ChatResponse object and a specific entity type.
responseEntity(Class<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
responseEntity(Class<T>, Consumer<ChatClient.EntityParamSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec: Returns a ResponseEntity containing both the complete ChatResponse object and a specific entity type, with behaviour configured via the entityParamSpecConsumer.
responseEntity(Class<T>, Consumer<ChatClient.EntityParamSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
responseEntity(StructuredOutputConverter<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec: Returns a ResponseEntity containing both the complete ChatResponse object and an entity converted using a specified StructuredOutputConverter.
responseEntity(StructuredOutputConverter<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
responseEntity(StructuredOutputConverter<T>, Consumer<ChatClient.EntityParamSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec: Returns a ResponseEntity containing both the complete ChatResponse object and an entity converted using a specified StructuredOutputConverter, with behaviour configured via the entityParamSpecConsumer.
responseEntity(StructuredOutputConverter<T>, Consumer<ChatClient.EntityParamSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
responseEntity(ParameterizedTypeReference<T>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec: Returns a ResponseEntity containing both the complete ChatResponse object and a Collection of entity types.
responseEntity(ParameterizedTypeReference<T>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
responseEntity(ParameterizedTypeReference<T>, Consumer<ChatClient.EntityParamSpec>) - Method in interface org.springframework.ai.chat.client.ChatClient.CallResponseSpec: Returns a ResponseEntity containing both the complete ChatResponse object and a specific entity type, with behaviour configured via the entityParamSpecConsumer.
responseEntity(ParameterizedTypeReference<T>, Consumer<ChatClient.EntityParamSpec>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec
ResponseEntity<R,E> - Record Class in org.springframework.ai.chat.client: Represents a Model response that includes the entire response along with the specified response entity type.
ResponseEntity(R, E) - Constructor for record class org.springframework.ai.chat.client.ResponseEntity: Creates an instance of a ResponseEntity record class.
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
self() - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder: Returns this builder cast to the appropriate type for method chaining.
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
setResponse(ChatClientResponse) - Method in class org.springframework.ai.chat.client.observation.ChatClientObservationContext
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 StreamAdvisor instances orchestrating the execution of a ChatClientRequest on the next StreamAdvisor in the chain.
STRUCTURED_OUTPUT_NATIVE - Enum constant in enum class org.springframework.ai.chat.client.ChatClientAttributes
STRUCTURED_OUTPUT_SCHEMA - Enum constant in enum class org.springframework.ai.chat.client.ChatClientAttributes
StructuredOutputValidationAdvisor - Class in org.springframework.ai.chat.client.advisor: Advisor that validates the structured JSON output of a chat client response against a JSON schema derived from the configured output type or a pre-supplied schema string.
StructuredOutputValidationAdvisor.Builder - Class in org.springframework.ai.chat.client.advisor: Builder for StructuredOutputValidationAdvisor.
supportsContext(Observation.Context) - Method in interface org.springframework.ai.chat.client.advisor.observation.AdvisorObservationConvention
supportsContext(Observation.Context) - Method in class org.springframework.ai.chat.client.observation.ChatClientCompletionObservationHandler
supportsContext(Observation.Context) - Method in interface org.springframework.ai.chat.client.observation.ChatClientObservationConvention
supportsContext(Observation.Context) - Method in class org.springframework.ai.chat.client.observation.ChatClientPromptContentObservationHandler
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

T

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
TOOL_CALL_ADVISOR_AUTO_REGISTER - Enum constant in enum class org.springframework.ai.chat.client.ChatClientAttributes: Deprecated, for removal: This API element is subject to removal in a future version.
TOOL_CALLING_ADVISOR_AUTO_REGISTER - Enum constant in enum class org.springframework.ai.chat.client.ChatClientAttributes
ToolAdvisor - Interface in org.springframework.ai.chat.client.advisor.api: Marker interface for advisors that own the tool-call lifecycle.
ToolCallAdvisor - Class in org.springframework.ai.chat.client.advisor: Deprecated, for removal: This API element is subject to removal in a future version.
since 2.0.0 in favor of ToolCallingAdvisor. This is kept for backward compatibility and will be removed in a future release.
ToolCallAdvisor(ToolCallingManager, ToolExecutionEligibilityChecker, int, boolean) - Constructor for class org.springframework.ai.chat.client.advisor.ToolCallAdvisor: Deprecated.
ToolCallAdvisor.Builder<T extends ToolCallAdvisor.Builder<T>> - Class in org.springframework.ai.chat.client.advisor: Deprecated, for removal: This API element is subject to removal in a future version.
since 2.0.0 in favor of ToolCallingAdvisor.Builder.
toolCallAdvisorAutoRegister(boolean) - Static method in class org.springframework.ai.chat.client.AdvisorParams: Deprecated, for removal: This API element is subject to removal in a future version.
since 2.0.0 in favor of AdvisorParams.toolCallingAdvisorAutoRegister(boolean).
toolCallbacks(List<ToolCallback>) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec: Deprecated, for removal: This API element is subject to removal in a future version.
as of 2.0.0, in favor of ChatClient.ChatClientRequestSpec.tools(Object...). To be removed in 3.0.0.
toolCallbacks(List<ToolCallback>) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
toolCallbacks(ToolCallback...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec: Deprecated, for removal: This API element is subject to removal in a future version.
as of 2.0.0, in favor of ChatClient.ChatClientRequestSpec.tools(Object...). To be removed in 3.0.0.
toolCallbacks(ToolCallback...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
toolCallbacks(ToolCallbackProvider...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec: Deprecated, for removal: This API element is subject to removal in a future version.
as of 2.0.0, in favor of ChatClient.ChatClientRequestSpec.tools(Object...). To be removed in 3.0.0.
toolCallbacks(ToolCallbackProvider...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
ToolCallingAdvisor - Class in org.springframework.ai.chat.client.advisor: Recursive Advisor that disables the internal tool execution flow and instead implements the tool calling loop as part of the advisor chain.
ToolCallingAdvisor(ToolCallingManager, ToolExecutionEligibilityChecker, int, boolean) - Constructor for class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor
ToolCallingAdvisor.Builder<T extends ToolCallingAdvisor.Builder<T>> - Class in org.springframework.ai.chat.client.advisor: Builder for creating instances of ToolCallingAdvisor.
toolCallingAdvisorAutoRegister(boolean) - Static method in class org.springframework.ai.chat.client.AdvisorParams: Controls whether a ToolCallingAdvisor is automatically added to the chain.
toolCallingManager - Variable in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor
toolCallingManager(ToolCallingManager) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder: Sets the ToolCallingManager to be used by the advisor.
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
toolExecutionEligibilityChecker(ToolExecutionEligibilityChecker) - Method in class org.springframework.ai.chat.client.advisor.ToolCallingAdvisor.Builder: Sets the checker that determines whether a model response should trigger tool execution.
tools(KeyValues, ChatClientObservationContext) - Method in class org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention
tools(Object...) - Method in interface org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec: Register one or more tools for this chat request.
tools(Object...) - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec
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

useProviderStructuredOutput() - Method in interface org.springframework.ai.chat.client.ChatClient.EntityParamSpec: Delivers the JSON schema to the AI provider as an API-level constraint rather than appending it as prompt text.
useProviderStructuredOutput() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultEntityParamSpec
user(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

validateSchema() - Method in interface org.springframework.ai.chat.client.ChatClient.EntityParamSpec: Validates the model's JSON response against the entity schema and retries with the error feedback on failure, up to maxRepeatAttempts times (default: 3).
validateSchema() - Method in class org.springframework.ai.chat.client.DefaultChatClient.DefaultEntityParamSpec
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.

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