@aws-sdk/client-qconnect 3.699.0 → 3.709.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/README.md +88 -0
- package/dist-cjs/index.js +1188 -127
- package/dist-es/QConnect.js +22 -0
- package/dist-es/commands/CreateAIGuardrailCommand.js +23 -0
- package/dist-es/commands/CreateAIGuardrailVersionCommand.js +23 -0
- package/dist-es/commands/CreateQuickResponseCommand.js +1 -1
- package/dist-es/commands/DeleteAIGuardrailCommand.js +22 -0
- package/dist-es/commands/DeleteAIGuardrailVersionCommand.js +22 -0
- package/dist-es/commands/GetAIGuardrailCommand.js +23 -0
- package/dist-es/commands/GetImportJobCommand.js +1 -1
- package/dist-es/commands/GetKnowledgeBaseCommand.js +1 -1
- package/dist-es/commands/GetMessageTemplateCommand.js +1 -1
- package/dist-es/commands/GetNextMessageCommand.js +23 -0
- package/dist-es/commands/GetQuickResponseCommand.js +1 -1
- package/dist-es/commands/ListAIGuardrailVersionsCommand.js +23 -0
- package/dist-es/commands/ListAIGuardrailsCommand.js +23 -0
- package/dist-es/commands/ListKnowledgeBasesCommand.js +1 -1
- package/dist-es/commands/ListMessagesCommand.js +23 -0
- package/dist-es/commands/ListQuickResponsesCommand.js +1 -1
- package/dist-es/commands/RenderMessageTemplateCommand.js +1 -1
- package/dist-es/commands/SendMessageCommand.js +23 -0
- package/dist-es/commands/UpdateAIGuardrailCommand.js +23 -0
- package/dist-es/commands/UpdateMessageTemplateCommand.js +1 -1
- package/dist-es/commands/UpdateMessageTemplateMetadataCommand.js +1 -1
- package/dist-es/commands/UpdateQuickResponseCommand.js +1 -1
- package/dist-es/commands/index.js +11 -0
- package/dist-es/models/models_0.js +310 -166
- package/dist-es/models/models_1.js +167 -1
- package/dist-es/pagination/ListAIGuardrailVersionsPaginator.js +4 -0
- package/dist-es/pagination/ListAIGuardrailsPaginator.js +4 -0
- package/dist-es/pagination/ListMessagesPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +443 -1
- package/dist-types/QConnect.d.ts +77 -0
- package/dist-types/QConnectClient.d.ts +13 -2
- package/dist-types/commands/CreateAIAgentCommand.d.ts +62 -0
- package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +31 -0
- package/dist-types/commands/CreateAIGuardrailCommand.d.ts +231 -0
- package/dist-types/commands/CreateAIGuardrailVersionCommand.d.ts +169 -0
- package/dist-types/commands/CreateQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/DeactivateMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAIGuardrailCommand.d.ts +88 -0
- package/dist-types/commands/DeleteAIGuardrailVersionCommand.d.ts +89 -0
- package/dist-types/commands/DeleteImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/GetAIAgentCommand.d.ts +31 -0
- package/dist-types/commands/GetAIGuardrailCommand.d.ts +157 -0
- package/dist-types/commands/GetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/GetMessageTemplateCommand.d.ts +4 -3
- package/dist-types/commands/GetNextMessageCommand.d.ts +106 -0
- package/dist-types/commands/GetQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +31 -0
- package/dist-types/commands/ListAIAgentsCommand.d.ts +31 -0
- package/dist-types/commands/ListAIGuardrailVersionsCommand.d.ts +105 -0
- package/dist-types/commands/ListAIGuardrailsCommand.d.ts +101 -0
- package/dist-types/commands/ListImportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/commands/ListMessageTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListMessageTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/ListMessagesCommand.d.ts +95 -0
- package/dist-types/commands/ListQuickResponsesCommand.d.ts +1 -1
- package/dist-types/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +1 -2
- package/dist-types/commands/RenderMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/SendMessageCommand.d.ts +114 -0
- package/dist-types/commands/UpdateAIAgentCommand.d.ts +62 -0
- package/dist-types/commands/UpdateAIGuardrailCommand.d.ts +224 -0
- package/dist-types/commands/UpdateMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/UpdateMessageTemplateMetadataCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +11 -0
- package/dist-types/models/models_0.d.ts +3820 -3619
- package/dist-types/models/models_1.d.ts +1513 -1
- package/dist-types/pagination/ListAIGuardrailVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAIGuardrailsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListMessagesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +99 -0
- package/dist-types/ts3.4/QConnect.d.ts +187 -0
- package/dist-types/ts3.4/QConnectClient.d.ts +66 -0
- package/dist-types/ts3.4/commands/CreateAIGuardrailCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateAIGuardrailVersionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeactivateMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteAIGuardrailCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteAIGuardrailVersionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetAIGuardrailCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetNextMessageCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAIGuardrailVersionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListAIGuardrailsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListImportJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessageTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessageTemplatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessagesCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListQuickResponsesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/RenderMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SendMessageCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateAIGuardrailCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateMessageTemplateMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +11 -0
- package/dist-types/ts3.4/models/models_0.d.ts +482 -441
- package/dist-types/ts3.4/models/models_1.d.ts +437 -5
- package/dist-types/ts3.4/pagination/ListAIGuardrailVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAIGuardrailsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListMessagesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +132 -0
- package/package.json +35 -35
|
@@ -51,6 +51,7 @@ declare const GetAIAgentCommand_base: {
|
|
|
51
51
|
* // configuration: { // AIAgentConfiguration Union: only one key present
|
|
52
52
|
* // manualSearchAIAgentConfiguration: { // ManualSearchAIAgentConfiguration
|
|
53
53
|
* // answerGenerationAIPromptId: "STRING_VALUE",
|
|
54
|
+
* // answerGenerationAIGuardrailId: "STRING_VALUE",
|
|
54
55
|
* // associationConfigurations: [ // AssociationConfigurationList
|
|
55
56
|
* // { // AssociationConfiguration
|
|
56
57
|
* // associationId: "STRING_VALUE",
|
|
@@ -88,6 +89,7 @@ declare const GetAIAgentCommand_base: {
|
|
|
88
89
|
* // intentLabelingGenerationAIPromptId: "STRING_VALUE",
|
|
89
90
|
* // queryReformulationAIPromptId: "STRING_VALUE",
|
|
90
91
|
* // answerGenerationAIPromptId: "STRING_VALUE",
|
|
92
|
+
* // answerGenerationAIGuardrailId: "STRING_VALUE",
|
|
91
93
|
* // associationConfigurations: [
|
|
92
94
|
* // {
|
|
93
95
|
* // associationId: "STRING_VALUE",
|
|
@@ -115,6 +117,35 @@ declare const GetAIAgentCommand_base: {
|
|
|
115
117
|
* // },
|
|
116
118
|
* // ],
|
|
117
119
|
* // },
|
|
120
|
+
* // selfServiceAIAgentConfiguration: { // SelfServiceAIAgentConfiguration
|
|
121
|
+
* // selfServicePreProcessingAIPromptId: "STRING_VALUE",
|
|
122
|
+
* // selfServiceAnswerGenerationAIPromptId: "STRING_VALUE",
|
|
123
|
+
* // selfServiceAIGuardrailId: "STRING_VALUE",
|
|
124
|
+
* // associationConfigurations: [
|
|
125
|
+
* // {
|
|
126
|
+
* // associationId: "STRING_VALUE",
|
|
127
|
+
* // associationType: "STRING_VALUE",
|
|
128
|
+
* // associationConfigurationData: {// Union: only one key present
|
|
129
|
+
* // knowledgeBaseAssociationConfigurationData: {
|
|
130
|
+
* // contentTagFilter: {// Union: only one key present
|
|
131
|
+
* // tagCondition: "<TagCondition>",
|
|
132
|
+
* // andConditions: [
|
|
133
|
+
* // "<TagCondition>",
|
|
134
|
+
* // ],
|
|
135
|
+
* // orConditions: [
|
|
136
|
+
* // {// Union: only one key present
|
|
137
|
+
* // andConditions: "<AndConditions>",
|
|
138
|
+
* // tagCondition: "<TagCondition>",
|
|
139
|
+
* // },
|
|
140
|
+
* // ],
|
|
141
|
+
* // },
|
|
142
|
+
* // maxResults: Number("int"),
|
|
143
|
+
* // overrideKnowledgeBaseSearchType: "STRING_VALUE",
|
|
144
|
+
* // },
|
|
145
|
+
* // },
|
|
146
|
+
* // },
|
|
147
|
+
* // ],
|
|
148
|
+
* // },
|
|
118
149
|
* // },
|
|
119
150
|
* // modifiedTime: new Date("TIMESTAMP"),
|
|
120
151
|
* // description: "STRING_VALUE",
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GetAIGuardrailRequest, GetAIGuardrailResponse } from "../models/models_0";
|
|
4
|
+
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetAIGuardrailCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetAIGuardrailCommandInput extends GetAIGuardrailRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetAIGuardrailCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetAIGuardrailCommandOutput extends GetAIGuardrailResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetAIGuardrailCommand_base: {
|
|
25
|
+
new (input: GetAIGuardrailCommandInput): import("@smithy/smithy-client").CommandImpl<GetAIGuardrailCommandInput, GetAIGuardrailCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetAIGuardrailCommandInput): import("@smithy/smithy-client").CommandImpl<GetAIGuardrailCommandInput, GetAIGuardrailCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Gets the Amazon Q in Connect AI Guardrail.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QConnectClient, GetAIGuardrailCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
35
|
+
* // const { QConnectClient, GetAIGuardrailCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
36
|
+
* const client = new QConnectClient(config);
|
|
37
|
+
* const input = { // GetAIGuardrailRequest
|
|
38
|
+
* assistantId: "STRING_VALUE", // required
|
|
39
|
+
* aiGuardrailId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetAIGuardrailCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetAIGuardrailResponse
|
|
44
|
+
* // aiGuardrail: { // AIGuardrailData
|
|
45
|
+
* // assistantId: "STRING_VALUE", // required
|
|
46
|
+
* // assistantArn: "STRING_VALUE", // required
|
|
47
|
+
* // aiGuardrailArn: "STRING_VALUE", // required
|
|
48
|
+
* // aiGuardrailId: "STRING_VALUE", // required
|
|
49
|
+
* // name: "STRING_VALUE", // required
|
|
50
|
+
* // visibilityStatus: "STRING_VALUE", // required
|
|
51
|
+
* // blockedInputMessaging: "STRING_VALUE", // required
|
|
52
|
+
* // blockedOutputsMessaging: "STRING_VALUE", // required
|
|
53
|
+
* // description: "STRING_VALUE",
|
|
54
|
+
* // topicPolicyConfig: { // AIGuardrailTopicPolicyConfig
|
|
55
|
+
* // topicsConfig: [ // GuardrailTopicsConfig // required
|
|
56
|
+
* // { // GuardrailTopicConfig
|
|
57
|
+
* // name: "STRING_VALUE", // required
|
|
58
|
+
* // definition: "STRING_VALUE", // required
|
|
59
|
+
* // examples: [ // GuardrailTopicExamples
|
|
60
|
+
* // "STRING_VALUE",
|
|
61
|
+
* // ],
|
|
62
|
+
* // type: "STRING_VALUE", // required
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // },
|
|
66
|
+
* // contentPolicyConfig: { // AIGuardrailContentPolicyConfig
|
|
67
|
+
* // filtersConfig: [ // GuardrailContentFiltersConfig // required
|
|
68
|
+
* // { // GuardrailContentFilterConfig
|
|
69
|
+
* // type: "STRING_VALUE", // required
|
|
70
|
+
* // inputStrength: "STRING_VALUE", // required
|
|
71
|
+
* // outputStrength: "STRING_VALUE", // required
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // },
|
|
75
|
+
* // wordPolicyConfig: { // AIGuardrailWordPolicyConfig
|
|
76
|
+
* // wordsConfig: [ // GuardrailWordsConfig
|
|
77
|
+
* // { // GuardrailWordConfig
|
|
78
|
+
* // text: "STRING_VALUE", // required
|
|
79
|
+
* // },
|
|
80
|
+
* // ],
|
|
81
|
+
* // managedWordListsConfig: [ // GuardrailManagedWordListsConfig
|
|
82
|
+
* // { // GuardrailManagedWordsConfig
|
|
83
|
+
* // type: "STRING_VALUE", // required
|
|
84
|
+
* // },
|
|
85
|
+
* // ],
|
|
86
|
+
* // },
|
|
87
|
+
* // sensitiveInformationPolicyConfig: { // AIGuardrailSensitiveInformationPolicyConfig
|
|
88
|
+
* // piiEntitiesConfig: [ // GuardrailPiiEntitiesConfig
|
|
89
|
+
* // { // GuardrailPiiEntityConfig
|
|
90
|
+
* // type: "STRING_VALUE", // required
|
|
91
|
+
* // action: "STRING_VALUE", // required
|
|
92
|
+
* // },
|
|
93
|
+
* // ],
|
|
94
|
+
* // regexesConfig: [ // GuardrailRegexesConfig
|
|
95
|
+
* // { // GuardrailRegexConfig
|
|
96
|
+
* // name: "STRING_VALUE", // required
|
|
97
|
+
* // description: "STRING_VALUE",
|
|
98
|
+
* // pattern: "STRING_VALUE", // required
|
|
99
|
+
* // action: "STRING_VALUE", // required
|
|
100
|
+
* // },
|
|
101
|
+
* // ],
|
|
102
|
+
* // },
|
|
103
|
+
* // contextualGroundingPolicyConfig: { // AIGuardrailContextualGroundingPolicyConfig
|
|
104
|
+
* // filtersConfig: [ // GuardrailContextualGroundingFiltersConfig // required
|
|
105
|
+
* // { // GuardrailContextualGroundingFilterConfig
|
|
106
|
+
* // type: "STRING_VALUE", // required
|
|
107
|
+
* // threshold: Number("double"), // required
|
|
108
|
+
* // },
|
|
109
|
+
* // ],
|
|
110
|
+
* // },
|
|
111
|
+
* // tags: { // Tags
|
|
112
|
+
* // "<keys>": "STRING_VALUE",
|
|
113
|
+
* // },
|
|
114
|
+
* // status: "STRING_VALUE",
|
|
115
|
+
* // modifiedTime: new Date("TIMESTAMP"),
|
|
116
|
+
* // },
|
|
117
|
+
* // versionNumber: Number("long"),
|
|
118
|
+
* // };
|
|
119
|
+
*
|
|
120
|
+
* ```
|
|
121
|
+
*
|
|
122
|
+
* @param GetAIGuardrailCommandInput - {@link GetAIGuardrailCommandInput}
|
|
123
|
+
* @returns {@link GetAIGuardrailCommandOutput}
|
|
124
|
+
* @see {@link GetAIGuardrailCommandInput} for command's `input` shape.
|
|
125
|
+
* @see {@link GetAIGuardrailCommandOutput} for command's `response` shape.
|
|
126
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
127
|
+
*
|
|
128
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
129
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
130
|
+
*
|
|
131
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
132
|
+
* <p>The specified resource does not exist.</p>
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
135
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
136
|
+
*
|
|
137
|
+
* @throws {@link ValidationException} (client fault)
|
|
138
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
139
|
+
*
|
|
140
|
+
* @throws {@link QConnectServiceException}
|
|
141
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
142
|
+
*
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
export declare class GetAIGuardrailCommand extends GetAIGuardrailCommand_base {
|
|
146
|
+
/** @internal type navigation helper, not in runtime. */
|
|
147
|
+
protected static __types: {
|
|
148
|
+
api: {
|
|
149
|
+
input: GetAIGuardrailRequest;
|
|
150
|
+
output: GetAIGuardrailResponse;
|
|
151
|
+
};
|
|
152
|
+
sdk: {
|
|
153
|
+
input: GetAIGuardrailCommandInput;
|
|
154
|
+
output: GetAIGuardrailCommandOutput;
|
|
155
|
+
};
|
|
156
|
+
};
|
|
157
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { GetImportJobRequest, GetImportJobResponse } from "../models/
|
|
3
|
+
import { GetImportJobRequest, GetImportJobResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { GetKnowledgeBaseRequest, GetKnowledgeBaseResponse } from "../models/
|
|
3
|
+
import { GetKnowledgeBaseRequest, GetKnowledgeBaseResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { GetMessageTemplateRequest, GetMessageTemplateResponse } from "../models/
|
|
3
|
+
import { GetMessageTemplateRequest, GetMessageTemplateResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -30,8 +30,9 @@ declare const GetMessageTemplateCommand_base: {
|
|
|
30
30
|
* <p>Retrieves the Amazon Q in Connect message template. The message template identifier can
|
|
31
31
|
* contain an optional qualifier, for example,
|
|
32
32
|
* <code><message-template-id>:<qualifier></code>, which is either an actual
|
|
33
|
-
* version number or an Amazon Q Connect managed qualifier <code>$ACTIVE_VERSION</code> |
|
|
34
|
-
*
|
|
33
|
+
* version number or an Amazon Q Connect managed qualifier <code>$ACTIVE_VERSION</code> |
|
|
34
|
+
* <code>$LATEST</code>. If it is not supplied, then <code>$LATEST</code> is assumed
|
|
35
|
+
* implicitly.</p>
|
|
35
36
|
* @example
|
|
36
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
38
|
* ```javascript
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GetNextMessageRequest, GetNextMessageResponse } from "../models/models_0";
|
|
4
|
+
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetNextMessageCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetNextMessageCommandInput extends GetNextMessageRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetNextMessageCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetNextMessageCommandOutput extends GetNextMessageResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetNextMessageCommand_base: {
|
|
25
|
+
new (input: GetNextMessageCommandInput): import("@smithy/smithy-client").CommandImpl<GetNextMessageCommandInput, GetNextMessageCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetNextMessageCommandInput): import("@smithy/smithy-client").CommandImpl<GetNextMessageCommandInput, GetNextMessageCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; /** @internal type navigation helper, not in runtime. */
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves next message on an Amazon Q in Connect session.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QConnectClient, GetNextMessageCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
35
|
+
* // const { QConnectClient, GetNextMessageCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
36
|
+
* const client = new QConnectClient(config);
|
|
37
|
+
* const input = { // GetNextMessageRequest
|
|
38
|
+
* assistantId: "STRING_VALUE", // required
|
|
39
|
+
* sessionId: "STRING_VALUE", // required
|
|
40
|
+
* nextMessageToken: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetNextMessageCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetNextMessageResponse
|
|
45
|
+
* // type: "STRING_VALUE", // required
|
|
46
|
+
* // response: { // MessageOutput
|
|
47
|
+
* // value: { // MessageData Union: only one key present
|
|
48
|
+
* // text: { // TextMessage
|
|
49
|
+
* // value: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // },
|
|
52
|
+
* // messageId: "STRING_VALUE", // required
|
|
53
|
+
* // participant: "STRING_VALUE", // required
|
|
54
|
+
* // timestamp: new Date("TIMESTAMP"), // required
|
|
55
|
+
* // },
|
|
56
|
+
* // requestMessageId: "STRING_VALUE", // required
|
|
57
|
+
* // conversationState: { // ConversationState
|
|
58
|
+
* // status: "STRING_VALUE", // required
|
|
59
|
+
* // reason: "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // nextMessageToken: "STRING_VALUE",
|
|
62
|
+
* // conversationSessionData: [ // RuntimeSessionDataList
|
|
63
|
+
* // { // RuntimeSessionData
|
|
64
|
+
* // key: "STRING_VALUE", // required
|
|
65
|
+
* // value: { // RuntimeSessionDataValue Union: only one key present
|
|
66
|
+
* // stringValue: "STRING_VALUE",
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // };
|
|
71
|
+
*
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
74
|
+
* @param GetNextMessageCommandInput - {@link GetNextMessageCommandInput}
|
|
75
|
+
* @returns {@link GetNextMessageCommandOutput}
|
|
76
|
+
* @see {@link GetNextMessageCommandInput} for command's `input` shape.
|
|
77
|
+
* @see {@link GetNextMessageCommandOutput} for command's `response` shape.
|
|
78
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
81
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <p>The specified resource does not exist.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ValidationException} (client fault)
|
|
87
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link QConnectServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
91
|
+
*
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
export declare class GetNextMessageCommand extends GetNextMessageCommand_base {
|
|
95
|
+
/** @internal type navigation helper, not in runtime. */
|
|
96
|
+
protected static __types: {
|
|
97
|
+
api: {
|
|
98
|
+
input: GetNextMessageRequest;
|
|
99
|
+
output: GetNextMessageResponse;
|
|
100
|
+
};
|
|
101
|
+
sdk: {
|
|
102
|
+
input: GetNextMessageCommandInput;
|
|
103
|
+
output: GetNextMessageCommandOutput;
|
|
104
|
+
};
|
|
105
|
+
};
|
|
106
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { GetQuickResponseRequest, GetQuickResponseResponse } from "../models/
|
|
3
|
+
import { GetQuickResponseRequest, GetQuickResponseResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -58,6 +58,7 @@ declare const ListAIAgentVersionsCommand_base: {
|
|
|
58
58
|
* // configuration: { // AIAgentConfiguration Union: only one key present
|
|
59
59
|
* // manualSearchAIAgentConfiguration: { // ManualSearchAIAgentConfiguration
|
|
60
60
|
* // answerGenerationAIPromptId: "STRING_VALUE",
|
|
61
|
+
* // answerGenerationAIGuardrailId: "STRING_VALUE",
|
|
61
62
|
* // associationConfigurations: [ // AssociationConfigurationList
|
|
62
63
|
* // { // AssociationConfiguration
|
|
63
64
|
* // associationId: "STRING_VALUE",
|
|
@@ -95,6 +96,7 @@ declare const ListAIAgentVersionsCommand_base: {
|
|
|
95
96
|
* // intentLabelingGenerationAIPromptId: "STRING_VALUE",
|
|
96
97
|
* // queryReformulationAIPromptId: "STRING_VALUE",
|
|
97
98
|
* // answerGenerationAIPromptId: "STRING_VALUE",
|
|
99
|
+
* // answerGenerationAIGuardrailId: "STRING_VALUE",
|
|
98
100
|
* // associationConfigurations: [
|
|
99
101
|
* // {
|
|
100
102
|
* // associationId: "STRING_VALUE",
|
|
@@ -122,6 +124,35 @@ declare const ListAIAgentVersionsCommand_base: {
|
|
|
122
124
|
* // },
|
|
123
125
|
* // ],
|
|
124
126
|
* // },
|
|
127
|
+
* // selfServiceAIAgentConfiguration: { // SelfServiceAIAgentConfiguration
|
|
128
|
+
* // selfServicePreProcessingAIPromptId: "STRING_VALUE",
|
|
129
|
+
* // selfServiceAnswerGenerationAIPromptId: "STRING_VALUE",
|
|
130
|
+
* // selfServiceAIGuardrailId: "STRING_VALUE",
|
|
131
|
+
* // associationConfigurations: [
|
|
132
|
+
* // {
|
|
133
|
+
* // associationId: "STRING_VALUE",
|
|
134
|
+
* // associationType: "STRING_VALUE",
|
|
135
|
+
* // associationConfigurationData: {// Union: only one key present
|
|
136
|
+
* // knowledgeBaseAssociationConfigurationData: {
|
|
137
|
+
* // contentTagFilter: {// Union: only one key present
|
|
138
|
+
* // tagCondition: "<TagCondition>",
|
|
139
|
+
* // andConditions: [
|
|
140
|
+
* // "<TagCondition>",
|
|
141
|
+
* // ],
|
|
142
|
+
* // orConditions: [
|
|
143
|
+
* // {// Union: only one key present
|
|
144
|
+
* // andConditions: "<AndConditions>",
|
|
145
|
+
* // tagCondition: "<TagCondition>",
|
|
146
|
+
* // },
|
|
147
|
+
* // ],
|
|
148
|
+
* // },
|
|
149
|
+
* // maxResults: Number("int"),
|
|
150
|
+
* // overrideKnowledgeBaseSearchType: "STRING_VALUE",
|
|
151
|
+
* // },
|
|
152
|
+
* // },
|
|
153
|
+
* // },
|
|
154
|
+
* // ],
|
|
155
|
+
* // },
|
|
125
156
|
* // },
|
|
126
157
|
* // origin: "STRING_VALUE",
|
|
127
158
|
* // description: "STRING_VALUE",
|
|
@@ -56,6 +56,7 @@ declare const ListAIAgentsCommand_base: {
|
|
|
56
56
|
* // configuration: { // AIAgentConfiguration Union: only one key present
|
|
57
57
|
* // manualSearchAIAgentConfiguration: { // ManualSearchAIAgentConfiguration
|
|
58
58
|
* // answerGenerationAIPromptId: "STRING_VALUE",
|
|
59
|
+
* // answerGenerationAIGuardrailId: "STRING_VALUE",
|
|
59
60
|
* // associationConfigurations: [ // AssociationConfigurationList
|
|
60
61
|
* // { // AssociationConfiguration
|
|
61
62
|
* // associationId: "STRING_VALUE",
|
|
@@ -93,6 +94,7 @@ declare const ListAIAgentsCommand_base: {
|
|
|
93
94
|
* // intentLabelingGenerationAIPromptId: "STRING_VALUE",
|
|
94
95
|
* // queryReformulationAIPromptId: "STRING_VALUE",
|
|
95
96
|
* // answerGenerationAIPromptId: "STRING_VALUE",
|
|
97
|
+
* // answerGenerationAIGuardrailId: "STRING_VALUE",
|
|
96
98
|
* // associationConfigurations: [
|
|
97
99
|
* // {
|
|
98
100
|
* // associationId: "STRING_VALUE",
|
|
@@ -120,6 +122,35 @@ declare const ListAIAgentsCommand_base: {
|
|
|
120
122
|
* // },
|
|
121
123
|
* // ],
|
|
122
124
|
* // },
|
|
125
|
+
* // selfServiceAIAgentConfiguration: { // SelfServiceAIAgentConfiguration
|
|
126
|
+
* // selfServicePreProcessingAIPromptId: "STRING_VALUE",
|
|
127
|
+
* // selfServiceAnswerGenerationAIPromptId: "STRING_VALUE",
|
|
128
|
+
* // selfServiceAIGuardrailId: "STRING_VALUE",
|
|
129
|
+
* // associationConfigurations: [
|
|
130
|
+
* // {
|
|
131
|
+
* // associationId: "STRING_VALUE",
|
|
132
|
+
* // associationType: "STRING_VALUE",
|
|
133
|
+
* // associationConfigurationData: {// Union: only one key present
|
|
134
|
+
* // knowledgeBaseAssociationConfigurationData: {
|
|
135
|
+
* // contentTagFilter: {// Union: only one key present
|
|
136
|
+
* // tagCondition: "<TagCondition>",
|
|
137
|
+
* // andConditions: [
|
|
138
|
+
* // "<TagCondition>",
|
|
139
|
+
* // ],
|
|
140
|
+
* // orConditions: [
|
|
141
|
+
* // {// Union: only one key present
|
|
142
|
+
* // andConditions: "<AndConditions>",
|
|
143
|
+
* // tagCondition: "<TagCondition>",
|
|
144
|
+
* // },
|
|
145
|
+
* // ],
|
|
146
|
+
* // },
|
|
147
|
+
* // maxResults: Number("int"),
|
|
148
|
+
* // overrideKnowledgeBaseSearchType: "STRING_VALUE",
|
|
149
|
+
* // },
|
|
150
|
+
* // },
|
|
151
|
+
* // },
|
|
152
|
+
* // ],
|
|
153
|
+
* // },
|
|
123
154
|
* // },
|
|
124
155
|
* // origin: "STRING_VALUE",
|
|
125
156
|
* // description: "STRING_VALUE",
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListAIGuardrailVersionsRequest, ListAIGuardrailVersionsResponse } from "../models/models_0";
|
|
4
|
+
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListAIGuardrailVersionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListAIGuardrailVersionsCommandInput extends ListAIGuardrailVersionsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListAIGuardrailVersionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListAIGuardrailVersionsCommandOutput extends ListAIGuardrailVersionsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListAIGuardrailVersionsCommand_base: {
|
|
25
|
+
new (input: ListAIGuardrailVersionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAIGuardrailVersionsCommandInput, ListAIGuardrailVersionsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListAIGuardrailVersionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAIGuardrailVersionsCommandInput, ListAIGuardrailVersionsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists AI Guardrail versions.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QConnectClient, ListAIGuardrailVersionsCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
35
|
+
* // const { QConnectClient, ListAIGuardrailVersionsCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
36
|
+
* const client = new QConnectClient(config);
|
|
37
|
+
* const input = { // ListAIGuardrailVersionsRequest
|
|
38
|
+
* assistantId: "STRING_VALUE", // required
|
|
39
|
+
* aiGuardrailId: "STRING_VALUE", // required
|
|
40
|
+
* nextToken: "STRING_VALUE",
|
|
41
|
+
* maxResults: Number("int"),
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListAIGuardrailVersionsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListAIGuardrailVersionsResponse
|
|
46
|
+
* // aiGuardrailVersionSummaries: [ // AIGuardrailVersionSummariesList // required
|
|
47
|
+
* // { // AIGuardrailVersionSummary
|
|
48
|
+
* // aiGuardrailSummary: { // AIGuardrailSummary
|
|
49
|
+
* // name: "STRING_VALUE", // required
|
|
50
|
+
* // assistantId: "STRING_VALUE", // required
|
|
51
|
+
* // assistantArn: "STRING_VALUE", // required
|
|
52
|
+
* // aiGuardrailId: "STRING_VALUE", // required
|
|
53
|
+
* // aiGuardrailArn: "STRING_VALUE", // required
|
|
54
|
+
* // modifiedTime: new Date("TIMESTAMP"),
|
|
55
|
+
* // visibilityStatus: "STRING_VALUE", // required
|
|
56
|
+
* // description: "STRING_VALUE",
|
|
57
|
+
* // status: "STRING_VALUE",
|
|
58
|
+
* // tags: { // Tags
|
|
59
|
+
* // "<keys>": "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // },
|
|
62
|
+
* // versionNumber: Number("long"),
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // nextToken: "STRING_VALUE",
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @param ListAIGuardrailVersionsCommandInput - {@link ListAIGuardrailVersionsCommandInput}
|
|
71
|
+
* @returns {@link ListAIGuardrailVersionsCommandOutput}
|
|
72
|
+
* @see {@link ListAIGuardrailVersionsCommandInput} for command's `input` shape.
|
|
73
|
+
* @see {@link ListAIGuardrailVersionsCommandOutput} for command's `response` shape.
|
|
74
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
77
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
80
|
+
* <p>The specified resource does not exist.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
83
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ValidationException} (client fault)
|
|
86
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link QConnectServiceException}
|
|
89
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
90
|
+
*
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
export declare class ListAIGuardrailVersionsCommand extends ListAIGuardrailVersionsCommand_base {
|
|
94
|
+
/** @internal type navigation helper, not in runtime. */
|
|
95
|
+
protected static __types: {
|
|
96
|
+
api: {
|
|
97
|
+
input: ListAIGuardrailVersionsRequest;
|
|
98
|
+
output: ListAIGuardrailVersionsResponse;
|
|
99
|
+
};
|
|
100
|
+
sdk: {
|
|
101
|
+
input: ListAIGuardrailVersionsCommandInput;
|
|
102
|
+
output: ListAIGuardrailVersionsCommandOutput;
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
}
|