@aws-sdk/client-qconnect 3.665.0 → 3.667.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 +19 -19
@@ -0,0 +1,180 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { CreateAIAgentVersionRequest, CreateAIAgentVersionResponse } 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 CreateAIAgentVersionCommand}.
14
+ */
15
+ export interface CreateAIAgentVersionCommandInput extends CreateAIAgentVersionRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateAIAgentVersionCommand}.
21
+ */
22
+ export interface CreateAIAgentVersionCommandOutput extends CreateAIAgentVersionResponse, __MetadataBearer {
23
+ }
24
+ declare const CreateAIAgentVersionCommand_base: {
25
+ new (input: CreateAIAgentVersionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateAIAgentVersionCommandInput, CreateAIAgentVersionCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CreateAIAgentVersionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateAIAgentVersionCommandInput, CreateAIAgentVersionCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates and Amazon Q in Connect AI Agent version.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QConnectClient, CreateAIAgentVersionCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
35
+ * // const { QConnectClient, CreateAIAgentVersionCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
36
+ * const client = new QConnectClient(config);
37
+ * const input = { // CreateAIAgentVersionRequest
38
+ * assistantId: "STRING_VALUE", // required
39
+ * aiAgentId: "STRING_VALUE", // required
40
+ * modifiedTime: new Date("TIMESTAMP"),
41
+ * clientToken: "STRING_VALUE",
42
+ * };
43
+ * const command = new CreateAIAgentVersionCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // CreateAIAgentVersionResponse
46
+ * // aiAgent: { // AIAgentData
47
+ * // assistantId: "STRING_VALUE", // required
48
+ * // assistantArn: "STRING_VALUE", // required
49
+ * // aiAgentId: "STRING_VALUE", // required
50
+ * // aiAgentArn: "STRING_VALUE", // required
51
+ * // name: "STRING_VALUE", // required
52
+ * // type: "STRING_VALUE", // required
53
+ * // configuration: { // AIAgentConfiguration Union: only one key present
54
+ * // manualSearchAIAgentConfiguration: { // ManualSearchAIAgentConfiguration
55
+ * // answerGenerationAIPromptId: "STRING_VALUE",
56
+ * // associationConfigurations: [ // AssociationConfigurationList
57
+ * // { // AssociationConfiguration
58
+ * // associationId: "STRING_VALUE",
59
+ * // associationType: "STRING_VALUE",
60
+ * // associationConfigurationData: { // AssociationConfigurationData Union: only one key present
61
+ * // knowledgeBaseAssociationConfigurationData: { // KnowledgeBaseAssociationConfigurationData
62
+ * // contentTagFilter: { // TagFilter Union: only one key present
63
+ * // tagCondition: { // TagCondition
64
+ * // key: "STRING_VALUE", // required
65
+ * // value: "STRING_VALUE",
66
+ * // },
67
+ * // andConditions: [ // AndConditions
68
+ * // {
69
+ * // key: "STRING_VALUE", // required
70
+ * // value: "STRING_VALUE",
71
+ * // },
72
+ * // ],
73
+ * // orConditions: [ // OrConditions
74
+ * // { // OrCondition Union: only one key present
75
+ * // andConditions: [
76
+ * // "<TagCondition>",
77
+ * // ],
78
+ * // tagCondition: "<TagCondition>",
79
+ * // },
80
+ * // ],
81
+ * // },
82
+ * // maxResults: Number("int"),
83
+ * // overrideKnowledgeBaseSearchType: "STRING_VALUE",
84
+ * // },
85
+ * // },
86
+ * // },
87
+ * // ],
88
+ * // },
89
+ * // answerRecommendationAIAgentConfiguration: { // AnswerRecommendationAIAgentConfiguration
90
+ * // intentLabelingGenerationAIPromptId: "STRING_VALUE",
91
+ * // queryReformulationAIPromptId: "STRING_VALUE",
92
+ * // answerGenerationAIPromptId: "STRING_VALUE",
93
+ * // associationConfigurations: [
94
+ * // {
95
+ * // associationId: "STRING_VALUE",
96
+ * // associationType: "STRING_VALUE",
97
+ * // associationConfigurationData: {// Union: only one key present
98
+ * // knowledgeBaseAssociationConfigurationData: {
99
+ * // contentTagFilter: {// Union: only one key present
100
+ * // tagCondition: "<TagCondition>",
101
+ * // andConditions: [
102
+ * // "<TagCondition>",
103
+ * // ],
104
+ * // orConditions: [
105
+ * // {// Union: only one key present
106
+ * // andConditions: [
107
+ * // "<TagCondition>",
108
+ * // ],
109
+ * // tagCondition: "<TagCondition>",
110
+ * // },
111
+ * // ],
112
+ * // },
113
+ * // maxResults: Number("int"),
114
+ * // overrideKnowledgeBaseSearchType: "STRING_VALUE",
115
+ * // },
116
+ * // },
117
+ * // },
118
+ * // ],
119
+ * // },
120
+ * // },
121
+ * // modifiedTime: new Date("TIMESTAMP"),
122
+ * // description: "STRING_VALUE",
123
+ * // visibilityStatus: "STRING_VALUE", // required
124
+ * // tags: { // Tags
125
+ * // "<keys>": "STRING_VALUE",
126
+ * // },
127
+ * // origin: "STRING_VALUE",
128
+ * // status: "STRING_VALUE",
129
+ * // },
130
+ * // versionNumber: Number("long"),
131
+ * // };
132
+ *
133
+ * ```
134
+ *
135
+ * @param CreateAIAgentVersionCommandInput - {@link CreateAIAgentVersionCommandInput}
136
+ * @returns {@link CreateAIAgentVersionCommandOutput}
137
+ * @see {@link CreateAIAgentVersionCommandInput} for command's `input` shape.
138
+ * @see {@link CreateAIAgentVersionCommandOutput} for command's `response` shape.
139
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
140
+ *
141
+ * @throws {@link AccessDeniedException} (client fault)
142
+ * <p>You do not have sufficient access to perform this action.</p>
143
+ *
144
+ * @throws {@link ConflictException} (client fault)
145
+ * <p>The request could not be processed because of conflict in the current state of the
146
+ * resource. For example, if you're using a <code>Create</code> API (such as
147
+ * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
148
+ * same name) is being created or mutated.</p>
149
+ *
150
+ * @throws {@link ResourceNotFoundException} (client fault)
151
+ * <p>The specified resource does not exist.</p>
152
+ *
153
+ * @throws {@link ServiceQuotaExceededException} (client fault)
154
+ * <p>You've exceeded your service quota. To perform the requested action, remove some of the
155
+ * relevant resources, or use service quotas to request a service quota increase.</p>
156
+ *
157
+ * @throws {@link ThrottlingException} (client fault)
158
+ * <p>The throttling limit has been exceeded.</p>
159
+ *
160
+ * @throws {@link ValidationException} (client fault)
161
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
162
+ *
163
+ * @throws {@link QConnectServiceException}
164
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
165
+ *
166
+ * @public
167
+ */
168
+ export declare class CreateAIAgentVersionCommand extends CreateAIAgentVersionCommand_base {
169
+ /** @internal type navigation helper, not in runtime. */
170
+ protected static __types: {
171
+ api: {
172
+ input: CreateAIAgentVersionRequest;
173
+ output: CreateAIAgentVersionResponse;
174
+ };
175
+ sdk: {
176
+ input: CreateAIAgentVersionCommandInput;
177
+ output: CreateAIAgentVersionCommandOutput;
178
+ };
179
+ };
180
+ }
@@ -0,0 +1,132 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { CreateAIPromptRequest, CreateAIPromptResponse } 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 CreateAIPromptCommand}.
14
+ */
15
+ export interface CreateAIPromptCommandInput extends CreateAIPromptRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateAIPromptCommand}.
21
+ */
22
+ export interface CreateAIPromptCommandOutput extends CreateAIPromptResponse, __MetadataBearer {
23
+ }
24
+ declare const CreateAIPromptCommand_base: {
25
+ new (input: CreateAIPromptCommandInput): import("@smithy/smithy-client").CommandImpl<CreateAIPromptCommandInput, CreateAIPromptCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CreateAIPromptCommandInput): import("@smithy/smithy-client").CommandImpl<CreateAIPromptCommandInput, CreateAIPromptCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates an Amazon Q in Connect AI Prompt.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QConnectClient, CreateAIPromptCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
35
+ * // const { QConnectClient, CreateAIPromptCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
36
+ * const client = new QConnectClient(config);
37
+ * const input = { // CreateAIPromptRequest
38
+ * clientToken: "STRING_VALUE",
39
+ * assistantId: "STRING_VALUE", // required
40
+ * name: "STRING_VALUE", // required
41
+ * type: "STRING_VALUE", // required
42
+ * templateConfiguration: { // AIPromptTemplateConfiguration Union: only one key present
43
+ * textFullAIPromptEditTemplateConfiguration: { // TextFullAIPromptEditTemplateConfiguration
44
+ * text: "STRING_VALUE", // required
45
+ * },
46
+ * },
47
+ * visibilityStatus: "STRING_VALUE", // required
48
+ * templateType: "STRING_VALUE", // required
49
+ * modelId: "STRING_VALUE", // required
50
+ * apiFormat: "STRING_VALUE", // required
51
+ * tags: { // Tags
52
+ * "<keys>": "STRING_VALUE",
53
+ * },
54
+ * description: "STRING_VALUE",
55
+ * };
56
+ * const command = new CreateAIPromptCommand(input);
57
+ * const response = await client.send(command);
58
+ * // { // CreateAIPromptResponse
59
+ * // aiPrompt: { // AIPromptData
60
+ * // assistantId: "STRING_VALUE", // required
61
+ * // assistantArn: "STRING_VALUE", // required
62
+ * // aiPromptId: "STRING_VALUE", // required
63
+ * // aiPromptArn: "STRING_VALUE", // required
64
+ * // name: "STRING_VALUE", // required
65
+ * // type: "STRING_VALUE", // required
66
+ * // templateType: "STRING_VALUE", // required
67
+ * // modelId: "STRING_VALUE", // required
68
+ * // apiFormat: "STRING_VALUE", // required
69
+ * // templateConfiguration: { // AIPromptTemplateConfiguration Union: only one key present
70
+ * // textFullAIPromptEditTemplateConfiguration: { // TextFullAIPromptEditTemplateConfiguration
71
+ * // text: "STRING_VALUE", // required
72
+ * // },
73
+ * // },
74
+ * // modifiedTime: new Date("TIMESTAMP"),
75
+ * // description: "STRING_VALUE",
76
+ * // visibilityStatus: "STRING_VALUE", // required
77
+ * // tags: { // Tags
78
+ * // "<keys>": "STRING_VALUE",
79
+ * // },
80
+ * // origin: "STRING_VALUE",
81
+ * // status: "STRING_VALUE",
82
+ * // },
83
+ * // };
84
+ *
85
+ * ```
86
+ *
87
+ * @param CreateAIPromptCommandInput - {@link CreateAIPromptCommandInput}
88
+ * @returns {@link CreateAIPromptCommandOutput}
89
+ * @see {@link CreateAIPromptCommandInput} for command's `input` shape.
90
+ * @see {@link CreateAIPromptCommandOutput} for command's `response` shape.
91
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
92
+ *
93
+ * @throws {@link AccessDeniedException} (client fault)
94
+ * <p>You do not have sufficient access to perform this action.</p>
95
+ *
96
+ * @throws {@link ConflictException} (client fault)
97
+ * <p>The request could not be processed because of conflict in the current state of the
98
+ * resource. For example, if you're using a <code>Create</code> API (such as
99
+ * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
100
+ * same name) is being created or mutated.</p>
101
+ *
102
+ * @throws {@link ResourceNotFoundException} (client fault)
103
+ * <p>The specified resource does not exist.</p>
104
+ *
105
+ * @throws {@link ServiceQuotaExceededException} (client fault)
106
+ * <p>You've exceeded your service quota. To perform the requested action, remove some of the
107
+ * relevant resources, or use service quotas to request a service quota increase.</p>
108
+ *
109
+ * @throws {@link ThrottlingException} (client fault)
110
+ * <p>The throttling limit has been exceeded.</p>
111
+ *
112
+ * @throws {@link ValidationException} (client fault)
113
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
114
+ *
115
+ * @throws {@link QConnectServiceException}
116
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
117
+ *
118
+ * @public
119
+ */
120
+ export declare class CreateAIPromptCommand extends CreateAIPromptCommand_base {
121
+ /** @internal type navigation helper, not in runtime. */
122
+ protected static __types: {
123
+ api: {
124
+ input: CreateAIPromptRequest;
125
+ output: CreateAIPromptResponse;
126
+ };
127
+ sdk: {
128
+ input: CreateAIPromptCommandInput;
129
+ output: CreateAIPromptCommandOutput;
130
+ };
131
+ };
132
+ }
@@ -0,0 +1,120 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { CreateAIPromptVersionRequest, CreateAIPromptVersionResponse } 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 CreateAIPromptVersionCommand}.
14
+ */
15
+ export interface CreateAIPromptVersionCommandInput extends CreateAIPromptVersionRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateAIPromptVersionCommand}.
21
+ */
22
+ export interface CreateAIPromptVersionCommandOutput extends CreateAIPromptVersionResponse, __MetadataBearer {
23
+ }
24
+ declare const CreateAIPromptVersionCommand_base: {
25
+ new (input: CreateAIPromptVersionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateAIPromptVersionCommandInput, CreateAIPromptVersionCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CreateAIPromptVersionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateAIPromptVersionCommandInput, CreateAIPromptVersionCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates an Amazon Q in Connect AI Prompt version.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QConnectClient, CreateAIPromptVersionCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
35
+ * // const { QConnectClient, CreateAIPromptVersionCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
36
+ * const client = new QConnectClient(config);
37
+ * const input = { // CreateAIPromptVersionRequest
38
+ * assistantId: "STRING_VALUE", // required
39
+ * aiPromptId: "STRING_VALUE", // required
40
+ * modifiedTime: new Date("TIMESTAMP"),
41
+ * clientToken: "STRING_VALUE",
42
+ * };
43
+ * const command = new CreateAIPromptVersionCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // CreateAIPromptVersionResponse
46
+ * // aiPrompt: { // AIPromptData
47
+ * // assistantId: "STRING_VALUE", // required
48
+ * // assistantArn: "STRING_VALUE", // required
49
+ * // aiPromptId: "STRING_VALUE", // required
50
+ * // aiPromptArn: "STRING_VALUE", // required
51
+ * // name: "STRING_VALUE", // required
52
+ * // type: "STRING_VALUE", // required
53
+ * // templateType: "STRING_VALUE", // required
54
+ * // modelId: "STRING_VALUE", // required
55
+ * // apiFormat: "STRING_VALUE", // required
56
+ * // templateConfiguration: { // AIPromptTemplateConfiguration Union: only one key present
57
+ * // textFullAIPromptEditTemplateConfiguration: { // TextFullAIPromptEditTemplateConfiguration
58
+ * // text: "STRING_VALUE", // required
59
+ * // },
60
+ * // },
61
+ * // modifiedTime: new Date("TIMESTAMP"),
62
+ * // description: "STRING_VALUE",
63
+ * // visibilityStatus: "STRING_VALUE", // required
64
+ * // tags: { // Tags
65
+ * // "<keys>": "STRING_VALUE",
66
+ * // },
67
+ * // origin: "STRING_VALUE",
68
+ * // status: "STRING_VALUE",
69
+ * // },
70
+ * // versionNumber: Number("long"),
71
+ * // };
72
+ *
73
+ * ```
74
+ *
75
+ * @param CreateAIPromptVersionCommandInput - {@link CreateAIPromptVersionCommandInput}
76
+ * @returns {@link CreateAIPromptVersionCommandOutput}
77
+ * @see {@link CreateAIPromptVersionCommandInput} for command's `input` shape.
78
+ * @see {@link CreateAIPromptVersionCommandOutput} for command's `response` shape.
79
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
80
+ *
81
+ * @throws {@link AccessDeniedException} (client fault)
82
+ * <p>You do not have sufficient access to perform this action.</p>
83
+ *
84
+ * @throws {@link ConflictException} (client fault)
85
+ * <p>The request could not be processed because of conflict in the current state of the
86
+ * resource. For example, if you're using a <code>Create</code> API (such as
87
+ * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
88
+ * same name) is being created or mutated.</p>
89
+ *
90
+ * @throws {@link ResourceNotFoundException} (client fault)
91
+ * <p>The specified resource does not exist.</p>
92
+ *
93
+ * @throws {@link ServiceQuotaExceededException} (client fault)
94
+ * <p>You've exceeded your service quota. To perform the requested action, remove some of the
95
+ * relevant resources, or use service quotas to request a service quota increase.</p>
96
+ *
97
+ * @throws {@link ThrottlingException} (client fault)
98
+ * <p>The throttling limit has been exceeded.</p>
99
+ *
100
+ * @throws {@link ValidationException} (client fault)
101
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
102
+ *
103
+ * @throws {@link QConnectServiceException}
104
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
105
+ *
106
+ * @public
107
+ */
108
+ export declare class CreateAIPromptVersionCommand extends CreateAIPromptVersionCommand_base {
109
+ /** @internal type navigation helper, not in runtime. */
110
+ protected static __types: {
111
+ api: {
112
+ input: CreateAIPromptVersionRequest;
113
+ output: CreateAIPromptVersionResponse;
114
+ };
115
+ sdk: {
116
+ input: CreateAIPromptVersionCommandInput;
117
+ output: CreateAIPromptVersionCommandOutput;
118
+ };
119
+ };
120
+ }
@@ -68,6 +68,11 @@ declare const CreateAssistantCommand_base: {
68
68
  * // capabilityConfiguration: { // AssistantCapabilityConfiguration
69
69
  * // type: "STRING_VALUE",
70
70
  * // },
71
+ * // aiAgentConfiguration: { // AIAgentConfigurationMap
72
+ * // "<keys>": { // AIAgentConfigurationData
73
+ * // aiAgentId: "STRING_VALUE", // required
74
+ * // },
75
+ * // },
71
76
  * // },
72
77
  * // };
73
78
  *
@@ -27,18 +27,17 @@ declare const CreateContentAssociationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates an association between a content resource in a knowledge base and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/step-by-step-guided-experiences.html">step-by-step
31
- * guides</a>. Step-by-step guides offer instructions to agents for resolving common
32
- * customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step
33
- * guides. </p>
30
+ * <p>Creates an association between a content resource in a knowledge base and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/step-by-step-guided-experiences.html">step-by-step guides</a>. Step-by-step guides offer instructions to agents for resolving
31
+ * common customer issues. You create a content association to integrate Amazon Q in Connect and
32
+ * step-by-step guides. </p>
34
33
  * <p>After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a
35
34
  * recommendation to an agent based on the intent that it's detected, it also provides them with
36
35
  * the option to start the step-by-step guide that you have associated with the content.</p>
37
36
  * <p>Note the following limitations:</p>
38
37
  * <ul>
39
38
  * <li>
40
- * <p>You can create only one content association for each
41
- * content resource in a knowledge base.</p>
39
+ * <p>You can create only one content association for each content resource in a knowledge
40
+ * base.</p>
42
41
  * </li>
43
42
  * <li>
44
43
  * <p>You can associate a step-by-step guide with multiple content resources.</p>
@@ -68,10 +68,62 @@ declare const CreateKnowledgeBaseCommand_base: {
68
68
  * "STRING_VALUE",
69
69
  * ],
70
70
  * },
71
+ * managedSourceConfiguration: { // ManagedSourceConfiguration Union: only one key present
72
+ * webCrawlerConfiguration: { // WebCrawlerConfiguration
73
+ * urlConfiguration: { // UrlConfiguration
74
+ * seedUrls: [ // SeedUrls
75
+ * { // SeedUrl
76
+ * url: "STRING_VALUE",
77
+ * },
78
+ * ],
79
+ * },
80
+ * crawlerLimits: { // WebCrawlerLimits
81
+ * rateLimit: Number("int"),
82
+ * },
83
+ * inclusionFilters: [ // UrlFilterList
84
+ * "STRING_VALUE",
85
+ * ],
86
+ * exclusionFilters: [
87
+ * "STRING_VALUE",
88
+ * ],
89
+ * scope: "STRING_VALUE",
90
+ * },
91
+ * },
71
92
  * },
72
93
  * renderingConfiguration: { // RenderingConfiguration
73
94
  * templateUri: "STRING_VALUE",
74
95
  * },
96
+ * vectorIngestionConfiguration: { // VectorIngestionConfiguration
97
+ * chunkingConfiguration: { // ChunkingConfiguration
98
+ * chunkingStrategy: "STRING_VALUE", // required
99
+ * fixedSizeChunkingConfiguration: { // FixedSizeChunkingConfiguration
100
+ * maxTokens: Number("int"), // required
101
+ * overlapPercentage: Number("int"), // required
102
+ * },
103
+ * hierarchicalChunkingConfiguration: { // HierarchicalChunkingConfiguration
104
+ * levelConfigurations: [ // HierarchicalChunkingLevelConfigurations // required
105
+ * { // HierarchicalChunkingLevelConfiguration
106
+ * maxTokens: Number("int"), // required
107
+ * },
108
+ * ],
109
+ * overlapTokens: Number("int"), // required
110
+ * },
111
+ * semanticChunkingConfiguration: { // SemanticChunkingConfiguration
112
+ * maxTokens: Number("int"), // required
113
+ * bufferSize: Number("int"), // required
114
+ * breakpointPercentileThreshold: Number("int"), // required
115
+ * },
116
+ * },
117
+ * parsingConfiguration: { // ParsingConfiguration
118
+ * parsingStrategy: "STRING_VALUE", // required
119
+ * bedrockFoundationModelConfiguration: { // BedrockFoundationModelConfigurationForParsing
120
+ * modelArn: "STRING_VALUE", // required
121
+ * parsingPrompt: { // ParsingPrompt
122
+ * parsingPromptText: "STRING_VALUE", // required
123
+ * },
124
+ * },
125
+ * },
126
+ * },
75
127
  * serverSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
76
128
  * kmsKeyId: "STRING_VALUE",
77
129
  * },
@@ -90,6 +142,37 @@ declare const CreateKnowledgeBaseCommand_base: {
90
142
  * // knowledgeBaseType: "STRING_VALUE", // required
91
143
  * // status: "STRING_VALUE", // required
92
144
  * // lastContentModificationTime: new Date("TIMESTAMP"),
145
+ * // vectorIngestionConfiguration: { // VectorIngestionConfiguration
146
+ * // chunkingConfiguration: { // ChunkingConfiguration
147
+ * // chunkingStrategy: "STRING_VALUE", // required
148
+ * // fixedSizeChunkingConfiguration: { // FixedSizeChunkingConfiguration
149
+ * // maxTokens: Number("int"), // required
150
+ * // overlapPercentage: Number("int"), // required
151
+ * // },
152
+ * // hierarchicalChunkingConfiguration: { // HierarchicalChunkingConfiguration
153
+ * // levelConfigurations: [ // HierarchicalChunkingLevelConfigurations // required
154
+ * // { // HierarchicalChunkingLevelConfiguration
155
+ * // maxTokens: Number("int"), // required
156
+ * // },
157
+ * // ],
158
+ * // overlapTokens: Number("int"), // required
159
+ * // },
160
+ * // semanticChunkingConfiguration: { // SemanticChunkingConfiguration
161
+ * // maxTokens: Number("int"), // required
162
+ * // bufferSize: Number("int"), // required
163
+ * // breakpointPercentileThreshold: Number("int"), // required
164
+ * // },
165
+ * // },
166
+ * // parsingConfiguration: { // ParsingConfiguration
167
+ * // parsingStrategy: "STRING_VALUE", // required
168
+ * // bedrockFoundationModelConfiguration: { // BedrockFoundationModelConfigurationForParsing
169
+ * // modelArn: "STRING_VALUE", // required
170
+ * // parsingPrompt: { // ParsingPrompt
171
+ * // parsingPromptText: "STRING_VALUE", // required
172
+ * // },
173
+ * // },
174
+ * // },
175
+ * // },
93
176
  * // sourceConfiguration: { // SourceConfiguration Union: only one key present
94
177
  * // appIntegrations: { // AppIntegrationsConfiguration
95
178
  * // appIntegrationArn: "STRING_VALUE", // required
@@ -97,6 +180,27 @@ declare const CreateKnowledgeBaseCommand_base: {
97
180
  * // "STRING_VALUE",
98
181
  * // ],
99
182
  * // },
183
+ * // managedSourceConfiguration: { // ManagedSourceConfiguration Union: only one key present
184
+ * // webCrawlerConfiguration: { // WebCrawlerConfiguration
185
+ * // urlConfiguration: { // UrlConfiguration
186
+ * // seedUrls: [ // SeedUrls
187
+ * // { // SeedUrl
188
+ * // url: "STRING_VALUE",
189
+ * // },
190
+ * // ],
191
+ * // },
192
+ * // crawlerLimits: { // WebCrawlerLimits
193
+ * // rateLimit: Number("int"),
194
+ * // },
195
+ * // inclusionFilters: [ // UrlFilterList
196
+ * // "STRING_VALUE",
197
+ * // ],
198
+ * // exclusionFilters: [
199
+ * // "STRING_VALUE",
200
+ * // ],
201
+ * // scope: "STRING_VALUE",
202
+ * // },
203
+ * // },
100
204
  * // },
101
205
  * // renderingConfiguration: { // RenderingConfiguration
102
206
  * // templateUri: "STRING_VALUE",
@@ -108,6 +212,10 @@ declare const CreateKnowledgeBaseCommand_base: {
108
212
  * // tags: { // Tags
109
213
  * // "<keys>": "STRING_VALUE",
110
214
  * // },
215
+ * // ingestionStatus: "STRING_VALUE",
216
+ * // ingestionFailureReasons: [ // FailureReason
217
+ * // "STRING_VALUE",
218
+ * // ],
111
219
  * // },
112
220
  * // };
113
221
  *
@@ -64,6 +64,11 @@ declare const CreateSessionCommand_base: {
64
64
  * },
65
65
  * ],
66
66
  * },
67
+ * aiAgentConfiguration: { // AIAgentConfigurationMap
68
+ * "<keys>": { // AIAgentConfigurationData
69
+ * aiAgentId: "STRING_VALUE", // required
70
+ * },
71
+ * },
67
72
  * };
68
73
  * const command = new CreateSessionCommand(input);
69
74
  * const response = await client.send(command);
@@ -99,6 +104,11 @@ declare const CreateSessionCommand_base: {
99
104
  * // },
100
105
  * // ],
101
106
  * // },
107
+ * // aiAgentConfiguration: { // AIAgentConfigurationMap
108
+ * // "<keys>": { // AIAgentConfigurationData
109
+ * // aiAgentId: "STRING_VALUE", // required
110
+ * // },
111
+ * // },
102
112
  * // },
103
113
  * // };
104
114
  *