@aws-sdk/client-bedrock-agent-runtime 3.758.0 → 3.765.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.
@@ -181,6 +181,9 @@ export interface ActionGroupInvocationOutput {
181
181
  export declare const ActionGroupSignature: {
182
182
  readonly AMAZON_CODEINTERPRETER: "AMAZON.CodeInterpreter";
183
183
  readonly AMAZON_USERINPUT: "AMAZON.UserInput";
184
+ readonly ANTHROPIC_BASH: "ANTHROPIC.Bash";
185
+ readonly ANTHROPIC_COMPUTER: "ANTHROPIC.Computer";
186
+ readonly ANTHROPIC_TEXTEDITOR: "ANTHROPIC.TextEditor";
184
187
  };
185
188
  /**
186
189
  * @public
@@ -418,14 +421,41 @@ export interface AgentActionGroup {
418
421
  */
419
422
  description?: string | undefined;
420
423
  /**
421
- * <p>
422
- * 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>.
423
- * You must leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields blank for this action group.
424
- * </p>
425
- * <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>. You must
426
- * leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields blank for this action group.</p>
427
- * <p>During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request,
428
- * it will invoke this action group instead and return an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html">Observation</a> reprompting the user for more information.</p>
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>
429
459
  * @public
430
460
  */
431
461
  parentActionGroupSignature?: ActionGroupSignature | undefined;
@@ -452,7 +482,30 @@ export interface AgentActionGroup {
452
482
  * @public
453
483
  */
454
484
  functionSchema?: FunctionSchema | undefined;
485
+ /**
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>
492
+ * @public
493
+ */
494
+ parentActionGroupSignatureParams?: Record<string, string> | undefined;
455
495
  }
496
+ /**
497
+ * @public
498
+ * @enum
499
+ */
500
+ export declare const AgentCollaboration: {
501
+ readonly DISABLED: "DISABLED";
502
+ readonly SUPERVISOR: "SUPERVISOR";
503
+ readonly SUPERVISOR_ROUTER: "SUPERVISOR_ROUTER";
504
+ };
505
+ /**
506
+ * @public
507
+ */
508
+ export type AgentCollaboration = (typeof AgentCollaboration)[keyof typeof AgentCollaboration];
456
509
  /**
457
510
  * @public
458
511
  * @enum
@@ -465,6 +518,67 @@ export declare const ConfirmationState: {
465
518
  * @public
466
519
  */
467
520
  export type ConfirmationState = (typeof ConfirmationState)[keyof typeof ConfirmationState];
521
+ /**
522
+ * @public
523
+ * @enum
524
+ */
525
+ export declare const ImageInputFormat: {
526
+ readonly GIF: "gif";
527
+ readonly JPEG: "jpeg";
528
+ readonly PNG: "png";
529
+ readonly WEBP: "webp";
530
+ };
531
+ /**
532
+ * @public
533
+ */
534
+ export type ImageInputFormat = (typeof ImageInputFormat)[keyof typeof ImageInputFormat];
535
+ /**
536
+ * <p>Details about the source of an input image in the result from a function in the action group invocation.</p>
537
+ * @public
538
+ */
539
+ export type ImageInputSource = ImageInputSource.BytesMember | ImageInputSource.$UnknownMember;
540
+ /**
541
+ * @public
542
+ */
543
+ export declare namespace ImageInputSource {
544
+ /**
545
+ * <p> The raw image bytes for the image. If you use an Amazon Web Services SDK, you don't need to encode the image bytes in base64.</p>
546
+ * @public
547
+ */
548
+ interface BytesMember {
549
+ bytes: Uint8Array;
550
+ $unknown?: never;
551
+ }
552
+ /**
553
+ * @public
554
+ */
555
+ interface $UnknownMember {
556
+ bytes?: never;
557
+ $unknown: [string, any];
558
+ }
559
+ interface Visitor<T> {
560
+ bytes: (value: Uint8Array) => T;
561
+ _: (name: string, value: any) => T;
562
+ }
563
+ const visit: <T>(value: ImageInputSource, visitor: Visitor<T>) => T;
564
+ }
565
+ /**
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>
568
+ * @public
569
+ */
570
+ export interface ImageInput {
571
+ /**
572
+ * <p>The type of image in the result.</p>
573
+ * @public
574
+ */
575
+ format: ImageInputFormat | undefined;
576
+ /**
577
+ * <p>The source of the image in the result.</p>
578
+ * @public
579
+ */
580
+ source: ImageInputSource | undefined;
581
+ }
468
582
  /**
469
583
  * <p>Contains the body of the API response.</p>
470
584
  * <p>This data type is used in the following API operations:</p>
@@ -482,6 +596,14 @@ export interface ContentBody {
482
596
  * @public
483
597
  */
484
598
  body?: string | undefined;
599
+ /**
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>
604
+ * @public
605
+ */
606
+ images?: ImageInput[] | undefined;
485
607
  }
