Package org.springframework.ai.chat.client

Interface ChatClient

All Known Implementing Classes:

DefaultChatClient

public interface ChatClient

Client to perform stateless requests to an AI Model, using a fluent API.

Use builder(ChatModel) to prepare an instance.

Since:

1.0.0

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ChatClient.AdvisorSpec
static interface	ChatClient.Builder	A mutable builder for creating a ChatClient.
static interface	ChatClient.CallResponseSpec
static interface	ChatClient.ChatClientRequestSpec
static interface	ChatClient.EntityParamSpec	Configures optional behaviour for entity(...) calls.
static interface	ChatClient.PromptSystemSpec	Specification for a prompt system.
static interface	ChatClient.PromptUserSpec
static interface	ChatClient.StreamResponseSpec

Method Summary

Modifier and Type	Method	Description
static ChatClient.Builder	builder(org.springframework.ai.chat.model.ChatModel chatModel)
static ChatClient.Builder	builder(org.springframework.ai.chat.model.ChatModel chatModel, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable ChatClientObservationConvention chatClientObservationConvention, @Nullable AdvisorObservationConvention advisorObservationConvention)
static ChatClient.Builder	builder(org.springframework.ai.chat.model.ChatModel chatModel, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable ChatClientObservationConvention chatClientObservationConvention, @Nullable AdvisorObservationConvention advisorObservationConvention, @Nullable ToolCallingAdvisor.Builder<?> toolCallingAdvisorBuilder)	Creates a ChatClient.Builder for constructing a ChatClient.
static ChatClient	create(org.springframework.ai.chat.model.ChatModel chatModel)
static ChatClient	create(org.springframework.ai.chat.model.ChatModel chatModel, io.micrometer.observation.ObservationRegistry observationRegistry)
static ChatClient	create(org.springframework.ai.chat.model.ChatModel chatModel, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable ChatClientObservationConvention chatClientObservationConvention, @Nullable AdvisorObservationConvention advisorObservationConvention)
ChatClient.Builder	mutate()	Return a ChatClient.Builder to create a new ChatClient whose settings are replicated from the default ChatClient.ChatClientRequestSpec of this client.
ChatClient.ChatClientRequestSpec	prompt()
ChatClient.ChatClientRequestSpec	prompt(String content)
ChatClient.ChatClientRequestSpec	prompt(org.springframework.ai.chat.prompt.Prompt prompt)

Method Details

create

static ChatClient create(org.springframework.ai.chat.model.ChatModel chatModel)

create

static ChatClient create(org.springframework.ai.chat.model.ChatModel chatModel,
 io.micrometer.observation.ObservationRegistry observationRegistry)

create

static ChatClient create(org.springframework.ai.chat.model.ChatModel chatModel,
 io.micrometer.observation.ObservationRegistry observationRegistry,
 @Nullable ChatClientObservationConvention chatClientObservationConvention,
 @Nullable AdvisorObservationConvention advisorObservationConvention)

builder

static ChatClient.Builder builder(org.springframework.ai.chat.model.ChatModel chatModel)

builder

static ChatClient.Builder builder(org.springframework.ai.chat.model.ChatModel chatModel,
 io.micrometer.observation.ObservationRegistry observationRegistry,
 @Nullable ChatClientObservationConvention chatClientObservationConvention,
 @Nullable AdvisorObservationConvention advisorObservationConvention)

builder

static ChatClient.Builder builder(org.springframework.ai.chat.model.ChatModel chatModel,
 io.micrometer.observation.ObservationRegistry observationRegistry,
 @Nullable ChatClientObservationConvention chatClientObservationConvention,
 @Nullable AdvisorObservationConvention advisorObservationConvention,
 @Nullable ToolCallingAdvisor.Builder<?> toolCallingAdvisorBuilder)

Creates a ChatClient.Builder for constructing a ChatClient.

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

Returns:

a new ChatClient.Builder

prompt

ChatClient.ChatClientRequestSpec prompt()

prompt

ChatClient.ChatClientRequestSpec prompt(String content)

prompt

ChatClient.ChatClientRequestSpec prompt(org.springframework.ai.chat.prompt.Prompt prompt)

mutate

ChatClient.Builder mutate()

Return a ChatClient.Builder to create a new ChatClient whose settings are replicated from the default ChatClient.ChatClientRequestSpec of this client.