Package software.amazon.awssdk.services.bedrockagent.model

Class KnowledgeBaseConfiguration

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

Contains details about the embeddings configuration of the knowledge base.

See Also:

  • Method Details

    • type

      public final KnowledgeBaseType type()

      The type of data that the data source is converted into for the knowledge base.

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

      Returns:
      The type of data that the data source is converted into for the knowledge base.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of data that the data source is converted into for the knowledge base.

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

      Returns:
      The type of data that the data source is converted into for the knowledge base.
      See Also:

    • vectorKnowledgeBaseConfiguration

      public final VectorKnowledgeBaseConfiguration vectorKnowledgeBaseConfiguration()

      Contains details about the embeddings model that'sused to convert the data source.

      Returns:
      Contains details about the embeddings model that'sused to convert the data source.

    • toBuilder

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

    • builder

      public static KnowledgeBaseConfiguration.Builder builder()

    • serializableBuilderClass

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