Class AgenticRetrieveConfiguration

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

Configuration settings for the agentic retrieval operation.

See Also:

  • Method Details

    • foundationModelConfiguration

      public final FoundationModelConfiguration foundationModelConfiguration()

      The foundation model configuration. Required when foundationModelType is CUSTOM.

      Returns:
      The foundation model configuration. Required when foundationModelType is CUSTOM.

    • foundationModelType

      public final FoundationModelType foundationModelType()

      The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.

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

      Returns:
      The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.
      See Also:

    • foundationModelTypeAsString

      public final String foundationModelTypeAsString()

      The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.

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

      Returns:
      The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.
      See Also:

    • maxAgentIteration

      public final Integer maxAgentIteration()

      The maximum number of agent iterations for retrieval.

      Returns:
      The maximum number of agent iterations for retrieval.

    • rerankingConfiguration

      public final AgenticRetrieveRerankingConfiguration rerankingConfiguration()

      The reranking model configuration. Required when rerankingModelType is CUSTOM.

      Returns:
      The reranking model configuration. Required when rerankingModelType is CUSTOM.

    • rerankingModelType

      public final AgenticRetrieveRerankingModelType rerankingModelType()

      The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.

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

      Returns:
      The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.
      See Also:

    • rerankingModelTypeAsString

      public final String rerankingModelTypeAsString()

      The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.

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

      Returns:
      The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.
      See Also:

    • toBuilder

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

    • builder

      public static AgenticRetrieveConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AgenticRetrieveConfiguration.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.