Class ManagedKnowledgeBaseConfiguration

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

Configurations for a managed knowledge base.

See Also:

  • Method Details

    • embeddingModelType

      public final EmbeddingModelType embeddingModelType()

      Choose CUSTOM to provide your own Bedrock embedding model ARN. Choose MANAGED to use a service-managed embedding model.

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

      Returns:
      Choose CUSTOM to provide your own Bedrock embedding model ARN. Choose MANAGED to use a service-managed embedding model.
      See Also:

    • embeddingModelTypeAsString

      public final String embeddingModelTypeAsString()

      Choose CUSTOM to provide your own Bedrock embedding model ARN. Choose MANAGED to use a service-managed embedding model.

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

      Returns:
      Choose CUSTOM to provide your own Bedrock embedding model ARN. Choose MANAGED to use a service-managed embedding model.
      See Also:

    • embeddingModelArn

      public final String embeddingModelArn()

      The ARN for the embeddings model.

      Returns:
      The ARN for the embeddings model.

    • embeddingModelConfiguration

      public final EmbeddingModelConfiguration embeddingModelConfiguration()

      The configuration details for the embeddings model. Not required when choosing the MANAGED embeddingModelType.

      Returns:
      The configuration details for the embeddings model. Not required when choosing the MANAGED embeddingModelType.

    • serverSideEncryptionConfiguration

      public final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration()

      Contains the configuration for server-side encryption for your managed knowledge base.

      Returns:
      Contains the configuration for server-side encryption for your managed knowledge base.

    • supplementalDataStorageConfiguration

      public final SupplementalDataStorageConfiguration supplementalDataStorageConfiguration()

      Use this object to specify the Amazon S3 location that the knowledge base uses to process and ingest multimodal content. This field is required when you use a native multimodal embedding model.

      Returns:
      Use this object to specify the Amazon S3 location that the knowledge base uses to process and ingest multimodal content. This field is required when you use a native multimodal embedding model.

    • toBuilder

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

    • builder

      public static ManagedKnowledgeBaseConfiguration.Builder builder()

    • serializableBuilderClass

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