Package org.springframework.ai.chat.client

Class DefaultChatClientBuilder

java.lang.Object

org.springframework.ai.chat.client.DefaultChatClientBuilder

All Implemented Interfaces:

ChatClient.Builder

public class DefaultChatClientBuilder
extends Object
implements ChatClient.Builder

DefaultChatClientBuilder is a builder class for creating a ChatClient.

It provides methods to set default values for various properties of the ChatClient.

Since:

1.0.0

Author:

Mark Pollack, Christian Tzolov, Josh Long, Arjen Poutsma, Thomas Vitale

Field Summary

Fields

Modifier and Type	Field	Description
protected final DefaultChatClient.DefaultChatClientRequestSpec	defaultRequest

Constructor Summary

Constructors

Constructor	Description
DefaultChatClientBuilder(ChatModel chatModel, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable ChatClientObservationConvention chatClientObservationConvention, @Nullable AdvisorObservationConvention advisorObservationConvention)	Deprecated, for removal: This API element is subject to removal in a future version.
DefaultChatClientBuilder(ChatModel chatModel, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable ChatClientObservationConvention chatClientObservationConvention, @Nullable AdvisorObservationConvention advisorObservationConvention, @Nullable ToolCallingAdvisor.Builder<?> toolCallingAdvisorBuilder)	Creates a new DefaultChatClientBuilder.

Method Summary

Modifier and Type	Method	Description
ChatClient	build()
ChatClient.Builder	clone()
ChatClient.Builder	defaultAdvisors(Consumer<ChatClient.AdvisorSpec> advisorSpecConsumer)
ChatClient.Builder	defaultAdvisors(List<Advisor> advisors)
ChatClient.Builder	defaultAdvisors(Advisor... advisors)
ChatClient.Builder	defaultOptions(ChatOptions.Builder customizer)
ChatClient.Builder	defaultSystem(String text)
ChatClient.Builder	defaultSystem(Consumer<ChatClient.PromptSystemSpec> systemSpecConsumer)
ChatClient.Builder	defaultSystem(org.springframework.core.io.Resource text)
ChatClient.Builder	defaultSystem(org.springframework.core.io.Resource text, Charset charset)
ChatClient.Builder	defaultTemplateRenderer(TemplateRenderer templateRenderer)
ChatClient.Builder	defaultToolCallbacks(List<ToolCallback> toolCallbacks)	Deprecated, for removal: This API element is subject to removal in a future version. as of 2.0.0, in favor of #defaultTools(Consumer).
ChatClient.Builder	defaultToolCallbacks(ToolCallback... toolCallbacks)	Deprecated, for removal: This API element is subject to removal in a future version. as of 2.0.0, in favor of defaultTools(Object...).
ChatClient.Builder	defaultToolCallbacks(ToolCallbackProvider... toolCallbackProviders)	Deprecated, for removal: This API element is subject to removal in a future version. as of 2.0.0, in favor of #defaultTools(Consumer).
ChatClient.Builder	defaultToolContext(Map<String,Object> toolContext)
ChatClient.Builder	defaultTools(Object... toolObjects)	Register one or more default tools that will be available to every request built from this ChatClient.Builder.
ChatClient.Builder	defaultUser(String text)
ChatClient.Builder	defaultUser(Consumer<ChatClient.PromptUserSpec> userSpecConsumer)
ChatClient.Builder	defaultUser(org.springframework.core.io.Resource text)
ChatClient.Builder	defaultUser(org.springframework.core.io.Resource text, Charset charset)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

defaultRequest

protected final DefaultChatClient.DefaultChatClientRequestSpec defaultRequest

Constructor Details

DefaultChatClientBuilder

@Deprecated(since="2.0.0",
            forRemoval=true)
public DefaultChatClientBuilder(ChatModel chatModel,
 io.micrometer.observation.ObservationRegistry observationRegistry,
 @Nullable ChatClientObservationConvention chatClientObservationConvention,
 @Nullable AdvisorObservationConvention advisorObservationConvention)

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

DefaultChatClientBuilder

public DefaultChatClientBuilder(ChatModel chatModel,
 io.micrometer.observation.ObservationRegistry observationRegistry,
 @Nullable ChatClientObservationConvention chatClientObservationConvention,
 @Nullable AdvisorObservationConvention advisorObservationConvention,
 @Nullable ToolCallingAdvisor.Builder<?> toolCallingAdvisorBuilder)

Creates a new DefaultChatClientBuilder.

When toolCallingAdvisorBuilder is null, a default ToolCallingAdvisor is created with a ToolCallingManager backed by the supplied observationRegistry.

When toolCallingAdvisorBuilder is non-null it is used as-is. The caller is then responsible for configuring the builder's ToolCallingManager, including any ObservationRegistry, since the supplied observationRegistry will not be automatically applied to it.

Parameters:

chatModel - the chat model to use

observationRegistry - the observation registry for client-level observations; also used to configure the default ToolCallingManager when toolCallingAdvisorBuilder is null

