Struct aws_sdk_bedrockagentruntime::operation::retrieve_and_generate::RetrieveAndGenerateOutput

#[non_exhaustive]
pub struct RetrieveAndGenerateOutput {
    pub session_id: String,
    pub output: Option<RetrieveAndGenerateOutput>,
    pub citations: Option<Vec<Citation>>,
    pub guardrail_action: Option<GuadrailAction>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

session_id: String

The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.

output: Option<RetrieveAndGenerateOutput>

Contains the response generated from querying the knowledge base.

citations: Option<Vec<Citation>>

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

guardrail_action: Option<GuadrailAction>

Specifies if there is a guardrail intervention in the response.

Implementations

impl RetrieveAndGenerateOutput

pub fn session_id(&self) -> &str

The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.

pub fn output(&self) -> Option<&RetrieveAndGenerateOutput>

Contains the response generated from querying the knowledge base.

pub fn citations(&self) -> &[Citation]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .citations.is_none().

pub fn guardrail_action(&self) -> Option<&GuadrailAction>

Specifies if there is a guardrail intervention in the response.

impl RetrieveAndGenerateOutput

pub fn builder() -> RetrieveAndGenerateOutputBuilder

Creates a new builder-style object to manufacture RetrieveAndGenerateOutput.

Trait Implementations

impl Clone for RetrieveAndGenerateOutput

fn clone(&self) -> RetrieveAndGenerateOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RetrieveAndGenerateOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for RetrieveAndGenerateOutput

fn eq(&self, other: &RetrieveAndGenerateOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for RetrieveAndGenerateOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for RetrieveAndGenerateOutput