Skip to content

/AWS1/CL_BDZKNOWLEDGEBASEVEC00

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:

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_numberofresults TYPE /AWS1/BDZINTEGER /AWS1/BDZINTEGER

The number of source chunks to retrieve.

iv_overridesearchtype TYPE /AWS1/BDZSEARCHTYPE /AWS1/BDZSEARCHTYPE

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.

io_filter TYPE REF TO /AWS1/CL_BDZRETRIEVALFILTER /AWS1/CL_BDZRETRIEVALFILTER

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

io_rerankingconfiguration TYPE REF TO /AWS1/CL_BDZVECTORSRCHRERANK00 /AWS1/CL_BDZVECTORSRCHRERANK00

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

io_implicitfilterconf TYPE REF TO /AWS1/CL_BDZIMPLICITFILTERCONF /AWS1/CL_BDZIMPLICITFILTERCONF

Settings for implicit filtering.

Queryable Attributes

numberOfResults

The number of source chunks to retrieve.

Accessible with the following methods

Method Description
GET_NUMBEROFRESULTS() Getter for NUMBEROFRESULTS, with configurable default
ASK_NUMBEROFRESULTS() Getter for NUMBEROFRESULTS w/ exceptions if field has no val
HAS_NUMBEROFRESULTS() Determine if NUMBEROFRESULTS has a value

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.

Accessible with the following methods

Method Description
GET_OVERRIDESEARCHTYPE() Getter for OVERRIDESEARCHTYPE, with configurable default
ASK_OVERRIDESEARCHTYPE() Getter for OVERRIDESEARCHTYPE w/ exceptions if field has no
HAS_OVERRIDESEARCHTYPE() Determine if OVERRIDESEARCHTYPE has a value

filter

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

Accessible with the following methods

Method Description
GET_FILTER() Getter for FILTER

rerankingConfiguration

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

Accessible with the following methods

Method Description
GET_RERANKINGCONFIGURATION() Getter for RERANKINGCONFIGURATION

implicitFilterConfiguration

Settings for implicit filtering.

Accessible with the following methods

Method Description
GET_IMPLICITFILTERCONF() Getter for IMPLICITFILTERCONFIGURATION