Class KnowledgeBaseVectorSearchConfiguration

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

Configurations for how to perform the search query and return results. For more information, see Query configurations.

This data type is used in the following API operations:

See Also:

  • Method Details

    • numberOfResults

      public final Integer numberOfResults()

      The number of source chunks to retrieve.

      Returns:
      The number of source chunks to retrieve.

    • overrideSearchType

      public final SearchType overrideSearchType()

      By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.

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

      Returns:
      By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.
      See Also:

    • overrideSearchTypeAsString

      public final String overrideSearchTypeAsString()

      By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.

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

      Returns:
      By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.
      See Also:

    • filter

      public final RetrievalFilter filter()

      Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.

      Returns:
      Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.

    • rerankingConfiguration

      public final VectorSearchRerankingConfiguration rerankingConfiguration()

      Contains configurations for reranking the retrieved results. For more information, see Improve the relevance of query responses with a reranker model.

      Returns:
      Contains configurations for reranking the retrieved results. For more information, see Improve the relevance of query responses with a reranker model.

    • implicitFilterConfiguration

      public final ImplicitFilterConfiguration implicitFilterConfiguration()

      Settings for implicit filtering.

      Returns:
      Settings for implicit filtering.

    • toBuilder

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

    • builder

      public static KnowledgeBaseVectorSearchConfiguration.Builder builder()

    • serializableBuilderClass

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