Package software.amazon.awssdk.services.bedrock.model

Interface KnowledgeBaseVectorSearchConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

KnowledgeBaseVectorSearchConfiguration

@Mutable
@NotThreadSafe
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 fields in the knowledge base data sources before returning results.
KnowledgeBaseVectorSearchConfiguration.Builder	filter(RetrievalFilter filter)	Specifies the filters to use on the metadata fields in the knowledge base data sources before returning results.
KnowledgeBaseVectorSearchConfiguration.Builder	numberOfResults(Integer numberOfResults)	The number of text chunks to retrieve; the number of results to return.
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.

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

numberOfResults

KnowledgeBaseVectorSearchConfiguration.Builder numberOfResults(Integer numberOfResults)

The number of text chunks to retrieve; the number of results to return.

Parameters:

numberOfResults - The number of text chunks to retrieve; the number of results to return.

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.

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.

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.

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.

Returns:

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

See Also:

SearchType, SearchType

filter

KnowledgeBaseVectorSearchConfiguration.Builder filter(RetrievalFilter filter)

Specifies the filters to use on the metadata fields in the knowledge base data sources before returning results.

Parameters:

filter - Specifies the filters to use on the metadata fields in the knowledge base data sources before returning results.

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 fields in the knowledge base data sources before returning results.

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)