Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface InvokeAgentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentRuntimeRequest.Builder, Buildable, CopyableBuilder<InvokeAgentRequest.Builder,InvokeAgentRequest>, SdkBuilder<InvokeAgentRequest.Builder,InvokeAgentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

InvokeAgentRequest

public static interface InvokeAgentRequest.Builder
extends BedrockAgentRuntimeRequest.Builder, SdkPojo, CopyableBuilder<InvokeAgentRequest.Builder,InvokeAgentRequest>

Method Summary

Modifier and Type	Method	Description
InvokeAgentRequest.Builder	agentAliasId(String agentAliasId)	The alias of the agent to use.
InvokeAgentRequest.Builder	agentId(String agentId)	The unique identifier of the agent to use.
InvokeAgentRequest.Builder	enableTrace(Boolean enableTrace)	Specifies whether to turn on the trace or not to track the agent's reasoning process.
InvokeAgentRequest.Builder	endSession(Boolean endSession)	Specifies whether to end the session with the agent or not.
InvokeAgentRequest.Builder	inputText(String inputText)	The prompt text to send the agent.
InvokeAgentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
InvokeAgentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
InvokeAgentRequest.Builder	sessionId(String sessionId)	The unique identifier of the session.
default InvokeAgentRequest.Builder	sessionState(Consumer<SessionState.Builder> sessionState)	Contains parameters that specify various attributes of the session.
InvokeAgentRequest.Builder	sessionState(SessionState sessionState)	Contains parameters that specify various attributes of the session.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

agentAliasId

InvokeAgentRequest.Builder agentAliasId(String agentAliasId)

The alias of the agent to use.

Parameters:

agentAliasId - The alias of the agent to use.

Returns:

Returns a reference to this object so that method calls can be chained together.

agentId

InvokeAgentRequest.Builder agentId(String agentId)

The unique identifier of the agent to use.

Parameters:

agentId - The unique identifier of the agent to use.

Returns:

Returns a reference to this object so that method calls can be chained together.

enableTrace

InvokeAgentRequest.Builder enableTrace(Boolean enableTrace)

Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.

Parameters:

enableTrace - Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.

Returns:

Returns a reference to this object so that method calls can be chained together.

endSession

InvokeAgentRequest.Builder endSession(Boolean endSession)

Specifies whether to end the session with the agent or not.

Parameters:

endSession - Specifies whether to end the session with the agent or not.

Returns:

Returns a reference to this object so that method calls can be chained together.

inputText

InvokeAgentRequest.Builder inputText(String inputText)

The prompt text to send the agent.

Parameters:

inputText - The prompt text to send the agent.

Returns:

Returns a reference to this object so that method calls can be chained together.

sessionId

InvokeAgentRequest.Builder sessionId(String sessionId)

The unique identifier of the session. Use the same value across requests to continue the same conversation.

Parameters:

sessionId - The unique identifier of the session. Use the same value across requests to continue the same conversation.

Returns:

Returns a reference to this object so that method calls can be chained together.

sessionState

InvokeAgentRequest.Builder sessionState(SessionState sessionState)

Contains parameters that specify various attributes of the session. For more information, see Control session context.

Parameters:

sessionState - Contains parameters that specify various attributes of the session. For more information, see Control session context.

Returns:

Returns a reference to this object so that method calls can be chained together.

sessionState

default InvokeAgentRequest.Builder sessionState(Consumer<SessionState.Builder> sessionState)

Contains parameters that specify various attributes of the session. For more information, see Control session context.

This is a convenience method that creates an instance of the SessionState.Builder avoiding the need to create one manually via SessionState.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sessionState(SessionState).

Parameters:

sessionState - a consumer that will call methods on SessionState.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sessionState(SessionState)

overrideConfiguration

InvokeAgentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

InvokeAgentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder