Class RetrieveAndGenerateConfiguration

java.lang.Object
software.amazon.awssdk.services.bedrock.model.RetrieveAndGenerateConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RetrieveAndGenerateConfiguration.Builder,RetrieveAndGenerateConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class RetrieveAndGenerateConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RetrieveAndGenerateConfiguration.Builder,RetrieveAndGenerateConfiguration>

Contains configuration details for a knowledge base retrieval and response generation.

See Also:

  • Method Details

    • type

      public final RetrieveAndGenerateType type()

      The type of resource that contains your data for retrieving information and generating responses.

      If you choose to use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

      If the service returns an enum value that is not available in the current SDK version, type will return RetrieveAndGenerateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of resource that contains your data for retrieving information and generating responses.

      If you choose to use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of resource that contains your data for retrieving information and generating responses.

      If you choose to use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

      If the service returns an enum value that is not available in the current SDK version, type will return RetrieveAndGenerateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of resource that contains your data for retrieving information and generating responses.

      If you choose to use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

      See Also:

    • knowledgeBaseConfiguration

      public final KnowledgeBaseRetrieveAndGenerateConfiguration knowledgeBaseConfiguration()

      Contains configuration details for the knowledge base retrieval and response generation.

      Returns:
      Contains configuration details for the knowledge base retrieval and response generation.

    • externalSourcesConfiguration

      public final ExternalSourcesRetrieveAndGenerateConfiguration externalSourcesConfiguration()

      The configuration for the external source wrapper object in the retrieveAndGenerate function.

      Returns:
      The configuration for the external source wrapper object in the retrieveAndGenerate function.

    • toBuilder

      public RetrieveAndGenerateConfiguration.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<RetrieveAndGenerateConfiguration.Builder,RetrieveAndGenerateConfiguration>
      Returns:
      a builder for type T

    • builder

      public static RetrieveAndGenerateConfiguration.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.