@aws-sdk/client-qconnect 3.665.0 → 3.666.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.
Files changed (107) hide show
  1. package/README.md +166 -0
  2. package/dist-cjs/index.js +1501 -102
  3. package/dist-es/QConnect.js +38 -0
  4. package/dist-es/commands/CreateAIAgentCommand.js +22 -0
  5. package/dist-es/commands/CreateAIAgentVersionCommand.js +22 -0
  6. package/dist-es/commands/CreateAIPromptCommand.js +23 -0
  7. package/dist-es/commands/CreateAIPromptVersionCommand.js +23 -0
  8. package/dist-es/commands/CreateKnowledgeBaseCommand.js +2 -1
  9. package/dist-es/commands/DeleteAIAgentCommand.js +22 -0
  10. package/dist-es/commands/DeleteAIAgentVersionCommand.js +22 -0
  11. package/dist-es/commands/DeleteAIPromptCommand.js +22 -0
  12. package/dist-es/commands/DeleteAIPromptVersionCommand.js +22 -0
  13. package/dist-es/commands/GetAIAgentCommand.js +22 -0
  14. package/dist-es/commands/GetAIPromptCommand.js +23 -0
  15. package/dist-es/commands/GetKnowledgeBaseCommand.js +2 -1
  16. package/dist-es/commands/ListAIAgentVersionsCommand.js +22 -0
  17. package/dist-es/commands/ListAIAgentsCommand.js +22 -0
  18. package/dist-es/commands/ListAIPromptVersionsCommand.js +22 -0
  19. package/dist-es/commands/ListAIPromptsCommand.js +22 -0
  20. package/dist-es/commands/ListKnowledgeBasesCommand.js +2 -1
  21. package/dist-es/commands/RemoveAssistantAIAgentCommand.js +22 -0
  22. package/dist-es/commands/UpdateAIAgentCommand.js +22 -0
  23. package/dist-es/commands/UpdateAIPromptCommand.js +23 -0
  24. package/dist-es/commands/UpdateAssistantAIAgentCommand.js +22 -0
  25. package/dist-es/commands/UpdateKnowledgeBaseTemplateUriCommand.js +2 -1
  26. package/dist-es/commands/UpdateSessionDataCommand.js +23 -0
  27. package/dist-es/commands/index.js +19 -0
  28. package/dist-es/models/models_0.js +310 -46
  29. package/dist-es/pagination/ListAIAgentVersionsPaginator.js +4 -0
  30. package/dist-es/pagination/ListAIAgentsPaginator.js +4 -0
  31. package/dist-es/pagination/ListAIPromptVersionsPaginator.js +4 -0
  32. package/dist-es/pagination/ListAIPromptsPaginator.js +4 -0
  33. package/dist-es/pagination/index.js +4 -0
  34. package/dist-es/protocols/Aws_restJson1.js +692 -8
  35. package/dist-types/QConnect.d.ts +148 -1
  36. package/dist-types/QConnectClient.d.ts +36 -3
  37. package/dist-types/commands/CreateAIAgentCommand.d.ts +252 -0
  38. package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +180 -0
  39. package/dist-types/commands/CreateAIPromptCommand.d.ts +132 -0
  40. package/dist-types/commands/CreateAIPromptVersionCommand.d.ts +120 -0
  41. package/dist-types/commands/CreateAssistantCommand.d.ts +5 -0
  42. package/dist-types/commands/CreateContentAssociationCommand.d.ts +5 -6
  43. package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +108 -0
  44. package/dist-types/commands/CreateSessionCommand.d.ts +10 -0
  45. package/dist-types/commands/DeleteAIAgentCommand.d.ts +82 -0
  46. package/dist-types/commands/DeleteAIAgentVersionCommand.d.ts +89 -0
  47. package/dist-types/commands/DeleteAIPromptCommand.d.ts +82 -0
  48. package/dist-types/commands/DeleteAIPromptVersionCommand.d.ts +89 -0
  49. package/dist-types/commands/GetAIAgentCommand.d.ts +168 -0
  50. package/dist-types/commands/GetAIPromptCommand.d.ts +108 -0
  51. package/dist-types/commands/GetAssistantCommand.d.ts +5 -0
  52. package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +56 -0
  53. package/dist-types/commands/GetRecommendationsCommand.d.ts +20 -0
  54. package/dist-types/commands/GetSessionCommand.d.ts +5 -0
  55. package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +176 -0
  56. package/dist-types/commands/ListAIAgentsCommand.d.ts +172 -0
  57. package/dist-types/commands/ListAIPromptVersionsCommand.d.ts +111 -0
  58. package/dist-types/commands/ListAIPromptsCommand.d.ts +107 -0
  59. package/dist-types/commands/ListAssistantsCommand.d.ts +5 -0
  60. package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +52 -0
  61. package/dist-types/commands/QueryAssistantCommand.d.ts +30 -1
  62. package/dist-types/commands/RemoveAssistantAIAgentCommand.d.ts +83 -0
  63. package/dist-types/commands/UpdateAIAgentCommand.d.ts +244 -0
  64. package/dist-types/commands/UpdateAIPromptCommand.d.ts +121 -0
  65. package/dist-types/commands/UpdateAssistantAIAgentCommand.d.ts +112 -0
  66. package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +56 -0
  67. package/dist-types/commands/UpdateSessionCommand.d.ts +10 -0
  68. package/dist-types/commands/UpdateSessionDataCommand.d.ts +100 -0
  69. package/dist-types/commands/index.d.ts +19 -0
  70. package/dist-types/index.d.ts +15 -1
  71. package/dist-types/models/models_0.d.ts +2454 -275
  72. package/dist-types/pagination/ListAIAgentVersionsPaginator.d.ts +7 -0
  73. package/dist-types/pagination/ListAIAgentsPaginator.d.ts +7 -0
  74. package/dist-types/pagination/ListAIPromptVersionsPaginator.d.ts +7 -0
  75. package/dist-types/pagination/ListAIPromptsPaginator.d.ts +7 -0
  76. package/dist-types/pagination/index.d.ts +4 -0
  77. package/dist-types/protocols/Aws_restJson1.d.ts +171 -0
  78. package/dist-types/ts3.4/QConnect.d.ts +323 -0
  79. package/dist-types/ts3.4/QConnectClient.d.ts +116 -2
  80. package/dist-types/ts3.4/commands/CreateAIAgentCommand.d.ts +50 -0
  81. package/dist-types/ts3.4/commands/CreateAIAgentVersionCommand.d.ts +51 -0
  82. package/dist-types/ts3.4/commands/CreateAIPromptCommand.d.ts +50 -0
  83. package/dist-types/ts3.4/commands/CreateAIPromptVersionCommand.d.ts +51 -0
  84. package/dist-types/ts3.4/commands/DeleteAIAgentCommand.d.ts +50 -0
  85. package/dist-types/ts3.4/commands/DeleteAIAgentVersionCommand.d.ts +51 -0
  86. package/dist-types/ts3.4/commands/DeleteAIPromptCommand.d.ts +50 -0
  87. package/dist-types/ts3.4/commands/DeleteAIPromptVersionCommand.d.ts +51 -0
  88. package/dist-types/ts3.4/commands/GetAIAgentCommand.d.ts +47 -0
  89. package/dist-types/ts3.4/commands/GetAIPromptCommand.d.ts +47 -0
  90. package/dist-types/ts3.4/commands/ListAIAgentVersionsCommand.d.ts +51 -0
  91. package/dist-types/ts3.4/commands/ListAIAgentsCommand.d.ts +47 -0
  92. package/dist-types/ts3.4/commands/ListAIPromptVersionsCommand.d.ts +51 -0
  93. package/dist-types/ts3.4/commands/ListAIPromptsCommand.d.ts +50 -0
  94. package/dist-types/ts3.4/commands/RemoveAssistantAIAgentCommand.d.ts +51 -0
  95. package/dist-types/ts3.4/commands/UpdateAIAgentCommand.d.ts +50 -0
  96. package/dist-types/ts3.4/commands/UpdateAIPromptCommand.d.ts +50 -0
  97. package/dist-types/ts3.4/commands/UpdateAssistantAIAgentCommand.d.ts +51 -0
  98. package/dist-types/ts3.4/commands/UpdateSessionDataCommand.d.ts +51 -0
  99. package/dist-types/ts3.4/commands/index.d.ts +19 -0
  100. package/dist-types/ts3.4/models/models_0.d.ts +794 -103
  101. package/dist-types/ts3.4/pagination/ListAIAgentVersionsPaginator.d.ts +11 -0
  102. package/dist-types/ts3.4/pagination/ListAIAgentsPaginator.d.ts +11 -0
  103. package/dist-types/ts3.4/pagination/ListAIPromptVersionsPaginator.d.ts +11 -0
  104. package/dist-types/ts3.4/pagination/ListAIPromptsPaginator.d.ts +11 -0
  105. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  106. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +228 -0
  107. package/package.json +12 -12
