@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
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { GetMessageTemplateRequest, GetMessageTemplateResponse } from "../models/
|
|
3
|
+
import { GetMessageTemplateRequest, GetMessageTemplateResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -49,6 +49,28 @@ declare const GetNextMessageCommand_base: {
|
|
|
49
49
|
* // value: { // MessageData Union: only one key present
|
|
50
50
|
* // text: { // TextMessage
|
|
51
51
|
* // value: "STRING_VALUE",
|
|
52
|
+
* // citations: [ // Citations
|
|
53
|
+
* // { // Citation
|
|
54
|
+
* // contentId: "STRING_VALUE",
|
|
55
|
+
* // title: "STRING_VALUE",
|
|
56
|
+
* // knowledgeBaseId: "STRING_VALUE",
|
|
57
|
+
* // citationSpan: { // CitationSpan
|
|
58
|
+
* // beginOffsetInclusive: Number("int"),
|
|
59
|
+
* // endOffsetExclusive: Number("int"),
|
|
60
|
+
* // },
|
|
61
|
+
* // sourceURL: "STRING_VALUE",
|
|
62
|
+
* // referenceType: "STRING_VALUE", // required
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // aiGuardrailAssessment: { // AIGuardrailAssessment
|
|
66
|
+
* // blocked: true || false, // required
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // toolUseResult: { // ToolUseResultData
|
|
70
|
+
* // toolUseId: "STRING_VALUE", // required
|
|
71
|
+
* // toolName: "STRING_VALUE", // required
|
|
72
|
+
* // toolResult: "DOCUMENT_VALUE", // required
|
|
73
|
+
* // inputSchema: "DOCUMENT_VALUE",
|
|
52
74
|
* // },
|
|
53
75
|
* // },
|
|
54
76
|
* // messageId: "STRING_VALUE", // required
|
|
@@ -69,6 +91,7 @@ declare const GetNextMessageCommand_base: {
|
|
|
69
91
|
* // },
|
|
70
92
|
* // },
|
|
71
93
|
* // ],
|
|
94
|
+
* // chunkedResponseTerminated: true || false,
|
|
72
95
|
* // };
|
|
73
96
|
*
|
|
74
97
|
* ```
|
|
@@ -85,6 +108,9 @@ declare const GetNextMessageCommand_base: {
|
|
|
85
108
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
86
109
|
* <p>The specified resource does not exist.</p>
|
|
87
110
|
*
|
|
111
|
+
* @throws {@link UnprocessableContentException} (client fault)
|
|
112
|
+
* <p>The server has a failure of processing the message</p>
|
|
113
|
+
*
|
|
88
114
|
* @throws {@link ValidationException} (client fault)
|
|
89
115
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
90
116
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { GetQuickResponseRequest, GetQuickResponseResponse } from "../models/
|
|
3
|
+
import { GetQuickResponseRequest, GetQuickResponseResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -45,6 +45,7 @@ declare const GetRecommendationsCommand_base: {
|
|
|
45
45
|
* maxResults: Number("int"),
|
|
46
46
|
* waitTimeSeconds: Number("int"),
|
|
47
47
|
* nextChunkToken: "STRING_VALUE",
|
|
48
|
+
* recommendationType: "STRING_VALUE",
|
|
48
49
|
* };
|
|
49
50
|
* const command = new GetRecommendationsCommand(input);
|
|
50
51
|
* const response = await client.send(command);
|
|
@@ -97,6 +98,10 @@ declare const GetRecommendationsCommand_base: {
|
|
|
97
98
|
* // modelId: "STRING_VALUE",
|
|
98
99
|
* // generationId: "STRING_VALUE",
|
|
99
100
|
* // },
|
|
101
|
+
* // suggestedMessageReference: { // SuggestedMessageReference
|
|
102
|
+
* // aiAgentId: "STRING_VALUE", // required
|
|
103
|
+
* // aiAgentArn: "STRING_VALUE", // required
|
|
104
|
+
* // },
|
|
100
105
|
* // },
|
|
101
106
|
* // details: { // DataDetails Union: only one key present
|
|
102
107
|
* // contentData: { // ContentDataDetails
|
|
@@ -135,6 +140,10 @@ declare const GetRecommendationsCommand_base: {
|
|
|
135
140
|
* // modelId: "STRING_VALUE",
|
|
136
141
|
* // generationId: "STRING_VALUE",
|
|
137
142
|
* // },
|
|
143
|
+
* // suggestedMessageReference: {
|
|
144
|
+
* // aiAgentId: "STRING_VALUE", // required
|
|
145
|
+
* // aiAgentArn: "STRING_VALUE", // required
|
|
146
|
+
* // },
|
|
138
147
|
* // },
|
|
139
148
|
* // details: {// Union: only one key present
|
|
140
149
|
* // contentData: {
|
|
@@ -160,6 +169,7 @@ declare const GetRecommendationsCommand_base: {
|
|
|
160
169
|
* // intentDetectedData: { // IntentDetectedDataDetails
|
|
161
170
|
* // intent: "STRING_VALUE", // required
|
|
162
171
|
* // intentId: "STRING_VALUE", // required
|
|
172
|
+
* // relevanceLevel: "STRING_VALUE",
|
|
163
173
|
* // },
|
|
164
174
|
* // sourceContentData: { // SourceContentDataDetails
|
|
165
175
|
* // id: "STRING_VALUE", // required
|
|
@@ -199,6 +209,20 @@ declare const GetRecommendationsCommand_base: {
|
|
|
199
209
|
* // ],
|
|
200
210
|
* // nextChunkToken: "STRING_VALUE",
|
|
201
211
|
* // },
|
|
212
|
+
* // caseSummarizationChunkData: { // CaseSummarizationChunkDataDetails
|
|
213
|
+
* // completion: "STRING_VALUE",
|
|
214
|
+
* // nextChunkToken: "STRING_VALUE",
|
|
215
|
+
* // },
|
|
216
|
+
* // suggestedMessageData: { // SuggestedMessageDataDetails
|
|
217
|
+
* // messageText: "STRING_VALUE", // required
|
|
218
|
+
* // },
|
|
219
|
+
* // notesData: { // NotesDataDetails
|
|
220
|
+
* // completion: "STRING_VALUE",
|
|
221
|
+
* // },
|
|
222
|
+
* // notesChunkData: { // NotesChunkDataDetails
|
|
223
|
+
* // completion: "STRING_VALUE",
|
|
224
|
+
* // nextChunkToken: "STRING_VALUE",
|
|
225
|
+
* // },
|
|
202
226
|
* // },
|
|
203
227
|
* // },
|
|
204
228
|
* // ],
|
|
@@ -210,6 +234,7 @@ declare const GetRecommendationsCommand_base: {
|
|
|
210
234
|
* // intentDetectedData: {
|
|
211
235
|
* // intent: "STRING_VALUE", // required
|
|
212
236
|
* // intentId: "STRING_VALUE", // required
|
|
237
|
+
* // relevanceLevel: "STRING_VALUE",
|
|
213
238
|
* // },
|
|
214
239
|
* // sourceContentData: {
|
|
215
240
|
* // id: "STRING_VALUE", // required
|
|
@@ -244,6 +269,20 @@ declare const GetRecommendationsCommand_base: {
|
|
|
244
269
|
* // references: "<DataSummaryList>",
|
|
245
270
|
* // nextChunkToken: "STRING_VALUE",
|
|
246
271
|
* // },
|
|
272
|
+
* // caseSummarizationChunkData: {
|
|
273
|
+
* // completion: "STRING_VALUE",
|
|
274
|
+
* // nextChunkToken: "STRING_VALUE",
|
|
275
|
+
* // },
|
|
276
|
+
* // suggestedMessageData: {
|
|
277
|
+
* // messageText: "STRING_VALUE", // required
|
|
278
|
+
* // },
|
|
279
|
+
* // notesData: {
|
|
280
|
+
* // completion: "STRING_VALUE",
|
|
281
|
+
* // },
|
|
282
|
+
* // notesChunkData: {
|
|
283
|
+
* // completion: "STRING_VALUE",
|
|
284
|
+
* // nextChunkToken: "STRING_VALUE",
|
|
285
|
+
* // },
|
|
247
286
|
* // },
|
|
248
287
|
* // },
|
|
249
288
|
* // },
|
|
@@ -80,6 +80,12 @@ declare const GetSessionCommand_base: {
|
|
|
80
80
|
* // },
|
|
81
81
|
* // },
|
|
82
82
|
* // origin: "STRING_VALUE",
|
|
83
|
+
* // orchestratorConfigurationList: [ // OrchestratorConfigurationList
|
|
84
|
+
* // { // OrchestratorConfigurationEntry
|
|
85
|
+
* // aiAgentId: "STRING_VALUE",
|
|
86
|
+
* // orchestratorUseCase: "STRING_VALUE", // required
|
|
87
|
+
* // },
|
|
88
|
+
* // ],
|
|
83
89
|
* // },
|
|
84
90
|
* // };
|
|
85
91
|
*
|
|
@@ -127,6 +127,9 @@ declare const ListAIAgentVersionsCommand_base: {
|
|
|
127
127
|
* // },
|
|
128
128
|
* // ],
|
|
129
129
|
* // locale: "STRING_VALUE",
|
|
130
|
+
* // suggestedMessages: [ // SuggestedMessagesList
|
|
131
|
+
* // "STRING_VALUE",
|
|
132
|
+
* // ],
|
|
130
133
|
* // },
|
|
131
134
|
* // selfServiceAIAgentConfiguration: { // SelfServiceAIAgentConfiguration
|
|
132
135
|
* // selfServicePreProcessingAIPromptId: "STRING_VALUE",
|
|
@@ -215,6 +218,66 @@ declare const ListAIAgentVersionsCommand_base: {
|
|
|
215
218
|
* // },
|
|
216
219
|
* // ],
|
|
217
220
|
* // },
|
|
221
|
+
* // orchestrationAIAgentConfiguration: { // OrchestrationAIAgentConfiguration
|
|
222
|
+
* // orchestrationAIPromptId: "STRING_VALUE", // required
|
|
223
|
+
* // orchestrationAIGuardrailId: "STRING_VALUE",
|
|
224
|
+
* // toolConfigurations: [ // ToolConfigurationList
|
|
225
|
+
* // { // ToolConfiguration
|
|
226
|
+
* // toolName: "STRING_VALUE", // required
|
|
227
|
+
* // toolType: "STRING_VALUE", // required
|
|
228
|
+
* // title: "STRING_VALUE",
|
|
229
|
+
* // toolId: "STRING_VALUE",
|
|
230
|
+
* // description: "STRING_VALUE",
|
|
231
|
+
* // instruction: { // ToolInstruction
|
|
232
|
+
* // instruction: "STRING_VALUE",
|
|
233
|
+
* // examples: [ // ToolExampleList
|
|
234
|
+
* // "STRING_VALUE",
|
|
235
|
+
* // ],
|
|
236
|
+
* // },
|
|
237
|
+
* // overrideInputValues: [ // ToolOverrideInputValueList
|
|
238
|
+
* // { // ToolOverrideInputValue
|
|
239
|
+
* // jsonPath: "STRING_VALUE", // required
|
|
240
|
+
* // value: { // ToolOverrideInputValueConfiguration Union: only one key present
|
|
241
|
+
* // constant: { // ToolOverrideConstantInputValue
|
|
242
|
+
* // type: "STRING_VALUE", // required
|
|
243
|
+
* // value: "STRING_VALUE", // required
|
|
244
|
+
* // },
|
|
245
|
+
* // },
|
|
246
|
+
* // },
|
|
247
|
+
* // ],
|
|
248
|
+
* // outputFilters: [ // ToolOutputFilterList
|
|
249
|
+
* // { // ToolOutputFilter
|
|
250
|
+
* // jsonPath: "STRING_VALUE", // required
|
|
251
|
+
* // outputConfiguration: { // ToolOutputConfiguration
|
|
252
|
+
* // outputVariableNameOverride: "STRING_VALUE",
|
|
253
|
+
* // sessionDataNamespace: "STRING_VALUE",
|
|
254
|
+
* // },
|
|
255
|
+
* // },
|
|
256
|
+
* // ],
|
|
257
|
+
* // inputSchema: "DOCUMENT_VALUE",
|
|
258
|
+
* // outputSchema: "DOCUMENT_VALUE",
|
|
259
|
+
* // annotations: { // Annotation
|
|
260
|
+
* // title: "STRING_VALUE",
|
|
261
|
+
* // destructiveHint: true || false,
|
|
262
|
+
* // },
|
|
263
|
+
* // userInteractionConfiguration: { // UserInteractionConfiguration
|
|
264
|
+
* // isUserConfirmationRequired: true || false,
|
|
265
|
+
* // },
|
|
266
|
+
* // },
|
|
267
|
+
* // ],
|
|
268
|
+
* // connectInstanceArn: "STRING_VALUE",
|
|
269
|
+
* // locale: "STRING_VALUE",
|
|
270
|
+
* // },
|
|
271
|
+
* // noteTakingAIAgentConfiguration: { // NoteTakingAIAgentConfiguration
|
|
272
|
+
* // noteTakingAIPromptId: "STRING_VALUE",
|
|
273
|
+
* // noteTakingAIGuardrailId: "STRING_VALUE",
|
|
274
|
+
* // locale: "STRING_VALUE",
|
|
275
|
+
* // },
|
|
276
|
+
* // caseSummarizationAIAgentConfiguration: { // CaseSummarizationAIAgentConfiguration
|
|
277
|
+
* // caseSummarizationAIPromptId: "STRING_VALUE",
|
|
278
|
+
* // caseSummarizationAIGuardrailId: "STRING_VALUE",
|
|
279
|
+
* // locale: "STRING_VALUE",
|
|
280
|
+
* // },
|
|
218
281
|
* // },
|
|
219
282
|
* // origin: "STRING_VALUE",
|
|
220
283
|
* // description: "STRING_VALUE",
|
|
@@ -125,6 +125,9 @@ declare const ListAIAgentsCommand_base: {
|
|
|
125
125
|
* // },
|
|
126
126
|
* // ],
|
|
127
127
|
* // locale: "STRING_VALUE",
|
|
128
|
+
* // suggestedMessages: [ // SuggestedMessagesList
|
|
129
|
+
* // "STRING_VALUE",
|
|
130
|
+
* // ],
|
|
128
131
|
* // },
|
|
129
132
|
* // selfServiceAIAgentConfiguration: { // SelfServiceAIAgentConfiguration
|
|
130
133
|
* // selfServicePreProcessingAIPromptId: "STRING_VALUE",
|
|
@@ -213,6 +216,66 @@ declare const ListAIAgentsCommand_base: {
|
|
|
213
216
|
* // },
|
|
214
217
|
* // ],
|
|
215
218
|
* // },
|
|
219
|
+
* // orchestrationAIAgentConfiguration: { // OrchestrationAIAgentConfiguration
|
|
220
|
+
* // orchestrationAIPromptId: "STRING_VALUE", // required
|
|
221
|
+
* // orchestrationAIGuardrailId: "STRING_VALUE",
|
|
222
|
+
* // toolConfigurations: [ // ToolConfigurationList
|
|
223
|
+
* // { // ToolConfiguration
|
|
224
|
+
* // toolName: "STRING_VALUE", // required
|
|
225
|
+
* // toolType: "STRING_VALUE", // required
|
|
226
|
+
* // title: "STRING_VALUE",
|
|
227
|
+
* // toolId: "STRING_VALUE",
|
|
228
|
+
* // description: "STRING_VALUE",
|
|
229
|
+
* // instruction: { // ToolInstruction
|
|
230
|
+
* // instruction: "STRING_VALUE",
|
|
231
|
+
* // examples: [ // ToolExampleList
|
|
232
|
+
* // "STRING_VALUE",
|
|
233
|
+
* // ],
|
|
234
|
+
* // },
|
|
235
|
+
* // overrideInputValues: [ // ToolOverrideInputValueList
|
|
236
|
+
* // { // ToolOverrideInputValue
|
|
237
|
+
* // jsonPath: "STRING_VALUE", // required
|
|
238
|
+
* // value: { // ToolOverrideInputValueConfiguration Union: only one key present
|
|
239
|
+
* // constant: { // ToolOverrideConstantInputValue
|
|
240
|
+
* // type: "STRING_VALUE", // required
|
|
241
|
+
* // value: "STRING_VALUE", // required
|
|
242
|
+
* // },
|
|
243
|
+
* // },
|
|
244
|
+
* // },
|
|
245
|
+
* // ],
|
|
246
|
+
* // outputFilters: [ // ToolOutputFilterList
|
|
247
|
+
* // { // ToolOutputFilter
|
|
248
|
+
* // jsonPath: "STRING_VALUE", // required
|
|
249
|
+
* // outputConfiguration: { // ToolOutputConfiguration
|
|
250
|
+
* // outputVariableNameOverride: "STRING_VALUE",
|
|
251
|
+
* // sessionDataNamespace: "STRING_VALUE",
|
|
252
|
+
* // },
|
|
253
|
+
* // },
|
|
254
|
+
* // ],
|
|
255
|
+
* // inputSchema: "DOCUMENT_VALUE",
|
|
256
|
+
* // outputSchema: "DOCUMENT_VALUE",
|
|
257
|
+
* // annotations: { // Annotation
|
|
258
|
+
* // title: "STRING_VALUE",
|
|
259
|
+
* // destructiveHint: true || false,
|
|
260
|
+
* // },
|
|
261
|
+
* // userInteractionConfiguration: { // UserInteractionConfiguration
|
|
262
|
+
* // isUserConfirmationRequired: true || false,
|
|
263
|
+
* // },
|
|
264
|
+
* // },
|
|
265
|
+
* // ],
|
|
266
|
+
* // connectInstanceArn: "STRING_VALUE",
|
|
267
|
+
* // locale: "STRING_VALUE",
|
|
268
|
+
* // },
|
|
269
|
+
* // noteTakingAIAgentConfiguration: { // NoteTakingAIAgentConfiguration
|
|
270
|
+
* // noteTakingAIPromptId: "STRING_VALUE",
|
|
271
|
+
* // noteTakingAIGuardrailId: "STRING_VALUE",
|
|
272
|
+
* // locale: "STRING_VALUE",
|
|
273
|
+
* // },
|
|
274
|
+
* // caseSummarizationAIAgentConfiguration: { // CaseSummarizationAIAgentConfiguration
|
|
275
|
+
* // caseSummarizationAIPromptId: "STRING_VALUE",
|
|
276
|
+
* // caseSummarizationAIGuardrailId: "STRING_VALUE",
|
|
277
|
+
* // locale: "STRING_VALUE",
|
|
278
|
+
* // },
|
|
216
279
|
* // },
|
|
217
280
|
* // origin: "STRING_VALUE",
|
|
218
281
|
* // description: "STRING_VALUE",
|
|
@@ -56,6 +56,10 @@ declare const ListAssistantAssociationsCommand_base: {
|
|
|
56
56
|
* // knowledgeBaseId: "STRING_VALUE",
|
|
57
57
|
* // knowledgeBaseArn: "STRING_VALUE",
|
|
58
58
|
* // },
|
|
59
|
+
* // externalBedrockKnowledgeBaseConfig: { // ExternalBedrockKnowledgeBaseConfig
|
|
60
|
+
* // bedrockKnowledgeBaseArn: "STRING_VALUE", // required
|
|
61
|
+
* // accessRoleArn: "STRING_VALUE", // required
|
|
62
|
+
* // },
|
|
59
63
|
* // },
|
|
60
64
|
* // tags: { // Tags
|
|
61
65
|
* // "<keys>": "STRING_VALUE",
|
|
@@ -68,6 +68,12 @@ declare const ListAssistantsCommand_base: {
|
|
|
68
68
|
* // aiAgentId: "STRING_VALUE", // required
|
|
69
69
|
* // },
|
|
70
70
|
* // },
|
|
71
|
+
* // orchestratorConfigurationList: [ // OrchestratorConfigurationList
|
|
72
|
+
* // { // OrchestratorConfigurationEntry
|
|
73
|
+
* // aiAgentId: "STRING_VALUE",
|
|
74
|
+
* // orchestratorUseCase: "STRING_VALUE", // required
|
|
75
|
+
* // },
|
|
76
|
+
* // ],
|
|
71
77
|
* // },
|
|
72
78
|
* // ],
|
|
73
79
|
* // nextToken: "STRING_VALUE",
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { ListImportJobsRequest, ListImportJobsResponse } from "../models/
|
|
3
|
+
import { ListImportJobsRequest, ListImportJobsResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { ListKnowledgeBasesRequest, ListKnowledgeBasesResponse } from "../models/
|
|
3
|
+
import { ListKnowledgeBasesRequest, ListKnowledgeBasesResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { ListMessageTemplateVersionsRequest, ListMessageTemplateVersionsResponse } from "../models/
|
|
3
|
+
import { ListMessageTemplateVersionsRequest, ListMessageTemplateVersionsResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { ListMessageTemplatesRequest, ListMessageTemplatesResponse } from "../models/
|
|
3
|
+
import { ListMessageTemplatesRequest, ListMessageTemplatesResponse } from "../models/models_1";
|
|
4
4
|
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -41,6 +41,7 @@ declare const ListMessagesCommand_base: {
|
|
|
41
41
|
* sessionId: "STRING_VALUE", // required
|
|
42
42
|
* nextToken: "STRING_VALUE",
|
|
43
43
|
* maxResults: Number("int"),
|
|
44
|
+
* filter: "STRING_VALUE",
|
|
44
45
|
* };
|
|
45
46
|
* const command = new ListMessagesCommand(input);
|
|
46
47
|
* const response = await client.send(command);
|
|
@@ -50,6 +51,28 @@ declare const ListMessagesCommand_base: {
|
|
|
50
51
|
* // value: { // MessageData Union: only one key present
|
|
51
52
|
* // text: { // TextMessage
|
|
52
53
|
* // value: "STRING_VALUE",
|
|
54
|
+
* // citations: [ // Citations
|
|
55
|
+
* // { // Citation
|
|
56
|
+
* // contentId: "STRING_VALUE",
|
|
57
|
+
* // title: "STRING_VALUE",
|
|
58
|
+
* // knowledgeBaseId: "STRING_VALUE",
|
|
59
|
+
* // citationSpan: { // CitationSpan
|
|
60
|
+
* // beginOffsetInclusive: Number("int"),
|
|
61
|
+
* // endOffsetExclusive: Number("int"),
|
|
62
|
+
* // },
|
|
63
|
+
* // sourceURL: "STRING_VALUE",
|
|
64
|
+
* // referenceType: "STRING_VALUE", // required
|
|
65
|
+
* // },
|
|
66
|
+
* // ],
|
|
67
|
+
* // aiGuardrailAssessment: { // AIGuardrailAssessment
|
|
68
|
+
* // blocked: true || false, // required
|
|
69
|
+
* // },
|
|
70
|
+
* // },
|
|
71
|
+
* // toolUseResult: { // ToolUseResultData
|
|
72
|
+
* // toolUseId: "STRING_VALUE", // required
|
|
73
|
+
* // toolName: "STRING_VALUE", // required
|
|
74
|
+
* // toolResult: "DOCUMENT_VALUE", // required
|
|
75
|
+
* // inputSchema: "DOCUMENT_VALUE",
|
|
53
76
|
* // },
|
|
54
77
|
* // },
|
|
55
78
|
* // messageId: "STRING_VALUE", // required
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListSpansRequest } from "../models/models_0";
|
|
4
|
+
import { ListSpansResponse } 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 ListSpansCommand}.
|
|
15
|
+
*/
|
|
16
|
+
export interface ListSpansCommandInput extends ListSpansRequest {
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
*
|
|
21
|
+
* The output of {@link ListSpansCommand}.
|
|
22
|
+
*/
|
|
23
|
+
export interface ListSpansCommandOutput extends ListSpansResponse, __MetadataBearer {
|
|
24
|
+
}
|
|
25
|
+
declare const ListSpansCommand_base: {
|
|
26
|
+
new (input: ListSpansCommandInput): import("@smithy/smithy-client").CommandImpl<ListSpansCommandInput, ListSpansCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
new (input: ListSpansCommandInput): import("@smithy/smithy-client").CommandImpl<ListSpansCommandInput, ListSpansCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
28
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* <p>Retrieves AI agent execution traces for a session, providing granular visibility into agent orchestration flows, LLM interactions, and tool invocations.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { QConnectClient, ListSpansCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
36
|
+
* // const { QConnectClient, ListSpansCommand } = 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 = { // ListSpansRequest
|
|
41
|
+
* assistantId: "STRING_VALUE", // required
|
|
42
|
+
* sessionId: "STRING_VALUE", // required
|
|
43
|
+
* nextToken: "STRING_VALUE",
|
|
44
|
+
* maxResults: Number("int"),
|
|
45
|
+
* };
|
|
46
|
+
* const command = new ListSpansCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // ListSpansResponse
|
|
49
|
+
* // spans: [ // SpanList // required
|
|
50
|
+
* // { // Span
|
|
51
|
+
* // spanId: "STRING_VALUE", // required
|
|
52
|
+
* // assistantId: "STRING_VALUE", // required
|
|
53
|
+
* // sessionId: "STRING_VALUE", // required
|
|
54
|
+
* // parentSpanId: "STRING_VALUE",
|
|
55
|
+
* // spanName: "STRING_VALUE", // required
|
|
56
|
+
* // spanType: "STRING_VALUE", // required
|
|
57
|
+
* // startTimestamp: new Date("TIMESTAMP"), // required
|
|
58
|
+
* // endTimestamp: new Date("TIMESTAMP"), // required
|
|
59
|
+
* // status: "STRING_VALUE", // required
|
|
60
|
+
* // requestId: "STRING_VALUE", // required
|
|
61
|
+
* // attributes: { // SpanAttributes
|
|
62
|
+
* // operationName: "STRING_VALUE",
|
|
63
|
+
* // providerName: "STRING_VALUE",
|
|
64
|
+
* // errorType: "STRING_VALUE",
|
|
65
|
+
* // agentId: "STRING_VALUE",
|
|
66
|
+
* // instanceArn: "STRING_VALUE",
|
|
67
|
+
* // contactId: "STRING_VALUE",
|
|
68
|
+
* // initialContactId: "STRING_VALUE",
|
|
69
|
+
* // sessionName: "STRING_VALUE",
|
|
70
|
+
* // aiAgentArn: "STRING_VALUE",
|
|
71
|
+
* // aiAgentType: "STRING_VALUE",
|
|
72
|
+
* // aiAgentName: "STRING_VALUE",
|
|
73
|
+
* // aiAgentId: "STRING_VALUE",
|
|
74
|
+
* // aiAgentVersion: Number("int"),
|
|
75
|
+
* // aiAgentInvoker: "STRING_VALUE",
|
|
76
|
+
* // aiAgentOrchestratorUseCase: "STRING_VALUE",
|
|
77
|
+
* // requestModel: "STRING_VALUE",
|
|
78
|
+
* // requestMaxTokens: Number("int"),
|
|
79
|
+
* // temperature: Number("float"),
|
|
80
|
+
* // topP: Number("float"),
|
|
81
|
+
* // responseModel: "STRING_VALUE",
|
|
82
|
+
* // responseFinishReasons: [ // SpanFinishReasonList
|
|
83
|
+
* // "STRING_VALUE",
|
|
84
|
+
* // ],
|
|
85
|
+
* // usageInputTokens: Number("int"),
|
|
86
|
+
* // usageOutputTokens: Number("int"),
|
|
87
|
+
* // usageTotalTokens: Number("int"),
|
|
88
|
+
* // cacheReadInputTokens: Number("int"),
|
|
89
|
+
* // cacheWriteInputTokens: Number("int"),
|
|
90
|
+
* // inputMessages: [ // SpanMessageList
|
|
91
|
+
* // { // SpanMessage
|
|
92
|
+
* // messageId: "STRING_VALUE", // required
|
|
93
|
+
* // participant: "STRING_VALUE", // required
|
|
94
|
+
* // timestamp: new Date("TIMESTAMP"), // required
|
|
95
|
+
* // values: [ // SpanMessageValueList // required
|
|
96
|
+
* // { // SpanMessageValue Union: only one key present
|
|
97
|
+
* // text: { // SpanTextValue
|
|
98
|
+
* // value: "STRING_VALUE", // required
|
|
99
|
+
* // citations: [ // SpanCitationList
|
|
100
|
+
* // { // SpanCitation
|
|
101
|
+
* // contentId: "STRING_VALUE",
|
|
102
|
+
* // title: "STRING_VALUE",
|
|
103
|
+
* // knowledgeBaseId: "STRING_VALUE",
|
|
104
|
+
* // knowledgeBaseArn: "STRING_VALUE",
|
|
105
|
+
* // },
|
|
106
|
+
* // ],
|
|
107
|
+
* // aiGuardrailAssessment: { // AIGuardrailAssessment
|
|
108
|
+
* // blocked: true || false, // required
|
|
109
|
+
* // },
|
|
110
|
+
* // },
|
|
111
|
+
* // toolUse: { // SpanToolUseValue
|
|
112
|
+
* // toolUseId: "STRING_VALUE", // required
|
|
113
|
+
* // name: "STRING_VALUE", // required
|
|
114
|
+
* // arguments: "DOCUMENT_VALUE", // required
|
|
115
|
+
* // },
|
|
116
|
+
* // toolResult: { // SpanToolResultValue
|
|
117
|
+
* // toolUseId: "STRING_VALUE", // required
|
|
118
|
+
* // values: [ // required
|
|
119
|
+
* // {// Union: only one key present
|
|
120
|
+
* // text: {
|
|
121
|
+
* // value: "STRING_VALUE", // required
|
|
122
|
+
* // citations: [
|
|
123
|
+
* // {
|
|
124
|
+
* // contentId: "STRING_VALUE",
|
|
125
|
+
* // title: "STRING_VALUE",
|
|
126
|
+
* // knowledgeBaseId: "STRING_VALUE",
|
|
127
|
+
* // knowledgeBaseArn: "STRING_VALUE",
|
|
128
|
+
* // },
|
|
129
|
+
* // ],
|
|
130
|
+
* // aiGuardrailAssessment: {
|
|
131
|
+
* // blocked: true || false, // required
|
|
132
|
+
* // },
|
|
133
|
+
* // },
|
|
134
|
+
* // toolUse: {
|
|
135
|
+
* // toolUseId: "STRING_VALUE", // required
|
|
136
|
+
* // name: "STRING_VALUE", // required
|
|
137
|
+
* // arguments: "DOCUMENT_VALUE", // required
|
|
138
|
+
* // },
|
|
139
|
+
* // toolResult: {
|
|
140
|
+
* // toolUseId: "STRING_VALUE", // required
|
|
141
|
+
* // values: "<SpanMessageValueList>", // required
|
|
142
|
+
* // error: "STRING_VALUE",
|
|
143
|
+
* // },
|
|
144
|
+
* // },
|
|
145
|
+
* // ],
|
|
146
|
+
* // error: "STRING_VALUE",
|
|
147
|
+
* // },
|
|
148
|
+
* // },
|
|
149
|
+
* // ],
|
|
150
|
+
* // },
|
|
151
|
+
* // ],
|
|
152
|
+
* // outputMessages: [
|
|
153
|
+
* // {
|
|
154
|
+
* // messageId: "STRING_VALUE", // required
|
|
155
|
+
* // participant: "STRING_VALUE", // required
|
|
156
|
+
* // timestamp: new Date("TIMESTAMP"), // required
|
|
157
|
+
* // values: "<SpanMessageValueList>", // required
|
|
158
|
+
* // },
|
|
159
|
+
* // ],
|
|
160
|
+
* // systemInstructions: "<SpanMessageValueList>",
|
|
161
|
+
* // promptArn: "STRING_VALUE",
|
|
162
|
+
* // promptId: "STRING_VALUE",
|
|
163
|
+
* // promptType: "STRING_VALUE",
|
|
164
|
+
* // promptName: "STRING_VALUE",
|
|
165
|
+
* // promptVersion: Number("int"),
|
|
166
|
+
* // },
|
|
167
|
+
* // },
|
|
168
|
+
* // ],
|
|
169
|
+
* // nextToken: "STRING_VALUE",
|
|
170
|
+
* // };
|
|
171
|
+
*
|
|
172
|
+
* ```
|
|
173
|
+
*
|
|
174
|
+
* @param ListSpansCommandInput - {@link ListSpansCommandInput}
|
|
175
|
+
* @returns {@link ListSpansCommandOutput}
|
|
176
|
+
* @see {@link ListSpansCommandInput} for command's `input` shape.
|
|
177
|
+
* @see {@link ListSpansCommandOutput} for command's `response` shape.
|
|
178
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
179
|
+
*
|
|
180
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
181
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
182
|
+
*
|
|
183
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
184
|
+
* <p>The specified resource does not exist.</p>
|
|
185
|
+
*
|
|
186
|
+
* @throws {@link ValidationException} (client fault)
|
|
187
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
188
|
+
*
|
|
189
|
+
* @throws {@link QConnectServiceException}
|
|
190
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
191
|
+
*
|
|
192
|
+
*
|
|
193
|
+
* @public
|
|
194
|
+
*/
|
|
195
|
+
export declare class ListSpansCommand extends ListSpansCommand_base {
|
|
196
|
+
/** @internal type navigation helper, not in runtime. */
|
|
197
|
+
protected static __types: {
|
|
198
|
+
api: {
|
|
199
|
+
input: ListSpansRequest;
|
|
200
|
+
output: ListSpansResponse;
|
|
201
|
+
};
|
|
202
|
+
sdk: {
|
|
203
|
+
input: ListSpansCommandInput;
|
|
204
|
+
output: ListSpansCommandOutput;
|
|
205
|
+
};
|
|
206
|
+
};
|
|
207
|
+
}
|