@aws-sdk/client-bedrock-agent-runtime 3.609.0 → 3.614.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 +24 -0
- package/dist-cjs/index.js +672 -71
- package/dist-es/BedrockAgentRuntime.js +6 -0
- package/dist-es/commands/DeleteAgentMemoryCommand.js +24 -0
- package/dist-es/commands/GetAgentMemoryCommand.js +24 -0
- package/dist-es/commands/InvokeFlowCommand.js +29 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +221 -49
- package/dist-es/pagination/GetAgentMemoryPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +311 -3
- package/dist-types/BedrockAgentRuntime.d.ts +21 -0
- package/dist-types/BedrockAgentRuntimeClient.d.ts +5 -2
- package/dist-types/commands/DeleteAgentMemoryCommand.d.ts +87 -0
- package/dist-types/commands/GetAgentMemoryCommand.d.ts +103 -0
- package/dist-types/commands/InvokeAgentCommand.d.ts +134 -4
- package/dist-types/commands/InvokeFlowCommand.d.ts +137 -0
- package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +18 -1
- package/dist-types/commands/RetrieveCommand.d.ts +13 -1
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +1339 -299
- package/dist-types/pagination/GetAgentMemoryPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +51 -0
- package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/DeleteAgentMemoryCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/GetAgentMemoryCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/InvokeFlowCommand.d.ts +36 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +527 -54
- package/dist-types/ts3.4/pagination/GetAgentMemoryPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +20 -20
|
@@ -13,143 +13,801 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
13
13
|
*/
|
|
14
14
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
15
|
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
* @enum
|
|
19
|
+
*/
|
|
20
|
+
export declare const ExecutionType: {
|
|
21
|
+
readonly LAMBDA: "LAMBDA";
|
|
22
|
+
readonly RETURN_CONTROL: "RETURN_CONTROL";
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
export type ExecutionType = (typeof ExecutionType)[keyof typeof ExecutionType];
|
|
16
28
|
/**
|
|
17
29
|
* <p>A parameter for the API request or function.</p>
|
|
18
30
|
* @public
|
|
19
31
|
*/
|
|
20
|
-
export interface Parameter {
|
|
32
|
+
export interface Parameter {
|
|
33
|
+
/**
|
|
34
|
+
* <p>The name of the parameter.</p>
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
name?: string;
|
|
38
|
+
/**
|
|
39
|
+
* <p>The type of the parameter.</p>
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
type?: string;
|
|
43
|
+
/**
|
|
44
|
+
* <p>The value of the parameter.</p>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
value?: string;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* <p>The parameters in the API request body.</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
export interface RequestBody {
|
|
54
|
+
/**
|
|
55
|
+
* <p>The content in the request body.</p>
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
content?: Record<string, Parameter[]>;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* <p>Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/trace-orchestration.html">OrchestrationTrace</a> in the Amazon Bedrock User Guide.</p>
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
export interface ActionGroupInvocationInput {
|
|
65
|
+
/**
|
|
66
|
+
* <p>The name of the action group.</p>
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
actionGroupName?: string;
|
|
70
|
+
/**
|
|
71
|
+
* <p>The API method being used, based off the action group.</p>
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
verb?: string;
|
|
75
|
+
/**
|
|
76
|
+
* <p>The path to the API to call, based off the action group.</p>
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
apiPath?: string;
|
|
80
|
+
/**
|
|
81
|
+
* <p>The parameters in the Lambda input event.</p>
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
parameters?: Parameter[];
|
|
85
|
+
/**
|
|
86
|
+
* <p>The parameters in the request body for the Lambda input event.</p>
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
requestBody?: RequestBody;
|
|
90
|
+
/**
|
|
91
|
+
* <p>The function in the action group to call.</p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
function?: string;
|
|
95
|
+
/**
|
|
96
|
+
* <p>How fulfillment of the action is handled. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/action-handle.html">Handling fulfillment of the action</a>.</p>
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
executionType?: ExecutionType;
|
|
100
|
+
/**
|
|
101
|
+
* <p>The unique identifier of the invocation. Only returned if the <code>executionType</code> is <code>RETURN_CONTROL</code>.</p>
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
invocationId?: string;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* <p>Contains the JSON-formatted string returned by the API invoked by the action group.</p>
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
export interface ActionGroupInvocationOutput {
|
|
111
|
+
/**
|
|
112
|
+
* <p>The JSON-formatted string returned by the API invoked by the action group.</p>
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
text?: string;
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
121
|
+
export declare class BadGatewayException extends __BaseException {
|
|
122
|
+
readonly name: "BadGatewayException";
|
|
123
|
+
readonly $fault: "server";
|
|
124
|
+
/**
|
|
125
|
+
* <p>The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.</p>
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
resourceName?: string;
|
|
129
|
+
/**
|
|
130
|
+
* @internal
|
|
131
|
+
*/
|
|
132
|
+
constructor(opts: __ExceptionOptionType<BadGatewayException, __BaseException>);
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
export declare class ConflictException extends __BaseException {
|
|
139
|
+
readonly name: "ConflictException";
|
|
140
|
+
readonly $fault: "client";
|
|
141
|
+
/**
|
|
142
|
+
* @internal
|
|
143
|
+
*/
|
|
144
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
export declare class DependencyFailedException extends __BaseException {
|
|
151
|
+
readonly name: "DependencyFailedException";
|
|
152
|
+
readonly $fault: "client";
|
|
153
|
+
/**
|
|
154
|
+
* <p>The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.</p>
|
|
155
|
+
* @public
|
|
156
|
+
*/
|
|
157
|
+
resourceName?: string;
|
|
158
|
+
/**
|
|
159
|
+
* @internal
|
|
160
|
+
*/
|
|
161
|
+
constructor(opts: __ExceptionOptionType<DependencyFailedException, __BaseException>);
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
165
|
+
* @public
|
|
166
|
+
*/
|
|
167
|
+
export declare class InternalServerException extends __BaseException {
|
|
168
|
+
readonly name: "InternalServerException";
|
|
169
|
+
readonly $fault: "server";
|
|
170
|
+
/**
|
|
171
|
+
* @internal
|
|
172
|
+
*/
|
|
173
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* <p>Contains information about an input into the flow.</p>
|
|
177
|
+
* <p>This data type is used in the following API operations:</p>
|
|
178
|
+
* <ul>
|
|
179
|
+
* <li>
|
|
180
|
+
* <p>
|
|
181
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax">InvokeFlow request</a>
|
|
182
|
+
* </p>
|
|
183
|
+
* </li>
|
|
184
|
+
* </ul>
|
|
185
|
+
* @public
|
|
186
|
+
*/
|
|
187
|
+
export type FlowInputContent = FlowInputContent.DocumentMember | FlowInputContent.$UnknownMember;
|
|
188
|
+
/**
|
|
189
|
+
* @public
|
|
190
|
+
*/
|
|
191
|
+
export declare namespace FlowInputContent {
|
|
192
|
+
/**
|
|
193
|
+
* <p>The input for the flow input node.</p>
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
interface DocumentMember {
|
|
197
|
+
document: __DocumentType;
|
|
198
|
+
$unknown?: never;
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* @public
|
|
202
|
+
*/
|
|
203
|
+
interface $UnknownMember {
|
|
204
|
+
document?: never;
|
|
205
|
+
$unknown: [string, any];
|
|
206
|
+
}
|
|
207
|
+
interface Visitor<T> {
|
|
208
|
+
document: (value: __DocumentType) => T;
|
|
209
|
+
_: (name: string, value: any) => T;
|
|
210
|
+
}
|
|
211
|
+
const visit: <T>(value: FlowInputContent, visitor: Visitor<T>) => T;
|
|
212
|
+
}
|
|
213
|
+
/**
|
|
214
|
+
* <p>Contains information about an input into the flow and what to do with it.</p>
|
|
215
|
+
* <p>This data type is used in the following API operations:</p>
|
|
216
|
+
* <ul>
|
|
217
|
+
* <li>
|
|
218
|
+
* <p>
|
|
219
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax">InvokeFlow request</a>
|
|
220
|
+
* </p>
|
|
221
|
+
* </li>
|
|
222
|
+
* </ul>
|
|
223
|
+
* @public
|
|
224
|
+
*/
|
|
225
|
+
export interface FlowInput {
|
|
226
|
+
/**
|
|
227
|
+
* <p>A name for the input of the flow input node.</p>
|
|
228
|
+
* @public
|
|
229
|
+
*/
|
|
230
|
+
nodeName: string | undefined;
|
|
231
|
+
/**
|
|
232
|
+
* <p>A name for the output of the flow input node.</p>
|
|
233
|
+
* @public
|
|
234
|
+
*/
|
|
235
|
+
nodeOutputName: string | undefined;
|
|
236
|
+
/**
|
|
237
|
+
* <p>Contains information about an input into the flow.</p>
|
|
238
|
+
* @public
|
|
239
|
+
*/
|
|
240
|
+
content: FlowInputContent | undefined;
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
245
|
+
export interface InvokeFlowRequest {
|
|
246
|
+
/**
|
|
247
|
+
* <p>The unique identifier of the flow.</p>
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
250
|
+
flowIdentifier: string | undefined;
|
|
251
|
+
/**
|
|
252
|
+
* <p>The unique identifier of the flow alias.</p>
|
|
253
|
+
* @public
|
|
254
|
+
*/
|
|
255
|
+
flowAliasIdentifier: string | undefined;
|
|
256
|
+
/**
|
|
257
|
+
* <p>A list of objects, each containing information about an input into the flow.</p>
|
|
258
|
+
* @public
|
|
259
|
+
*/
|
|
260
|
+
inputs: FlowInput[] | undefined;
|
|
261
|
+
}
|
|
262
|
+
/**
|
|
263
|
+
* @public
|
|
264
|
+
* @enum
|
|
265
|
+
*/
|
|
266
|
+
export declare const FlowCompletionReason: {
|
|
267
|
+
readonly SUCCESS: "SUCCESS";
|
|
268
|
+
};
|
|
269
|
+
/**
|
|
270
|
+
* @public
|
|
271
|
+
*/
|
|
272
|
+
export type FlowCompletionReason = (typeof FlowCompletionReason)[keyof typeof FlowCompletionReason];
|
|
273
|
+
/**
|
|
274
|
+
* <p>Contains information about why a flow completed.</p>
|
|
275
|
+
* <p>This data type is used in the following API operations:</p>
|
|
276
|
+
* <ul>
|
|
277
|
+
* <li>
|
|
278
|
+
* <p>
|
|
279
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax">InvokeFlow response</a>
|
|
280
|
+
* </p>
|
|
281
|
+
* </li>
|
|
282
|
+
* </ul>
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
export interface FlowCompletionEvent {
|
|
286
|
+
/**
|
|
287
|
+
* <p>The reason that the flow completed.</p>
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
completionReason: FlowCompletionReason | undefined;
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* <p>Contains information about the output node.</p>
|
|
294
|
+
* <p>This data type is used in the following API operations:</p>
|
|
295
|
+
* <ul>
|
|
296
|
+
* <li>
|
|
297
|
+
* <p>
|
|
298
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax">InvokeFlow request</a>
|
|
299
|
+
* </p>
|
|
300
|
+
* </li>
|
|
301
|
+
* </ul>
|
|
302
|
+
* @public
|
|
303
|
+
*/
|
|
304
|
+
export type FlowOutputContent = FlowOutputContent.DocumentMember | FlowOutputContent.$UnknownMember;
|
|
305
|
+
/**
|
|
306
|
+
* @public
|
|
307
|
+
*/
|
|
308
|
+
export declare namespace FlowOutputContent {
|
|
309
|
+
/**
|
|
310
|
+
* <p>A name for the output of the flow.</p>
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
interface DocumentMember {
|
|
314
|
+
document: __DocumentType;
|
|
315
|
+
$unknown?: never;
|
|
316
|
+
}
|
|
317
|
+
/**
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
interface $UnknownMember {
|
|
321
|
+
document?: never;
|
|
322
|
+
$unknown: [string, any];
|
|
323
|
+
}
|
|
324
|
+
interface Visitor<T> {
|
|
325
|
+
document: (value: __DocumentType) => T;
|
|
326
|
+
_: (name: string, value: any) => T;
|
|
327
|
+
}
|
|
328
|
+
const visit: <T>(value: FlowOutputContent, visitor: Visitor<T>) => T;
|
|
329
|
+
}
|
|
330
|
+
/**
|
|
331
|
+
* @public
|
|
332
|
+
* @enum
|
|
333
|
+
*/
|
|
334
|
+
export declare const NodeType: {
|
|
335
|
+
readonly CONDITION_NODE: "ConditionNode";
|
|
336
|
+
readonly FLOW_INPUT_NODE: "FlowInputNode";
|
|
337
|
+
readonly FLOW_OUTPUT_NODE: "FlowOutputNode";
|
|
338
|
+
readonly KNOWLEDGE_BASE_NODE: "KnowledgeBaseNode";
|
|
339
|
+
readonly LAMBDA_FUNCTION_NODE: "LambdaFunctionNode";
|
|
340
|
+
readonly LEX_NODE: "LexNode";
|
|
341
|
+
readonly PROMPT_NODE: "PromptNode";
|
|
342
|
+
};
|
|
343
|
+
/**
|
|
344
|
+
* @public
|
|
345
|
+
*/
|
|
346
|
+
export type NodeType = (typeof NodeType)[keyof typeof NodeType];
|
|
347
|
+
/**
|
|
348
|
+
* <p>Contains information about an output from flow invoction.</p>
|
|
349
|
+
* <p>This data type is used in the following API operations:</p>
|
|
350
|
+
* <ul>
|
|
351
|
+
* <li>
|
|
352
|
+
* <p>
|
|
353
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax">InvokeFlow response</a>
|
|
354
|
+
* </p>
|
|
355
|
+
* </li>
|
|
356
|
+
* </ul>
|
|
357
|
+
* @public
|
|
358
|
+
*/
|
|
359
|
+
export interface FlowOutputEvent {
|
|
360
|
+
/**
|
|
361
|
+
* <p>The name of the node to which input was provided.</p>
|
|
362
|
+
* @public
|
|
363
|
+
*/
|
|
364
|
+
nodeName: string | undefined;
|
|
365
|
+
/**
|
|
366
|
+
* <p>The type of node to which input was provided.</p>
|
|
367
|
+
* @public
|
|
368
|
+
*/
|
|
369
|
+
nodeType: NodeType | undefined;
|
|
370
|
+
/**
|
|
371
|
+
* <p>The output of the node.</p>
|
|
372
|
+
* @public
|
|
373
|
+
*/
|
|
374
|
+
content: FlowOutputContent | undefined;
|
|
375
|
+
}
|
|
376
|
+
/**
|
|
377
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
378
|
+
* @public
|
|
379
|
+
*/
|
|
380
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
381
|
+
readonly name: "ResourceNotFoundException";
|
|
382
|
+
readonly $fault: "client";
|
|
383
|
+
/**
|
|
384
|
+
* @internal
|
|
385
|
+
*/
|
|
386
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
387
|
+
}
|
|
388
|
+
/**
|
|
389
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
390
|
+
* @public
|
|
391
|
+
*/
|
|
392
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
393
|
+
readonly name: "ServiceQuotaExceededException";
|
|
394
|
+
readonly $fault: "client";
|
|
395
|
+
/**
|
|
396
|
+
* @internal
|
|
397
|
+
*/
|
|
398
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
399
|
+
}
|
|
400
|
+
/**
|
|
401
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
402
|
+
* @public
|
|
403
|
+
*/
|
|
404
|
+
export declare class ThrottlingException extends __BaseException {
|
|
405
|
+
readonly name: "ThrottlingException";
|
|
406
|
+
readonly $fault: "client";
|
|
407
|
+
/**
|
|
408
|
+
* @internal
|
|
409
|
+
*/
|
|
410
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
411
|
+
}
|
|
412
|
+
/**
|
|
413
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
414
|
+
* @public
|
|
415
|
+
*/
|
|
416
|
+
export declare class ValidationException extends __BaseException {
|
|
417
|
+
readonly name: "ValidationException";
|
|
418
|
+
readonly $fault: "client";
|
|
419
|
+
/**
|
|
420
|
+
* @internal
|
|
421
|
+
*/
|
|
422
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
423
|
+
}
|
|
424
|
+
/**
|
|
425
|
+
* <p>The output of the flow.</p>
|
|
426
|
+
* <p>This data type is used in the following API operations:</p>
|
|
427
|
+
* <ul>
|
|
428
|
+
* <li>
|
|
429
|
+
* <p>
|
|
430
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax">InvokeFlow response</a>
|
|
431
|
+
* </p>
|
|
432
|
+
* </li>
|
|
433
|
+
* </ul>
|
|
434
|
+
* @public
|
|
435
|
+
*/
|
|
436
|
+
export type FlowResponseStream = FlowResponseStream.AccessDeniedExceptionMember | FlowResponseStream.BadGatewayExceptionMember | FlowResponseStream.ConflictExceptionMember | FlowResponseStream.DependencyFailedExceptionMember | FlowResponseStream.FlowCompletionEventMember | FlowResponseStream.FlowOutputEventMember | FlowResponseStream.InternalServerExceptionMember | FlowResponseStream.ResourceNotFoundExceptionMember | FlowResponseStream.ServiceQuotaExceededExceptionMember | FlowResponseStream.ThrottlingExceptionMember | FlowResponseStream.ValidationExceptionMember | FlowResponseStream.$UnknownMember;
|
|
437
|
+
/**
|
|
438
|
+
* @public
|
|
439
|
+
*/
|
|
440
|
+
export declare namespace FlowResponseStream {
|
|
441
|
+
/**
|
|
442
|
+
* <p>Contains information about an output from flow invocation.</p>
|
|
443
|
+
* @public
|
|
444
|
+
*/
|
|
445
|
+
interface FlowOutputEventMember {
|
|
446
|
+
flowOutputEvent: FlowOutputEvent;
|
|
447
|
+
flowCompletionEvent?: never;
|
|
448
|
+
internalServerException?: never;
|
|
449
|
+
validationException?: never;
|
|
450
|
+
resourceNotFoundException?: never;
|
|
451
|
+
serviceQuotaExceededException?: never;
|
|
452
|
+
throttlingException?: never;
|
|
453
|
+
accessDeniedException?: never;
|
|
454
|
+
conflictException?: never;
|
|
455
|
+
dependencyFailedException?: never;
|
|
456
|
+
badGatewayException?: never;
|
|
457
|
+
$unknown?: never;
|
|
458
|
+
}
|
|
459
|
+
/**
|
|
460
|
+
* <p>Contains information about why the flow completed.</p>
|
|
461
|
+
* @public
|
|
462
|
+
*/
|
|
463
|
+
interface FlowCompletionEventMember {
|
|
464
|
+
flowOutputEvent?: never;
|
|
465
|
+
flowCompletionEvent: FlowCompletionEvent;
|
|
466
|
+
internalServerException?: never;
|
|
467
|
+
validationException?: never;
|
|
468
|
+
resourceNotFoundException?: never;
|
|
469
|
+
serviceQuotaExceededException?: never;
|
|
470
|
+
throttlingException?: never;
|
|
471
|
+
accessDeniedException?: never;
|
|
472
|
+
conflictException?: never;
|
|
473
|
+
dependencyFailedException?: never;
|
|
474
|
+
badGatewayException?: never;
|
|
475
|
+
$unknown?: never;
|
|
476
|
+
}
|
|
477
|
+
/**
|
|
478
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
479
|
+
* @public
|
|
480
|
+
*/
|
|
481
|
+
interface InternalServerExceptionMember {
|
|
482
|
+
flowOutputEvent?: never;
|
|
483
|
+
flowCompletionEvent?: never;
|
|
484
|
+
internalServerException: InternalServerException;
|
|
485
|
+
validationException?: never;
|
|
486
|
+
resourceNotFoundException?: never;
|
|
487
|
+
serviceQuotaExceededException?: never;
|
|
488
|
+
throttlingException?: never;
|
|
489
|
+
accessDeniedException?: never;
|
|
490
|
+
conflictException?: never;
|
|
491
|
+
dependencyFailedException?: never;
|
|
492
|
+
badGatewayException?: never;
|
|
493
|
+
$unknown?: never;
|
|
494
|
+
}
|
|
495
|
+
/**
|
|
496
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
497
|
+
* @public
|
|
498
|
+
*/
|
|
499
|
+
interface ValidationExceptionMember {
|
|
500
|
+
flowOutputEvent?: never;
|
|
501
|
+
flowCompletionEvent?: never;
|
|
502
|
+
internalServerException?: never;
|
|
503
|
+
validationException: ValidationException;
|
|
504
|
+
resourceNotFoundException?: never;
|
|
505
|
+
serviceQuotaExceededException?: never;
|
|
506
|
+
throttlingException?: never;
|
|
507
|
+
accessDeniedException?: never;
|
|
508
|
+
conflictException?: never;
|
|
509
|
+
dependencyFailedException?: never;
|
|
510
|
+
badGatewayException?: never;
|
|
511
|
+
$unknown?: never;
|
|
512
|
+
}
|
|
513
|
+
/**
|
|
514
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
515
|
+
* @public
|
|
516
|
+
*/
|
|
517
|
+
interface ResourceNotFoundExceptionMember {
|
|
518
|
+
flowOutputEvent?: never;
|
|
519
|
+
flowCompletionEvent?: never;
|
|
520
|
+
internalServerException?: never;
|
|
521
|
+
validationException?: never;
|
|
522
|
+
resourceNotFoundException: ResourceNotFoundException;
|
|
523
|
+
serviceQuotaExceededException?: never;
|
|
524
|
+
throttlingException?: never;
|
|
525
|
+
accessDeniedException?: never;
|
|
526
|
+
conflictException?: never;
|
|
527
|
+
dependencyFailedException?: never;
|
|
528
|
+
badGatewayException?: never;
|
|
529
|
+
$unknown?: never;
|
|
530
|
+
}
|
|
531
|
+
/**
|
|
532
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
533
|
+
* @public
|
|
534
|
+
*/
|
|
535
|
+
interface ServiceQuotaExceededExceptionMember {
|
|
536
|
+
flowOutputEvent?: never;
|
|
537
|
+
flowCompletionEvent?: never;
|
|
538
|
+
internalServerException?: never;
|
|
539
|
+
validationException?: never;
|
|
540
|
+
resourceNotFoundException?: never;
|
|
541
|
+
serviceQuotaExceededException: ServiceQuotaExceededException;
|
|
542
|
+
throttlingException?: never;
|
|
543
|
+
accessDeniedException?: never;
|
|
544
|
+
conflictException?: never;
|
|
545
|
+
dependencyFailedException?: never;
|
|
546
|
+
badGatewayException?: never;
|
|
547
|
+
$unknown?: never;
|
|
548
|
+
}
|
|
549
|
+
/**
|
|
550
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
551
|
+
* @public
|
|
552
|
+
*/
|
|
553
|
+
interface ThrottlingExceptionMember {
|
|
554
|
+
flowOutputEvent?: never;
|
|
555
|
+
flowCompletionEvent?: never;
|
|
556
|
+
internalServerException?: never;
|
|
557
|
+
validationException?: never;
|
|
558
|
+
resourceNotFoundException?: never;
|
|
559
|
+
serviceQuotaExceededException?: never;
|
|
560
|
+
throttlingException: ThrottlingException;
|
|
561
|
+
accessDeniedException?: never;
|
|
562
|
+
conflictException?: never;
|
|
563
|
+
dependencyFailedException?: never;
|
|
564
|
+
badGatewayException?: never;
|
|
565
|
+
$unknown?: never;
|
|
566
|
+
}
|
|
567
|
+
/**
|
|
568
|
+
* <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
|
|
569
|
+
* @public
|
|
570
|
+
*/
|
|
571
|
+
interface AccessDeniedExceptionMember {
|
|
572
|
+
flowOutputEvent?: never;
|
|
573
|
+
flowCompletionEvent?: never;
|
|
574
|
+
internalServerException?: never;
|
|
575
|
+
validationException?: never;
|
|
576
|
+
resourceNotFoundException?: never;
|
|
577
|
+
serviceQuotaExceededException?: never;
|
|
578
|
+
throttlingException?: never;
|
|
579
|
+
accessDeniedException: AccessDeniedException;
|
|
580
|
+
conflictException?: never;
|
|
581
|
+
dependencyFailedException?: never;
|
|
582
|
+
badGatewayException?: never;
|
|
583
|
+
$unknown?: never;
|
|
584
|
+
}
|
|
585
|
+
/**
|
|
586
|
+
* <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
|
|
587
|
+
* @public
|
|
588
|
+
*/
|
|
589
|
+
interface ConflictExceptionMember {
|
|
590
|
+
flowOutputEvent?: never;
|
|
591
|
+
flowCompletionEvent?: never;
|
|
592
|
+
internalServerException?: never;
|
|
593
|
+
validationException?: never;
|
|
594
|
+
resourceNotFoundException?: never;
|
|
595
|
+
serviceQuotaExceededException?: never;
|
|
596
|
+
throttlingException?: never;
|
|
597
|
+
accessDeniedException?: never;
|
|
598
|
+
conflictException: ConflictException;
|
|
599
|
+
dependencyFailedException?: never;
|
|
600
|
+
badGatewayException?: never;
|
|
601
|
+
$unknown?: never;
|
|
602
|
+
}
|
|
603
|
+
/**
|
|
604
|
+
* <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
|
|
605
|
+
* @public
|
|
606
|
+
*/
|
|
607
|
+
interface DependencyFailedExceptionMember {
|
|
608
|
+
flowOutputEvent?: never;
|
|
609
|
+
flowCompletionEvent?: never;
|
|
610
|
+
internalServerException?: never;
|
|
611
|
+
validationException?: never;
|
|
612
|
+
resourceNotFoundException?: never;
|
|
613
|
+
serviceQuotaExceededException?: never;
|
|
614
|
+
throttlingException?: never;
|
|
615
|
+
accessDeniedException?: never;
|
|
616
|
+
conflictException?: never;
|
|
617
|
+
dependencyFailedException: DependencyFailedException;
|
|
618
|
+
badGatewayException?: never;
|
|
619
|
+
$unknown?: never;
|
|
620
|
+
}
|
|
621
|
+
/**
|
|
622
|
+
* <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
|
|
623
|
+
* @public
|
|
624
|
+
*/
|
|
625
|
+
interface BadGatewayExceptionMember {
|
|
626
|
+
flowOutputEvent?: never;
|
|
627
|
+
flowCompletionEvent?: never;
|
|
628
|
+
internalServerException?: never;
|
|
629
|
+
validationException?: never;
|
|
630
|
+
resourceNotFoundException?: never;
|
|
631
|
+
serviceQuotaExceededException?: never;
|
|
632
|
+
throttlingException?: never;
|
|
633
|
+
accessDeniedException?: never;
|
|
634
|
+
conflictException?: never;
|
|
635
|
+
dependencyFailedException?: never;
|
|
636
|
+
badGatewayException: BadGatewayException;
|
|
637
|
+
$unknown?: never;
|
|
638
|
+
}
|
|
639
|
+
/**
|
|
640
|
+
* @public
|
|
641
|
+
*/
|
|
642
|
+
interface $UnknownMember {
|
|
643
|
+
flowOutputEvent?: never;
|
|
644
|
+
flowCompletionEvent?: never;
|
|
645
|
+
internalServerException?: never;
|
|
646
|
+
validationException?: never;
|
|
647
|
+
resourceNotFoundException?: never;
|
|
648
|
+
serviceQuotaExceededException?: never;
|
|
649
|
+
throttlingException?: never;
|
|
650
|
+
accessDeniedException?: never;
|
|
651
|
+
conflictException?: never;
|
|
652
|
+
dependencyFailedException?: never;
|
|
653
|
+
badGatewayException?: never;
|
|
654
|
+
$unknown: [string, any];
|
|
655
|
+
}
|
|
656
|
+
interface Visitor<T> {
|
|
657
|
+
flowOutputEvent: (value: FlowOutputEvent) => T;
|
|
658
|
+
flowCompletionEvent: (value: FlowCompletionEvent) => T;
|
|
659
|
+
internalServerException: (value: InternalServerException) => T;
|
|
660
|
+
validationException: (value: ValidationException) => T;
|
|
661
|
+
resourceNotFoundException: (value: ResourceNotFoundException) => T;
|
|
662
|
+
serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T;
|
|
663
|
+
throttlingException: (value: ThrottlingException) => T;
|
|
664
|
+
accessDeniedException: (value: AccessDeniedException) => T;
|
|
665
|
+
conflictException: (value: ConflictException) => T;
|
|
666
|
+
dependencyFailedException: (value: DependencyFailedException) => T;
|
|
667
|
+
badGatewayException: (value: BadGatewayException) => T;
|
|
668
|
+
_: (name: string, value: any) => T;
|
|
669
|
+
}
|
|
670
|
+
const visit: <T>(value: FlowResponseStream, visitor: Visitor<T>) => T;
|
|
671
|
+
}
|
|
672
|
+
/**
|
|
673
|
+
* @public
|
|
674
|
+
*/
|
|
675
|
+
export interface InvokeFlowResponse {
|
|
21
676
|
/**
|
|
22
|
-
* <p>The
|
|
677
|
+
* <p>The output of the flow, returned as a stream. If there's an error, the error is returned.</p>
|
|
23
678
|
* @public
|
|
24
679
|
*/
|
|
25
|
-
|
|
680
|
+
responseStream: AsyncIterable<FlowResponseStream> | undefined;
|
|
681
|
+
}
|
|
682
|
+
/**
|
|
683
|
+
* <p>The property contains the file to chat with, along with its attributes.</p>
|
|
684
|
+
* @public
|
|
685
|
+
*/
|
|
686
|
+
export interface ByteContentFile {
|
|
26
687
|
/**
|
|
27
|
-
* <p>The type of the
|
|
688
|
+
* <p>The MIME type of data contained in the file used for chat.</p>
|
|
28
689
|
* @public
|
|
29
690
|
*/
|
|
30
|
-
|
|
691
|
+
mediaType: string | undefined;
|
|
31
692
|
/**
|
|
32
|
-
* <p>The value of the
|
|
693
|
+
* <p>The byte value of the file to attach, encoded as Base-64 string. The maximum size of all files that is attached is 10MB. You can attach a maximum of 5 files. </p>
|
|
33
694
|
* @public
|
|
34
695
|
*/
|
|
35
|
-
|
|
696
|
+
data: Uint8Array | undefined;
|
|
36
697
|
}
|
|
37
698
|
/**
|
|
38
|
-
* <p>
|
|
699
|
+
* <p>Contains details of the s3 object where the source file is located.</p>
|
|
39
700
|
* @public
|
|
40
701
|
*/
|
|
41
|
-
export interface
|
|
702
|
+
export interface S3ObjectFile {
|
|
42
703
|
/**
|
|
43
|
-
* <p>The
|
|
704
|
+
* <p>The uri of the s3 object.</p>
|
|
44
705
|
* @public
|
|
45
706
|
*/
|
|
46
|
-
|
|
707
|
+
uri: string | undefined;
|
|
47
708
|
}
|
|
48
709
|
/**
|
|
49
|
-
* <p>Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/trace-orchestration.html">OrchestrationTrace</a> in the Amazon Bedrock User Guide.</p>
|
|
50
710
|
* @public
|
|
711
|
+
* @enum
|
|
51
712
|
*/
|
|
52
|
-
export
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
* @public
|
|
66
|
-
*/
|
|
67
|
-
apiPath?: string;
|
|
713
|
+
export declare const FileSourceType: {
|
|
714
|
+
readonly BYTE_CONTENT: "BYTE_CONTENT";
|
|
715
|
+
readonly S3: "S3";
|
|
716
|
+
};
|
|
717
|
+
/**
|
|
718
|
+
* @public
|
|
719
|
+
*/
|
|
720
|
+
export type FileSourceType = (typeof FileSourceType)[keyof typeof FileSourceType];
|
|
721
|
+
/**
|
|
722
|
+
* <p>The source file of the content contained in the wrapper object.</p>
|
|
723
|
+
* @public
|
|
724
|
+
*/
|
|
725
|
+
export interface FileSource {
|
|
68
726
|
/**
|
|
69
|
-
* <p>The
|
|
727
|
+
* <p>The source type of the files to attach.</p>
|
|
70
728
|
* @public
|
|
71
729
|
*/
|
|
72
|
-
|
|
730
|
+
sourceType: FileSourceType | undefined;
|
|
73
731
|
/**
|
|
74
|
-
* <p>The
|
|
732
|
+
* <p>The s3 location of the files to attach.</p>
|
|
75
733
|
* @public
|
|
76
734
|
*/
|
|
77
|
-
|
|
735
|
+
s3Location?: S3ObjectFile;
|
|
78
736
|
/**
|
|
79
|
-
* <p>The
|
|
737
|
+
* <p>The data and the text of the attached files.</p>
|
|
80
738
|
* @public
|
|
81
739
|
*/
|
|
82
|
-
|
|
740
|
+
byteContent?: ByteContentFile;
|
|
83
741
|
}
|
|
84
742
|
/**
|
|
85
|
-
* <p>Contains the JSON-formatted string returned by the API invoked by the action group.</p>
|
|
86
743
|
* @public
|
|
744
|
+
* @enum
|
|
87
745
|
*/
|
|
88
|
-
export
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
*/
|
|
93
|
-
text?: string;
|
|
94
|
-
}
|
|
746
|
+
export declare const FileUseCase: {
|
|
747
|
+
readonly CHAT: "CHAT";
|
|
748
|
+
readonly CODE_INTERPRETER: "CODE_INTERPRETER";
|
|
749
|
+
};
|
|
95
750
|
/**
|
|
96
|
-
* <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
|
|
97
751
|
* @public
|
|
98
752
|
*/
|
|
99
|
-
export
|
|
100
|
-
|
|
101
|
-
|
|
753
|
+
export type FileUseCase = (typeof FileUseCase)[keyof typeof FileUseCase];
|
|
754
|
+
/**
|
|
755
|
+
* <p>Contains details of the source files.</p>
|
|
756
|
+
* @public
|
|
757
|
+
*/
|
|
758
|
+
export interface InputFile {
|
|
102
759
|
/**
|
|
103
|
-
* <p>The name of the
|
|
760
|
+
* <p>The name of the source file.</p>
|
|
104
761
|
* @public
|
|
105
762
|
*/
|
|
106
|
-
|
|
763
|
+
name: string | undefined;
|
|
107
764
|
/**
|
|
108
|
-
*
|
|
765
|
+
* <p>Specifies where the files are located.</p>
|
|
766
|
+
* @public
|
|
109
767
|
*/
|
|
110
|
-
|
|
111
|
-
}
|
|
112
|
-
/**
|
|
113
|
-
* <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
|
|
114
|
-
* @public
|
|
115
|
-
*/
|
|
116
|
-
export declare class ConflictException extends __BaseException {
|
|
117
|
-
readonly name: "ConflictException";
|
|
118
|
-
readonly $fault: "client";
|
|
768
|
+
source: FileSource | undefined;
|
|
119
769
|
/**
|
|
120
|
-
*
|
|
770
|
+
* <p>Specifies how the source files will be used by the code interpreter.</p>
|
|
771
|
+
* @public
|
|
121
772
|
*/
|
|
122
|
-
|
|
773
|
+
useCase: FileUseCase | undefined;
|
|
123
774
|
}
|
|
124
775
|
/**
|
|
125
|
-
* <p>
|
|
776
|
+
* <p>Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
|
|
777
|
+
* <p>This data type is used in the following API operations:</p>
|
|
778
|
+
* <ul>
|
|
779
|
+
* <li>
|
|
780
|
+
* <p>
|
|
781
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a>
|
|
782
|
+
* </p>
|
|
783
|
+
* </li>
|
|
784
|
+
* </ul>
|
|
126
785
|
* @public
|
|
127
786
|
*/
|
|
128
|
-
export
|
|
129
|
-
readonly name: "DependencyFailedException";
|
|
130
|
-
readonly $fault: "client";
|
|
787
|
+
export interface FilterAttribute {
|
|
131
788
|
/**
|
|
132
|
-
* <p>The name
|
|
789
|
+
* <p>The name that the metadata attribute must match.</p>
|
|
133
790
|
* @public
|
|
134
791
|
*/
|
|
135
|
-
|
|
792
|
+
key: string | undefined;
|
|
136
793
|
/**
|
|
137
|
-
*
|
|
794
|
+
* <p>The value to whcih to compare the value of the metadata attribute.</p>
|
|
795
|
+
* @public
|
|
138
796
|
*/
|
|
139
|
-
|
|
797
|
+
value: __DocumentType | undefined;
|
|
140
798
|
}
|
|
141
799
|
/**
|
|
142
|
-
* <p>An internal server error occurred. Retry your request.</p>
|
|
143
800
|
* @public
|
|
801
|
+
* @enum
|
|
144
802
|
*/
|
|
145
|
-
export declare
|
|
146
|
-
readonly
|
|
147
|
-
readonly
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
803
|
+
export declare const SearchType: {
|
|
804
|
+
readonly HYBRID: "HYBRID";
|
|
805
|
+
readonly SEMANTIC: "SEMANTIC";
|
|
806
|
+
};
|
|
807
|
+
/**
|
|
808
|
+
* @public
|
|
809
|
+
*/
|
|
810
|
+
export type SearchType = (typeof SearchType)[keyof typeof SearchType];
|
|
153
811
|
/**
|
|
154
812
|
* <p>Contains the body of the API response.</p>
|
|
155
813
|
* <p>This data type is used in the following API operations:</p>
|
|
@@ -306,81 +964,6 @@ export declare namespace InvocationResultMember {
|
|
|
306
964
|
}
|
|
307
965
|
const visit: <T>(value: InvocationResultMember, visitor: Visitor<T>) => T;
|
|
308
966
|
}
|
|
309
|
-
/**
|
|
310
|
-
* <p>Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html">Lambda function</a> for an action group or pass them when making an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
311
|
-
* @public
|
|
312
|
-
*/
|
|
313
|
-
export interface SessionState {
|
|
314
|
-
/**
|
|
315
|
-
* <p>Contains attributes that persist across a session and the values of those attributes.</p>
|
|
316
|
-
* @public
|
|
317
|
-
*/
|
|
318
|
-
sessionAttributes?: Record<string, string>;
|
|
319
|
-
/**
|
|
320
|
-
* <p>Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Prompt template placeholder variables</a>.</p>
|
|
321
|
-
* @public
|
|
322
|
-
*/
|
|
323
|
-
promptSessionAttributes?: Record<string, string>;
|
|
324
|
-
/**
|
|
325
|
-
* <p>Contains information about the results from the action group invocation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
326
|
-
* <note>
|
|
327
|
-
* <p>If you include this field, the <code>inputText</code> field will be ignored.</p>
|
|
328
|
-
* </note>
|
|
329
|
-
* @public
|
|
330
|
-
*/
|
|
331
|
-
returnControlInvocationResults?: InvocationResultMember[];
|
|
332
|
-
/**
|
|
333
|
-
* <p>The identifier of the invocation of an action. This value must match the <code>invocationId</code> returned in the <code>InvokeAgent</code> response for the action whose results are provided in the <code>returnControlInvocationResults</code> field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
334
|
-
* @public
|
|
335
|
-
*/
|
|
336
|
-
invocationId?: string;
|
|
337
|
-
}
|
|
338
|
-
/**
|
|
339
|
-
* @public
|
|
340
|
-
*/
|
|
341
|
-
export interface InvokeAgentRequest {
|
|
342
|
-
/**
|
|
343
|
-
* <p>Contains parameters that specify various attributes of the session. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
344
|
-
* <note>
|
|
345
|
-
* <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
|
|
346
|
-
* </note>
|
|
347
|
-
* @public
|
|
348
|
-
*/
|
|
349
|
-
sessionState?: SessionState;
|
|
350
|
-
/**
|
|
351
|
-
* <p>The unique identifier of the agent to use.</p>
|
|
352
|
-
* @public
|
|
353
|
-
*/
|
|
354
|
-
agentId: string | undefined;
|
|
355
|
-
/**
|
|
356
|
-
* <p>The alias of the agent to use.</p>
|
|
357
|
-
* @public
|
|
358
|
-
*/
|
|
359
|
-
agentAliasId: string | undefined;
|
|
360
|
-
/**
|
|
361
|
-
* <p>The unique identifier of the session. Use the same value across requests to continue the same conversation.</p>
|
|
362
|
-
* @public
|
|
363
|
-
*/
|
|
364
|
-
sessionId: string | undefined;
|
|
365
|
-
/**
|
|
366
|
-
* <p>Specifies whether to end the session with the agent or not.</p>
|
|
367
|
-
* @public
|
|
368
|
-
*/
|
|
369
|
-
endSession?: boolean;
|
|
370
|
-
/**
|
|
371
|
-
* <p>Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events">Trace enablement</a>.</p>
|
|
372
|
-
* @public
|
|
373
|
-
*/
|
|
374
|
-
enableTrace?: boolean;
|
|
375
|
-
/**
|
|
376
|
-
* <p>The prompt text to send the agent.</p>
|
|
377
|
-
* <note>
|
|
378
|
-
* <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
|
|
379
|
-
* </note>
|
|
380
|
-
* @public
|
|
381
|
-
*/
|
|
382
|
-
inputText?: string;
|
|
383
|
-
}
|
|
384
967
|
/**
|
|
385
968
|
* <p>Contains information about where the text with a citation begins and ends in the generated output.</p>
|
|
386
969
|
* <p>This data type is used in the following API operations:</p>
|
|
@@ -484,7 +1067,18 @@ export interface RetrievalResultContent {
|
|
|
484
1067
|
text: string | undefined;
|
|
485
1068
|
}
|
|
486
1069
|
/**
|
|
487
|
-
* <p>
|
|
1070
|
+
* <p>The Confluence data source location.</p>
|
|
1071
|
+
* @public
|
|
1072
|
+
*/
|
|
1073
|
+
export interface RetrievalResultConfluenceLocation {
|
|
1074
|
+
/**
|
|
1075
|
+
* <p>The Confluence host URL for the data source location.</p>
|
|
1076
|
+
* @public
|
|
1077
|
+
*/
|
|
1078
|
+
url?: string;
|
|
1079
|
+
}
|
|
1080
|
+
/**
|
|
1081
|
+
* <p>The S3 data source location.</p>
|
|
488
1082
|
* <p>This data type is used in the following API operations:</p>
|
|
489
1083
|
* <ul>
|
|
490
1084
|
* <li>
|
|
@@ -504,24 +1098,61 @@ export interface RetrievalResultContent {
|
|
|
504
1098
|
*/
|
|
505
1099
|
export interface RetrievalResultS3Location {
|
|
506
1100
|
/**
|
|
507
|
-
* <p>The S3 URI
|
|
1101
|
+
* <p>The S3 URI for the data source location.</p>
|
|
508
1102
|
* @public
|
|
509
1103
|
*/
|
|
510
1104
|
uri?: string;
|
|
511
1105
|
}
|
|
1106
|
+
/**
|
|
1107
|
+
* <p>The Salesforce data source location.</p>
|
|
1108
|
+
* @public
|
|
1109
|
+
*/
|
|
1110
|
+
export interface RetrievalResultSalesforceLocation {
|
|
1111
|
+
/**
|
|
1112
|
+
* <p>The Salesforce host URL for the data source location.</p>
|
|
1113
|
+
* @public
|
|
1114
|
+
*/
|
|
1115
|
+
url?: string;
|
|
1116
|
+
}
|
|
1117
|
+
/**
|
|
1118
|
+
* <p>The SharePoint data source location.</p>
|
|
1119
|
+
* @public
|
|
1120
|
+
*/
|
|
1121
|
+
export interface RetrievalResultSharePointLocation {
|
|
1122
|
+
/**
|
|
1123
|
+
* <p>The SharePoint site URL for the data source location.</p>
|
|
1124
|
+
* @public
|
|
1125
|
+
*/
|
|
1126
|
+
url?: string;
|
|
1127
|
+
}
|
|
512
1128
|
/**
|
|
513
1129
|
* @public
|
|
514
1130
|
* @enum
|
|
515
1131
|
*/
|
|
516
1132
|
export declare const RetrievalResultLocationType: {
|
|
1133
|
+
readonly CONFLUENCE: "CONFLUENCE";
|
|
517
1134
|
readonly S3: "S3";
|
|
1135
|
+
readonly SALESFORCE: "SALESFORCE";
|
|
1136
|
+
readonly SHAREPOINT: "SHAREPOINT";
|
|
1137
|
+
readonly WEB: "WEB";
|
|
518
1138
|
};
|
|
519
1139
|
/**
|
|
520
1140
|
* @public
|
|
521
1141
|
*/
|
|
522
1142
|
export type RetrievalResultLocationType = (typeof RetrievalResultLocationType)[keyof typeof RetrievalResultLocationType];
|
|
523
1143
|
/**
|
|
524
|
-
* <p>
|
|
1144
|
+
* <p>The web URL/URLs data source location.</p>
|
|
1145
|
+
* @public
|
|
1146
|
+
*/
|
|
1147
|
+
export interface RetrievalResultWebLocation {
|
|
1148
|
+
/**
|
|
1149
|
+
* <p>The web URL/URLs for the data source location.</p>
|
|
1150
|
+
* @public
|
|
1151
|
+
*/
|
|
1152
|
+
url?: string;
|
|
1153
|
+
}
|
|
1154
|
+
/**
|
|
1155
|
+
* <p>Contains information about the data source location.</p>
|
|
525
1156
|
* <p>This data type is used in the following API operations:</p>
|
|
526
1157
|
* <ul>
|
|
527
1158
|
* <li>
|
|
@@ -541,15 +1172,35 @@ export type RetrievalResultLocationType = (typeof RetrievalResultLocationType)[k
|
|
|
541
1172
|
*/
|
|
542
1173
|
export interface RetrievalResultLocation {
|
|
543
1174
|
/**
|
|
544
|
-
* <p>The type of
|
|
1175
|
+
* <p>The type of data source location.</p>
|
|
545
1176
|
* @public
|
|
546
1177
|
*/
|
|
547
1178
|
type: RetrievalResultLocationType | undefined;
|
|
548
1179
|
/**
|
|
549
|
-
* <p>
|
|
1180
|
+
* <p>The S3 data source location.</p>
|
|
550
1181
|
* @public
|
|
551
1182
|
*/
|
|
552
1183
|
s3Location?: RetrievalResultS3Location;
|
|
1184
|
+
/**
|
|
1185
|
+
* <p>The web URL/URLs data source location.</p>
|
|
1186
|
+
* @public
|
|
1187
|
+
*/
|
|
1188
|
+
webLocation?: RetrievalResultWebLocation;
|
|
1189
|
+
/**
|
|
1190
|
+
* <p>The Confluence data source location.</p>
|
|
1191
|
+
* @public
|
|
1192
|
+
*/
|
|
1193
|
+
confluenceLocation?: RetrievalResultConfluenceLocation;
|
|
1194
|
+
/**
|
|
1195
|
+
* <p>The Salesforce data source location.</p>
|
|
1196
|
+
* @public
|
|
1197
|
+
*/
|
|
1198
|
+
salesforceLocation?: RetrievalResultSalesforceLocation;
|
|
1199
|
+
/**
|
|
1200
|
+
* <p>The SharePoint data source location.</p>
|
|
1201
|
+
* @public
|
|
1202
|
+
*/
|
|
1203
|
+
sharePointLocation?: RetrievalResultSharePointLocation;
|
|
553
1204
|
}
|
|
554
1205
|
/**
|
|
555
1206
|
* <p>Contains metadata about a source cited for the generated response.</p>
|
|
@@ -638,16 +1289,36 @@ export interface PayloadPart {
|
|
|
638
1289
|
attribution?: Attribution;
|
|
639
1290
|
}
|
|
640
1291
|
/**
|
|
641
|
-
* <p>
|
|
1292
|
+
* <p>Contains details of the response from code interpreter.</p>
|
|
1293
|
+
* @public
|
|
1294
|
+
*/
|
|
1295
|
+
export interface OutputFile {
|
|
1296
|
+
/**
|
|
1297
|
+
* <p>The name of the file containing response from code interpreter.</p>
|
|
1298
|
+
* @public
|
|
1299
|
+
*/
|
|
1300
|
+
name?: string;
|
|
1301
|
+
/**
|
|
1302
|
+
* <p>The type of file that contains response from the code interpreter.</p>
|
|
1303
|
+
* @public
|
|
1304
|
+
*/
|
|
1305
|
+
type?: string;
|
|
1306
|
+
/**
|
|
1307
|
+
* <p>The byte count of files that contains response from code interpreter.</p>
|
|
1308
|
+
* @public
|
|
1309
|
+
*/
|
|
1310
|
+
bytes?: Uint8Array;
|
|
1311
|
+
}
|
|
1312
|
+
/**
|
|
1313
|
+
* <p>Contains intermediate response for code interpreter if any files have been generated.</p>
|
|
642
1314
|
* @public
|
|
643
1315
|
*/
|
|
644
|
-
export
|
|
645
|
-
readonly name: "ResourceNotFoundException";
|
|
646
|
-
readonly $fault: "client";
|
|
1316
|
+
export interface FilePart {
|
|
647
1317
|
/**
|
|
648
|
-
*
|
|
1318
|
+
* <p>Files containing intermediate response for the user.</p>
|
|
1319
|
+
* @public
|
|
649
1320
|
*/
|
|
650
|
-
|
|
1321
|
+
files?: OutputFile[];
|
|
651
1322
|
}
|
|
652
1323
|
/**
|
|
653
1324
|
* <p>Information about a parameter to provide to the API request.</p>
|
|
@@ -875,30 +1546,6 @@ export interface ReturnControlPayload {
|
|
|
875
1546
|
*/
|
|
876
1547
|
invocationId?: string;
|
|
877
1548
|
}
|
|
878
|
-
/**
|
|
879
|
-
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
880
|
-
* @public
|
|
881
|
-
*/
|
|
882
|
-
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
883
|
-
readonly name: "ServiceQuotaExceededException";
|
|
884
|
-
readonly $fault: "client";
|
|
885
|
-
/**
|
|
886
|
-
* @internal
|
|
887
|
-
*/
|
|
888
|
-
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
889
|
-
}
|
|
890
|
-
/**
|
|
891
|
-
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
892
|
-
* @public
|
|
893
|
-
*/
|
|
894
|
-
export declare class ThrottlingException extends __BaseException {
|
|
895
|
-
readonly name: "ThrottlingException";
|
|
896
|
-
readonly $fault: "client";
|
|
897
|
-
/**
|
|
898
|
-
* @internal
|
|
899
|
-
*/
|
|
900
|
-
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
901
|
-
}
|
|
902
1549
|
/**
|
|
903
1550
|
* <p>Contains information about the failure of the interaction.</p>
|
|
904
1551
|
* @public
|
|
@@ -1297,12 +1944,29 @@ export interface GuardrailTrace {
|
|
|
1297
1944
|
*/
|
|
1298
1945
|
outputAssessments?: GuardrailAssessment[];
|
|
1299
1946
|
}
|
|
1947
|
+
/**
|
|
1948
|
+
* <p>Contains information about the code interpreter being invoked.</p>
|
|
1949
|
+
* @public
|
|
1950
|
+
*/
|
|
1951
|
+
export interface CodeInterpreterInvocationInput {
|
|
1952
|
+
/**
|
|
1953
|
+
* <p>The code for the code interpreter to use.</p>
|
|
1954
|
+
* @public
|
|
1955
|
+
*/
|
|
1956
|
+
code?: string;
|
|
1957
|
+
/**
|
|
1958
|
+
* <p>Files that are uploaded for code interpreter to use.</p>
|
|
1959
|
+
* @public
|
|
1960
|
+
*/
|
|
1961
|
+
files?: string[];
|
|
1962
|
+
}
|
|
1300
1963
|
/**
|
|
1301
1964
|
* @public
|
|
1302
1965
|
* @enum
|
|
1303
1966
|
*/
|
|
1304
1967
|
export declare const InvocationType: {
|
|
1305
1968
|
readonly ACTION_GROUP: "ACTION_GROUP";
|
|
1969
|
+
readonly ACTION_GROUP_CODE_INTERPRETER: "ACTION_GROUP_CODE_INTERPRETER";
|
|
1306
1970
|
readonly FINISH: "FINISH";
|
|
1307
1971
|
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
1308
1972
|
};
|
|
@@ -1351,6 +2015,11 @@ export interface InvocationInput {
|
|
|
1351
2015
|
* @public
|
|
1352
2016
|
*/
|
|
1353
2017
|
knowledgeBaseLookupInput?: KnowledgeBaseLookupInput;
|
|
2018
|
+
/**
|
|
2019
|
+
* <p>Contains information about the code interpreter to be invoked.</p>
|
|
2020
|
+
* @public
|
|
2021
|
+
*/
|
|
2022
|
+
codeInterpreterInvocationInput?: CodeInterpreterInvocationInput;
|
|
1354
2023
|
}
|
|
1355
2024
|
/**
|
|
1356
2025
|
* <p>Specifications about the inference parameters that were provided alongside the prompt. These are specified in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
|
|
@@ -1461,6 +2130,32 @@ export interface ModelInvocationInput {
|
|
|
1461
2130
|
*/
|
|
1462
2131
|
parserMode?: CreationMode;
|
|
1463
2132
|
}
|
|
2133
|
+
/**
|
|
2134
|
+
* <p>Contains the JSON-formatted string returned by the API invoked by the code interpreter.</p>
|
|
2135
|
+
* @public
|
|
2136
|
+
*/
|
|
2137
|
+
export interface CodeInterpreterInvocationOutput {
|
|
2138
|
+
/**
|
|
2139
|
+
* <p>Contains the successful output returned from code execution</p>
|
|
2140
|
+
* @public
|
|
2141
|
+
*/
|
|
2142
|
+
executionOutput?: string;
|
|
2143
|
+
/**
|
|
2144
|
+
* <p>Contains the error returned from code execution.</p>
|
|
2145
|
+
* @public
|
|
2146
|
+
*/
|
|
2147
|
+
executionError?: string;
|
|
2148
|
+
/**
|
|
2149
|
+
* <p>Contains output files, if generated by code execution.</p>
|
|
2150
|
+
* @public
|
|
2151
|
+
*/
|
|
2152
|
+
files?: string[];
|
|
2153
|
+
/**
|
|
2154
|
+
* <p>Indicates if the execution of the code timed out.</p>
|
|
2155
|
+
* @public
|
|
2156
|
+
*/
|
|
2157
|
+
executionTimeout?: boolean;
|
|
2158
|
+
}
|
|
1464
2159
|
/**
|
|
1465
2160
|
* <p>Contains details about the response to the user.</p>
|
|
1466
2161
|
* @public
|
|
@@ -1584,6 +2279,11 @@ export interface Observation {
|
|
|
1584
2279
|
* @public
|
|
1585
2280
|
*/
|
|
1586
2281
|
repromptResponse?: RepromptResponse;
|
|
2282
|
+
/**
|
|
2283
|
+
* <p>Contains the JSON-formatted string returned by the API invoked by the code interpreter.</p>
|
|
2284
|
+
* @public
|
|
2285
|
+
*/
|
|
2286
|
+
codeInterpreterInvocationOutput?: CodeInterpreterInvocationOutput;
|
|
1587
2287
|
}
|
|
1588
2288
|
/**
|
|
1589
2289
|
* <p>Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.</p>
|
|
@@ -1970,23 +2670,11 @@ export interface TracePart {
|
|
|
1970
2670
|
*/
|
|
1971
2671
|
trace?: Trace;
|
|
1972
2672
|
}
|
|
1973
|
-
/**
|
|
1974
|
-
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
1975
|
-
* @public
|
|
1976
|
-
*/
|
|
1977
|
-
export declare class ValidationException extends __BaseException {
|
|
1978
|
-
readonly name: "ValidationException";
|
|
1979
|
-
readonly $fault: "client";
|
|
1980
|
-
/**
|
|
1981
|
-
* @internal
|
|
1982
|
-
*/
|
|
1983
|
-
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
1984
|
-
}
|
|
1985
2673
|
/**
|
|
1986
2674
|
* <p>The response from invoking the agent and associated citations and trace information.</p>
|
|
1987
2675
|
* @public
|
|
1988
2676
|
*/
|
|
1989
|
-
export type ResponseStream = ResponseStream.AccessDeniedExceptionMember | ResponseStream.BadGatewayExceptionMember | ResponseStream.ChunkMember | ResponseStream.ConflictExceptionMember | ResponseStream.DependencyFailedExceptionMember | ResponseStream.InternalServerExceptionMember | ResponseStream.ResourceNotFoundExceptionMember | ResponseStream.ReturnControlMember | ResponseStream.ServiceQuotaExceededExceptionMember | ResponseStream.ThrottlingExceptionMember | ResponseStream.TraceMember | ResponseStream.ValidationExceptionMember | ResponseStream.$UnknownMember;
|
|
2677
|
+
export type ResponseStream = ResponseStream.AccessDeniedExceptionMember | ResponseStream.BadGatewayExceptionMember | ResponseStream.ChunkMember | ResponseStream.ConflictExceptionMember | ResponseStream.DependencyFailedExceptionMember | ResponseStream.FilesMember | ResponseStream.InternalServerExceptionMember | ResponseStream.ResourceNotFoundExceptionMember | ResponseStream.ReturnControlMember | ResponseStream.ServiceQuotaExceededExceptionMember | ResponseStream.ThrottlingExceptionMember | ResponseStream.TraceMember | ResponseStream.ValidationExceptionMember | ResponseStream.$UnknownMember;
|
|
1990
2678
|
/**
|
|
1991
2679
|
* @public
|
|
1992
2680
|
*/
|
|
@@ -2008,6 +2696,7 @@ export declare namespace ResponseStream {
|
|
|
2008
2696
|
conflictException?: never;
|
|
2009
2697
|
dependencyFailedException?: never;
|
|
2010
2698
|
badGatewayException?: never;
|
|
2699
|
+
files?: never;
|
|
2011
2700
|
$unknown?: never;
|
|
2012
2701
|
}
|
|
2013
2702
|
/**
|
|
@@ -2027,6 +2716,7 @@ export declare namespace ResponseStream {
|
|
|
2027
2716
|
conflictException?: never;
|
|
2028
2717
|
dependencyFailedException?: never;
|
|
2029
2718
|
badGatewayException?: never;
|
|
2719
|
+
files?: never;
|
|
2030
2720
|
$unknown?: never;
|
|
2031
2721
|
}
|
|
2032
2722
|
/**
|
|
@@ -2046,6 +2736,7 @@ export declare namespace ResponseStream {
|
|
|
2046
2736
|
conflictException?: never;
|
|
2047
2737
|
dependencyFailedException?: never;
|
|
2048
2738
|
badGatewayException?: never;
|
|
2739
|
+
files?: never;
|
|
2049
2740
|
$unknown?: never;
|
|
2050
2741
|
}
|
|
2051
2742
|
/**
|
|
@@ -2065,6 +2756,7 @@ export declare namespace ResponseStream {
|
|
|
2065
2756
|
conflictException?: never;
|
|
2066
2757
|
dependencyFailedException?: never;
|
|
2067
2758
|
badGatewayException?: never;
|
|
2759
|
+
files?: never;
|
|
2068
2760
|
$unknown?: never;
|
|
2069
2761
|
}
|
|
2070
2762
|
/**
|
|
@@ -2084,6 +2776,7 @@ export declare namespace ResponseStream {
|
|
|
2084
2776
|
conflictException?: never;
|
|
2085
2777
|
dependencyFailedException?: never;
|
|
2086
2778
|
badGatewayException?: never;
|
|
2779
|
+
files?: never;
|
|
2087
2780
|
$unknown?: never;
|
|
2088
2781
|
}
|
|
2089
2782
|
/**
|
|
@@ -2103,6 +2796,7 @@ export declare namespace ResponseStream {
|
|
|
2103
2796
|
conflictException?: never;
|
|
2104
2797
|
dependencyFailedException?: never;
|
|
2105
2798
|
badGatewayException?: never;
|
|
2799
|
+
files?: never;
|
|
2106
2800
|
$unknown?: never;
|
|
2107
2801
|
}
|
|
2108
2802
|
/**
|
|
@@ -2122,6 +2816,7 @@ export declare namespace ResponseStream {
|
|
|
2122
2816
|
conflictException?: never;
|
|
2123
2817
|
dependencyFailedException?: never;
|
|
2124
2818
|
badGatewayException?: never;
|
|
2819
|
+
files?: never;
|
|
2125
2820
|
$unknown?: never;
|
|
2126
2821
|
}
|
|
2127
2822
|
/**
|
|
@@ -2141,6 +2836,7 @@ export declare namespace ResponseStream {
|
|
|
2141
2836
|
conflictException?: never;
|
|
2142
2837
|
dependencyFailedException?: never;
|
|
2143
2838
|
badGatewayException?: never;
|
|
2839
|
+
files?: never;
|
|
2144
2840
|
$unknown?: never;
|
|
2145
2841
|
}
|
|
2146
2842
|
/**
|
|
@@ -2160,6 +2856,7 @@ export declare namespace ResponseStream {
|
|
|
2160
2856
|
conflictException?: never;
|
|
2161
2857
|
dependencyFailedException?: never;
|
|
2162
2858
|
badGatewayException?: never;
|
|
2859
|
+
files?: never;
|
|
2163
2860
|
$unknown?: never;
|
|
2164
2861
|
}
|
|
2165
2862
|
/**
|
|
@@ -2179,100 +2876,281 @@ export declare namespace ResponseStream {
|
|
|
2179
2876
|
conflictException: ConflictException;
|
|
2180
2877
|
dependencyFailedException?: never;
|
|
2181
2878
|
badGatewayException?: never;
|
|
2879
|
+
files?: never;
|
|
2880
|
+
$unknown?: never;
|
|
2881
|
+
}
|
|
2882
|
+
/**
|
|
2883
|
+
* <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
|
|
2884
|
+
* @public
|
|
2885
|
+
*/
|
|
2886
|
+
interface DependencyFailedExceptionMember {
|
|
2887
|
+
chunk?: never;
|
|
2888
|
+
trace?: never;
|
|
2889
|
+
returnControl?: never;
|
|
2890
|
+
internalServerException?: never;
|
|
2891
|
+
validationException?: never;
|
|
2892
|
+
resourceNotFoundException?: never;
|
|
2893
|
+
serviceQuotaExceededException?: never;
|
|
2894
|
+
throttlingException?: never;
|
|
2895
|
+
accessDeniedException?: never;
|
|
2896
|
+
conflictException?: never;
|
|
2897
|
+
dependencyFailedException: DependencyFailedException;
|
|
2898
|
+
badGatewayException?: never;
|
|
2899
|
+
files?: never;
|
|
2900
|
+
$unknown?: never;
|
|
2901
|
+
}
|
|
2902
|
+
/**
|
|
2903
|
+
* <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
|
|
2904
|
+
* @public
|
|
2905
|
+
*/
|
|
2906
|
+
interface BadGatewayExceptionMember {
|
|
2907
|
+
chunk?: never;
|
|
2908
|
+
trace?: never;
|
|
2909
|
+
returnControl?: never;
|
|
2910
|
+
internalServerException?: never;
|
|
2911
|
+
validationException?: never;
|
|
2912
|
+
resourceNotFoundException?: never;
|
|
2913
|
+
serviceQuotaExceededException?: never;
|
|
2914
|
+
throttlingException?: never;
|
|
2915
|
+
accessDeniedException?: never;
|
|
2916
|
+
conflictException?: never;
|
|
2917
|
+
dependencyFailedException?: never;
|
|
2918
|
+
badGatewayException: BadGatewayException;
|
|
2919
|
+
files?: never;
|
|
2920
|
+
$unknown?: never;
|
|
2921
|
+
}
|
|
2922
|
+
/**
|
|
2923
|
+
* <p>Contains intermediate response for code interpreter if any files have been generated.</p>
|
|
2924
|
+
* @public
|
|
2925
|
+
*/
|
|
2926
|
+
interface FilesMember {
|
|
2927
|
+
chunk?: never;
|
|
2928
|
+
trace?: never;
|
|
2929
|
+
returnControl?: never;
|
|
2930
|
+
internalServerException?: never;
|
|
2931
|
+
validationException?: never;
|
|
2932
|
+
resourceNotFoundException?: never;
|
|
2933
|
+
serviceQuotaExceededException?: never;
|
|
2934
|
+
throttlingException?: never;
|
|
2935
|
+
accessDeniedException?: never;
|
|
2936
|
+
conflictException?: never;
|
|
2937
|
+
dependencyFailedException?: never;
|
|
2938
|
+
badGatewayException?: never;
|
|
2939
|
+
files: FilePart;
|
|
2182
2940
|
$unknown?: never;
|
|
2183
2941
|
}
|
|
2184
2942
|
/**
|
|
2185
|
-
* <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
|
|
2186
2943
|
* @public
|
|
2187
2944
|
*/
|
|
2188
|
-
interface
|
|
2189
|
-
chunk?: never;
|
|
2190
|
-
trace?: never;
|
|
2191
|
-
returnControl?: never;
|
|
2192
|
-
internalServerException?: never;
|
|
2193
|
-
validationException?: never;
|
|
2194
|
-
resourceNotFoundException?: never;
|
|
2195
|
-
serviceQuotaExceededException?: never;
|
|
2196
|
-
throttlingException?: never;
|
|
2197
|
-
accessDeniedException?: never;
|
|
2198
|
-
conflictException?: never;
|
|
2199
|
-
dependencyFailedException
|
|
2200
|
-
badGatewayException?: never;
|
|
2201
|
-
|
|
2202
|
-
|
|
2945
|
+
interface $UnknownMember {
|
|
2946
|
+
chunk?: never;
|
|
2947
|
+
trace?: never;
|
|
2948
|
+
returnControl?: never;
|
|
2949
|
+
internalServerException?: never;
|
|
2950
|
+
validationException?: never;
|
|
2951
|
+
resourceNotFoundException?: never;
|
|
2952
|
+
serviceQuotaExceededException?: never;
|
|
2953
|
+
throttlingException?: never;
|
|
2954
|
+
accessDeniedException?: never;
|
|
2955
|
+
conflictException?: never;
|
|
2956
|
+
dependencyFailedException?: never;
|
|
2957
|
+
badGatewayException?: never;
|
|
2958
|
+
files?: never;
|
|
2959
|
+
$unknown: [string, any];
|
|
2960
|
+
}
|
|
2961
|
+
interface Visitor<T> {
|
|
2962
|
+
chunk: (value: PayloadPart) => T;
|
|
2963
|
+
trace: (value: TracePart) => T;
|
|
2964
|
+
returnControl: (value: ReturnControlPayload) => T;
|
|
2965
|
+
internalServerException: (value: InternalServerException) => T;
|
|
2966
|
+
validationException: (value: ValidationException) => T;
|
|
2967
|
+
resourceNotFoundException: (value: ResourceNotFoundException) => T;
|
|
2968
|
+
serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T;
|
|
2969
|
+
throttlingException: (value: ThrottlingException) => T;
|
|
2970
|
+
accessDeniedException: (value: AccessDeniedException) => T;
|
|
2971
|
+
conflictException: (value: ConflictException) => T;
|
|
2972
|
+
dependencyFailedException: (value: DependencyFailedException) => T;
|
|
2973
|
+
badGatewayException: (value: BadGatewayException) => T;
|
|
2974
|
+
files: (value: FilePart) => T;
|
|
2975
|
+
_: (name: string, value: any) => T;
|
|
2976
|
+
}
|
|
2977
|
+
const visit: <T>(value: ResponseStream, visitor: Visitor<T>) => T;
|
|
2978
|
+
}
|
|
2979
|
+
/**
|
|
2980
|
+
* @public
|
|
2981
|
+
*/
|
|
2982
|
+
export interface InvokeAgentResponse {
|
|
2983
|
+
/**
|
|
2984
|
+
* <p>The agent's response to the user prompt.</p>
|
|
2985
|
+
* @public
|
|
2986
|
+
*/
|
|
2987
|
+
completion: AsyncIterable<ResponseStream> | undefined;
|
|
2988
|
+
/**
|
|
2989
|
+
* <p>The MIME type of the input data in the request. The default value is <code>application/json</code>.</p>
|
|
2990
|
+
* @public
|
|
2991
|
+
*/
|
|
2992
|
+
contentType: string | undefined;
|
|
2993
|
+
/**
|
|
2994
|
+
* <p>The unique identifier of the session with the agent.</p>
|
|
2995
|
+
* @public
|
|
2996
|
+
*/
|
|
2997
|
+
sessionId: string | undefined;
|
|
2998
|
+
/**
|
|
2999
|
+
* <p>The unique identifier of the agent memory.</p>
|
|
3000
|
+
* @public
|
|
3001
|
+
*/
|
|
3002
|
+
memoryId?: string;
|
|
3003
|
+
}
|
|
3004
|
+
/**
|
|
3005
|
+
* @public
|
|
3006
|
+
*/
|
|
3007
|
+
export interface DeleteAgentMemoryRequest {
|
|
3008
|
+
/**
|
|
3009
|
+
* <p>The unique identifier of the agent to which the alias belongs.</p>
|
|
3010
|
+
* @public
|
|
3011
|
+
*/
|
|
3012
|
+
agentId: string | undefined;
|
|
3013
|
+
/**
|
|
3014
|
+
* <p>The unique identifier of an alias of an agent.</p>
|
|
3015
|
+
* @public
|
|
3016
|
+
*/
|
|
3017
|
+
agentAliasId: string | undefined;
|
|
3018
|
+
/**
|
|
3019
|
+
* <p>The unique identifier of the memory.</p>
|
|
3020
|
+
* @public
|
|
3021
|
+
*/
|
|
3022
|
+
memoryId?: string;
|
|
3023
|
+
}
|
|
3024
|
+
/**
|
|
3025
|
+
* @public
|
|
3026
|
+
*/
|
|
3027
|
+
export interface DeleteAgentMemoryResponse {
|
|
3028
|
+
}
|
|
3029
|
+
/**
|
|
3030
|
+
* @public
|
|
3031
|
+
* @enum
|
|
3032
|
+
*/
|
|
3033
|
+
export declare const MemoryType: {
|
|
3034
|
+
readonly SESSION_SUMMARY: "SESSION_SUMMARY";
|
|
3035
|
+
};
|
|
3036
|
+
/**
|
|
3037
|
+
* @public
|
|
3038
|
+
*/
|
|
3039
|
+
export type MemoryType = (typeof MemoryType)[keyof typeof MemoryType];
|
|
3040
|
+
/**
|
|
3041
|
+
* @public
|
|
3042
|
+
*/
|
|
3043
|
+
export interface GetAgentMemoryRequest {
|
|
3044
|
+
/**
|
|
3045
|
+
* <p>If the total number of results is greater than the maxItems value provided in the request, enter the token returned
|
|
3046
|
+
* in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
3047
|
+
* @public
|
|
3048
|
+
*/
|
|
3049
|
+
nextToken?: string;
|
|
3050
|
+
/**
|
|
3051
|
+
* <p>The maximum number of items to return in the response. If the total number of results is greater
|
|
3052
|
+
* than this value, use the token returned in the response in the <code>nextToken</code> field when making another
|
|
3053
|
+
* request to return the next batch of results.</p>
|
|
3054
|
+
* @public
|
|
3055
|
+
*/
|
|
3056
|
+
maxItems?: number;
|
|
3057
|
+
/**
|
|
3058
|
+
* <p>The unique identifier of the agent to which the alias belongs.</p>
|
|
3059
|
+
* @public
|
|
3060
|
+
*/
|
|
3061
|
+
agentId: string | undefined;
|
|
3062
|
+
/**
|
|
3063
|
+
* <p>The unique identifier of an alias of an agent.</p>
|
|
3064
|
+
* @public
|
|
3065
|
+
*/
|
|
3066
|
+
agentAliasId: string | undefined;
|
|
3067
|
+
/**
|
|
3068
|
+
* <p>The type of memory.</p>
|
|
3069
|
+
* @public
|
|
3070
|
+
*/
|
|
3071
|
+
memoryType: MemoryType | undefined;
|
|
3072
|
+
/**
|
|
3073
|
+
* <p>The unique identifier of the memory. </p>
|
|
3074
|
+
* @public
|
|
3075
|
+
*/
|
|
3076
|
+
memoryId: string | undefined;
|
|
3077
|
+
}
|
|
3078
|
+
/**
|
|
3079
|
+
* <p>Contains details of a session summary.</p>
|
|
3080
|
+
* @public
|
|
3081
|
+
*/
|
|
3082
|
+
export interface MemorySessionSummary {
|
|
3083
|
+
/**
|
|
3084
|
+
* <p>The unique identifier of the memory where the session summary is stored.</p>
|
|
3085
|
+
* @public
|
|
3086
|
+
*/
|
|
3087
|
+
memoryId?: string;
|
|
3088
|
+
/**
|
|
3089
|
+
* <p>The identifier for this session.</p>
|
|
3090
|
+
* @public
|
|
3091
|
+
*/
|
|
3092
|
+
sessionId?: string;
|
|
3093
|
+
/**
|
|
3094
|
+
* <p>The start time for this session.</p>
|
|
3095
|
+
* @public
|
|
3096
|
+
*/
|
|
3097
|
+
sessionStartTime?: Date;
|
|
3098
|
+
/**
|
|
3099
|
+
* <p>The time when the memory duration for the session is set to end.</p>
|
|
3100
|
+
* @public
|
|
3101
|
+
*/
|
|
3102
|
+
sessionExpiryTime?: Date;
|
|
3103
|
+
/**
|
|
3104
|
+
* <p>The summarized text for this session.</p>
|
|
3105
|
+
* @public
|
|
3106
|
+
*/
|
|
3107
|
+
summaryText?: string;
|
|
3108
|
+
}
|
|
3109
|
+
/**
|
|
3110
|
+
* <p>Contains sessions summaries.</p>
|
|
3111
|
+
* @public
|
|
3112
|
+
*/
|
|
3113
|
+
export type Memory = Memory.SessionSummaryMember | Memory.$UnknownMember;
|
|
3114
|
+
/**
|
|
3115
|
+
* @public
|
|
3116
|
+
*/
|
|
3117
|
+
export declare namespace Memory {
|
|
2203
3118
|
/**
|
|
2204
|
-
* <p>
|
|
3119
|
+
* <p>Contains summary of a session.</p>
|
|
2205
3120
|
* @public
|
|
2206
3121
|
*/
|
|
2207
|
-
interface
|
|
2208
|
-
|
|
2209
|
-
trace?: never;
|
|
2210
|
-
returnControl?: never;
|
|
2211
|
-
internalServerException?: never;
|
|
2212
|
-
validationException?: never;
|
|
2213
|
-
resourceNotFoundException?: never;
|
|
2214
|
-
serviceQuotaExceededException?: never;
|
|
2215
|
-
throttlingException?: never;
|
|
2216
|
-
accessDeniedException?: never;
|
|
2217
|
-
conflictException?: never;
|
|
2218
|
-
dependencyFailedException?: never;
|
|
2219
|
-
badGatewayException: BadGatewayException;
|
|
3122
|
+
interface SessionSummaryMember {
|
|
3123
|
+
sessionSummary: MemorySessionSummary;
|
|
2220
3124
|
$unknown?: never;
|
|
2221
3125
|
}
|
|
2222
3126
|
/**
|
|
2223
3127
|
* @public
|
|
2224
3128
|
*/
|
|
2225
3129
|
interface $UnknownMember {
|
|
2226
|
-
|
|
2227
|
-
trace?: never;
|
|
2228
|
-
returnControl?: never;
|
|
2229
|
-
internalServerException?: never;
|
|
2230
|
-
validationException?: never;
|
|
2231
|
-
resourceNotFoundException?: never;
|
|
2232
|
-
serviceQuotaExceededException?: never;
|
|
2233
|
-
throttlingException?: never;
|
|
2234
|
-
accessDeniedException?: never;
|
|
2235
|
-
conflictException?: never;
|
|
2236
|
-
dependencyFailedException?: never;
|
|
2237
|
-
badGatewayException?: never;
|
|
3130
|
+
sessionSummary?: never;
|
|
2238
3131
|
$unknown: [string, any];
|
|
2239
3132
|
}
|
|
2240
3133
|
interface Visitor<T> {
|
|
2241
|
-
|
|
2242
|
-
trace: (value: TracePart) => T;
|
|
2243
|
-
returnControl: (value: ReturnControlPayload) => T;
|
|
2244
|
-
internalServerException: (value: InternalServerException) => T;
|
|
2245
|
-
validationException: (value: ValidationException) => T;
|
|
2246
|
-
resourceNotFoundException: (value: ResourceNotFoundException) => T;
|
|
2247
|
-
serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T;
|
|
2248
|
-
throttlingException: (value: ThrottlingException) => T;
|
|
2249
|
-
accessDeniedException: (value: AccessDeniedException) => T;
|
|
2250
|
-
conflictException: (value: ConflictException) => T;
|
|
2251
|
-
dependencyFailedException: (value: DependencyFailedException) => T;
|
|
2252
|
-
badGatewayException: (value: BadGatewayException) => T;
|
|
3134
|
+
sessionSummary: (value: MemorySessionSummary) => T;
|
|
2253
3135
|
_: (name: string, value: any) => T;
|
|
2254
3136
|
}
|
|
2255
|
-
const visit: <T>(value:
|
|
3137
|
+
const visit: <T>(value: Memory, visitor: Visitor<T>) => T;
|
|
2256
3138
|
}
|
|
2257
3139
|
/**
|
|
2258
3140
|
* @public
|
|
2259
3141
|
*/
|
|
2260
|
-
export interface
|
|
2261
|
-
/**
|
|
2262
|
-
* <p>The agent's response to the user prompt.</p>
|
|
2263
|
-
* @public
|
|
2264
|
-
*/
|
|
2265
|
-
completion: AsyncIterable<ResponseStream> | undefined;
|
|
3142
|
+
export interface GetAgentMemoryResponse {
|
|
2266
3143
|
/**
|
|
2267
|
-
* <p>
|
|
3144
|
+
* <p>If the total number of results is greater than the maxItems value provided in the request, use this token
|
|
3145
|
+
* when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
2268
3146
|
* @public
|
|
2269
3147
|
*/
|
|
2270
|
-
|
|
3148
|
+
nextToken?: string;
|
|
2271
3149
|
/**
|
|
2272
|
-
* <p>
|
|
3150
|
+
* <p>Contains details of the sessions stored in the memory</p>
|
|
2273
3151
|
* @public
|
|
2274
3152
|
*/
|
|
2275
|
-
|
|
3153
|
+
memoryContents?: Memory[];
|
|
2276
3154
|
}
|
|
2277
3155
|
/**
|
|
2278
3156
|
* <p>Contains the query made to the knowledge base.</p>
|
|
@@ -2536,41 +3414,40 @@ export interface GenerationConfiguration {
|
|
|
2536
3414
|
additionalModelRequestFields?: Record<string, __DocumentType>;
|
|
2537
3415
|
}
|
|
2538
3416
|
/**
|
|
2539
|
-
* <p>Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
|
|
2540
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2541
|
-
* <ul>
|
|
2542
|
-
* <li>
|
|
2543
|
-
* <p>
|
|
2544
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a>
|
|
2545
|
-
* </p>
|
|
2546
|
-
* </li>
|
|
2547
|
-
* </ul>
|
|
2548
3417
|
* @public
|
|
3418
|
+
* @enum
|
|
2549
3419
|
*/
|
|
2550
|
-
export
|
|
2551
|
-
|
|
2552
|
-
|
|
2553
|
-
|
|
2554
|
-
|
|
2555
|
-
|
|
3420
|
+
export declare const QueryTransformationType: {
|
|
3421
|
+
readonly QUERY_DECOMPOSITION: "QUERY_DECOMPOSITION";
|
|
3422
|
+
};
|
|
3423
|
+
/**
|
|
3424
|
+
* @public
|
|
3425
|
+
*/
|
|
3426
|
+
export type QueryTransformationType = (typeof QueryTransformationType)[keyof typeof QueryTransformationType];
|
|
3427
|
+
/**
|
|
3428
|
+
* <p>To split up the prompt and retrieve multiple sources, set the transformation type to
|
|
3429
|
+
* <code>QUERY_DECOMPOSITION</code>.</p>
|
|
3430
|
+
* @public
|
|
3431
|
+
*/
|
|
3432
|
+
export interface QueryTransformationConfiguration {
|
|
2556
3433
|
/**
|
|
2557
|
-
* <p>The
|
|
3434
|
+
* <p>The type of transformation to apply to the prompt.</p>
|
|
2558
3435
|
* @public
|
|
2559
3436
|
*/
|
|
2560
|
-
|
|
3437
|
+
type: QueryTransformationType | undefined;
|
|
2561
3438
|
}
|
|
2562
3439
|
/**
|
|
2563
|
-
*
|
|
2564
|
-
* @enum
|
|
2565
|
-
*/
|
|
2566
|
-
export declare const SearchType: {
|
|
2567
|
-
readonly HYBRID: "HYBRID";
|
|
2568
|
-
readonly SEMANTIC: "SEMANTIC";
|
|
2569
|
-
};
|
|
2570
|
-
/**
|
|
3440
|
+
* <p>Settings for how the model processes the prompt prior to retrieval and generation.</p>
|
|
2571
3441
|
* @public
|
|
2572
3442
|
*/
|
|
2573
|
-
export
|
|
3443
|
+
export interface OrchestrationConfiguration {
|
|
3444
|
+
/**
|
|
3445
|
+
* <p>To split up the prompt and retrieve multiple sources, set the transformation type to
|
|
3446
|
+
* <code>QUERY_DECOMPOSITION</code>.</p>
|
|
3447
|
+
* @public
|
|
3448
|
+
*/
|
|
3449
|
+
queryTransformationConfiguration: QueryTransformationConfiguration | undefined;
|
|
3450
|
+
}
|
|
2574
3451
|
/**
|
|
2575
3452
|
* @public
|
|
2576
3453
|
* @enum
|
|
@@ -2636,7 +3513,7 @@ export interface RetrieveAndGenerateOutput {
|
|
|
2636
3513
|
*/
|
|
2637
3514
|
export interface RetrieveAndGenerateResponse {
|
|
2638
3515
|
/**
|
|
2639
|
-
* <p>The unique identifier of the session.
|
|
3516
|
+
* <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
|
|
2640
3517
|
* @public
|
|
2641
3518
|
*/
|
|
2642
3519
|
sessionId: string | undefined;
|
|
@@ -3126,7 +4003,7 @@ export interface KnowledgeBaseVectorSearchConfiguration {
|
|
|
3126
4003
|
filter?: RetrievalFilter;
|
|
3127
4004
|
}
|
|
3128
4005
|
/**
|
|
3129
|
-
* <p>Contains configurations for
|
|
4006
|
+
* <p>Contains configurations for knowledge base query. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
|
|
3130
4007
|
* <p>This data type is used in the following API operations:</p>
|
|
3131
4008
|
* <ul>
|
|
3132
4009
|
* <li>
|
|
@@ -3147,6 +4024,22 @@ export interface KnowledgeBaseRetrievalConfiguration {
|
|
|
3147
4024
|
*/
|
|
3148
4025
|
vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined;
|
|
3149
4026
|
}
|
|
4027
|
+
/**
|
|
4028
|
+
* <p>Configurations to apply to a knowledge base attached to the agent during query. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html#session-state-kb">Knowledge base retrieval configurations</a>.</p>
|
|
4029
|
+
* @public
|
|
4030
|
+
*/
|
|
4031
|
+
export interface KnowledgeBaseConfiguration {
|
|
4032
|
+
/**
|
|
4033
|
+
* <p>The unique identifier for a knowledge base attached to the agent.</p>
|
|
4034
|
+
* @public
|
|
4035
|
+
*/
|
|
4036
|
+
knowledgeBaseId: string | undefined;
|
|
4037
|
+
/**
|
|
4038
|
+
* <p>The configurations to apply to the knowledge base during query. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
|
|
4039
|
+
* @public
|
|
4040
|
+
*/
|
|
4041
|
+
retrievalConfiguration: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
4042
|
+
}
|
|
3150
4043
|
/**
|
|
3151
4044
|
* <p>Contains details about the resource being queried.</p>
|
|
3152
4045
|
* <p>This data type is used in the following API operations:</p>
|
|
@@ -3179,10 +4072,15 @@ export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
|
|
|
3179
4072
|
*/
|
|
3180
4073
|
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
|
|
3181
4074
|
/**
|
|
3182
|
-
* <p>Contains configurations for response generation based on the
|
|
4075
|
+
* <p>Contains configurations for response generation based on the knowledge base query results.</p>
|
|
3183
4076
|
* @public
|
|
3184
4077
|
*/
|
|
3185
4078
|
generationConfiguration?: GenerationConfiguration;
|
|
4079
|
+
/**
|
|
4080
|
+
* <p>Settings for how the model processes the prompt prior to retrieval and generation.</p>
|
|
4081
|
+
* @public
|
|
4082
|
+
*/
|
|
4083
|
+
orchestrationConfiguration?: OrchestrationConfiguration;
|
|
3186
4084
|
}
|
|
3187
4085
|
/**
|
|
3188
4086
|
* @public
|
|
@@ -3242,7 +4140,7 @@ export interface RetrieveAndGenerateConfiguration {
|
|
|
3242
4140
|
*/
|
|
3243
4141
|
export interface RetrieveAndGenerateRequest {
|
|
3244
4142
|
/**
|
|
3245
|
-
* <p>The unique identifier of the session.
|
|
4143
|
+
* <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
|
|
3246
4144
|
* @public
|
|
3247
4145
|
*/
|
|
3248
4146
|
sessionId?: string;
|
|
@@ -3262,6 +4160,96 @@ export interface RetrieveAndGenerateRequest {
|
|
|
3262
4160
|
*/
|
|
3263
4161
|
sessionConfiguration?: RetrieveAndGenerateSessionConfiguration;
|
|
3264
4162
|
}
|
|
4163
|
+
/**
|
|
4164
|
+
* <p>Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html">Lambda function</a> for an action group or pass them when making an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
4165
|
+
* @public
|
|
4166
|
+
*/
|
|
4167
|
+
export interface SessionState {
|
|
4168
|
+
/**
|
|
4169
|
+
* <p>Contains attributes that persist across a session and the values of those attributes.</p>
|
|
4170
|
+
* @public
|
|
4171
|
+
*/
|
|
4172
|
+
sessionAttributes?: Record<string, string>;
|
|
4173
|
+
/**
|
|
4174
|
+
* <p>Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Prompt template placeholder variables</a>.</p>
|
|
4175
|
+
* @public
|
|
4176
|
+
*/
|
|
4177
|
+
promptSessionAttributes?: Record<string, string>;
|
|
4178
|
+
/**
|
|
4179
|
+
* <p>Contains information about the results from the action group invocation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
4180
|
+
* <note>
|
|
4181
|
+
* <p>If you include this field, the <code>inputText</code> field will be ignored.</p>
|
|
4182
|
+
* </note>
|
|
4183
|
+
* @public
|
|
4184
|
+
*/
|
|
4185
|
+
returnControlInvocationResults?: InvocationResultMember[];
|
|
4186
|
+
/**
|
|
4187
|
+
* <p>The identifier of the invocation of an action. This value must match the <code>invocationId</code> returned in the <code>InvokeAgent</code> response for the action whose results are provided in the <code>returnControlInvocationResults</code> field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
4188
|
+
* @public
|
|
4189
|
+
*/
|
|
4190
|
+
invocationId?: string;
|
|
4191
|
+
/**
|
|
4192
|
+
* <p>Contains information about the files used by code interpreter.</p>
|
|
4193
|
+
* @public
|
|
4194
|
+
*/
|
|
4195
|
+
files?: InputFile[];
|
|
4196
|
+
/**
|
|
4197
|
+
* <p>An array of configurations, each of which applies to a knowledge base attached to the agent.</p>
|
|
4198
|
+
* @public
|
|
4199
|
+
*/
|
|
4200
|
+
knowledgeBaseConfigurations?: KnowledgeBaseConfiguration[];
|
|
4201
|
+
}
|
|
4202
|
+
/**
|
|
4203
|
+
* @public
|
|
4204
|
+
*/
|
|
4205
|
+
export interface InvokeAgentRequest {
|
|
4206
|
+
/**
|
|
4207
|
+
* <p>Contains parameters that specify various attributes of the session. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
4208
|
+
* <note>
|
|
4209
|
+
* <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
|
|
4210
|
+
* </note>
|
|
4211
|
+
* @public
|
|
4212
|
+
*/
|
|
4213
|
+
sessionState?: SessionState;
|
|
4214
|
+
/**
|
|
4215
|
+
* <p>The unique identifier of the agent to use.</p>
|
|
4216
|
+
* @public
|
|
4217
|
+
*/
|
|
4218
|
+
agentId: string | undefined;
|
|
4219
|
+
/**
|
|
4220
|
+
* <p>The alias of the agent to use.</p>
|
|
4221
|
+
* @public
|
|
4222
|
+
*/
|
|
4223
|
+
agentAliasId: string | undefined;
|
|
4224
|
+
/**
|
|
4225
|
+
* <p>The unique identifier of the session. Use the same value across requests to continue the same conversation.</p>
|
|
4226
|
+
* @public
|
|
4227
|
+
*/
|
|
4228
|
+
sessionId: string | undefined;
|
|
4229
|
+
/**
|
|
4230
|
+
* <p>Specifies whether to end the session with the agent or not.</p>
|
|
4231
|
+
* @public
|
|
4232
|
+
*/
|
|
4233
|
+
endSession?: boolean;
|
|
4234
|
+
/**
|
|
4235
|
+
* <p>Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events">Trace enablement</a>.</p>
|
|
4236
|
+
* @public
|
|
4237
|
+
*/
|
|
4238
|
+
enableTrace?: boolean;
|
|
4239
|
+
/**
|
|
4240
|
+
* <p>The prompt text to send the agent.</p>
|
|
4241
|
+
* <note>
|
|
4242
|
+
* <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
|
|
4243
|
+
* </note>
|
|
4244
|
+
* @public
|
|
4245
|
+
*/
|
|
4246
|
+
inputText?: string;
|
|
4247
|
+
/**
|
|
4248
|
+
* <p>The unique identifier of the agent memory.</p>
|
|
4249
|
+
* @public
|
|
4250
|
+
*/
|
|
4251
|
+
memoryId?: string;
|
|
4252
|
+
}
|
|
3265
4253
|
/**
|
|
3266
4254
|
* @internal
|
|
3267
4255
|
*/
|
|
@@ -3273,19 +4261,51 @@ export declare const ActionGroupInvocationOutputFilterSensitiveLog: (obj: Action
|
|
|
3273
4261
|
/**
|
|
3274
4262
|
* @internal
|
|
3275
4263
|
*/
|
|
3276
|
-
export declare const
|
|
4264
|
+
export declare const FlowInputContentFilterSensitiveLog: (obj: FlowInputContent) => any;
|
|
3277
4265
|
/**
|
|
3278
4266
|
* @internal
|
|
3279
4267
|
*/
|
|
3280
|
-
export declare const
|
|
4268
|
+
export declare const FlowInputFilterSensitiveLog: (obj: FlowInput) => any;
|
|
3281
4269
|
/**
|
|
3282
4270
|
* @internal
|
|
3283
4271
|
*/
|
|
3284
|
-
export declare const
|
|
4272
|
+
export declare const InvokeFlowRequestFilterSensitiveLog: (obj: InvokeFlowRequest) => any;
|
|
3285
4273
|
/**
|
|
3286
4274
|
* @internal
|
|
3287
4275
|
*/
|
|
3288
|
-
export declare const
|
|
4276
|
+
export declare const FlowCompletionEventFilterSensitiveLog: (obj: FlowCompletionEvent) => any;
|
|
4277
|
+
/**
|
|
4278
|
+
* @internal
|
|
4279
|
+
*/
|
|
4280
|
+
export declare const FlowOutputEventFilterSensitiveLog: (obj: FlowOutputEvent) => any;
|
|
4281
|
+
/**
|
|
4282
|
+
* @internal
|
|
4283
|
+
*/
|
|
4284
|
+
export declare const FlowResponseStreamFilterSensitiveLog: (obj: FlowResponseStream) => any;
|
|
4285
|
+
/**
|
|
4286
|
+
* @internal
|
|
4287
|
+
*/
|
|
4288
|
+
export declare const InvokeFlowResponseFilterSensitiveLog: (obj: InvokeFlowResponse) => any;
|
|
4289
|
+
/**
|
|
4290
|
+
* @internal
|
|
4291
|
+
*/
|
|
4292
|
+
export declare const ByteContentFileFilterSensitiveLog: (obj: ByteContentFile) => any;
|
|
4293
|
+
/**
|
|
4294
|
+
* @internal
|
|
4295
|
+
*/
|
|
4296
|
+
export declare const FileSourceFilterSensitiveLog: (obj: FileSource) => any;
|
|
4297
|
+
/**
|
|
4298
|
+
* @internal
|
|
4299
|
+
*/
|
|
4300
|
+
export declare const InputFileFilterSensitiveLog: (obj: InputFile) => any;
|
|
4301
|
+
/**
|
|
4302
|
+
* @internal
|
|
4303
|
+
*/
|
|
4304
|
+
export declare const ApiResultFilterSensitiveLog: (obj: ApiResult) => any;
|
|
4305
|
+
/**
|
|
4306
|
+
* @internal
|
|
4307
|
+
*/
|
|
4308
|
+
export declare const InvocationResultMemberFilterSensitiveLog: (obj: InvocationResultMember) => any;
|
|
3289
4309
|
/**
|
|
3290
4310
|
* @internal
|
|
3291
4311
|
*/
|
|
@@ -3318,6 +4338,14 @@ export declare const AttributionFilterSensitiveLog: (obj: Attribution) => any;
|
|
|
3318
4338
|
* @internal
|
|
3319
4339
|
*/
|
|
3320
4340
|
export declare const PayloadPartFilterSensitiveLog: (obj: PayloadPart) => any;
|
|
4341
|
+
/**
|
|
4342
|
+
* @internal
|
|
4343
|
+
*/
|
|
4344
|
+
export declare const OutputFileFilterSensitiveLog: (obj: OutputFile) => any;
|
|
4345
|
+
/**
|
|
4346
|
+
* @internal
|
|
4347
|
+
*/
|
|
4348
|
+
export declare const FilePartFilterSensitiveLog: (obj: FilePart) => any;
|
|
3321
4349
|
/**
|
|
3322
4350
|
* @internal
|
|
3323
4351
|
*/
|
|
@@ -3518,6 +4546,10 @@ export declare const KnowledgeBaseVectorSearchConfigurationFilterSensitiveLog: (
|
|
|
3518
4546
|
* @internal
|
|
3519
4547
|
*/
|
|
3520
4548
|
export declare const KnowledgeBaseRetrievalConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrievalConfiguration) => any;
|
|
4549
|
+
/**
|
|
4550
|
+
* @internal
|
|
4551
|
+
*/
|
|
4552
|
+
export declare const KnowledgeBaseConfigurationFilterSensitiveLog: (obj: KnowledgeBaseConfiguration) => any;
|
|
3521
4553
|
/**
|
|
3522
4554
|
* @internal
|
|
3523
4555
|
*/
|
|
@@ -3534,3 +4566,11 @@ export declare const RetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: R
|
|
|
3534
4566
|
* @internal
|
|
3535
4567
|
*/
|
|
3536
4568
|
export declare const RetrieveAndGenerateRequestFilterSensitiveLog: (obj: RetrieveAndGenerateRequest) => any;
|
|
4569
|
+
/**
|
|
4570
|
+
* @internal
|
|
4571
|
+
*/
|
|
4572
|
+
export declare const SessionStateFilterSensitiveLog: (obj: SessionState) => any;
|
|
4573
|
+
/**
|
|
4574
|
+
* @internal
|
|
4575
|
+
*/
|
|
4576
|
+
export declare const InvokeAgentRequestFilterSensitiveLog: (obj: InvokeAgentRequest) => any;
|