com.amazonaws.services.bedrockagentruntime.model

Class KnowledgeBaseRetrievalConfiguration

java.lang.Object

com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Contains configurations for knowledge base query. For more information, see Query configurations.

This data type is used in the following API operations:

• Retrieve request – in the retrievalConfiguration field

• RetrieveAndGenerate request – in the retrievalConfiguration field

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
KnowledgeBaseRetrievalConfiguration()

Method Summary

Modifier and Type	Method and Description
KnowledgeBaseRetrievalConfiguration	clone()
boolean	equals(Object obj)
KnowledgeBaseVectorSearchConfiguration	getVectorSearchConfiguration() Contains details about how the results from the vector search should be returned.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setVectorSearchConfiguration(KnowledgeBaseVectorSearchConfiguration vectorSearchConfiguration) Contains details about how the results from the vector search should be returned.
String	toString() Returns a string representation of this object.
KnowledgeBaseRetrievalConfiguration	withVectorSearchConfiguration(KnowledgeBaseVectorSearchConfiguration vectorSearchConfiguration) Contains details about how the results from the vector search should be returned.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

KnowledgeBaseRetrievalConfiguration

public KnowledgeBaseRetrievalConfiguration()

Method Detail

setVectorSearchConfiguration

public void setVectorSearchConfiguration(KnowledgeBaseVectorSearchConfiguration vectorSearchConfiguration)

Contains details about how the results from the vector search should be returned. For more information, see Query configurations.

Parameters:

vectorSearchConfiguration - Contains details about how the results from the vector search should be returned. For more information, see Query configurations.

getVectorSearchConfiguration

public KnowledgeBaseVectorSearchConfiguration getVectorSearchConfiguration()

Contains details about how the results from the vector search should be returned. For more information, see Query configurations.

Returns:

Contains details about how the results from the vector search should be returned. For more information, see Query configurations.

withVectorSearchConfiguration

public KnowledgeBaseRetrievalConfiguration withVectorSearchConfiguration(KnowledgeBaseVectorSearchConfiguration vectorSearchConfiguration)

Contains details about how the results from the vector search should be returned. For more information, see Query configurations.

Parameters:

vectorSearchConfiguration - Contains details about how the results from the vector search should be returned. For more information, see Query configurations.

Returns:

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

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 KnowledgeBaseRetrievalConfiguration 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.