Package org.springframework.ai.chat.client

Class DefaultChatClient.DefaultChatClientRequestSpec

java.lang.Object

org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec

All Implemented Interfaces:

ChatClient.ChatClientRequestSpec

Enclosing class:

DefaultChatClient

public static class DefaultChatClient.DefaultChatClientRequestSpec
extends Object
implements ChatClient.ChatClientRequestSpec

Constructor Summary

Constructors

Constructor

Description

DefaultChatClientRequestSpec(ChatModel chatModel, @Nullable String userText, Map<String,Object> userParams, Map<String,Object> userMetadata, @Nullable String systemText, Map<String,Object> systemParams, Map<String,Object> systemMetadata, List<ToolCallback> toolCallbacks, List<ToolCallbackProvider> toolCallbackProviders, List<Message> messages, List<Media> media, @Nullable ChatOptions.Builder<?> customizer, List<Advisor> advisors, Map<String,Object> advisorParams, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable ChatClientObservationConvention chatClientObservationConvention, Map<String,Object> toolContext, @Nullable TemplateRenderer templateRenderer, @Nullable AdvisorObservationConvention advisorObservationConvention, ToolCallingAdvisor.Builder<?> toolCallingAdvisorBuilder)

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()
Map<String,Object>	getAdvisorParams()
List<Advisor>	getAdvisors()
List<Media>	getMedia()
List<Message>	getMessages()
Map<String,Object>	getSystemMetadata()
Map<String,Object>	getSystemParams()
@Nullable String	getSystemText()
TemplateRenderer	getTemplateRenderer()
List<ToolCallbackProvider>	getToolCallbackProviders()
List<ToolCallback>	getToolCallbacks()
Map<String,Object>	getToolContext()
Map<String,Object>	getUserMetadata()
Map<String,Object>	getUserParams()
@Nullable String	getUserText()
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 text, Charset charset)
ChatClient.ChatClientRequestSpec	templateRenderer(TemplateRenderer templateRenderer)
ChatClient.ChatClientRequestSpec	toolCallbacks(List<ToolCallback> toolCallbacks)
ChatClient.ChatClientRequestSpec	toolCallbacks(ToolCallback... toolCallbacks)
ChatClient.ChatClientRequestSpec	toolCallbacks(ToolCallbackProvider... toolCallbackProviders)
ChatClient.ChatClientRequestSpec	toolContext(Map<String,Object> toolContext)
ChatClient.ChatClientRequestSpec	tools(Object... toolObjects)	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)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultChatClientRequestSpec

public DefaultChatClientRequestSpec(ChatModel chatModel,
 @Nullable String userText,
 Map<String,Object> userParams,
 Map<String,Object> userMetadata,
 @Nullable String systemText,
 Map<String,Object> systemParams,
 Map<String,Object> systemMetadata,
 List<ToolCallback> toolCallbacks,
 List<ToolCallbackProvider> toolCallbackProviders,
 List<Message> messages,
 List<Media> media,
 @Nullable ChatOptions.Builder<?> customizer,
 List<Advisor> advisors,
 Map<String,Object> advisorParams,
 io.micrometer.observation.ObservationRegistry observationRegistry,
 @Nullable ChatClientObservationConvention chatClientObservationConvention,
 Map<String,Object> toolContext,
 @Nullable TemplateRenderer templateRenderer,
 @Nullable AdvisorObservationConvention advisorObservationConvention,
 ToolCallingAdvisor.Builder<?> toolCallingAdvisorBuilder)

Method Details

getUserText

public @Nullable String getUserText()

getUserParams

public Map<String,Object> getUserParams()

getUserMetadata

public Map<String,Object> getUserMetadata()

getSystemText

public @Nullable String getSystemText()

getSystemParams

public Map<String,Object> getSystemParams()

getSystemMetadata

public Map<String,Object> getSystemMetadata()

getAdvisors

public List<Advisor> getAdvisors()

getAdvisorParams

public Map<String,Object> getAdvisorParams()

getMessages

public List<Message> getMessages()

getMedia

public List<Media> getMedia()

getToolCallbacks

public List<ToolCallback> getToolCallbacks()

getToolCallbackProviders

public List<ToolCallbackProvider> getToolCallbackProviders()

getToolContext

public Map<String,Object> getToolContext()

getTemplateRenderer

public TemplateRenderer getTemplateRenderer()

mutate

public ChatClient.Builder mutate()

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

Specified by:

mutate in interface ChatClient.ChatClientRequestSpec

advisors

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

Specified by:

advisors in interface ChatClient.ChatClientRequestSpec

advisors

public ChatClient.ChatClientRequestSpec advisors(Advisor... advisors)

Specified by:

advisors in interface ChatClient.ChatClientRequestSpec

advisors

public ChatClient.ChatClientRequestSpec advisors(List<Advisor> advisors)

Specified by:

advisors in interface ChatClient.ChatClientRequestSpec

messages

public ChatClient.ChatClientRequestSpec messages(Message... messages)

Specified by:

messages in interface ChatClient.ChatClientRequestSpec

messages

public ChatClient.ChatClientRequestSpec messages(List<Message> messages)

Specified by:

messages in interface ChatClient.ChatClientRequestSpec

options

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

Specified by:

options in interface ChatClient.ChatClientRequestSpec

toolCallbacks

public ChatClient.ChatClientRequestSpec toolCallbacks(ToolCallback... toolCallbacks)

Specified by:

toolCallbacks in interface ChatClient.ChatClientRequestSpec

toolCallbacks

public ChatClient.ChatClientRequestSpec toolCallbacks(List<ToolCallback> toolCallbacks)

Specified by:

toolCallbacks in interface ChatClient.ChatClientRequestSpec

tools

public ChatClient.ChatClientRequestSpec tools(Object... toolObjects)

Description copied from interface: ChatClient.ChatClientRequestSpec

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.

Specified by:

tools in interface ChatClient.ChatClientRequestSpec

Parameters:

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

Returns:

this spec for chaining

toolCallbacks

public ChatClient.ChatClientRequestSpec toolCallbacks(ToolCallbackProvider... toolCallbackProviders)

Specified by:

toolCallbacks in interface ChatClient.ChatClientRequestSpec

toolContext

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

Specified by:

toolContext in interface ChatClient.ChatClientRequestSpec

system

public ChatClient.ChatClientRequestSpec system(String text)

Specified by:

system in interface ChatClient.ChatClientRequestSpec

system

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

Specified by:

system in interface ChatClient.ChatClientRequestSpec

system

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

Specified by:

system in interface ChatClient.ChatClientRequestSpec

system

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

Specified by:

system in interface ChatClient.ChatClientRequestSpec

user

public ChatClient.ChatClientRequestSpec user(String text)

Specified by:

user in interface ChatClient.ChatClientRequestSpec

user

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

Specified by:

user in interface ChatClient.ChatClientRequestSpec

user

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

Specified by:

user in interface ChatClient.ChatClientRequestSpec

user

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

Specified by:

user in interface ChatClient.ChatClientRequestSpec

templateRenderer

public ChatClient.ChatClientRequestSpec templateRenderer(TemplateRenderer templateRenderer)

Specified by:

templateRenderer in interface ChatClient.ChatClientRequestSpec

call

public ChatClient.CallResponseSpec call()

Specified by:

call in interface ChatClient.ChatClientRequestSpec

stream

public ChatClient.StreamResponseSpec stream()

Specified by:

stream in interface ChatClient.ChatClientRequestSpec