Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PredictQAResults

Predicts existing visuals or generates new visuals to answer a given query.

Request Syntax


POST /accounts/AwsAccountId/qa/predict HTTP/1.1
Content-type: application/json

{
   "IncludeGeneratedAnswer": "string",
   "IncludeQuickSightQIndex": "string",
   "MaxTopicsToConsider": number,
   "QueryText": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the AWS account that the user wants to execute Predict QA results in.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

QueryText

The query text to be used to predict QA results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: Yes

IncludeGeneratedAnswer

Indicates whether generated answers are included or excluded.

Type: String

Valid Values: INCLUDE | EXCLUDE

Required: No

IncludeQuickSightQIndex

Indicates whether Q indicies are included or excluded.

Type: String

Valid Values: INCLUDE | EXCLUDE

Required: No

MaxTopicsToConsider

The number of maximum topics to be considered to predict QA results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 4.

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "AdditionalResults": [ 
      { 
         "DashboardVisual": { 
            "DashboardId": "string",
            "DashboardName": "string",
            "DashboardUrl": "string",
            "SheetId": "string",
            "SheetName": "string",
            "VisualId": "string",
            "VisualSubtitle": "string",
            "VisualTitle": "string"
         },
         "GeneratedAnswer": { 
            "AnswerId": "string",
            "AnswerStatus": "string",
            "QuestionId": "string",
            "QuestionText": "string",
            "QuestionUrl": "string",
            "Restatement": "string",
            "TopicId": "string",
            "TopicName": "string"
         },
         "ResultType": "string"
      }
   ],
   "PrimaryResult": { 
      "DashboardVisual": { 
         "DashboardId": "string",
         "DashboardName": "string",
         "DashboardUrl": "string",
         "SheetId": "string",
         "SheetName": "string",
         "VisualId": "string",
         "VisualSubtitle": "string",
         "VisualTitle": "string"
      },
      "GeneratedAnswer": { 
         "AnswerId": "string",
         "AnswerStatus": "string",
         "QuestionId": "string",
         "QuestionText": "string",
         "QuestionUrl": "string",
         "Restatement": "string",
         "TopicId": "string",
         "TopicName": "string"
      },
      "ResultType": "string"
   },
   "RequestId": "string"
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of the request.

The following data is returned in JSON format by the service.

AdditionalResults

Additional visual responses.

Type: Array of QAResult objects

PrimaryResult

The primary visual response.

Type: QAResult object

RequestId

The AWS request ID for this operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

ThrottlingException

Access is throttled.

HTTP Status Code: 429