@aws-sdk/client-qconnect 3.940.0 → 3.943.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 +16 -0
- package/dist-cjs/index.js +879 -101
- package/dist-es/QConnect.js +4 -0
- package/dist-es/commands/ListSpansCommand.js +16 -0
- package/dist-es/commands/RetrieveCommand.js +16 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/enums.js +61 -12
- package/dist-es/models/errors.js +12 -0
- package/dist-es/pagination/ListSpansPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +774 -90
- package/dist-types/QConnect.d.ts +14 -0
- package/dist-types/QConnectClient.d.ts +4 -2
- package/dist-types/commands/CreateAIAgentCommand.d.ts +126 -0
- package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +63 -0
- package/dist-types/commands/CreateAIPromptCommand.d.ts +16 -0
- package/dist-types/commands/CreateAIPromptVersionCommand.d.ts +8 -0
- package/dist-types/commands/CreateAssistantAssociationCommand.d.ts +8 -0
- package/dist-types/commands/CreateAssistantCommand.d.ts +6 -0
- package/dist-types/commands/CreateSessionCommand.d.ts +14 -1
- 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 +63 -0
- package/dist-types/commands/GetAIPromptCommand.d.ts +8 -0
- package/dist-types/commands/GetAssistantAssociationCommand.d.ts +4 -0
- package/dist-types/commands/GetAssistantCommand.d.ts +6 -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 +1 -1
- package/dist-types/commands/GetNextMessageCommand.d.ts +26 -0
- package/dist-types/commands/GetQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/GetRecommendationsCommand.d.ts +39 -0
- package/dist-types/commands/GetSessionCommand.d.ts +6 -0
- package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +63 -0
- package/dist-types/commands/ListAIAgentsCommand.d.ts +63 -0
- package/dist-types/commands/ListAssistantAssociationsCommand.d.ts +4 -0
- package/dist-types/commands/ListAssistantsCommand.d.ts +6 -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 +23 -0
- package/dist-types/commands/ListSpansCommand.d.ts +207 -0
- package/dist-types/commands/QueryAssistantCommand.d.ts +41 -0
- package/dist-types/commands/RemoveAssistantAIAgentCommand.d.ts +1 -0
- package/dist-types/commands/RenderMessageTemplateCommand.d.ts +1 -2
- package/dist-types/commands/RetrieveCommand.d.ts +168 -0
- package/dist-types/commands/SendMessageCommand.d.ts +37 -1
- package/dist-types/commands/UpdateAIAgentCommand.d.ts +126 -0
- package/dist-types/commands/UpdateAIPromptCommand.d.ts +16 -0
- package/dist-types/commands/UpdateAssistantAIAgentCommand.d.ts +12 -0
- package/dist-types/commands/UpdateSessionCommand.d.ts +13 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/enums.d.ts +110 -21
- package/dist-types/models/errors.d.ts +13 -1
- package/dist-types/models/models_0.d.ts +996 -723
- package/dist-types/models/models_1.d.ts +1563 -48
- package/dist-types/pagination/ListSpansPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +64 -0
- package/dist-types/ts3.4/QConnect.d.ts +34 -0
- package/dist-types/ts3.4/QConnectClient.d.ts +12 -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/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/GetQuickResponseCommand.d.ts +1 -1
- 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/ListSpansCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/RenderMessageTemplateCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/enums.d.ts +71 -15
- package/dist-types/ts3.4/models/errors.d.ts +7 -0
- package/dist-types/ts3.4/models/models_0.d.ts +354 -172
- package/dist-types/ts3.4/models/models_1.d.ts +663 -2
- package/dist-types/ts3.4/pagination/ListSpansPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +64 -0
- package/package.json +5 -5
|
@@ -61,6 +61,9 @@ declare const QueryAssistantCommand_base: {
|
|
|
61
61
|
* intentInputData: { // IntentInputData
|
|
62
62
|
* intentId: "STRING_VALUE", // required
|
|
63
63
|
* },
|
|
64
|
+
* caseSummarizationInputData: { // CaseSummarizationInputData
|
|
65
|
+
* caseArn: "STRING_VALUE", // required
|
|
66
|
+
* },
|
|
64
67
|
* },
|
|
65
68
|
* overrideKnowledgeBaseSearchType: "STRING_VALUE",
|
|
66
69
|
* };
|
|
@@ -113,6 +116,10 @@ declare const QueryAssistantCommand_base: {
|
|
|
113
116
|
* // modelId: "STRING_VALUE",
|
|
114
117
|
* // generationId: "STRING_VALUE",
|
|
115
118
|
* // },
|
|
119
|
+
* // suggestedMessageReference: { // SuggestedMessageReference
|
|
120
|
+
* // aiAgentId: "STRING_VALUE", // required
|
|
121
|
+
* // aiAgentArn: "STRING_VALUE", // required
|
|
122
|
+
* // },
|
|
116
123
|
* // },
|
|
117
124
|
* // details: { // DataDetails Union: only one key present
|
|
118
125
|
* // contentData: { // ContentDataDetails
|
|
@@ -151,6 +158,10 @@ declare const QueryAssistantCommand_base: {
|
|
|
151
158
|
* // modelId: "STRING_VALUE",
|
|
152
159
|
* // generationId: "STRING_VALUE",
|
|
153
160
|
* // },
|
|
161
|
+
* // suggestedMessageReference: {
|
|
162
|
+
* // aiAgentId: "STRING_VALUE", // required
|
|
163
|
+
* // aiAgentArn: "STRING_VALUE", // required
|
|
164
|
+
* // },
|
|
154
165
|
* // },
|
|
155
166
|
* // details: {// Union: only one key present
|
|
156
167
|
* // contentData: {
|
|
@@ -176,6 +187,7 @@ declare const QueryAssistantCommand_base: {
|
|
|
176
187
|
* // intentDetectedData: { // IntentDetectedDataDetails
|
|
177
188
|
* // intent: "STRING_VALUE", // required
|
|
178
189
|
* // intentId: "STRING_VALUE", // required
|
|
190
|
+
* // relevanceLevel: "STRING_VALUE",
|
|
179
191
|
* // },
|
|
180
192
|
* // sourceContentData: { // SourceContentDataDetails
|
|
181
193
|
* // id: "STRING_VALUE", // required
|
|
@@ -215,6 +227,20 @@ declare const QueryAssistantCommand_base: {
|
|
|
215
227
|
* // ],
|
|
216
228
|
* // nextChunkToken: "STRING_VALUE",
|
|
217
229
|
* // },
|
|
230
|
+
* // caseSummarizationChunkData: { // CaseSummarizationChunkDataDetails
|
|
231
|
+
* // completion: "STRING_VALUE",
|
|
232
|
+
* // nextChunkToken: "STRING_VALUE",
|
|
233
|
+
* // },
|
|
234
|
+
* // suggestedMessageData: { // SuggestedMessageDataDetails
|
|
235
|
+
* // messageText: "STRING_VALUE", // required
|
|
236
|
+
* // },
|
|
237
|
+
* // notesData: { // NotesDataDetails
|
|
238
|
+
* // completion: "STRING_VALUE",
|
|
239
|
+
* // },
|
|
240
|
+
* // notesChunkData: { // NotesChunkDataDetails
|
|
241
|
+
* // completion: "STRING_VALUE",
|
|
242
|
+
* // nextChunkToken: "STRING_VALUE",
|
|
243
|
+
* // },
|
|
218
244
|
* // },
|
|
219
245
|
* // },
|
|
220
246
|
* // ],
|
|
@@ -226,6 +252,7 @@ declare const QueryAssistantCommand_base: {
|
|
|
226
252
|
* // intentDetectedData: {
|
|
227
253
|
* // intent: "STRING_VALUE", // required
|
|
228
254
|
* // intentId: "STRING_VALUE", // required
|
|
255
|
+
* // relevanceLevel: "STRING_VALUE",
|
|
229
256
|
* // },
|
|
230
257
|
* // sourceContentData: {
|
|
231
258
|
* // id: "STRING_VALUE", // required
|
|
@@ -260,6 +287,20 @@ declare const QueryAssistantCommand_base: {
|
|
|
260
287
|
* // references: "<DataSummaryList>",
|
|
261
288
|
* // nextChunkToken: "STRING_VALUE",
|
|
262
289
|
* // },
|
|
290
|
+
* // caseSummarizationChunkData: {
|
|
291
|
+
* // completion: "STRING_VALUE",
|
|
292
|
+
* // nextChunkToken: "STRING_VALUE",
|
|
293
|
+
* // },
|
|
294
|
+
* // suggestedMessageData: {
|
|
295
|
+
* // messageText: "STRING_VALUE", // required
|
|
296
|
+
* // },
|
|
297
|
+
* // notesData: {
|
|
298
|
+
* // completion: "STRING_VALUE",
|
|
299
|
+
* // },
|
|
300
|
+
* // notesChunkData: {
|
|
301
|
+
* // completion: "STRING_VALUE",
|
|
302
|
+
* // nextChunkToken: "STRING_VALUE",
|
|
303
|
+
* // },
|
|
263
304
|
* // },
|
|
264
305
|
* // },
|
|
265
306
|
* // type: "STRING_VALUE",
|
|
@@ -39,6 +39,7 @@ declare const RemoveAssistantAIAgentCommand_base: {
|
|
|
39
39
|
* const input = { // RemoveAssistantAIAgentRequest
|
|
40
40
|
* assistantId: "STRING_VALUE", // required
|
|
41
41
|
* aiAgentType: "STRING_VALUE", // required
|
|
42
|
+
* orchestratorUseCase: "STRING_VALUE",
|
|
42
43
|
* };
|
|
43
44
|
* const command = new RemoveAssistantAIAgentCommand(input);
|
|
44
45
|
* const response = await client.send(command);
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { RenderMessageTemplateRequest } from "../models/
|
|
4
|
-
import { RenderMessageTemplateResponse } from "../models/models_1";
|
|
3
|
+
import { RenderMessageTemplateRequest, RenderMessageTemplateResponse } from "../models/models_1";
|
|
5
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { RetrieveResponse } from "../models/models_0";
|
|
4
|
+
import { RetrieveRequest } from "../models/models_1";
|
|
5
|
+
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export type { __MetadataBearer };
|
|
10
|
+
export { $Command };
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*
|
|
14
|
+
* The input for {@link RetrieveCommand}.
|
|
15
|
+
*/
|
|
16
|
+
export interface RetrieveCommandInput extends RetrieveRequest {
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
*
|
|
21
|
+
* The output of {@link RetrieveCommand}.
|
|
22
|
+
*/
|
|
23
|
+
export interface RetrieveCommandOutput extends RetrieveResponse, __MetadataBearer {
|
|
24
|
+
}
|
|
25
|
+
declare const RetrieveCommand_base: {
|
|
26
|
+
new (input: RetrieveCommandInput): import("@smithy/smithy-client").CommandImpl<RetrieveCommandInput, RetrieveCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
new (input: RetrieveCommandInput): import("@smithy/smithy-client").CommandImpl<RetrieveCommandInput, RetrieveCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
28
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* <p>Retrieves content from knowledge sources based on a query.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { QConnectClient, RetrieveCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
36
|
+
* // const { QConnectClient, RetrieveCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
37
|
+
* // import type { QConnectClientConfig } from "@aws-sdk/client-qconnect";
|
|
38
|
+
* const config = {}; // type is QConnectClientConfig
|
|
39
|
+
* const client = new QConnectClient(config);
|
|
40
|
+
* const input = { // RetrieveRequest
|
|
41
|
+
* assistantId: "STRING_VALUE", // required
|
|
42
|
+
* retrievalConfiguration: { // RetrievalConfiguration
|
|
43
|
+
* knowledgeSource: { // KnowledgeSource Union: only one key present
|
|
44
|
+
* assistantAssociationIds: [ // AssistantAssociationIdList
|
|
45
|
+
* "STRING_VALUE",
|
|
46
|
+
* ],
|
|
47
|
+
* },
|
|
48
|
+
* filter: { // RetrievalFilterConfiguration Union: only one key present
|
|
49
|
+
* andAll: [ // RetrievalFilterList
|
|
50
|
+
* {// Union: only one key present
|
|
51
|
+
* andAll: [
|
|
52
|
+
* "<RetrievalFilterConfiguration>",
|
|
53
|
+
* ],
|
|
54
|
+
* equals: { // FilterAttribute
|
|
55
|
+
* key: "STRING_VALUE", // required
|
|
56
|
+
* value: "DOCUMENT_VALUE", // required
|
|
57
|
+
* },
|
|
58
|
+
* greaterThan: {
|
|
59
|
+
* key: "STRING_VALUE", // required
|
|
60
|
+
* value: "DOCUMENT_VALUE", // required
|
|
61
|
+
* },
|
|
62
|
+
* greaterThanOrEquals: {
|
|
63
|
+
* key: "STRING_VALUE", // required
|
|
64
|
+
* value: "DOCUMENT_VALUE", // required
|
|
65
|
+
* },
|
|
66
|
+
* in: {
|
|
67
|
+
* key: "STRING_VALUE", // required
|
|
68
|
+
* value: "DOCUMENT_VALUE", // required
|
|
69
|
+
* },
|
|
70
|
+
* lessThan: {
|
|
71
|
+
* key: "STRING_VALUE", // required
|
|
72
|
+
* value: "DOCUMENT_VALUE", // required
|
|
73
|
+
* },
|
|
74
|
+
* lessThanOrEquals: "<FilterAttribute>",
|
|
75
|
+
* listContains: "<FilterAttribute>",
|
|
76
|
+
* notEquals: "<FilterAttribute>",
|
|
77
|
+
* notIn: "<FilterAttribute>",
|
|
78
|
+
* orAll: [
|
|
79
|
+
* "<RetrievalFilterConfiguration>",
|
|
80
|
+
* ],
|
|
81
|
+
* startsWith: "<FilterAttribute>",
|
|
82
|
+
* stringContains: "<FilterAttribute>",
|
|
83
|
+
* },
|
|
84
|
+
* ],
|
|
85
|
+
* equals: "<FilterAttribute>",
|
|
86
|
+
* greaterThan: "<FilterAttribute>",
|
|
87
|
+
* greaterThanOrEquals: "<FilterAttribute>",
|
|
88
|
+
* in: "<FilterAttribute>",
|
|
89
|
+
* lessThan: "<FilterAttribute>",
|
|
90
|
+
* lessThanOrEquals: "<FilterAttribute>",
|
|
91
|
+
* listContains: "<FilterAttribute>",
|
|
92
|
+
* notEquals: "<FilterAttribute>",
|
|
93
|
+
* notIn: "<FilterAttribute>",
|
|
94
|
+
* orAll: [
|
|
95
|
+
* "<RetrievalFilterConfiguration>",
|
|
96
|
+
* ],
|
|
97
|
+
* startsWith: "<FilterAttribute>",
|
|
98
|
+
* stringContains: "<FilterAttribute>",
|
|
99
|
+
* },
|
|
100
|
+
* numberOfResults: Number("int"),
|
|
101
|
+
* overrideKnowledgeBaseSearchType: "STRING_VALUE",
|
|
102
|
+
* },
|
|
103
|
+
* retrievalQuery: "STRING_VALUE", // required
|
|
104
|
+
* };
|
|
105
|
+
* const command = new RetrieveCommand(input);
|
|
106
|
+
* const response = await client.send(command);
|
|
107
|
+
* // { // RetrieveResponse
|
|
108
|
+
* // results: [ // RetrieveResultList // required
|
|
109
|
+
* // { // RetrieveResult
|
|
110
|
+
* // associationId: "STRING_VALUE", // required
|
|
111
|
+
* // sourceId: "STRING_VALUE", // required
|
|
112
|
+
* // referenceType: "STRING_VALUE", // required
|
|
113
|
+
* // contentText: "STRING_VALUE", // required
|
|
114
|
+
* // },
|
|
115
|
+
* // ],
|
|
116
|
+
* // };
|
|
117
|
+
*
|
|
118
|
+
* ```
|
|
119
|
+
*
|
|
120
|
+
* @param RetrieveCommandInput - {@link RetrieveCommandInput}
|
|
121
|
+
* @returns {@link RetrieveCommandOutput}
|
|
122
|
+
* @see {@link RetrieveCommandInput} for command's `input` shape.
|
|
123
|
+
* @see {@link RetrieveCommandOutput} for command's `response` shape.
|
|
124
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
125
|
+
*
|
|
126
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
127
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link ConflictException} (client fault)
|
|
130
|
+
* <p>The request could not be processed because of conflict in the current state of the resource. For example, if you're using a <code>Create</code> API (such as <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.</p>
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link DependencyFailedException} (client fault)
|
|
133
|
+
* <p>The request failed because it depends on another request that failed.</p>
|
|
134
|
+
*
|
|
135
|
+
* @throws {@link RequestTimeoutException} (client fault)
|
|
136
|
+
* <p>The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.</p>
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
139
|
+
* <p>The specified resource does not exist.</p>
|
|
140
|
+
*
|
|
141
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
142
|
+
* <p>You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.</p>
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
145
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
146
|
+
*
|
|
147
|
+
* @throws {@link ValidationException} (client fault)
|
|
148
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
149
|
+
*
|
|
150
|
+
* @throws {@link QConnectServiceException}
|
|
151
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
152
|
+
*
|
|
153
|
+
*
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
export declare class RetrieveCommand extends RetrieveCommand_base {
|
|
157
|
+
/** @internal type navigation helper, not in runtime. */
|
|
158
|
+
protected static __types: {
|
|
159
|
+
api: {
|
|
160
|
+
input: RetrieveRequest;
|
|
161
|
+
output: RetrieveResponse;
|
|
162
|
+
};
|
|
163
|
+
sdk: {
|
|
164
|
+
input: RetrieveCommandInput;
|
|
165
|
+
output: RetrieveCommandOutput;
|
|
166
|
+
};
|
|
167
|
+
};
|
|
168
|
+
}
|
|
@@ -44,22 +44,51 @@ declare const SendMessageCommand_base: {
|
|
|
44
44
|
* value: { // MessageData Union: only one key present
|
|
45
45
|
* text: { // TextMessage
|
|
46
46
|
* value: "STRING_VALUE",
|
|
47
|
+
* citations: [ // Citations
|
|
48
|
+
* { // Citation
|
|
49
|
+
* contentId: "STRING_VALUE",
|
|
50
|
+
* title: "STRING_VALUE",
|
|
51
|
+
* knowledgeBaseId: "STRING_VALUE",
|
|
52
|
+
* citationSpan: { // CitationSpan
|
|
53
|
+
* beginOffsetInclusive: Number("int"),
|
|
54
|
+
* endOffsetExclusive: Number("int"),
|
|
55
|
+
* },
|
|
56
|
+
* sourceURL: "STRING_VALUE",
|
|
57
|
+
* referenceType: "STRING_VALUE", // required
|
|
58
|
+
* },
|
|
59
|
+
* ],
|
|
60
|
+
* aiGuardrailAssessment: { // AIGuardrailAssessment
|
|
61
|
+
* blocked: true || false, // required
|
|
62
|
+
* },
|
|
63
|
+
* },
|
|
64
|
+
* toolUseResult: { // ToolUseResultData
|
|
65
|
+
* toolUseId: "STRING_VALUE", // required
|
|
66
|
+
* toolName: "STRING_VALUE", // required
|
|
67
|
+
* toolResult: "DOCUMENT_VALUE", // required
|
|
68
|
+
* inputSchema: "DOCUMENT_VALUE",
|
|
47
69
|
* },
|
|
48
70
|
* },
|
|
49
71
|
* },
|
|
72
|
+
* aiAgentId: "STRING_VALUE",
|
|
50
73
|
* conversationContext: { // ConversationContext
|
|
51
74
|
* selfServiceConversationHistory: [ // SelfServiceConversationHistoryList // required
|
|
52
75
|
* { // SelfServiceConversationHistory
|
|
53
|
-
* turnNumber: Number("int"),
|
|
76
|
+
* turnNumber: Number("int"),
|
|
54
77
|
* inputTranscript: "STRING_VALUE",
|
|
55
78
|
* botResponse: "STRING_VALUE",
|
|
79
|
+
* timestamp: new Date("TIMESTAMP"),
|
|
56
80
|
* },
|
|
57
81
|
* ],
|
|
58
82
|
* },
|
|
59
83
|
* configuration: { // MessageConfiguration
|
|
60
84
|
* generateFillerMessage: true || false,
|
|
85
|
+
* generateChunkedMessage: true || false,
|
|
61
86
|
* },
|
|
62
87
|
* clientToken: "STRING_VALUE",
|
|
88
|
+
* orchestratorUseCase: "STRING_VALUE",
|
|
89
|
+
* metadata: { // MessageMetadata
|
|
90
|
+
* "<keys>": "STRING_VALUE",
|
|
91
|
+
* },
|
|
63
92
|
* };
|
|
64
93
|
* const command = new SendMessageCommand(input);
|
|
65
94
|
* const response = await client.send(command);
|
|
@@ -67,6 +96,7 @@ declare const SendMessageCommand_base: {
|
|
|
67
96
|
* // requestMessageId: "STRING_VALUE", // required
|
|
68
97
|
* // configuration: { // MessageConfiguration
|
|
69
98
|
* // generateFillerMessage: true || false,
|
|
99
|
+
* // generateChunkedMessage: true || false,
|
|
70
100
|
* // },
|
|
71
101
|
* // nextMessageToken: "STRING_VALUE", // required
|
|
72
102
|
* // };
|
|
@@ -85,12 +115,18 @@ declare const SendMessageCommand_base: {
|
|
|
85
115
|
* @throws {@link ConflictException} (client fault)
|
|
86
116
|
* <p>The request could not be processed because of conflict in the current state of the resource. For example, if you're using a <code>Create</code> API (such as <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.</p>
|
|
87
117
|
*
|
|
118
|
+
* @throws {@link DependencyFailedException} (client fault)
|
|
119
|
+
* <p>The request failed because it depends on another request that failed.</p>
|
|
120
|
+
*
|
|
88
121
|
* @throws {@link RequestTimeoutException} (client fault)
|
|
89
122
|
* <p>The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.</p>
|
|
90
123
|
*
|
|
91
124
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
92
125
|
* <p>The specified resource does not exist.</p>
|
|
93
126
|
*
|
|
127
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
128
|
+
* <p>You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.</p>
|
|
129
|
+
*
|
|
94
130
|
* @throws {@link ThrottlingException} (client fault)
|
|
95
131
|
* <p>The throttling limit has been exceeded.</p>
|
|
96
132
|
*
|
|
@@ -111,6 +111,9 @@ declare const UpdateAIAgentCommand_base: {
|
|
|
111
111
|
* },
|
|
112
112
|
* ],
|
|
113
113
|
* locale: "STRING_VALUE",
|
|
114
|
+
* suggestedMessages: [ // SuggestedMessagesList
|
|
115
|
+
* "STRING_VALUE",
|
|
116
|
+
* ],
|
|
114
117
|
* },
|
|
115
118
|
* selfServiceAIAgentConfiguration: { // SelfServiceAIAgentConfiguration
|
|
116
119
|
* selfServicePreProcessingAIPromptId: "STRING_VALUE",
|
|
@@ -199,6 +202,66 @@ declare const UpdateAIAgentCommand_base: {
|
|
|
199
202
|
* },
|
|
200
203
|
* ],
|
|
201
204
|
* },
|
|
205
|
+
* orchestrationAIAgentConfiguration: { // OrchestrationAIAgentConfiguration
|
|
206
|
+
* orchestrationAIPromptId: "STRING_VALUE", // required
|
|
207
|
+
* orchestrationAIGuardrailId: "STRING_VALUE",
|
|
208
|
+
* toolConfigurations: [ // ToolConfigurationList
|
|
209
|
+
* { // ToolConfiguration
|
|
210
|
+
* toolName: "STRING_VALUE", // required
|
|
211
|
+
* toolType: "STRING_VALUE", // required
|
|
212
|
+
* title: "STRING_VALUE",
|
|
213
|
+
* toolId: "STRING_VALUE",
|
|
214
|
+
* description: "STRING_VALUE",
|
|
215
|
+
* instruction: { // ToolInstruction
|
|
216
|
+
* instruction: "STRING_VALUE",
|
|
217
|
+
* examples: [ // ToolExampleList
|
|
218
|
+
* "STRING_VALUE",
|
|
219
|
+
* ],
|
|
220
|
+
* },
|
|
221
|
+
* overrideInputValues: [ // ToolOverrideInputValueList
|
|
222
|
+
* { // ToolOverrideInputValue
|
|
223
|
+
* jsonPath: "STRING_VALUE", // required
|
|
224
|
+
* value: { // ToolOverrideInputValueConfiguration Union: only one key present
|
|
225
|
+
* constant: { // ToolOverrideConstantInputValue
|
|
226
|
+
* type: "STRING_VALUE", // required
|
|
227
|
+
* value: "STRING_VALUE", // required
|
|
228
|
+
* },
|
|
229
|
+
* },
|
|
230
|
+
* },
|
|
231
|
+
* ],
|
|
232
|
+
* outputFilters: [ // ToolOutputFilterList
|
|
233
|
+
* { // ToolOutputFilter
|
|
234
|
+
* jsonPath: "STRING_VALUE", // required
|
|
235
|
+
* outputConfiguration: { // ToolOutputConfiguration
|
|
236
|
+
* outputVariableNameOverride: "STRING_VALUE",
|
|
237
|
+
* sessionDataNamespace: "STRING_VALUE",
|
|
238
|
+
* },
|
|
239
|
+
* },
|
|
240
|
+
* ],
|
|
241
|
+
* inputSchema: "DOCUMENT_VALUE",
|
|
242
|
+
* outputSchema: "DOCUMENT_VALUE",
|
|
243
|
+
* annotations: { // Annotation
|
|
244
|
+
* title: "STRING_VALUE",
|
|
245
|
+
* destructiveHint: true || false,
|
|
246
|
+
* },
|
|
247
|
+
* userInteractionConfiguration: { // UserInteractionConfiguration
|
|
248
|
+
* isUserConfirmationRequired: true || false,
|
|
249
|
+
* },
|
|
250
|
+
* },
|
|
251
|
+
* ],
|
|
252
|
+
* connectInstanceArn: "STRING_VALUE",
|
|
253
|
+
* locale: "STRING_VALUE",
|
|
254
|
+
* },
|
|
255
|
+
* noteTakingAIAgentConfiguration: { // NoteTakingAIAgentConfiguration
|
|
256
|
+
* noteTakingAIPromptId: "STRING_VALUE",
|
|
257
|
+
* noteTakingAIGuardrailId: "STRING_VALUE",
|
|
258
|
+
* locale: "STRING_VALUE",
|
|
259
|
+
* },
|
|
260
|
+
* caseSummarizationAIAgentConfiguration: { // CaseSummarizationAIAgentConfiguration
|
|
261
|
+
* caseSummarizationAIPromptId: "STRING_VALUE",
|
|
262
|
+
* caseSummarizationAIGuardrailId: "STRING_VALUE",
|
|
263
|
+
* locale: "STRING_VALUE",
|
|
264
|
+
* },
|
|
202
265
|
* },
|
|
203
266
|
* description: "STRING_VALUE",
|
|
204
267
|
* };
|
|
@@ -282,6 +345,9 @@ declare const UpdateAIAgentCommand_base: {
|
|
|
282
345
|
* // },
|
|
283
346
|
* // ],
|
|
284
347
|
* // locale: "STRING_VALUE",
|
|
348
|
+
* // suggestedMessages: [ // SuggestedMessagesList
|
|
349
|
+
* // "STRING_VALUE",
|
|
350
|
+
* // ],
|
|
285
351
|
* // },
|
|
286
352
|
* // selfServiceAIAgentConfiguration: { // SelfServiceAIAgentConfiguration
|
|
287
353
|
* // selfServicePreProcessingAIPromptId: "STRING_VALUE",
|
|
@@ -370,6 +436,66 @@ declare const UpdateAIAgentCommand_base: {
|
|
|
370
436
|
* // },
|
|
371
437
|
* // ],
|
|
372
438
|
* // },
|
|
439
|
+
* // orchestrationAIAgentConfiguration: { // OrchestrationAIAgentConfiguration
|
|
440
|
+
* // orchestrationAIPromptId: "STRING_VALUE", // required
|
|
441
|
+
* // orchestrationAIGuardrailId: "STRING_VALUE",
|
|
442
|
+
* // toolConfigurations: [ // ToolConfigurationList
|
|
443
|
+
* // { // ToolConfiguration
|
|
444
|
+
* // toolName: "STRING_VALUE", // required
|
|
445
|
+
* // toolType: "STRING_VALUE", // required
|
|
446
|
+
* // title: "STRING_VALUE",
|
|
447
|
+
* // toolId: "STRING_VALUE",
|
|
448
|
+
* // description: "STRING_VALUE",
|
|
449
|
+
* // instruction: { // ToolInstruction
|
|
450
|
+
* // instruction: "STRING_VALUE",
|
|
451
|
+
* // examples: [ // ToolExampleList
|
|
452
|
+
* // "STRING_VALUE",
|
|
453
|
+
* // ],
|
|
454
|
+
* // },
|
|
455
|
+
* // overrideInputValues: [ // ToolOverrideInputValueList
|
|
456
|
+
* // { // ToolOverrideInputValue
|
|
457
|
+
* // jsonPath: "STRING_VALUE", // required
|
|
458
|
+
* // value: { // ToolOverrideInputValueConfiguration Union: only one key present
|
|
459
|
+
* // constant: { // ToolOverrideConstantInputValue
|
|
460
|
+
* // type: "STRING_VALUE", // required
|
|
461
|
+
* // value: "STRING_VALUE", // required
|
|
462
|
+
* // },
|
|
463
|
+
* // },
|
|
464
|
+
* // },
|
|
465
|
+
* // ],
|
|
466
|
+
* // outputFilters: [ // ToolOutputFilterList
|
|
467
|
+
* // { // ToolOutputFilter
|
|
468
|
+
* // jsonPath: "STRING_VALUE", // required
|
|
469
|
+
* // outputConfiguration: { // ToolOutputConfiguration
|
|
470
|
+
* // outputVariableNameOverride: "STRING_VALUE",
|
|
471
|
+
* // sessionDataNamespace: "STRING_VALUE",
|
|
472
|
+
* // },
|
|
473
|
+
* // },
|
|
474
|
+
* // ],
|
|
475
|
+
* // inputSchema: "DOCUMENT_VALUE",
|
|
476
|
+
* // outputSchema: "DOCUMENT_VALUE",
|
|
477
|
+
* // annotations: { // Annotation
|
|
478
|
+
* // title: "STRING_VALUE",
|
|
479
|
+
* // destructiveHint: true || false,
|
|
480
|
+
* // },
|
|
481
|
+
* // userInteractionConfiguration: { // UserInteractionConfiguration
|
|
482
|
+
* // isUserConfirmationRequired: true || false,
|
|
483
|
+
* // },
|
|
484
|
+
* // },
|
|
485
|
+
* // ],
|
|
486
|
+
* // connectInstanceArn: "STRING_VALUE",
|
|
487
|
+
* // locale: "STRING_VALUE",
|
|
488
|
+
* // },
|
|
489
|
+
* // noteTakingAIAgentConfiguration: { // NoteTakingAIAgentConfiguration
|
|
490
|
+
* // noteTakingAIPromptId: "STRING_VALUE",
|
|
491
|
+
* // noteTakingAIGuardrailId: "STRING_VALUE",
|
|
492
|
+
* // locale: "STRING_VALUE",
|
|
493
|
+
* // },
|
|
494
|
+
* // caseSummarizationAIAgentConfiguration: { // CaseSummarizationAIAgentConfiguration
|
|
495
|
+
* // caseSummarizationAIPromptId: "STRING_VALUE",
|
|
496
|
+
* // caseSummarizationAIGuardrailId: "STRING_VALUE",
|
|
497
|
+
* // locale: "STRING_VALUE",
|
|
498
|
+
* // },
|
|
373
499
|
* // },
|
|
374
500
|
* // modifiedTime: new Date("TIMESTAMP"),
|
|
375
501
|
* // description: "STRING_VALUE",
|
|
@@ -48,6 +48,14 @@ declare const UpdateAIPromptCommand_base: {
|
|
|
48
48
|
* },
|
|
49
49
|
* description: "STRING_VALUE",
|
|
50
50
|
* modelId: "STRING_VALUE",
|
|
51
|
+
* inferenceConfiguration: { // AIPromptInferenceConfiguration Union: only one key present
|
|
52
|
+
* textAIPromptInferenceConfiguration: { // TextAIPromptInferenceConfiguration
|
|
53
|
+
* temperature: Number("float"),
|
|
54
|
+
* topP: Number("float"),
|
|
55
|
+
* topK: Number("int"),
|
|
56
|
+
* maxTokensToSample: Number("int"),
|
|
57
|
+
* },
|
|
58
|
+
* },
|
|
51
59
|
* };
|
|
52
60
|
* const command = new UpdateAIPromptCommand(input);
|
|
53
61
|
* const response = await client.send(command);
|
|
@@ -67,6 +75,14 @@ declare const UpdateAIPromptCommand_base: {
|
|
|
67
75
|
* // text: "STRING_VALUE", // required
|
|
68
76
|
* // },
|
|
69
77
|
* // },
|
|
78
|
+
* // inferenceConfiguration: { // AIPromptInferenceConfiguration Union: only one key present
|
|
79
|
+
* // textAIPromptInferenceConfiguration: { // TextAIPromptInferenceConfiguration
|
|
80
|
+
* // temperature: Number("float"),
|
|
81
|
+
* // topP: Number("float"),
|
|
82
|
+
* // topK: Number("int"),
|
|
83
|
+
* // maxTokensToSample: Number("int"),
|
|
84
|
+
* // },
|
|
85
|
+
* // },
|
|
70
86
|
* // modifiedTime: new Date("TIMESTAMP"),
|
|
71
87
|
* // description: "STRING_VALUE",
|
|
72
88
|
* // visibilityStatus: "STRING_VALUE", // required
|
|
@@ -42,6 +42,12 @@ declare const UpdateAssistantAIAgentCommand_base: {
|
|
|
42
42
|
* configuration: { // AIAgentConfigurationData
|
|
43
43
|
* aiAgentId: "STRING_VALUE", // required
|
|
44
44
|
* },
|
|
45
|
+
* orchestratorConfigurationList: [ // OrchestratorConfigurationList
|
|
46
|
+
* { // OrchestratorConfigurationEntry
|
|
47
|
+
* aiAgentId: "STRING_VALUE",
|
|
48
|
+
* orchestratorUseCase: "STRING_VALUE", // required
|
|
49
|
+
* },
|
|
50
|
+
* ],
|
|
45
51
|
* };
|
|
46
52
|
* const command = new UpdateAssistantAIAgentCommand(input);
|
|
47
53
|
* const response = await client.send(command);
|
|
@@ -70,6 +76,12 @@ declare const UpdateAssistantAIAgentCommand_base: {
|
|
|
70
76
|
* // aiAgentId: "STRING_VALUE", // required
|
|
71
77
|
* // },
|
|
72
78
|
* // },
|
|
79
|
+
* // orchestratorConfigurationList: [ // OrchestratorConfigurationList
|
|
80
|
+
* // { // OrchestratorConfigurationEntry
|
|
81
|
+
* // aiAgentId: "STRING_VALUE",
|
|
82
|
+
* // orchestratorUseCase: "STRING_VALUE", // required
|
|
83
|
+
* // },
|
|
84
|
+
* // ],
|
|
73
85
|
* // },
|
|
74
86
|
* // };
|
|
75
87
|
*
|
|
@@ -65,6 +65,13 @@ declare const UpdateSessionCommand_base: {
|
|
|
65
65
|
* aiAgentId: "STRING_VALUE", // required
|
|
66
66
|
* },
|
|
67
67
|
* },
|
|
68
|
+
* orchestratorConfigurationList: [ // OrchestratorConfigurationList
|
|
69
|
+
* { // OrchestratorConfigurationEntry
|
|
70
|
+
* aiAgentId: "STRING_VALUE",
|
|
71
|
+
* orchestratorUseCase: "STRING_VALUE", // required
|
|
72
|
+
* },
|
|
73
|
+
* ],
|
|
74
|
+
* removeOrchestratorConfigurationList: true || false,
|
|
68
75
|
* };
|
|
69
76
|
* const command = new UpdateSessionCommand(input);
|
|
70
77
|
* const response = await client.send(command);
|
|
@@ -106,6 +113,12 @@ declare const UpdateSessionCommand_base: {
|
|
|
106
113
|
* // },
|
|
107
114
|
* // },
|
|
108
115
|
* // origin: "STRING_VALUE",
|
|
116
|
+
* // orchestratorConfigurationList: [ // OrchestratorConfigurationList
|
|
117
|
+
* // { // OrchestratorConfigurationEntry
|
|
118
|
+
* // aiAgentId: "STRING_VALUE",
|
|
119
|
+
* // orchestratorUseCase: "STRING_VALUE", // required
|
|
120
|
+
* // },
|
|
121
|
+
* // ],
|
|
109
122
|
* // },
|
|
110
123
|
* // };
|
|
111
124
|
*
|
|
@@ -62,6 +62,7 @@ export * from "./ListMessageTemplateVersionsCommand";
|
|
|
62
62
|
export * from "./ListMessageTemplatesCommand";
|
|
63
63
|
export * from "./ListMessagesCommand";
|
|
64
64
|
export * from "./ListQuickResponsesCommand";
|
|
65
|
+
export * from "./ListSpansCommand";
|
|
65
66
|
export * from "./ListTagsForResourceCommand";
|
|
66
67
|
export * from "./NotifyRecommendationsReceivedCommand";
|
|
67
68
|
export * from "./PutFeedbackCommand";
|
|
@@ -69,6 +70,7 @@ export * from "./QueryAssistantCommand";
|
|
|
69
70
|
export * from "./RemoveAssistantAIAgentCommand";
|
|
70
71
|
export * from "./RemoveKnowledgeBaseTemplateUriCommand";
|
|
71
72
|
export * from "./RenderMessageTemplateCommand";
|
|
73
|
+
export * from "./RetrieveCommand";
|
|
72
74
|
export * from "./SearchContentCommand";
|
|
73
75
|
export * from "./SearchMessageTemplatesCommand";
|
|
74
76
|
export * from "./SearchQuickResponsesCommand";
|