com.amazonaws.services.bedrockagentruntime.model

Class KnowledgeBaseRetrieveAndGenerateConfiguration

java.lang.Object

com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Contains details about the resource being queried.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
KnowledgeBaseRetrieveAndGenerateConfiguration()

Method Summary

Modifier and Type	Method and Description
KnowledgeBaseRetrieveAndGenerateConfiguration	clone()
boolean	equals(Object obj)
String	getKnowledgeBaseId() The unique identifier of the knowledge base that is queried and the foundation model used for generation.
String	getModelArn() The ARN of the foundation model used to generate a response.
KnowledgeBaseRetrievalConfiguration	getRetrievalConfiguration() Contains configurations for how to retrieve and return the knowledge base query.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setKnowledgeBaseId(String knowledgeBaseId) The unique identifier of the knowledge base that is queried and the foundation model used for generation.
void	setModelArn(String modelArn) The ARN of the foundation model used to generate a response.
void	setRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration) Contains configurations for how to retrieve and return the knowledge base query.
String	toString() Returns a string representation of this object.
KnowledgeBaseRetrieveAndGenerateConfiguration	withKnowledgeBaseId(String knowledgeBaseId) The unique identifier of the knowledge base that is queried and the foundation model used for generation.
KnowledgeBaseRetrieveAndGenerateConfiguration	withModelArn(String modelArn) The ARN of the foundation model used to generate a response.
KnowledgeBaseRetrieveAndGenerateConfiguration	withRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration) Contains configurations for how to retrieve and return the knowledge base query.

Methods inherited from class java.lang.Object

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

Constructor Detail

KnowledgeBaseRetrieveAndGenerateConfiguration

public KnowledgeBaseRetrieveAndGenerateConfiguration()

Method Detail

setKnowledgeBaseId

public void setKnowledgeBaseId(String knowledgeBaseId)

The unique identifier of the knowledge base that is queried and the foundation model used for generation.

Parameters:

knowledgeBaseId - The unique identifier of the knowledge base that is queried and the foundation model used for generation.

getKnowledgeBaseId

public String getKnowledgeBaseId()

The unique identifier of the knowledge base that is queried and the foundation model used for generation.

Returns:

The unique identifier of the knowledge base that is queried and the foundation model used for generation.

withKnowledgeBaseId

public KnowledgeBaseRetrieveAndGenerateConfiguration withKnowledgeBaseId(String knowledgeBaseId)

The unique identifier of the knowledge base that is queried and the foundation model used for generation.

Parameters:

knowledgeBaseId - The unique identifier of the knowledge base that is queried and the foundation model used for generation.

Returns:

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

setModelArn

public void setModelArn(String modelArn)

The ARN of the foundation model used to generate a response.

Parameters:

modelArn - The ARN of the foundation model used to generate a response.

getModelArn

public String getModelArn()

The ARN of the foundation model used to generate a response.

Returns:

The ARN of the foundation model used to generate a response.

withModelArn

public KnowledgeBaseRetrieveAndGenerateConfiguration withModelArn(String modelArn)

The ARN of the foundation model used to generate a response.

Parameters:

modelArn - The ARN of the foundation model used to generate a response.

Returns:

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

setRetrievalConfiguration

public void setRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)

Contains configurations for how to retrieve and return the knowledge base query.

Parameters:

retrievalConfiguration - Contains configurations for how to retrieve and return the knowledge base query.

getRetrievalConfiguration

public KnowledgeBaseRetrievalConfiguration getRetrievalConfiguration()

Contains configurations for how to retrieve and return the knowledge base query.

Returns:

Contains configurations for how to retrieve and return the knowledge base query.

withRetrievalConfiguration

public KnowledgeBaseRetrieveAndGenerateConfiguration withRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)

Contains configurations for how to retrieve and return the knowledge base query.

Parameters:

retrievalConfiguration - Contains configurations for how to retrieve and return the knowledge base query.

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 KnowledgeBaseRetrieveAndGenerateConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo