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.CallPromptResponseSpec
static interface	ChatClient.CallResponseSpec
static interface	ChatClient.ChatClientRequestSpec
static interface	ChatClient.PromptSystemSpec	Specification for a prompt system.
static interface	ChatClient.PromptUserSpec
static interface	ChatClient.StreamPromptResponseSpec
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, ChatClientObservationConvention customObservationConvention)
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, ChatClientObservationConvention observationConvention)
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 observationConvention)

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 customObservationConvention)

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.