Interface RetrieveAndGenerateStreamRequest.Builder

All Superinterfaces:

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

Enclosing class:

RetrieveAndGenerateStreamRequest

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

Method Summary

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

Method Details

input

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

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

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

RetrieveAndGenerateStreamRequest.Builder sessionId(String sessionId)

The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

Parameters:

sessionId - The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

Returns:

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

overrideConfiguration

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

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