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

Interface RetrieveAndGenerateResponse.Builder

All Superinterfaces:

AwsResponse.Builder, BedrockAgentRuntimeResponse.Builder, Buildable, CopyableBuilder<RetrieveAndGenerateResponse.Builder,RetrieveAndGenerateResponse>, SdkBuilder<RetrieveAndGenerateResponse.Builder,RetrieveAndGenerateResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

RetrieveAndGenerateResponse

@Mutable
@NotThreadSafe
public static interface RetrieveAndGenerateResponse.Builder
extends BedrockAgentRuntimeResponse.Builder, SdkPojo, CopyableBuilder<RetrieveAndGenerateResponse.Builder,RetrieveAndGenerateResponse>

Method Summary

Modifier and Type	Method	Description
RetrieveAndGenerateResponse.Builder	citations(Collection<Citation> citations)	A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
RetrieveAndGenerateResponse.Builder	citations(Consumer<Citation.Builder>... citations)	A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
RetrieveAndGenerateResponse.Builder	citations(Citation... citations)	A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
RetrieveAndGenerateResponse.Builder	guardrailAction(String guardrailAction)	Specifies if there is a guardrail intervention in the response.
RetrieveAndGenerateResponse.Builder	guardrailAction(GuadrailAction guardrailAction)	Specifies if there is a guardrail intervention in the response.
default RetrieveAndGenerateResponse.Builder	output(Consumer<RetrieveAndGenerateOutput.Builder> output)	Contains the response generated from querying the knowledge base.
RetrieveAndGenerateResponse.Builder	output(RetrieveAndGenerateOutput output)	Contains the response generated from querying the knowledge base.
RetrieveAndGenerateResponse.Builder	sessionId(String sessionId)	The unique identifier of the session.

Methods inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeResponse.Builder

build, responseMetadata, responseMetadata

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

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

citations

RetrieveAndGenerateResponse.Builder citations(Collection<Citation> citations)

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

Parameters:

citations - A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

Returns:

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

citations

RetrieveAndGenerateResponse.Builder citations(Citation... citations)

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

Parameters:

citations - A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

Returns:

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

citations

RetrieveAndGenerateResponse.Builder citations(Consumer<Citation.Builder>... citations)

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #citations(List).

Parameters:

citations - a consumer that will call methods on Citation.Builder

Returns:

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

See Also:

#citations(java.util.Collection)

guardrailAction

RetrieveAndGenerateResponse.Builder guardrailAction(String guardrailAction)

Specifies if there is a guardrail intervention in the response.

Parameters:

guardrailAction - Specifies if there is a guardrail intervention in the response.

Returns:

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

See Also:

GuadrailAction, GuadrailAction

guardrailAction

RetrieveAndGenerateResponse.Builder guardrailAction(GuadrailAction guardrailAction)

Specifies if there is a guardrail intervention in the response.

Parameters:

guardrailAction - Specifies if there is a guardrail intervention in the response.

Returns:

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

See Also:

GuadrailAction, GuadrailAction

output

RetrieveAndGenerateResponse.Builder output(RetrieveAndGenerateOutput output)

Contains the response generated from querying the knowledge base.

Parameters:

output - Contains the response generated from querying the knowledge base.

Returns:

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

output

default RetrieveAndGenerateResponse.Builder output(Consumer<RetrieveAndGenerateOutput.Builder> output)

Contains the response generated from querying the knowledge base.

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

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

Parameters:

output - a consumer that will call methods on RetrieveAndGenerateOutput.Builder

Returns:

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

See Also:

output(RetrieveAndGenerateOutput)

sessionId

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