Class ChatExecutor.AbstractBuilder<T extends ChatExecutor.AbstractBuilder<T>>

java.lang.Object

dev.langchain4j.guardrail.ChatExecutor.AbstractBuilder<T>

Type Parameters:

T - the type of the builder subclass for enabling fluent method chaining

Direct Known Subclasses:

ChatExecutor.StreamingToSynchronousBuilder, ChatExecutor.SynchronousBuilder

Enclosing interface:

ChatExecutor

public abstract static class ChatExecutor.AbstractBuilder<T extends ChatExecutor.AbstractBuilder<T>>
extends Object

An abstract base-builder class for constructing instances of ChatExecutor. This class provides a fluent API for setting required components, such as ChatRequest, and defines a contract for building ChatExecutor instances. Subclasses should implement the build() method to ensure proper construction of the target chat executor object.

Field Summary

Fields

Modifier and Type	Field	Description
protected ChatRequest	chatRequest
protected AiServiceListenerRegistrar	eventListenerRegistrar
protected InvocationContext	invocationContext

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
abstract ChatExecutor	build()	Constructs and returns an instance of ChatExecutor.
ChatExecutor.AbstractBuilder<T>	chatRequest(ChatRequest chatRequest)	Sets the ChatRequest instance for the synchronousBuilder.
ChatExecutor.AbstractBuilder<T>	eventListenerRegistrar(AiServiceListenerRegistrar eventListenerRegistrar)	Sets the AiServiceListenerRegistrar instance for the builder.
ChatExecutor.AbstractBuilder<T>	invocationContext(InvocationContext invocationContext)	Sets the InvocationContext instance for the builder.

Methods inherited from class Object

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

Field Details

chatRequest

protected ChatRequest chatRequest

invocationContext

protected InvocationContext invocationContext

eventListenerRegistrar

protected AiServiceListenerRegistrar eventListenerRegistrar

Constructor Details

AbstractBuilder

protected AbstractBuilder()

Method Details

chatRequest

public ChatExecutor.AbstractBuilder<T> chatRequest(ChatRequest chatRequest)

Sets the ChatRequest instance for the synchronousBuilder. The ChatRequest encapsulates the input messages and parameters required to generate a response from the chat model.

Parameters:

chatRequest - the ChatRequest containing the input messages and parameters

Returns:

the updated SynchronousBuilder instance

invocationContext

public ChatExecutor.AbstractBuilder<T> invocationContext(InvocationContext invocationContext)

Sets the InvocationContext instance for the builder. The InvocationContext provides contextual information that can be used during the execution of the chat request.

Parameters:

invocationContext - the InvocationContext containing contextual information

Returns:

the updated builder instance of type T for method chaining

eventListenerRegistrar

public ChatExecutor.AbstractBuilder<T> eventListenerRegistrar(AiServiceListenerRegistrar eventListenerRegistrar)

Sets the AiServiceListenerRegistrar instance for the builder. The AiServiceListenerRegistrar facilitates the registration and management of AiServiceListeners, allowing the builder to configure event listeners for handling AiServiceEvents.

Parameters:

eventListenerRegistrar - the AiServiceListenerRegistrar to use for managing event listeners

Returns:

the updated builder instance of type T for method chaining

build

public abstract ChatExecutor build()

Constructs and returns an instance of ChatExecutor. Ensures that all required parameters have been appropriately set before building the ChatExecutor.

Returns:

a fully constructed ChatExecutor instance