@@ -0,0 +1,107 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ListAIPromptsRequest, ListAIPromptsResponse } 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 ListAIPromptsCommand}.
14
+ */
15
+ export interface ListAIPromptsCommandInput extends ListAIPromptsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListAIPromptsCommand}.
21
+ */
22
+ export interface ListAIPromptsCommandOutput extends ListAIPromptsResponse, __MetadataBearer {
23
+ }
24
+ declare const ListAIPromptsCommand_base: {
25
+ new (input: ListAIPromptsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAIPromptsCommandInput, ListAIPromptsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ListAIPromptsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAIPromptsCommandInput, ListAIPromptsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Lists the AI Prompts available on the Amazon Q in Connect assistant.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QConnectClient, ListAIPromptsCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
35
+ * // const { QConnectClient, ListAIPromptsCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
36
+ * const client = new QConnectClient(config);
37
+ * const input = { // ListAIPromptsRequest
38
+ * assistantId: "STRING_VALUE", // required
39
+ * nextToken: "STRING_VALUE",
40
+ * maxResults: Number("int"),
41
+ * origin: "STRING_VALUE",
42
+ * };
43
+ * const command = new ListAIPromptsCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // ListAIPromptsResponse
46
+ * // aiPromptSummaries: [ // AIPromptSummaryList // required
47
+ * // { // AIPromptSummary
48
+ * // name: "STRING_VALUE", // required
49
+ * // assistantId: "STRING_VALUE", // required
50
+ * // assistantArn: "STRING_VALUE", // required
51
+ * // aiPromptId: "STRING_VALUE", // required
52
+ * // type: "STRING_VALUE", // required
53
+ * // aiPromptArn: "STRING_VALUE", // required
54
+ * // modifiedTime: new Date("TIMESTAMP"),
55
+ * // templateType: "STRING_VALUE", // required
56
+ * // modelId: "STRING_VALUE", // required
57
+ * // apiFormat: "STRING_VALUE", // required
58
+ * // visibilityStatus: "STRING_VALUE", // required
59
+ * // origin: "STRING_VALUE",
60
+ * // description: "STRING_VALUE",
61
+ * // status: "STRING_VALUE",
62
+ * // tags: { // Tags
63
+ * // "<keys>": "STRING_VALUE",
64
+ * // },
65
+ * // },
66
+ * // ],
67
+ * // nextToken: "STRING_VALUE",
68
+ * // };
69
+ *
70
+ * ```
71
+ *
72
+ * @param ListAIPromptsCommandInput - {@link ListAIPromptsCommandInput}
73
+ * @returns {@link ListAIPromptsCommandOutput}
74
+ * @see {@link ListAIPromptsCommandInput} for command's `input` shape.
75
+ * @see {@link ListAIPromptsCommandOutput} for command's `response` shape.
76
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
77
+ *
78
+ * @throws {@link AccessDeniedException} (client fault)
79
+ * <p>You do not have sufficient access to perform this action.</p>
80
+ *
81
+ * @throws {@link ResourceNotFoundException} (client fault)
82
+ * <p>The specified resource does not exist.</p>
83
+ *
84
+ * @throws {@link ThrottlingException} (client fault)
85
+ * <p>The throttling limit has been exceeded.</p>
86
+ *
87
+ * @throws {@link ValidationException} (client fault)
88
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
89
+ *
90
+ * @throws {@link QConnectServiceException}
91
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
92
+ *
93
+ * @public
94
+ */
95
+ export declare class ListAIPromptsCommand extends ListAIPromptsCommand_base {
96
+ /** @internal type navigation helper, not in runtime. */
97
+ protected static __types: {
98
+ api: {
99
+ input: ListAIPromptsRequest;
100
+ output: ListAIPromptsResponse;
101
+ };
102
+ sdk: {
103
+ input: ListAIPromptsCommandInput;
104
+ output: ListAIPromptsCommandOutput;
105
+ };
106
+ };
107
+ }
@@ -61,6 +61,11 @@ declare const ListAssistantsCommand_base: {
61
61
  * // capabilityConfiguration: { // AssistantCapabilityConfiguration
62
62
  * // type: "STRING_VALUE",
63
63
  * // },
64
+ * // aiAgentConfiguration: { // AIAgentConfigurationMap
65
+ * // "<keys>": { // AIAgentConfigurationData
66
+ * // aiAgentId: "STRING_VALUE", // required
67
+ * // },
68
+ * // },
64
69
  * // },
65
70
  * // ],
66
71
  * // nextToken: "STRING_VALUE",
@@ -55,6 +55,58 @@ declare const ListKnowledgeBasesCommand_base: {
55
55
  * // "STRING_VALUE",
56
56
  * // ],
57
57
  * // },
58
+ * // managedSourceConfiguration: { // ManagedSourceConfiguration Union: only one key present
59
+ * // webCrawlerConfiguration: { // WebCrawlerConfiguration
60
+ * // urlConfiguration: { // UrlConfiguration
61
+ * // seedUrls: [ // SeedUrls
62
+ * // { // SeedUrl
63
+ * // url: "STRING_VALUE",
64
+ * // },
65
+ * // ],
66
+ * // },
67
+ * // crawlerLimits: { // WebCrawlerLimits
68
+ * // rateLimit: Number("int"),
69
+ * // },
70
+ * // inclusionFilters: [ // UrlFilterList
71
+ * // "STRING_VALUE",
72
+ * // ],
73
+ * // exclusionFilters: [
74
+ * // "STRING_VALUE",
75
+ * // ],
76
+ * // scope: "STRING_VALUE",
77
+ * // },
78
+ * // },
79
+ * // },
80
+ * // vectorIngestionConfiguration: { // VectorIngestionConfiguration
81
+ * // chunkingConfiguration: { // ChunkingConfiguration
82
+ * // chunkingStrategy: "STRING_VALUE", // required
83
+ * // fixedSizeChunkingConfiguration: { // FixedSizeChunkingConfiguration
84
+ * // maxTokens: Number("int"), // required
85
+ * // overlapPercentage: Number("int"), // required
86
+ * // },
87
+ * // hierarchicalChunkingConfiguration: { // HierarchicalChunkingConfiguration
88
+ * // levelConfigurations: [ // HierarchicalChunkingLevelConfigurations // required
89
+ * // { // HierarchicalChunkingLevelConfiguration
90
+ * // maxTokens: Number("int"), // required
91
+ * // },
92
+ * // ],
93
+ * // overlapTokens: Number("int"), // required
94
+ * // },
95
+ * // semanticChunkingConfiguration: { // SemanticChunkingConfiguration
96
+ * // maxTokens: Number("int"), // required
97
+ * // bufferSize: Number("int"), // required
98
+ * // breakpointPercentileThreshold: Number("int"), // required
99
+ * // },
100
+ * // },
101
+ * // parsingConfiguration: { // ParsingConfiguration
102
+ * // parsingStrategy: "STRING_VALUE", // required
103
+ * // bedrockFoundationModelConfiguration: { // BedrockFoundationModelConfigurationForParsing
104
+ * // modelArn: "STRING_VALUE", // required
105
+ * // parsingPrompt: { // ParsingPrompt
106
+ * // parsingPromptText: "STRING_VALUE", // required
107
+ * // },
108
+ * // },
109
+ * // },
58
110
  * // },
59
111
  * // renderingConfiguration: { // RenderingConfiguration
60
112
  * // templateUri: "STRING_VALUE",
@@ -45,7 +45,7 @@ declare const QueryAssistantCommand_base: {
45
45
  * const client = new QConnectClient(config);
46
46
  * const input = { // QueryAssistantRequest
47
47
  * assistantId: "STRING_VALUE", // required
48
- * queryText: "STRING_VALUE", // required
48
+ * queryText: "STRING_VALUE",
49
49
  * nextToken: "STRING_VALUE",
50
50
  * maxResults: Number("int"),
51
51
  * sessionId: "STRING_VALUE",
@@ -58,6 +58,15 @@ declare const QueryAssistantCommand_base: {
58
58
  * },
59
59
  * },
60
60
  * ],
61
+ * queryInputData: { // QueryInputData Union: only one key present
62
+ * queryTextInputData: { // QueryTextInputData
63
+ * text: "STRING_VALUE", // required
64
+ * },
65
+ * intentInputData: { // IntentInputData
66
+ * intentId: "STRING_VALUE", // required
67
+ * },
68
+ * },
69
+ * overrideKnowledgeBaseSearchType: "STRING_VALUE",
61
70
  * };
62
71
  * const command = new QueryAssistantCommand(input);
63
72
  * const response = await client.send(command);
@@ -71,6 +80,8 @@ declare const QueryAssistantCommand_base: {
71
80
  * // knowledgeBaseId: "STRING_VALUE",
72
81
  * // contentArn: "STRING_VALUE",
73
82
  * // contentId: "STRING_VALUE",
83
+ * // sourceURL: "STRING_VALUE",
84
+ * // referenceType: "STRING_VALUE",
74
85
  * // },
75
86
  * // title: { // DocumentText
76
87
  * // text: "STRING_VALUE",
@@ -99,6 +110,8 @@ declare const QueryAssistantCommand_base: {
99
110
  * // knowledgeBaseId: "STRING_VALUE",
100
111
  * // contentArn: "STRING_VALUE",
101
112
  * // contentId: "STRING_VALUE",
113
+ * // sourceURL: "STRING_VALUE",
114
+ * // referenceType: "STRING_VALUE",
102
115
  * // },
103
116
  * // generativeReference: { // GenerativeReference
104
117
  * // modelId: "STRING_VALUE",
@@ -164,6 +177,10 @@ declare const QueryAssistantCommand_base: {
164
177
  * // relevanceLevel: "STRING_VALUE",
165
178
  * // },
166
179
  * // },
180
+ * // intentDetectedData: { // IntentDetectedDataDetails
181
+ * // intent: "STRING_VALUE", // required
182
+ * // intentId: "STRING_VALUE", // required
183
+ * // },
167
184
  * // sourceContentData: { // SourceContentDataDetails
168
185
  * // id: "STRING_VALUE", // required
169
186
  * // type: "STRING_VALUE", // required
@@ -175,6 +192,10 @@ declare const QueryAssistantCommand_base: {
175
192
  * // relevanceScore: Number("double"),
176
193
  * // relevanceLevel: "STRING_VALUE",
177
194
  * // },
195
+ * // citationSpan: { // CitationSpan
196
+ * // beginOffsetInclusive: Number("int"),
197
+ * // endOffsetExclusive: Number("int"),
198
+ * // },
178
199
  * // },
179
200
  * // },
180
201
  * // },
@@ -184,6 +205,10 @@ declare const QueryAssistantCommand_base: {
184
205
  * // relevanceLevel: "STRING_VALUE",
185
206
  * // },
186
207
  * // },
208
+ * // intentDetectedData: {
209
+ * // intent: "STRING_VALUE", // required
210
+ * // intentId: "STRING_VALUE", // required
211
+ * // },
187
212
  * // sourceContentData: {
188
213
  * // id: "STRING_VALUE", // required
189
214
  * // type: "STRING_VALUE", // required
@@ -192,6 +217,10 @@ declare const QueryAssistantCommand_base: {
192
217
  * // excerpt: "<DocumentText>",
193
218
  * // },
194
219
  * // rankingData: "<RankingData>", // required
220
+ * // citationSpan: {
221
+ * // beginOffsetInclusive: Number("int"),
222
+ * // endOffsetExclusive: Number("int"),
223
+ * // },
195
224
  * // },
196
225
  * // },
197
226
  * // },
@@ -0,0 +1,83 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { RemoveAssistantAIAgentRequest, RemoveAssistantAIAgentResponse } 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 RemoveAssistantAIAgentCommand}.
14
+ */
15
+ export interface RemoveAssistantAIAgentCommandInput extends RemoveAssistantAIAgentRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link RemoveAssistantAIAgentCommand}.
21
+ */
22
+ export interface RemoveAssistantAIAgentCommandOutput extends RemoveAssistantAIAgentResponse, __MetadataBearer {
23
+ }
24
+ declare const RemoveAssistantAIAgentCommand_base: {
25
+ new (input: RemoveAssistantAIAgentCommandInput): import("@smithy/smithy-client").CommandImpl<RemoveAssistantAIAgentCommandInput, RemoveAssistantAIAgentCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: RemoveAssistantAIAgentCommandInput): import("@smithy/smithy-client").CommandImpl<RemoveAssistantAIAgentCommandInput, RemoveAssistantAIAgentCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect
31
+ * Assistant.</p>
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { QConnectClient, RemoveAssistantAIAgentCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
36
+ * // const { QConnectClient, RemoveAssistantAIAgentCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
37
+ * const client = new QConnectClient(config);
38
+ * const input = { // RemoveAssistantAIAgentRequest
39
+ * assistantId: "STRING_VALUE", // required
40
+ * aiAgentType: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new RemoveAssistantAIAgentCommand(input);
43
+ * const response = await client.send(command);
44
+ * // {};
45
+ *
46
+ * ```
47
+ *
48
+ * @param RemoveAssistantAIAgentCommandInput - {@link RemoveAssistantAIAgentCommandInput}
49
+ * @returns {@link RemoveAssistantAIAgentCommandOutput}
50
+ * @see {@link RemoveAssistantAIAgentCommandInput} for command's `input` shape.
51
+ * @see {@link RemoveAssistantAIAgentCommandOutput} for command's `response` shape.
52
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
53
+ *
54
+ * @throws {@link AccessDeniedException} (client fault)
55
+ * <p>You do not have sufficient access to perform this action.</p>
56
+ *
57
+ * @throws {@link ResourceNotFoundException} (client fault)
58
+ * <p>The specified resource does not exist.</p>
59
+ *
60
+ * @throws {@link ThrottlingException} (client fault)
61
+ * <p>The throttling limit has been exceeded.</p>
62
+ *
63
+ * @throws {@link ValidationException} (client fault)
64
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
65
+ *
66
+ * @throws {@link QConnectServiceException}
67
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
68
+ *
69
+ * @public
70
+ */
71
+ export declare class RemoveAssistantAIAgentCommand extends RemoveAssistantAIAgentCommand_base {
72
+ /** @internal type navigation helper, not in runtime. */
73
+ protected static __types: {
74
+ api: {
75
+ input: RemoveAssistantAIAgentRequest;
76
+ output: {};
77
+ };
78
+ sdk: {
79
+ input: RemoveAssistantAIAgentCommandInput;
80
+ output: RemoveAssistantAIAgentCommandOutput;
81
+ };
82
+ };
83
+ }
@@ -0,0 +1,244 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { UpdateAIAgentRequest, UpdateAIAgentResponse } 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 UpdateAIAgentCommand}.
14
+ */
15
+ export interface UpdateAIAgentCommandInput extends UpdateAIAgentRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateAIAgentCommand}.
21
+ */
22
+ export interface UpdateAIAgentCommandOutput extends UpdateAIAgentResponse, __MetadataBearer {
23
+ }
24
+ declare const UpdateAIAgentCommand_base: {
25
+ new (input: UpdateAIAgentCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAIAgentCommandInput, UpdateAIAgentCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: UpdateAIAgentCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAIAgentCommandInput, UpdateAIAgentCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Updates an AI Agent.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QConnectClient, UpdateAIAgentCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
35
+ * // const { QConnectClient, UpdateAIAgentCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
36
+ * const client = new QConnectClient(config);
37
+ * const input = { // UpdateAIAgentRequest
38
+ * clientToken: "STRING_VALUE",
39
+ * assistantId: "STRING_VALUE", // required
40
+ * aiAgentId: "STRING_VALUE", // required
41
+ * visibilityStatus: "STRING_VALUE", // required
42
+ * configuration: { // AIAgentConfiguration Union: only one key present
43
+ * manualSearchAIAgentConfiguration: { // ManualSearchAIAgentConfiguration
44
+ * answerGenerationAIPromptId: "STRING_VALUE",
45
+ * associationConfigurations: [ // AssociationConfigurationList
46
+ * { // AssociationConfiguration
47
+ * associationId: "STRING_VALUE",
48
+ * associationType: "STRING_VALUE",
49
+ * associationConfigurationData: { // AssociationConfigurationData Union: only one key present
50
+ * knowledgeBaseAssociationConfigurationData: { // KnowledgeBaseAssociationConfigurationData
51
+ * contentTagFilter: { // TagFilter Union: only one key present
52
+ * tagCondition: { // TagCondition
53
+ * key: "STRING_VALUE", // required
54
+ * value: "STRING_VALUE",
55
+ * },
56
+ * andConditions: [ // AndConditions
57
+ * {
58
+ * key: "STRING_VALUE", // required
59
+ * value: "STRING_VALUE",
60
+ * },
61
+ * ],
62
+ * orConditions: [ // OrConditions
63
+ * { // OrCondition Union: only one key present
64
+ * andConditions: [
65
+ * "<TagCondition>",
66
+ * ],
67
+ * tagCondition: "<TagCondition>",
68
+ * },
69
+ * ],
70
+ * },
71
+ * maxResults: Number("int"),
72
+ * overrideKnowledgeBaseSearchType: "STRING_VALUE",
73
+ * },
74
+ * },
75
+ * },
76
+ * ],
77
+ * },
78
+ * answerRecommendationAIAgentConfiguration: { // AnswerRecommendationAIAgentConfiguration
79
+ * intentLabelingGenerationAIPromptId: "STRING_VALUE",
80
+ * queryReformulationAIPromptId: "STRING_VALUE",
81
+ * answerGenerationAIPromptId: "STRING_VALUE",
82
+ * associationConfigurations: [
83
+ * {
84
+ * associationId: "STRING_VALUE",
85
+ * associationType: "STRING_VALUE",
86
+ * associationConfigurationData: {// Union: only one key present
87
+ * knowledgeBaseAssociationConfigurationData: {
88
+ * contentTagFilter: {// Union: only one key present
89
+ * tagCondition: "<TagCondition>",
90
+ * andConditions: [
91
+ * "<TagCondition>",
92
+ * ],
93
+ * orConditions: [
94
+ * {// Union: only one key present
95
+ * andConditions: [
96
+ * "<TagCondition>",
97
+ * ],
98
+ * tagCondition: "<TagCondition>",
99
+ * },
100
+ * ],
101
+ * },
102
+ * maxResults: Number("int"),
103
+ * overrideKnowledgeBaseSearchType: "STRING_VALUE",
104
+ * },
105
+ * },
106
+ * },
107
+ * ],
108
+ * },
109
+ * },
110
+ * description: "STRING_VALUE",
111
+ * };
112
+ * const command = new UpdateAIAgentCommand(input);
113
+ * const response = await client.send(command);
114
+ * // { // UpdateAIAgentResponse
115
+ * // aiAgent: { // AIAgentData
116
+ * // assistantId: "STRING_VALUE", // required
117
+ * // assistantArn: "STRING_VALUE", // required
118
+ * // aiAgentId: "STRING_VALUE", // required
119
+ * // aiAgentArn: "STRING_VALUE", // required
120
+ * // name: "STRING_VALUE", // required
121
+ * // type: "STRING_VALUE", // required
122
+ * // configuration: { // AIAgentConfiguration Union: only one key present
123
+ * // manualSearchAIAgentConfiguration: { // ManualSearchAIAgentConfiguration
124
+ * // answerGenerationAIPromptId: "STRING_VALUE",
125
+ * // associationConfigurations: [ // AssociationConfigurationList
126
+ * // { // AssociationConfiguration
127
+ * // associationId: "STRING_VALUE",
128
+ * // associationType: "STRING_VALUE",
129
+ * // associationConfigurationData: { // AssociationConfigurationData Union: only one key present
130
+ * // knowledgeBaseAssociationConfigurationData: { // KnowledgeBaseAssociationConfigurationData
131
+ * // contentTagFilter: { // TagFilter Union: only one key present
132
+ * // tagCondition: { // TagCondition
133
+ * // key: "STRING_VALUE", // required
134
+ * // value: "STRING_VALUE",
135
+ * // },
136
+ * // andConditions: [ // AndConditions
137
+ * // {
138
+ * // key: "STRING_VALUE", // required
139
+ * // value: "STRING_VALUE",
140
+ * // },
141
+ * // ],
142
+ * // orConditions: [ // OrConditions
143
+ * // { // OrCondition Union: only one key present
144
+ * // andConditions: [
145
+ * // "<TagCondition>",
146
+ * // ],
147
+ * // tagCondition: "<TagCondition>",
148
+ * // },
149
+ * // ],
150
+ * // },
151
+ * // maxResults: Number("int"),
152
+ * // overrideKnowledgeBaseSearchType: "STRING_VALUE",
153
+ * // },
154
+ * // },
155
+ * // },
156
+ * // ],
157
+ * // },
158
+ * // answerRecommendationAIAgentConfiguration: { // AnswerRecommendationAIAgentConfiguration
159
+ * // intentLabelingGenerationAIPromptId: "STRING_VALUE",
160
+ * // queryReformulationAIPromptId: "STRING_VALUE",
161
+ * // answerGenerationAIPromptId: "STRING_VALUE",
162
+ * // associationConfigurations: [
163
+ * // {
164
+ * // associationId: "STRING_VALUE",
165
+ * // associationType: "STRING_VALUE",
166
+ * // associationConfigurationData: {// Union: only one key present
167
+ * // knowledgeBaseAssociationConfigurationData: {
168
+ * // contentTagFilter: {// Union: only one key present
169
+ * // tagCondition: "<TagCondition>",
170
+ * // andConditions: [
171
+ * // "<TagCondition>",
172
+ * // ],
173
+ * // orConditions: [
174
+ * // {// Union: only one key present
175
+ * // andConditions: [
176
+ * // "<TagCondition>",
177
+ * // ],
178
+ * // tagCondition: "<TagCondition>",
179
+ * // },
180
+ * // ],
181
+ * // },
182
+ * // maxResults: Number("int"),
183
+ * // overrideKnowledgeBaseSearchType: "STRING_VALUE",
184
+ * // },
185
+ * // },
186
+ * // },
187
+ * // ],
188
+ * // },
189
+ * // },
190
+ * // modifiedTime: new Date("TIMESTAMP"),
191
+ * // description: "STRING_VALUE",
192
+ * // visibilityStatus: "STRING_VALUE", // required
193
+ * // tags: { // Tags
194
+ * // "<keys>": "STRING_VALUE",
195
+ * // },
196
+ * // origin: "STRING_VALUE",
197
+ * // status: "STRING_VALUE",
198
+ * // },
199
+ * // };
200
+ *
201
+ * ```
202
+ *
203
+ * @param UpdateAIAgentCommandInput - {@link UpdateAIAgentCommandInput}
204
+ * @returns {@link UpdateAIAgentCommandOutput}
205
+ * @see {@link UpdateAIAgentCommandInput} for command's `input` shape.
206
+ * @see {@link UpdateAIAgentCommandOutput} for command's `response` shape.
207
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
208
+ *
209
+ * @throws {@link AccessDeniedException} (client fault)
210
+ * <p>You do not have sufficient access to perform this action.</p>
211
+ *
212
+ * @throws {@link ConflictException} (client fault)
213
+ * <p>The request could not be processed because of conflict in the current state of the
214
+ * resource. For example, if you're using a <code>Create</code> API (such as
215
+ * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
216
+ * same name) is being created or mutated.</p>
217
+ *
218
+ * @throws {@link ResourceNotFoundException} (client fault)
219
+ * <p>The specified resource does not exist.</p>
220
+ *
221
+ * @throws {@link ThrottlingException} (client fault)
222
+ * <p>The throttling limit has been exceeded.</p>
223
+ *
224
+ * @throws {@link ValidationException} (client fault)
225
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
226
+ *
227
+ * @throws {@link QConnectServiceException}
228
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
229
+ *
230
+ * @public
231
+ */
232
+ export declare class UpdateAIAgentCommand extends UpdateAIAgentCommand_base {
233
+ /** @internal type navigation helper, not in runtime. */
234
+ protected static __types: {
235
+ api: {
236
+ input: UpdateAIAgentRequest;
237
+ output: UpdateAIAgentResponse;
238
+ };
239
+ sdk: {
240
+ input: UpdateAIAgentCommandInput;
241
+ output: UpdateAIAgentCommandOutput;
242
+ };
243
+ };
244
+ }