import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { QueryAssistantRequest } from "../models/models_0"; import type { QueryAssistantResponse } from "../models/models_1"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link QueryAssistantCommand}. */ export interface QueryAssistantCommandInput extends QueryAssistantRequest { } /** * @public * * The output of {@link QueryAssistantCommand}. */ export interface QueryAssistantCommandOutput extends QueryAssistantResponse, __MetadataBearer { } declare const QueryAssistantCommand_base: { new (input: QueryAssistantCommandInput): import("@smithy/core/client").CommandImpl; new (input: QueryAssistantCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

* * @deprecated QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { QConnectClient, QueryAssistantCommand } from "@aws-sdk/client-qconnect"; // ES Modules import * // const { QConnectClient, QueryAssistantCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import * // import type { QConnectClientConfig } from "@aws-sdk/client-qconnect"; * const config = {}; // type is QConnectClientConfig * const client = new QConnectClient(config); * const input = { // QueryAssistantRequest * assistantId: "STRING_VALUE", // required * queryText: "STRING_VALUE", * nextToken: "STRING_VALUE", * maxResults: Number("int"), * sessionId: "STRING_VALUE", * queryCondition: [ // QueryConditionExpression * { // QueryCondition Union: only one key present * single: { // QueryConditionItem * field: "STRING_VALUE", // required * comparator: "STRING_VALUE", // required * value: "STRING_VALUE", // required * }, * }, * ], * queryInputData: { // QueryInputData Union: only one key present * queryTextInputData: { // QueryTextInputData * text: "STRING_VALUE", // required * }, * intentInputData: { // IntentInputData * intentId: "STRING_VALUE", // required * }, * caseSummarizationInputData: { // CaseSummarizationInputData * caseArn: "STRING_VALUE", // required * }, * }, * overrideKnowledgeBaseSearchType: "STRING_VALUE", * }; * const command = new QueryAssistantCommand(input); * const response = await client.send(command); * // { // QueryAssistantResponse * // results: [ // QueryResultsList // required * // { // ResultData * // resultId: "STRING_VALUE", // required * // document: { // Document * // contentReference: { // ContentReference * // knowledgeBaseArn: "STRING_VALUE", * // knowledgeBaseId: "STRING_VALUE", * // contentArn: "STRING_VALUE", * // contentId: "STRING_VALUE", * // sourceURL: "STRING_VALUE", * // referenceType: "STRING_VALUE", * // }, * // title: { // DocumentText * // text: "STRING_VALUE", * // highlights: [ // Highlights * // { // Highlight * // beginOffsetInclusive: Number("int"), * // endOffsetExclusive: Number("int"), * // }, * // ], * // }, * // excerpt: { * // text: "STRING_VALUE", * // highlights: [ * // { * // beginOffsetInclusive: Number("int"), * // endOffsetExclusive: Number("int"), * // }, * // ], * // }, * // }, * // relevanceScore: Number("double"), * // data: { // DataSummary * // reference: { // DataReference Union: only one key present * // contentReference: { * // knowledgeBaseArn: "STRING_VALUE", * // knowledgeBaseId: "STRING_VALUE", * // contentArn: "STRING_VALUE", * // contentId: "STRING_VALUE", * // sourceURL: "STRING_VALUE", * // referenceType: "STRING_VALUE", * // }, * // generativeReference: { // GenerativeReference * // modelId: "STRING_VALUE", * // generationId: "STRING_VALUE", * // }, * // suggestedMessageReference: { // SuggestedMessageReference * // aiAgentId: "STRING_VALUE", // required * // aiAgentArn: "STRING_VALUE", // required * // }, * // }, * // details: { // DataDetails Union: only one key present * // contentData: { // ContentDataDetails * // textData: { // TextData * // title: { * // text: "STRING_VALUE", * // highlights: [ * // { * // beginOffsetInclusive: Number("int"), * // endOffsetExclusive: Number("int"), * // }, * // ], * // }, * // excerpt: { * // text: "STRING_VALUE", * // highlights: [ * // { * // beginOffsetInclusive: Number("int"), * // endOffsetExclusive: Number("int"), * // }, * // ], * // }, * // }, * // rankingData: { // RankingData * // relevanceScore: Number("double"), * // relevanceLevel: "STRING_VALUE", * // }, * // }, * // generativeData: { // GenerativeDataDetails * // completion: "STRING_VALUE", // required * // references: [ // DataSummaryList // required * // { * // reference: {// Union: only one key present * // contentReference: "", * // generativeReference: { * // modelId: "STRING_VALUE", * // generationId: "STRING_VALUE", * // }, * // suggestedMessageReference: { * // aiAgentId: "STRING_VALUE", // required * // aiAgentArn: "STRING_VALUE", // required * // }, * // }, * // details: {// Union: only one key present * // contentData: { * // textData: { * // title: "", * // excerpt: "", * // }, * // rankingData: { * // relevanceScore: Number("double"), * // relevanceLevel: "STRING_VALUE", * // }, * // }, * // generativeData: { * // completion: "STRING_VALUE", // required * // references: [ // required * // "", * // ], * // rankingData: { * // relevanceScore: Number("double"), * // relevanceLevel: "STRING_VALUE", * // }, * // }, * // intentDetectedData: { // IntentDetectedDataDetails * // intent: "STRING_VALUE", // required * // intentId: "STRING_VALUE", // required * // relevanceLevel: "STRING_VALUE", * // }, * // sourceContentData: { // SourceContentDataDetails * // id: "STRING_VALUE", // required * // type: "STRING_VALUE", // required * // textData: { * // title: "", * // excerpt: "", * // }, * // rankingData: { * // relevanceScore: Number("double"), * // relevanceLevel: "STRING_VALUE", * // }, * // citationSpan: { // CitationSpan * // beginOffsetInclusive: Number("int"), * // endOffsetExclusive: Number("int"), * // }, * // }, * // generativeChunkData: { // GenerativeChunkDataDetails * // completion: "STRING_VALUE", * // references: [ * // "", * // ], * // nextChunkToken: "STRING_VALUE", * // }, * // emailResponseChunkData: { // EmailResponseChunkDataDetails * // completion: "STRING_VALUE", * // nextChunkToken: "STRING_VALUE", * // }, * // emailOverviewChunkData: { // EmailOverviewChunkDataDetails * // completion: "STRING_VALUE", * // nextChunkToken: "STRING_VALUE", * // }, * // emailGenerativeAnswerChunkData: { // EmailGenerativeAnswerChunkDataDetails * // completion: "STRING_VALUE", * // references: [ * // "", * // ], * // nextChunkToken: "STRING_VALUE", * // }, * // caseSummarizationChunkData: { // CaseSummarizationChunkDataDetails * // completion: "STRING_VALUE", * // nextChunkToken: "STRING_VALUE", * // }, * // suggestedMessageData: { // SuggestedMessageDataDetails * // messageText: "STRING_VALUE", // required * // }, * // notesData: { // NotesDataDetails * // completion: "STRING_VALUE", * // }, * // notesChunkData: { // NotesChunkDataDetails * // completion: "STRING_VALUE", * // nextChunkToken: "STRING_VALUE", * // }, * // }, * // }, * // ], * // rankingData: { * // relevanceScore: Number("double"), * // relevanceLevel: "STRING_VALUE", * // }, * // }, * // intentDetectedData: { * // intent: "STRING_VALUE", // required * // intentId: "STRING_VALUE", // required * // relevanceLevel: "STRING_VALUE", * // }, * // sourceContentData: { * // id: "STRING_VALUE", // required * // type: "STRING_VALUE", // required * // textData: { * // title: "", * // excerpt: "", * // }, * // rankingData: "", // required * // citationSpan: { * // beginOffsetInclusive: Number("int"), * // endOffsetExclusive: Number("int"), * // }, * // }, * // generativeChunkData: { * // completion: "STRING_VALUE", * // references: [ * // "", * // ], * // nextChunkToken: "STRING_VALUE", * // }, * // emailResponseChunkData: { * // completion: "STRING_VALUE", * // nextChunkToken: "STRING_VALUE", * // }, * // emailOverviewChunkData: { * // completion: "STRING_VALUE", * // nextChunkToken: "STRING_VALUE", * // }, * // emailGenerativeAnswerChunkData: { * // completion: "STRING_VALUE", * // references: "", * // nextChunkToken: "STRING_VALUE", * // }, * // caseSummarizationChunkData: { * // completion: "STRING_VALUE", * // nextChunkToken: "STRING_VALUE", * // }, * // suggestedMessageData: { * // messageText: "STRING_VALUE", // required * // }, * // notesData: { * // completion: "STRING_VALUE", * // }, * // notesChunkData: { * // completion: "STRING_VALUE", * // nextChunkToken: "STRING_VALUE", * // }, * // }, * // }, * // type: "STRING_VALUE", * // }, * // ], * // nextToken: "STRING_VALUE", * // }; * * ``` * * @param QueryAssistantCommandInput - {@link QueryAssistantCommandInput} * @returns {@link QueryAssistantCommandOutput} * @see {@link QueryAssistantCommandInput} for command's `input` shape. * @see {@link QueryAssistantCommandOutput} for command's `response` shape. * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You do not have sufficient access to perform this action.

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

The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.

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

The specified resource does not exist.

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

The input fails to satisfy the constraints specified by a service.

* * @throws {@link QConnectServiceException} *

Base exception class for all service exceptions from QConnect service.

* * * @public */ export declare class QueryAssistantCommand extends QueryAssistantCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: QueryAssistantRequest; output: QueryAssistantResponse; }; sdk: { input: QueryAssistantCommandInput; output: QueryAssistantCommandOutput; }; }; }