Class AiServiceTokenStreamParameters.Builder

java.lang.Object

dev.langchain4j.service.AiServiceTokenStreamParameters.Builder

Enclosing class:

AiServiceTokenStreamParameters

public static class AiServiceTokenStreamParameters.Builder
extends Object

Builder for AiServiceTokenStreamParameters.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
AiServiceTokenStreamParameters.Builder	availableTools(List<ToolSpecification> availableTools)	Deprecated. use toolServiceContext(ToolServiceContext) instead
AiServiceTokenStreamParameters	build()	Builds a new AiServiceTokenStreamParameters.
AiServiceTokenStreamParameters.Builder	commonGuardrailParams(GuardrailRequestParams commonGuardrailParams)	Sets the common guardrail parameters for validating interactions between a user and a language model.
AiServiceTokenStreamParameters.Builder	completeResponseProcessingExecutor(Executor completeResponseProcessingExecutor)	Sets the executor that processes each complete response received from the StreamingChatModel: updating the chat memory, executing the requested tools (or, when toolExecutor(Executor) is set, waiting for their results), sending the next request to the model, running the output guardrails, firing the AI Service listener events and invoking TokenStream.onIntermediateResponse(java.util.function.Consumer) and TokenStream.onCompleteResponse(java.util.function.Consumer).
AiServiceTokenStreamParameters.Builder	context(AiServiceContext context)	Sets the AI service context.
AiServiceTokenStreamParameters.Builder	effectiveTools(List<ToolSpecification> effectiveTools)	Deprecated. use toolServiceContext(ToolServiceContext) instead
AiServiceTokenStreamParameters.Builder	invocationContext(InvocationContext invocationContext)
AiServiceTokenStreamParameters.Builder	messages(List<ChatMessage> messages)	Sets the messages.
AiServiceTokenStreamParameters.Builder	methodKey(Object methodKey)	Sets the method key.
AiServiceTokenStreamParameters.Builder	retrievedContents(List<Content> retrievedContents)	Sets the retrieved contents.
AiServiceTokenStreamParameters.Builder	toolArgumentsErrorHandler(ToolArgumentsErrorHandler handler)
AiServiceTokenStreamParameters.Builder	toolExecutionErrorHandler(ToolExecutionErrorHandler handler)
AiServiceTokenStreamParameters.Builder	toolExecutor(Executor toolExecutor)
AiServiceTokenStreamParameters.Builder	toolExecutors(Map<String, ToolExecutor> toolExecutors)	Deprecated. use toolServiceContext(ToolServiceContext) instead
AiServiceTokenStreamParameters.Builder	toolServiceContext(ToolServiceContext toolServiceContext)	Sets the tool service context.
AiServiceTokenStreamParameters.Builder	toolSpecifications(List<ToolSpecification> toolSpecifications)	Deprecated. use toolServiceContext(ToolServiceContext) instead

Methods inherited from class Object

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

Constructor Details

Builder

protected Builder()

Method Details

messages

public AiServiceTokenStreamParameters.Builder messages(List<ChatMessage> messages)

Sets the messages.

Parameters:

messages - the messages

Returns:

this builder

toolServiceContext

public AiServiceTokenStreamParameters.Builder toolServiceContext(ToolServiceContext toolServiceContext)

Sets the tool service context.

Since:

1.13.0

effectiveTools

@Deprecated(since="1.13.0")
public AiServiceTokenStreamParameters.Builder effectiveTools(List<ToolSpecification> effectiveTools)

Deprecated.

use toolServiceContext(ToolServiceContext) instead

Sets effective tool specifications that should be included in the next ChatRequest.

See Also:

• availableTools(List)

toolSpecifications

@Deprecated(since="1.12.0")
public AiServiceTokenStreamParameters.Builder toolSpecifications(List<ToolSpecification> toolSpecifications)

Deprecated.

use toolServiceContext(ToolServiceContext) instead

Sets tool specifications that should be included in the next ChatRequest.

availableTools

@Deprecated(since="1.13.0")
public AiServiceTokenStreamParameters.Builder availableTools(List<ToolSpecification> availableTools)

Deprecated.

use toolServiceContext(ToolServiceContext) instead

Sets all available tool specifications configured for AI service.

See Also:

• effectiveTools(List)

toolExecutors

@Deprecated(since="1.13.0")
public AiServiceTokenStreamParameters.Builder toolExecutors(Map<String, ToolExecutor> toolExecutors)

Deprecated.

use toolServiceContext(ToolServiceContext) instead

Sets the tool executors.

toolArgumentsErrorHandler

public AiServiceTokenStreamParameters.Builder toolArgumentsErrorHandler(ToolArgumentsErrorHandler handler)

Since:

1.4.0

toolExecutionErrorHandler

public AiServiceTokenStreamParameters.Builder toolExecutionErrorHandler(ToolExecutionErrorHandler handler)

Since:

1.4.0

toolExecutor

public AiServiceTokenStreamParameters.Builder toolExecutor(Executor toolExecutor)

Since:

1.4.0

completeResponseProcessingExecutor

public AiServiceTokenStreamParameters.Builder completeResponseProcessingExecutor(Executor completeResponseProcessingExecutor)

Sets the executor that processes each complete response received from the StreamingChatModel: updating the chat memory, executing the requested tools (or, when toolExecutor(Executor) is set, waiting for their results), sending the next request to the model, running the output guardrails, firing the AI Service listener events and invoking TokenStream.onIntermediateResponse(java.util.function.Consumer) and TokenStream.onCompleteResponse(java.util.function.Consumer). Partial responses are still delivered on the thread of the StreamingChatModel.

If not set (or null), the response is processed on the thread that delivers it, which is usually a thread of the HTTP client used by the StreamingChatModel. Use this executor when that thread must not be blocked (e.g., an event loop thread) and the processing can block (e.g., a tool, a chat memory store or an output guardrail doing I/O). The executor can also decide per task whether to run it on the calling thread. The context captured with ExecutorProvider.captureContext() when the AI Service was invoked is restored on the executor's thread. LangChain4j never shuts the executor down.

Anything thrown while processing the response, including an Error, is passed to TokenStream.onError(java.util.function.Consumer). So is an exception thrown by the executor itself (e.g., RejectedExecutionException), on the thread that delivered the response.

Ignored by AiServiceStreamingEventPublisher, which does not block the thread that delivers the response.

Since:

1.23.0

retrievedContents

public AiServiceTokenStreamParameters.Builder retrievedContents(List<Content> retrievedContents)

Sets the retrieved contents.

Parameters:

retrievedContents - the retrieved contents

Returns:

this builder

context

public AiServiceTokenStreamParameters.Builder context(AiServiceContext context)

Sets the AI service context.

Parameters:

context - the AI service context

Returns:

this builder

invocationContext

public AiServiceTokenStreamParameters.Builder invocationContext(InvocationContext invocationContext)

commonGuardrailParams

public AiServiceTokenStreamParameters.Builder commonGuardrailParams(GuardrailRequestParams commonGuardrailParams)

Sets the common guardrail parameters for validating interactions between a user and a language model.

Parameters:

commonGuardrailParams - an instance of GuardrailRequestParams containing the shared parameters required for guardrail checks, such as chat memory, user message template, and additional variables.

Returns:

this builder instance.

methodKey

public AiServiceTokenStreamParameters.Builder methodKey(Object methodKey)

Sets the method key.

Parameters:

methodKey - the method key

Returns:

this builder

build

public AiServiceTokenStreamParameters build()

Builds a new AiServiceTokenStreamParameters.

Returns:

a new AiServiceTokenStreamParameters