Class: Aws::BedrockAgentRuntime::Types::KnowledgeBaseVectorSearchConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb

Overview

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:

Constant Summary collapse

SENSITIVE =
[:filter]

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::RetrievalFilter

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



4990
4991
4992
4993
4994
4995
4996
4997
4998
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4990

class KnowledgeBaseVectorSearchConfiguration < Struct.new(
  :number_of_results,
  :override_search_type,
  :filter,
  :reranking_configuration,
  :implicit_filter_configuration)
  SENSITIVE = [:filter]
  include Aws::Structure
end

#implicit_filter_configurationTypes::ImplicitFilterConfiguration

Settings for implicit filtering.



4990
4991
4992
4993
4994
4995
4996
4997
4998
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4990

class KnowledgeBaseVectorSearchConfiguration < Struct.new(
  :number_of_results,
  :override_search_type,
  :filter,
  :reranking_configuration,
  :implicit_filter_configuration)
  SENSITIVE = [:filter]
  include Aws::Structure
end

#number_of_resultsInteger

The number of source chunks to retrieve.

Returns:

  • (Integer)


4990
4991
4992
4993
4994
4995
4996
4997
4998
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4990

class KnowledgeBaseVectorSearchConfiguration < Struct.new(
  :number_of_results,
  :override_search_type,
  :filter,
  :reranking_configuration,
  :implicit_filter_configuration)
  SENSITIVE = [:filter]
  include Aws::Structure
end

#override_search_typeString

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.

Returns:

  • (String)


4990
4991
4992
4993
4994
4995
4996
4997
4998
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4990

class KnowledgeBaseVectorSearchConfiguration < Struct.new(
  :number_of_results,
  :override_search_type,
  :filter,
  :reranking_configuration,
  :implicit_filter_configuration)
  SENSITIVE = [:filter]
  include Aws::Structure
end

#reranking_configurationTypes::VectorSearchRerankingConfiguration

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



4990
4991
4992
4993
4994
4995
4996
4997
4998
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4990

class KnowledgeBaseVectorSearchConfiguration < Struct.new(
  :number_of_results,
  :override_search_type,
  :filter,
  :reranking_configuration,
  :implicit_filter_configuration)
  SENSITIVE = [:filter]
  include Aws::Structure
end