Interface RetrieveRequest.Builder

All Superinterfaces:

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

Enclosing class:

RetrieveRequest

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

Method Summary

Modifier and Type	Method	Description
default RetrieveRequest.Builder	guardrailConfiguration(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration)	Guardrail settings.
RetrieveRequest.Builder	guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)	Guardrail settings.
RetrieveRequest.Builder	knowledgeBaseId(String knowledgeBaseId)	The unique identifier of the knowledge base to query.
RetrieveRequest.Builder	nextToken(String nextToken)	If there are more results than can fit in the response, the response returns a nextToken.
RetrieveRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
RetrieveRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default RetrieveRequest.Builder	retrievalConfiguration(Consumer<KnowledgeBaseRetrievalConfiguration.Builder> retrievalConfiguration)	Contains configurations for the knowledge base query and retrieval process.
RetrieveRequest.Builder	retrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)	Contains configurations for the knowledge base query and retrieval process.
default RetrieveRequest.Builder	retrievalQuery(Consumer<KnowledgeBaseQuery.Builder> retrievalQuery)	Contains the query to send the knowledge base.
RetrieveRequest.Builder	retrievalQuery(KnowledgeBaseQuery retrievalQuery)	Contains the query to send the knowledge base.
default RetrieveRequest.Builder	userContext(Consumer<UserContext.Builder> userContext)	Contains information about the user making the request.
RetrieveRequest.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

guardrailConfiguration

RetrieveRequest.Builder guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)

Guardrail settings.

Parameters:

guardrailConfiguration - Guardrail settings.

Returns:

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

guardrailConfiguration

default RetrieveRequest.Builder guardrailConfiguration(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration)

Guardrail settings.

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

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

Parameters:

guardrailConfiguration - a consumer that will call methods on GuardrailConfiguration.Builder

Returns:

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

See Also:

• guardrailConfiguration(GuardrailConfiguration)

knowledgeBaseId

RetrieveRequest.Builder knowledgeBaseId(String knowledgeBaseId)

The unique identifier of the knowledge base to query.

Parameters:

knowledgeBaseId - The unique identifier of the knowledge base to query.

Returns:

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

nextToken

RetrieveRequest.Builder nextToken(String nextToken)

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

Parameters:

nextToken - If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

Returns:

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

retrievalConfiguration

RetrieveRequest.Builder retrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

Parameters:

retrievalConfiguration - Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

Returns:

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

retrievalConfiguration

default RetrieveRequest.Builder retrievalConfiguration(Consumer<KnowledgeBaseRetrievalConfiguration.Builder> retrievalConfiguration)

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

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

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

Parameters:

retrievalConfiguration - a consumer that will call methods on KnowledgeBaseRetrievalConfiguration.Builder

Returns:

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

See Also:

• retrievalConfiguration(KnowledgeBaseRetrievalConfiguration)

retrievalQuery

RetrieveRequest.Builder retrievalQuery(KnowledgeBaseQuery retrievalQuery)

Contains the query to send the knowledge base.

Parameters:

retrievalQuery - Contains the query to send the knowledge base.

Returns:

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

retrievalQuery

default RetrieveRequest.Builder retrievalQuery(Consumer<KnowledgeBaseQuery.Builder> retrievalQuery)

Contains the query to send the knowledge base.

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

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

Parameters:

retrievalQuery - a consumer that will call methods on KnowledgeBaseQuery.Builder

Returns:

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

See Also:

• retrievalQuery(KnowledgeBaseQuery)

userContext

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

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

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