Skip to content

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.

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 Amazon QuickSight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon QuickSight 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 update_quick_sight_q_search_configuration.

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
)