Module Values.ChatSyncOutputSource

Starts or continues a non-streaming Amazon Q Business conversation.

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

    The identifier of the Amazon Q Business conversation.

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

    An AI-generated message in a conversation.

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

    The identifier of an Amazon Q Business AI generated message within the conversation.

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

    The identifier of an Amazon Q Business end user text input message within the conversation.

    *)
  5. actionReview : ActionReview.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.

    *)
  6. authChallengeRequest : AuthChallengeRequest.t option;
    (*

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

    *)
  7. sourceAttributions : SourceAttributions.t option;
    (*

    The source documents used to generate the conversation response.

    *)
  8. failedAttachments : AttachmentsOutput.t option;
    (*

    A list of files which failed to upload during chat.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `ConflictException of ConflictException.t
  3. | `ExternalResourceException of ExternalResourceException.t
  4. | `InternalServerException of InternalServerException.t
  5. | `LicenseNotFoundException of LicenseNotFoundException.t
  6. | `ResourceNotFoundException of ResourceNotFoundException.t
  7. | `ThrottlingException of ThrottlingException.t
  8. | `ValidationException of ValidationException.t
  9. | `Unknown_operation_error of string * string option
]
Sourceval make : ?conversationId:??? -> ?systemMessage:??? -> ?systemMessageId:??? -> ?userMessageId:??? -> ?actionReview:??? -> ?authChallengeRequest:??? -> ?sourceAttributions:??? -> ?failedAttachments:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `ConflictException of ConflictException.t | `ExternalResourceException of ExternalResourceException.t | `InternalServerException of InternalServerException.t | `LicenseNotFoundException of LicenseNotFoundException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `ConflictException of ConflictException.t | `ExternalResourceException of ExternalResourceException.t | `InternalServerException of InternalServerException.t | `LicenseNotFoundException of LicenseNotFoundException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `Enum 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 | `Structure of (string * [> `Enum of string | `String of ErrorMessage.t ]) list | `Timestamp of Timestamp.t ]) list ] list | `String of ConversationId.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 PluginId.t ]) 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