ActionReviewEvent¶
Structure Class¶
dataclass
¶
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.
Attributes¶
class-attribute
instance-attribute
¶
conversation_id: str | None = None
The identifier of the conversation with which the action review event is associated.
class-attribute
instance-attribute
¶
payload: dict[str, ActionReviewPayloadField] | None = None
Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
class-attribute
instance-attribute
¶
payload_field_name_separator: str | None = None
A string used to retain information about the hierarchical contexts within an action review event payload.
class-attribute
instance-attribute
¶
plugin_id: str | None = None
The identifier of the plugin associated with the action review event.
class-attribute
instance-attribute
¶
plugin_type: PluginType | None = None
The type of plugin.
class-attribute
instance-attribute
¶
system_message_id: str | None = None
The identifier of an Amazon Q Business AI generated associated with the action review event.
class-attribute
instance-attribute
¶
user_message_id: str | None = None
The identifier of the conversation with which the plugin action is associated.