Package org.springframework.ai.chat.client

Interface ChatClient.ChatClientRequestSpec

All Known Implementing Classes:

DefaultChatClient.DefaultChatClientRequestSpec

Enclosing interface:

ChatClient

public static interface ChatClient.ChatClientRequestSpec

Method Summary

Modifier and Type	Method	Description
ChatClient.ChatClientRequestSpec	advisors(Consumer<ChatClient.AdvisorSpec> consumer)
ChatClient.ChatClientRequestSpec	advisors(List<Advisor> advisors)
ChatClient.ChatClientRequestSpec	advisors(Advisor... advisors)
ChatClient.CallResponseSpec	call()
ChatClient.ChatClientRequestSpec	messages(List<Message> messages)
ChatClient.ChatClientRequestSpec	messages(Message... messages)
ChatClient.Builder	mutate()	Return a ChatClient.Builder to create a new ChatClient whose settings are replicated from this ChatClientRequest.
<B extends ChatOptions.Builder<?>> ChatClient.ChatClientRequestSpec	options(B customizer)
ChatClient.StreamResponseSpec	stream()
ChatClient.ChatClientRequestSpec	system(String text)
ChatClient.ChatClientRequestSpec	system(Consumer<ChatClient.PromptSystemSpec> consumer)
ChatClient.ChatClientRequestSpec	system(org.springframework.core.io.Resource text)
ChatClient.ChatClientRequestSpec	system(org.springframework.core.io.Resource textResource, Charset charset)
ChatClient.ChatClientRequestSpec	templateRenderer(TemplateRenderer templateRenderer)
ChatClient.ChatClientRequestSpec	toolCallbacks(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 tools(Object...).
ChatClient.ChatClientRequestSpec	toolCallbacks(ToolCallback... toolCallbacks)	Deprecated, for removal: This API element is subject to removal in a future version. as of 2.0.0, in favor of tools(Object...).
ChatClient.ChatClientRequestSpec	toolCallbacks(ToolCallbackProvider... toolCallbackProviders)	Deprecated, for removal: This API element is subject to removal in a future version. as of 2.0.0, in favor of tools(Object...).
ChatClient.ChatClientRequestSpec	toolContext(Map<String,Object> toolContext)
ChatClient.ChatClientRequestSpec	tools(Object... tools)	Register one or more tools for this chat request.
ChatClient.ChatClientRequestSpec	user(String text)
ChatClient.ChatClientRequestSpec	user(Consumer<ChatClient.PromptUserSpec> consumer)
ChatClient.ChatClientRequestSpec	user(org.springframework.core.io.Resource text)
ChatClient.ChatClientRequestSpec	user(org.springframework.core.io.Resource text, Charset charset)

Method Details

mutate

ChatClient.Builder mutate()

Return a ChatClient.Builder to create a new ChatClient whose settings are replicated from this ChatClientRequest.

advisors

ChatClient.ChatClientRequestSpec advisors(Consumer<ChatClient.AdvisorSpec> consumer)

advisors

ChatClient.ChatClientRequestSpec advisors(Advisor... advisors)

advisors

ChatClient.ChatClientRequestSpec advisors(List<Advisor> advisors)

messages

ChatClient.ChatClientRequestSpec messages(Message... messages)

messages

ChatClient.ChatClientRequestSpec messages(List<Message> messages)

options

<B extends ChatOptions.Builder<?>>
ChatClient.ChatClientRequestSpec options(B customizer)

tools

ChatClient.ChatClientRequestSpec tools(Object... tools)

Register one or more tools for this chat request. The method accepts a heterogeneous mix of tool representations and routes each element to the appropriate internal list automatically:

• 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.

Mixed calls are fully supported:

 chatClient.prompt()
     .tools(new DateTimeTools(), existingCallback, myProvider)
     .toolContext(Map.of("tenantId", "acme"))
     .call().content();
 

Tools registered here are available only for this specific request. Use ChatClient.Builder.defaultTools(Object...) to register tools that apply to every request built from the same ChatClient.Builder.

Parameters:

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

Returns:

this spec for chaining

Throws:

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

toolCallbacks

@Deprecated(since="2.0.0",
            forRemoval=true)
ChatClient.ChatClientRequestSpec toolCallbacks(ToolCallback... toolCallbacks)

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

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

toolCallbacks

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

toolCallbacks

@Deprecated(since="2.0.0",
            forRemoval=true)
ChatClient.ChatClientRequestSpec toolCallbacks(ToolCallbackProvider... toolCallbackProviders)

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

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

toolContext

ChatClient.ChatClientRequestSpec toolContext(Map<String,Object> toolContext)

system

ChatClient.ChatClientRequestSpec system(String text)

system

ChatClient.ChatClientRequestSpec system(org.springframework.core.io.Resource textResource,
 Charset charset)

system

ChatClient.ChatClientRequestSpec system(org.springframework.core.io.Resource text)

system

ChatClient.ChatClientRequestSpec system(Consumer<ChatClient.PromptSystemSpec> consumer)

user

ChatClient.ChatClientRequestSpec user(String text)

user

ChatClient.ChatClientRequestSpec user(org.springframework.core.io.Resource text,
 Charset charset)

user

ChatClient.ChatClientRequestSpec user(org.springframework.core.io.Resource text)

user

ChatClient.ChatClientRequestSpec user(Consumer<ChatClient.PromptUserSpec> consumer)

templateRenderer

ChatClient.ChatClientRequestSpec templateRenderer(TemplateRenderer templateRenderer)

call

ChatClient.CallResponseSpec call()

stream

ChatClient.StreamResponseSpec stream()