Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface KnowledgeBaseVectorSearchConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<KnowledgeBaseVectorSearchConfiguration.Builder,KnowledgeBaseVectorSearchConfiguration>, SdkBuilder<KnowledgeBaseVectorSearchConfiguration.Builder,KnowledgeBaseVectorSearchConfiguration>, SdkPojo

Enclosing class:

KnowledgeBaseVectorSearchConfiguration

public static interface KnowledgeBaseVectorSearchConfiguration.Builder
extends SdkPojo, CopyableBuilder<KnowledgeBaseVectorSearchConfiguration.Builder,KnowledgeBaseVectorSearchConfiguration>

Method Summary

Modifier and Type	Method	Description
default KnowledgeBaseVectorSearchConfiguration.Builder	filter(Consumer<RetrievalFilter.Builder> filter)	Specifies the filters to use on the metadata in the knowledge base data sources before returning results.
KnowledgeBaseVectorSearchConfiguration.Builder	filter(RetrievalFilter filter)	Specifies the filters to use on the metadata in the knowledge base data sources before returning results.
default KnowledgeBaseVectorSearchConfiguration.Builder	implicitFilterConfiguration(Consumer<ImplicitFilterConfiguration.Builder> implicitFilterConfiguration)	Settings for implicit filtering.
KnowledgeBaseVectorSearchConfiguration.Builder	implicitFilterConfiguration(ImplicitFilterConfiguration implicitFilterConfiguration)	Settings for implicit filtering.
KnowledgeBaseVectorSearchConfiguration.Builder	numberOfResults(Integer numberOfResults)	The number of source chunks to retrieve.
KnowledgeBaseVectorSearchConfiguration.Builder	overrideSearchType(String overrideSearchType)	By default, Amazon Bedrock decides a search strategy for you.
KnowledgeBaseVectorSearchConfiguration.Builder	overrideSearchType(SearchType overrideSearchType)	By default, Amazon Bedrock decides a search strategy for you.
default KnowledgeBaseVectorSearchConfiguration.Builder	rerankingConfiguration(Consumer<VectorSearchRerankingConfiguration.Builder> rerankingConfiguration)	Contains configurations for reranking the retrieved results.
KnowledgeBaseVectorSearchConfiguration.Builder	rerankingConfiguration(VectorSearchRerankingConfiguration rerankingConfiguration)	Contains configurations for reranking the retrieved results.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

filter

KnowledgeBaseVectorSearchConfiguration.Builder filter(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

filter

default KnowledgeBaseVectorSearchConfiguration.Builder filter(Consumer<RetrievalFilter.Builder> filter)

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

This is a convenience method that creates an instance of the RetrievalFilter.Builder avoiding the need to create one manually via RetrievalFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(RetrievalFilter).

Parameters:

filter - a consumer that will call methods on RetrievalFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

filter(RetrievalFilter)

implicitFilterConfiguration

KnowledgeBaseVectorSearchConfiguration.Builder implicitFilterConfiguration(ImplicitFilterConfiguration implicitFilterConfiguration)

Settings for implicit filtering.

Parameters:

implicitFilterConfiguration - Settings for implicit filtering.

Returns:

Returns a reference to this object so that method calls can be chained together.

implicitFilterConfiguration

default KnowledgeBaseVectorSearchConfiguration.Builder implicitFilterConfiguration(Consumer<ImplicitFilterConfiguration.Builder> implicitFilterConfiguration)

Settings for implicit filtering.

This is a convenience method that creates an instance of the ImplicitFilterConfiguration.Builder avoiding the need to create one manually via ImplicitFilterConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to implicitFilterConfiguration(ImplicitFilterConfiguration).

Parameters:

implicitFilterConfiguration - a consumer that will call methods on ImplicitFilterConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

implicitFilterConfiguration(ImplicitFilterConfiguration)

numberOfResults

KnowledgeBaseVectorSearchConfiguration.Builder numberOfResults(Integer numberOfResults)

The number of source chunks to retrieve.

Parameters:

numberOfResults - The number of source chunks to retrieve.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideSearchType

KnowledgeBaseVectorSearchConfiguration.Builder overrideSearchType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SearchType, SearchType

overrideSearchType

KnowledgeBaseVectorSearchConfiguration.Builder overrideSearchType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SearchType, SearchType

rerankingConfiguration

KnowledgeBaseVectorSearchConfiguration.Builder rerankingConfiguration(VectorSearchRerankingConfiguration rerankingConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

rerankingConfiguration

default KnowledgeBaseVectorSearchConfiguration.Builder rerankingConfiguration(Consumer<VectorSearchRerankingConfiguration.Builder> rerankingConfiguration)

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

This is a convenience method that creates an instance of the VectorSearchRerankingConfiguration.Builder avoiding the need to create one manually via VectorSearchRerankingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rerankingConfiguration(VectorSearchRerankingConfiguration).

Parameters:

rerankingConfiguration - a consumer that will call methods on VectorSearchRerankingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

rerankingConfiguration(VectorSearchRerankingConfiguration)