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<org.springframework.ai.chat.messages.Message> messages)
ChatClient.ChatClientRequestSpec	messages(org.springframework.ai.chat.messages.Message... messages)
ChatClient.Builder	mutate()	Return a ChatClient.Builder to create a new ChatClient whose settings are replicated from this ChatClientRequest.
<B extends org.springframework.ai.chat.prompt.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(org.springframework.ai.template.TemplateRenderer templateRenderer)
ChatClient.ChatClientRequestSpec	toolCallbacks(List<org.springframework.ai.tool.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(Consumer) and tools(Consumer<ToolSpec>) To be removed in 3.0.0.
ChatClient.ChatClientRequestSpec	toolCallbacks(org.springframework.ai.tool.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(Consumer) and tools(Consumer<ToolSpec>) To be removed in 3.0.0.
ChatClient.ChatClientRequestSpec	toolCallbacks(org.springframework.ai.tool.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(Consumer) and tools(Consumer<ToolSpec>) To be removed in 3.0.0.
ChatClient.ChatClientRequestSpec	toolContext(Map<String,Object> toolContext)	Deprecated, for removal: This API element is subject to removal in a future version. as of 2.0.0, in favor of tools(Consumer) and tools(Consumer<ToolSpec>) To be removed in 3.0.0.
ChatClient.ChatClientRequestSpec	toolNames(String... toolNames)	Deprecated, for removal: This API element is subject to removal in a future version. as of 2.0.0, in favor of tools(Consumer).
ChatClient.ChatClientRequestSpec	tools(Object... toolObjects)
ChatClient.ChatClientRequestSpec	tools(Consumer<ChatClient.ToolSpec> consumer)
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(org.springframework.ai.chat.messages.Message... messages)

messages

ChatClient.ChatClientRequestSpec messages(List<org.springframework.ai.chat.messages.Message> messages)

options

<B extends org.springframework.ai.chat.prompt.ChatOptions.Builder<?>>
ChatClient.ChatClientRequestSpec options(B customizer)

tools

ChatClient.ChatClientRequestSpec tools(Consumer<ChatClient.ToolSpec> consumer)

tools

ChatClient.ChatClientRequestSpec tools(Object... toolObjects)

toolNames

@Deprecated(since="2.0.0",
            forRemoval=true)
ChatClient.ChatClientRequestSpec toolNames(String... toolNames)

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

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

toolCallbacks

@Deprecated(since="2.0.0",
            forRemoval=true)
ChatClient.ChatClientRequestSpec toolCallbacks(org.springframework.ai.tool.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(Consumer) and tools(Consumer<ToolSpec>) To be removed in 3.0.0.

toolCallbacks

@Deprecated(since="2.0.0",
            forRemoval=true)
ChatClient.ChatClientRequestSpec toolCallbacks(List<org.springframework.ai.tool.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(Consumer) and tools(Consumer<ToolSpec>) To be removed in 3.0.0.

toolCallbacks

@Deprecated(since="2.0.0",
            forRemoval=true)
ChatClient.ChatClientRequestSpec toolCallbacks(org.springframework.ai.tool.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(Consumer) and tools(Consumer<ToolSpec>) To be removed in 3.0.0.

toolContext

@Deprecated(since="2.0.0",
            forRemoval=true)
ChatClient.ChatClientRequestSpec toolContext(Map<String,Object> toolContext)

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

as of 2.0.0, in favor of tools(Consumer) and tools(Consumer<ToolSpec>) To be removed in 3.0.0.

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(org.springframework.ai.template.TemplateRenderer templateRenderer)

call

ChatClient.CallResponseSpec call()

stream

ChatClient.StreamResponseSpec stream()