Package org.springframework.ai.chat.client

Interface ChatClient.Builder

All Known Implementing Classes:

DefaultChatClientBuilder

Enclosing interface:

ChatClient

public static interface ChatClient.Builder

A mutable builder for creating a ChatClient.

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 chatOptions)
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(Object...).
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(Object...).
ChatClient.Builder	defaultToolContext(Map<String,Object> toolContext)
ChatClient.Builder	defaultTools(Object... tools)	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)

Method Details

defaultAdvisors

ChatClient.Builder defaultAdvisors(Advisor... advisors)

defaultAdvisors

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

defaultAdvisors

ChatClient.Builder defaultAdvisors(List<Advisor> advisors)

defaultOptions

ChatClient.Builder defaultOptions(ChatOptions.Builder chatOptions)

defaultUser

ChatClient.Builder defaultUser(String text)

defaultUser

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

defaultUser

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

defaultUser

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

defaultSystem

ChatClient.Builder defaultSystem(String text)

defaultSystem

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

defaultSystem

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

defaultSystem

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

defaultTemplateRenderer

ChatClient.Builder defaultTemplateRenderer(TemplateRenderer templateRenderer)

defaultTools

ChatClient.Builder defaultTools(Object... tools)

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.

Parameters:

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

Returns:

this builder for chaining

Throws:

IllegalArgumentException - if tools is null, contains null elements, or if a POJO argument has no Tool-annotated methods

defaultToolCallbacks

@Deprecated(since="2.0.0",
            forRemoval=true)
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.

defaultToolCallbacks

@Deprecated(since="2.0.0",
            forRemoval=true)
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(Object...). To be removed in 3.0.0.

defaultToolCallbacks

@Deprecated(since="2.0.0",
            forRemoval=true)
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(Object...). To be removed in 3.0.0.

defaultToolContext

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

clone

ChatClient.Builder clone()

build

ChatClient build()