chatClientObservationConvention - optional custom observation convention for the chat client

advisorObservationConvention - optional custom observation convention for advisors

toolCallingAdvisorBuilder - optional builder for the ToolCallingAdvisor; when null a default is created

Method Details

build

public ChatClient build()

Specified by:

build in interface ChatClient.Builder

clone

public ChatClient.Builder clone()

Specified by:

clone in interface ChatClient.Builder

Overrides:

clone in class Object

defaultAdvisors

public ChatClient.Builder defaultAdvisors(Advisor... advisors)

Specified by:

defaultAdvisors in interface ChatClient.Builder

defaultAdvisors

public ChatClient.Builder defaultAdvisors(Consumer<ChatClient.AdvisorSpec> advisorSpecConsumer)

Specified by:

defaultAdvisors in interface ChatClient.Builder

defaultAdvisors

public ChatClient.Builder defaultAdvisors(List<Advisor> advisors)

Specified by:

defaultAdvisors in interface ChatClient.Builder

defaultOptions

public ChatClient.Builder defaultOptions(ChatOptions.Builder customizer)

Specified by:

defaultOptions in interface ChatClient.Builder

defaultUser

public ChatClient.Builder defaultUser(String text)

Specified by:

defaultUser in interface ChatClient.Builder

defaultUser

public ChatClient.Builder defaultUser(org.springframework.core.io.Resource text,
 Charset charset)

Specified by:

defaultUser in interface ChatClient.Builder

defaultUser

public ChatClient.Builder defaultUser(org.springframework.core.io.Resource text)

Specified by:

defaultUser in interface ChatClient.Builder

defaultUser

public ChatClient.Builder defaultUser(Consumer<ChatClient.PromptUserSpec> userSpecConsumer)

Specified by:

defaultUser in interface ChatClient.Builder

defaultSystem

public ChatClient.Builder defaultSystem(String text)

Specified by:

defaultSystem in interface ChatClient.Builder

defaultSystem

public ChatClient.Builder defaultSystem(org.springframework.core.io.Resource text,
 Charset charset)

Specified by:

defaultSystem in interface ChatClient.Builder

defaultSystem

public ChatClient.Builder defaultSystem(org.springframework.core.io.Resource text)

Specified by:

defaultSystem in interface ChatClient.Builder

defaultSystem

public ChatClient.Builder defaultSystem(Consumer<ChatClient.PromptSystemSpec> systemSpecConsumer)

Specified by:

defaultSystem in interface ChatClient.Builder

defaultTools

public ChatClient.Builder defaultTools(Object... toolObjects)

Description copied from interface: ChatClient.Builder

Register one or more default tools that will be available to every request built from this ChatClient.Builder. The method accepts the same heterogeneous mix of tool representations as ChatClient.ChatClientRequestSpec.tools(Object...) and applies the same automatic dispatch rules:

• ToolCallback — registered directly as a callback.
• ToolCallbackProvider — registered directly as a provider; its callbacks are resolved lazily at request time.
• ToolCallback[] or ToolCallbackProvider[] — every element of the array is registered as above.
• Collection — iterated and each element is dispatched by the same rules.
• Any other object — treated as a @Tool-annotated POJO; a ToolCallback is generated for each Tool-annotated method it contains.

Default tools are shared across all requests produced by ChatClient instances built from this builder. If a request also provides its own tools via ChatClient.ChatClientRequestSpec.tools(Object...), those runtime tools completely override the defaults for that request.

WARNING: Because default tools are shared, be careful not to register tools that should only be available in specific contexts.

Specified by:

defaultTools in interface ChatClient.Builder

Parameters:

toolObjects - tool objects to register; must not be null and must not contain null elements

Returns:

this builder for chaining

defaultToolCallbacks

@Deprecated(since="2.0.0",
            forRemoval=true)
public ChatClient.Builder defaultToolCallbacks(ToolCallback... toolCallbacks)

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

as of 2.0.0, in favor of defaultTools(Object...). To be removed in 3.0.0.

Specified by:

defaultToolCallbacks in interface ChatClient.Builder

defaultToolCallbacks

@Deprecated(since="2.0.0",
            forRemoval=true)
public ChatClient.Builder defaultToolCallbacks(List<ToolCallback> toolCallbacks)

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.

Specified by:

defaultToolCallbacks in interface ChatClient.Builder

defaultToolCallbacks

@Deprecated(since="2.0.0",
            forRemoval=true)
public ChatClient.Builder defaultToolCallbacks(ToolCallbackProvider... toolCallbackProviders)

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.

Specified by:

defaultToolCallbacks in interface ChatClient.Builder

defaultToolContext

public ChatClient.Builder defaultToolContext(Map<String,Object> toolContext)

Specified by:

defaultToolContext in interface ChatClient.Builder

defaultTemplateRenderer

public ChatClient.Builder defaultTemplateRenderer(TemplateRenderer templateRenderer)

Specified by:

defaultTemplateRenderer in interface ChatClient.Builder