Package dev.langchain4j.guardrail

Interface ChatExecutor

public interface ChatExecutor

Generic executor interface that defines a chat interaction

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ChatExecutor.AbstractBuilder<T extends ChatExecutor.AbstractBuilder<T>>	An abstract base-builder class for constructing instances of ChatExecutor.
static class	ChatExecutor.StreamingToSynchronousBuilder	StreamingToSynchronousBuilder for constructing instances of ChatExecutor.
static class	ChatExecutor.SynchronousBuilder	SynchronousBuilder for constructing instances of ChatExecutor.

Method Summary

Modifier and Type	Method	Description
static ChatExecutor.SynchronousBuilder	builder(ChatModel chatModel)	Creates a new ChatExecutor.SynchronousBuilder instance for constructing ChatExecutor objects that perform synchronous chat requests.
static ChatExecutor.StreamingToSynchronousBuilder	builder(StreamingChatModel streamingChatModel)	Creates a new ChatExecutor.StreamingToSynchronousBuilder instance for constructing ChatExecutor objects that perform streaming chat requests.
ChatResponse	execute()	Execute a chat request
ChatResponse	execute(List<ChatMessage> chatMessages)	Executes a chat request using the provided chat messages

Method Details

execute

ChatResponse execute()

Execute a chat request

Returns:

The response

execute

ChatResponse execute(List<ChatMessage> chatMessages)

Executes a chat request using the provided chat messages

Parameters:

chatMessages - The chat messages containing the context of the conversation. It provides the history of messages required for proper interaction with the chat model

Returns:

A response object containing the AI's response and additional metadata.

builder

static ChatExecutor.SynchronousBuilder builder(ChatModel chatModel)

Creates a new ChatExecutor.SynchronousBuilder instance for constructing ChatExecutor objects that perform synchronous chat requests.

Returns:

A new ChatExecutor.SynchronousBuilder instance to configure and build a ChatExecutor.

builder

static ChatExecutor.StreamingToSynchronousBuilder builder(StreamingChatModel streamingChatModel)

Creates a new ChatExecutor.StreamingToSynchronousBuilder instance for constructing ChatExecutor objects that perform streaming chat requests.

Returns:

A new ChatExecutor.StreamingToSynchronousBuilder instance to configure and build a ChatExecutor.