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:

See Also:

Constant Summary collapse

SENSITIVE = 
[:filter]

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Types::RetrievalFilter

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

Returns:



6307
6308
6309
6310
6311
6312
6313
6314
6315
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6307

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

#implicit_filter_configuration ⇒ Types::ImplicitFilterConfiguration

Settings for implicit filtering.

Returns:



6307
6308
6309
6310
6311
6312
6313
6314
6315
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6307

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

#number_of_results ⇒ Integer

The number of source chunks to retrieve.

Returns:

  • (Integer) 


6307
6308
6309
6310
6311
6312
6313
6314
6315
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6307

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

#override_search_type ⇒ String

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) 


6307
6308
6309
6310
6311
6312
6313
6314
6315
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6307

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

#reranking_configuration ⇒ Types::VectorSearchRerankingConfiguration

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

Returns:



6307
6308
6309
6310
6311
6312
6313
6314
6315
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 6307

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