com.amazonaws.services.bedrockagentruntime.model

Class RetrieveAndGenerateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RetrieveAndGenerateRequest()

Method Summary

Modifier and Type	Method and Description
RetrieveAndGenerateRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
RetrieveAndGenerateInput	getInput() Contains the query to be made to the knowledge base.
RetrieveAndGenerateConfiguration	getRetrieveAndGenerateConfiguration() Contains configurations for the knowledge base query and retrieval process.
RetrieveAndGenerateSessionConfiguration	getSessionConfiguration() Contains details about the session with the knowledge base.
String	getSessionId() The unique identifier of the session.
int	hashCode()
void	setInput(RetrieveAndGenerateInput input) Contains the query to be made to the knowledge base.
void	setRetrieveAndGenerateConfiguration(RetrieveAndGenerateConfiguration retrieveAndGenerateConfiguration) Contains configurations for the knowledge base query and retrieval process.
void	setSessionConfiguration(RetrieveAndGenerateSessionConfiguration sessionConfiguration) Contains details about the session with the knowledge base.
void	setSessionId(String sessionId) The unique identifier of the session.
String	toString() Returns a string representation of this object.
RetrieveAndGenerateRequest	withInput(RetrieveAndGenerateInput input) Contains the query to be made to the knowledge base.
RetrieveAndGenerateRequest	withRetrieveAndGenerateConfiguration(RetrieveAndGenerateConfiguration retrieveAndGenerateConfiguration) Contains configurations for the knowledge base query and retrieval process.
RetrieveAndGenerateRequest	withSessionConfiguration(RetrieveAndGenerateSessionConfiguration sessionConfiguration) Contains details about the session with the knowledge base.
RetrieveAndGenerateRequest	withSessionId(String sessionId) The unique identifier of the session.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RetrieveAndGenerateRequest

public RetrieveAndGenerateRequest()

Method Detail

setInput

public void setInput(RetrieveAndGenerateInput input)

Contains the query to be made to the knowledge base.

Parameters:

input - Contains the query to be made to the knowledge base.

getInput

public RetrieveAndGenerateInput getInput()

Contains the query to be made to the knowledge base.

Returns:

Contains the query to be made to the knowledge base.

withInput

public RetrieveAndGenerateRequest withInput(RetrieveAndGenerateInput input)

Contains the query to be made to the knowledge base.

Parameters:

input - Contains the query to be made to the knowledge base.

Returns:

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

setRetrieveAndGenerateConfiguration

public void setRetrieveAndGenerateConfiguration(RetrieveAndGenerateConfiguration retrieveAndGenerateConfiguration)

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

Parameters:

retrieveAndGenerateConfiguration - Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

getRetrieveAndGenerateConfiguration

public RetrieveAndGenerateConfiguration getRetrieveAndGenerateConfiguration()

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

Returns:

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

withRetrieveAndGenerateConfiguration

public RetrieveAndGenerateRequest withRetrieveAndGenerateConfiguration(RetrieveAndGenerateConfiguration retrieveAndGenerateConfiguration)

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

Parameters:

retrieveAndGenerateConfiguration - Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

Returns:

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

setSessionConfiguration

public void setSessionConfiguration(RetrieveAndGenerateSessionConfiguration sessionConfiguration)

Contains details about the session with the knowledge base.

Parameters:

sessionConfiguration - Contains details about the session with the knowledge base.

getSessionConfiguration

public RetrieveAndGenerateSessionConfiguration getSessionConfiguration()

Contains details about the session with the knowledge base.

Returns:

Contains details about the session with the knowledge base.

withSessionConfiguration

public RetrieveAndGenerateRequest withSessionConfiguration(RetrieveAndGenerateSessionConfiguration sessionConfiguration)

Contains details about the session with the knowledge base.

Parameters:

sessionConfiguration - Contains details about the session with the knowledge base.

Returns:

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

setSessionId

public void setSessionId(String sessionId)

The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

Parameters:

sessionId - The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

getSessionId

public String getSessionId()

The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

Returns:

The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

withSessionId

public RetrieveAndGenerateRequest withSessionId(String sessionId)

The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

Parameters:

sessionId - The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()