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)	Sets all available tool specifications configured for AI service.
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	context(AiServiceContext context)	Sets the AI service context.
AiServiceTokenStreamParameters.Builder	effectiveTools(List<ToolSpecification> effectiveTools)	Sets effective tool specifications that should be included in the next ChatRequest.
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)	Sets the tool executors.
AiServiceTokenStreamParameters.Builder	toolSpecifications(List<ToolSpecification> effectiveTools)	Deprecated. use effectiveTools(List) 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

effectiveTools

public AiServiceTokenStreamParameters.Builder effectiveTools(List<ToolSpecification> effectiveTools)

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

Deprecated.

use effectiveTools(List) instead

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

See Also:

• availableTools(List)

availableTools

public AiServiceTokenStreamParameters.Builder availableTools(List<ToolSpecification> availableTools)

Sets all available tool specifications configured for AI service. These tool specifications can be discovered/found by the LLM (see ToolSearchStrategy) and included in the next ChatRequest.

Since:

1.12.0

See Also:

• effectiveTools(List)

toolExecutors

public AiServiceTokenStreamParameters.Builder toolExecutors(Map<String, ToolExecutor> toolExecutors)

Sets the tool executors.

Parameters:

toolExecutors - the tool executors

Returns:

this builder

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

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