Module Values.ChatOutputStreamSource

The streaming output for the Chat API.

Sourcetype nonrec t = {
  1. textEvent : TextOutputEvent.t option;
    (*

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

    *)
  2. metadataEvent : MetadataEvent.t option;
    (*

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

    *)
  3. actionReviewEvent : ActionReviewEvent.t option;
    (*

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

    *)
  4. failedAttachmentEvent : FailedAttachmentEvent.t option;
    (*

    A failed file upload event during a web experience chat.

    *)
  5. authChallengeRequestEvent : AuthChallengeRequestEvent.t option;
    (*

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

    *)
}
Sourceval make : ?textEvent:??? -> ?metadataEvent:??? -> ?actionReviewEvent:??? -> ?failedAttachmentEvent:??? -> ?authChallengeRequestEvent:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Integer of Integer.t | `List of [> `Structure of (string * [> `Integer of Integer.t | `String of SourceAttributionMediaId.t | `Structure of (string * [> `String of SnippetExcerptText.t | `Structure of (string * [> `Enum of string | `Long of Long.t | `String of MediaId.t ]) list ]) list ]) list ] list | `String of String_.t | `Timestamp of Timestamp.t ]) list ] list | `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 | `Structure of (string * [> `Enum of string | `String of AttachmentName.t | `Structure of (string * [> `Enum of string | `String of ErrorMessage.t ]) list ]) list ]) list ]) 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