Module Values_2.PredictQAResultsResponseSource

Predicts existing visuals or generates new visuals to answer a given query. This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Quick with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Quick resource and permissions. We recommend enabling the QSearchStatus API to unlock the full potential of PredictQnA. When QSearchStatus is enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found, PredictQnA uses generative Q&A to provide an answer. To update the QSearchStatus, see UpdateQuickSightQSearchConfiguration.

Sourcetype nonrec t = {
  1. primaryResult : QAResult.t option;
    (*

    The primary visual response.

    *)
  2. additionalResults : QAResults.t option;
    (*

    Additional visual responses.

    *)
  3. requestId : Values_0.String_.t option;
    (*

    The Amazon Web Services request ID for this operation.

    *)
  4. status : Values_1.StatusCode.t option;
    (*

    The HTTP status of the request.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of Values_0.AccessDeniedException.t
  2. | `InternalFailureException of Values_1.InternalFailureException.t
  3. | `InvalidParameterValueException of Values_1.InvalidParameterValueException.t
  4. | `ThrottlingException of Values_1.ThrottlingException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?primaryResult:??? -> ?additionalResults:??? -> ?requestId:??? -> ?status:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of Values_0.AccessDeniedException.t | `InternalFailureException of Values_1.InternalFailureException.t | `InvalidParameterValueException of Values_1.InvalidParameterValueException.t | `ThrottlingException of Values_1.ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of Values_0.AccessDeniedException.t | `InternalFailureException of Values_1.InternalFailureException.t | `InvalidParameterValueException of Values_1.InvalidParameterValueException.t | `ThrottlingException of Values_1.ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of Values_1.StatusCode.t | `List of [> `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `String of Values_0.ShortRestrictiveResourceId.t ]) list ]) list ] list | `String of Values_0.String_.t | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `String of Values_0.ShortRestrictiveResourceId.t ]) 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