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>

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RetrieveAndGenerateRequest.Builder,RetrieveAndGenerateRequest>
      Specified by:
      toBuilder in class BedrockAgentRuntimeRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.