import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { PredictQAResultsRequest, PredictQAResultsResponse } from "../models/models_4"; import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link PredictQAResultsCommand}. */ export interface PredictQAResultsCommandInput extends PredictQAResultsRequest { } /** * @public * * The output of {@link PredictQAResultsCommand}. */ export interface PredictQAResultsCommandOutput extends PredictQAResultsResponse, __MetadataBearer { } declare const PredictQAResultsCommand_base: { new (input: PredictQAResultsCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: PredictQAResultsCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { QuickSightClient, PredictQAResultsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import * // const { QuickSightClient, PredictQAResultsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import * // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight"; * const config = {}; // type is QuickSightClientConfig * const client = new QuickSightClient(config); * const input = { // PredictQAResultsRequest * AwsAccountId: "STRING_VALUE", // required * QueryText: "STRING_VALUE", // required * IncludeQuickSightQIndex: "INCLUDE" || "EXCLUDE", * IncludeGeneratedAnswer: "INCLUDE" || "EXCLUDE", * MaxTopicsToConsider: Number("int"), * }; * const command = new PredictQAResultsCommand(input); * const response = await client.send(command); * // { // PredictQAResultsResponse * // PrimaryResult: { // QAResult * // ResultType: "DASHBOARD_VISUAL" || "GENERATED_ANSWER" || "NO_ANSWER", * // DashboardVisual: { // DashboardVisualResult * // DashboardId: "STRING_VALUE", * // DashboardName: "STRING_VALUE", * // SheetId: "STRING_VALUE", * // SheetName: "STRING_VALUE", * // VisualId: "STRING_VALUE", * // VisualTitle: "STRING_VALUE", * // VisualSubtitle: "STRING_VALUE", * // DashboardUrl: "STRING_VALUE", * // }, * // GeneratedAnswer: { // GeneratedAnswerResult * // QuestionText: "STRING_VALUE", * // AnswerStatus: "ANSWER_GENERATED" || "ANSWER_RETRIEVED" || "ANSWER_DOWNGRADE", * // TopicId: "STRING_VALUE", * // TopicName: "STRING_VALUE", * // Restatement: "STRING_VALUE", * // QuestionId: "STRING_VALUE", * // AnswerId: "STRING_VALUE", * // QuestionUrl: "STRING_VALUE", * // }, * // }, * // AdditionalResults: [ // QAResults * // { * // ResultType: "DASHBOARD_VISUAL" || "GENERATED_ANSWER" || "NO_ANSWER", * // DashboardVisual: { * // DashboardId: "STRING_VALUE", * // DashboardName: "STRING_VALUE", * // SheetId: "STRING_VALUE", * // SheetName: "STRING_VALUE", * // VisualId: "STRING_VALUE", * // VisualTitle: "STRING_VALUE", * // VisualSubtitle: "STRING_VALUE", * // DashboardUrl: "STRING_VALUE", * // }, * // GeneratedAnswer: { * // QuestionText: "STRING_VALUE", * // AnswerStatus: "ANSWER_GENERATED" || "ANSWER_RETRIEVED" || "ANSWER_DOWNGRADE", * // TopicId: "STRING_VALUE", * // TopicName: "STRING_VALUE", * // Restatement: "STRING_VALUE", * // QuestionId: "STRING_VALUE", * // AnswerId: "STRING_VALUE", * // QuestionUrl: "STRING_VALUE", * // }, * // }, * // ], * // RequestId: "STRING_VALUE", * // Status: Number("int"), * // }; * * ``` * * @param PredictQAResultsCommandInput - {@link PredictQAResultsCommandInput} * @returns {@link PredictQAResultsCommandOutput} * @see {@link PredictQAResultsCommandInput} for command's `input` shape. * @see {@link PredictQAResultsCommandOutput} for command's `response` shape. * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

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 Quick Sight service, that your policies have the * correct permissions, and that you are using the correct credentials.

* * @throws {@link InternalFailureException} (server fault) *

An internal failure occurred.

* * @throws {@link InvalidParameterValueException} (client fault) *

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

* * @throws {@link ThrottlingException} (client fault) *

Access is throttled.

* * @throws {@link QuickSightServiceException} *

Base exception class for all service exceptions from QuickSight service.

* * * @public */ export declare class PredictQAResultsCommand extends PredictQAResultsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: PredictQAResultsRequest; output: PredictQAResultsResponse; }; sdk: { input: PredictQAResultsCommandInput; output: PredictQAResultsCommandOutput; }; }; }