Interface InvokeAgentRequest.Builder

All Superinterfaces:

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

Enclosing class:

InvokeAgentRequest

@Mutable
@NotThreadSafe
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.
default InvokeAgentRequest.Builder	bedrockModelConfigurations(Consumer<BedrockModelConfigurations.Builder> bedrockModelConfigurations)	Model performance settings for the request.
InvokeAgentRequest.Builder	bedrockModelConfigurations(BedrockModelConfigurations bedrockModelConfigurations)	Model performance settings for the request.
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	memoryId(String memoryId)	The unique identifier of the agent memory.
InvokeAgentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
InvokeAgentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default InvokeAgentRequest.Builder	promptCreationConfigurations(Consumer<PromptCreationConfigurations.Builder> promptCreationConfigurations)	Specifies parameters that control how the service populates the agent prompt for an InvokeAgent request.
InvokeAgentRequest.Builder	promptCreationConfigurations(PromptCreationConfigurations promptCreationConfigurations)	Specifies parameters that control how the service populates the agent prompt for an InvokeAgent request.
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.
InvokeAgentRequest.Builder	sourceArn(String sourceArn)	The ARN of the resource making the request.
default InvokeAgentRequest.Builder	streamingConfigurations(Consumer<StreamingConfigurations.Builder> streamingConfigurations)	Specifies the configurations for streaming.
InvokeAgentRequest.Builder	streamingConfigurations(StreamingConfigurations streamingConfigurations)	Specifies the configurations for streaming.

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, sdkFieldNameToField, sdkFields

Method Details

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.

bedrockModelConfigurations

InvokeAgentRequest.Builder bedrockModelConfigurations(BedrockModelConfigurations bedrockModelConfigurations)

Model performance settings for the request.

Parameters:

bedrockModelConfigurations - Model performance settings for the request.

Returns:

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

bedrockModelConfigurations

default InvokeAgentRequest.Builder bedrockModelConfigurations(Consumer<BedrockModelConfigurations.Builder> bedrockModelConfigurations)

Model performance settings for the request.

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

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

Parameters:

bedrockModelConfigurations - a consumer that will call methods on BedrockModelConfigurations.Builder

Returns:

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

See Also:

• bedrockModelConfigurations(BedrockModelConfigurations)

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.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

Parameters:

inputText - The prompt text to send the agent.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

Returns:

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

memoryId

InvokeAgentRequest.Builder memoryId(String memoryId)

The unique identifier of the agent memory.

Parameters:

memoryId - The unique identifier of the agent memory.

Returns:

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

promptCreationConfigurations

InvokeAgentRequest.Builder promptCreationConfigurations(PromptCreationConfigurations promptCreationConfigurations)

Specifies parameters that control how the service populates the agent prompt for an InvokeAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.

Parameters:

promptCreationConfigurations - Specifies parameters that control how the service populates the agent prompt for an InvokeAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.

Returns:

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

promptCreationConfigurations

default InvokeAgentRequest.Builder promptCreationConfigurations(Consumer<PromptCreationConfigurations.Builder> promptCreationConfigurations)

Specifies parameters that control how the service populates the agent prompt for an InvokeAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.

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

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

Parameters:

promptCreationConfigurations - a consumer that will call methods on PromptCreationConfigurations.Builder

Returns:

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

See Also:

• promptCreationConfigurations(PromptCreationConfigurations)

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.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

Parameters:

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

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

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.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

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)

sourceArn

InvokeAgentRequest.Builder sourceArn(String sourceArn)

The ARN of the resource making the request.

Parameters:

sourceArn - The ARN of the resource making the request.

Returns:

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

streamingConfigurations

InvokeAgentRequest.Builder streamingConfigurations(StreamingConfigurations streamingConfigurations)

Specifies the configurations for streaming.

To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.

Parameters:

streamingConfigurations - Specifies the configurations for streaming.

To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.

Returns:

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

streamingConfigurations

default InvokeAgentRequest.Builder streamingConfigurations(Consumer<StreamingConfigurations.Builder> streamingConfigurations)

Specifies the configurations for streaming.

To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.

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

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

Parameters:

streamingConfigurations - a consumer that will call methods on StreamingConfigurations.Builder

Returns:

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

See Also:

• streamingConfigurations(StreamingConfigurations)

overrideConfiguration

InvokeAgentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.