Predict Qa Results

quicksight_predict_qa_results

R Documentation

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

Description

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

Usage

quicksight_predict_qa_results(AwsAccountId, QueryText,
  IncludeQuickSightQIndex, IncludeGeneratedAnswer, MaxTopicsToConsider)

Arguments

AwsAccountId

[required] The ID of the Amazon Web Services account that the user wants to execute Predict QA results in.

QueryText

[required] The query text to be used to predict QA results.

IncludeQuickSightQIndex

Indicates whether Q indicies are included or excluded.

IncludeGeneratedAnswer

Indicates whether generated answers are included or excluded.

MaxTopicsToConsider

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

Value

A list with the following syntax:

list(
  PrimaryResult = list(
    ResultType = "DASHBOARD_VISUAL"|"GENERATED_ANSWER"|"NO_ANSWER",
    DashboardVisual = list(
      DashboardId = "string",
      DashboardName = "string",
      SheetId = "string",
      SheetName = "string",
      VisualId = "string",
      VisualTitle = "string",
      VisualSubtitle = "string",
      DashboardUrl = "string"
    ),
    GeneratedAnswer = list(
      QuestionText = "string",
      AnswerStatus = "ANSWER_GENERATED"|"ANSWER_RETRIEVED"|"ANSWER_DOWNGRADE",
      TopicId = "string",
      TopicName = "string",
      Restatement = "string",
      QuestionId = "string",
      AnswerId = "string",
      QuestionUrl = "string"
    )
  ),
  AdditionalResults = list(
    list(
      ResultType = "DASHBOARD_VISUAL"|"GENERATED_ANSWER"|"NO_ANSWER",
      DashboardVisual = list(
        DashboardId = "string",
        DashboardName = "string",
        SheetId = "string",
        SheetName = "string",
        VisualId = "string",
        VisualTitle = "string",
        VisualSubtitle = "string",
        DashboardUrl = "string"
      ),
      GeneratedAnswer = list(
        QuestionText = "string",
        AnswerStatus = "ANSWER_GENERATED"|"ANSWER_RETRIEVED"|"ANSWER_DOWNGRADE",
        TopicId = "string",
        TopicName = "string",
        Restatement = "string",
        QuestionId = "string",
        AnswerId = "string",
        QuestionUrl = "string"
      )
    )
  ),
  RequestId = "string",
  Status = 123
)

Request syntax

svc$predict_qa_results(
  AwsAccountId = "string",
  QueryText = "string",
  IncludeQuickSightQIndex = "INCLUDE"|"EXCLUDE",
  IncludeGeneratedAnswer = "INCLUDE"|"EXCLUDE",
  MaxTopicsToConsider = 123
)