com.amazonaws.services.bedrockagentruntime.model

Class RetrieveAndGenerateResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RetrieveAndGenerateResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RetrieveAndGenerateResult()

Method Summary

Modifier and Type	Method and Description
RetrieveAndGenerateResult	clone()
boolean	equals(Object obj)
List<Citation>	getCitations() A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
String	getGuardrailAction() Specifies if there is a guardrail intervention in the response.
RetrieveAndGenerateOutput	getOutput() Contains the response generated from querying the knowledge base.
String	getSessionId() The unique identifier of the session.
int	hashCode()
void	setCitations(Collection<Citation> citations) A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
void	setGuardrailAction(String guardrailAction) Specifies if there is a guardrail intervention in the response.
void	setOutput(RetrieveAndGenerateOutput output) Contains the response generated from querying the knowledge base.
void	setSessionId(String sessionId) The unique identifier of the session.
String	toString() Returns a string representation of this object.
RetrieveAndGenerateResult	withCitations(Citation... citations) A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
RetrieveAndGenerateResult	withCitations(Collection<Citation> citations) A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
RetrieveAndGenerateResult	withGuardrailAction(GuadrailAction guardrailAction) Specifies if there is a guardrail intervention in the response.
RetrieveAndGenerateResult	withGuardrailAction(String guardrailAction) Specifies if there is a guardrail intervention in the response.
RetrieveAndGenerateResult	withOutput(RetrieveAndGenerateOutput output) Contains the response generated from querying the knowledge base.
RetrieveAndGenerateResult	withSessionId(String sessionId) The unique identifier of the session.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RetrieveAndGenerateResult

public RetrieveAndGenerateResult()

Method Detail

getCitations

public List<Citation> getCitations()

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

Returns:

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

setCitations

public void setCitations(Collection<Citation> citations)

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

Parameters:

citations - A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

withCitations

public RetrieveAndGenerateResult withCitations(Citation... citations)

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

NOTE: This method appends the values to the existing list (if any). Use setCitations(java.util.Collection) or withCitations(java.util.Collection) if you want to override the existing values.

Parameters:

citations - A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

Returns:

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

withCitations

public RetrieveAndGenerateResult withCitations(Collection<Citation> citations)

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

Parameters:

citations - A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

Returns:

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

setGuardrailAction

public void setGuardrailAction(String guardrailAction)

Specifies if there is a guardrail intervention in the response.

Parameters:

guardrailAction - Specifies if there is a guardrail intervention in the response.

See Also:

GuadrailAction

getGuardrailAction

public String getGuardrailAction()

Specifies if there is a guardrail intervention in the response.

Returns:

Specifies if there is a guardrail intervention in the response.

See Also:

GuadrailAction

withGuardrailAction

public RetrieveAndGenerateResult withGuardrailAction(String guardrailAction)

Specifies if there is a guardrail intervention in the response.

Parameters:

guardrailAction - Specifies if there is a guardrail intervention in the response.

Returns:

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

See Also:

GuadrailAction

withGuardrailAction

public RetrieveAndGenerateResult withGuardrailAction(GuadrailAction guardrailAction)

Specifies if there is a guardrail intervention in the response.

Parameters:

guardrailAction - Specifies if there is a guardrail intervention in the response.

Returns:

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

See Also:

GuadrailAction

setOutput

public void setOutput(RetrieveAndGenerateOutput output)

Contains the response generated from querying the knowledge base.

Parameters:

output - Contains the response generated from querying the knowledge base.

getOutput

public RetrieveAndGenerateOutput getOutput()

Contains the response generated from querying the knowledge base.

Returns:

Contains the response generated from querying the knowledge base.

withOutput

public RetrieveAndGenerateResult withOutput(RetrieveAndGenerateOutput output)

Contains the response generated from querying the knowledge base.

Parameters:

output - Contains the response generated from querying 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 RetrieveAndGenerateResult 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 RetrieveAndGenerateResult clone()

Overrides:

clone in class Object