Struct MetadataEvent 

#[non_exhaustive]
pub struct MetadataEvent {
    pub conversation_id: Option<String>,
    pub user_message_id: Option<String>,
    pub system_message_id: Option<String>,
    pub source_attributions: Option<Vec<Option<SourceAttribution>>>,
    pub final_text_message: Option<String>,
}

A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.

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.

conversation_id: Option<String>

The identifier of the conversation with which the generated metadata is associated.

user_message_id: Option<String>

The identifier of an Amazon Q Business end user text input message within the conversation.

system_message_id: Option<String>

The identifier of an Amazon Q Business AI generated message within the conversation.

source_attributions: Option<Vec<Option<SourceAttribution>>>

The source documents used to generate the conversation response.

final_text_message: Option<String>

The final text output message generated by the system.

Implementations

impl MetadataEvent

pub fn conversation_id(&self) -> Option<&str>

The identifier of the conversation with which the generated metadata is associated.

pub fn user_message_id(&self) -> Option<&str>

The identifier of an Amazon Q Business end user text input message within the conversation.

pub fn system_message_id(&self) -> Option<&str>

The identifier of an Amazon Q Business AI generated message within the conversation.

pub fn source_attributions(&self) -> &[Option<SourceAttribution>]

The source documents used to generate the conversation response.

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

pub fn final_text_message(&self) -> Option<&str>

The final text output message generated by the system.

impl MetadataEvent

pub fn builder() -> MetadataEventBuilder

Creates a new builder-style object to manufacture MetadataEvent.

Trait Implementations

impl Clone for MetadataEvent

fn clone(&self) -> MetadataEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataEvent

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

Formats the value using the given formatter.

impl PartialEq for MetadataEvent

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for MetadataEvent