@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,1241 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { QConnectServiceException as __BaseException } from "./QConnectServiceException";
|
|
3
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
4
|
+
readonly name: "AccessDeniedException";
|
|
5
|
+
readonly $fault: "client";
|
|
6
|
+
constructor(
|
|
7
|
+
opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
|
|
8
|
+
);
|
|
9
|
+
}
|
|
10
|
+
export interface AppIntegrationsConfiguration {
|
|
11
|
+
appIntegrationArn: string | undefined;
|
|
12
|
+
objectFields?: string[];
|
|
13
|
+
}
|
|
14
|
+
export declare class ConflictException extends __BaseException {
|
|
15
|
+
readonly name: "ConflictException";
|
|
16
|
+
readonly $fault: "client";
|
|
17
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
18
|
+
}
|
|
19
|
+
export type AssistantAssociationInputData =
|
|
20
|
+
| AssistantAssociationInputData.KnowledgeBaseIdMember
|
|
21
|
+
| AssistantAssociationInputData.$UnknownMember;
|
|
22
|
+
export declare namespace AssistantAssociationInputData {
|
|
23
|
+
interface KnowledgeBaseIdMember {
|
|
24
|
+
knowledgeBaseId: string;
|
|
25
|
+
$unknown?: never;
|
|
26
|
+
}
|
|
27
|
+
interface $UnknownMember {
|
|
28
|
+
knowledgeBaseId?: never;
|
|
29
|
+
$unknown: [string, any];
|
|
30
|
+
}
|
|
31
|
+
interface Visitor<T> {
|
|
32
|
+
knowledgeBaseId: (value: string) => T;
|
|
33
|
+
_: (name: string, value: any) => T;
|
|
34
|
+
}
|
|
35
|
+
const visit: <T>(
|
|
36
|
+
value: AssistantAssociationInputData,
|
|
37
|
+
visitor: Visitor<T>
|
|
38
|
+
) => T;
|
|
39
|
+
}
|
|
40
|
+
export declare const AssociationType: {
|
|
41
|
+
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
42
|
+
};
|
|
43
|
+
export type AssociationType =
|
|
44
|
+
(typeof AssociationType)[keyof typeof AssociationType];
|
|
45
|
+
export interface CreateAssistantAssociationRequest {
|
|
46
|
+
assistantId: string | undefined;
|
|
47
|
+
associationType: AssociationType | undefined;
|
|
48
|
+
association: AssistantAssociationInputData | undefined;
|
|
49
|
+
clientToken?: string;
|
|
50
|
+
tags?: Record<string, string>;
|
|
51
|
+
}
|
|
52
|
+
export interface KnowledgeBaseAssociationData {
|
|
53
|
+
knowledgeBaseId?: string;
|
|
54
|
+
knowledgeBaseArn?: string;
|
|
55
|
+
}
|
|
56
|
+
export type AssistantAssociationOutputData =
|
|
57
|
+
| AssistantAssociationOutputData.KnowledgeBaseAssociationMember
|
|
58
|
+
| AssistantAssociationOutputData.$UnknownMember;
|
|
59
|
+
export declare namespace AssistantAssociationOutputData {
|
|
60
|
+
interface KnowledgeBaseAssociationMember {
|
|
61
|
+
knowledgeBaseAssociation: KnowledgeBaseAssociationData;
|
|
62
|
+
$unknown?: never;
|
|
63
|
+
}
|
|
64
|
+
interface $UnknownMember {
|
|
65
|
+
knowledgeBaseAssociation?: never;
|
|
66
|
+
$unknown: [string, any];
|
|
67
|
+
}
|
|
68
|
+
interface Visitor<T> {
|
|
69
|
+
knowledgeBaseAssociation: (value: KnowledgeBaseAssociationData) => T;
|
|
70
|
+
_: (name: string, value: any) => T;
|
|
71
|
+
}
|
|
72
|
+
const visit: <T>(
|
|
73
|
+
value: AssistantAssociationOutputData,
|
|
74
|
+
visitor: Visitor<T>
|
|
75
|
+
) => T;
|
|
76
|
+
}
|
|
77
|
+
export interface AssistantAssociationData {
|
|
78
|
+
assistantAssociationId: string | undefined;
|
|
79
|
+
assistantAssociationArn: string | undefined;
|
|
80
|
+
assistantId: string | undefined;
|
|
81
|
+
assistantArn: string | undefined;
|
|
82
|
+
associationType: AssociationType | undefined;
|
|
83
|
+
associationData: AssistantAssociationOutputData | undefined;
|
|
84
|
+
tags?: Record<string, string>;
|
|
85
|
+
}
|
|
86
|
+
export interface CreateAssistantAssociationResponse {
|
|
87
|
+
assistantAssociation?: AssistantAssociationData;
|
|
88
|
+
}
|
|
89
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
90
|
+
readonly name: "ResourceNotFoundException";
|
|
91
|
+
readonly $fault: "client";
|
|
92
|
+
resourceName?: string;
|
|
93
|
+
constructor(
|
|
94
|
+
opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
|
|
95
|
+
);
|
|
96
|
+
}
|
|
97
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
98
|
+
readonly name: "ServiceQuotaExceededException";
|
|
99
|
+
readonly $fault: "client";
|
|
100
|
+
constructor(
|
|
101
|
+
opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
|
|
102
|
+
);
|
|
103
|
+
}
|
|
104
|
+
export declare class ValidationException extends __BaseException {
|
|
105
|
+
readonly name: "ValidationException";
|
|
106
|
+
readonly $fault: "client";
|
|
107
|
+
constructor(
|
|
108
|
+
opts: __ExceptionOptionType<ValidationException, __BaseException>
|
|
109
|
+
);
|
|
110
|
+
}
|
|
111
|
+
export interface DeleteAssistantAssociationRequest {
|
|
112
|
+
assistantAssociationId: string | undefined;
|
|
113
|
+
assistantId: string | undefined;
|
|
114
|
+
}
|
|
115
|
+
export interface DeleteAssistantAssociationResponse {}
|
|
116
|
+
export interface GetAssistantAssociationRequest {
|
|
117
|
+
assistantAssociationId: string | undefined;
|
|
118
|
+
assistantId: string | undefined;
|
|
119
|
+
}
|
|
120
|
+
export interface GetAssistantAssociationResponse {
|
|
121
|
+
assistantAssociation?: AssistantAssociationData;
|
|
122
|
+
}
|
|
123
|
+
export interface ListAssistantAssociationsRequest {
|
|
124
|
+
nextToken?: string;
|
|
125
|
+
maxResults?: number;
|
|
126
|
+
assistantId: string | undefined;
|
|
127
|
+
}
|
|
128
|
+
export interface AssistantAssociationSummary {
|
|
129
|
+
assistantAssociationId: string | undefined;
|
|
130
|
+
assistantAssociationArn: string | undefined;
|
|
131
|
+
assistantId: string | undefined;
|
|
132
|
+
assistantArn: string | undefined;
|
|
133
|
+
associationType: AssociationType | undefined;
|
|
134
|
+
associationData: AssistantAssociationOutputData | undefined;
|
|
135
|
+
tags?: Record<string, string>;
|
|
136
|
+
}
|
|
137
|
+
export interface ListAssistantAssociationsResponse {
|
|
138
|
+
assistantAssociationSummaries: AssistantAssociationSummary[] | undefined;
|
|
139
|
+
nextToken?: string;
|
|
140
|
+
}
|
|
141
|
+
export interface ServerSideEncryptionConfiguration {
|
|
142
|
+
kmsKeyId?: string;
|
|
143
|
+
}
|
|
144
|
+
export declare const AssistantType: {
|
|
145
|
+
readonly AGENT: "AGENT";
|
|
146
|
+
};
|
|
147
|
+
export type AssistantType = (typeof AssistantType)[keyof typeof AssistantType];
|
|
148
|
+
export interface CreateAssistantRequest {
|
|
149
|
+
clientToken?: string;
|
|
150
|
+
name: string | undefined;
|
|
151
|
+
type: AssistantType | undefined;
|
|
152
|
+
description?: string;
|
|
153
|
+
tags?: Record<string, string>;
|
|
154
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
155
|
+
}
|
|
156
|
+
export declare const AssistantCapabilityType: {
|
|
157
|
+
readonly V1: "V1";
|
|
158
|
+
readonly V2: "V2";
|
|
159
|
+
};
|
|
160
|
+
export type AssistantCapabilityType =
|
|
161
|
+
(typeof AssistantCapabilityType)[keyof typeof AssistantCapabilityType];
|
|
162
|
+
export interface AssistantCapabilityConfiguration {
|
|
163
|
+
type?: AssistantCapabilityType;
|
|
164
|
+
}
|
|
165
|
+
export interface AssistantIntegrationConfiguration {
|
|
166
|
+
topicIntegrationArn?: string;
|
|
167
|
+
}
|
|
168
|
+
export declare const AssistantStatus: {
|
|
169
|
+
readonly ACTIVE: "ACTIVE";
|
|
170
|
+
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
171
|
+
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
172
|
+
readonly DELETED: "DELETED";
|
|
173
|
+
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
174
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
175
|
+
};
|
|
176
|
+
export type AssistantStatus =
|
|
177
|
+
(typeof AssistantStatus)[keyof typeof AssistantStatus];
|
|
178
|
+
export interface AssistantData {
|
|
179
|
+
assistantId: string | undefined;
|
|
180
|
+
assistantArn: string | undefined;
|
|
181
|
+
name: string | undefined;
|
|
182
|
+
type: AssistantType | undefined;
|
|
183
|
+
status: AssistantStatus | undefined;
|
|
184
|
+
description?: string;
|
|
185
|
+
tags?: Record<string, string>;
|
|
186
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
187
|
+
integrationConfiguration?: AssistantIntegrationConfiguration;
|
|
188
|
+
capabilityConfiguration?: AssistantCapabilityConfiguration;
|
|
189
|
+
}
|
|
190
|
+
export interface CreateAssistantResponse {
|
|
191
|
+
assistant?: AssistantData;
|
|
192
|
+
}
|
|
193
|
+
export interface DeleteAssistantRequest {
|
|
194
|
+
assistantId: string | undefined;
|
|
195
|
+
}
|
|
196
|
+
export interface DeleteAssistantResponse {}
|
|
197
|
+
export interface GetAssistantRequest {
|
|
198
|
+
assistantId: string | undefined;
|
|
199
|
+
}
|
|
200
|
+
export interface GetAssistantResponse {
|
|
201
|
+
assistant?: AssistantData;
|
|
202
|
+
}
|
|
203
|
+
export interface GetRecommendationsRequest {
|
|
204
|
+
assistantId: string | undefined;
|
|
205
|
+
sessionId: string | undefined;
|
|
206
|
+
maxResults?: number;
|
|
207
|
+
waitTimeSeconds?: number;
|
|
208
|
+
}
|
|
209
|
+
export declare const RelevanceLevel: {
|
|
210
|
+
readonly HIGH: "HIGH";
|
|
211
|
+
readonly LOW: "LOW";
|
|
212
|
+
readonly MEDIUM: "MEDIUM";
|
|
213
|
+
};
|
|
214
|
+
export type RelevanceLevel =
|
|
215
|
+
(typeof RelevanceLevel)[keyof typeof RelevanceLevel];
|
|
216
|
+
export interface RankingData {
|
|
217
|
+
relevanceScore?: number;
|
|
218
|
+
relevanceLevel?: RelevanceLevel;
|
|
219
|
+
}
|
|
220
|
+
export interface Highlight {
|
|
221
|
+
beginOffsetInclusive?: number;
|
|
222
|
+
endOffsetExclusive?: number;
|
|
223
|
+
}
|
|
224
|
+
export interface DocumentText {
|
|
225
|
+
text?: string;
|
|
226
|
+
highlights?: Highlight[];
|
|
227
|
+
}
|
|
228
|
+
export interface TextData {
|
|
229
|
+
title?: DocumentText;
|
|
230
|
+
excerpt?: DocumentText;
|
|
231
|
+
}
|
|
232
|
+
export interface ContentDataDetails {
|
|
233
|
+
textData: TextData | undefined;
|
|
234
|
+
rankingData: RankingData | undefined;
|
|
235
|
+
}
|
|
236
|
+
export declare const SourceContentType: {
|
|
237
|
+
readonly KNOWLEDGE_CONTENT: "KNOWLEDGE_CONTENT";
|
|
238
|
+
};
|
|
239
|
+
export type SourceContentType =
|
|
240
|
+
(typeof SourceContentType)[keyof typeof SourceContentType];
|
|
241
|
+
export interface SourceContentDataDetails {
|
|
242
|
+
id: string | undefined;
|
|
243
|
+
type: SourceContentType | undefined;
|
|
244
|
+
textData: TextData | undefined;
|
|
245
|
+
rankingData: RankingData | undefined;
|
|
246
|
+
}
|
|
247
|
+
export interface ContentReference {
|
|
248
|
+
knowledgeBaseArn?: string;
|
|
249
|
+
knowledgeBaseId?: string;
|
|
250
|
+
contentArn?: string;
|
|
251
|
+
contentId?: string;
|
|
252
|
+
}
|
|
253
|
+
export interface GenerativeReference {
|
|
254
|
+
modelId?: string;
|
|
255
|
+
generationId?: string;
|
|
256
|
+
}
|
|
257
|
+
export type DataReference =
|
|
258
|
+
| DataReference.ContentReferenceMember
|
|
259
|
+
| DataReference.GenerativeReferenceMember
|
|
260
|
+
| DataReference.$UnknownMember;
|
|
261
|
+
export declare namespace DataReference {
|
|
262
|
+
interface ContentReferenceMember {
|
|
263
|
+
contentReference: ContentReference;
|
|
264
|
+
generativeReference?: never;
|
|
265
|
+
$unknown?: never;
|
|
266
|
+
}
|
|
267
|
+
interface GenerativeReferenceMember {
|
|
268
|
+
contentReference?: never;
|
|
269
|
+
generativeReference: GenerativeReference;
|
|
270
|
+
$unknown?: never;
|
|
271
|
+
}
|
|
272
|
+
interface $UnknownMember {
|
|
273
|
+
contentReference?: never;
|
|
274
|
+
generativeReference?: never;
|
|
275
|
+
$unknown: [string, any];
|
|
276
|
+
}
|
|
277
|
+
interface Visitor<T> {
|
|
278
|
+
contentReference: (value: ContentReference) => T;
|
|
279
|
+
generativeReference: (value: GenerativeReference) => T;
|
|
280
|
+
_: (name: string, value: any) => T;
|
|
281
|
+
}
|
|
282
|
+
const visit: <T>(value: DataReference, visitor: Visitor<T>) => T;
|
|
283
|
+
}
|
|
284
|
+
export interface Document {
|
|
285
|
+
contentReference: ContentReference | undefined;
|
|
286
|
+
title?: DocumentText;
|
|
287
|
+
excerpt?: DocumentText;
|
|
288
|
+
}
|
|
289
|
+
export declare const RecommendationType: {
|
|
290
|
+
readonly GENERATIVE_ANSWER: "GENERATIVE_ANSWER";
|
|
291
|
+
readonly GENERATIVE_RESPONSE: "GENERATIVE_RESPONSE";
|
|
292
|
+
readonly KNOWLEDGE_CONTENT: "KNOWLEDGE_CONTENT";
|
|
293
|
+
};
|
|
294
|
+
export type RecommendationType =
|
|
295
|
+
(typeof RecommendationType)[keyof typeof RecommendationType];
|
|
296
|
+
export interface QueryRecommendationTriggerData {
|
|
297
|
+
text?: string;
|
|
298
|
+
}
|
|
299
|
+
export type RecommendationTriggerData =
|
|
300
|
+
| RecommendationTriggerData.QueryMember
|
|
301
|
+
| RecommendationTriggerData.$UnknownMember;
|
|
302
|
+
export declare namespace RecommendationTriggerData {
|
|
303
|
+
interface QueryMember {
|
|
304
|
+
query: QueryRecommendationTriggerData;
|
|
305
|
+
$unknown?: never;
|
|
306
|
+
}
|
|
307
|
+
interface $UnknownMember {
|
|
308
|
+
query?: never;
|
|
309
|
+
$unknown: [string, any];
|
|
310
|
+
}
|
|
311
|
+
interface Visitor<T> {
|
|
312
|
+
query: (value: QueryRecommendationTriggerData) => T;
|
|
313
|
+
_: (name: string, value: any) => T;
|
|
314
|
+
}
|
|
315
|
+
const visit: <T>(value: RecommendationTriggerData, visitor: Visitor<T>) => T;
|
|
316
|
+
}
|
|
317
|
+
export declare const RecommendationSourceType: {
|
|
318
|
+
readonly ISSUE_DETECTION: "ISSUE_DETECTION";
|
|
319
|
+
readonly OTHER: "OTHER";
|
|
320
|
+
readonly RULE_EVALUATION: "RULE_EVALUATION";
|
|
321
|
+
};
|
|
322
|
+
export type RecommendationSourceType =
|
|
323
|
+
(typeof RecommendationSourceType)[keyof typeof RecommendationSourceType];
|
|
324
|
+
export declare const RecommendationTriggerType: {
|
|
325
|
+
readonly GENERATIVE: "GENERATIVE";
|
|
326
|
+
readonly QUERY: "QUERY";
|
|
327
|
+
};
|
|
328
|
+
export type RecommendationTriggerType =
|
|
329
|
+
(typeof RecommendationTriggerType)[keyof typeof RecommendationTriggerType];
|
|
330
|
+
export interface RecommendationTrigger {
|
|
331
|
+
id: string | undefined;
|
|
332
|
+
type: RecommendationTriggerType | undefined;
|
|
333
|
+
source: RecommendationSourceType | undefined;
|
|
334
|
+
data: RecommendationTriggerData | undefined;
|
|
335
|
+
recommendationIds: string[] | undefined;
|
|
336
|
+
}
|
|
337
|
+
export interface ListAssistantsRequest {
|
|
338
|
+
nextToken?: string;
|
|
339
|
+
maxResults?: number;
|
|
340
|
+
}
|
|
341
|
+
export interface AssistantSummary {
|
|
342
|
+
assistantId: string | undefined;
|
|
343
|
+
assistantArn: string | undefined;
|
|
344
|
+
name: string | undefined;
|
|
345
|
+
type: AssistantType | undefined;
|
|
346
|
+
status: AssistantStatus | undefined;
|
|
347
|
+
description?: string;
|
|
348
|
+
tags?: Record<string, string>;
|
|
349
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
350
|
+
integrationConfiguration?: AssistantIntegrationConfiguration;
|
|
351
|
+
capabilityConfiguration?: AssistantCapabilityConfiguration;
|
|
352
|
+
}
|
|
353
|
+
export interface ListAssistantsResponse {
|
|
354
|
+
assistantSummaries: AssistantSummary[] | undefined;
|
|
355
|
+
nextToken?: string;
|
|
356
|
+
}
|
|
357
|
+
export interface NotifyRecommendationsReceivedRequest {
|
|
358
|
+
assistantId: string | undefined;
|
|
359
|
+
sessionId: string | undefined;
|
|
360
|
+
recommendationIds: string[] | undefined;
|
|
361
|
+
}
|
|
362
|
+
export interface NotifyRecommendationsReceivedError {
|
|
363
|
+
recommendationId?: string;
|
|
364
|
+
message?: string;
|
|
365
|
+
}
|
|
366
|
+
export interface NotifyRecommendationsReceivedResponse {
|
|
367
|
+
recommendationIds?: string[];
|
|
368
|
+
errors?: NotifyRecommendationsReceivedError[];
|
|
369
|
+
}
|
|
370
|
+
export declare const QueryConditionComparisonOperator: {
|
|
371
|
+
readonly EQUALS: "EQUALS";
|
|
372
|
+
};
|
|
373
|
+
export type QueryConditionComparisonOperator =
|
|
374
|
+
(typeof QueryConditionComparisonOperator)[keyof typeof QueryConditionComparisonOperator];
|
|
375
|
+
export declare const QueryConditionFieldName: {
|
|
376
|
+
readonly RESULT_TYPE: "RESULT_TYPE";
|
|
377
|
+
};
|
|
378
|
+
export type QueryConditionFieldName =
|
|
379
|
+
(typeof QueryConditionFieldName)[keyof typeof QueryConditionFieldName];
|
|
380
|
+
export interface QueryConditionItem {
|
|
381
|
+
field: QueryConditionFieldName | undefined;
|
|
382
|
+
comparator: QueryConditionComparisonOperator | undefined;
|
|
383
|
+
value: string | undefined;
|
|
384
|
+
}
|
|
385
|
+
export type QueryCondition =
|
|
386
|
+
| QueryCondition.SingleMember
|
|
387
|
+
| QueryCondition.$UnknownMember;
|
|
388
|
+
export declare namespace QueryCondition {
|
|
389
|
+
interface SingleMember {
|
|
390
|
+
single: QueryConditionItem;
|
|
391
|
+
$unknown?: never;
|
|
392
|
+
}
|
|
393
|
+
interface $UnknownMember {
|
|
394
|
+
single?: never;
|
|
395
|
+
$unknown: [string, any];
|
|
396
|
+
}
|
|
397
|
+
interface Visitor<T> {
|
|
398
|
+
single: (value: QueryConditionItem) => T;
|
|
399
|
+
_: (name: string, value: any) => T;
|
|
400
|
+
}
|
|
401
|
+
const visit: <T>(value: QueryCondition, visitor: Visitor<T>) => T;
|
|
402
|
+
}
|
|
403
|
+
export interface QueryAssistantRequest {
|
|
404
|
+
assistantId: string | undefined;
|
|
405
|
+
queryText: string | undefined;
|
|
406
|
+
nextToken?: string;
|
|
407
|
+
maxResults?: number;
|
|
408
|
+
sessionId?: string;
|
|
409
|
+
queryCondition?: QueryCondition[];
|
|
410
|
+
}
|
|
411
|
+
export declare const QueryResultType: {
|
|
412
|
+
readonly GENERATIVE_ANSWER: "GENERATIVE_ANSWER";
|
|
413
|
+
readonly KNOWLEDGE_CONTENT: "KNOWLEDGE_CONTENT";
|
|
414
|
+
};
|
|
415
|
+
export type QueryResultType =
|
|
416
|
+
(typeof QueryResultType)[keyof typeof QueryResultType];
|
|
417
|
+
export declare class RequestTimeoutException extends __BaseException {
|
|
418
|
+
readonly name: "RequestTimeoutException";
|
|
419
|
+
readonly $fault: "client";
|
|
420
|
+
$retryable: {};
|
|
421
|
+
constructor(
|
|
422
|
+
opts: __ExceptionOptionType<RequestTimeoutException, __BaseException>
|
|
423
|
+
);
|
|
424
|
+
}
|
|
425
|
+
export declare const FilterField: {
|
|
426
|
+
readonly NAME: "NAME";
|
|
427
|
+
};
|
|
428
|
+
export type FilterField = (typeof FilterField)[keyof typeof FilterField];
|
|
429
|
+
export declare const FilterOperator: {
|
|
430
|
+
readonly EQUALS: "EQUALS";
|
|
431
|
+
};
|
|
432
|
+
export type FilterOperator =
|
|
433
|
+
(typeof FilterOperator)[keyof typeof FilterOperator];
|
|
434
|
+
export interface Filter {
|
|
435
|
+
field: FilterField | undefined;
|
|
436
|
+
operator: FilterOperator | undefined;
|
|
437
|
+
value: string | undefined;
|
|
438
|
+
}
|
|
439
|
+
export interface SearchExpression {
|
|
440
|
+
filters: Filter[] | undefined;
|
|
441
|
+
}
|
|
442
|
+
export interface SearchSessionsRequest {
|
|
443
|
+
nextToken?: string;
|
|
444
|
+
maxResults?: number;
|
|
445
|
+
assistantId: string | undefined;
|
|
446
|
+
searchExpression: SearchExpression | undefined;
|
|
447
|
+
}
|
|
448
|
+
export interface SessionSummary {
|
|
449
|
+
sessionId: string | undefined;
|
|
450
|
+
sessionArn: string | undefined;
|
|
451
|
+
assistantId: string | undefined;
|
|
452
|
+
assistantArn: string | undefined;
|
|
453
|
+
}
|
|
454
|
+
export interface SearchSessionsResponse {
|
|
455
|
+
sessionSummaries: SessionSummary[] | undefined;
|
|
456
|
+
nextToken?: string;
|
|
457
|
+
}
|
|
458
|
+
export interface CreateSessionRequest {
|
|
459
|
+
clientToken?: string;
|
|
460
|
+
assistantId: string | undefined;
|
|
461
|
+
name: string | undefined;
|
|
462
|
+
description?: string;
|
|
463
|
+
tags?: Record<string, string>;
|
|
464
|
+
}
|
|
465
|
+
export interface SessionIntegrationConfiguration {
|
|
466
|
+
topicIntegrationArn?: string;
|
|
467
|
+
}
|
|
468
|
+
export interface SessionData {
|
|
469
|
+
sessionArn: string | undefined;
|
|
470
|
+
sessionId: string | undefined;
|
|
471
|
+
name: string | undefined;
|
|
472
|
+
description?: string;
|
|
473
|
+
tags?: Record<string, string>;
|
|
474
|
+
integrationConfiguration?: SessionIntegrationConfiguration;
|
|
475
|
+
}
|
|
476
|
+
export interface CreateSessionResponse {
|
|
477
|
+
session?: SessionData;
|
|
478
|
+
}
|
|
479
|
+
export interface GetSessionRequest {
|
|
480
|
+
assistantId: string | undefined;
|
|
481
|
+
sessionId: string | undefined;
|
|
482
|
+
}
|
|
483
|
+
export interface GetSessionResponse {
|
|
484
|
+
session?: SessionData;
|
|
485
|
+
}
|
|
486
|
+
export interface ConnectConfiguration {
|
|
487
|
+
instanceId?: string;
|
|
488
|
+
}
|
|
489
|
+
export type Configuration =
|
|
490
|
+
| Configuration.ConnectConfigurationMember
|
|
491
|
+
| Configuration.$UnknownMember;
|
|
492
|
+
export declare namespace Configuration {
|
|
493
|
+
interface ConnectConfigurationMember {
|
|
494
|
+
connectConfiguration: ConnectConfiguration;
|
|
495
|
+
$unknown?: never;
|
|
496
|
+
}
|
|
497
|
+
interface $UnknownMember {
|
|
498
|
+
connectConfiguration?: never;
|
|
499
|
+
$unknown: [string, any];
|
|
500
|
+
}
|
|
501
|
+
interface Visitor<T> {
|
|
502
|
+
connectConfiguration: (value: ConnectConfiguration) => T;
|
|
503
|
+
_: (name: string, value: any) => T;
|
|
504
|
+
}
|
|
505
|
+
const visit: <T>(value: Configuration, visitor: Visitor<T>) => T;
|
|
506
|
+
}
|
|
507
|
+
export interface CreateContentRequest {
|
|
508
|
+
knowledgeBaseId: string | undefined;
|
|
509
|
+
name: string | undefined;
|
|
510
|
+
title?: string;
|
|
511
|
+
overrideLinkOutUri?: string;
|
|
512
|
+
metadata?: Record<string, string>;
|
|
513
|
+
uploadId: string | undefined;
|
|
514
|
+
clientToken?: string;
|
|
515
|
+
tags?: Record<string, string>;
|
|
516
|
+
}
|
|
517
|
+
export declare const ContentStatus: {
|
|
518
|
+
readonly ACTIVE: "ACTIVE";
|
|
519
|
+
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
520
|
+
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
521
|
+
readonly DELETED: "DELETED";
|
|
522
|
+
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
523
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
524
|
+
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
525
|
+
};
|
|
526
|
+
export type ContentStatus = (typeof ContentStatus)[keyof typeof ContentStatus];
|
|
527
|
+
export interface ContentData {
|
|
528
|
+
contentArn: string | undefined;
|
|
529
|
+
contentId: string | undefined;
|
|
530
|
+
knowledgeBaseArn: string | undefined;
|
|
531
|
+
knowledgeBaseId: string | undefined;
|
|
532
|
+
name: string | undefined;
|
|
533
|
+
revisionId: string | undefined;
|
|
534
|
+
title: string | undefined;
|
|
535
|
+
contentType: string | undefined;
|
|
536
|
+
status: ContentStatus | undefined;
|
|
537
|
+
metadata: Record<string, string> | undefined;
|
|
538
|
+
tags?: Record<string, string>;
|
|
539
|
+
linkOutUri?: string;
|
|
540
|
+
url: string | undefined;
|
|
541
|
+
urlExpiry: Date | undefined;
|
|
542
|
+
}
|
|
543
|
+
export interface CreateContentResponse {
|
|
544
|
+
content?: ContentData;
|
|
545
|
+
}
|
|
546
|
+
export interface DeleteContentRequest {
|
|
547
|
+
knowledgeBaseId: string | undefined;
|
|
548
|
+
contentId: string | undefined;
|
|
549
|
+
}
|
|
550
|
+
export interface DeleteContentResponse {}
|
|
551
|
+
export interface GetContentRequest {
|
|
552
|
+
contentId: string | undefined;
|
|
553
|
+
knowledgeBaseId: string | undefined;
|
|
554
|
+
}
|
|
555
|
+
export interface GetContentResponse {
|
|
556
|
+
content?: ContentData;
|
|
557
|
+
}
|
|
558
|
+
export interface GetContentSummaryRequest {
|
|
559
|
+
contentId: string | undefined;
|
|
560
|
+
knowledgeBaseId: string | undefined;
|
|
561
|
+
}
|
|
562
|
+
export interface ContentSummary {
|
|
563
|
+
contentArn: string | undefined;
|
|
564
|
+
contentId: string | undefined;
|
|
565
|
+
knowledgeBaseArn: string | undefined;
|
|
566
|
+
knowledgeBaseId: string | undefined;
|
|
567
|
+
name: string | undefined;
|
|
568
|
+
revisionId: string | undefined;
|
|
569
|
+
title: string | undefined;
|
|
570
|
+
contentType: string | undefined;
|
|
571
|
+
status: ContentStatus | undefined;
|
|
572
|
+
metadata: Record<string, string> | undefined;
|
|
573
|
+
tags?: Record<string, string>;
|
|
574
|
+
}
|
|
575
|
+
export interface GetContentSummaryResponse {
|
|
576
|
+
contentSummary?: ContentSummary;
|
|
577
|
+
}
|
|
578
|
+
export interface ListContentsRequest {
|
|
579
|
+
nextToken?: string;
|
|
580
|
+
maxResults?: number;
|
|
581
|
+
knowledgeBaseId: string | undefined;
|
|
582
|
+
}
|
|
583
|
+
export interface ListContentsResponse {
|
|
584
|
+
contentSummaries: ContentSummary[] | undefined;
|
|
585
|
+
nextToken?: string;
|
|
586
|
+
}
|
|
587
|
+
export declare class PreconditionFailedException extends __BaseException {
|
|
588
|
+
readonly name: "PreconditionFailedException";
|
|
589
|
+
readonly $fault: "client";
|
|
590
|
+
constructor(
|
|
591
|
+
opts: __ExceptionOptionType<PreconditionFailedException, __BaseException>
|
|
592
|
+
);
|
|
593
|
+
}
|
|
594
|
+
export interface UpdateContentRequest {
|
|
595
|
+
knowledgeBaseId: string | undefined;
|
|
596
|
+
contentId: string | undefined;
|
|
597
|
+
revisionId?: string;
|
|
598
|
+
title?: string;
|
|
599
|
+
overrideLinkOutUri?: string;
|
|
600
|
+
removeOverrideLinkOutUri?: boolean;
|
|
601
|
+
metadata?: Record<string, string>;
|
|
602
|
+
uploadId?: string;
|
|
603
|
+
}
|
|
604
|
+
export interface UpdateContentResponse {
|
|
605
|
+
content?: ContentData;
|
|
606
|
+
}
|
|
607
|
+
export declare const KnowledgeBaseType: {
|
|
608
|
+
readonly CUSTOM: "CUSTOM";
|
|
609
|
+
readonly EXTERNAL: "EXTERNAL";
|
|
610
|
+
readonly QUICK_RESPONSES: "QUICK_RESPONSES";
|
|
611
|
+
};
|
|
612
|
+
export type KnowledgeBaseType =
|
|
613
|
+
(typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType];
|
|
614
|
+
export interface RenderingConfiguration {
|
|
615
|
+
templateUri?: string;
|
|
616
|
+
}
|
|
617
|
+
export type SourceConfiguration =
|
|
618
|
+
| SourceConfiguration.AppIntegrationsMember
|
|
619
|
+
| SourceConfiguration.$UnknownMember;
|
|
620
|
+
export declare namespace SourceConfiguration {
|
|
621
|
+
interface AppIntegrationsMember {
|
|
622
|
+
appIntegrations: AppIntegrationsConfiguration;
|
|
623
|
+
$unknown?: never;
|
|
624
|
+
}
|
|
625
|
+
interface $UnknownMember {
|
|
626
|
+
appIntegrations?: never;
|
|
627
|
+
$unknown: [string, any];
|
|
628
|
+
}
|
|
629
|
+
interface Visitor<T> {
|
|
630
|
+
appIntegrations: (value: AppIntegrationsConfiguration) => T;
|
|
631
|
+
_: (name: string, value: any) => T;
|
|
632
|
+
}
|
|
633
|
+
const visit: <T>(value: SourceConfiguration, visitor: Visitor<T>) => T;
|
|
634
|
+
}
|
|
635
|
+
export interface CreateKnowledgeBaseRequest {
|
|
636
|
+
clientToken?: string;
|
|
637
|
+
name: string | undefined;
|
|
638
|
+
knowledgeBaseType: KnowledgeBaseType | undefined;
|
|
639
|
+
sourceConfiguration?: SourceConfiguration;
|
|
640
|
+
renderingConfiguration?: RenderingConfiguration;
|
|
641
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
642
|
+
description?: string;
|
|
643
|
+
tags?: Record<string, string>;
|
|
644
|
+
}
|
|
645
|
+
export declare const KnowledgeBaseStatus: {
|
|
646
|
+
readonly ACTIVE: "ACTIVE";
|
|
647
|
+
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
648
|
+
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
649
|
+
readonly DELETED: "DELETED";
|
|
650
|
+
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
651
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
652
|
+
};
|
|
653
|
+
export type KnowledgeBaseStatus =
|
|
654
|
+
(typeof KnowledgeBaseStatus)[keyof typeof KnowledgeBaseStatus];
|
|
655
|
+
export interface KnowledgeBaseData {
|
|
656
|
+
knowledgeBaseId: string | undefined;
|
|
657
|
+
knowledgeBaseArn: string | undefined;
|
|
658
|
+
name: string | undefined;
|
|
659
|
+
knowledgeBaseType: KnowledgeBaseType | undefined;
|
|
660
|
+
status: KnowledgeBaseStatus | undefined;
|
|
661
|
+
lastContentModificationTime?: Date;
|
|
662
|
+
sourceConfiguration?: SourceConfiguration;
|
|
663
|
+
renderingConfiguration?: RenderingConfiguration;
|
|
664
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
665
|
+
description?: string;
|
|
666
|
+
tags?: Record<string, string>;
|
|
667
|
+
}
|
|
668
|
+
export interface CreateKnowledgeBaseResponse {
|
|
669
|
+
knowledgeBase?: KnowledgeBaseData;
|
|
670
|
+
}
|
|
671
|
+
export type QuickResponseDataProvider =
|
|
672
|
+
| QuickResponseDataProvider.ContentMember
|
|
673
|
+
| QuickResponseDataProvider.$UnknownMember;
|
|
674
|
+
export declare namespace QuickResponseDataProvider {
|
|
675
|
+
interface ContentMember {
|
|
676
|
+
content: string;
|
|
677
|
+
$unknown?: never;
|
|
678
|
+
}
|
|
679
|
+
interface $UnknownMember {
|
|
680
|
+
content?: never;
|
|
681
|
+
$unknown: [string, any];
|
|
682
|
+
}
|
|
683
|
+
interface Visitor<T> {
|
|
684
|
+
content: (value: string) => T;
|
|
685
|
+
_: (name: string, value: any) => T;
|
|
686
|
+
}
|
|
687
|
+
const visit: <T>(value: QuickResponseDataProvider, visitor: Visitor<T>) => T;
|
|
688
|
+
}
|
|
689
|
+
export interface GroupingConfiguration {
|
|
690
|
+
criteria?: string;
|
|
691
|
+
values?: string[];
|
|
692
|
+
}
|
|
693
|
+
export interface CreateQuickResponseRequest {
|
|
694
|
+
knowledgeBaseId: string | undefined;
|
|
695
|
+
name: string | undefined;
|
|
696
|
+
content: QuickResponseDataProvider | undefined;
|
|
697
|
+
contentType?: string;
|
|
698
|
+
groupingConfiguration?: GroupingConfiguration;
|
|
699
|
+
description?: string;
|
|
700
|
+
shortcutKey?: string;
|
|
701
|
+
isActive?: boolean;
|
|
702
|
+
channels?: string[];
|
|
703
|
+
language?: string;
|
|
704
|
+
clientToken?: string;
|
|
705
|
+
tags?: Record<string, string>;
|
|
706
|
+
}
|
|
707
|
+
export type QuickResponseContentProvider =
|
|
708
|
+
| QuickResponseContentProvider.ContentMember
|
|
709
|
+
| QuickResponseContentProvider.$UnknownMember;
|
|
710
|
+
export declare namespace QuickResponseContentProvider {
|
|
711
|
+
interface ContentMember {
|
|
712
|
+
content: string;
|
|
713
|
+
$unknown?: never;
|
|
714
|
+
}
|
|
715
|
+
interface $UnknownMember {
|
|
716
|
+
content?: never;
|
|
717
|
+
$unknown: [string, any];
|
|
718
|
+
}
|
|
719
|
+
interface Visitor<T> {
|
|
720
|
+
content: (value: string) => T;
|
|
721
|
+
_: (name: string, value: any) => T;
|
|
722
|
+
}
|
|
723
|
+
const visit: <T>(
|
|
724
|
+
value: QuickResponseContentProvider,
|
|
725
|
+
visitor: Visitor<T>
|
|
726
|
+
) => T;
|
|
727
|
+
}
|
|
728
|
+
export interface QuickResponseContents {
|
|
729
|
+
plainText?: QuickResponseContentProvider;
|
|
730
|
+
markdown?: QuickResponseContentProvider;
|
|
731
|
+
}
|
|
732
|
+
export declare const QuickResponseStatus: {
|
|
733
|
+
readonly CREATED: "CREATED";
|
|
734
|
+
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
735
|
+
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
736
|
+
readonly DELETED: "DELETED";
|
|
737
|
+
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
738
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
739
|
+
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
740
|
+
readonly UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS";
|
|
741
|
+
};
|
|
742
|
+
export type QuickResponseStatus =
|
|
743
|
+
(typeof QuickResponseStatus)[keyof typeof QuickResponseStatus];
|
|
744
|
+
export interface QuickResponseData {
|
|
745
|
+
quickResponseArn: string | undefined;
|
|
746
|
+
quickResponseId: string | undefined;
|
|
747
|
+
knowledgeBaseArn: string | undefined;
|
|
748
|
+
knowledgeBaseId: string | undefined;
|
|
749
|
+
name: string | undefined;
|
|
750
|
+
contentType: string | undefined;
|
|
751
|
+
status: QuickResponseStatus | undefined;
|
|
752
|
+
createdTime: Date | undefined;
|
|
753
|
+
lastModifiedTime: Date | undefined;
|
|
754
|
+
contents?: QuickResponseContents;
|
|
755
|
+
description?: string;
|
|
756
|
+
groupingConfiguration?: GroupingConfiguration;
|
|
757
|
+
shortcutKey?: string;
|
|
758
|
+
lastModifiedBy?: string;
|
|
759
|
+
isActive?: boolean;
|
|
760
|
+
channels?: string[];
|
|
761
|
+
language?: string;
|
|
762
|
+
tags?: Record<string, string>;
|
|
763
|
+
}
|
|
764
|
+
export interface CreateQuickResponseResponse {
|
|
765
|
+
quickResponse?: QuickResponseData;
|
|
766
|
+
}
|
|
767
|
+
export interface DeleteImportJobRequest {
|
|
768
|
+
knowledgeBaseId: string | undefined;
|
|
769
|
+
importJobId: string | undefined;
|
|
770
|
+
}
|
|
771
|
+
export interface DeleteImportJobResponse {}
|
|
772
|
+
export interface DeleteKnowledgeBaseRequest {
|
|
773
|
+
knowledgeBaseId: string | undefined;
|
|
774
|
+
}
|
|
775
|
+
export interface DeleteKnowledgeBaseResponse {}
|
|
776
|
+
export interface DeleteQuickResponseRequest {
|
|
777
|
+
knowledgeBaseId: string | undefined;
|
|
778
|
+
quickResponseId: string | undefined;
|
|
779
|
+
}
|
|
780
|
+
export interface DeleteQuickResponseResponse {}
|
|
781
|
+
export declare const ExternalSource: {
|
|
782
|
+
readonly AMAZON_CONNECT: "AMAZON_CONNECT";
|
|
783
|
+
};
|
|
784
|
+
export type ExternalSource =
|
|
785
|
+
(typeof ExternalSource)[keyof typeof ExternalSource];
|
|
786
|
+
export interface ExternalSourceConfiguration {
|
|
787
|
+
source: ExternalSource | undefined;
|
|
788
|
+
configuration: Configuration | undefined;
|
|
789
|
+
}
|
|
790
|
+
export interface GetImportJobRequest {
|
|
791
|
+
importJobId: string | undefined;
|
|
792
|
+
knowledgeBaseId: string | undefined;
|
|
793
|
+
}
|
|
794
|
+
export declare const ImportJobType: {
|
|
795
|
+
readonly QUICK_RESPONSES: "QUICK_RESPONSES";
|
|
796
|
+
};
|
|
797
|
+
export type ImportJobType = (typeof ImportJobType)[keyof typeof ImportJobType];
|
|
798
|
+
export declare const ImportJobStatus: {
|
|
799
|
+
readonly COMPLETE: "COMPLETE";
|
|
800
|
+
readonly DELETED: "DELETED";
|
|
801
|
+
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
802
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
803
|
+
readonly FAILED: "FAILED";
|
|
804
|
+
readonly START_IN_PROGRESS: "START_IN_PROGRESS";
|
|
805
|
+
};
|
|
806
|
+
export type ImportJobStatus =
|
|
807
|
+
(typeof ImportJobStatus)[keyof typeof ImportJobStatus];
|
|
808
|
+
export interface ImportJobData {
|
|
809
|
+
importJobId: string | undefined;
|
|
810
|
+
knowledgeBaseId: string | undefined;
|
|
811
|
+
uploadId: string | undefined;
|
|
812
|
+
knowledgeBaseArn: string | undefined;
|
|
813
|
+
importJobType: ImportJobType | undefined;
|
|
814
|
+
status: ImportJobStatus | undefined;
|
|
815
|
+
url: string | undefined;
|
|
816
|
+
failedRecordReport?: string;
|
|
817
|
+
urlExpiry: Date | undefined;
|
|
818
|
+
createdTime: Date | undefined;
|
|
819
|
+
lastModifiedTime: Date | undefined;
|
|
820
|
+
metadata?: Record<string, string>;
|
|
821
|
+
externalSourceConfiguration?: ExternalSourceConfiguration;
|
|
822
|
+
}
|
|
823
|
+
export interface GetImportJobResponse {
|
|
824
|
+
importJob?: ImportJobData;
|
|
825
|
+
}
|
|
826
|
+
export interface GetKnowledgeBaseRequest {
|
|
827
|
+
knowledgeBaseId: string | undefined;
|
|
828
|
+
}
|
|
829
|
+
export interface GetKnowledgeBaseResponse {
|
|
830
|
+
knowledgeBase?: KnowledgeBaseData;
|
|
831
|
+
}
|
|
832
|
+
export interface GetQuickResponseRequest {
|
|
833
|
+
quickResponseId: string | undefined;
|
|
834
|
+
knowledgeBaseId: string | undefined;
|
|
835
|
+
}
|
|
836
|
+
export interface GetQuickResponseResponse {
|
|
837
|
+
quickResponse?: QuickResponseData;
|
|
838
|
+
}
|
|
839
|
+
export interface ImportJobSummary {
|
|
840
|
+
importJobId: string | undefined;
|
|
841
|
+
knowledgeBaseId: string | undefined;
|
|
842
|
+
uploadId: string | undefined;
|
|
843
|
+
knowledgeBaseArn: string | undefined;
|
|
844
|
+
importJobType: ImportJobType | undefined;
|
|
845
|
+
status: ImportJobStatus | undefined;
|
|
846
|
+
createdTime: Date | undefined;
|
|
847
|
+
lastModifiedTime: Date | undefined;
|
|
848
|
+
metadata?: Record<string, string>;
|
|
849
|
+
externalSourceConfiguration?: ExternalSourceConfiguration;
|
|
850
|
+
}
|
|
851
|
+
export interface ListImportJobsRequest {
|
|
852
|
+
nextToken?: string;
|
|
853
|
+
maxResults?: number;
|
|
854
|
+
knowledgeBaseId: string | undefined;
|
|
855
|
+
}
|
|
856
|
+
export interface ListImportJobsResponse {
|
|
857
|
+
importJobSummaries: ImportJobSummary[] | undefined;
|
|
858
|
+
nextToken?: string;
|
|
859
|
+
}
|
|
860
|
+
export interface ListKnowledgeBasesRequest {
|
|
861
|
+
nextToken?: string;
|
|
862
|
+
maxResults?: number;
|
|
863
|
+
}
|
|
864
|
+
export interface KnowledgeBaseSummary {
|
|
865
|
+
knowledgeBaseId: string | undefined;
|
|
866
|
+
knowledgeBaseArn: string | undefined;
|
|
867
|
+
name: string | undefined;
|
|
868
|
+
knowledgeBaseType: KnowledgeBaseType | undefined;
|
|
869
|
+
status: KnowledgeBaseStatus | undefined;
|
|
870
|
+
sourceConfiguration?: SourceConfiguration;
|
|
871
|
+
renderingConfiguration?: RenderingConfiguration;
|
|
872
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
873
|
+
description?: string;
|
|
874
|
+
tags?: Record<string, string>;
|
|
875
|
+
}
|
|
876
|
+
export interface ListKnowledgeBasesResponse {
|
|
877
|
+
knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
|
|
878
|
+
nextToken?: string;
|
|
879
|
+
}
|
|
880
|
+
export interface ListQuickResponsesRequest {
|
|
881
|
+
nextToken?: string;
|
|
882
|
+
maxResults?: number;
|
|
883
|
+
knowledgeBaseId: string | undefined;
|
|
884
|
+
}
|
|
885
|
+
export interface QuickResponseSummary {
|
|
886
|
+
quickResponseArn: string | undefined;
|
|
887
|
+
quickResponseId: string | undefined;
|
|
888
|
+
knowledgeBaseArn: string | undefined;
|
|
889
|
+
knowledgeBaseId: string | undefined;
|
|
890
|
+
name: string | undefined;
|
|
891
|
+
contentType: string | undefined;
|
|
892
|
+
status: QuickResponseStatus | undefined;
|
|
893
|
+
createdTime: Date | undefined;
|
|
894
|
+
lastModifiedTime: Date | undefined;
|
|
895
|
+
description?: string;
|
|
896
|
+
lastModifiedBy?: string;
|
|
897
|
+
isActive?: boolean;
|
|
898
|
+
channels?: string[];
|
|
899
|
+
tags?: Record<string, string>;
|
|
900
|
+
}
|
|
901
|
+
export interface ListQuickResponsesResponse {
|
|
902
|
+
quickResponseSummaries: QuickResponseSummary[] | undefined;
|
|
903
|
+
nextToken?: string;
|
|
904
|
+
}
|
|
905
|
+
export interface UpdateQuickResponseRequest {
|
|
906
|
+
knowledgeBaseId: string | undefined;
|
|
907
|
+
quickResponseId: string | undefined;
|
|
908
|
+
name?: string;
|
|
909
|
+
content?: QuickResponseDataProvider;
|
|
910
|
+
contentType?: string;
|
|
911
|
+
groupingConfiguration?: GroupingConfiguration;
|
|
912
|
+
removeGroupingConfiguration?: boolean;
|
|
913
|
+
description?: string;
|
|
914
|
+
removeDescription?: boolean;
|
|
915
|
+
shortcutKey?: string;
|
|
916
|
+
removeShortcutKey?: boolean;
|
|
917
|
+
isActive?: boolean;
|
|
918
|
+
channels?: string[];
|
|
919
|
+
language?: string;
|
|
920
|
+
}
|
|
921
|
+
export interface UpdateQuickResponseResponse {
|
|
922
|
+
quickResponse?: QuickResponseData;
|
|
923
|
+
}
|
|
924
|
+
export interface RemoveKnowledgeBaseTemplateUriRequest {
|
|
925
|
+
knowledgeBaseId: string | undefined;
|
|
926
|
+
}
|
|
927
|
+
export interface RemoveKnowledgeBaseTemplateUriResponse {}
|
|
928
|
+
export interface SearchContentRequest {
|
|
929
|
+
nextToken?: string;
|
|
930
|
+
maxResults?: number;
|
|
931
|
+
knowledgeBaseId: string | undefined;
|
|
932
|
+
searchExpression: SearchExpression | undefined;
|
|
933
|
+
}
|
|
934
|
+
export interface SearchContentResponse {
|
|
935
|
+
contentSummaries: ContentSummary[] | undefined;
|
|
936
|
+
nextToken?: string;
|
|
937
|
+
}
|
|
938
|
+
export declare const QuickResponseFilterOperator: {
|
|
939
|
+
readonly EQUALS: "EQUALS";
|
|
940
|
+
readonly PREFIX: "PREFIX";
|
|
941
|
+
};
|
|
942
|
+
export type QuickResponseFilterOperator =
|
|
943
|
+
(typeof QuickResponseFilterOperator)[keyof typeof QuickResponseFilterOperator];
|
|
944
|
+
export interface QuickResponseFilterField {
|
|
945
|
+
name: string | undefined;
|
|
946
|
+
values?: string[];
|
|
947
|
+
operator: QuickResponseFilterOperator | undefined;
|
|
948
|
+
includeNoExistence?: boolean;
|
|
949
|
+
}
|
|
950
|
+
export declare const Order: {
|
|
951
|
+
readonly ASC: "ASC";
|
|
952
|
+
readonly DESC: "DESC";
|
|
953
|
+
};
|
|
954
|
+
export type Order = (typeof Order)[keyof typeof Order];
|
|
955
|
+
export interface QuickResponseOrderField {
|
|
956
|
+
name: string | undefined;
|
|
957
|
+
order?: Order;
|
|
958
|
+
}
|
|
959
|
+
export declare const QuickResponseQueryOperator: {
|
|
960
|
+
readonly CONTAINS: "CONTAINS";
|
|
961
|
+
readonly CONTAINS_AND_PREFIX: "CONTAINS_AND_PREFIX";
|
|
962
|
+
};
|
|
963
|
+
export type QuickResponseQueryOperator =
|
|
964
|
+
(typeof QuickResponseQueryOperator)[keyof typeof QuickResponseQueryOperator];
|
|
965
|
+
export declare const Priority: {
|
|
966
|
+
readonly HIGH: "HIGH";
|
|
967
|
+
readonly LOW: "LOW";
|
|
968
|
+
readonly MEDIUM: "MEDIUM";
|
|
969
|
+
};
|
|
970
|
+
export type Priority = (typeof Priority)[keyof typeof Priority];
|
|
971
|
+
export interface QuickResponseQueryField {
|
|
972
|
+
name: string | undefined;
|
|
973
|
+
values: string[] | undefined;
|
|
974
|
+
operator: QuickResponseQueryOperator | undefined;
|
|
975
|
+
allowFuzziness?: boolean;
|
|
976
|
+
priority?: Priority;
|
|
977
|
+
}
|
|
978
|
+
export interface QuickResponseSearchExpression {
|
|
979
|
+
queries?: QuickResponseQueryField[];
|
|
980
|
+
filters?: QuickResponseFilterField[];
|
|
981
|
+
orderOnField?: QuickResponseOrderField;
|
|
982
|
+
}
|
|
983
|
+
export interface SearchQuickResponsesRequest {
|
|
984
|
+
knowledgeBaseId: string | undefined;
|
|
985
|
+
searchExpression: QuickResponseSearchExpression | undefined;
|
|
986
|
+
nextToken?: string;
|
|
987
|
+
maxResults?: number;
|
|
988
|
+
attributes?: Record<string, string>;
|
|
989
|
+
}
|
|
990
|
+
export interface QuickResponseSearchResultData {
|
|
991
|
+
quickResponseArn: string | undefined;
|
|
992
|
+
quickResponseId: string | undefined;
|
|
993
|
+
knowledgeBaseArn: string | undefined;
|
|
994
|
+
knowledgeBaseId: string | undefined;
|
|
995
|
+
name: string | undefined;
|
|
996
|
+
contentType: string | undefined;
|
|
997
|
+
status: QuickResponseStatus | undefined;
|
|
998
|
+
contents: QuickResponseContents | undefined;
|
|
999
|
+
createdTime: Date | undefined;
|
|
1000
|
+
lastModifiedTime: Date | undefined;
|
|
1001
|
+
isActive: boolean | undefined;
|
|
1002
|
+
description?: string;
|
|
1003
|
+
groupingConfiguration?: GroupingConfiguration;
|
|
1004
|
+
shortcutKey?: string;
|
|
1005
|
+
lastModifiedBy?: string;
|
|
1006
|
+
channels?: string[];
|
|
1007
|
+
language?: string;
|
|
1008
|
+
attributesNotInterpolated?: string[];
|
|
1009
|
+
attributesInterpolated?: string[];
|
|
1010
|
+
tags?: Record<string, string>;
|
|
1011
|
+
}
|
|
1012
|
+
export interface SearchQuickResponsesResponse {
|
|
1013
|
+
results: QuickResponseSearchResultData[] | undefined;
|
|
1014
|
+
nextToken?: string;
|
|
1015
|
+
}
|
|
1016
|
+
export interface StartContentUploadRequest {
|
|
1017
|
+
knowledgeBaseId: string | undefined;
|
|
1018
|
+
contentType: string | undefined;
|
|
1019
|
+
presignedUrlTimeToLive?: number;
|
|
1020
|
+
}
|
|
1021
|
+
export interface StartContentUploadResponse {
|
|
1022
|
+
uploadId: string | undefined;
|
|
1023
|
+
url: string | undefined;
|
|
1024
|
+
urlExpiry: Date | undefined;
|
|
1025
|
+
headersToInclude: Record<string, string> | undefined;
|
|
1026
|
+
}
|
|
1027
|
+
export interface StartImportJobRequest {
|
|
1028
|
+
knowledgeBaseId: string | undefined;
|
|
1029
|
+
importJobType: ImportJobType | undefined;
|
|
1030
|
+
uploadId: string | undefined;
|
|
1031
|
+
clientToken?: string;
|
|
1032
|
+
metadata?: Record<string, string>;
|
|
1033
|
+
externalSourceConfiguration?: ExternalSourceConfiguration;
|
|
1034
|
+
}
|
|
1035
|
+
export interface StartImportJobResponse {
|
|
1036
|
+
importJob?: ImportJobData;
|
|
1037
|
+
}
|
|
1038
|
+
export interface UpdateKnowledgeBaseTemplateUriRequest {
|
|
1039
|
+
knowledgeBaseId: string | undefined;
|
|
1040
|
+
templateUri: string | undefined;
|
|
1041
|
+
}
|
|
1042
|
+
export interface UpdateKnowledgeBaseTemplateUriResponse {
|
|
1043
|
+
knowledgeBase?: KnowledgeBaseData;
|
|
1044
|
+
}
|
|
1045
|
+
export interface ListTagsForResourceRequest {
|
|
1046
|
+
resourceArn: string | undefined;
|
|
1047
|
+
}
|
|
1048
|
+
export interface ListTagsForResourceResponse {
|
|
1049
|
+
tags?: Record<string, string>;
|
|
1050
|
+
}
|
|
1051
|
+
export interface TagResourceRequest {
|
|
1052
|
+
resourceArn: string | undefined;
|
|
1053
|
+
tags: Record<string, string> | undefined;
|
|
1054
|
+
}
|
|
1055
|
+
export interface TagResourceResponse {}
|
|
1056
|
+
export declare class TooManyTagsException extends __BaseException {
|
|
1057
|
+
readonly name: "TooManyTagsException";
|
|
1058
|
+
readonly $fault: "client";
|
|
1059
|
+
resourceName?: string;
|
|
1060
|
+
constructor(
|
|
1061
|
+
opts: __ExceptionOptionType<TooManyTagsException, __BaseException>
|
|
1062
|
+
);
|
|
1063
|
+
}
|
|
1064
|
+
export interface UntagResourceRequest {
|
|
1065
|
+
resourceArn: string | undefined;
|
|
1066
|
+
tagKeys: string[] | undefined;
|
|
1067
|
+
}
|
|
1068
|
+
export interface UntagResourceResponse {}
|
|
1069
|
+
export type DataDetails =
|
|
1070
|
+
| DataDetails.ContentDataMember
|
|
1071
|
+
| DataDetails.GenerativeDataMember
|
|
1072
|
+
| DataDetails.SourceContentDataMember
|
|
1073
|
+
| DataDetails.$UnknownMember;
|
|
1074
|
+
export declare namespace DataDetails {
|
|
1075
|
+
interface ContentDataMember {
|
|
1076
|
+
contentData: ContentDataDetails;
|
|
1077
|
+
generativeData?: never;
|
|
1078
|
+
sourceContentData?: never;
|
|
1079
|
+
$unknown?: never;
|
|
1080
|
+
}
|
|
1081
|
+
interface GenerativeDataMember {
|
|
1082
|
+
contentData?: never;
|
|
1083
|
+
generativeData: GenerativeDataDetails;
|
|
1084
|
+
sourceContentData?: never;
|
|
1085
|
+
$unknown?: never;
|
|
1086
|
+
}
|
|
1087
|
+
interface SourceContentDataMember {
|
|
1088
|
+
contentData?: never;
|
|
1089
|
+
generativeData?: never;
|
|
1090
|
+
sourceContentData: SourceContentDataDetails;
|
|
1091
|
+
$unknown?: never;
|
|
1092
|
+
}
|
|
1093
|
+
interface $UnknownMember {
|
|
1094
|
+
contentData?: never;
|
|
1095
|
+
generativeData?: never;
|
|
1096
|
+
sourceContentData?: never;
|
|
1097
|
+
$unknown: [string, any];
|
|
1098
|
+
}
|
|
1099
|
+
interface Visitor<T> {
|
|
1100
|
+
contentData: (value: ContentDataDetails) => T;
|
|
1101
|
+
generativeData: (value: GenerativeDataDetails) => T;
|
|
1102
|
+
sourceContentData: (value: SourceContentDataDetails) => T;
|
|
1103
|
+
_: (name: string, value: any) => T;
|
|
1104
|
+
}
|
|
1105
|
+
const visit: <T>(value: DataDetails, visitor: Visitor<T>) => T;
|
|
1106
|
+
}
|
|
1107
|
+
export interface DataSummary {
|
|
1108
|
+
reference: DataReference | undefined;
|
|
1109
|
+
details: DataDetails | undefined;
|
|
1110
|
+
}
|
|
1111
|
+
export interface GenerativeDataDetails {
|
|
1112
|
+
completion: string | undefined;
|
|
1113
|
+
references: DataSummary[] | undefined;
|
|
1114
|
+
rankingData: RankingData | undefined;
|
|
1115
|
+
}
|
|
1116
|
+
export interface RecommendationData {
|
|
1117
|
+
recommendationId: string | undefined;
|
|
1118
|
+
document?: Document;
|
|
1119
|
+
relevanceScore?: number;
|
|
1120
|
+
relevanceLevel?: RelevanceLevel;
|
|
1121
|
+
type?: RecommendationType;
|
|
1122
|
+
data?: DataSummary;
|
|
1123
|
+
}
|
|
1124
|
+
export interface ResultData {
|
|
1125
|
+
resultId: string | undefined;
|
|
1126
|
+
document?: Document;
|
|
1127
|
+
relevanceScore?: number;
|
|
1128
|
+
data?: DataSummary;
|
|
1129
|
+
type?: QueryResultType;
|
|
1130
|
+
}
|
|
1131
|
+
export interface GetRecommendationsResponse {
|
|
1132
|
+
recommendations: RecommendationData[] | undefined;
|
|
1133
|
+
triggers?: RecommendationTrigger[];
|
|
1134
|
+
}
|
|
1135
|
+
export interface QueryAssistantResponse {
|
|
1136
|
+
results: ResultData[] | undefined;
|
|
1137
|
+
nextToken?: string;
|
|
1138
|
+
}
|
|
1139
|
+
export declare const DocumentTextFilterSensitiveLog: (obj: DocumentText) => any;
|
|
1140
|
+
export declare const TextDataFilterSensitiveLog: (obj: TextData) => any;
|
|
1141
|
+
export declare const ContentDataDetailsFilterSensitiveLog: (
|
|
1142
|
+
obj: ContentDataDetails
|
|
1143
|
+
) => any;
|
|
1144
|
+
export declare const SourceContentDataDetailsFilterSensitiveLog: (
|
|
1145
|
+
obj: SourceContentDataDetails
|
|
1146
|
+
) => any;
|
|
1147
|
+
export declare const DocumentFilterSensitiveLog: (obj: Document) => any;
|
|
1148
|
+
export declare const QueryRecommendationTriggerDataFilterSensitiveLog: (
|
|
1149
|
+
obj: QueryRecommendationTriggerData
|
|
1150
|
+
) => any;
|
|
1151
|
+
export declare const RecommendationTriggerDataFilterSensitiveLog: (
|
|
1152
|
+
obj: RecommendationTriggerData
|
|
1153
|
+
) => any;
|
|
1154
|
+
export declare const RecommendationTriggerFilterSensitiveLog: (
|
|
1155
|
+
obj: RecommendationTrigger
|
|
1156
|
+
) => any;
|
|
1157
|
+
export declare const QueryAssistantRequestFilterSensitiveLog: (
|
|
1158
|
+
obj: QueryAssistantRequest
|
|
1159
|
+
) => any;
|
|
1160
|
+
export declare const ContentDataFilterSensitiveLog: (obj: ContentData) => any;
|
|
1161
|
+
export declare const CreateContentResponseFilterSensitiveLog: (
|
|
1162
|
+
obj: CreateContentResponse
|
|
1163
|
+
) => any;
|
|
1164
|
+
export declare const GetContentResponseFilterSensitiveLog: (
|
|
1165
|
+
obj: GetContentResponse
|
|
1166
|
+
) => any;
|
|
1167
|
+
export declare const UpdateContentResponseFilterSensitiveLog: (
|
|
1168
|
+
obj: UpdateContentResponse
|
|
1169
|
+
) => any;
|
|
1170
|
+
export declare const QuickResponseDataProviderFilterSensitiveLog: (
|
|
1171
|
+
obj: QuickResponseDataProvider
|
|
1172
|
+
) => any;
|
|
1173
|
+
export declare const GroupingConfigurationFilterSensitiveLog: (
|
|
1174
|
+
obj: GroupingConfiguration
|
|
1175
|
+
) => any;
|
|
1176
|
+
export declare const CreateQuickResponseRequestFilterSensitiveLog: (
|
|
1177
|
+
obj: CreateQuickResponseRequest
|
|
1178
|
+
) => any;
|
|
1179
|
+
export declare const QuickResponseContentProviderFilterSensitiveLog: (
|
|
1180
|
+
obj: QuickResponseContentProvider
|
|
1181
|
+
) => any;
|
|
1182
|
+
export declare const QuickResponseContentsFilterSensitiveLog: (
|
|
1183
|
+
obj: QuickResponseContents
|
|
1184
|
+
) => any;
|
|
1185
|
+
export declare const QuickResponseDataFilterSensitiveLog: (
|
|
1186
|
+
obj: QuickResponseData
|
|
1187
|
+
) => any;
|
|
1188
|
+
export declare const CreateQuickResponseResponseFilterSensitiveLog: (
|
|
1189
|
+
obj: CreateQuickResponseResponse
|
|
1190
|
+
) => any;
|
|
1191
|
+
export declare const ImportJobDataFilterSensitiveLog: (
|
|
1192
|
+
obj: ImportJobData
|
|
1193
|
+
) => any;
|
|
1194
|
+
export declare const GetImportJobResponseFilterSensitiveLog: (
|
|
1195
|
+
obj: GetImportJobResponse
|
|
1196
|
+
) => any;
|
|
1197
|
+
export declare const GetQuickResponseResponseFilterSensitiveLog: (
|
|
1198
|
+
obj: GetQuickResponseResponse
|
|
1199
|
+
) => any;
|
|
1200
|
+
export declare const QuickResponseSummaryFilterSensitiveLog: (
|
|
1201
|
+
obj: QuickResponseSummary
|
|
1202
|
+
) => any;
|
|
1203
|
+
export declare const ListQuickResponsesResponseFilterSensitiveLog: (
|
|
1204
|
+
obj: ListQuickResponsesResponse
|
|
1205
|
+
) => any;
|
|
1206
|
+
export declare const UpdateQuickResponseRequestFilterSensitiveLog: (
|
|
1207
|
+
obj: UpdateQuickResponseRequest
|
|
1208
|
+
) => any;
|
|
1209
|
+
export declare const UpdateQuickResponseResponseFilterSensitiveLog: (
|
|
1210
|
+
obj: UpdateQuickResponseResponse
|
|
1211
|
+
) => any;
|
|
1212
|
+
export declare const SearchQuickResponsesRequestFilterSensitiveLog: (
|
|
1213
|
+
obj: SearchQuickResponsesRequest
|
|
1214
|
+
) => any;
|
|
1215
|
+
export declare const QuickResponseSearchResultDataFilterSensitiveLog: (
|
|
1216
|
+
obj: QuickResponseSearchResultData
|
|
1217
|
+
) => any;
|
|
1218
|
+
export declare const SearchQuickResponsesResponseFilterSensitiveLog: (
|
|
1219
|
+
obj: SearchQuickResponsesResponse
|
|
1220
|
+
) => any;
|
|
1221
|
+
export declare const StartContentUploadResponseFilterSensitiveLog: (
|
|
1222
|
+
obj: StartContentUploadResponse
|
|
1223
|
+
) => any;
|
|
1224
|
+
export declare const StartImportJobResponseFilterSensitiveLog: (
|
|
1225
|
+
obj: StartImportJobResponse
|
|
1226
|
+
) => any;
|
|
1227
|
+
export declare const DataDetailsFilterSensitiveLog: (obj: DataDetails) => any;
|
|
1228
|
+
export declare const DataSummaryFilterSensitiveLog: (obj: DataSummary) => any;
|
|
1229
|
+
export declare const GenerativeDataDetailsFilterSensitiveLog: (
|
|
1230
|
+
obj: GenerativeDataDetails
|
|
1231
|
+
) => any;
|
|
1232
|
+
export declare const RecommendationDataFilterSensitiveLog: (
|
|
1233
|
+
obj: RecommendationData
|
|
1234
|
+
) => any;
|
|
1235
|
+
export declare const ResultDataFilterSensitiveLog: (obj: ResultData) => any;
|
|
1236
|
+
export declare const GetRecommendationsResponseFilterSensitiveLog: (
|
|
1237
|
+
obj: GetRecommendationsResponse
|
|
1238
|
+
) => any;
|
|
1239
|
+
export declare const QueryAssistantResponseFilterSensitiveLog: (
|
|
1240
|
+
obj: QueryAssistantResponse
|
|
1241
|
+
) => any;
|