486
608
  /**
487
609
  * @public
@@ -576,7 +698,10 @@ export interface FunctionResult {
576
698
  */
577
699
  function?: string | undefined;
578
700
  /**
579
- * <p>The response from the function call using the parameters. The key of the object is the content type (currently, only <code>TEXT</code> is supported). The response may be returned directly or from the Lambda function.</p>
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>
580
705
  * @public
581
706
  */
582
707
  responseBody?: Record<string, ContentBody> | undefined;
@@ -4534,6 +4659,13 @@ export interface TracePart {
4534
4659
  * @public
4535
4660
  */
4536
4661
  callerChain?: Caller[] | undefined;
4662
+ /**
4663
+ * <p>
4664
+ * The time of the trace.
4665
+ * </p>
4666
+ * @public
4667
+ */
4668
+ eventTime?: Date | undefined;
4537
4669
  /**
4538
4670
  * <p>The part's collaborator name.</p>
4539
4671
  * @public
@@ -4923,77 +5055,75 @@ export interface InlineBedrockModelConfigurations {
4923
5055
  */
4924
5056
  performanceConfig?: PerformanceConfiguration | undefined;
4925
5057
  }
5058
+ /**
5059
+ * @public
5060
+ * @enum
5061
+ */
5062
+ export declare const RelayConversationHistory: {
5063
+ readonly DISABLED: "DISABLED";
5064
+ readonly TO_COLLABORATOR: "TO_COLLABORATOR";
5065
+ };
5066
+ /**
5067
+ * @public
5068
+ */
5069
+ export type RelayConversationHistory = (typeof RelayConversationHistory)[keyof typeof RelayConversationHistory];
4926
5070
  /**
4927
5071
  * <p>
4928
- * The configuration details for the guardrail.
5072
+ * Settings of an inline collaborator agent.
4929
5073
  * </p>
4930
5074
  * @public
4931
5075
  */
