Class AiServiceTokenStreamParameters

java.lang.Object

dev.langchain4j.service.AiServiceTokenStreamParameters

public class AiServiceTokenStreamParameters
extends Object

Parameters for creating an AiServiceTokenStream.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AiServiceTokenStreamParameters.Builder	Builder for AiServiceTokenStreamParameters.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AiServiceTokenStreamParameters(AiServiceTokenStreamParameters.Builder builder)

Method Summary

Modifier and Type	Method	Description
List<ToolSpecification>	availableTools()	Returns all available tool specifications configured for AI service.
static AiServiceTokenStreamParameters.Builder	builder()	Creates a new builder for AiServiceTokenStreamParameters.
GuardrailRequestParams	commonGuardrailParams()	Retrieves the common parameters shared across guardrail checks for validating interactions between a user and a language model, if available.
AiServiceContext	context()
List<ToolSpecification>	effectiveTools()	Returns effective tool specifications that should be included in the next ChatRequest.
InvocationContext	invocationContext()
List<ChatMessage>	messages()	Returns messages that should be included in the next ChatRequest.
Object	methodKey()	Retrieves the method key associated with this instance.
List<Content>	retrievedContents()
ToolArgumentsErrorHandler	toolArgumentsErrorHandler()
ToolExecutionErrorHandler	toolExecutionErrorHandler()
Executor	toolExecutor()
Map<String, ToolExecutor>	toolExecutors()
List<ToolSpecification>	toolSpecifications()	Deprecated. use effectiveTools() instead

Methods inherited from class Object

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

Constructor Details

AiServiceTokenStreamParameters

protected AiServiceTokenStreamParameters(AiServiceTokenStreamParameters.Builder builder)

Method Details

messages

public List<ChatMessage> messages()

Returns messages that should be included in the next ChatRequest.

effectiveTools

public List<ToolSpecification> effectiveTools()

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

See Also:

• availableTools()

toolSpecifications

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

Deprecated.

use effectiveTools() instead

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

See Also:

• effectiveTools()

availableTools

public List<ToolSpecification> availableTools()

Returns 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()

toolExecutors

public Map<String, ToolExecutor> toolExecutors()

Returns:

the tool executors

toolArgumentsErrorHandler

public ToolArgumentsErrorHandler toolArgumentsErrorHandler()

Since:

1.4.0

toolExecutionErrorHandler

public ToolExecutionErrorHandler toolExecutionErrorHandler()

Since:

1.4.0

toolExecutor

public Executor toolExecutor()

Since:

1.4.0

retrievedContents

public List<Content> retrievedContents()

Returns:

the retrieved contents

context

public AiServiceContext context()

Returns:

the AI service context

invocationContext

public InvocationContext invocationContext()

Since:

1.6.0

commonGuardrailParams

public GuardrailRequestParams commonGuardrailParams()

Retrieves the common parameters shared across guardrail checks for validating interactions between a user and a language model, if available.

Returns:

the GuardrailRequestParams containing chat memory, user message template, and additional variables required for guardrail processing, or null if not set.

methodKey

public Object methodKey()

Retrieves the method key associated with this instance.

Returns:

the method key as an Object

builder

public static AiServiceTokenStreamParameters.Builder builder()

Creates a new builder for AiServiceTokenStreamParameters.

Returns:

a new builder