Enum aws_sdk_qbusiness::types::ChatOutputStream

#[non_exhaustive]
pub enum ChatOutputStream {
    ActionReviewEvent(ActionReviewEvent),
    AuthChallengeRequestEvent(AuthChallengeRequestEvent),
    FailedAttachmentEvent(FailedAttachmentEvent),
    MetadataEvent(MetadataEvent),
    TextEvent(TextOutputEvent),
    Unknown,
}

The streaming output for the Chat API.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ActionReviewEvent(ActionReviewEvent)

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

AuthChallengeRequestEvent(AuthChallengeRequestEvent)

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

FailedAttachmentEvent(FailedAttachmentEvent)

A failed file upload event during a web experience chat.

MetadataEvent(MetadataEvent)

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

TextEvent(TextOutputEvent)

Information about the payload of the ChatOutputStream event containing the AI-generated message output.

Unknown

The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version. An unknown enum variant

Note: If you encounter this error, consider upgrading your SDK to the latest version. The Unknown variant represents cases where the server sent a value that wasn’t recognized by the client. This can happen when the server adds new functionality, but the client has not been updated. To investigate this, consider turning on debug logging to print the raw HTTP response.

Implementations

impl ChatOutputStream

pub fn as_action_review_event(&self) -> Result<&ActionReviewEvent, &Self>

Tries to convert the enum instance into ActionReviewEvent, extracting the inner ActionReviewEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_action_review_event(&self) -> bool

Returns true if this is a ActionReviewEvent.

pub fn as_auth_challenge_request_event( &self, ) -> Result<&AuthChallengeRequestEvent, &Self>

Tries to convert the enum instance into AuthChallengeRequestEvent, extracting the inner AuthChallengeRequestEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_auth_challenge_request_event(&self) -> bool

Returns true if this is a AuthChallengeRequestEvent.

pub fn as_failed_attachment_event( &self, ) -> Result<&FailedAttachmentEvent, &Self>

Tries to convert the enum instance into FailedAttachmentEvent, extracting the inner FailedAttachmentEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_failed_attachment_event(&self) -> bool

Returns true if this is a FailedAttachmentEvent.

pub fn as_metadata_event(&self) -> Result<&MetadataEvent, &Self>

Tries to convert the enum instance into MetadataEvent, extracting the inner MetadataEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_metadata_event(&self) -> bool

Returns true if this is a MetadataEvent.

pub fn as_text_event(&self) -> Result<&TextOutputEvent, &Self>

Tries to convert the enum instance into TextEvent, extracting the inner TextOutputEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_text_event(&self) -> bool

Returns true if this is a TextEvent.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for ChatOutputStream

fn clone(&self) -> ChatOutputStream

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChatOutputStream

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

Formats the value using the given formatter.

impl PartialEq for ChatOutputStream

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