@aws-sdk/client-qconnect 3.461.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +545 -0
- package/dist-cjs/QConnect.js +93 -0
- package/dist-cjs/QConnectClient.js +43 -0
- package/dist-cjs/commands/CreateAssistantAssociationCommand.js +51 -0
- package/dist-cjs/commands/CreateAssistantCommand.js +51 -0
- package/dist-cjs/commands/CreateContentCommand.js +52 -0
- package/dist-cjs/commands/CreateKnowledgeBaseCommand.js +51 -0
- package/dist-cjs/commands/CreateQuickResponseCommand.js +52 -0
- package/dist-cjs/commands/CreateSessionCommand.js +51 -0
- package/dist-cjs/commands/DeleteAssistantAssociationCommand.js +51 -0
- package/dist-cjs/commands/DeleteAssistantCommand.js +51 -0
- package/dist-cjs/commands/DeleteContentCommand.js +51 -0
- package/dist-cjs/commands/DeleteImportJobCommand.js +51 -0
- package/dist-cjs/commands/DeleteKnowledgeBaseCommand.js +51 -0
- package/dist-cjs/commands/DeleteQuickResponseCommand.js +51 -0
- package/dist-cjs/commands/GetAssistantAssociationCommand.js +51 -0
- package/dist-cjs/commands/GetAssistantCommand.js +51 -0
- package/dist-cjs/commands/GetContentCommand.js +52 -0
- package/dist-cjs/commands/GetContentSummaryCommand.js +51 -0
- package/dist-cjs/commands/GetImportJobCommand.js +52 -0
- package/dist-cjs/commands/GetKnowledgeBaseCommand.js +51 -0
- package/dist-cjs/commands/GetQuickResponseCommand.js +52 -0
- package/dist-cjs/commands/GetRecommendationsCommand.js +52 -0
- package/dist-cjs/commands/GetSessionCommand.js +51 -0
- package/dist-cjs/commands/ListAssistantAssociationsCommand.js +51 -0
- package/dist-cjs/commands/ListAssistantsCommand.js +51 -0
- package/dist-cjs/commands/ListContentsCommand.js +51 -0
- package/dist-cjs/commands/ListImportJobsCommand.js +51 -0
- package/dist-cjs/commands/ListKnowledgeBasesCommand.js +51 -0
- package/dist-cjs/commands/ListQuickResponsesCommand.js +52 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +51 -0
- package/dist-cjs/commands/NotifyRecommendationsReceivedCommand.js +51 -0
- package/dist-cjs/commands/QueryAssistantCommand.js +52 -0
- package/dist-cjs/commands/RemoveKnowledgeBaseTemplateUriCommand.js +51 -0
- package/dist-cjs/commands/SearchContentCommand.js +51 -0
- package/dist-cjs/commands/SearchQuickResponsesCommand.js +52 -0
- package/dist-cjs/commands/SearchSessionsCommand.js +51 -0
- package/dist-cjs/commands/StartContentUploadCommand.js +52 -0
- package/dist-cjs/commands/StartImportJobCommand.js +52 -0
- package/dist-cjs/commands/TagResourceCommand.js +51 -0
- package/dist-cjs/commands/UntagResourceCommand.js +51 -0
- package/dist-cjs/commands/UpdateContentCommand.js +52 -0
- package/dist-cjs/commands/UpdateKnowledgeBaseTemplateUriCommand.js +51 -0
- package/dist-cjs/commands/UpdateQuickResponseCommand.js +52 -0
- package/dist-cjs/commands/index.js +44 -0
- package/dist-cjs/endpoint/EndpointParameters.js +12 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +12 -0
- package/dist-cjs/models/QConnectServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +559 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListAssistantAssociationsPaginator.js +29 -0
- package/dist-cjs/pagination/ListAssistantsPaginator.js +29 -0
- package/dist-cjs/pagination/ListContentsPaginator.js +29 -0
- package/dist-cjs/pagination/ListImportJobsPaginator.js +29 -0
- package/dist-cjs/pagination/ListKnowledgeBasesPaginator.js +29 -0
- package/dist-cjs/pagination/ListQuickResponsesPaginator.js +29 -0
- package/dist-cjs/pagination/QueryAssistantPaginator.js +29 -0
- package/dist-cjs/pagination/SearchContentPaginator.js +29 -0
- package/dist-cjs/pagination/SearchQuickResponsesPaginator.js +29 -0
- package/dist-cjs/pagination/SearchSessionsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +14 -0
- package/dist-cjs/protocols/Aws_restJson1.js +2993 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +50 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +24 -0
- package/dist-cjs/runtimeExtensions.js +22 -0
- package/dist-es/QConnect.js +89 -0
- package/dist-es/QConnectClient.js +39 -0
- package/dist-es/commands/CreateAssistantAssociationCommand.js +47 -0
- package/dist-es/commands/CreateAssistantCommand.js +47 -0
- package/dist-es/commands/CreateContentCommand.js +48 -0
- package/dist-es/commands/CreateKnowledgeBaseCommand.js +47 -0
- package/dist-es/commands/CreateQuickResponseCommand.js +48 -0
- package/dist-es/commands/CreateSessionCommand.js +47 -0
- package/dist-es/commands/DeleteAssistantAssociationCommand.js +47 -0
- package/dist-es/commands/DeleteAssistantCommand.js +47 -0
- package/dist-es/commands/DeleteContentCommand.js +47 -0
- package/dist-es/commands/DeleteImportJobCommand.js +47 -0
- package/dist-es/commands/DeleteKnowledgeBaseCommand.js +47 -0
- package/dist-es/commands/DeleteQuickResponseCommand.js +47 -0
- package/dist-es/commands/GetAssistantAssociationCommand.js +47 -0
- package/dist-es/commands/GetAssistantCommand.js +47 -0
- package/dist-es/commands/GetContentCommand.js +48 -0
- package/dist-es/commands/GetContentSummaryCommand.js +47 -0
- package/dist-es/commands/GetImportJobCommand.js +48 -0
- package/dist-es/commands/GetKnowledgeBaseCommand.js +47 -0
- package/dist-es/commands/GetQuickResponseCommand.js +48 -0
- package/dist-es/commands/GetRecommendationsCommand.js +48 -0
- package/dist-es/commands/GetSessionCommand.js +47 -0
- package/dist-es/commands/ListAssistantAssociationsCommand.js +47 -0
- package/dist-es/commands/ListAssistantsCommand.js +47 -0
- package/dist-es/commands/ListContentsCommand.js +47 -0
- package/dist-es/commands/ListImportJobsCommand.js +47 -0
- package/dist-es/commands/ListKnowledgeBasesCommand.js +47 -0
- package/dist-es/commands/ListQuickResponsesCommand.js +48 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +47 -0
- package/dist-es/commands/NotifyRecommendationsReceivedCommand.js +47 -0
- package/dist-es/commands/QueryAssistantCommand.js +48 -0
- package/dist-es/commands/RemoveKnowledgeBaseTemplateUriCommand.js +47 -0
- package/dist-es/commands/SearchContentCommand.js +47 -0
- package/dist-es/commands/SearchQuickResponsesCommand.js +48 -0
- package/dist-es/commands/SearchSessionsCommand.js +47 -0
- package/dist-es/commands/StartContentUploadCommand.js +48 -0
- package/dist-es/commands/StartImportJobCommand.js +48 -0
- package/dist-es/commands/TagResourceCommand.js +47 -0
- package/dist-es/commands/UntagResourceCommand.js +47 -0
- package/dist-es/commands/UpdateContentCommand.js +48 -0
- package/dist-es/commands/UpdateKnowledgeBaseTemplateUriCommand.js +47 -0
- package/dist-es/commands/UpdateQuickResponseCommand.js +48 -0
- package/dist-es/commands/index.js +41 -0
- package/dist-es/endpoint/EndpointParameters.js +8 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +7 -0
- package/dist-es/models/QConnectServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +508 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListAssistantAssociationsPaginator.js +25 -0
- package/dist-es/pagination/ListAssistantsPaginator.js +25 -0
- package/dist-es/pagination/ListContentsPaginator.js +25 -0
- package/dist-es/pagination/ListImportJobsPaginator.js +25 -0
- package/dist-es/pagination/ListKnowledgeBasesPaginator.js +25 -0
- package/dist-es/pagination/ListQuickResponsesPaginator.js +25 -0
- package/dist-es/pagination/QueryAssistantPaginator.js +25 -0
- package/dist-es/pagination/SearchContentPaginator.js +25 -0
- package/dist-es/pagination/SearchQuickResponsesPaginator.js +25 -0
- package/dist-es/pagination/SearchSessionsPaginator.js +25 -0
- package/dist-es/pagination/index.js +11 -0
- package/dist-es/protocols/Aws_restJson1.js +2907 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +45 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +20 -0
- package/dist-es/runtimeExtensions.js +18 -0
- package/dist-types/QConnect.d.ts +309 -0
- package/dist-types/QConnectClient.d.ts +222 -0
- package/dist-types/commands/CreateAssistantAssociationCommand.d.ts +117 -0
- package/dist-types/commands/CreateAssistantCommand.d.ts +117 -0
- package/dist-types/commands/CreateContentCommand.d.ts +123 -0
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +157 -0
- package/dist-types/commands/CreateQuickResponseCommand.d.ts +149 -0
- package/dist-types/commands/CreateSessionCommand.d.ts +104 -0
- package/dist-types/commands/DeleteAssistantAssociationCommand.d.ts +81 -0
- package/dist-types/commands/DeleteAssistantCommand.d.ts +80 -0
- package/dist-types/commands/DeleteContentCommand.d.ts +81 -0
- package/dist-types/commands/DeleteImportJobCommand.d.ts +87 -0
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +94 -0
- package/dist-types/commands/DeleteQuickResponseCommand.d.ts +81 -0
- package/dist-types/commands/GetAssistantAssociationCommand.d.ts +98 -0
- package/dist-types/commands/GetAssistantCommand.d.ts +101 -0
- package/dist-types/commands/GetContentCommand.d.ts +102 -0
- package/dist-types/commands/GetContentSummaryCommand.d.ts +99 -0
- package/dist-types/commands/GetImportJobCommand.d.ts +106 -0
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +107 -0
- package/dist-types/commands/GetQuickResponseCommand.d.ts +118 -0
- package/dist-types/commands/GetRecommendationsCommand.d.ts +239 -0
- package/dist-types/commands/GetSessionCommand.d.ts +94 -0
- package/dist-types/commands/ListAssistantAssociationsCommand.d.ts +102 -0
- package/dist-types/commands/ListAssistantsCommand.d.ts +102 -0
- package/dist-types/commands/ListContentsCommand.d.ts +103 -0
- package/dist-types/commands/ListImportJobsCommand.d.ts +104 -0
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +107 -0
- package/dist-types/commands/ListQuickResponsesCommand.d.ts +106 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +78 -0
- package/dist-types/commands/NotifyRecommendationsReceivedCommand.d.ts +96 -0
- package/dist-types/commands/QueryAssistantCommand.d.ts +238 -0
- package/dist-types/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +80 -0
- package/dist-types/commands/SearchContentCommand.d.ts +113 -0
- package/dist-types/commands/SearchQuickResponsesCommand.d.ts +163 -0
- package/dist-types/commands/SearchSessionsCommand.d.ts +101 -0
- package/dist-types/commands/StartContentUploadCommand.d.ts +92 -0
- package/dist-types/commands/StartImportJobCommand.d.ts +135 -0
- package/dist-types/commands/TagResourceCommand.d.ts +80 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +77 -0
- package/dist-types/commands/UpdateContentCommand.d.ts +114 -0
- package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +113 -0
- package/dist-types/commands/UpdateQuickResponseCommand.d.ts +149 -0
- package/dist-types/commands/index.d.ts +41 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +22 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +8 -0
- package/dist-types/index.d.ts +27 -0
- package/dist-types/models/QConnectServiceException.d.ts +13 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +4249 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListAssistantAssociationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAssistantsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListContentsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListImportJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListKnowledgeBasesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListQuickResponsesPaginator.d.ts +7 -0
- package/dist-types/pagination/QueryAssistantPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchContentPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchQuickResponsesPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchSessionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +11 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +371 -0
- package/dist-types/runtimeConfig.browser.d.ts +46 -0
- package/dist-types/runtimeConfig.d.ts +46 -0
- package/dist-types/runtimeConfig.native.d.ts +45 -0
- package/dist-types/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/QConnect.d.ts +702 -0
- package/dist-types/ts3.4/QConnectClient.d.ts +364 -0
- package/dist-types/ts3.4/commands/CreateAssistantAssociationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateAssistantCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateContentCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateKnowledgeBaseCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateQuickResponseCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteAssistantAssociationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteAssistantCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteContentCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteImportJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteQuickResponseCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetAssistantAssociationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetAssistantCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetContentCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetContentSummaryCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetKnowledgeBaseCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetQuickResponseCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetRecommendationsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListAssistantAssociationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListAssistantsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListContentsCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListImportJobsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListQuickResponsesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/NotifyRecommendationsReceivedCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/QueryAssistantCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/SearchContentCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/SearchQuickResponsesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/SearchSessionsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StartContentUploadCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/StartImportJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateContentCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateQuickResponseCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +41 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +33 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +7 -0
- package/dist-types/ts3.4/index.d.ts +10 -0
- package/dist-types/ts3.4/models/QConnectServiceException.d.ts +8 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +1241 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListAssistantAssociationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAssistantsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListContentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListImportJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListKnowledgeBasesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListQuickResponsesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/QueryAssistantPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchContentPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchQuickResponsesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchSessionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +11 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +497 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +88 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/package.json +104 -0
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { GetImportJobRequest, GetImportJobResponse } from "../models/models_0";
|
|
5
|
+
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetImportJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetImportJobCommandInput extends GetImportJobRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetImportJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetImportJobCommandOutput extends GetImportJobResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Retrieves the started import job.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { QConnectClient, GetImportJobCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
31
|
+
* // const { QConnectClient, GetImportJobCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
32
|
+
* const client = new QConnectClient(config);
|
|
33
|
+
* const input = { // GetImportJobRequest
|
|
34
|
+
* importJobId: "STRING_VALUE", // required
|
|
35
|
+
* knowledgeBaseId: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new GetImportJobCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // GetImportJobResponse
|
|
40
|
+
* // importJob: { // ImportJobData
|
|
41
|
+
* // importJobId: "STRING_VALUE", // required
|
|
42
|
+
* // knowledgeBaseId: "STRING_VALUE", // required
|
|
43
|
+
* // uploadId: "STRING_VALUE", // required
|
|
44
|
+
* // knowledgeBaseArn: "STRING_VALUE", // required
|
|
45
|
+
* // importJobType: "STRING_VALUE", // required
|
|
46
|
+
* // status: "STRING_VALUE", // required
|
|
47
|
+
* // url: "STRING_VALUE", // required
|
|
48
|
+
* // failedRecordReport: "STRING_VALUE",
|
|
49
|
+
* // urlExpiry: new Date("TIMESTAMP"), // required
|
|
50
|
+
* // createdTime: new Date("TIMESTAMP"), // required
|
|
51
|
+
* // lastModifiedTime: new Date("TIMESTAMP"), // required
|
|
52
|
+
* // metadata: { // ContentMetadata
|
|
53
|
+
* // "<keys>": "STRING_VALUE",
|
|
54
|
+
* // },
|
|
55
|
+
* // externalSourceConfiguration: { // ExternalSourceConfiguration
|
|
56
|
+
* // source: "STRING_VALUE", // required
|
|
57
|
+
* // configuration: { // Configuration Union: only one key present
|
|
58
|
+
* // connectConfiguration: { // ConnectConfiguration
|
|
59
|
+
* // instanceId: "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // },
|
|
62
|
+
* // },
|
|
63
|
+
* // },
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param GetImportJobCommandInput - {@link GetImportJobCommandInput}
|
|
69
|
+
* @returns {@link GetImportJobCommandOutput}
|
|
70
|
+
* @see {@link GetImportJobCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link GetImportJobCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
75
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
78
|
+
* <p>The specified resource does not exist.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ValidationException} (client fault)
|
|
81
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link QConnectServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
85
|
+
*
|
|
86
|
+
*/
|
|
87
|
+
export declare class GetImportJobCommand extends $Command<GetImportJobCommandInput, GetImportJobCommandOutput, QConnectClientResolvedConfig> {
|
|
88
|
+
readonly input: GetImportJobCommandInput;
|
|
89
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
90
|
+
/**
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
constructor(input: GetImportJobCommandInput);
|
|
94
|
+
/**
|
|
95
|
+
* @internal
|
|
96
|
+
*/
|
|
97
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetImportJobCommandInput, GetImportJobCommandOutput>;
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
private serialize;
|
|
102
|
+
/**
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
private deserialize;
|
|
106
|
+
}
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { GetKnowledgeBaseRequest, GetKnowledgeBaseResponse } from "../models/models_0";
|
|
5
|
+
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetKnowledgeBaseCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetKnowledgeBaseCommandInput extends GetKnowledgeBaseRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetKnowledgeBaseCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetKnowledgeBaseCommandOutput extends GetKnowledgeBaseResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Retrieves information about the knowledge base.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { QConnectClient, GetKnowledgeBaseCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
31
|
+
* // const { QConnectClient, GetKnowledgeBaseCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
32
|
+
* const client = new QConnectClient(config);
|
|
33
|
+
* const input = { // GetKnowledgeBaseRequest
|
|
34
|
+
* knowledgeBaseId: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetKnowledgeBaseCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* // { // GetKnowledgeBaseResponse
|
|
39
|
+
* // knowledgeBase: { // KnowledgeBaseData
|
|
40
|
+
* // knowledgeBaseId: "STRING_VALUE", // required
|
|
41
|
+
* // knowledgeBaseArn: "STRING_VALUE", // required
|
|
42
|
+
* // name: "STRING_VALUE", // required
|
|
43
|
+
* // knowledgeBaseType: "STRING_VALUE", // required
|
|
44
|
+
* // status: "STRING_VALUE", // required
|
|
45
|
+
* // lastContentModificationTime: new Date("TIMESTAMP"),
|
|
46
|
+
* // sourceConfiguration: { // SourceConfiguration Union: only one key present
|
|
47
|
+
* // appIntegrations: { // AppIntegrationsConfiguration
|
|
48
|
+
* // appIntegrationArn: "STRING_VALUE", // required
|
|
49
|
+
* // objectFields: [ // ObjectFieldsList
|
|
50
|
+
* // "STRING_VALUE",
|
|
51
|
+
* // ],
|
|
52
|
+
* // },
|
|
53
|
+
* // },
|
|
54
|
+
* // renderingConfiguration: { // RenderingConfiguration
|
|
55
|
+
* // templateUri: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // serverSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
|
|
58
|
+
* // kmsKeyId: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // description: "STRING_VALUE",
|
|
61
|
+
* // tags: { // Tags
|
|
62
|
+
* // "<keys>": "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // },
|
|
65
|
+
* // };
|
|
66
|
+
*
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
69
|
+
* @param GetKnowledgeBaseCommandInput - {@link GetKnowledgeBaseCommandInput}
|
|
70
|
+
* @returns {@link GetKnowledgeBaseCommandOutput}
|
|
71
|
+
* @see {@link GetKnowledgeBaseCommandInput} for command's `input` shape.
|
|
72
|
+
* @see {@link GetKnowledgeBaseCommandOutput} for command's `response` shape.
|
|
73
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
76
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
79
|
+
* <p>The specified resource does not exist.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ValidationException} (client fault)
|
|
82
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link QConnectServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
86
|
+
*
|
|
87
|
+
*/
|
|
88
|
+
export declare class GetKnowledgeBaseCommand extends $Command<GetKnowledgeBaseCommandInput, GetKnowledgeBaseCommandOutput, QConnectClientResolvedConfig> {
|
|
89
|
+
readonly input: GetKnowledgeBaseCommandInput;
|
|
90
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
91
|
+
/**
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
constructor(input: GetKnowledgeBaseCommandInput);
|
|
95
|
+
/**
|
|
96
|
+
* @internal
|
|
97
|
+
*/
|
|
98
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetKnowledgeBaseCommandInput, GetKnowledgeBaseCommandOutput>;
|
|
99
|
+
/**
|
|
100
|
+
* @internal
|
|
101
|
+
*/
|
|
102
|
+
private serialize;
|
|
103
|
+
/**
|
|
104
|
+
* @internal
|
|
105
|
+
*/
|
|
106
|
+
private deserialize;
|
|
107
|
+
}
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { GetQuickResponseRequest, GetQuickResponseResponse } from "../models/models_0";
|
|
5
|
+
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetQuickResponseCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetQuickResponseCommandInput extends GetQuickResponseRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetQuickResponseCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetQuickResponseCommandOutput extends GetQuickResponseResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Retrieves the quick response.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { QConnectClient, GetQuickResponseCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
31
|
+
* // const { QConnectClient, GetQuickResponseCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
32
|
+
* const client = new QConnectClient(config);
|
|
33
|
+
* const input = { // GetQuickResponseRequest
|
|
34
|
+
* quickResponseId: "STRING_VALUE", // required
|
|
35
|
+
* knowledgeBaseId: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new GetQuickResponseCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // GetQuickResponseResponse
|
|
40
|
+
* // quickResponse: { // QuickResponseData
|
|
41
|
+
* // quickResponseArn: "STRING_VALUE", // required
|
|
42
|
+
* // quickResponseId: "STRING_VALUE", // required
|
|
43
|
+
* // knowledgeBaseArn: "STRING_VALUE", // required
|
|
44
|
+
* // knowledgeBaseId: "STRING_VALUE", // required
|
|
45
|
+
* // name: "STRING_VALUE", // required
|
|
46
|
+
* // contentType: "STRING_VALUE", // required
|
|
47
|
+
* // status: "STRING_VALUE", // required
|
|
48
|
+
* // createdTime: new Date("TIMESTAMP"), // required
|
|
49
|
+
* // lastModifiedTime: new Date("TIMESTAMP"), // required
|
|
50
|
+
* // contents: { // QuickResponseContents
|
|
51
|
+
* // plainText: { // QuickResponseContentProvider Union: only one key present
|
|
52
|
+
* // content: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // markdown: {// Union: only one key present
|
|
55
|
+
* // content: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // },
|
|
58
|
+
* // description: "STRING_VALUE",
|
|
59
|
+
* // groupingConfiguration: { // GroupingConfiguration
|
|
60
|
+
* // criteria: "STRING_VALUE",
|
|
61
|
+
* // values: [ // GroupingValues
|
|
62
|
+
* // "STRING_VALUE",
|
|
63
|
+
* // ],
|
|
64
|
+
* // },
|
|
65
|
+
* // shortcutKey: "STRING_VALUE",
|
|
66
|
+
* // lastModifiedBy: "STRING_VALUE",
|
|
67
|
+
* // isActive: true || false,
|
|
68
|
+
* // channels: [ // Channels
|
|
69
|
+
* // "STRING_VALUE",
|
|
70
|
+
* // ],
|
|
71
|
+
* // language: "STRING_VALUE",
|
|
72
|
+
* // tags: { // Tags
|
|
73
|
+
* // "<keys>": "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // },
|
|
76
|
+
* // };
|
|
77
|
+
*
|
|
78
|
+
* ```
|
|
79
|
+
*
|
|
80
|
+
* @param GetQuickResponseCommandInput - {@link GetQuickResponseCommandInput}
|
|
81
|
+
* @returns {@link GetQuickResponseCommandOutput}
|
|
82
|
+
* @see {@link GetQuickResponseCommandInput} for command's `input` shape.
|
|
83
|
+
* @see {@link GetQuickResponseCommandOutput} for command's `response` shape.
|
|
84
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
87
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
90
|
+
* <p>The specified resource does not exist.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ValidationException} (client fault)
|
|
93
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link QConnectServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
97
|
+
*
|
|
98
|
+
*/
|
|
99
|
+
export declare class GetQuickResponseCommand extends $Command<GetQuickResponseCommandInput, GetQuickResponseCommandOutput, QConnectClientResolvedConfig> {
|
|
100
|
+
readonly input: GetQuickResponseCommandInput;
|
|
101
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
102
|
+
/**
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
constructor(input: GetQuickResponseCommandInput);
|
|
106
|
+
/**
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetQuickResponseCommandInput, GetQuickResponseCommandOutput>;
|
|
110
|
+
/**
|
|
111
|
+
* @internal
|
|
112
|
+
*/
|
|
113
|
+
private serialize;
|
|
114
|
+
/**
|
|
115
|
+
* @internal
|
|
116
|
+
*/
|
|
117
|
+
private deserialize;
|
|
118
|
+
}
|
|
@@ -0,0 +1,239 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { GetRecommendationsRequest, GetRecommendationsResponse } from "../models/models_0";
|
|
5
|
+
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetRecommendationsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetRecommendationsCommandInput extends GetRecommendationsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetRecommendationsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetRecommendationsCommandOutput extends GetRecommendationsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Retrieves recommendations for the specified session. To avoid retrieving the same
|
|
27
|
+
* recommendations in subsequent calls, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_NotifyRecommendationsReceived.html">NotifyRecommendationsReceived</a>. This API supports long-polling behavior with the
|
|
28
|
+
* <code>waitTimeSeconds</code> parameter. Short poll is the default behavior and only returns
|
|
29
|
+
* recommendations already available. To perform a manual query against an assistant, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_QueryAssistant.html">QueryAssistant</a>.</p>
|
|
30
|
+
* @example
|
|
31
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
32
|
+
* ```javascript
|
|
33
|
+
* import { QConnectClient, GetRecommendationsCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
34
|
+
* // const { QConnectClient, GetRecommendationsCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
35
|
+
* const client = new QConnectClient(config);
|
|
36
|
+
* const input = { // GetRecommendationsRequest
|
|
37
|
+
* assistantId: "STRING_VALUE", // required
|
|
38
|
+
* sessionId: "STRING_VALUE", // required
|
|
39
|
+
* maxResults: Number("int"),
|
|
40
|
+
* waitTimeSeconds: Number("int"),
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetRecommendationsCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetRecommendationsResponse
|
|
45
|
+
* // recommendations: [ // RecommendationList // required
|
|
46
|
+
* // { // RecommendationData
|
|
47
|
+
* // recommendationId: "STRING_VALUE", // required
|
|
48
|
+
* // document: { // Document
|
|
49
|
+
* // contentReference: { // ContentReference
|
|
50
|
+
* // knowledgeBaseArn: "STRING_VALUE",
|
|
51
|
+
* // knowledgeBaseId: "STRING_VALUE",
|
|
52
|
+
* // contentArn: "STRING_VALUE",
|
|
53
|
+
* // contentId: "STRING_VALUE",
|
|
54
|
+
* // },
|
|
55
|
+
* // title: { // DocumentText
|
|
56
|
+
* // text: "STRING_VALUE",
|
|
57
|
+
* // highlights: [ // Highlights
|
|
58
|
+
* // { // Highlight
|
|
59
|
+
* // beginOffsetInclusive: Number("int"),
|
|
60
|
+
* // endOffsetExclusive: Number("int"),
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // },
|
|
64
|
+
* // excerpt: {
|
|
65
|
+
* // text: "STRING_VALUE",
|
|
66
|
+
* // highlights: [
|
|
67
|
+
* // {
|
|
68
|
+
* // beginOffsetInclusive: Number("int"),
|
|
69
|
+
* // endOffsetExclusive: Number("int"),
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // },
|
|
73
|
+
* // },
|
|
74
|
+
* // relevanceScore: Number("double"),
|
|
75
|
+
* // relevanceLevel: "STRING_VALUE",
|
|
76
|
+
* // type: "STRING_VALUE",
|
|
77
|
+
* // data: { // DataSummary
|
|
78
|
+
* // reference: { // DataReference Union: only one key present
|
|
79
|
+
* // contentReference: {
|
|
80
|
+
* // knowledgeBaseArn: "STRING_VALUE",
|
|
81
|
+
* // knowledgeBaseId: "STRING_VALUE",
|
|
82
|
+
* // contentArn: "STRING_VALUE",
|
|
83
|
+
* // contentId: "STRING_VALUE",
|
|
84
|
+
* // },
|
|
85
|
+
* // generativeReference: { // GenerativeReference
|
|
86
|
+
* // modelId: "STRING_VALUE",
|
|
87
|
+
* // generationId: "STRING_VALUE",
|
|
88
|
+
* // },
|
|
89
|
+
* // },
|
|
90
|
+
* // details: { // DataDetails Union: only one key present
|
|
91
|
+
* // contentData: { // ContentDataDetails
|
|
92
|
+
* // textData: { // TextData
|
|
93
|
+
* // title: {
|
|
94
|
+
* // text: "STRING_VALUE",
|
|
95
|
+
* // highlights: [
|
|
96
|
+
* // {
|
|
97
|
+
* // beginOffsetInclusive: Number("int"),
|
|
98
|
+
* // endOffsetExclusive: Number("int"),
|
|
99
|
+
* // },
|
|
100
|
+
* // ],
|
|
101
|
+
* // },
|
|
102
|
+
* // excerpt: {
|
|
103
|
+
* // text: "STRING_VALUE",
|
|
104
|
+
* // highlights: [
|
|
105
|
+
* // {
|
|
106
|
+
* // beginOffsetInclusive: Number("int"),
|
|
107
|
+
* // endOffsetExclusive: Number("int"),
|
|
108
|
+
* // },
|
|
109
|
+
* // ],
|
|
110
|
+
* // },
|
|
111
|
+
* // },
|
|
112
|
+
* // rankingData: { // RankingData
|
|
113
|
+
* // relevanceScore: Number("double"),
|
|
114
|
+
* // relevanceLevel: "STRING_VALUE",
|
|
115
|
+
* // },
|
|
116
|
+
* // },
|
|
117
|
+
* // generativeData: { // GenerativeDataDetails
|
|
118
|
+
* // completion: "STRING_VALUE", // required
|
|
119
|
+
* // references: [ // DataSummaryList // required
|
|
120
|
+
* // {
|
|
121
|
+
* // reference: {// Union: only one key present
|
|
122
|
+
* // contentReference: "<ContentReference>",
|
|
123
|
+
* // generativeReference: {
|
|
124
|
+
* // modelId: "STRING_VALUE",
|
|
125
|
+
* // generationId: "STRING_VALUE",
|
|
126
|
+
* // },
|
|
127
|
+
* // },
|
|
128
|
+
* // details: {// Union: only one key present
|
|
129
|
+
* // contentData: {
|
|
130
|
+
* // textData: {
|
|
131
|
+
* // title: "<DocumentText>",
|
|
132
|
+
* // excerpt: "<DocumentText>",
|
|
133
|
+
* // },
|
|
134
|
+
* // rankingData: {
|
|
135
|
+
* // relevanceScore: Number("double"),
|
|
136
|
+
* // relevanceLevel: "STRING_VALUE",
|
|
137
|
+
* // },
|
|
138
|
+
* // },
|
|
139
|
+
* // generativeData: {
|
|
140
|
+
* // completion: "STRING_VALUE", // required
|
|
141
|
+
* // references: [ // required
|
|
142
|
+
* // "<DataSummary>",
|
|
143
|
+
* // ],
|
|
144
|
+
* // rankingData: {
|
|
145
|
+
* // relevanceScore: Number("double"),
|
|
146
|
+
* // relevanceLevel: "STRING_VALUE",
|
|
147
|
+
* // },
|
|
148
|
+
* // },
|
|
149
|
+
* // sourceContentData: { // SourceContentDataDetails
|
|
150
|
+
* // id: "STRING_VALUE", // required
|
|
151
|
+
* // type: "STRING_VALUE", // required
|
|
152
|
+
* // textData: {
|
|
153
|
+
* // title: "<DocumentText>",
|
|
154
|
+
* // excerpt: "<DocumentText>",
|
|
155
|
+
* // },
|
|
156
|
+
* // rankingData: {
|
|
157
|
+
* // relevanceScore: Number("double"),
|
|
158
|
+
* // relevanceLevel: "STRING_VALUE",
|
|
159
|
+
* // },
|
|
160
|
+
* // },
|
|
161
|
+
* // },
|
|
162
|
+
* // },
|
|
163
|
+
* // ],
|
|
164
|
+
* // rankingData: {
|
|
165
|
+
* // relevanceScore: Number("double"),
|
|
166
|
+
* // relevanceLevel: "STRING_VALUE",
|
|
167
|
+
* // },
|
|
168
|
+
* // },
|
|
169
|
+
* // sourceContentData: {
|
|
170
|
+
* // id: "STRING_VALUE", // required
|
|
171
|
+
* // type: "STRING_VALUE", // required
|
|
172
|
+
* // textData: {
|
|
173
|
+
* // title: "<DocumentText>",
|
|
174
|
+
* // excerpt: "<DocumentText>",
|
|
175
|
+
* // },
|
|
176
|
+
* // rankingData: "<RankingData>", // required
|
|
177
|
+
* // },
|
|
178
|
+
* // },
|
|
179
|
+
* // },
|
|
180
|
+
* // },
|
|
181
|
+
* // ],
|
|
182
|
+
* // triggers: [ // RecommendationTriggerList
|
|
183
|
+
* // { // RecommendationTrigger
|
|
184
|
+
* // id: "STRING_VALUE", // required
|
|
185
|
+
* // type: "STRING_VALUE", // required
|
|
186
|
+
* // source: "STRING_VALUE", // required
|
|
187
|
+
* // data: { // RecommendationTriggerData Union: only one key present
|
|
188
|
+
* // query: { // QueryRecommendationTriggerData
|
|
189
|
+
* // text: "STRING_VALUE",
|
|
190
|
+
* // },
|
|
191
|
+
* // },
|
|
192
|
+
* // recommendationIds: [ // RecommendationIdList // required
|
|
193
|
+
* // "STRING_VALUE",
|
|
194
|
+
* // ],
|
|
195
|
+
* // },
|
|
196
|
+
* // ],
|
|
197
|
+
* // };
|
|
198
|
+
*
|
|
199
|
+
* ```
|
|
200
|
+
*
|
|
201
|
+
* @param GetRecommendationsCommandInput - {@link GetRecommendationsCommandInput}
|
|
202
|
+
* @returns {@link GetRecommendationsCommandOutput}
|
|
203
|
+
* @see {@link GetRecommendationsCommandInput} for command's `input` shape.
|
|
204
|
+
* @see {@link GetRecommendationsCommandOutput} for command's `response` shape.
|
|
205
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
206
|
+
*
|
|
207
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
208
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
209
|
+
*
|
|
210
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
211
|
+
* <p>The specified resource does not exist.</p>
|
|
212
|
+
*
|
|
213
|
+
* @throws {@link ValidationException} (client fault)
|
|
214
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
215
|
+
*
|
|
216
|
+
* @throws {@link QConnectServiceException}
|
|
217
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
218
|
+
*
|
|
219
|
+
*/
|
|
220
|
+
export declare class GetRecommendationsCommand extends $Command<GetRecommendationsCommandInput, GetRecommendationsCommandOutput, QConnectClientResolvedConfig> {
|
|
221
|
+
readonly input: GetRecommendationsCommandInput;
|
|
222
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
223
|
+
/**
|
|
224
|
+
* @public
|
|
225
|
+
*/
|
|
226
|
+
constructor(input: GetRecommendationsCommandInput);
|
|
227
|
+
/**
|
|
228
|
+
* @internal
|
|
229
|
+
*/
|
|
230
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetRecommendationsCommandInput, GetRecommendationsCommandOutput>;
|
|
231
|
+
/**
|
|
232
|
+
* @internal
|
|
233
|
+
*/
|
|
234
|
+
private serialize;
|
|
235
|
+
/**
|
|
236
|
+
* @internal
|
|
237
|
+
*/
|
|
238
|
+
private deserialize;
|
|
239
|
+
}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { GetSessionRequest, GetSessionResponse } from "../models/models_0";
|
|
5
|
+
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetSessionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetSessionCommandInput extends GetSessionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetSessionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Retrieves information for a specified session.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { QConnectClient, GetSessionCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
31
|
+
* // const { QConnectClient, GetSessionCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
32
|
+
* const client = new QConnectClient(config);
|
|
33
|
+
* const input = { // GetSessionRequest
|
|
34
|
+
* assistantId: "STRING_VALUE", // required
|
|
35
|
+
* sessionId: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new GetSessionCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // GetSessionResponse
|
|
40
|
+
* // session: { // SessionData
|
|
41
|
+
* // sessionArn: "STRING_VALUE", // required
|
|
42
|
+
* // sessionId: "STRING_VALUE", // required
|
|
43
|
+
* // name: "STRING_VALUE", // required
|
|
44
|
+
* // description: "STRING_VALUE",
|
|
45
|
+
* // tags: { // Tags
|
|
46
|
+
* // "<keys>": "STRING_VALUE",
|
|
47
|
+
* // },
|
|
48
|
+
* // integrationConfiguration: { // SessionIntegrationConfiguration
|
|
49
|
+
* // topicIntegrationArn: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // },
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param GetSessionCommandInput - {@link GetSessionCommandInput}
|
|
57
|
+
* @returns {@link GetSessionCommandOutput}
|
|
58
|
+
* @see {@link GetSessionCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link GetSessionCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
|
+
* <p>The specified resource does not exist.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ValidationException} (client fault)
|
|
69
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link QConnectServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
73
|
+
*
|
|
74
|
+
*/
|
|
75
|
+
export declare class GetSessionCommand extends $Command<GetSessionCommandInput, GetSessionCommandOutput, QConnectClientResolvedConfig> {
|
|
76
|
+
readonly input: GetSessionCommandInput;
|
|
77
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
78
|
+
/**
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
constructor(input: GetSessionCommandInput);
|
|
82
|
+
/**
|
|
83
|
+
* @internal
|
|
84
|
+
*/
|
|
85
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSessionCommandInput, GetSessionCommandOutput>;
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
89
|
+
private serialize;
|
|
90
|
+
/**
|
|
91
|
+
* @internal
|
|
92
|
+
*/
|
|
93
|
+
private deserialize;
|
|
94
|
+
}
|