Class VectorKnowledgeBaseConfiguration

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

Contains details about the model used to create vector embeddings for the knowledge base.

See Also:

  • Method Details

    • embeddingModelArn

      public final String embeddingModelArn()

      The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.

      Returns:
      The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.

    • embeddingModelConfiguration

      public final EmbeddingModelConfiguration embeddingModelConfiguration()

      The embeddings model configuration details for the vector model used in Knowledge Base.

      Returns:
      The embeddings model configuration details for the vector model used in Knowledge Base.

    • supplementalDataStorageConfiguration

      public final SupplementalDataStorageConfiguration supplementalDataStorageConfiguration()

      If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate.

      Returns:
      If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate.

    • toBuilder

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

    • builder

      public static VectorKnowledgeBaseConfiguration.Builder builder()

    • serializableBuilderClass

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