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

Class KnowledgeBaseVectorSearchConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrock.model.KnowledgeBaseVectorSearchConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KnowledgeBaseVectorSearchConfiguration.Builder,KnowledgeBaseVectorSearchConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class KnowledgeBaseVectorSearchConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KnowledgeBaseVectorSearchConfiguration.Builder,KnowledgeBaseVectorSearchConfiguration>

The configuration details for returning the results from the knowledge base vector search.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KnowledgeBaseVectorSearchConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static KnowledgeBaseVectorSearchConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
RetrievalFilter	filter()	Specifies the filters to use on the metadata fields in the knowledge base data sources before returning results.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	numberOfResults()	The number of text chunks to retrieve; the number of results to return.
SearchType	overrideSearchType()	By default, Amazon Bedrock decides a search strategy for you.
String	overrideSearchTypeAsString()	By default, Amazon Bedrock decides a search strategy for you.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends KnowledgeBaseVectorSearchConfiguration.Builder>	serializableBuilderClass()
KnowledgeBaseVectorSearchConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

numberOfResults

public final Integer numberOfResults()

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

Returns:

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

overrideSearchType

public final 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.

If the service returns an enum value that is not available in the current SDK version, overrideSearchType will return SearchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from overrideSearchTypeAsString().

Returns:

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.

See Also:

SearchType

overrideSearchTypeAsString

public final String overrideSearchTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, overrideSearchType will return SearchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from overrideSearchTypeAsString().

Returns:

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.

See Also:

SearchType

filter

public final RetrievalFilter filter()

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

Returns:

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

toBuilder

public KnowledgeBaseVectorSearchConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KnowledgeBaseVectorSearchConfiguration.Builder,KnowledgeBaseVectorSearchConfiguration>

builder

public static KnowledgeBaseVectorSearchConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends KnowledgeBaseVectorSearchConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo