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

Class RetrieveAndGenerateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeRequest

software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveAndGenerateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RetrieveAndGenerateRequest.Builder,RetrieveAndGenerateRequest>

@Generated("software.amazon.awssdk:codegen")
public final class RetrieveAndGenerateRequest
extends BedrockAgentRuntimeRequest
implements ToCopyableBuilder<RetrieveAndGenerateRequest.Builder,RetrieveAndGenerateRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrieveAndGenerateRequest.Builder

Method Summary

Modifier and Type	Method	Description
static RetrieveAndGenerateRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RetrieveAndGenerateInput	input()	Contains the query to be made to the knowledge base.
RetrieveAndGenerateConfiguration	retrieveAndGenerateConfiguration()	Contains configurations for the knowledge base query and retrieval process.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RetrieveAndGenerateRequest.Builder>	serializableBuilderClass()
RetrieveAndGenerateSessionConfiguration	sessionConfiguration()	Contains details about the session with the knowledge base.
String	sessionId()	The unique identifier of the session.
RetrieveAndGenerateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

input

public final RetrieveAndGenerateInput input()

Contains the query to be made to the knowledge base.

Returns:

Contains the query to be made to the knowledge base.

retrieveAndGenerateConfiguration

public final RetrieveAndGenerateConfiguration retrieveAndGenerateConfiguration()

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

Returns:

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

sessionConfiguration

public final RetrieveAndGenerateSessionConfiguration sessionConfiguration()

Contains details about the session with the knowledge base.

Returns:

Contains details about the session with the knowledge base.

sessionId

public final 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.

Returns:

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.

toBuilder

public RetrieveAndGenerateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RetrieveAndGenerateRequest.Builder,RetrieveAndGenerateRequest>

Specified by:

toBuilder in class BedrockAgentRuntimeRequest

builder

public static RetrieveAndGenerateRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RetrieveAndGenerateRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo