Module Values.TextOutputEventSource

An output event for an AI-generated response in an Amazon Q Business web experience.

Sourcetype nonrec t = {
  1. systemMessageType : SystemMessageType.t option;
    (*

    The type of AI-generated message in a TextOutputEvent. Amazon Q Business currently supports two types of messages: RESPONSE - The Amazon Q Business system response. GROUNDED_RESPONSE - The corrected, hallucination-reduced, response returned by Amazon Q Business. Available only if hallucination reduction is supported and configured for the application and detected in the end user chat query by Amazon Q Business.

    *)
  2. conversationId : ConversationId.t option;
    (*

    The identifier of the conversation with which the text output event is associated.

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

    The identifier of an end user message in a TextOutputEvent.

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

    The identifier of an AI-generated message in a TextOutputEvent.

    *)
  5. systemMessage : String_.t option;
    (*

    An AI-generated message in a TextOutputEvent.

    *)
}
Sourceval make : ?systemMessageType:??? -> ?conversationId:??? -> ?userMessageId:??? -> ?systemMessageId:??? -> ?systemMessage:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `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