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:
-
Retrieve request – in the
vectorSearchConfigurationfield -
RetrieveAndGenerate request – in the
vectorSearchConfigurationfield
Contents
- filter
-
Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.
Type: RetrievalFilter object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- implicitFilterConfiguration
-
Settings for implicit filtering.
Type: ImplicitFilterConfiguration object
Required: No
- numberOfResults
-
The number of source chunks to retrieve.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- 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
HYBRIDsearch using both vector embeddings and raw text, orSEMANTICsearch using only vector embeddings. For other vector store configurations, onlySEMANTICsearch is available. For more information, see Test a knowledge base.Type: String
Valid Values:
HYBRID | SEMANTICRequired: No
- rerankingConfiguration
-
Contains configurations for reranking the retrieved results. For more information, see Improve the relevance of query responses with a reranker model.
Type: VectorSearchRerankingConfiguration object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
