Interface AgenticRetrieveStreamRequest.Builder

All Superinterfaces:

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

Enclosing class:

AgenticRetrieveStreamRequest

@Mutable
@NotThreadSafe
public static interface AgenticRetrieveStreamRequest.Builder
extends BedrockAgentRuntimeRequest.Builder, SdkPojo, CopyableBuilder<AgenticRetrieveStreamRequest.Builder,AgenticRetrieveStreamRequest>

Method Summary

Modifier and Type	Method	Description
default AgenticRetrieveStreamRequest.Builder	agenticRetrieveConfiguration(Consumer<AgenticRetrieveConfiguration.Builder> agenticRetrieveConfiguration)	Configuration settings for the agentic retrieval operation.
AgenticRetrieveStreamRequest.Builder	agenticRetrieveConfiguration(AgenticRetrieveConfiguration agenticRetrieveConfiguration)	Configuration settings for the agentic retrieval operation.
AgenticRetrieveStreamRequest.Builder	generateResponse(Boolean generateResponse)	Whether to generate a response based on the retrieved results.
AgenticRetrieveStreamRequest.Builder	messages(Collection<AgenticRetrieveMessage> messages)	The list of messages for the agentic retrieval conversation.
AgenticRetrieveStreamRequest.Builder	messages(Consumer<AgenticRetrieveMessage.Builder>... messages)	The list of messages for the agentic retrieval conversation.
AgenticRetrieveStreamRequest.Builder	messages(AgenticRetrieveMessage... messages)	The list of messages for the agentic retrieval conversation.
AgenticRetrieveStreamRequest.Builder	nextToken(String nextToken)	Opaque continuation token for paginated results.
AgenticRetrieveStreamRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
AgenticRetrieveStreamRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default AgenticRetrieveStreamRequest.Builder	policyConfiguration(Consumer<AgenticRetrievePolicyConfiguration.Builder> policyConfiguration)	Policy configuration for guardrails and content filtering.
AgenticRetrieveStreamRequest.Builder	policyConfiguration(AgenticRetrievePolicyConfiguration policyConfiguration)	Policy configuration for guardrails and content filtering.
AgenticRetrieveStreamRequest.Builder	retrievers(Collection<AgenticRetriever> retrievers)	The list of retrievers to use for agentic retrieval.
AgenticRetrieveStreamRequest.Builder	retrievers(Consumer<AgenticRetriever.Builder>... retrievers)	The list of retrievers to use for agentic retrieval.
AgenticRetrieveStreamRequest.Builder	retrievers(AgenticRetriever... retrievers)	The list of retrievers to use for agentic retrieval.
default AgenticRetrieveStreamRequest.Builder	userContext(Consumer<UserContext.Builder> userContext)	Contains information about the user making the request.
AgenticRetrieveStreamRequest.Builder	userContext(UserContext userContext)	Contains information about the user making the request.

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

agenticRetrieveConfiguration

AgenticRetrieveStreamRequest.Builder agenticRetrieveConfiguration(AgenticRetrieveConfiguration agenticRetrieveConfiguration)

Configuration settings for the agentic retrieval operation.

Parameters:

agenticRetrieveConfiguration - Configuration settings for the agentic retrieval operation.

Returns:

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

agenticRetrieveConfiguration

default AgenticRetrieveStreamRequest.Builder agenticRetrieveConfiguration(Consumer<AgenticRetrieveConfiguration.Builder> agenticRetrieveConfiguration)

Configuration settings for the agentic retrieval operation.

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

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

Parameters:

agenticRetrieveConfiguration - a consumer that will call methods on AgenticRetrieveConfiguration.Builder

Returns:

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

See Also:

• agenticRetrieveConfiguration(AgenticRetrieveConfiguration)

generateResponse

AgenticRetrieveStreamRequest.Builder generateResponse(Boolean generateResponse)

Whether to generate a response based on the retrieved results.

Parameters:

generateResponse - Whether to generate a response based on the retrieved results.

Returns:

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

messages

AgenticRetrieveStreamRequest.Builder messages(Collection<AgenticRetrieveMessage> messages)

The list of messages for the agentic retrieval conversation.

Parameters:

messages - The list of messages for the agentic retrieval conversation.

Returns:

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

messages

AgenticRetrieveStreamRequest.Builder messages(AgenticRetrieveMessage... messages)

The list of messages for the agentic retrieval conversation.

Parameters:

messages - The list of messages for the agentic retrieval conversation.

Returns:

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

messages

AgenticRetrieveStreamRequest.Builder messages(Consumer<AgenticRetrieveMessage.Builder>... messages)

The list of messages for the agentic retrieval conversation.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to messages(List<AgenticRetrieveMessage>).

Parameters:

messages - a consumer that will call methods on AgenticRetrieveMessage.Builder

Returns:

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

See Also:

• messages(java.util.Collection<AgenticRetrieveMessage>)

nextToken

AgenticRetrieveStreamRequest.Builder nextToken(String nextToken)

Opaque continuation token for paginated results.

Parameters:

nextToken - Opaque continuation token for paginated results.

Returns:

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

policyConfiguration

AgenticRetrieveStreamRequest.Builder policyConfiguration(AgenticRetrievePolicyConfiguration policyConfiguration)

Policy configuration for guardrails and content filtering.

Parameters:

policyConfiguration - Policy configuration for guardrails and content filtering.

Returns:

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

policyConfiguration

default AgenticRetrieveStreamRequest.Builder policyConfiguration(Consumer<AgenticRetrievePolicyConfiguration.Builder> policyConfiguration)

Policy configuration for guardrails and content filtering.

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

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

Parameters:

policyConfiguration - a consumer that will call methods on AgenticRetrievePolicyConfiguration.Builder

Returns:

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

See Also:

• policyConfiguration(AgenticRetrievePolicyConfiguration)

retrievers

AgenticRetrieveStreamRequest.Builder retrievers(Collection<AgenticRetriever> retrievers)

The list of retrievers to use for agentic retrieval.

Parameters:

retrievers - The list of retrievers to use for agentic retrieval.

Returns:

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

retrievers

AgenticRetrieveStreamRequest.Builder retrievers(AgenticRetriever... retrievers)

The list of retrievers to use for agentic retrieval.

Parameters:

retrievers - The list of retrievers to use for agentic retrieval.

Returns:

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

retrievers

AgenticRetrieveStreamRequest.Builder retrievers(Consumer<AgenticRetriever.Builder>... retrievers)

The list of retrievers to use for agentic retrieval.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retrievers(List<AgenticRetriever>).

Parameters:

retrievers - a consumer that will call methods on AgenticRetriever.Builder

Returns:

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

See Also:

• retrievers(java.util.Collection<AgenticRetriever>)

userContext

AgenticRetrieveStreamRequest.Builder userContext(UserContext userContext)

Contains information about the user making the request. This is used for access control filtering to ensure that retrieval results only include documents the user is authorized to access.

Parameters:

userContext - Contains information about the user making the request. This is used for access control filtering to ensure that retrieval results only include documents the user is authorized to access.

Returns:

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

userContext

default AgenticRetrieveStreamRequest.Builder userContext(Consumer<UserContext.Builder> userContext)

Contains information about the user making the request. This is used for access control filtering to ensure that retrieval results only include documents the user is authorized to access.

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

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

Parameters:

userContext - a consumer that will call methods on UserContext.Builder

Returns:

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

See Also:

• userContext(UserContext)

overrideConfiguration

AgenticRetrieveStreamRequest.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

AgenticRetrieveStreamRequest.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.