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

Interface RetrieveAndGenerateRequest.Builder

All Superinterfaces:

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

Enclosing class:

RetrieveAndGenerateRequest

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

Method Summary

Modifier and Type	Method	Description
default RetrieveAndGenerateRequest.Builder	input(Consumer<RetrieveAndGenerateInput.Builder> input)	Contains the query to be made to the knowledge base.
RetrieveAndGenerateRequest.Builder	input(RetrieveAndGenerateInput input)	Contains the query to be made to the knowledge base.
RetrieveAndGenerateRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
RetrieveAndGenerateRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default RetrieveAndGenerateRequest.Builder	retrieveAndGenerateConfiguration(Consumer<RetrieveAndGenerateConfiguration.Builder> retrieveAndGenerateConfiguration)	Contains configurations for the knowledge base query and retrieval process.
RetrieveAndGenerateRequest.Builder	retrieveAndGenerateConfiguration(RetrieveAndGenerateConfiguration retrieveAndGenerateConfiguration)	Contains configurations for the knowledge base query and retrieval process.
default RetrieveAndGenerateRequest.Builder	sessionConfiguration(Consumer<RetrieveAndGenerateSessionConfiguration.Builder> sessionConfiguration)	Contains details about the session with the knowledge base.
RetrieveAndGenerateRequest.Builder	sessionConfiguration(RetrieveAndGenerateSessionConfiguration sessionConfiguration)	Contains details about the session with the knowledge base.
RetrieveAndGenerateRequest.Builder	sessionId(String sessionId)	The unique identifier 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 Details

input

RetrieveAndGenerateRequest.Builder input(RetrieveAndGenerateInput input)

Contains the query to be made to the knowledge base.

Parameters:

input - Contains the query to be made to the knowledge base.

Returns:

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

input

default RetrieveAndGenerateRequest.Builder input(Consumer<RetrieveAndGenerateInput.Builder> input)

Contains the query to be made to the knowledge base.

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

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

Parameters:

input - a consumer that will call methods on RetrieveAndGenerateInput.Builder

Returns:

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

See Also:

• input(RetrieveAndGenerateInput)

retrieveAndGenerateConfiguration

RetrieveAndGenerateRequest.Builder retrieveAndGenerateConfiguration(RetrieveAndGenerateConfiguration retrieveAndGenerateConfiguration)

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

Parameters:

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

retrieveAndGenerateConfiguration

default RetrieveAndGenerateRequest.Builder retrieveAndGenerateConfiguration(Consumer<RetrieveAndGenerateConfiguration.Builder> retrieveAndGenerateConfiguration)

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 RetrieveAndGenerateConfiguration.Builder avoiding the need to create one manually via RetrieveAndGenerateConfiguration.builder().

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

Parameters:

retrieveAndGenerateConfiguration - a consumer that will call methods on RetrieveAndGenerateConfiguration.Builder

Returns:

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

See Also:

• retrieveAndGenerateConfiguration(RetrieveAndGenerateConfiguration)

sessionConfiguration

RetrieveAndGenerateRequest.Builder sessionConfiguration(RetrieveAndGenerateSessionConfiguration sessionConfiguration)

Contains details about the session with the knowledge base.

Parameters:

sessionConfiguration - Contains details about the session with the knowledge base.

Returns:

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

sessionConfiguration

default RetrieveAndGenerateRequest.Builder sessionConfiguration(Consumer<RetrieveAndGenerateSessionConfiguration.Builder> sessionConfiguration)

Contains details about the session with the knowledge base.

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

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

Parameters:

sessionConfiguration - a consumer that will call methods on RetrieveAndGenerateSessionConfiguration.Builder

Returns:

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

See Also:

• sessionConfiguration(RetrieveAndGenerateSessionConfiguration)

sessionId

RetrieveAndGenerateRequest.Builder sessionId(String sessionId)

The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.

Parameters:

sessionId - The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.

Returns:

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

overrideConfiguration

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

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