4932
- export interface GuardrailConfigurationWithArn {
4933
- /**
4934
- * <p>
4935
- * The unique identifier for the guardrail.
4936
- * </p>
4937
- * @public
4938
- */
4939
- guardrailIdentifier: string | undefined;
5076
+ export interface CollaboratorConfiguration {
4940
5077
  /**
4941
5078
  * <p>
4942
- * The version of the guardrail.
5079
+ * Name of the inline collaborator agent which must be the same name as specified for <code>agentName</code>.
4943
5080
  * </p>
4944
5081
  * @public
4945
5082
  */
4946
- guardrailVersion: string | undefined;
4947
- }
4948
- /**
4949
- * <p>
4950
- * Contains parameters that specify various attributes that persist across a session or prompt. You can define session state
4951
- * 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.
4952
- * Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior.
4953
- * For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>
4954
- * </p>
4955
- * @public
4956
- */
4957
- export interface InlineSessionState {
5083
+ collaboratorName: string | undefined;
4958
5084
  /**
4959
5085
  * <p>
4960
- * Contains attributes that persist across a session and the values of those attributes.
5086
+ * Instructions that tell the inline collaborator agent what it should do and how it should interact with users.
4961
5087
  * </p>
4962
5088
  * @public
4963
5089
  */
4964
- sessionAttributes?: Record<string, string> | undefined;
5090
+ collaboratorInstruction: string | undefined;
4965
5091
  /**
4966
5092
  * <p>
4967
- * Contains attributes that persist across a session and the values of those attributes.
5093
+ * The Amazon Resource Name (ARN) of the inline collaborator agent.
4968
5094
  * </p>
4969
5095
  * @public
4970
5096
  */
4971
- promptSessionAttributes?: Record<string, string> | undefined;
5097
+ agentAliasArn?: string | undefined;
4972
5098
  /**
4973
5099
  * <p>
4974
- * 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>.
5100
+ * A relay conversation history for the inline collaborator agent.
4975
5101
  * </p>
4976
- * <note>
4977
- * <p>If you include this field in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
4978
- * </note>
4979
5102
  * @public
4980
5103
  */
4981
- returnControlInvocationResults?: InvocationResultMember[] | undefined;
5104
+ relayConversationHistory?: RelayConversationHistory | undefined;
5105
+ }
5106
+ /**
5107
+ * <p>
5108
+ * The configuration details for the guardrail.
5109
+ * </p>
5110
+ * @public
5111
+ */
5112
+ export interface GuardrailConfigurationWithArn {
4982
5113
  /**
4983
5114
  * <p>
4984
- * 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
4985
- * 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>.
5115
+ * The unique identifier for the guardrail.
4986
5116
  * </p>
4987
5117
  * @public
4988
5118
  */
4989
- invocationId?: string | undefined;
5119
+ guardrailIdentifier: string | undefined;
4990
5120
  /**
4991
5121
  * <p>
4992
- * Contains information about the files used by code interpreter.
5122
+ * The version of the guardrail.
4993
5123
  * </p>
4994
5124
  * @public
4995
5125
  */
4996
- files?: InputFile[] | undefined;
5126
+ guardrailVersion: string | undefined;
4997
5127
  }
4998
5128
  /**
4999
5129
  * @public
@@ -5068,6 +5198,13 @@ export interface PromptConfiguration {
5068
5198
  * @public
5069
5199
  */
5070
5200
  parserMode?: CreationMode | undefined;
5201
+ /**
5202
+ * <p>
5203
+ * The foundation model to use.
5204
+ * </p>
5205
+ * @public
5206
+ */
5207
+ foundationModel?: string | undefined;
5071
5208
  /**
5072
5209
  * <p>If the Converse or ConverseStream operations support the model,
5073
5210
  * <code>additionalModelRequestFields</code> contains additional inference parameters,
@@ -5099,6 +5236,63 @@ export interface PromptOverrideConfiguration {
5099
5236
  */
5100
5237
  overrideLambda?: string | undefined;
5101
5238
  }
5239
+ /**
5240
+ * <p>
5241
+ * Contains parameters that specify various attributes that persist across a session or prompt. You can define session state
5242
+ * 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.
5243
+ * Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior.
5244
+ * For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>
5245
+ * </p>
5246
+ * @public
5247
+ */
5248
+ export interface InlineSessionState {
5249
+ /**
5250
+ * <p>
5251
+ * Contains attributes that persist across a session and the values of those attributes.
5252
+ * </p>
5253
+ * @public
5254
+ */
5255
+ sessionAttributes?: Record<string, string> | undefined;
5256
+ /**
5257
+ * <p>
5258
+ * Contains attributes that persist across a session and the values of those attributes.
5259
+ * </p>
5260
+ * @public
5261
+ */
5262
+ promptSessionAttributes?: Record<string, string> | undefined;
5263
+ /**
5264
+ * <p>
5265
+ * 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>.
5266
+ * </p>
5267
+ * <note>
5268
+ * <p>If you include this field in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
5269
+ * </note>
5270
+ * @public
5271
+ */
5272
+ returnControlInvocationResults?: InvocationResultMember[] | undefined;
5273
+ /**
5274
+ * <p>
5275
+ * 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
5276
+ * 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>.
5277
+ * </p>
5278
+ * @public
5279
+ */
5280
+ invocationId?: string | undefined;
5281
+ /**
5282
+ * <p>
5283
+ * Contains information about the files used by code interpreter.
5284
+ * </p>
5285
+ * @public
5286
+ */
5287
+ files?: InputFile[] | undefined;
5288
+ /**
5289
+ * <p>
5290
+ * Contains the conversation history that persist across sessions.
5291
+ * </p>
5292
+ * @public
5293
+ */
5294
+ conversationHistory?: ConversationHistory | undefined;
5295
+ }
5102
5296
  /**
5103
5297
  * <p>Contains a part of an agent response and citations for it. </p>
5104
5298
  * @public
@@ -7664,66 +7858,6 @@ export interface UpdateSessionResponse {
7664
7858
  */
7665
7859
  lastUpdatedAt: Date | undefined;
7666
7860
  }
7667
- /**
7668
- * @public
7669
- */
7670
- export interface ListTagsForResourceRequest {
7671
- /**
7672
- * <p>The Amazon Resource Name (ARN) of the resource for which to list tags.</p>
7673
- * @public
7674
- */
7675
- resourceArn: string | undefined;
7676
- }
7677
- /**
7678
- * @public
7679
- */
7680
- export interface ListTagsForResourceResponse {
7681
- /**
7682
- * <p>The key-value pairs for the tags associated with the resource.</p>
7683
- * @public
7684
- */
7685
- tags?: Record<string, string> | undefined;
7686
- }
7687
- /**
7688
- * @public
7689
- */
7690
- export interface TagResourceRequest {
7691
- /**
7692
- * <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
7693
- * @public
7694
- */
7695
- resourceArn: string | undefined;
7696
- /**
7697
- * <p>An object containing key-value pairs that define the tags to attach to the resource.</p>
7698
- * @public
7699
- */
7700
- tags: Record<string, string> | undefined;
7701
- }
7702
- /**
7703
- * @public
7704
- */
7705
- export interface TagResourceResponse {
7706
- }
7707
- /**
7708
- * @public
7709
- */
7710
- export interface UntagResourceRequest {
7711
- /**
7712
- * <p>The Amazon Resource Name (ARN) of the resource from which to remove tags.</p>
7713
- * @public
7714
- */
7715
- resourceArn: string | undefined;
7716
- /**
7717
- * <p>A list of keys of the tags to remove from the resource.</p>
7718
- * @public
7719
- */
7720
- tagKeys: string[] | undefined;
7721
- }
7722
- /**
7723
- * @public
7724
- */
7725
- export interface UntagResourceResponse {
7726
- }
7727
7861
  /**
7728
7862
  * @internal
7729
7863
  */
@@ -8139,7 +8273,7 @@ export declare const InvokeAgentResponseFilterSensitiveLog: (obj: InvokeAgentRes
8139
8273
  /**
8140
8274
  * @internal
8141
8275
  */
8142
- export declare const InlineSessionStateFilterSensitiveLog: (obj: InlineSessionState) => any;
8276
+ export declare const CollaboratorConfigurationFilterSensitiveLog: (obj: CollaboratorConfiguration) => any;
8143
8277
  /**
8144
8278
  * @internal
8145
8279
  */
@@ -8148,6 +8282,10 @@ export declare const PromptConfigurationFilterSensitiveLog: (obj: PromptConfigur
8148
8282
  * @internal
8149
8283
  */
8150
8284
  export declare const PromptOverrideConfigurationFilterSensitiveLog: (obj: PromptOverrideConfiguration) => any;
8285
+ /**
8286
+ * @internal
8287
+ */
8288
+ export declare const InlineSessionStateFilterSensitiveLog: (obj: InlineSessionState) => any;
8151
8289
  /**
8152
8290
  * @internal
8153
8291
  */