com.amazonaws.services.bedrockagentruntime.model

Class KnowledgeBaseVectorSearchConfiguration

java.lang.Object

com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KnowledgeBaseVectorSearchConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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 vectorSearchConfiguration field

• RetrieveAndGenerate request – in the vectorSearchConfiguration field

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
KnowledgeBaseVectorSearchConfiguration()

Method Summary

Modifier and Type	Method and Description
KnowledgeBaseVectorSearchConfiguration	clone()
boolean	equals(Object obj)
RetrievalFilter	getFilter() Specifies the filters to use on the metadata in the knowledge base data sources before returning results.
Integer	getNumberOfResults() The number of source chunks to retrieve.
String	getOverrideSearchType() By default, Amazon Bedrock decides a search strategy for you.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setFilter(RetrievalFilter filter) Specifies the filters to use on the metadata in the knowledge base data sources before returning results.
void	setNumberOfResults(Integer numberOfResults) The number of source chunks to retrieve.
void	setOverrideSearchType(String overrideSearchType) By default, Amazon Bedrock decides a search strategy for you.
String	toString() Returns a string representation of this object.
KnowledgeBaseVectorSearchConfiguration	withFilter(RetrievalFilter filter) Specifies the filters to use on the metadata in the knowledge base data sources before returning results.
KnowledgeBaseVectorSearchConfiguration	withNumberOfResults(Integer numberOfResults) The number of source chunks to retrieve.
KnowledgeBaseVectorSearchConfiguration	withOverrideSearchType(SearchType overrideSearchType) By default, Amazon Bedrock decides a search strategy for you.
KnowledgeBaseVectorSearchConfiguration	withOverrideSearchType(String overrideSearchType) By default, Amazon Bedrock decides a search strategy for you.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

KnowledgeBaseVectorSearchConfiguration

public KnowledgeBaseVectorSearchConfiguration()

Method Detail

setFilter

public void setFilter(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.

getFilter

public RetrievalFilter getFilter()

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

Returns:

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

withFilter

public KnowledgeBaseVectorSearchConfiguration withFilter(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.

setNumberOfResults

public void setNumberOfResults(Integer numberOfResults)

The number of source chunks to retrieve.

Parameters:

numberOfResults - The number of source chunks to retrieve.

getNumberOfResults

public Integer getNumberOfResults()

The number of source chunks to retrieve.

Returns:

The number of source chunks to retrieve.

withNumberOfResults

public KnowledgeBaseVectorSearchConfiguration withNumberOfResults(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.

setOverrideSearchType

public void setOverrideSearchType(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.

See Also:

SearchType

getOverrideSearchType

public String getOverrideSearchType()

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:

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.

See Also:

SearchType

withOverrideSearchType

public KnowledgeBaseVectorSearchConfiguration withOverrideSearchType(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

withOverrideSearchType

public KnowledgeBaseVectorSearchConfiguration withOverrideSearchType(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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public KnowledgeBaseVectorSearchConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.