Struct ActionReviewEvent 

#[non_exhaustive]
pub struct ActionReviewEvent {
    pub conversation_id: Option<String>,
    pub user_message_id: Option<String>,
    pub system_message_id: Option<String>,
    pub plugin_id: Option<String>,
    pub plugin_type: Option<PluginType>,
    pub payload: Option<HashMap<String, ActionReviewPayloadField>>,
    pub payload_field_name_separator: Option<String>,
}

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

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 action review event is associated.

user_message_id: Option<String>

The identifier of the conversation with which the plugin action is associated.

system_message_id: Option<String>

The identifier of an Amazon Q Business AI generated associated with the action review event.

plugin_id: Option<String>

The identifier of the plugin associated with the action review event.

plugin_type: Option<PluginType>

The type of plugin.

payload: Option<HashMap<String, ActionReviewPayloadField>>

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

payload_field_name_separator: Option<String>

A string used to retain information about the hierarchical contexts within an action review event payload.

Implementations

impl ActionReviewEvent

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

The identifier of the conversation with which the action review event is associated.

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

The identifier of the conversation with which the plugin action is associated.

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

The identifier of an Amazon Q Business AI generated associated with the action review event.

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

The identifier of the plugin associated with the action review event.

pub fn plugin_type(&self) -> Option<&PluginType>

The type of plugin.

pub fn payload(&self) -> Option<&HashMap<String, ActionReviewPayloadField>>

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

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

A string used to retain information about the hierarchical contexts within an action review event payload.

impl ActionReviewEvent

pub fn builder() -> ActionReviewEventBuilder

Creates a new builder-style object to manufacture ActionReviewEvent.

Trait Implementations

impl Clone for ActionReviewEvent

fn clone(&self) -> ActionReviewEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActionReviewEvent

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

Formats the value using the given formatter.

impl PartialEq for ActionReviewEvent

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