Struct ChatSyncOutput 

#[non_exhaustive]
pub struct ChatSyncOutput {
    pub conversation_id: Option<String>,
    pub system_message: Option<String>,
    pub system_message_id: Option<String>,
    pub user_message_id: Option<String>,
    pub action_review: Option<ActionReview>,
    pub auth_challenge_request: Option<AuthChallengeRequest>,
    pub source_attributions: Option<Vec<Option<SourceAttribution>>>,
    pub failed_attachments: Option<Vec<AttachmentOutput>>,
    /* 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.

conversation_id: Option<String>

The identifier of the Amazon Q Business conversation.

system_message: Option<String>

An AI-generated message in a conversation.

system_message_id: Option<String>

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

user_message_id: Option<String>

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

action_review: Option<ActionReview>

A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

auth_challenge_request: Option<AuthChallengeRequest>

An authentication verification event activated by an end user request to use a custom plugin.

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

The source documents used to generate the conversation response.

failed_attachments: Option<Vec<AttachmentOutput>>

A list of files which failed to upload during chat.

Implementations

impl ChatSyncOutput

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

The identifier of the Amazon Q Business conversation.

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

An AI-generated message in a conversation.

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

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

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 action_review(&self) -> Option<&ActionReview>

A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

pub fn auth_challenge_request(&self) -> Option<&AuthChallengeRequest>

An authentication verification event activated by an end user request to use a custom plugin.

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 failed_attachments(&self) -> &[AttachmentOutput]

A list of files which failed to upload during chat.

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

impl ChatSyncOutput

pub fn builder() -> ChatSyncOutputBuilder

Creates a new builder-style object to manufacture ChatSyncOutput.

Trait Implementations

impl Clone for ChatSyncOutput

fn clone(&self) -> ChatSyncOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatSyncOutput

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

Formats the value using the given formatter.

impl PartialEq for ChatSyncOutput

fn eq(&self, other: &ChatSyncOutput) -> 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 RequestId for ChatSyncOutput

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

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

impl StructuralPartialEq for ChatSyncOutput