Module Values.ActionReviewEventSource

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.

Sourcetype nonrec t = {
  1. conversationId : ConversationId.t option;
    (*

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

    *)
  2. userMessageId : MessageId.t option;
    (*

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

    *)
  3. systemMessageId : MessageId.t option;
    (*

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

    *)
  4. pluginId : PluginId.t option;
    (*

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

    *)
  5. pluginType : PluginType.t option;
    (*

    The type of plugin.

    *)
  6. payload : ActionReviewPayload.t option;
    (*

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

    *)
  7. payloadFieldNameSeparator : ActionPayloadFieldNameSeparator.t option;
    (*

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

    *)
}
Sourceval make : ?conversationId:??? -> ?userMessageId:??? -> ?systemMessageId:??? -> ?pluginId:??? -> ?pluginType:??? -> ?payload:??? -> ?payloadFieldNameSeparator:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Map of ([> `String of ActionPayloadFieldKey.t ] * [> `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t | `List of [> `Structure of (string * [> `Structure of 'a list ]) list ] list | `String of String_.t | `Structure of 'b list ]) list ]) list | `String of ConversationId.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t