qbusiness/aws.sdk.kotlin.services.qbusiness.model/ActionReviewEvent

ActionReviewEvent

class ActionReviewEvent

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.

Types

object Companion

Properties

val conversationId: String?

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

val payload: Map<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.

payloadFieldNameSeparator

val payloadFieldNameSeparator: String?

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

val pluginId: String?

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

val pluginType: PluginType?

The type of plugin.

systemMessageId

val systemMessageId: String?

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

val userMessageId: String?

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

Functions

inline fun copy(block: ActionReviewEvent.Builder.() -> Unit = {}): ActionReviewEvent

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String