@aws-sdk/client-bedrock-agent-runtime 3.798.0 → 3.800.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/dist-cjs/index.js +27 -2
- package/dist-cjs/runtimeConfig.js +1 -0
- package/dist-es/models/models_0.js +14 -0
- package/dist-es/models/models_1.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +6 -0
- package/dist-es/runtimeConfig.js +2 -1
- package/dist-types/commands/CreateInvocationCommand.d.ts +1 -20
- package/dist-types/commands/CreateSessionCommand.d.ts +1 -36
- package/dist-types/commands/DeleteSessionCommand.d.ts +1 -3
- package/dist-types/commands/EndSessionCommand.d.ts +1 -3
- package/dist-types/commands/InvokeAgentCommand.d.ts +5 -42
- package/dist-types/commands/InvokeFlowCommand.d.ts +1 -4
- package/dist-types/commands/InvokeInlineAgentCommand.d.ts +15 -25
- package/dist-types/commands/ListSessionsCommand.d.ts +3 -1
- package/dist-types/commands/PutInvocationStepCommand.d.ts +1 -24
- package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +1 -5
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSessionCommand.d.ts +1 -2
- package/dist-types/models/models_0.d.ts +218 -824
- package/dist-types/models/models_1.d.ts +132 -274
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSessionsCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UpdateSessionCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +33 -18
- package/dist-types/ts3.4/models/models_1.d.ts +20 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -4
- package/package.json +5 -5
|
@@ -25,10 +25,7 @@ export declare const CustomControlMethod: {
|
|
|
25
25
|
*/
|
|
26
26
|
export type CustomControlMethod = (typeof CustomControlMethod)[keyof typeof CustomControlMethod];
|
|
27
27
|
/**
|
|
28
|
-
* <p>
|
|
29
|
-
* Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the
|
|
30
|
-
* custom control method for handling the information elicited from the user.
|
|
31
|
-
* </p>
|
|
28
|
+
* <p> Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user. </p>
|
|
32
29
|
* @public
|
|
33
30
|
*/
|
|
34
31
|
export type ActionGroupExecutor = ActionGroupExecutor.CustomControlMember | ActionGroupExecutor.LambdaMember | ActionGroupExecutor.$UnknownMember;
|
|
@@ -37,9 +34,7 @@ export type ActionGroupExecutor = ActionGroupExecutor.CustomControlMember | Acti
|
|
|
37
34
|
*/
|
|
38
35
|
export declare namespace ActionGroupExecutor {
|
|
39
36
|
/**
|
|
40
|
-
* <p>
|
|
41
|
-
* The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
|
|
42
|
-
* </p>
|
|
37
|
+
* <p> The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action. </p>
|
|
43
38
|
* @public
|
|
44
39
|
*/
|
|
45
40
|
interface LambdaMember {
|
|
@@ -48,9 +43,7 @@ export declare namespace ActionGroupExecutor {
|
|
|
48
43
|
$unknown?: never;
|
|
49
44
|
}
|
|
50
45
|
/**
|
|
51
|
-
* <p>
|
|
52
|
-
* To return the action group invocation results directly in the <code>InvokeInlineAgent</code> response, specify <code>RETURN_CONTROL</code>.
|
|
53
|
-
* </p>
|
|
46
|
+
* <p> To return the action group invocation results directly in the <code>InvokeInlineAgent</code> response, specify <code>RETURN_CONTROL</code>. </p>
|
|
54
47
|
* @public
|
|
55
48
|
*/
|
|
56
49
|
interface CustomControlMember {
|
|
@@ -203,32 +196,23 @@ export declare const ActionInvocationType: {
|
|
|
203
196
|
*/
|
|
204
197
|
export type ActionInvocationType = (typeof ActionInvocationType)[keyof typeof ActionInvocationType];
|
|
205
198
|
/**
|
|
206
|
-
* <p>
|
|
207
|
-
* The identifier information for an Amazon S3 bucket.
|
|
208
|
-
* </p>
|
|
199
|
+
* <p> The identifier information for an Amazon S3 bucket. </p>
|
|
209
200
|
* @public
|
|
210
201
|
*/
|
|
211
202
|
export interface S3Identifier {
|
|
212
203
|
/**
|
|
213
|
-
* <p>
|
|
214
|
-
* The name of the S3 bucket.
|
|
215
|
-
* </p>
|
|
204
|
+
* <p> The name of the S3 bucket. </p>
|
|
216
205
|
* @public
|
|
217
206
|
*/
|
|
218
207
|
s3BucketName?: string | undefined;
|
|
219
208
|
/**
|
|
220
|
-
* <p>
|
|
221
|
-
* The S3 object key for the S3 resource.
|
|
222
|
-
* </p>
|
|
209
|
+
* <p> The S3 object key for the S3 resource. </p>
|
|
223
210
|
* @public
|
|
224
211
|
*/
|
|
225
212
|
s3ObjectKey?: string | undefined;
|
|
226
213
|
}
|
|
227
214
|
/**
|
|
228
|
-
* <p>
|
|
229
|
-
* Contains details about the OpenAPI schema for the action group. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>.
|
|
230
|
-
* You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
|
|
231
|
-
* </p>
|
|
215
|
+
* <p> Contains details about the OpenAPI schema for the action group. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field. </p>
|
|
232
216
|
* @public
|
|
233
217
|
*/
|
|
234
218
|
export type APISchema = APISchema.PayloadMember | APISchema.S3Member | APISchema.$UnknownMember;
|
|
@@ -237,9 +221,7 @@ export type APISchema = APISchema.PayloadMember | APISchema.S3Member | APISchema
|
|
|
237
221
|
*/
|
|
238
222
|
export declare namespace APISchema {
|
|
239
223
|
/**
|
|
240
|
-
* <p>
|
|
241
|
-
* Contains details about the S3 object containing the OpenAPI schema for the action group.
|
|
242
|
-
* </p>
|
|
224
|
+
* <p> Contains details about the S3 object containing the OpenAPI schema for the action group. </p>
|
|
243
225
|
* @public
|
|
244
226
|
*/
|
|
245
227
|
interface S3Member {
|
|
@@ -248,9 +230,7 @@ export declare namespace APISchema {
|
|
|
248
230
|
$unknown?: never;
|
|
249
231
|
}
|
|
250
232
|
/**
|
|
251
|
-
* <p>
|
|
252
|
-
* The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
|
|
253
|
-
* </p>
|
|
233
|
+
* <p> The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. </p>
|
|
254
234
|
* @public
|
|
255
235
|
*/
|
|
256
236
|
interface PayloadMember {
|
|
@@ -289,30 +269,22 @@ export declare const ParameterType: {
|
|
|
289
269
|
*/
|
|
290
270
|
export type ParameterType = (typeof ParameterType)[keyof typeof ParameterType];
|
|
291
271
|
/**
|
|
292
|
-
* <p>
|
|
293
|
-
* Contains details about a parameter in a function for an action group.
|
|
294
|
-
* </p>
|
|
272
|
+
* <p> Contains details about a parameter in a function for an action group. </p>
|
|
295
273
|
* @public
|
|
296
274
|
*/
|
|
297
275
|
export interface ParameterDetail {
|
|
298
276
|
/**
|
|
299
|
-
* <p>
|
|
300
|
-
* A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
|
|
301
|
-
* </p>
|
|
277
|
+
* <p> A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user. </p>
|
|
302
278
|
* @public
|
|
303
279
|
*/
|
|
304
280
|
description?: string | undefined;
|
|
305
281
|
/**
|
|
306
|
-
* <p>
|
|
307
|
-
* The data type of the parameter.
|
|
308
|
-
* </p>
|
|
282
|
+
* <p> The data type of the parameter. </p>
|
|
309
283
|
* @public
|
|
310
284
|
*/
|
|
311
285
|
type: ParameterType | undefined;
|
|
312
286
|
/**
|
|
313
|
-
* <p>
|
|
314
|
-
* Whether the parameter is required for the agent to complete the function for action group invocation.
|
|
315
|
-
* </p>
|
|
287
|
+
* <p> Whether the parameter is required for the agent to complete the function for action group invocation. </p>
|
|
316
288
|
* @public
|
|
317
289
|
*/
|
|
318
290
|
required?: boolean | undefined;
|
|
@@ -330,45 +302,33 @@ export declare const RequireConfirmation: {
|
|
|
330
302
|
*/
|
|
331
303
|
export type RequireConfirmation = (typeof RequireConfirmation)[keyof typeof RequireConfirmation];
|
|
332
304
|
/**
|
|
333
|
-
* <p>
|
|
334
|
-
* Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
|
|
335
|
-
* </p>
|
|
305
|
+
* <p> Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group. </p>
|
|
336
306
|
* @public
|
|
337
307
|
*/
|
|
338
308
|
export interface FunctionDefinition {
|
|
339
309
|
/**
|
|
340
|
-
* <p>
|
|
341
|
-
* A name for the function.
|
|
342
|
-
* </p>
|
|
310
|
+
* <p> A name for the function. </p>
|
|
343
311
|
* @public
|
|
344
312
|
*/
|
|
345
313
|
name: string | undefined;
|
|
346
314
|
/**
|
|
347
|
-
* <p>
|
|
348
|
-
* A description of the function and its purpose.
|
|
349
|
-
* </p>
|
|
315
|
+
* <p> A description of the function and its purpose. </p>
|
|
350
316
|
* @public
|
|
351
317
|
*/
|
|
352
318
|
description?: string | undefined;
|
|
353
319
|
/**
|
|
354
|
-
* <p>
|
|
355
|
-
* The parameters that the agent elicits from the user to fulfill the function.
|
|
356
|
-
* </p>
|
|
320
|
+
* <p> The parameters that the agent elicits from the user to fulfill the function. </p>
|
|
357
321
|
* @public
|
|
358
322
|
*/
|
|
359
323
|
parameters?: Record<string, ParameterDetail> | undefined;
|
|
360
324
|
/**
|
|
361
|
-
* <p>
|
|
362
|
-
* Contains information if user confirmation is required to invoke the function.
|
|
363
|
-
* </p>
|
|
325
|
+
* <p> Contains information if user confirmation is required to invoke the function. </p>
|
|
364
326
|
* @public
|
|
365
327
|
*/
|
|
366
328
|
requireConfirmation?: RequireConfirmation | undefined;
|
|
367
329
|
}
|
|
368
330
|
/**
|
|
369
|
-
* <p>
|
|
370
|
-
* Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
|
|
371
|
-
* </p>
|
|
331
|
+
* <p> Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema. </p>
|
|
372
332
|
* @public
|
|
373
333
|
*/
|
|
374
334
|
export type FunctionSchema = FunctionSchema.FunctionsMember | FunctionSchema.$UnknownMember;
|
|
@@ -377,9 +337,7 @@ export type FunctionSchema = FunctionSchema.FunctionsMember | FunctionSchema.$Un
|
|
|
377
337
|
*/
|
|
378
338
|
export declare namespace FunctionSchema {
|
|
379
339
|
/**
|
|
380
|
-
* <p>
|
|
381
|
-
* A list of functions that each define an action in the action group.
|
|
382
|
-
* </p>
|
|
340
|
+
* <p> A list of functions that each define an action in the action group. </p>
|
|
383
341
|
* @public
|
|
384
342
|
*/
|
|
385
343
|
interface FunctionsMember {
|
|
@@ -400,95 +358,42 @@ export declare namespace FunctionSchema {
|
|
|
400
358
|
const visit: <T>(value: FunctionSchema, visitor: Visitor<T>) => T;
|
|
401
359
|
}
|
|
402
360
|
/**
|
|
403
|
-
* <p>
|
|
404
|
-
* Contains details of the inline agent's action group.
|
|
405
|
-
* </p>
|
|
361
|
+
* <p> Contains details of the inline agent's action group. </p>
|
|
406
362
|
* @public
|
|
407
363
|
*/
|
|
408
364
|
export interface AgentActionGroup {
|
|
409
365
|
/**
|
|
410
|
-
* <p>
|
|
411
|
-
* The name of the action group.
|
|
412
|
-
* </p>
|
|
366
|
+
* <p> The name of the action group. </p>
|
|
413
367
|
* @public
|
|
414
368
|
*/
|
|
415
369
|
actionGroupName: string | undefined;
|
|
416
370
|
/**
|
|
417
|
-
* <p>
|
|
418
|
-
* A description of the action group.
|
|
419
|
-
* </p>
|
|
371
|
+
* <p> A description of the action group. </p>
|
|
420
372
|
* @public
|
|
421
373
|
*/
|
|
422
374
|
description?: string | undefined;
|
|
423
375
|
/**
|
|
424
|
-
* <p>Specify a built-in or computer use action for this action group. If you specify a value, you must leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields empty for this action group. </p>
|
|
425
|
-
* <ul>
|
|
426
|
-
* <li>
|
|
427
|
-
* <p>To allow your agent to request the user for additional information when trying to complete a task, set this field to <code>AMAZON.UserInput</code>. </p>
|
|
428
|
-
* </li>
|
|
429
|
-
* <li>
|
|
430
|
-
* <p>To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to <code>AMAZON.CodeInterpreter</code>.</p>
|
|
431
|
-
* </li>
|
|
432
|
-
* <li>
|
|
433
|
-
* <p>To allow your agent to use an Anthropic computer use tool, specify one of the following values. </p>
|
|
434
|
-
* <important>
|
|
435
|
-
* <p>
|
|
436
|
-
* Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only.
|
|
437
|
-
* When operating computer use functionality, we recommend taking additional security precautions,
|
|
438
|
-
* such as executing computer actions in virtual environments with restricted data access and limited internet connectivity.
|
|
439
|
-
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.
|
|
440
|
-
* </p>
|
|
441
|
-
* </important>
|
|
442
|
-
* <ul>
|
|
443
|
-
* <li>
|
|
444
|
-
* <p>
|
|
445
|
-
* <code>ANTHROPIC.Computer</code> - Gives the agent permission to use the mouse and keyboard and
|
|
446
|
-
* take screenshots.</p>
|
|
447
|
-
* </li>
|
|
448
|
-
* <li>
|
|
449
|
-
* <p>
|
|
450
|
-
* <code>ANTHROPIC.TextEditor</code> - Gives the agent permission to view, create and edit files.</p>
|
|
451
|
-
* </li>
|
|
452
|
-
* <li>
|
|
453
|
-
* <p>
|
|
454
|
-
* <code>ANTHROPIC.Bash</code> - Gives the agent permission to run commands in a bash shell.</p>
|
|
455
|
-
* </li>
|
|
456
|
-
* </ul>
|
|
457
|
-
* </li>
|
|
458
|
-
* </ul>
|
|
376
|
+
* <p>Specify a built-in or computer use action for this action group. If you specify a value, you must leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields empty for this action group. </p> <ul> <li> <p>To allow your agent to request the user for additional information when trying to complete a task, set this field to <code>AMAZON.UserInput</code>. </p> </li> <li> <p>To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to <code>AMAZON.CodeInterpreter</code>.</p> </li> <li> <p>To allow your agent to use an Anthropic computer use tool, specify one of the following values. </p> <important> <p> Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>. </p> </important> <ul> <li> <p> <code>ANTHROPIC.Computer</code> - Gives the agent permission to use the mouse and keyboard and take screenshots.</p> </li> <li> <p> <code>ANTHROPIC.TextEditor</code> - Gives the agent permission to view, create and edit files.</p> </li> <li> <p> <code>ANTHROPIC.Bash</code> - Gives the agent permission to run commands in a bash shell.</p> </li> </ul> </li> </ul>
|
|
459
377
|
* @public
|
|
460
378
|
*/
|
|
461
379
|
parentActionGroupSignature?: ActionGroupSignature | undefined;
|
|
462
380
|
/**
|
|
463
|
-
* <p>
|
|
464
|
-
* The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking
|
|
465
|
-
* the action or the custom control method for handling the information elicited from the user.
|
|
466
|
-
* </p>
|
|
381
|
+
* <p> The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user. </p>
|
|
467
382
|
* @public
|
|
468
383
|
*/
|
|
469
384
|
actionGroupExecutor?: ActionGroupExecutor | undefined;
|
|
470
385
|
/**
|
|
471
|
-
* <p>
|
|
472
|
-
* Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted
|
|
473
|
-
* payload defining the schema. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>.
|
|
474
|
-
* </p>
|
|
386
|
+
* <p> Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>. </p>
|
|
475
387
|
* @public
|
|
476
388
|
*/
|
|
477
389
|
apiSchema?: APISchema | undefined;
|
|
478
390
|
/**
|
|
479
|
-
* <p>
|
|
480
|
-
* Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
|
|
481
|
-
* </p>
|
|
391
|
+
* <p> Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema. </p>
|
|
482
392
|
* @public
|
|
483
393
|
*/
|
|
484
394
|
functionSchema?: FunctionSchema | undefined;
|
|
485
395
|
/**
|
|
486
|
-
* <p>
|
|
487
|
-
* The configuration settings for a computer use action.
|
|
488
|
-
* </p>
|
|
489
|
-
* <important>
|
|
490
|
-
* <p>Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.</p>
|
|
491
|
-
* </important>
|
|
396
|
+
* <p> The configuration settings for a computer use action. </p> <important> <p>Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.</p> </important>
|
|
492
397
|
* @public
|
|
493
398
|
*/
|
|
494
399
|
parentActionGroupSignatureParams?: Record<string, string> | undefined;
|
|
@@ -563,8 +468,7 @@ export declare namespace ImageInputSource {
|
|
|
563
468
|
const visit: <T>(value: ImageInputSource, visitor: Visitor<T>) => T;
|
|
564
469
|
}
|
|
565
470
|
/**
|
|
566
|
-
* <p>Details about an image in the result from a function in the action group invocation. You can specify images only when the function
|
|
567
|
-
* is a computer use action. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.</p>
|
|
471
|
+
* <p>Details about an image in the result from a function in the action group invocation. You can specify images only when the function is a computer use action. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.</p>
|
|
568
472
|
* @public
|
|
569
473
|
*/
|
|
570
474
|
export interface ImageInput {
|
|
@@ -580,14 +484,7 @@ export interface ImageInput {
|
|
|
580
484
|
source: ImageInputSource | undefined;
|
|
581
485
|
}
|
|
582
486
|
/**
|
|
583
|
-
* <p>Contains the body of the API response.</p>
|
|
584
|
-
* <p>This data type is used in the following API operations:</p>
|
|
585
|
-
* <ul>
|
|
586
|
-
* <li>
|
|
587
|
-
* <p>In the <code>returnControlInvocationResults</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
|
|
588
|
-
* </p>
|
|
589
|
-
* </li>
|
|
590
|
-
* </ul>
|
|
487
|
+
* <p>Contains the body of the API response.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p>In the <code>returnControlInvocationResults</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a> </p> </li> </ul>
|
|
591
488
|
* @public
|
|
592
489
|
*/
|
|
593
490
|
export interface ContentBody {
|
|
@@ -597,10 +494,7 @@ export interface ContentBody {
|
|
|
597
494
|
*/
|
|
598
495
|
body?: string | undefined;
|
|
599
496
|
/**
|
|
600
|
-
* <p>Lists details, including format and source, for the image in the response from the function call. You can specify only one image and the function in the <code>returnControlInvocationResults</code>
|
|
601
|
-
* must be a computer use action.
|
|
602
|
-
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.
|
|
603
|
-
* </p>
|
|
497
|
+
* <p>Lists details, including format and source, for the image in the response from the function call. You can specify only one image and the function in the <code>returnControlInvocationResults</code> must be a computer use action. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>. </p>
|
|
604
498
|
* @public
|
|
605
499
|
*/
|
|
606
500
|
images?: ImageInput[] | undefined;
|
|
@@ -618,14 +512,7 @@ export declare const ResponseState: {
|
|
|
618
512
|
*/
|
|
619
513
|
export type ResponseState = (typeof ResponseState)[keyof typeof ResponseState];
|
|
620
514
|
/**
|
|
621
|
-
* <p>Contains information about the API operation that was called from the action group and the response body that was returned.</p>
|
|
622
|
-
* <p>This data type is used in the following API operations:</p>
|
|
623
|
-
* <ul>
|
|
624
|
-
* <li>
|
|
625
|
-
* <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
|
|
626
|
-
* </p>
|
|
627
|
-
* </li>
|
|
628
|
-
* </ul>
|
|
515
|
+
* <p>Contains information about the API operation that was called from the action group and the response body that was returned.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a> </p> </li> </ul>
|
|
629
516
|
* @public
|
|
630
517
|
*/
|
|
631
518
|
export interface ApiResult {
|
|
@@ -671,14 +558,7 @@ export interface ApiResult {
|
|
|
671
558
|
agentId?: string | undefined;
|
|
672
559
|
}
|
|
673
560
|
/**
|
|
674
|
-
* <p>Contains information about the function that was called from the action group and the response that was returned.</p>
|
|
675
|
-
* <p>This data type is used in the following API operations:</p>
|
|
676
|
-
* <ul>
|
|
677
|
-
* <li>
|
|
678
|
-
* <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
|
|
679
|
-
* </p>
|
|
680
|
-
* </li>
|
|
681
|
-
* </ul>
|
|
561
|
+
* <p>Contains information about the function that was called from the action group and the response that was returned.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a> </p> </li> </ul>
|
|
682
562
|
* @public
|
|
683
563
|
*/
|
|
684
564
|
export interface FunctionResult {
|
|
@@ -698,10 +578,7 @@ export interface FunctionResult {
|
|
|
698
578
|
*/
|
|
699
579
|
function?: string | undefined;
|
|
700
580
|
/**
|
|
701
|
-
* <p>The response from the function call using the parameters. The response might be returned directly or from the Lambda function.
|
|
702
|
-
* Specify <code>TEXT</code> or <code>IMAGES</code>. The key of the object is the content type. You can only specify one type. If you
|
|
703
|
-
* specify <code>IMAGES</code>, you can specify only one image. You can specify images only when the function in the <code>returnControlInvocationResults</code>
|
|
704
|
-
* is a computer use action. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.</p>
|
|
581
|
+
* <p>The response from the function call using the parameters. The response might be returned directly or from the Lambda function. Specify <code>TEXT</code> or <code>IMAGES</code>. The key of the object is the content type. You can only specify one type. If you specify <code>IMAGES</code>, you can specify only one image. You can specify images only when the function in the <code>returnControlInvocationResults</code> is a computer use action. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.</p>
|
|
705
582
|
* @public
|
|
706
583
|
*/
|
|
707
584
|
responseBody?: Record<string, ContentBody> | undefined;
|
|
@@ -717,15 +594,7 @@ export interface FunctionResult {
|
|
|
717
594
|
agentId?: string | undefined;
|
|
718
595
|
}
|
|
719
596
|
/**
|
|
720
|
-
* <p>A result from the invocation of an action. 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>
|
|
721
|
-
* <p>This data type is used in the following API operations:</p>
|
|
722
|
-
* <ul>
|
|
723
|
-
* <li>
|
|
724
|
-
* <p>
|
|
725
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
|
|
726
|
-
* </p>
|
|
727
|
-
* </li>
|
|
728
|
-
* </ul>
|
|
597
|
+
* <p>A result from the invocation of an action. 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> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a> </p> </li> </ul>
|
|
729
598
|
* @public
|
|
730
599
|
*/
|
|
731
600
|
export type InvocationResultMember = InvocationResultMember.ApiResultMember | InvocationResultMember.FunctionResultMember | InvocationResultMember.$UnknownMember;
|
|
@@ -837,15 +706,7 @@ export interface AgentCollaboratorInvocationInput {
|
|
|
837
706
|
input?: AgentCollaboratorInputPayload | undefined;
|
|
838
707
|
}
|
|
839
708
|
/**
|
|
840
|
-
* <p>Information about a parameter to provide to the API request.</p>
|
|
841
|
-
* <p>This data type is used in the following API operations:</p>
|
|
842
|
-
* <ul>
|
|
843
|
-
* <li>
|
|
844
|
-
* <p>
|
|
845
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
846
|
-
* </p>
|
|
847
|
-
* </li>
|
|
848
|
-
* </ul>
|
|
709
|
+
* <p>Information about a parameter to provide to the API request.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> </p> </li> </ul>
|
|
849
710
|
* @public
|
|
850
711
|
*/
|
|
851
712
|
export interface ApiParameter {
|
|
@@ -877,15 +738,7 @@ export interface PropertyParameters {
|
|
|
877
738
|
properties?: Parameter[] | undefined;
|
|
878
739
|
}
|
|
879
740
|
/**
|
|
880
|
-
* <p>The request body to provide for the API request, as the agent elicited from the user.</p>
|
|
881
|
-
* <p>This data type is used in the following API operations:</p>
|
|
882
|
-
* <ul>
|
|
883
|
-
* <li>
|
|
884
|
-
* <p>
|
|
885
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
886
|
-
* </p>
|
|
887
|
-
* </li>
|
|
888
|
-
* </ul>
|
|
741
|
+
* <p>The request body to provide for the API request, as the agent elicited from the user.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> </p> </li> </ul>
|
|
889
742
|
* @public
|
|
890
743
|
*/
|
|
891
744
|
export interface ApiRequestBody {
|
|
@@ -896,14 +749,7 @@ export interface ApiRequestBody {
|
|
|
896
749
|
content?: Record<string, PropertyParameters> | undefined;
|
|
897
750
|
}
|
|
898
751
|
/**
|
|
899
|
-
* <p>Contains information about the API operation that the agent predicts should be called.</p>
|
|
900
|
-
* <p>This data type is used in the following API operations:</p>
|
|
901
|
-
* <ul>
|
|
902
|
-
* <li>
|
|
903
|
-
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
904
|
-
* </p>
|
|
905
|
-
* </li>
|
|
906
|
-
* </ul>
|
|
752
|
+
* <p>Contains information about the API operation that the agent predicts should be called.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> </p> </li> </ul>
|
|
907
753
|
* @public
|
|
908
754
|
*/
|
|
909
755
|
export interface ApiInvocationInput {
|
|
@@ -949,14 +795,7 @@ export interface ApiInvocationInput {
|
|
|
949
795
|
collaboratorName?: string | undefined;
|
|
950
796
|
}
|
|
951
797
|
/**
|
|
952
|
-
* <p>Contains information about a parameter of the function.</p>
|
|
953
|
-
* <p>This data type is used in the following API operations:</p>
|
|
954
|
-
* <ul>
|
|
955
|
-
* <li>
|
|
956
|
-
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
957
|
-
* </p>
|
|
958
|
-
* </li>
|
|
959
|
-
* </ul>
|
|
798
|
+
* <p>Contains information about a parameter of the function.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> </p> </li> </ul>
|
|
960
799
|
* @public
|
|
961
800
|
*/
|
|
962
801
|
export interface FunctionParameter {
|
|
@@ -977,14 +816,7 @@ export interface FunctionParameter {
|
|
|
977
816
|
value?: string | undefined;
|
|
978
817
|
}
|
|
979
818
|
/**
|
|
980
|
-
* <p>Contains information about the function that the agent predicts should be called.</p>
|
|
981
|
-
* <p>This data type is used in the following API operations:</p>
|
|
982
|
-
* <ul>
|
|
983
|
-
* <li>
|
|
984
|
-
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
985
|
-
* </p>
|
|
986
|
-
* </li>
|
|
987
|
-
* </ul>
|
|
819
|
+
* <p>Contains information about the function that the agent predicts should be called.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> </p> </li> </ul>
|
|
988
820
|
* @public
|
|
989
821
|
*/
|
|
990
822
|
export interface FunctionInvocationInput {
|
|
@@ -1020,14 +852,7 @@ export interface FunctionInvocationInput {
|
|
|
1020
852
|
collaboratorName?: string | undefined;
|
|
1021
853
|
}
|
|
1022
854
|
/**
|
|
1023
|
-
* <p>Contains details about the API operation or function that the agent predicts should be called. </p>
|
|
1024
|
-
* <p>This data type is used in the following API operations:</p>
|
|
1025
|
-
* <ul>
|
|
1026
|
-
* <li>
|
|
1027
|
-
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
1028
|
-
* </p>
|
|
1029
|
-
* </li>
|
|
1030
|
-
* </ul>
|
|
855
|
+
* <p>Contains details about the API operation or function that the agent predicts should be called. </p> <p>This data type is used in the following API operations:</p> <ul> <li> <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> </p> </li> </ul>
|
|
1031
856
|
* @public
|
|
1032
857
|
*/
|
|
1033
858
|
export type InvocationInputMember = InvocationInputMember.ApiInvocationInputMember | InvocationInputMember.FunctionInvocationInputMember | InvocationInputMember.$UnknownMember;
|
|
@@ -1069,15 +894,7 @@ export declare namespace InvocationInputMember {
|
|
|
1069
894
|
const visit: <T>(value: InvocationInputMember, visitor: Visitor<T>) => T;
|
|
1070
895
|
}
|
|
1071
896
|
/**
|
|
1072
|
-
* <p>Contains information to return from the action group that the agent has predicted to invoke.</p>
|
|
1073
|
-
* <p>This data type is used in the following API operations:</p>
|
|
1074
|
-
* <ul>
|
|
1075
|
-
* <li>
|
|
1076
|
-
* <p>
|
|
1077
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
1078
|
-
* </p>
|
|
1079
|
-
* </li>
|
|
1080
|
-
* </ul>
|
|
897
|
+
* <p>Contains information to return from the action group that the agent has predicted to invoke.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> </p> </li> </ul>
|
|
1081
898
|
* @public
|
|
1082
899
|
*/
|
|
1083
900
|
export interface ReturnControlPayload {
|
|
@@ -1317,7 +1134,7 @@ export interface InvokeFlowRequest {
|
|
|
1317
1134
|
*/
|
|
1318
1135
|
modelPerformanceConfiguration?: ModelPerformanceConfiguration | undefined;
|
|
1319
1136
|
/**
|
|
1320
|
-
* <p>The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.
|
|
1137
|
+
* <p>The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you. </p>
|
|
1321
1138
|
* @public
|
|
1322
1139
|
*/
|
|
1323
1140
|
executionId?: string | undefined;
|
|
@@ -1497,8 +1314,7 @@ export interface FlowTraceConditionNodeResultEvent {
|
|
|
1497
1314
|
satisfiedConditions: FlowTraceCondition[] | undefined;
|
|
1498
1315
|
}
|
|
1499
1316
|
/**
|
|
1500
|
-
* <p>Contains information about an action (operation) called by a node in an Amazon Bedrock flow. The service generates action events for calls made by prompt nodes,
|
|
1501
|
-
* agent nodes, and Amazon Web Services Lambda nodes. </p>
|
|
1317
|
+
* <p>Contains information about an action (operation) called by a node in an Amazon Bedrock flow. The service generates action events for calls made by prompt nodes, agent nodes, and Amazon Web Services Lambda nodes. </p>
|
|
1502
1318
|
* @public
|
|
1503
1319
|
*/
|
|
1504
1320
|
export interface FlowTraceNodeActionEvent {
|
|
@@ -1705,8 +1521,7 @@ export declare namespace FlowTrace {
|
|
|
1705
1521
|
$unknown?: never;
|
|
1706
1522
|
}
|
|
1707
1523
|
/**
|
|
1708
|
-
* <p>Contains information about an action (operation) called by a node.
|
|
1709
|
-
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
|
|
1524
|
+
* <p>Contains information about an action (operation) called by a node. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
|
|
1710
1525
|
* @public
|
|
1711
1526
|
*/
|
|
1712
1527
|
interface NodeActionTraceMember {
|
|
@@ -2433,15 +2248,7 @@ export interface InputFile {
|
|
|
2433
2248
|
useCase: FileUseCase | undefined;
|
|
2434
2249
|
}
|
|
2435
2250
|
/**
|
|
2436
|
-
* <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>
|
|
2437
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2438
|
-
* <ul>
|
|
2439
|
-
* <li>
|
|
2440
|
-
* <p>
|
|
2441
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a>
|
|
2442
|
-
* </p>
|
|
2443
|
-
* </li>
|
|
2444
|
-
* </ul>
|
|
2251
|
+
* <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> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> </p> </li> </ul>
|
|
2445
2252
|
* @public
|
|
2446
2253
|
*/
|
|
2447
2254
|
export interface FilterAttribute {
|
|
@@ -2670,48 +2477,18 @@ export interface VectorSearchRerankingConfiguration {
|
|
|
2670
2477
|
*/
|
|
2671
2478
|
export interface StreamingConfigurations {
|
|
2672
2479
|
/**
|
|
2673
|
-
* <p>
|
|
2674
|
-
* Specifies whether to enable streaming for the final response. This is set to <code>false</code> by default.
|
|
2675
|
-
* </p>
|
|
2480
|
+
* <p> Specifies whether to enable streaming for the final response. This is set to <code>false</code> by default. </p>
|
|
2676
2481
|
* @public
|
|
2677
2482
|
*/
|
|
2678
2483
|
streamFinalResponse?: boolean | undefined;
|
|
2679
2484
|
/**
|
|
2680
|
-
* <p> The guardrail interval to apply as response is generated. By default, the guardrail
|
|
2681
|
-
* interval is set to 50 characters. If a larger interval is specified, the response will
|
|
2682
|
-
* be generated in larger chunks with fewer <code>ApplyGuardrail</code> calls. The
|
|
2683
|
-
* following examples show the response generated for <i>Hello, I am an
|
|
2684
|
-
* agent</i> input string.</p>
|
|
2685
|
-
* <p>
|
|
2686
|
-
* <b>Example response in chunks: Interval set to 3 characters</b>
|
|
2687
|
-
* </p>
|
|
2688
|
-
* <p>
|
|
2689
|
-
* <code>'Hel', 'lo, ','I am', ' an', ' Age', 'nt'</code>
|
|
2690
|
-
* </p>
|
|
2691
|
-
* <p>Each chunk has at least 3 characters except for the last chunk</p>
|
|
2692
|
-
* <p>
|
|
2693
|
-
* <b>Example response in chunks: Interval set to 20 or more characters</b>
|
|
2694
|
-
* </p>
|
|
2695
|
-
* <p>
|
|
2696
|
-
* <code>Hello, I am an Agent</code>
|
|
2697
|
-
* </p>
|
|
2485
|
+
* <p> The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer <code>ApplyGuardrail</code> calls. The following examples show the response generated for <i>Hello, I am an agent</i> input string.</p> <p> <b>Example response in chunks: Interval set to 3 characters</b> </p> <p> <code>'Hel', 'lo, ','I am', ' an', ' Age', 'nt'</code> </p> <p>Each chunk has at least 3 characters except for the last chunk</p> <p> <b>Example response in chunks: Interval set to 20 or more characters</b> </p> <p> <code>Hello, I am an Agent</code> </p>
|
|
2698
2486
|
* @public
|
|
2699
2487
|
*/
|
|
2700
2488
|
applyGuardrailInterval?: number | undefined;
|
|
2701
2489
|
}
|
|
2702
2490
|
/**
|
|
2703
|
-
* <p>Contains information about where the text with a citation begins and ends in the generated output.</p>
|
|
2704
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2705
|
-
* <ul>
|
|
2706
|
-
* <li>
|
|
2707
|
-
* <p>
|
|
2708
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>span</code> field</p>
|
|
2709
|
-
* </li>
|
|
2710
|
-
* <li>
|
|
2711
|
-
* <p>
|
|
2712
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>span</code> field</p>
|
|
2713
|
-
* </li>
|
|
2714
|
-
* </ul>
|
|
2491
|
+
* <p>Contains information about where the text with a citation begins and ends in the generated output.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>span</code> field</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>span</code> field</p> </li> </ul>
|
|
2715
2492
|
* @public
|
|
2716
2493
|
*/
|
|
2717
2494
|
export interface Span {
|
|
@@ -2727,18 +2504,7 @@ export interface Span {
|
|
|
2727
2504
|
end?: number | undefined;
|
|
2728
2505
|
}
|
|
2729
2506
|
/**
|
|
2730
|
-
* <p>Contains the part of the generated text that contains a citation, alongside where it begins and ends.</p>
|
|
2731
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2732
|
-
* <ul>
|
|
2733
|
-
* <li>
|
|
2734
|
-
* <p>
|
|
2735
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>textResponsePart</code> field</p>
|
|
2736
|
-
* </li>
|
|
2737
|
-
* <li>
|
|
2738
|
-
* <p>
|
|
2739
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>textResponsePart</code> field</p>
|
|
2740
|
-
* </li>
|
|
2741
|
-
* </ul>
|
|
2507
|
+
* <p>Contains the part of the generated text that contains a citation, alongside where it begins and ends.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>textResponsePart</code> field</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>textResponsePart</code> field</p> </li> </ul>
|
|
2742
2508
|
* @public
|
|
2743
2509
|
*/
|
|
2744
2510
|
export interface TextResponsePart {
|
|
@@ -2754,18 +2520,7 @@ export interface TextResponsePart {
|
|
|
2754
2520
|
span?: Span | undefined;
|
|
2755
2521
|
}
|
|
2756
2522
|
/**
|
|
2757
|
-
* <p>Contains metadata about a part of the generated response that is accompanied by a citation.</p>
|
|
2758
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2759
|
-
* <ul>
|
|
2760
|
-
* <li>
|
|
2761
|
-
* <p>
|
|
2762
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>generatedResponsePart</code> field</p>
|
|
2763
|
-
* </li>
|
|
2764
|
-
* <li>
|
|
2765
|
-
* <p>
|
|
2766
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>generatedResponsePart</code> field</p>
|
|
2767
|
-
* </li>
|
|
2768
|
-
* </ul>
|
|
2523
|
+
* <p>Contains metadata about a part of the generated response that is accompanied by a citation.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>generatedResponsePart</code> field</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>generatedResponsePart</code> field</p> </li> </ul>
|
|
2769
2524
|
* @public
|
|
2770
2525
|
*/
|
|
2771
2526
|
export interface GeneratedResponsePart {
|
|
@@ -2826,22 +2581,7 @@ export declare const RetrievalResultContentType: {
|
|
|
2826
2581
|
*/
|
|
2827
2582
|
export type RetrievalResultContentType = (typeof RetrievalResultContentType)[keyof typeof RetrievalResultContentType];
|
|
2828
2583
|
/**
|
|
2829
|
-
* <p>Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.</p>
|
|
2830
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2831
|
-
* <ul>
|
|
2832
|
-
* <li>
|
|
2833
|
-
* <p>
|
|
2834
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>content</code> field</p>
|
|
2835
|
-
* </li>
|
|
2836
|
-
* <li>
|
|
2837
|
-
* <p>
|
|
2838
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>content</code> field</p>
|
|
2839
|
-
* </li>
|
|
2840
|
-
* <li>
|
|
2841
|
-
* <p>
|
|
2842
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>content</code> field</p>
|
|
2843
|
-
* </li>
|
|
2844
|
-
* </ul>
|
|
2584
|
+
* <p>Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>content</code> field</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>content</code> field</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>content</code> field</p> </li> </ul>
|
|
2845
2585
|
* @public
|
|
2846
2586
|
*/
|
|
2847
2587
|
export interface RetrievalResultContent {
|
|
@@ -2900,22 +2640,7 @@ export interface RetrievalResultKendraDocumentLocation {
|
|
|
2900
2640
|
uri?: string | undefined;
|
|
2901
2641
|
}
|
|
2902
2642
|
/**
|
|
2903
|
-
* <p>The S3 data source location.</p>
|
|
2904
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2905
|
-
* <ul>
|
|
2906
|
-
* <li>
|
|
2907
|
-
* <p>
|
|
2908
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>s3Location</code> field</p>
|
|
2909
|
-
* </li>
|
|
2910
|
-
* <li>
|
|
2911
|
-
* <p>
|
|
2912
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>s3Location</code> field</p>
|
|
2913
|
-
* </li>
|
|
2914
|
-
* <li>
|
|
2915
|
-
* <p>
|
|
2916
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>s3Location</code> field</p>
|
|
2917
|
-
* </li>
|
|
2918
|
-
* </ul>
|
|
2643
|
+
* <p>The S3 data source location.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>s3Location</code> field</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>s3Location</code> field</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>s3Location</code> field</p> </li> </ul>
|
|
2919
2644
|
* @public
|
|
2920
2645
|
*/
|
|
2921
2646
|
export interface RetrievalResultS3Location {
|
|
@@ -2988,22 +2713,7 @@ export interface RetrievalResultWebLocation {
|
|
|
2988
2713
|
url?: string | undefined;
|
|
2989
2714
|
}
|
|
2990
2715
|
/**
|
|
2991
|
-
* <p>Contains information about the data source location.</p>
|
|
2992
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2993
|
-
* <ul>
|
|
2994
|
-
* <li>
|
|
2995
|
-
* <p>
|
|
2996
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>location</code> field</p>
|
|
2997
|
-
* </li>
|
|
2998
|
-
* <li>
|
|
2999
|
-
* <p>
|
|
3000
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>location</code> field</p>
|
|
3001
|
-
* </li>
|
|
3002
|
-
* <li>
|
|
3003
|
-
* <p>
|
|
3004
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>location</code> field</p>
|
|
3005
|
-
* </li>
|
|
3006
|
-
* </ul>
|
|
2716
|
+
* <p>Contains information about the data source location.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>location</code> field</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>location</code> field</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>location</code> field</p> </li> </ul>
|
|
3007
2717
|
* @public
|
|
3008
2718
|
*/
|
|
3009
2719
|
export interface RetrievalResultLocation {
|
|
@@ -3054,18 +2764,7 @@ export interface RetrievalResultLocation {
|
|
|
3054
2764
|
sqlLocation?: RetrievalResultSqlLocation | undefined;
|
|
3055
2765
|
}
|
|
3056
2766
|
/**
|
|
3057
|
-
* <p>Contains metadata about a source cited for the generated response.</p>
|
|
3058
|
-
* <p>This data type is used in the following API operations:</p>
|
|
3059
|
-
* <ul>
|
|
3060
|
-
* <li>
|
|
3061
|
-
* <p>
|
|
3062
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>retrievedReferences</code> field</p>
|
|
3063
|
-
* </li>
|
|
3064
|
-
* <li>
|
|
3065
|
-
* <p>
|
|
3066
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>retrievedReferences</code> field</p>
|
|
3067
|
-
* </li>
|
|
3068
|
-
* </ul>
|
|
2767
|
+
* <p>Contains metadata about a source cited for the generated response.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>retrievedReferences</code> field</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>retrievedReferences</code> field</p> </li> </ul>
|
|
3069
2768
|
* @public
|
|
3070
2769
|
*/
|
|
3071
2770
|
export interface RetrievedReference {
|
|
@@ -3086,18 +2785,7 @@ export interface RetrievedReference {
|
|
|
3086
2785
|
metadata?: Record<string, __DocumentType> | undefined;
|
|
3087
2786
|
}
|
|
3088
2787
|
/**
|
|
3089
|
-
* <p>An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.</p>
|
|
3090
|
-
* <p>This data type is used in the following API operations:</p>
|
|
3091
|
-
* <ul>
|
|
3092
|
-
* <li>
|
|
3093
|
-
* <p>
|
|
3094
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>citations</code> field</p>
|
|
3095
|
-
* </li>
|
|
3096
|
-
* <li>
|
|
3097
|
-
* <p>
|
|
3098
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>citations</code> field</p>
|
|
3099
|
-
* </li>
|
|
3100
|
-
* </ul>
|
|
2788
|
+
* <p>An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>citations</code> field</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>citations</code> field</p> </li> </ul>
|
|
3101
2789
|
* @public
|
|
3102
2790
|
*/
|
|
3103
2791
|
export interface Citation {
|
|
@@ -3172,12 +2860,7 @@ export interface FilePart {
|
|
|
3172
2860
|
files?: OutputFile[] | undefined;
|
|
3173
2861
|
}
|
|
3174
2862
|
/**
|
|
3175
|
-
* <p>
|
|
3176
|
-
* The model specified in the request is not ready to serve inference requests. The AWS SDK
|
|
3177
|
-
* will automatically retry the operation up to 5 times. For information about configuring
|
|
3178
|
-
* automatic retries, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html">Retry behavior</a> in the <i>AWS SDKs and Tools</i>
|
|
3179
|
-
* reference guide.
|
|
3180
|
-
* </p>
|
|
2863
|
+
* <p> The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html">Retry behavior</a> in the <i>AWS SDKs and Tools</i> reference guide. </p>
|
|
3181
2864
|
* @public
|
|
3182
2865
|
*/
|
|
3183
2866
|
export declare class ModelNotReadyException extends __BaseException {
|
|
@@ -3219,38 +2902,28 @@ export declare namespace Caller {
|
|
|
3219
2902
|
const visit: <T>(value: Caller, visitor: Visitor<T>) => T;
|
|
3220
2903
|
}
|
|
3221
2904
|
/**
|
|
3222
|
-
* <p>
|
|
3223
|
-
* The event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent.
|
|
3224
|
-
* </p>
|
|
2905
|
+
* <p> The event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent. </p>
|
|
3225
2906
|
* @public
|
|
3226
2907
|
*/
|
|
3227
2908
|
export interface CustomOrchestrationTraceEvent {
|
|
3228
2909
|
/**
|
|
3229
|
-
* <p>
|
|
3230
|
-
* The text that prompted the event at this step.
|
|
3231
|
-
* </p>
|
|
2910
|
+
* <p> The text that prompted the event at this step. </p>
|
|
3232
2911
|
* @public
|
|
3233
2912
|
*/
|
|
3234
2913
|
text?: string | undefined;
|
|
3235
2914
|
}
|
|
3236
2915
|
/**
|
|
3237
|
-
* <p>
|
|
3238
|
-
* The trace behavior for the custom orchestration.
|
|
3239
|
-
* </p>
|
|
2916
|
+
* <p> The trace behavior for the custom orchestration. </p>
|
|
3240
2917
|
* @public
|
|
3241
2918
|
*/
|
|
3242
2919
|
export interface CustomOrchestrationTrace {
|
|
3243
2920
|
/**
|
|
3244
|
-
* <p>
|
|
3245
|
-
* The unique identifier of the trace.
|
|
3246
|
-
* </p>
|
|
2921
|
+
* <p> The unique identifier of the trace. </p>
|
|
3247
2922
|
* @public
|
|
3248
2923
|
*/
|
|
3249
2924
|
traceId?: string | undefined;
|
|
3250
2925
|
/**
|
|
3251
|
-
* <p>
|
|
3252
|
-
* The event details used with the custom orchestration.
|
|
3253
|
-
* </p>
|
|
2926
|
+
* <p> The event details used with the custom orchestration. </p>
|
|
3254
2927
|
* @public
|
|
3255
2928
|
*/
|
|
3256
2929
|
event?: CustomOrchestrationTraceEvent | undefined;
|
|
@@ -3795,18 +3468,7 @@ export declare const PromptType: {
|
|
|
3795
3468
|
*/
|
|
3796
3469
|
export type PromptType = (typeof PromptType)[keyof typeof PromptType];
|
|
3797
3470
|
/**
|
|
3798
|
-
* <p>The input for the pre-processing step.</p>
|
|
3799
|
-
* <ul>
|
|
3800
|
-
* <li>
|
|
3801
|
-
* <p>The <code>type</code> matches the agent step.</p>
|
|
3802
|
-
* </li>
|
|
3803
|
-
* <li>
|
|
3804
|
-
* <p>The <code>text</code> contains the prompt.</p>
|
|
3805
|
-
* </li>
|
|
3806
|
-
* <li>
|
|
3807
|
-
* <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set 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.</p>
|
|
3808
|
-
* </li>
|
|
3809
|
-
* </ul>
|
|
3471
|
+
* <p>The input for the pre-processing step.</p> <ul> <li> <p>The <code>type</code> matches the agent step.</p> </li> <li> <p>The <code>text</code> contains the prompt.</p> </li> <li> <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set 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.</p> </li> </ul>
|
|
3810
3472
|
* @public
|
|
3811
3473
|
*/
|
|
3812
3474
|
export interface ModelInvocationInput {
|
|
@@ -3900,18 +3562,13 @@ export interface ReasoningTextBlock {
|
|
|
3900
3562
|
*/
|
|
3901
3563
|
text: string | undefined;
|
|
3902
3564
|
/**
|
|
3903
|
-
* <p>A hash of all the messages in the conversation to ensure that the content in the
|
|
3904
|
-
* reasoning text block isn't tampered with. You must submit the signature in subsequent
|
|
3905
|
-
* <code>Converse</code> requests, in addition to the previous messages. If the
|
|
3906
|
-
* previous messages are tampered with, the response throws an error.</p>
|
|
3565
|
+
* <p>A hash of all the messages in the conversation to ensure that the content in the reasoning text block isn't tampered with. You must submit the signature in subsequent <code>Converse</code> requests, in addition to the previous messages. If the previous messages are tampered with, the response throws an error.</p>
|
|
3907
3566
|
* @public
|
|
3908
3567
|
*/
|
|
3909
3568
|
signature?: string | undefined;
|
|
3910
3569
|
}
|
|
3911
3570
|
/**
|
|
3912
|
-
* <p>Contains content regarding the reasoning that the foundation model made with respect
|
|
3913
|
-
* to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that
|
|
3914
|
-
* the model generates to enhance the accuracy of its final response.</p>
|
|
3571
|
+
* <p>Contains content regarding the reasoning that the foundation model made with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.</p>
|
|
3915
3572
|
* @public
|
|
3916
3573
|
*/
|
|
3917
3574
|
export type ReasoningContentBlock = ReasoningContentBlock.ReasoningTextMember | ReasoningContentBlock.RedactedContentMember | ReasoningContentBlock.$UnknownMember;
|
|
@@ -3920,8 +3577,7 @@ export type ReasoningContentBlock = ReasoningContentBlock.ReasoningTextMember |
|
|
|
3920
3577
|
*/
|
|
3921
3578
|
export declare namespace ReasoningContentBlock {
|
|
3922
3579
|
/**
|
|
3923
|
-
* <p>Contains information about the reasoning that the model used to return the content in
|
|
3924
|
-
* the content block.</p>
|
|
3580
|
+
* <p>Contains information about the reasoning that the model used to return the content in the content block.</p>
|
|
3925
3581
|
* @public
|
|
3926
3582
|
*/
|
|
3927
3583
|
interface ReasoningTextMember {
|
|
@@ -4083,29 +3739,7 @@ export interface Observation {
|
|
|
4083
3739
|
*/
|
|
4084
3740
|
traceId?: string | undefined;
|
|
4085
3741
|
/**
|
|
4086
|
-
* <p>Specifies what kind of information the agent returns in the observation. The following values are possible.</p>
|
|
4087
|
-
* <ul>
|
|
4088
|
-
* <li>
|
|
4089
|
-
* <p>
|
|
4090
|
-
* <code>ACTION_GROUP</code> – The agent returns the result of an action group.</p>
|
|
4091
|
-
* </li>
|
|
4092
|
-
* <li>
|
|
4093
|
-
* <p>
|
|
4094
|
-
* <code>KNOWLEDGE_BASE</code> – The agent returns information from a knowledge base.</p>
|
|
4095
|
-
* </li>
|
|
4096
|
-
* <li>
|
|
4097
|
-
* <p>
|
|
4098
|
-
* <code>FINISH</code> – The agent returns a final response to the user with no follow-up.</p>
|
|
4099
|
-
* </li>
|
|
4100
|
-
* <li>
|
|
4101
|
-
* <p>
|
|
4102
|
-
* <code>ASK_USER</code> – The agent asks the user a question.</p>
|
|
4103
|
-
* </li>
|
|
4104
|
-
* <li>
|
|
4105
|
-
* <p>
|
|
4106
|
-
* <code>REPROMPT</code> – The agent prompts the user again for the same information.</p>
|
|
4107
|
-
* </li>
|
|
4108
|
-
* </ul>
|
|
3742
|
+
* <p>Specifies what kind of information the agent returns in the observation. The following values are possible.</p> <ul> <li> <p> <code>ACTION_GROUP</code> – The agent returns the result of an action group.</p> </li> <li> <p> <code>KNOWLEDGE_BASE</code> – The agent returns information from a knowledge base.</p> </li> <li> <p> <code>FINISH</code> – The agent returns a final response to the user with no follow-up.</p> </li> <li> <p> <code>ASK_USER</code> – The agent asks the user a question.</p> </li> <li> <p> <code>REPROMPT</code> – The agent prompts the user again for the same information.</p> </li> </ul>
|
|
4109
3743
|
* @public
|
|
4110
3744
|
*/
|
|
4111
3745
|
type?: Type | undefined;
|
|
@@ -4202,18 +3836,7 @@ export declare namespace OrchestrationTrace {
|
|
|
4202
3836
|
$unknown?: never;
|
|
4203
3837
|
}
|
|
4204
3838
|
/**
|
|
4205
|
-
* <p>The input for the orchestration step.</p>
|
|
4206
|
-
* <ul>
|
|
4207
|
-
* <li>
|
|
4208
|
-
* <p>The <code>type</code> is <code>ORCHESTRATION</code>.</p>
|
|
4209
|
-
* </li>
|
|
4210
|
-
* <li>
|
|
4211
|
-
* <p>The <code>text</code> contains the prompt.</p>
|
|
4212
|
-
* </li>
|
|
4213
|
-
* <li>
|
|
4214
|
-
* <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set 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.</p>
|
|
4215
|
-
* </li>
|
|
4216
|
-
* </ul>
|
|
3839
|
+
* <p>The input for the orchestration step.</p> <ul> <li> <p>The <code>type</code> is <code>ORCHESTRATION</code>.</p> </li> <li> <p>The <code>text</code> contains the prompt.</p> </li> <li> <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set 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.</p> </li> </ul>
|
|
4217
3840
|
* @public
|
|
4218
3841
|
*/
|
|
4219
3842
|
interface ModelInvocationInputMember {
|
|
@@ -4284,16 +3907,12 @@ export interface PostProcessingModelInvocationOutput {
|
|
|
4284
3907
|
*/
|
|
4285
3908
|
parsedResponse?: PostProcessingParsedResponse | undefined;
|
|
4286
3909
|
/**
|
|
4287
|
-
* <p>
|
|
4288
|
-
* Details of the raw response from the foundation model output.
|
|
4289
|
-
* </p>
|
|
3910
|
+
* <p> Details of the raw response from the foundation model output. </p>
|
|
4290
3911
|
* @public
|
|
4291
3912
|
*/
|
|
4292
3913
|
rawResponse?: RawResponse | undefined;
|
|
4293
3914
|
/**
|
|
4294
|
-
* <p>
|
|
4295
|
-
* Contains information about the foundation model output from the post-processing step.
|
|
4296
|
-
* </p>
|
|
3915
|
+
* <p> Contains information about the foundation model output from the post-processing step. </p>
|
|
4297
3916
|
* @public
|
|
4298
3917
|
*/
|
|
4299
3918
|
metadata?: Metadata | undefined;
|
|
@@ -4313,18 +3932,7 @@ export type PostProcessingTrace = PostProcessingTrace.ModelInvocationInputMember
|
|
|
4313
3932
|
*/
|
|
4314
3933
|
export declare namespace PostProcessingTrace {
|
|
4315
3934
|
/**
|
|
4316
|
-
* <p>The input for the post-processing step.</p>
|
|
4317
|
-
* <ul>
|
|
4318
|
-
* <li>
|
|
4319
|
-
* <p>The <code>type</code> is <code>POST_PROCESSING</code>.</p>
|
|
4320
|
-
* </li>
|
|
4321
|
-
* <li>
|
|
4322
|
-
* <p>The <code>text</code> contains the prompt.</p>
|
|
4323
|
-
* </li>
|
|
4324
|
-
* <li>
|
|
4325
|
-
* <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set 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.</p>
|
|
4326
|
-
* </li>
|
|
4327
|
-
* </ul>
|
|
3935
|
+
* <p>The input for the post-processing step.</p> <ul> <li> <p>The <code>type</code> is <code>POST_PROCESSING</code>.</p> </li> <li> <p>The <code>text</code> contains the prompt.</p> </li> <li> <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set 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.</p> </li> </ul>
|
|
4328
3936
|
* @public
|
|
4329
3937
|
*/
|
|
4330
3938
|
interface ModelInvocationInputMember {
|
|
@@ -4388,16 +3996,12 @@ export interface PreProcessingModelInvocationOutput {
|
|
|
4388
3996
|
*/
|
|
4389
3997
|
parsedResponse?: PreProcessingParsedResponse | undefined;
|
|
4390
3998
|
/**
|
|
4391
|
-
* <p>
|
|
4392
|
-
* Details of the raw response from the foundation model output.
|
|
4393
|
-
* </p>
|
|
3999
|
+
* <p> Details of the raw response from the foundation model output. </p>
|
|
4394
4000
|
* @public
|
|
4395
4001
|
*/
|
|
4396
4002
|
rawResponse?: RawResponse | undefined;
|
|
4397
4003
|
/**
|
|
4398
|
-
* <p>
|
|
4399
|
-
* Contains information about the foundation model output from the pre-processing step.
|
|
4400
|
-
* </p>
|
|
4004
|
+
* <p> Contains information about the foundation model output from the pre-processing step. </p>
|
|
4401
4005
|
* @public
|
|
4402
4006
|
*/
|
|
4403
4007
|
metadata?: Metadata | undefined;
|
|
@@ -4417,18 +4021,7 @@ export type PreProcessingTrace = PreProcessingTrace.ModelInvocationInputMember |
|
|
|
4417
4021
|
*/
|
|
4418
4022
|
export declare namespace PreProcessingTrace {
|
|
4419
4023
|
/**
|
|
4420
|
-
* <p>The input for the pre-processing step.</p>
|
|
4421
|
-
* <ul>
|
|
4422
|
-
* <li>
|
|
4423
|
-
* <p>The <code>type</code> is <code>PRE_PROCESSING</code>.</p>
|
|
4424
|
-
* </li>
|
|
4425
|
-
* <li>
|
|
4426
|
-
* <p>The <code>text</code> contains the prompt.</p>
|
|
4427
|
-
* </li>
|
|
4428
|
-
* <li>
|
|
4429
|
-
* <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set 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.</p>
|
|
4430
|
-
* </li>
|
|
4431
|
-
* </ul>
|
|
4024
|
+
* <p>The input for the pre-processing step.</p> <ul> <li> <p>The <code>type</code> is <code>PRE_PROCESSING</code>.</p> </li> <li> <p>The <code>text</code> contains the prompt.</p> </li> <li> <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set 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.</p> </li> </ul>
|
|
4432
4025
|
* @public
|
|
4433
4026
|
*/
|
|
4434
4027
|
interface ModelInvocationInputMember {
|
|
@@ -4647,9 +4240,7 @@ export declare namespace Trace {
|
|
|
4647
4240
|
$unknown?: never;
|
|
4648
4241
|
}
|
|
4649
4242
|
/**
|
|
4650
|
-
* <p>
|
|
4651
|
-
* Details about the custom orchestration step in which the agent determines the order in which actions are executed.
|
|
4652
|
-
* </p>
|
|
4243
|
+
* <p> Details about the custom orchestration step in which the agent determines the order in which actions are executed. </p>
|
|
4653
4244
|
* @public
|
|
4654
4245
|
*/
|
|
4655
4246
|
interface CustomOrchestrationTraceMember {
|
|
@@ -4703,37 +4294,35 @@ export interface TracePart {
|
|
|
4703
4294
|
*/
|
|
4704
4295
|
trace?: Trace | undefined;
|
|
4705
4296
|
/**
|
|
4706
|
-
* <p>The
|
|
4297
|
+
* <p>The part's caller chain.</p>
|
|
4707
4298
|
* @public
|
|
4708
4299
|
*/
|
|
4709
|
-
|
|
4300
|
+
callerChain?: Caller[] | undefined;
|
|
4710
4301
|
/**
|
|
4711
|
-
* <p>The
|
|
4302
|
+
* <p> The time of the trace. </p>
|
|
4712
4303
|
* @public
|
|
4713
4304
|
*/
|
|
4714
|
-
|
|
4305
|
+
eventTime?: Date | undefined;
|
|
4715
4306
|
/**
|
|
4716
|
-
* <p>The
|
|
4307
|
+
* <p>The part's collaborator name.</p>
|
|
4717
4308
|
* @public
|
|
4718
4309
|
*/
|
|
4719
|
-
|
|
4310
|
+
collaboratorName?: string | undefined;
|
|
4720
4311
|
/**
|
|
4721
|
-
* <p>The
|
|
4312
|
+
* <p>The unique identifier of the agent.</p>
|
|
4722
4313
|
* @public
|
|
4723
4314
|
*/
|
|
4724
|
-
|
|
4315
|
+
agentId?: string | undefined;
|
|
4725
4316
|
/**
|
|
4726
|
-
* <p>
|
|
4727
|
-
* The time of the trace.
|
|
4728
|
-
* </p>
|
|
4317
|
+
* <p>The unique identifier of the alias of the agent.</p>
|
|
4729
4318
|
* @public
|
|
4730
4319
|
*/
|
|
4731
|
-
|
|
4320
|
+
agentAliasId?: string | undefined;
|
|
4732
4321
|
/**
|
|
4733
|
-
* <p>The
|
|
4322
|
+
* <p>The version of the agent.</p>
|
|
4734
4323
|
* @public
|
|
4735
4324
|
*/
|
|
4736
|
-
|
|
4325
|
+
agentVersion?: string | undefined;
|
|
4737
4326
|
}
|
|
4738
4327
|
/**
|
|
4739
4328
|
* <p>The response from invoking the agent and associated citations and trace information.</p>
|
|
@@ -4997,12 +4586,7 @@ export declare namespace ResponseStream {
|
|
|
4997
4586
|
$unknown?: never;
|
|
4998
4587
|
}
|
|
4999
4588
|
/**
|
|
5000
|
-
* <p>
|
|
5001
|
-
* The model specified in the request is not ready to serve Inference requests. The AWS SDK
|
|
5002
|
-
* will automatically retry the operation up to 5 times. For information about configuring
|
|
5003
|
-
* automatic retries, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html">Retry behavior</a> in the <i>AWS SDKs and Tools</i>
|
|
5004
|
-
* reference guide.
|
|
5005
|
-
* </p>
|
|
4589
|
+
* <p> The model specified in the request is not ready to serve Inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html">Retry behavior</a> in the <i>AWS SDKs and Tools</i> reference guide. </p>
|
|
5006
4590
|
* @public
|
|
5007
4591
|
*/
|
|
5008
4592
|
interface ModelNotReadyExceptionMember {
|
|
@@ -5131,59 +4715,43 @@ export declare const RelayConversationHistory: {
|
|
|
5131
4715
|
*/
|
|
5132
4716
|
export type RelayConversationHistory = (typeof RelayConversationHistory)[keyof typeof RelayConversationHistory];
|
|
5133
4717
|
/**
|
|
5134
|
-
* <p>
|
|
5135
|
-
* Settings of an inline collaborator agent.
|
|
5136
|
-
* </p>
|
|
4718
|
+
* <p> Settings of an inline collaborator agent. </p>
|
|
5137
4719
|
* @public
|
|
5138
4720
|
*/
|
|
5139
4721
|
export interface CollaboratorConfiguration {
|
|
5140
4722
|
/**
|
|
5141
|
-
* <p>
|
|
5142
|
-
* Name of the inline collaborator agent which must be the same name as specified for <code>agentName</code>.
|
|
5143
|
-
* </p>
|
|
4723
|
+
* <p> Name of the inline collaborator agent which must be the same name as specified for <code>agentName</code>. </p>
|
|
5144
4724
|
* @public
|
|
5145
4725
|
*/
|
|
5146
4726
|
collaboratorName: string | undefined;
|
|
5147
4727
|
/**
|
|
5148
|
-
* <p>
|
|
5149
|
-
* Instructions that tell the inline collaborator agent what it should do and how it should interact with users.
|
|
5150
|
-
* </p>
|
|
4728
|
+
* <p> Instructions that tell the inline collaborator agent what it should do and how it should interact with users. </p>
|
|
5151
4729
|
* @public
|
|
5152
4730
|
*/
|
|
5153
4731
|
collaboratorInstruction: string | undefined;
|
|
5154
4732
|
/**
|
|
5155
|
-
* <p>
|
|
5156
|
-
* The Amazon Resource Name (ARN) of the inline collaborator agent.
|
|
5157
|
-
* </p>
|
|
4733
|
+
* <p> The Amazon Resource Name (ARN) of the inline collaborator agent. </p>
|
|
5158
4734
|
* @public
|
|
5159
4735
|
*/
|
|
5160
4736
|
agentAliasArn?: string | undefined;
|
|
5161
4737
|
/**
|
|
5162
|
-
* <p>
|
|
5163
|
-
* A relay conversation history for the inline collaborator agent.
|
|
5164
|
-
* </p>
|
|
4738
|
+
* <p> A relay conversation history for the inline collaborator agent. </p>
|
|
5165
4739
|
* @public
|
|
5166
4740
|
*/
|
|
5167
4741
|
relayConversationHistory?: RelayConversationHistory | undefined;
|
|
5168
4742
|
}
|
|
5169
4743
|
/**
|
|
5170
|
-
* <p>
|
|
5171
|
-
* The configuration details for the guardrail.
|
|
5172
|
-
* </p>
|
|
4744
|
+
* <p> The configuration details for the guardrail. </p>
|
|
5173
4745
|
* @public
|
|
5174
4746
|
*/
|
|
5175
4747
|
export interface GuardrailConfigurationWithArn {
|
|
5176
4748
|
/**
|
|
5177
|
-
* <p>
|
|
5178
|
-
* The unique identifier for the guardrail.
|
|
5179
|
-
* </p>
|
|
4749
|
+
* <p> The unique identifier for the guardrail. </p>
|
|
5180
4750
|
* @public
|
|
5181
4751
|
*/
|
|
5182
4752
|
guardrailIdentifier: string | undefined;
|
|
5183
4753
|
/**
|
|
5184
|
-
* <p>
|
|
5185
|
-
* The version of the guardrail.
|
|
5186
|
-
* </p>
|
|
4754
|
+
* <p> The version of the guardrail. </p>
|
|
5187
4755
|
* @public
|
|
5188
4756
|
*/
|
|
5189
4757
|
guardrailVersion: string | undefined;
|
|
@@ -5201,16 +4769,12 @@ export declare const PromptState: {
|
|
|
5201
4769
|
*/
|
|
5202
4770
|
export type PromptState = (typeof PromptState)[keyof typeof PromptState];
|
|
5203
4771
|
/**
|
|
5204
|
-
* <p>
|
|
5205
|
-
* Contains configurations to override a prompt template in one part of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.
|
|
5206
|
-
* </p>
|
|
4772
|
+
* <p> Contains configurations to override a prompt template in one part of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>. </p>
|
|
5207
4773
|
* @public
|
|
5208
4774
|
*/
|
|
5209
4775
|
export interface PromptConfiguration {
|
|
5210
4776
|
/**
|
|
5211
|
-
* <p>
|
|
5212
|
-
* The step in the agent sequence that this prompt configuration applies to.
|
|
5213
|
-
* </p>
|
|
4777
|
+
* <p> The step in the agent sequence that this prompt configuration applies to. </p>
|
|
5214
4778
|
* @public
|
|
5215
4779
|
*/
|
|
5216
4780
|
promptType?: PromptType | undefined;
|
|
@@ -5220,29 +4784,7 @@ export interface PromptConfiguration {
|
|
|
5220
4784
|
*/
|
|
5221
4785
|
promptCreationMode?: CreationMode | undefined;
|
|
5222
4786
|
/**
|
|
5223
|
-
* <p>Specifies whether to allow the inline agent to carry out the step specified in the <code>promptType</code>. If you set this value to <code>DISABLED</code>, the agent skips that step. The default state for each <code>promptType</code> is as follows.</p>
|
|
5224
|
-
* <ul>
|
|
5225
|
-
* <li>
|
|
5226
|
-
* <p>
|
|
5227
|
-
* <code>PRE_PROCESSING</code> – <code>ENABLED</code>
|
|
5228
|
-
* </p>
|
|
5229
|
-
* </li>
|
|
5230
|
-
* <li>
|
|
5231
|
-
* <p>
|
|
5232
|
-
* <code>ORCHESTRATION</code> – <code>ENABLED</code>
|
|
5233
|
-
* </p>
|
|
5234
|
-
* </li>
|
|
5235
|
-
* <li>
|
|
5236
|
-
* <p>
|
|
5237
|
-
* <code>KNOWLEDGE_BASE_RESPONSE_GENERATION</code> – <code>ENABLED</code>
|
|
5238
|
-
* </p>
|
|
5239
|
-
* </li>
|
|
5240
|
-
* <li>
|
|
5241
|
-
* <p>
|
|
5242
|
-
* <code>POST_PROCESSING</code> – <code>DISABLED</code>
|
|
5243
|
-
* </p>
|
|
5244
|
-
* </li>
|
|
5245
|
-
* </ul>
|
|
4787
|
+
* <p>Specifies whether to allow the inline agent to carry out the step specified in the <code>promptType</code>. If you set this value to <code>DISABLED</code>, the agent skips that step. The default state for each <code>promptType</code> is as follows.</p> <ul> <li> <p> <code>PRE_PROCESSING</code> – <code>ENABLED</code> </p> </li> <li> <p> <code>ORCHESTRATION</code> – <code>ENABLED</code> </p> </li> <li> <p> <code>KNOWLEDGE_BASE_RESPONSE_GENERATION</code> – <code>ENABLED</code> </p> </li> <li> <p> <code>POST_PROCESSING</code> – <code>DISABLED</code> </p> </li> </ul>
|
|
5246
4788
|
* @public
|
|
5247
4789
|
*/
|
|
5248
4790
|
promptState?: PromptState | undefined;
|
|
@@ -5262,20 +4804,12 @@ export interface PromptConfiguration {
|
|
|
5262
4804
|
*/
|
|
5263
4805
|
parserMode?: CreationMode | undefined;
|
|
5264
4806
|
/**
|
|
5265
|
-
* <p>
|
|
5266
|
-
* The foundation model to use.
|
|
5267
|
-
* </p>
|
|
4807
|
+
* <p> The foundation model to use. </p>
|
|
5268
4808
|
* @public
|
|
5269
4809
|
*/
|
|
5270
4810
|
foundationModel?: string | undefined;
|
|
5271
4811
|
/**
|
|
5272
|
-
* <p>If the Converse or ConverseStream operations support the model,
|
|
5273
|
-
* <code>additionalModelRequestFields</code> contains additional inference parameters,
|
|
5274
|
-
* beyond the base set of inference parameters in the <code>inferenceConfiguration</code>
|
|
5275
|
-
* field. </p>
|
|
5276
|
-
* <p>For more information, see <i>Inference request parameters and
|
|
5277
|
-
* response fields for foundation models</i> in the Amazon Bedrock user
|
|
5278
|
-
* guide.</p>
|
|
4812
|
+
* <p>If the Converse or ConverseStream operations support the model, <code>additionalModelRequestFields</code> contains additional inference parameters, beyond the base set of inference parameters in the <code>inferenceConfiguration</code> field. </p> <p>For more information, see <i>Inference request parameters and response fields for foundation models</i> in the Amazon Bedrock user guide.</p>
|
|
5279
4813
|
* @public
|
|
5280
4814
|
*/
|
|
5281
4815
|
additionalModelRequestFields?: __DocumentType | undefined;
|
|
@@ -5291,71 +4825,100 @@ export interface PromptOverrideConfiguration {
|
|
|
5291
4825
|
*/
|
|
5292
4826
|
promptConfigurations: PromptConfiguration[] | undefined;
|
|
5293
4827
|
/**
|
|
5294
|
-
* <p>The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
|
|
5295
|
-
* If you specify this field, at least one of the <code>promptConfigurations</code> must contain a <code>parserMode</code> value that is
|
|
5296
|
-
* set to <code>OVERRIDDEN</code>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html">Parser Lambda function in Amazon Bedrock Agents</a>.
|
|
5297
|
-
* </p>
|
|
4828
|
+
* <p>The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the <code>promptConfigurations</code> must contain a <code>parserMode</code> value that is set to <code>OVERRIDDEN</code>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html">Parser Lambda function in Amazon Bedrock Agents</a>. </p>
|
|
5298
4829
|
* @public
|
|
5299
4830
|
*/
|
|
5300
4831
|
overrideLambda?: string | undefined;
|
|
5301
4832
|
}
|
|
5302
4833
|
/**
|
|
5303
|
-
* <p>
|
|
5304
|
-
*
|
|
5305
|
-
|
|
5306
|
-
|
|
5307
|
-
|
|
5308
|
-
*
|
|
4834
|
+
* <p>The structure of the executor invoking the actions in custom orchestration.</p>
|
|
4835
|
+
* @public
|
|
4836
|
+
*/
|
|
4837
|
+
export type OrchestrationExecutor = OrchestrationExecutor.LambdaMember | OrchestrationExecutor.$UnknownMember;
|
|
4838
|
+
/**
|
|
4839
|
+
* @public
|
|
4840
|
+
*/
|
|
4841
|
+
export declare namespace OrchestrationExecutor {
|
|
4842
|
+
/**
|
|
4843
|
+
* <p>The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action. </p>
|
|
4844
|
+
* @public
|
|
4845
|
+
*/
|
|
4846
|
+
interface LambdaMember {
|
|
4847
|
+
lambda: string;
|
|
4848
|
+
$unknown?: never;
|
|
4849
|
+
}
|
|
4850
|
+
/**
|
|
4851
|
+
* @public
|
|
4852
|
+
*/
|
|
4853
|
+
interface $UnknownMember {
|
|
4854
|
+
lambda?: never;
|
|
4855
|
+
$unknown: [string, any];
|
|
4856
|
+
}
|
|
4857
|
+
interface Visitor<T> {
|
|
4858
|
+
lambda: (value: string) => T;
|
|
4859
|
+
_: (name: string, value: any) => T;
|
|
4860
|
+
}
|
|
4861
|
+
const visit: <T>(value: OrchestrationExecutor, visitor: Visitor<T>) => T;
|
|
4862
|
+
}
|
|
4863
|
+
/**
|
|
4864
|
+
* <p>Contains details of the custom orchestration configured for the agent. </p>
|
|
4865
|
+
* @public
|
|
4866
|
+
*/
|
|
4867
|
+
export interface CustomOrchestration {
|
|
4868
|
+
/**
|
|
4869
|
+
* <p>The structure of the executor invoking the actions in custom orchestration. </p>
|
|
4870
|
+
* @public
|
|
4871
|
+
*/
|
|
4872
|
+
executor?: OrchestrationExecutor | undefined;
|
|
4873
|
+
}
|
|
4874
|
+
/**
|
|
4875
|
+
* <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 <code>InvokeInlineAgent</code> request. Use session state attributes to control and provide conversational context for your inline 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>
|
|
5309
4876
|
* @public
|
|
5310
4877
|
*/
|
|
5311
4878
|
export interface InlineSessionState {
|
|
5312
4879
|
/**
|
|
5313
|
-
* <p>
|
|
5314
|
-
* Contains attributes that persist across a session and the values of those attributes.
|
|
5315
|
-
* </p>
|
|
4880
|
+
* <p> Contains attributes that persist across a session and the values of those attributes. </p>
|
|
5316
4881
|
* @public
|
|
5317
4882
|
*/
|
|
5318
4883
|
sessionAttributes?: Record<string, string> | undefined;
|
|
5319
4884
|
/**
|
|
5320
|
-
* <p>
|
|
5321
|
-
* Contains attributes that persist across a session and the values of those attributes.
|
|
5322
|
-
* </p>
|
|
4885
|
+
* <p> Contains attributes that persist across a session and the values of those attributes. </p>
|
|
5323
4886
|
* @public
|
|
5324
4887
|
*/
|
|
5325
4888
|
promptSessionAttributes?: Record<string, string> | undefined;
|
|
5326
4889
|
/**
|
|
5327
|
-
* <p>
|
|
5328
|
-
* 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>.
|
|
5329
|
-
* </p>
|
|
5330
|
-
* <note>
|
|
5331
|
-
* <p>If you include this field in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
|
|
5332
|
-
* </note>
|
|
4890
|
+
* <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>. </p> <note> <p>If you include this field in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p> </note>
|
|
5333
4891
|
* @public
|
|
5334
4892
|
*/
|
|
5335
4893
|
returnControlInvocationResults?: InvocationResultMember[] | undefined;
|
|
5336
4894
|
/**
|
|
5337
|
-
* <p>
|
|
5338
|
-
* The identifier of the invocation of an action. This value must match the <code>invocationId</code> returned in the <code>InvokeInlineAgent</code> response for the action
|
|
5339
|
-
* 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>.
|
|
5340
|
-
* </p>
|
|
4895
|
+
* <p> The identifier of the invocation of an action. This value must match the <code>invocationId</code> returned in the <code>InvokeInlineAgent</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>. </p>
|
|
5341
4896
|
* @public
|
|
5342
4897
|
*/
|
|
5343
4898
|
invocationId?: string | undefined;
|
|
5344
4899
|
/**
|
|
5345
|
-
* <p>
|
|
5346
|
-
* Contains information about the files used by code interpreter.
|
|
5347
|
-
* </p>
|
|
4900
|
+
* <p> Contains information about the files used by code interpreter. </p>
|
|
5348
4901
|
* @public
|
|
5349
4902
|
*/
|
|
5350
4903
|
files?: InputFile[] | undefined;
|
|
5351
4904
|
/**
|
|
5352
|
-
* <p>
|
|
5353
|
-
* Contains the conversation history that persist across sessions.
|
|
5354
|
-
* </p>
|
|
4905
|
+
* <p> Contains the conversation history that persist across sessions. </p>
|
|
5355
4906
|
* @public
|
|
5356
4907
|
*/
|
|
5357
4908
|
conversationHistory?: ConversationHistory | undefined;
|
|
5358
4909
|
}
|
|
4910
|
+
/**
|
|
4911
|
+
* @public
|
|
4912
|
+
* @enum
|
|
4913
|
+
*/
|
|
4914
|
+
export declare const OrchestrationType: {
|
|
4915
|
+
readonly CUSTOM_ORCHESTRATION: "CUSTOM_ORCHESTRATION";
|
|
4916
|
+
readonly DEFAULT: "DEFAULT";
|
|
4917
|
+
};
|
|
4918
|
+
/**
|
|
4919
|
+
* @public
|
|
4920
|
+
*/
|
|
4921
|
+
export type OrchestrationType = (typeof OrchestrationType)[keyof typeof OrchestrationType];
|
|
5359
4922
|
/**
|
|
5360
4923
|
* <p>Contains a part of an agent response and citations for it. </p>
|
|
5361
4924
|
* @public
|
|
@@ -5384,14 +4947,12 @@ export interface InlineAgentFilePart {
|
|
|
5384
4947
|
files?: OutputFile[] | undefined;
|
|
5385
4948
|
}
|
|
5386
4949
|
/**
|
|
5387
|
-
* <p>Contains information to return from the action group that the agent has predicted to invoke.</p>
|
|
5388
|
-
* <p>This data type is used in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> API operation.</p>
|
|
4950
|
+
* <p>Contains information to return from the action group that the agent has predicted to invoke.</p> <p>This data type is used in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> API operation.</p>
|
|
5389
4951
|
* @public
|
|
5390
4952
|
*/
|
|
5391
4953
|
export interface InlineAgentReturnControlPayload {
|
|
5392
4954
|
/**
|
|
5393
|
-
* <p>A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent
|
|
5394
|
-
* determines from its session with the user.</p>
|
|
4955
|
+
* <p>A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.</p>
|
|
5395
4956
|
* @public
|
|
5396
4957
|
*/
|
|
5397
4958
|
invocationInputs?: InvocationInputMember[] | undefined;
|
|
@@ -5402,9 +4963,7 @@ export interface InlineAgentReturnControlPayload {
|
|
|
5402
4963
|
invocationId?: string | undefined;
|
|
5403
4964
|
}
|
|
5404
4965
|
/**
|
|
5405
|
-
* <p>Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases
|
|
5406
|
-
* and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer.
|
|
5407
|
-
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement">Trace enablement</a>.</p>
|
|
4966
|
+
* <p>Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement">Trace enablement</a>.</p>
|
|
5408
4967
|
* @public
|
|
5409
4968
|
*/
|
|
5410
4969
|
export interface InlineAgentTracePart {
|
|
@@ -5414,12 +4973,25 @@ export interface InlineAgentTracePart {
|
|
|
5414
4973
|
*/
|
|
5415
4974
|
sessionId?: string | undefined;
|
|
5416
4975
|
/**
|
|
5417
|
-
* <p>Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the
|
|
5418
|
-
* agent arrived at the response it provided the customer. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement">Trace enablement</a>.
|
|
5419
|
-
* </p>
|
|
4976
|
+
* <p>Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement">Trace enablement</a>. </p>
|
|
5420
4977
|
* @public
|
|
5421
4978
|
*/
|
|
5422
4979
|
trace?: Trace | undefined;
|
|
4980
|
+
/**
|
|
4981
|
+
* <p>The caller chain for the trace part.</p>
|
|
4982
|
+
* @public
|
|
4983
|
+
*/
|
|
4984
|
+
callerChain?: Caller[] | undefined;
|
|
4985
|
+
/**
|
|
4986
|
+
* <p>The time that trace occurred. </p>
|
|
4987
|
+
* @public
|
|
4988
|
+
*/
|
|
4989
|
+
eventTime?: Date | undefined;
|
|
4990
|
+
/**
|
|
4991
|
+
* <p>The collaborator name for the trace part.</p>
|
|
4992
|
+
* @public
|
|
4993
|
+
*/
|
|
4994
|
+
collaboratorName?: string | undefined;
|
|
5423
4995
|
}
|
|
5424
4996
|
/**
|
|
5425
4997
|
* <p>The response from invoking the agent and associated citations and trace information.</p>
|
|
@@ -5451,10 +5023,7 @@ export declare namespace InlineAgentResponseStream {
|
|
|
5451
5023
|
$unknown?: never;
|
|
5452
5024
|
}
|
|
5453
5025
|
/**
|
|
5454
|
-
* <p>Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying
|
|
5455
|
-
* knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer.
|
|
5456
|
-
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html">Trace events</a>.
|
|
5457
|
-
* </p>
|
|
5026
|
+
* <p>Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html">Trace events</a>. </p>
|
|
5458
5027
|
* @public
|
|
5459
5028
|
*/
|
|
5460
5029
|
interface TraceMember {
|
|
@@ -5474,8 +5043,7 @@ export declare namespace InlineAgentResponseStream {
|
|
|
5474
5043
|
$unknown?: never;
|
|
5475
5044
|
}
|
|
5476
5045
|
/**
|
|
5477
|
-
* <p>Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system
|
|
5478
|
-
* and can be used in your own setup for fulfilling the action.</p>
|
|
5046
|
+
* <p>Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.</p>
|
|
5479
5047
|
* @public
|
|
5480
5048
|
*/
|
|
5481
5049
|
interface ReturnControlMember {
|
|
@@ -5736,23 +5304,17 @@ export declare namespace InlineAgentResponseStream {
|
|
|
5736
5304
|
*/
|
|
5737
5305
|
export interface InvokeInlineAgentResponse {
|
|
5738
5306
|
/**
|
|
5739
|
-
* <p>
|
|
5740
|
-
*
|
|
5741
|
-
* </p>
|
|
5307
|
+
* <p>The inline agent's response to the user prompt. </p>
|
|
5742
5308
|
* @public
|
|
5743
5309
|
*/
|
|
5744
5310
|
completion: AsyncIterable<InlineAgentResponseStream> | undefined;
|
|
5745
5311
|
/**
|
|
5746
|
-
* <p>
|
|
5747
|
-
* The MIME type of the input data in the request. The default value is application/json.
|
|
5748
|
-
* </p>
|
|
5312
|
+
* <p> The MIME type of the input data in the request. The default value is application/json. </p>
|
|
5749
5313
|
* @public
|
|
5750
5314
|
*/
|
|
5751
5315
|
contentType: string | undefined;
|
|
5752
5316
|
/**
|
|
5753
|
-
* <p>
|
|
5754
|
-
* The unique identifier of the session with the agent.
|
|
5755
|
-
* </p>
|
|
5317
|
+
* <p> The unique identifier of the session with the agent. </p>
|
|
5756
5318
|
* @public
|
|
5757
5319
|
*/
|
|
5758
5320
|
sessionId: string | undefined;
|
|
@@ -5803,15 +5365,12 @@ export type MemoryType = (typeof MemoryType)[keyof typeof MemoryType];
|
|
|
5803
5365
|
*/
|
|
5804
5366
|
export interface GetAgentMemoryRequest {
|
|
5805
5367
|
/**
|
|
5806
|
-
* <p>If the total number of results is greater than the maxItems value provided in the request, enter the token returned
|
|
5807
|
-
* in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
5368
|
+
* <p>If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
5808
5369
|
* @public
|
|
5809
5370
|
*/
|
|
5810
5371
|
nextToken?: string | undefined;
|
|
5811
5372
|
/**
|
|
5812
|
-
* <p>The maximum number of items to return in the response. If the total number of results is greater
|
|
5813
|
-
* than this value, use the token returned in the response in the <code>nextToken</code> field when making another
|
|
5814
|
-
* request to return the next batch of results.</p>
|
|
5373
|
+
* <p>The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
5815
5374
|
* @public
|
|
5816
5375
|
*/
|
|
5817
5376
|
maxItems?: number | undefined;
|
|
@@ -5902,8 +5461,7 @@ export declare namespace Memory {
|
|
|
5902
5461
|
*/
|
|
5903
5462
|
export interface GetAgentMemoryResponse {
|
|
5904
5463
|
/**
|
|
5905
|
-
* <p>If the total number of results is greater than the maxItems value provided in the request, use this token
|
|
5906
|
-
* when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
5464
|
+
* <p>If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
5907
5465
|
* @public
|
|
5908
5466
|
*/
|
|
5909
5467
|
nextToken?: string | undefined;
|
|
@@ -6406,14 +5964,7 @@ export interface RerankResponse {
|
|
|
6406
5964
|
nextToken?: string | undefined;
|
|
6407
5965
|
}
|
|
6408
5966
|
/**
|
|
6409
|
-
* <p>Contains the query made to the knowledge base.</p>
|
|
6410
|
-
* <p>This data type is used in the following API operations:</p>
|
|
6411
|
-
* <ul>
|
|
6412
|
-
* <li>
|
|
6413
|
-
* <p>
|
|
6414
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>input</code> field</p>
|
|
6415
|
-
* </li>
|
|
6416
|
-
* </ul>
|
|
5967
|
+
* <p>Contains the query made to the knowledge base.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>input</code> field</p> </li> </ul>
|
|
6417
5968
|
* @public
|
|
6418
5969
|
*/
|
|
6419
5970
|
export interface RetrieveAndGenerateInput {
|
|
@@ -6440,20 +5991,12 @@ export interface GuardrailConfiguration {
|
|
|
6440
5991
|
guardrailVersion: string | undefined;
|
|
6441
5992
|
}
|
|
6442
5993
|
/**
|
|
6443
|
-
* <p>Configuration settings for text generation using a language model via the
|
|
6444
|
-
* RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token
|
|
6445
|
-
* count, and stop sequences. </p>
|
|
6446
|
-
* <note>
|
|
6447
|
-
* <p>The valid range of <code>maxTokens</code> depends on the accepted values for your chosen
|
|
6448
|
-
* model's inference parameters. To see the inference parameters for your model, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference
|
|
6449
|
-
* parameters for foundation models.</a>
|
|
6450
|
-
* </p>
|
|
6451
|
-
* </note>
|
|
5994
|
+
* <p>Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences. </p> <note> <p>The valid range of <code>maxTokens</code> depends on the accepted values for your chosen model's inference parameters. To see the inference parameters for your model, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models.</a> </p> </note>
|
|
6452
5995
|
* @public
|
|
6453
5996
|
*/
|
|
6454
5997
|
export interface TextInferenceConfig {
|
|
6455
5998
|
/**
|
|
6456
|
-
* <p> Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
|
|
5999
|
+
* <p> Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable. </p>
|
|
6457
6000
|
* @public
|
|
6458
6001
|
*/
|
|
6459
6002
|
temperature?: number | undefined;
|
|
@@ -6463,17 +6006,12 @@ export interface TextInferenceConfig {
|
|
|
6463
6006
|
*/
|
|
6464
6007
|
topP?: number | undefined;
|
|
6465
6008
|
/**
|
|
6466
|
-
* <p>The maximum number of tokens to generate in the output text. Do not use the minimum of 0
|
|
6467
|
-
* or the maximum of 65536. The limit values described here are arbitary values, for actual
|
|
6468
|
-
* values consult the limits defined by your specific model.</p>
|
|
6009
|
+
* <p>The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.</p>
|
|
6469
6010
|
* @public
|
|
6470
6011
|
*/
|
|
6471
6012
|
maxTokens?: number | undefined;
|
|
6472
6013
|
/**
|
|
6473
|
-
* <p>A list of sequences of characters that, if generated, will cause the model to stop
|
|
6474
|
-
* generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The
|
|
6475
|
-
* limit values described here are arbitary values, for actual values consult the limits defined
|
|
6476
|
-
* by your specific model.</p>
|
|
6014
|
+
* <p>A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.</p>
|
|
6477
6015
|
* @public
|
|
6478
6016
|
*/
|
|
6479
6017
|
stopSequences?: string[] | undefined;
|
|
@@ -6490,32 +6028,12 @@ export interface InferenceConfig {
|
|
|
6490
6028
|
textInferenceConfig?: TextInferenceConfig | undefined;
|
|
6491
6029
|
}
|
|
6492
6030
|
/**
|
|
6493
|
-
* <p>Contains the template for the prompt that's sent to the model for response generation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt">Knowledge base prompt templates</a>.</p>
|
|
6494
|
-
* <p>This data type is used in the following API operations:</p>
|
|
6495
|
-
* <ul>
|
|
6496
|
-
* <li>
|
|
6497
|
-
* <p>
|
|
6498
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>filter</code> field</p>
|
|
6499
|
-
* </li>
|
|
6500
|
-
* </ul>
|
|
6031
|
+
* <p>Contains the template for the prompt that's sent to the model for response generation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt">Knowledge base prompt templates</a>.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>filter</code> field</p> </li> </ul>
|
|
6501
6032
|
* @public
|
|
6502
6033
|
*/
|
|
6503
6034
|
export interface PromptTemplate {
|
|
6504
6035
|
/**
|
|
6505
|
-
* <p>The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.</p>
|
|
6506
|
-
* <p>For more information, see the following resources:</p>
|
|
6507
|
-
* <ul>
|
|
6508
|
-
* <li>
|
|
6509
|
-
* <p>
|
|
6510
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt">Knowledge base prompt templates</a>
|
|
6511
|
-
* </p>
|
|
6512
|
-
* </li>
|
|
6513
|
-
* <li>
|
|
6514
|
-
* <p>
|
|
6515
|
-
* <a href="https://docs.anthropic.com/claude/docs/use-xml-tags">Use XML tags with Anthropic Claude models</a>
|
|
6516
|
-
* </p>
|
|
6517
|
-
* </li>
|
|
6518
|
-
* </ul>
|
|
6036
|
+
* <p>The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.</p> <p>For more information, see the following resources:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt">Knowledge base prompt templates</a> </p> </li> <li> <p> <a href="https://docs.anthropic.com/claude/docs/use-xml-tags">Use XML tags with Anthropic Claude models</a> </p> </li> </ul>
|
|
6519
6037
|
* @public
|
|
6520
6038
|
*/
|
|
6521
6039
|
textPromptTemplate?: string | undefined;
|
|
@@ -6638,15 +6156,7 @@ export interface ExternalSourcesRetrieveAndGenerateConfiguration {
|
|
|
6638
6156
|
generationConfiguration?: ExternalSourcesGenerationConfiguration | undefined;
|
|
6639
6157
|
}
|
|
6640
6158
|
/**
|
|
6641
|
-
* <p>Contains configurations for response generation based on the knowledge base query results.</p>
|
|
6642
|
-
* <p>This data type is used in the following API operations:</p>
|
|
6643
|
-
* <ul>
|
|
6644
|
-
* <li>
|
|
6645
|
-
* <p>
|
|
6646
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a>
|
|
6647
|
-
* </p>
|
|
6648
|
-
* </li>
|
|
6649
|
-
* </ul>
|
|
6159
|
+
* <p>Contains configurations for response generation based on the knowledge base query results.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> </p> </li> </ul>
|
|
6650
6160
|
* @public
|
|
6651
6161
|
*/
|
|
6652
6162
|
export interface GenerationConfiguration {
|
|
@@ -6688,8 +6198,7 @@ export declare const QueryTransformationType: {
|
|
|
6688
6198
|
*/
|
|
6689
6199
|
export type QueryTransformationType = (typeof QueryTransformationType)[keyof typeof QueryTransformationType];
|
|
6690
6200
|
/**
|
|
6691
|
-
* <p>To split up the prompt and retrieve multiple sources, set the transformation type to
|
|
6692
|
-
* <code>QUERY_DECOMPOSITION</code>.</p>
|
|
6201
|
+
* <p>To split up the prompt and retrieve multiple sources, set the transformation type to <code>QUERY_DECOMPOSITION</code>.</p>
|
|
6693
6202
|
* @public
|
|
6694
6203
|
*/
|
|
6695
6204
|
export interface QueryTransformationConfiguration {
|
|
@@ -6720,8 +6229,7 @@ export interface OrchestrationConfiguration {
|
|
|
6720
6229
|
*/
|
|
6721
6230
|
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
6722
6231
|
/**
|
|
6723
|
-
* <p>To split up the prompt and retrieve multiple sources, set the transformation type to
|
|
6724
|
-
* <code>QUERY_DECOMPOSITION</code>.</p>
|
|
6232
|
+
* <p>To split up the prompt and retrieve multiple sources, set the transformation type to <code>QUERY_DECOMPOSITION</code>.</p>
|
|
6725
6233
|
* @public
|
|
6726
6234
|
*/
|
|
6727
6235
|
queryTransformationConfiguration?: QueryTransformationConfiguration | undefined;
|
|
@@ -6744,14 +6252,7 @@ export declare const RetrieveAndGenerateType: {
|
|
|
6744
6252
|
*/
|
|
6745
6253
|
export type RetrieveAndGenerateType = (typeof RetrieveAndGenerateType)[keyof typeof RetrieveAndGenerateType];
|
|
6746
6254
|
/**
|
|
6747
|
-
* <p>Contains configuration about the session with the knowledge base.</p>
|
|
6748
|
-
* <p>This data type is used in the following API operations:</p>
|
|
6749
|
-
* <ul>
|
|
6750
|
-
* <li>
|
|
6751
|
-
* <p>
|
|
6752
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>sessionConfiguration</code> field</p>
|
|
6753
|
-
* </li>
|
|
6754
|
-
* </ul>
|
|
6255
|
+
* <p>Contains configuration about the session with the knowledge base.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>sessionConfiguration</code> field</p> </li> </ul>
|
|
6755
6256
|
* @public
|
|
6756
6257
|
*/
|
|
6757
6258
|
export interface RetrieveAndGenerateSessionConfiguration {
|
|
@@ -6774,14 +6275,7 @@ export declare const GuadrailAction: {
|
|
|
6774
6275
|
*/
|
|
6775
6276
|
export type GuadrailAction = (typeof GuadrailAction)[keyof typeof GuadrailAction];
|
|
6776
6277
|
/**
|
|
6777
|
-
* <p>Contains the response generated from querying the knowledge base.</p>
|
|
6778
|
-
* <p>This data type is used in the following API operations:</p>
|
|
6779
|
-
* <ul>
|
|
6780
|
-
* <li>
|
|
6781
|
-
* <p>
|
|
6782
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>output</code> field</p>
|
|
6783
|
-
* </li>
|
|
6784
|
-
* </ul>
|
|
6278
|
+
* <p>Contains the response generated from querying the knowledge base.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>output</code> field</p> </li> </ul>
|
|
6785
6279
|
* @public
|
|
6786
6280
|
*/
|
|
6787
6281
|
export interface RetrieveAndGenerateOutput {
|
|
@@ -6947,8 +6441,7 @@ export declare namespace RetrieveAndGenerateStreamResponseOutput {
|
|
|
6947
6441
|
$unknown?: never;
|
|
6948
6442
|
}
|
|
6949
6443
|
/**
|
|
6950
|
-
* <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error,
|
|
6951
|
-
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide.</p>
|
|
6444
|
+
* <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide.</p>
|
|
6952
6445
|
* @public
|
|
6953
6446
|
*/
|
|
6954
6447
|
interface ValidationExceptionMember {
|
|
@@ -6967,8 +6460,7 @@ export declare namespace RetrieveAndGenerateStreamResponseOutput {
|
|
|
6967
6460
|
$unknown?: never;
|
|
6968
6461
|
}
|
|
6969
6462
|
/**
|
|
6970
|
-
* <p>The specified resource ARN was not found. For troubleshooting this error,
|
|
6971
|
-
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found">ResourceNotFound</a> in the Amazon Bedrock User Guide.</p>
|
|
6463
|
+
* <p>The specified resource ARN was not found. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found">ResourceNotFound</a> in the Amazon Bedrock User Guide.</p>
|
|
6972
6464
|
* @public
|
|
6973
6465
|
*/
|
|
6974
6466
|
interface ResourceNotFoundExceptionMember {
|
|
@@ -7006,8 +6498,7 @@ export declare namespace RetrieveAndGenerateStreamResponseOutput {
|
|
|
7006
6498
|
$unknown?: never;
|
|
7007
6499
|
}
|
|
7008
6500
|
/**
|
|
7009
|
-
* <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For
|
|
7010
|
-
* troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide.</p>
|
|
6501
|
+
* <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide.</p>
|
|
7011
6502
|
* @public
|
|
7012
6503
|
*/
|
|
7013
6504
|
interface ThrottlingExceptionMember {
|
|
@@ -7026,8 +6517,7 @@ export declare namespace RetrieveAndGenerateStreamResponseOutput {
|
|
|
7026
6517
|
$unknown?: never;
|
|
7027
6518
|
}
|
|
7028
6519
|
/**
|
|
7029
|
-
* <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error,
|
|
7030
|
-
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide.</p>
|
|
6520
|
+
* <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide.</p>
|
|
7031
6521
|
* @public
|
|
7032
6522
|
*/
|
|
7033
6523
|
interface AccessDeniedExceptionMember {
|
|
@@ -7153,14 +6643,7 @@ export interface RetrieveAndGenerateStreamResponse {
|
|
|
7153
6643
|
sessionId: string | undefined;
|
|
7154
6644
|
}
|
|
7155
6645
|
/**
|
|
7156
|
-
* <p>Contains the query made to the knowledge base.</p>
|
|
7157
|
-
* <p>This data type is used in the following API operations:</p>
|
|
7158
|
-
* <ul>
|
|
7159
|
-
* <li>
|
|
7160
|
-
* <p>
|
|
7161
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>retrievalQuery</code> field</p>
|
|
7162
|
-
* </li>
|
|
7163
|
-
* </ul>
|
|
6646
|
+
* <p>Contains the query made to the knowledge base.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>retrievalQuery</code> field</p> </li> </ul>
|
|
7164
6647
|
* @public
|
|
7165
6648
|
*/
|
|
7166
6649
|
export interface KnowledgeBaseQuery {
|
|
@@ -7171,14 +6654,7 @@ export interface KnowledgeBaseQuery {
|
|
|
7171
6654
|
text: string | undefined;
|
|
7172
6655
|
}
|
|
7173
6656
|
/**
|
|
7174
|
-
* <p>Details about a result from querying the knowledge base.</p>
|
|
7175
|
-
* <p>This data type is used in the following API operations:</p>
|
|
7176
|
-
* <ul>
|
|
7177
|
-
* <li>
|
|
7178
|
-
* <p>
|
|
7179
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>retrievalResults</code> field</p>
|
|
7180
|
-
* </li>
|
|
7181
|
-
* </ul>
|
|
6657
|
+
* <p>Details about a result from querying the knowledge base.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>retrievalResults</code> field</p> </li> </ul>
|
|
7182
6658
|
* @public
|
|
7183
6659
|
*/
|
|
7184
6660
|
export interface KnowledgeBaseRetrievalResult {
|
|
@@ -7228,15 +6704,12 @@ export interface RetrieveResponse {
|
|
|
7228
6704
|
*/
|
|
7229
6705
|
export interface CreateSessionRequest {
|
|
7230
6706
|
/**
|
|
7231
|
-
* <p>A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference,
|
|
7232
|
-
* and the type of device they are using.</p>
|
|
6707
|
+
* <p>A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, and the type of device they are using.</p>
|
|
7233
6708
|
* @public
|
|
7234
6709
|
*/
|
|
7235
6710
|
sessionMetadata?: Record<string, string> | undefined;
|
|
7236
6711
|
/**
|
|
7237
|
-
* <p>The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key.
|
|
7238
|
-
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html">Amazon Bedrock session encryption</a>.
|
|
7239
|
-
* </p>
|
|
6712
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html">Amazon Bedrock session encryption</a>. </p>
|
|
7240
6713
|
* @public
|
|
7241
6714
|
*/
|
|
7242
6715
|
encryptionKeyArn?: string | undefined;
|
|
@@ -7374,8 +6847,7 @@ export interface GetSessionResponse {
|
|
|
7374
6847
|
*/
|
|
7375
6848
|
sessionMetadata?: Record<string, string> | undefined;
|
|
7376
6849
|
/**
|
|
7377
|
-
* <p>The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data.
|
|
7378
|
-
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html">Amazon Bedrock session encryption</a>.</p>
|
|
6850
|
+
* <p>The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html">Amazon Bedrock session encryption</a>.</p>
|
|
7379
6851
|
* @public
|
|
7380
6852
|
*/
|
|
7381
6853
|
encryptionKeyArn?: string | undefined;
|
|
@@ -7395,8 +6867,7 @@ export interface CreateInvocationRequest {
|
|
|
7395
6867
|
*/
|
|
7396
6868
|
description?: string | undefined;
|
|
7397
6869
|
/**
|
|
7398
|
-
* <p>The unique identifier for the associated session for the invocation. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).
|
|
7399
|
-
* </p>
|
|
6870
|
+
* <p>The unique identifier for the associated session for the invocation. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN). </p>
|
|
7400
6871
|
* @public
|
|
7401
6872
|
*/
|
|
7402
6873
|
sessionIdentifier: string | undefined;
|
|
@@ -7426,16 +6897,12 @@ export interface CreateInvocationResponse {
|
|
|
7426
6897
|
*/
|
|
7427
6898
|
export interface ListInvocationsRequest {
|
|
7428
6899
|
/**
|
|
7429
|
-
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the
|
|
7430
|
-
* token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.
|
|
7431
|
-
* </p>
|
|
6900
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results. </p>
|
|
7432
6901
|
* @public
|
|
7433
6902
|
*/
|
|
7434
6903
|
nextToken?: string | undefined;
|
|
7435
6904
|
/**
|
|
7436
|
-
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value,
|
|
7437
|
-
* use the token returned in the response in the <code>nextToken</code> field when making another request to return the next
|
|
7438
|
-
* batch of results.</p>
|
|
6905
|
+
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
7439
6906
|
* @public
|
|
7440
6907
|
*/
|
|
7441
6908
|
maxResults?: number | undefined;
|
|
@@ -7585,10 +7052,7 @@ export interface ImageBlock {
|
|
|
7585
7052
|
source: ImageSource | undefined;
|
|
7586
7053
|
}
|
|
7587
7054
|
/**
|
|
7588
|
-
* <p>A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a
|
|
7589
|
-
* session in the <code>payLoad</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_PutInvocationStep.html">PutInvocationStep</a> API operation.
|
|
7590
|
-
* You retrieve the content with the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_GetInvocationStep.html">GetInvocationStep</a> API operation.</p>
|
|
7591
|
-
* <p>For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
|
|
7055
|
+
* <p>A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a session in the <code>payLoad</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_PutInvocationStep.html">PutInvocationStep</a> API operation. You retrieve the content with the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_GetInvocationStep.html">GetInvocationStep</a> API operation.</p> <p>For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
|
|
7592
7056
|
* @public
|
|
7593
7057
|
*/
|
|
7594
7058
|
export type BedrockSessionContentBlock = BedrockSessionContentBlock.ImageMember | BedrockSessionContentBlock.TextMember | BedrockSessionContentBlock.$UnknownMember;
|
|
@@ -7710,16 +7174,12 @@ export interface ListInvocationStepsRequest {
|
|
|
7710
7174
|
*/
|
|
7711
7175
|
invocationIdentifier?: string | undefined;
|
|
7712
7176
|
/**
|
|
7713
|
-
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the
|
|
7714
|
-
* token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.
|
|
7715
|
-
* </p>
|
|
7177
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results. </p>
|
|
7716
7178
|
* @public
|
|
7717
7179
|
*/
|
|
7718
7180
|
nextToken?: string | undefined;
|
|
7719
7181
|
/**
|
|
7720
|
-
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value,
|
|
7721
|
-
* use the token returned in the response in the <code>nextToken</code> field when making another request to return the next
|
|
7722
|
-
* batch of results.</p>
|
|
7182
|
+
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
7723
7183
|
* @public
|
|
7724
7184
|
*/
|
|
7725
7185
|
maxResults?: number | undefined;
|
|
@@ -7815,82 +7275,16 @@ export interface PutInvocationStepResponse {
|
|
|
7815
7275
|
*/
|
|
7816
7276
|
export interface ListSessionsRequest {
|
|
7817
7277
|
/**
|
|
7818
|
-
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value,
|
|
7819
|
-
* use the token returned in the response in the <code>nextToken</code> field when making another request to return the next
|
|
7820
|
-
* batch of results.</p>
|
|
7278
|
+
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
7821
7279
|
* @public
|
|
7822
7280
|
*/
|
|
7823
7281
|
maxResults?: number | undefined;
|
|
7824
7282
|
/**
|
|
7825
|
-
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the
|
|
7826
|
-
* token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.
|
|
7827
|
-
* </p>
|
|
7828
|
-
* @public
|
|
7829
|
-
*/
|
|
7830
|
-
nextToken?: string | undefined;
|
|
7831
|
-
}
|
|
7832
|
-
/**
|
|
7833
|
-
* <p>Contains details about a session. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
|
|
7834
|
-
* @public
|
|
7835
|
-
*/
|
|
7836
|
-
export interface SessionSummary {
|
|
7837
|
-
/**
|
|
7838
|
-
* <p>The unique identifier for the session.</p>
|
|
7839
|
-
* @public
|
|
7840
|
-
*/
|
|
7841
|
-
sessionId: string | undefined;
|
|
7842
|
-
/**
|
|
7843
|
-
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
7844
|
-
* @public
|
|
7845
|
-
*/
|
|
7846
|
-
sessionArn: string | undefined;
|
|
7847
|
-
/**
|
|
7848
|
-
* <p>The current status of the session.</p>
|
|
7849
|
-
* @public
|
|
7850
|
-
*/
|
|
7851
|
-
sessionStatus: SessionStatus | undefined;
|
|
7852
|
-
/**
|
|
7853
|
-
* <p>The timestamp for when the session was created.</p>
|
|
7854
|
-
* @public
|
|
7855
|
-
*/
|
|
7856
|
-
createdAt: Date | undefined;
|
|
7857
|
-
/**
|
|
7858
|
-
* <p>The timestamp for when the session was last modified.</p>
|
|
7859
|
-
* @public
|
|
7860
|
-
*/
|
|
7861
|
-
lastUpdatedAt: Date | undefined;
|
|
7862
|
-
}
|
|
7863
|
-
/**
|
|
7864
|
-
* @public
|
|
7865
|
-
*/
|
|
7866
|
-
export interface ListSessionsResponse {
|
|
7867
|
-
/**
|
|
7868
|
-
* <p>A list of summaries for each session in your Amazon Web Services account.</p>
|
|
7869
|
-
* @public
|
|
7870
|
-
*/
|
|
7871
|
-
sessionSummaries: SessionSummary[] | undefined;
|
|
7872
|
-
/**
|
|
7873
|
-
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
7283
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results. </p>
|
|
7874
7284
|
* @public
|
|
7875
7285
|
*/
|
|
7876
7286
|
nextToken?: string | undefined;
|
|
7877
7287
|
}
|
|
7878
|
-
/**
|
|
7879
|
-
* @public
|
|
7880
|
-
*/
|
|
7881
|
-
export interface UpdateSessionRequest {
|
|
7882
|
-
/**
|
|
7883
|
-
* <p>A map of key-value pairs containing attributes to be persisted across the session. For example the user's ID, their language preference,
|
|
7884
|
-
* and the type of device they are using.</p>
|
|
7885
|
-
* @public
|
|
7886
|
-
*/
|
|
7887
|
-
sessionMetadata?: Record<string, string> | undefined;
|
|
7888
|
-
/**
|
|
7889
|
-
* <p>The unique identifier of the session to modify. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
|
|
7890
|
-
* @public
|
|
7891
|
-
*/
|
|
7892
|
-
sessionIdentifier: string | undefined;
|
|
7893
|
-
}
|
|
7894
7288
|
/**
|
|
7895
7289
|
* @internal
|
|
7896
7290
|
*/
|