@aws-sdk/client-bedrock-agent 3.840.0 → 3.845.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 +13 -1
- package/dist-es/models/models_1.js +10 -0
- package/dist-types/commands/CreateAgentActionGroupCommand.d.ts +1 -6
- package/dist-types/commands/CreateAgentCommand.d.ts +1 -32
- package/dist-types/commands/CreateDataSourceCommand.d.ts +1 -4
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +13 -34
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +6 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -4
- package/dist-types/commands/UpdateKnowledgeBaseCommand.d.ts +13 -22
- package/dist-types/models/models_0.d.ts +105 -660
- package/dist-types/models/models_1.d.ts +58 -231
- package/dist-types/ts3.4/models/models_1.d.ts +10 -0
- package/package.json +14 -14
|
@@ -164,35 +164,7 @@ export declare const Type: {
|
|
|
164
164
|
*/
|
|
165
165
|
export type Type = (typeof Type)[keyof typeof Type];
|
|
166
166
|
/**
|
|
167
|
-
* <p>Contains details about a parameter in a function for an action group.</p>
|
|
168
|
-
* <p>This data type is used in the following API operations:</p>
|
|
169
|
-
* <ul>
|
|
170
|
-
* <li>
|
|
171
|
-
* <p>
|
|
172
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax">CreateAgentActionGroup request</a>
|
|
173
|
-
* </p>
|
|
174
|
-
* </li>
|
|
175
|
-
* <li>
|
|
176
|
-
* <p>
|
|
177
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax">CreateAgentActionGroup response</a>
|
|
178
|
-
* </p>
|
|
179
|
-
* </li>
|
|
180
|
-
* <li>
|
|
181
|
-
* <p>
|
|
182
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax">UpdateAgentActionGroup request</a>
|
|
183
|
-
* </p>
|
|
184
|
-
* </li>
|
|
185
|
-
* <li>
|
|
186
|
-
* <p>
|
|
187
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax">UpdateAgentActionGroup response</a>
|
|
188
|
-
* </p>
|
|
189
|
-
* </li>
|
|
190
|
-
* <li>
|
|
191
|
-
* <p>
|
|
192
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax">GetAgentActionGroup response</a>
|
|
193
|
-
* </p>
|
|
194
|
-
* </li>
|
|
195
|
-
* </ul>
|
|
167
|
+
* <p>Contains details about a parameter in a function for an action group.</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_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax">CreateAgentActionGroup request</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax">CreateAgentActionGroup response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax">UpdateAgentActionGroup request</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax">UpdateAgentActionGroup response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax">GetAgentActionGroup response</a> </p> </li> </ul>
|
|
196
168
|
* @public
|
|
197
169
|
*/
|
|
198
170
|
export interface ParameterDetail {
|
|
@@ -225,35 +197,7 @@ export declare const RequireConfirmation: {
|
|
|
225
197
|
*/
|
|
226
198
|
export type RequireConfirmation = (typeof RequireConfirmation)[keyof typeof RequireConfirmation];
|
|
227
199
|
/**
|
|
228
|
-
* <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>
|
|
229
|
-
* <p>This data type is used in the following API operations:</p>
|
|
230
|
-
* <ul>
|
|
231
|
-
* <li>
|
|
232
|
-
* <p>
|
|
233
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax">CreateAgentActionGroup request</a>
|
|
234
|
-
* </p>
|
|
235
|
-
* </li>
|
|
236
|
-
* <li>
|
|
237
|
-
* <p>
|
|
238
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax">CreateAgentActionGroup response</a>
|
|
239
|
-
* </p>
|
|
240
|
-
* </li>
|
|
241
|
-
* <li>
|
|
242
|
-
* <p>
|
|
243
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax">UpdateAgentActionGroup request</a>
|
|
244
|
-
* </p>
|
|
245
|
-
* </li>
|
|
246
|
-
* <li>
|
|
247
|
-
* <p>
|
|
248
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax">UpdateAgentActionGroup response</a>
|
|
249
|
-
* </p>
|
|
250
|
-
* </li>
|
|
251
|
-
* <li>
|
|
252
|
-
* <p>
|
|
253
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax">GetAgentActionGroup response</a>
|
|
254
|
-
* </p>
|
|
255
|
-
* </li>
|
|
256
|
-
* </ul>
|
|
200
|
+
* <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> <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_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax">CreateAgentActionGroup request</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax">CreateAgentActionGroup response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax">UpdateAgentActionGroup request</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax">UpdateAgentActionGroup response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax">GetAgentActionGroup response</a> </p> </li> </ul>
|
|
257
201
|
* @public
|
|
258
202
|
*/
|
|
259
203
|
export interface Function {
|
|
@@ -279,35 +223,7 @@ export interface Function {
|
|
|
279
223
|
requireConfirmation?: RequireConfirmation | undefined;
|
|
280
224
|
}
|
|
281
225
|
/**
|
|
282
|
-
* <p>Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.</p>
|
|
283
|
-
* <p>This data type is used in the following API operations:</p>
|
|
284
|
-
* <ul>
|
|
285
|
-
* <li>
|
|
286
|
-
* <p>
|
|
287
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax">CreateAgentActionGroup request</a>
|
|
288
|
-
* </p>
|
|
289
|
-
* </li>
|
|
290
|
-
* <li>
|
|
291
|
-
* <p>
|
|
292
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax">CreateAgentActionGroup response</a>
|
|
293
|
-
* </p>
|
|
294
|
-
* </li>
|
|
295
|
-
* <li>
|
|
296
|
-
* <p>
|
|
297
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax">UpdateAgentActionGroup request</a>
|
|
298
|
-
* </p>
|
|
299
|
-
* </li>
|
|
300
|
-
* <li>
|
|
301
|
-
* <p>
|
|
302
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax">UpdateAgentActionGroup response</a>
|
|
303
|
-
* </p>
|
|
304
|
-
* </li>
|
|
305
|
-
* <li>
|
|
306
|
-
* <p>
|
|
307
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax">GetAgentActionGroup response</a>
|
|
308
|
-
* </p>
|
|
309
|
-
* </li>
|
|
310
|
-
* </ul>
|
|
226
|
+
* <p>Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.</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_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax">CreateAgentActionGroup request</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax">CreateAgentActionGroup response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax">UpdateAgentActionGroup request</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax">UpdateAgentActionGroup response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax">GetAgentActionGroup response</a> </p> </li> </ul>
|
|
311
227
|
* @public
|
|
312
228
|
*/
|
|
313
229
|
export type FunctionSchema = FunctionSchema.FunctionsMember | FunctionSchema.$UnknownMember;
|
|
@@ -371,8 +287,7 @@ export interface CreateAgentActionGroupRequest {
|
|
|
371
287
|
*/
|
|
372
288
|
actionGroupName: string | undefined;
|
|
373
289
|
/**
|
|
374
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
375
|
-
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
290
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
376
291
|
* @public
|
|
377
292
|
*/
|
|
378
293
|
clientToken?: string | undefined;
|
|
@@ -382,51 +297,12 @@ export interface CreateAgentActionGroupRequest {
|
|
|
382
297
|
*/
|
|
383
298
|
description?: string | undefined;
|
|
384
299
|
/**
|
|
385
|
-
* <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>
|
|
386
|
-
* <ul>
|
|
387
|
-
* <li>
|
|
388
|
-
* <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>
|
|
389
|
-
* </li>
|
|
390
|
-
* <li>
|
|
391
|
-
* <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>
|
|
392
|
-
* </li>
|
|
393
|
-
* <li>
|
|
394
|
-
* <p>To allow your agent to use an Anthropic computer use tool, specify one of the following values. </p>
|
|
395
|
-
* <important>
|
|
396
|
-
* <p>
|
|
397
|
-
* 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.
|
|
398
|
-
* When operating computer use functionality, we recommend taking additional security precautions,
|
|
399
|
-
* such as executing computer actions in virtual environments with restricted data access and limited internet connectivity.
|
|
400
|
-
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.
|
|
401
|
-
* </p>
|
|
402
|
-
* </important>
|
|
403
|
-
* <ul>
|
|
404
|
-
* <li>
|
|
405
|
-
* <p>
|
|
406
|
-
* <code>ANTHROPIC.Computer</code> - Gives the agent permission to use the mouse and keyboard and
|
|
407
|
-
* take screenshots.</p>
|
|
408
|
-
* </li>
|
|
409
|
-
* <li>
|
|
410
|
-
* <p>
|
|
411
|
-
* <code>ANTHROPIC.TextEditor</code> - Gives the agent permission to view, create and edit files.</p>
|
|
412
|
-
* </li>
|
|
413
|
-
* <li>
|
|
414
|
-
* <p>
|
|
415
|
-
* <code>ANTHROPIC.Bash</code> - Gives the agent permission to run commands in a bash shell.</p>
|
|
416
|
-
* </li>
|
|
417
|
-
* </ul>
|
|
418
|
-
* </li>
|
|
419
|
-
* </ul>
|
|
300
|
+
* <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/agents-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>
|
|
420
301
|
* @public
|
|
421
302
|
*/
|
|
422
303
|
parentActionGroupSignature?: ActionGroupSignature | undefined;
|
|
423
304
|
/**
|
|
424
|
-
* <p>The configuration settings for a computer use action.</p>
|
|
425
|
-
* <important>
|
|
426
|
-
* <p>
|
|
427
|
-
* 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. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.
|
|
428
|
-
* </p>
|
|
429
|
-
* </important>
|
|
305
|
+
* <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 Anthropic 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/agents-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>. </p> </important>
|
|
430
306
|
* @public
|
|
431
307
|
*/
|
|
432
308
|
parentActionGroupSignatureParams?: Record<string, string> | undefined;
|
|
@@ -477,8 +353,7 @@ export interface AgentActionGroup {
|
|
|
477
353
|
*/
|
|
478
354
|
actionGroupName: string | undefined;
|
|
479
355
|
/**
|
|
480
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
481
|
-
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
356
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
482
357
|
* @public
|
|
483
358
|
*/
|
|
484
359
|
clientToken?: string | undefined;
|
|
@@ -498,18 +373,12 @@ export interface AgentActionGroup {
|
|
|
498
373
|
*/
|
|
499
374
|
updatedAt: Date | undefined;
|
|
500
375
|
/**
|
|
501
|
-
* <p>If this field is set as <code>AMAZON.UserInput</code>, the agent can request the user for additional information when trying to complete a task. The <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields must be blank for this action group.</p>
|
|
502
|
-
* <p>During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, 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>
|
|
376
|
+
* <p>If this field is set as <code>AMAZON.UserInput</code>, the agent can request the user for additional information when trying to complete a task. The <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields must be blank for this action group.</p> <p>During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, 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>
|
|
503
377
|
* @public
|
|
504
378
|
*/
|
|
505
379
|
parentActionSignature?: ActionGroupSignature | undefined;
|
|
506
380
|
/**
|
|
507
|
-
* <p>The configuration settings for a computer use action.</p>
|
|
508
|
-
* <important>
|
|
509
|
-
* <p>
|
|
510
|
-
* 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/agents-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.
|
|
511
|
-
* </p>
|
|
512
|
-
* </important>
|
|
381
|
+
* <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/agents-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>. </p> </important>
|
|
513
382
|
* @public
|
|
514
383
|
*/
|
|
515
384
|
parentActionGroupSignatureParams?: Record<string, string> | undefined;
|
|
@@ -726,9 +595,7 @@ export interface ActionGroupSummary {
|
|
|
726
595
|
*/
|
|
727
596
|
actionGroupName: string | undefined;
|
|
728
597
|
/**
|
|
729
|
-
* <p>Specifies whether the action group is available for the agent to invoke or not when
|
|
730
|
-
* sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a>
|
|
731
|
-
* request.</p>
|
|
598
|
+
* <p>Specifies whether the action group is available for the agent to invoke or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
|
|
732
599
|
* @public
|
|
733
600
|
*/
|
|
734
601
|
actionGroupState: ActionGroupState | undefined;
|
|
@@ -788,52 +655,12 @@ export interface UpdateAgentActionGroupRequest {
|
|
|
788
655
|
*/
|
|
789
656
|
description?: string | undefined;
|
|
790
657
|
/**
|
|
791
|
-
* <p>Update the 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>
|
|
792
|
-
* <ul>
|
|
793
|
-
* <li>
|
|
794
|
-
* <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>
|
|
795
|
-
* </li>
|
|
796
|
-
* <li>
|
|
797
|
-
* <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>
|
|
798
|
-
* </li>
|
|
799
|
-
* <li>
|
|
800
|
-
* <p>To allow your agent to use an Anthropic computer use tool, specify one of the following values. </p>
|
|
801
|
-
* <important>
|
|
802
|
-
* <p>
|
|
803
|
-
* 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.
|
|
804
|
-
* When operating computer use functionality, we recommend taking additional security precautions,
|
|
805
|
-
* such as executing computer actions in virtual environments with restricted data access and limited internet connectivity.
|
|
806
|
-
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.
|
|
807
|
-
* </p>
|
|
808
|
-
* </important>
|
|
809
|
-
* <ul>
|
|
810
|
-
* <li>
|
|
811
|
-
* <p>
|
|
812
|
-
* <code>ANTHROPIC.Computer</code> - Gives the agent permission to use the mouse and keyboard and
|
|
813
|
-
* take screenshots.</p>
|
|
814
|
-
* </li>
|
|
815
|
-
* <li>
|
|
816
|
-
* <p>
|
|
817
|
-
* <code>ANTHROPIC.TextEditor</code> - Gives the agent permission to view, create and edit files.</p>
|
|
818
|
-
* </li>
|
|
819
|
-
* <li>
|
|
820
|
-
* <p>
|
|
821
|
-
* <code>ANTHROPIC.Bash</code> - Gives the agent permission to run commands in a bash shell.</p>
|
|
822
|
-
* </li>
|
|
823
|
-
* </ul>
|
|
824
|
-
* </li>
|
|
825
|
-
* </ul>
|
|
826
|
-
* <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, 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>
|
|
658
|
+
* <p>Update the 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/agents-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> <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, 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>
|
|
827
659
|
* @public
|
|
828
660
|
*/
|
|
829
661
|
parentActionGroupSignature?: ActionGroupSignature | undefined;
|
|
830
662
|
/**
|
|
831
|
-
* <p>The configuration settings for a computer use action.</p>
|
|
832
|
-
* <important>
|
|
833
|
-
* <p>
|
|
834
|
-
* 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/agents-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.
|
|
835
|
-
* </p>
|
|
836
|
-
* </important>
|
|
663
|
+
* <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/agents-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>. </p> </important>
|
|
837
664
|
* @public
|
|
838
665
|
*/
|
|
839
666
|
parentActionGroupSignatureParams?: Record<string, string> | undefined;
|
|
@@ -900,9 +727,7 @@ export declare const AgentStatus: {
|
|
|
900
727
|
*/
|
|
901
728
|
export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus];
|
|
902
729
|
/**
|
|
903
|
-
* <p>
|
|
904
|
-
* Contains details about the Lambda function containing the orchestration logic carried out upon invoking the custom orchestration.
|
|
905
|
-
* </p>
|
|
730
|
+
* <p> Contains details about the Lambda function containing the orchestration logic carried out upon invoking the custom orchestration. </p>
|
|
906
731
|
* @public
|
|
907
732
|
*/
|
|
908
733
|
export type OrchestrationExecutor = OrchestrationExecutor.LambdaMember | OrchestrationExecutor.$UnknownMember;
|
|
@@ -911,9 +736,7 @@ export type OrchestrationExecutor = OrchestrationExecutor.LambdaMember | Orchest
|
|
|
911
736
|
*/
|
|
912
737
|
export declare namespace OrchestrationExecutor {
|
|
913
738
|
/**
|
|
914
|
-
* <p>
|
|
915
|
-
* The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
|
|
916
|
-
* </p>
|
|
739
|
+
* <p> The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action. </p>
|
|
917
740
|
* @public
|
|
918
741
|
*/
|
|
919
742
|
interface LambdaMember {
|
|
@@ -934,16 +757,12 @@ export declare namespace OrchestrationExecutor {
|
|
|
934
757
|
const visit: <T>(value: OrchestrationExecutor, visitor: Visitor<T>) => T;
|
|
935
758
|
}
|
|
936
759
|
/**
|
|
937
|
-
* <p>
|
|
938
|
-
* Details of custom orchestration.
|
|
939
|
-
* </p>
|
|
760
|
+
* <p> Details of custom orchestration. </p>
|
|
940
761
|
* @public
|
|
941
762
|
*/
|
|
942
763
|
export interface CustomOrchestration {
|
|
943
764
|
/**
|
|
944
|
-
* <p>
|
|
945
|
-
* The structure of the executor invoking the actions in custom orchestration.
|
|
946
|
-
* </p>
|
|
765
|
+
* <p> The structure of the executor invoking the actions in custom orchestration. </p>
|
|
947
766
|
* @public
|
|
948
767
|
*/
|
|
949
768
|
executor?: OrchestrationExecutor | undefined;
|
|
@@ -1105,29 +924,7 @@ export interface PromptConfiguration {
|
|
|
1105
924
|
*/
|
|
1106
925
|
promptCreationMode?: CreationMode | undefined;
|
|
1107
926
|
/**
|
|
1108
|
-
* <p>Specifies whether to allow the 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>
|
|
1109
|
-
* <ul>
|
|
1110
|
-
* <li>
|
|
1111
|
-
* <p>
|
|
1112
|
-
* <code>PRE_PROCESSING</code> – <code>DISABLED</code>
|
|
1113
|
-
* </p>
|
|
1114
|
-
* </li>
|
|
1115
|
-
* <li>
|
|
1116
|
-
* <p>
|
|
1117
|
-
* <code>ORCHESTRATION</code> – <code>ENABLED</code>
|
|
1118
|
-
* </p>
|
|
1119
|
-
* </li>
|
|
1120
|
-
* <li>
|
|
1121
|
-
* <p>
|
|
1122
|
-
* <code>KNOWLEDGE_BASE_RESPONSE_GENERATION</code> – <code>ENABLED</code>
|
|
1123
|
-
* </p>
|
|
1124
|
-
* </li>
|
|
1125
|
-
* <li>
|
|
1126
|
-
* <p>
|
|
1127
|
-
* <code>POST_PROCESSING</code> – <code>DISABLED</code>
|
|
1128
|
-
* </p>
|
|
1129
|
-
* </li>
|
|
1130
|
-
* </ul>
|
|
927
|
+
* <p>Specifies whether to allow the 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>DISABLED</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>
|
|
1131
928
|
* @public
|
|
1132
929
|
*/
|
|
1133
930
|
promptState?: PromptState | undefined;
|
|
@@ -1152,13 +949,7 @@ export interface PromptConfiguration {
|
|
|
1152
949
|
*/
|
|
1153
950
|
foundationModel?: string | undefined;
|
|
1154
951
|
/**
|
|
1155
|
-
* <p>If the Converse or ConverseStream operations support the model,
|
|
1156
|
-
* <code>additionalModelRequestFields</code> contains additional inference parameters,
|
|
1157
|
-
* beyond the base set of inference parameters in the <code>inferenceConfiguration</code>
|
|
1158
|
-
* field. </p>
|
|
1159
|
-
* <p>For more information, see <i>Inference request parameters and
|
|
1160
|
-
* response fields for foundation models</i> in the Amazon Bedrock user
|
|
1161
|
-
* guide.</p>
|
|
952
|
+
* <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>
|
|
1162
953
|
* @public
|
|
1163
954
|
*/
|
|
1164
955
|
additionalModelRequestFields?: __DocumentType | undefined;
|
|
@@ -1205,8 +996,7 @@ export interface Agent {
|
|
|
1205
996
|
*/
|
|
1206
997
|
agentVersion: string | undefined;
|
|
1207
998
|
/**
|
|
1208
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
1209
|
-
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
999
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
1210
1000
|
* @public
|
|
1211
1001
|
*/
|
|
1212
1002
|
clientToken?: string | undefined;
|
|
@@ -1216,30 +1006,7 @@ export interface Agent {
|
|
|
1216
1006
|
*/
|
|
1217
1007
|
instruction?: string | undefined;
|
|
1218
1008
|
/**
|
|
1219
|
-
* <p>The status of the agent and whether it is ready for use. The following statuses are possible:</p>
|
|
1220
|
-
* <ul>
|
|
1221
|
-
* <li>
|
|
1222
|
-
* <p>CREATING – The agent is being created.</p>
|
|
1223
|
-
* </li>
|
|
1224
|
-
* <li>
|
|
1225
|
-
* <p>PREPARING – The agent is being prepared.</p>
|
|
1226
|
-
* </li>
|
|
1227
|
-
* <li>
|
|
1228
|
-
* <p>PREPARED – The agent is prepared and ready to be invoked.</p>
|
|
1229
|
-
* </li>
|
|
1230
|
-
* <li>
|
|
1231
|
-
* <p>NOT_PREPARED – The agent has been created but not yet prepared.</p>
|
|
1232
|
-
* </li>
|
|
1233
|
-
* <li>
|
|
1234
|
-
* <p>FAILED – The agent API operation failed.</p>
|
|
1235
|
-
* </li>
|
|
1236
|
-
* <li>
|
|
1237
|
-
* <p>UPDATING – The agent is being updated.</p>
|
|
1238
|
-
* </li>
|
|
1239
|
-
* <li>
|
|
1240
|
-
* <p>DELETING – The agent is being deleted.</p>
|
|
1241
|
-
* </li>
|
|
1242
|
-
* </ul>
|
|
1009
|
+
* <p>The status of the agent and whether it is ready for use. The following statuses are possible:</p> <ul> <li> <p>CREATING – The agent is being created.</p> </li> <li> <p>PREPARING – The agent is being prepared.</p> </li> <li> <p>PREPARED – The agent is prepared and ready to be invoked.</p> </li> <li> <p>NOT_PREPARED – The agent has been created but not yet prepared.</p> </li> <li> <p>FAILED – The agent API operation failed.</p> </li> <li> <p>UPDATING – The agent is being updated.</p> </li> <li> <p>DELETING – The agent is being deleted.</p> </li> </ul>
|
|
1243
1010
|
* @public
|
|
1244
1011
|
*/
|
|
1245
1012
|
agentStatus: AgentStatus | undefined;
|
|
@@ -1254,22 +1021,17 @@ export interface Agent {
|
|
|
1254
1021
|
*/
|
|
1255
1022
|
description?: string | undefined;
|
|
1256
1023
|
/**
|
|
1257
|
-
* <p>
|
|
1258
|
-
* Specifies the orchestration strategy for the agent.
|
|
1259
|
-
* </p>
|
|
1024
|
+
* <p> Specifies the orchestration strategy for the agent. </p>
|
|
1260
1025
|
* @public
|
|
1261
1026
|
*/
|
|
1262
1027
|
orchestrationType?: OrchestrationType | undefined;
|
|
1263
1028
|
/**
|
|
1264
|
-
* <p>
|
|
1265
|
-
* Contains custom orchestration configurations for the agent.
|
|
1266
|
-
* </p>
|
|
1029
|
+
* <p> Contains custom orchestration configurations for the agent. </p>
|
|
1267
1030
|
* @public
|
|
1268
1031
|
*/
|
|
1269
1032
|
customOrchestration?: CustomOrchestration | undefined;
|
|
1270
1033
|
/**
|
|
1271
|
-
* <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
|
|
1272
|
-
* <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
|
|
1034
|
+
* <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p> <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
|
|
1273
1035
|
* @public
|
|
1274
1036
|
*/
|
|
1275
1037
|
idleSessionTTLInSeconds: number | undefined;
|
|
@@ -1426,8 +1188,7 @@ export interface AgentAlias {
|
|
|
1426
1188
|
*/
|
|
1427
1189
|
agentAliasArn: string | undefined;
|
|
1428
1190
|
/**
|
|
1429
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
1430
|
-
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
1191
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
1431
1192
|
* @public
|
|
1432
1193
|
*/
|
|
1433
1194
|
clientToken?: string | undefined;
|
|
@@ -1457,27 +1218,7 @@ export interface AgentAlias {
|
|
|
1457
1218
|
*/
|
|
1458
1219
|
agentAliasHistoryEvents?: AgentAliasHistoryEvent[] | undefined;
|
|
1459
1220
|
/**
|
|
1460
|
-
* <p>The status of the alias of the agent and whether it is ready for use. The following statuses are possible:</p>
|
|
1461
|
-
* <ul>
|
|
1462
|
-
* <li>
|
|
1463
|
-
* <p>CREATING – The agent alias is being created.</p>
|
|
1464
|
-
* </li>
|
|
1465
|
-
* <li>
|
|
1466
|
-
* <p>PREPARED – The agent alias is finished being created or updated and is ready to be invoked.</p>
|
|
1467
|
-
* </li>
|
|
1468
|
-
* <li>
|
|
1469
|
-
* <p>FAILED – The agent alias API operation failed.</p>
|
|
1470
|
-
* </li>
|
|
1471
|
-
* <li>
|
|
1472
|
-
* <p>UPDATING – The agent alias is being updated.</p>
|
|
1473
|
-
* </li>
|
|
1474
|
-
* <li>
|
|
1475
|
-
* <p>DELETING – The agent alias is being deleted.</p>
|
|
1476
|
-
* </li>
|
|
1477
|
-
* <li>
|
|
1478
|
-
* <p>DISSOCIATED - The agent alias has no version associated with it.</p>
|
|
1479
|
-
* </li>
|
|
1480
|
-
* </ul>
|
|
1221
|
+
* <p>The status of the alias of the agent and whether it is ready for use. The following statuses are possible:</p> <ul> <li> <p>CREATING – The agent alias is being created.</p> </li> <li> <p>PREPARED – The agent alias is finished being created or updated and is ready to be invoked.</p> </li> <li> <p>FAILED – The agent alias API operation failed.</p> </li> <li> <p>UPDATING – The agent alias is being updated.</p> </li> <li> <p>DELETING – The agent alias is being deleted.</p> </li> <li> <p>DISSOCIATED - The agent alias has no version associated with it.</p> </li> </ul>
|
|
1481
1222
|
* @public
|
|
1482
1223
|
*/
|
|
1483
1224
|
agentAliasStatus: AgentAliasStatus | undefined;
|
|
@@ -1487,10 +1228,7 @@ export interface AgentAlias {
|
|
|
1487
1228
|
*/
|
|
1488
1229
|
failureReasons?: string[] | undefined;
|
|
1489
1230
|
/**
|
|
1490
|
-
* <p>The invocation state for the agent alias. If the agent alias is running,
|
|
1491
|
-
* the value is <code>ACCEPT_INVOCATIONS</code>. If the agent alias is paused,
|
|
1492
|
-
* the value is <code>REJECT_INVOCATIONS</code>. Use the <code>UpdateAgentAlias</code> operation
|
|
1493
|
-
* to change the invocation state.</p>
|
|
1231
|
+
* <p>The invocation state for the agent alias. If the agent alias is running, the value is <code>ACCEPT_INVOCATIONS</code>. If the agent alias is paused, the value is <code>REJECT_INVOCATIONS</code>. Use the <code>UpdateAgentAlias</code> operation to change the invocation state.</p>
|
|
1494
1232
|
* @public
|
|
1495
1233
|
*/
|
|
1496
1234
|
aliasInvocationState?: AliasInvocationState | undefined;
|
|
@@ -1536,10 +1274,7 @@ export interface AgentAliasSummary {
|
|
|
1536
1274
|
*/
|
|
1537
1275
|
updatedAt: Date | undefined;
|
|
1538
1276
|
/**
|
|
1539
|
-
* <p>The invocation state for the agent alias. If the agent alias is running,
|
|
1540
|
-
* the value is <code>ACCEPT_INVOCATIONS</code>. If the agent alias is paused,
|
|
1541
|
-
* the value is <code>REJECT_INVOCATIONS</code>. Use the <code>UpdateAgentAlias</code> operation
|
|
1542
|
-
* to change the invocation state.</p>
|
|
1277
|
+
* <p>The invocation state for the agent alias. If the agent alias is running, the value is <code>ACCEPT_INVOCATIONS</code>. If the agent alias is paused, the value is <code>REJECT_INVOCATIONS</code>. Use the <code>UpdateAgentAlias</code> operation to change the invocation state.</p>
|
|
1543
1278
|
* @public
|
|
1544
1279
|
*/
|
|
1545
1280
|
aliasInvocationState?: AliasInvocationState | undefined;
|
|
@@ -1969,8 +1704,7 @@ export interface CreateAgentRequest {
|
|
|
1969
1704
|
*/
|
|
1970
1705
|
agentName: string | undefined;
|
|
1971
1706
|
/**
|
|
1972
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
1973
|
-
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
1707
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
1974
1708
|
* @public
|
|
1975
1709
|
*/
|
|
1976
1710
|
clientToken?: string | undefined;
|
|
@@ -1980,25 +1714,7 @@ export interface CreateAgentRequest {
|
|
|
1980
1714
|
*/
|
|
1981
1715
|
instruction?: string | undefined;
|
|
1982
1716
|
/**
|
|
1983
|
-
* <p>The identifier for the model that you want to be used for orchestration by the agent you create.</p>
|
|
1984
|
-
* <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
|
|
1985
|
-
* <ul>
|
|
1986
|
-
* <li>
|
|
1987
|
-
* <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p>
|
|
1988
|
-
* </li>
|
|
1989
|
-
* <li>
|
|
1990
|
-
* <p>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</p>
|
|
1991
|
-
* </li>
|
|
1992
|
-
* <li>
|
|
1993
|
-
* <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
|
|
1994
|
-
* </li>
|
|
1995
|
-
* <li>
|
|
1996
|
-
* <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
|
|
1997
|
-
* </li>
|
|
1998
|
-
* <li>
|
|
1999
|
-
* <p>If you use an <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported model</a>, specify the ARN of the imported model. You can get the model ARN from a successful call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a> or from the Imported models page in the Amazon Bedrock console.</p>
|
|
2000
|
-
* </li>
|
|
2001
|
-
* </ul>
|
|
1717
|
+
* <p>The identifier for the model that you want to be used for orchestration by the agent you create.</p> <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p> <ul> <li> <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p> </li> <li> <p>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</p> </li> <li> <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p> </li> <li> <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p> </li> <li> <p>If you use an <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported model</a>, specify the ARN of the imported model. You can get the model ARN from a successful call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a> or from the Imported models page in the Amazon Bedrock console.</p> </li> </ul>
|
|
2002
1718
|
* @public
|
|
2003
1719
|
*/
|
|
2004
1720
|
foundationModel?: string | undefined;
|
|
@@ -2008,22 +1724,17 @@ export interface CreateAgentRequest {
|
|
|
2008
1724
|
*/
|
|
2009
1725
|
description?: string | undefined;
|
|
2010
1726
|
/**
|
|
2011
|
-
* <p>
|
|
2012
|
-
* Specifies the type of orchestration strategy for the agent. This is set to <code>DEFAULT</code> orchestration type, by default.
|
|
2013
|
-
* </p>
|
|
1727
|
+
* <p> Specifies the type of orchestration strategy for the agent. This is set to <code>DEFAULT</code> orchestration type, by default. </p>
|
|
2014
1728
|
* @public
|
|
2015
1729
|
*/
|
|
2016
1730
|
orchestrationType?: OrchestrationType | undefined;
|
|
2017
1731
|
/**
|
|
2018
|
-
* <p>
|
|
2019
|
-
* Contains details of the custom orchestration configured for the agent.
|
|
2020
|
-
* </p>
|
|
1732
|
+
* <p> Contains details of the custom orchestration configured for the agent. </p>
|
|
2021
1733
|
* @public
|
|
2022
1734
|
*/
|
|
2023
1735
|
customOrchestration?: CustomOrchestration | undefined;
|
|
2024
1736
|
/**
|
|
2025
|
-
* <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
|
|
2026
|
-
* <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
|
|
1737
|
+
* <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p> <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
|
|
2027
1738
|
* @public
|
|
2028
1739
|
*/
|
|
2029
1740
|
idleSessionTTLInSeconds?: number | undefined;
|
|
@@ -2249,25 +1960,7 @@ export interface UpdateAgentRequest {
|
|
|
2249
1960
|
*/
|
|
2250
1961
|
instruction?: string | undefined;
|
|
2251
1962
|
/**
|
|
2252
|
-
* <p>The identifier for the model that you want to be used for orchestration by the agent you create.</p>
|
|
2253
|
-
* <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
|
|
2254
|
-
* <ul>
|
|
2255
|
-
* <li>
|
|
2256
|
-
* <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p>
|
|
2257
|
-
* </li>
|
|
2258
|
-
* <li>
|
|
2259
|
-
* <p>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</p>
|
|
2260
|
-
* </li>
|
|
2261
|
-
* <li>
|
|
2262
|
-
* <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
|
|
2263
|
-
* </li>
|
|
2264
|
-
* <li>
|
|
2265
|
-
* <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
|
|
2266
|
-
* </li>
|
|
2267
|
-
* <li>
|
|
2268
|
-
* <p>If you use an <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported model</a>, specify the ARN of the imported model. You can get the model ARN from a successful call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a> or from the Imported models page in the Amazon Bedrock console.</p>
|
|
2269
|
-
* </li>
|
|
2270
|
-
* </ul>
|
|
1963
|
+
* <p>The identifier for the model that you want to be used for orchestration by the agent you create.</p> <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p> <ul> <li> <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p> </li> <li> <p>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</p> </li> <li> <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p> </li> <li> <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p> </li> <li> <p>If you use an <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported model</a>, specify the ARN of the imported model. You can get the model ARN from a successful call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a> or from the Imported models page in the Amazon Bedrock console.</p> </li> </ul>
|
|
2271
1964
|
* @public
|
|
2272
1965
|
*/
|
|
2273
1966
|
foundationModel: string | undefined;
|
|
@@ -2277,22 +1970,17 @@ export interface UpdateAgentRequest {
|
|
|
2277
1970
|
*/
|
|
2278
1971
|
description?: string | undefined;
|
|
2279
1972
|
/**
|
|
2280
|
-
* <p>
|
|
2281
|
-
* Specifies the type of orchestration strategy for the agent. This is set to <code>DEFAULT</code> orchestration type, by default.
|
|
2282
|
-
* </p>
|
|
1973
|
+
* <p> Specifies the type of orchestration strategy for the agent. This is set to <code>DEFAULT</code> orchestration type, by default. </p>
|
|
2283
1974
|
* @public
|
|
2284
1975
|
*/
|
|
2285
1976
|
orchestrationType?: OrchestrationType | undefined;
|
|
2286
1977
|
/**
|
|
2287
|
-
* <p>
|
|
2288
|
-
* Contains details of the custom orchestration configured for the agent.
|
|
2289
|
-
* </p>
|
|
1978
|
+
* <p> Contains details of the custom orchestration configured for the agent. </p>
|
|
2290
1979
|
* @public
|
|
2291
1980
|
*/
|
|
2292
1981
|
customOrchestration?: CustomOrchestration | undefined;
|
|
2293
1982
|
/**
|
|
2294
|
-
* <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
|
|
2295
|
-
* <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
|
|
1983
|
+
* <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p> <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
|
|
2296
1984
|
* @public
|
|
2297
1985
|
*/
|
|
2298
1986
|
idleSessionTTLInSeconds?: number | undefined;
|
|
@@ -2383,8 +2071,7 @@ export interface AgentVersion {
|
|
|
2383
2071
|
*/
|
|
2384
2072
|
description?: string | undefined;
|
|
2385
2073
|
/**
|
|
2386
|
-
* <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
|
|
2387
|
-
* <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
|
|
2074
|
+
* <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p> <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
|
|
2388
2075
|
* @public
|
|
2389
2076
|
*/
|
|
2390
2077
|
idleSessionTTLInSeconds: number | undefined;
|
|
@@ -2429,9 +2116,7 @@ export interface AgentVersion {
|
|
|
2429
2116
|
*/
|
|
2430
2117
|
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
2431
2118
|
/**
|
|
2432
|
-
* <p>
|
|
2433
|
-
* Contains details of the memory configuration on the version of the agent.
|
|
2434
|
-
* </p>
|
|
2119
|
+
* <p> Contains details of the memory configuration on the version of the agent. </p>
|
|
2435
2120
|
* @public
|
|
2436
2121
|
*/
|
|
2437
2122
|
memoryConfiguration?: MemoryConfiguration | undefined;
|
|
@@ -2497,8 +2182,7 @@ export interface CreateAgentAliasRequest {
|
|
|
2497
2182
|
*/
|
|
2498
2183
|
agentAliasName: string | undefined;
|
|
2499
2184
|
/**
|
|
2500
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
2501
|
-
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
2185
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
2502
2186
|
* @public
|
|
2503
2187
|
*/
|
|
2504
2188
|
clientToken?: string | undefined;
|
|
@@ -2653,11 +2337,7 @@ export interface UpdateAgentAliasRequest {
|
|
|
2653
2337
|
*/
|
|
2654
2338
|
routingConfiguration?: AgentAliasRoutingConfigurationListItem[] | undefined;
|
|
2655
2339
|
/**
|
|
2656
|
-
* <p>The invocation state for the agent alias. To pause the agent alias, set the value to
|
|
2657
|
-
* <code>REJECT_INVOCATIONS</code>. To start the agent alias running again, set the value to
|
|
2658
|
-
* <code>ACCEPT_INVOCATIONS</code>. Use the <code>GetAgentAlias</code>, or
|
|
2659
|
-
* <code>ListAgentAliases</code>, operation to get the invocation state of an agent
|
|
2660
|
-
* alias.</p>
|
|
2340
|
+
* <p>The invocation state for the agent alias. To pause the agent alias, set the value to <code>REJECT_INVOCATIONS</code>. To start the agent alias running again, set the value to <code>ACCEPT_INVOCATIONS</code>. Use the <code>GetAgentAlias</code>, or <code>ListAgentAliases</code>, operation to get the invocation state of an agent alias.</p>
|
|
2661
2341
|
* @public
|
|
2662
2342
|
*/
|
|
2663
2343
|
aliasInvocationState?: AliasInvocationState | undefined;
|
|
@@ -2685,8 +2365,7 @@ export declare const DataDeletionPolicy: {
|
|
|
2685
2365
|
*/
|
|
2686
2366
|
export type DataDeletionPolicy = (typeof DataDeletionPolicy)[keyof typeof DataDeletionPolicy];
|
|
2687
2367
|
/**
|
|
2688
|
-
* <p>The specific filters applied to your data source content. You can filter out or
|
|
2689
|
-
* include certain content.</p>
|
|
2368
|
+
* <p>The specific filters applied to your data source content. You can filter out or include certain content.</p>
|
|
2690
2369
|
* @public
|
|
2691
2370
|
*/
|
|
2692
2371
|
export interface PatternObjectFilter {
|
|
@@ -2696,18 +2375,12 @@ export interface PatternObjectFilter {
|
|
|
2696
2375
|
*/
|
|
2697
2376
|
objectType: string | undefined;
|
|
2698
2377
|
/**
|
|
2699
|
-
* <p>A list of one or more inclusion regular expression patterns to include certain
|
|
2700
|
-
* object types that adhere to the pattern. If you specify an inclusion and exclusion
|
|
2701
|
-
* filter/pattern and both match a document, the exclusion filter takes precedence
|
|
2702
|
-
* and the document isn’t crawled.</p>
|
|
2378
|
+
* <p>A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.</p>
|
|
2703
2379
|
* @public
|
|
2704
2380
|
*/
|
|
2705
2381
|
inclusionFilters?: string[] | undefined;
|
|
2706
2382
|
/**
|
|
2707
|
-
* <p>A list of one or more exclusion regular expression patterns to exclude certain
|
|
2708
|
-
* object types that adhere to the pattern. If you specify an inclusion and exclusion
|
|
2709
|
-
* filter/pattern and both match a document, the exclusion filter takes precedence
|
|
2710
|
-
* and the document isn’t crawled.</p>
|
|
2383
|
+
* <p>A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.</p>
|
|
2711
2384
|
* @public
|
|
2712
2385
|
*/
|
|
2713
2386
|
exclusionFilters?: string[] | undefined;
|
|
@@ -2718,8 +2391,7 @@ export interface PatternObjectFilter {
|
|
|
2718
2391
|
*/
|
|
2719
2392
|
export interface PatternObjectFilterConfiguration {
|
|
2720
2393
|
/**
|
|
2721
|
-
* <p>The configuration of specific filters applied to your data source content. You can
|
|
2722
|
-
* filter out or include certain content.</p>
|
|
2394
|
+
* <p>The configuration of specific filters applied to your data source content. You can filter out or include certain content.</p>
|
|
2723
2395
|
* @public
|
|
2724
2396
|
*/
|
|
2725
2397
|
filters: PatternObjectFilter[] | undefined;
|
|
@@ -2736,15 +2408,12 @@ export declare const CrawlFilterConfigurationType: {
|
|
|
2736
2408
|
*/
|
|
2737
2409
|
export type CrawlFilterConfigurationType = (typeof CrawlFilterConfigurationType)[keyof typeof CrawlFilterConfigurationType];
|
|
2738
2410
|
/**
|
|
2739
|
-
* <p>The configuration of filtering the data source content. For example,
|
|
2740
|
-
* configuring regular expression patterns to include or exclude certain content.</p>
|
|
2411
|
+
* <p>The configuration of filtering the data source content. For example, configuring regular expression patterns to include or exclude certain content.</p>
|
|
2741
2412
|
* @public
|
|
2742
2413
|
*/
|
|
2743
2414
|
export interface CrawlFilterConfiguration {
|
|
2744
2415
|
/**
|
|
2745
|
-
* <p>The type of filtering that you want to apply to certain objects or content of the
|
|
2746
|
-
* data source. For example, the <code>PATTERN</code> type is regular expression patterns
|
|
2747
|
-
* you can apply to filter your content.</p>
|
|
2416
|
+
* <p>The type of filtering that you want to apply to certain objects or content of the data source. For example, the <code>PATTERN</code> type is regular expression patterns you can apply to filter your content.</p>
|
|
2748
2417
|
* @public
|
|
2749
2418
|
*/
|
|
2750
2419
|
type: CrawlFilterConfigurationType | undefined;
|
|
@@ -2755,14 +2424,12 @@ export interface CrawlFilterConfiguration {
|
|
|
2755
2424
|
patternObjectFilter?: PatternObjectFilterConfiguration | undefined;
|
|
2756
2425
|
}
|
|
2757
2426
|
/**
|
|
2758
|
-
* <p>The configuration of the Confluence content. For example, configuring specific
|
|
2759
|
-
* types of Confluence content.</p>
|
|
2427
|
+
* <p>The configuration of the Confluence content. For example, configuring specific types of Confluence content.</p>
|
|
2760
2428
|
* @public
|
|
2761
2429
|
*/
|
|
2762
2430
|
export interface ConfluenceCrawlerConfiguration {
|
|
2763
2431
|
/**
|
|
2764
|
-
* <p>The configuration of filtering the Confluence content. For example, configuring
|
|
2765
|
-
* regular expression patterns to include or exclude certain content.</p>
|
|
2432
|
+
* <p>The configuration of filtering the Confluence content. For example, configuring regular expression patterns to include or exclude certain content.</p>
|
|
2766
2433
|
* @public
|
|
2767
2434
|
*/
|
|
2768
2435
|
filterConfiguration?: CrawlFilterConfiguration | undefined;
|
|
@@ -2806,17 +2473,12 @@ export interface ConfluenceSourceConfiguration {
|
|
|
2806
2473
|
*/
|
|
2807
2474
|
hostType: ConfluenceHostType | undefined;
|
|
2808
2475
|
/**
|
|
2809
|
-
* <p>The supported authentication type to authenticate and connect to your
|
|
2810
|
-
* Confluence instance.</p>
|
|
2476
|
+
* <p>The supported authentication type to authenticate and connect to your Confluence instance.</p>
|
|
2811
2477
|
* @public
|
|
2812
2478
|
*/
|
|
2813
2479
|
authType: ConfluenceAuthType | undefined;
|
|
2814
2480
|
/**
|
|
2815
|
-
* <p>The Amazon Resource Name of an Secrets Manager secret that
|
|
2816
|
-
* stores your authentication credentials for your Confluence instance URL.
|
|
2817
|
-
* For more information on the key-value pairs that must be included in
|
|
2818
|
-
* your secret, depending on your authentication type, see
|
|
2819
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/confluence-data-source-connector.html#configuration-confluence-connector">Confluence connection configuration</a>.</p>
|
|
2481
|
+
* <p>The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/confluence-data-source-connector.html#configuration-confluence-connector">Confluence connection configuration</a>.</p>
|
|
2820
2482
|
* @public
|
|
2821
2483
|
*/
|
|
2822
2484
|
credentialsSecretArn: string | undefined;
|
|
@@ -2832,8 +2494,7 @@ export interface ConfluenceDataSourceConfiguration {
|
|
|
2832
2494
|
*/
|
|
2833
2495
|
sourceConfiguration: ConfluenceSourceConfiguration | undefined;
|
|
2834
2496
|
/**
|
|
2835
|
-
* <p>The configuration of the Confluence content. For example, configuring
|
|
2836
|
-
* specific types of Confluence content.</p>
|
|
2497
|
+
* <p>The configuration of the Confluence content. For example, configuring specific types of Confluence content.</p>
|
|
2837
2498
|
* @public
|
|
2838
2499
|
*/
|
|
2839
2500
|
crawlerConfiguration?: ConfluenceCrawlerConfiguration | undefined;
|
|
@@ -2849,8 +2510,7 @@ export interface S3DataSourceConfiguration {
|
|
|
2849
2510
|
*/
|
|
2850
2511
|
bucketArn: string | undefined;
|
|
2851
2512
|
/**
|
|
2852
|
-
* <p>A list of S3 prefixes to include certain files or content. For more information,
|
|
2853
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a>.</p>
|
|
2513
|
+
* <p>A list of S3 prefixes to include certain files or content. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a>.</p>
|
|
2854
2514
|
* @public
|
|
2855
2515
|
*/
|
|
2856
2516
|
inclusionPrefixes?: string[] | undefined;
|
|
@@ -2861,15 +2521,12 @@ export interface S3DataSourceConfiguration {
|
|
|
2861
2521
|
bucketOwnerAccountId?: string | undefined;
|
|
2862
2522
|
}
|
|
2863
2523
|
/**
|
|
2864
|
-
* <p>The configuration of the Salesforce content. For example, configuring
|
|
2865
|
-
* specific types of Salesforce content.</p>
|
|
2524
|
+
* <p>The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.</p>
|
|
2866
2525
|
* @public
|
|
2867
2526
|
*/
|
|
2868
2527
|
export interface SalesforceCrawlerConfiguration {
|
|
2869
2528
|
/**
|
|
2870
|
-
* <p>The configuration of filtering the Salesforce content. For example,
|
|
2871
|
-
* configuring regular expression patterns to include or exclude certain
|
|
2872
|
-
* content.</p>
|
|
2529
|
+
* <p>The configuration of filtering the Salesforce content. For example, configuring regular expression patterns to include or exclude certain content.</p>
|
|
2873
2530
|
* @public
|
|
2874
2531
|
*/
|
|
2875
2532
|
filterConfiguration?: CrawlFilterConfiguration | undefined;
|
|
@@ -2896,17 +2553,12 @@ export interface SalesforceSourceConfiguration {
|
|
|
2896
2553
|
*/
|
|
2897
2554
|
hostUrl: string | undefined;
|
|
2898
2555
|
/**
|
|
2899
|
-
* <p>The supported authentication type to authenticate and connect to your
|
|
2900
|
-
* Salesforce instance.</p>
|
|
2556
|
+
* <p>The supported authentication type to authenticate and connect to your Salesforce instance.</p>
|
|
2901
2557
|
* @public
|
|
2902
2558
|
*/
|
|
2903
2559
|
authType: SalesforceAuthType | undefined;
|
|
2904
2560
|
/**
|
|
2905
|
-
* <p>The Amazon Resource Name of an Secrets Manager secret that
|
|
2906
|
-
* stores your authentication credentials for your Salesforce instance URL.
|
|
2907
|
-
* For more information on the key-value pairs that must be included in
|
|
2908
|
-
* your secret, depending on your authentication type, see
|
|
2909
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/salesforce-data-source-connector.html#configuration-salesforce-connector">Salesforce connection configuration</a>.</p>
|
|
2561
|
+
* <p>The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/salesforce-data-source-connector.html#configuration-salesforce-connector">Salesforce connection configuration</a>.</p>
|
|
2910
2562
|
* @public
|
|
2911
2563
|
*/
|
|
2912
2564
|
credentialsSecretArn: string | undefined;
|
|
@@ -2922,21 +2574,18 @@ export interface SalesforceDataSourceConfiguration {
|
|
|
2922
2574
|
*/
|
|
2923
2575
|
sourceConfiguration: SalesforceSourceConfiguration | undefined;
|
|
2924
2576
|
/**
|
|
2925
|
-
* <p>The configuration of the Salesforce content. For example, configuring
|
|
2926
|
-
* specific types of Salesforce content.</p>
|
|
2577
|
+
* <p>The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.</p>
|
|
2927
2578
|
* @public
|
|
2928
2579
|
*/
|
|
2929
2580
|
crawlerConfiguration?: SalesforceCrawlerConfiguration | undefined;
|
|
2930
2581
|
}
|
|
2931
2582
|
/**
|
|
2932
|
-
* <p>The configuration of the SharePoint content. For example, configuring
|
|
2933
|
-
* specific types of SharePoint content.</p>
|
|
2583
|
+
* <p>The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.</p>
|
|
2934
2584
|
* @public
|
|
2935
2585
|
*/
|
|
2936
2586
|
export interface SharePointCrawlerConfiguration {
|
|
2937
2587
|
/**
|
|
2938
|
-
* <p>The configuration of filtering the SharePoint content. For example,
|
|
2939
|
-
* configuring regular expression patterns to include or exclude certain content.</p>
|
|
2588
|
+
* <p>The configuration of filtering the SharePoint content. For example, configuring regular expression patterns to include or exclude certain content.</p>
|
|
2940
2589
|
* @public
|
|
2941
2590
|
*/
|
|
2942
2591
|
filterConfiguration?: CrawlFilterConfiguration | undefined;
|
|
@@ -2990,17 +2639,12 @@ export interface SharePointSourceConfiguration {
|
|
|
2990
2639
|
*/
|
|
2991
2640
|
hostType: SharePointHostType | undefined;
|
|
2992
2641
|
/**
|
|
2993
|
-
* <p>The supported authentication type to authenticate and connect
|
|
2994
|
-
* to your SharePoint site/sites.</p>
|
|
2642
|
+
* <p>The supported authentication type to authenticate and connect to your SharePoint site/sites.</p>
|
|
2995
2643
|
* @public
|
|
2996
2644
|
*/
|
|
2997
2645
|
authType: SharePointAuthType | undefined;
|
|
2998
2646
|
/**
|
|
2999
|
-
* <p>The Amazon Resource Name of an Secrets Manager secret that
|
|
3000
|
-
* stores your authentication credentials for your SharePoint site/sites.
|
|
3001
|
-
* For more information on the key-value pairs that must be included in
|
|
3002
|
-
* your secret, depending on your authentication type, see
|
|
3003
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sharepoint-data-source-connector.html#configuration-sharepoint-connector">SharePoint connection configuration</a>.</p>
|
|
2647
|
+
* <p>The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sharepoint-data-source-connector.html#configuration-sharepoint-connector">SharePoint connection configuration</a>.</p>
|
|
3004
2648
|
* @public
|
|
3005
2649
|
*/
|
|
3006
2650
|
credentialsSecretArn: string | undefined;
|
|
@@ -3016,8 +2660,7 @@ export interface SharePointDataSourceConfiguration {
|
|
|
3016
2660
|
*/
|
|
3017
2661
|
sourceConfiguration: SharePointSourceConfiguration | undefined;
|
|
3018
2662
|
/**
|
|
3019
|
-
* <p>The configuration of the SharePoint content. For example, configuring
|
|
3020
|
-
* specific types of SharePoint content.</p>
|
|
2663
|
+
* <p>The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.</p>
|
|
3021
2664
|
* @public
|
|
3022
2665
|
*/
|
|
3023
2666
|
crawlerConfiguration?: SharePointCrawlerConfiguration | undefined;
|
|
@@ -3040,8 +2683,7 @@ export declare const DataSourceType: {
|
|
|
3040
2683
|
*/
|
|
3041
2684
|
export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType];
|
|
3042
2685
|
/**
|
|
3043
|
-
* <p>The rate limits for the URLs that you want to crawl.
|
|
3044
|
-
* You should be authorized to crawl the URLs.</p>
|
|
2686
|
+
* <p>The rate limits for the URLs that you want to crawl. You should be authorized to crawl the URLs.</p>
|
|
3045
2687
|
* @public
|
|
3046
2688
|
*/
|
|
3047
2689
|
export interface WebCrawlerLimits {
|
|
@@ -3051,10 +2693,7 @@ export interface WebCrawlerLimits {
|
|
|
3051
2693
|
*/
|
|
3052
2694
|
rateLimit?: number | undefined;
|
|
3053
2695
|
/**
|
|
3054
|
-
* <p>
|
|
3055
|
-
* The max number of web pages crawled from your source URLs, up to 25,000 pages. If
|
|
3056
|
-
* the web pages exceed this limit, the data source sync will fail and no web pages will be ingested.
|
|
3057
|
-
* </p>
|
|
2696
|
+
* <p> The max number of web pages crawled from your source URLs, up to 25,000 pages. If the web pages exceed this limit, the data source sync will fail and no web pages will be ingested. </p>
|
|
3058
2697
|
* @public
|
|
3059
2698
|
*/
|
|
3060
2699
|
maxPages?: number | undefined;
|
|
@@ -3072,8 +2711,7 @@ export declare const WebScopeType: {
|
|
|
3072
2711
|
*/
|
|
3073
2712
|
export type WebScopeType = (typeof WebScopeType)[keyof typeof WebScopeType];
|
|
3074
2713
|
/**
|
|
3075
|
-
* <p>The configuration of web URLs that you want to crawl.
|
|
3076
|
-
* You should be authorized to crawl the URLs.</p>
|
|
2714
|
+
* <p>The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.</p>
|
|
3077
2715
|
* @public
|
|
3078
2716
|
*/
|
|
3079
2717
|
export interface WebCrawlerConfiguration {
|
|
@@ -3083,29 +2721,17 @@ export interface WebCrawlerConfiguration {
|
|
|
3083
2721
|
*/
|
|
3084
2722
|
crawlerLimits?: WebCrawlerLimits | undefined;
|
|
3085
2723
|
/**
|
|
3086
|
-
* <p>A list of one or more inclusion regular expression patterns to include
|
|
3087
|
-
* certain URLs. If you specify an inclusion and exclusion filter/pattern
|
|
3088
|
-
* and both match a URL, the exclusion filter takes precedence and the web
|
|
3089
|
-
* content of the URL isn’t crawled.</p>
|
|
2724
|
+
* <p>A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.</p>
|
|
3090
2725
|
* @public
|
|
3091
2726
|
*/
|
|
3092
2727
|
inclusionFilters?: string[] | undefined;
|
|
3093
2728
|
/**
|
|
3094
|
-
* <p>A list of one or more exclusion regular expression patterns to exclude
|
|
3095
|
-
* certain URLs. If you specify an inclusion and exclusion filter/pattern
|
|
3096
|
-
* and both match a URL, the exclusion filter takes precedence and the web
|
|
3097
|
-
* content of the URL isn’t crawled.</p>
|
|
2729
|
+
* <p>A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.</p>
|
|
3098
2730
|
* @public
|
|
3099
2731
|
*/
|
|
3100
2732
|
exclusionFilters?: string[] | undefined;
|
|
3101
2733
|
/**
|
|
3102
|
-
* <p>The scope of what is crawled for your URLs.</p>
|
|
3103
|
-
* <p>You can choose to crawl only web pages that belong to the same host or primary
|
|
3104
|
-
* domain. For example, only web pages that contain the seed URL
|
|
3105
|
-
* "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains.
|
|
3106
|
-
* You can choose to include sub domains in addition to the host or primary domain.
|
|
3107
|
-
* For example, web pages that contain "aws.amazon.com" can also include sub domain
|
|
3108
|
-
* "docs.aws.amazon.com".</p>
|
|
2734
|
+
* <p>The scope of what is crawled for your URLs.</p> <p>You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".</p>
|
|
3109
2735
|
* @public
|
|
3110
2736
|
*/
|
|
3111
2737
|
scope?: WebScopeType | undefined;
|
|
@@ -3115,17 +2741,13 @@ export interface WebCrawlerConfiguration {
|
|
|
3115
2741
|
*/
|
|
3116
2742
|
userAgent?: string | undefined;
|
|
3117
2743
|
/**
|
|
3118
|
-
* <p>A string used for identifying the crawler or bot when it accesses a web server. The user agent header value
|
|
3119
|
-
* consists of the <code>bedrockbot</code>, UUID, and a user agent suffix for your crawler (if one is provided).
|
|
3120
|
-
* By default, it is set to <code>bedrockbot_UUID</code>. You can optionally append a custom
|
|
3121
|
-
* suffix to <code>bedrockbot_UUID</code> to allowlist a specific user agent permitted to access your source URLs. </p>
|
|
2744
|
+
* <p>A string used for identifying the crawler or bot when it accesses a web server. The user agent header value consists of the <code>bedrockbot</code>, UUID, and a user agent suffix for your crawler (if one is provided). By default, it is set to <code>bedrockbot_UUID</code>. You can optionally append a custom suffix to <code>bedrockbot_UUID</code> to allowlist a specific user agent permitted to access your source URLs. </p>
|
|
3122
2745
|
* @public
|
|
3123
2746
|
*/
|
|
3124
2747
|
userAgentHeader?: string | undefined;
|
|
3125
2748
|
}
|
|
3126
2749
|
/**
|
|
3127
|
-
* <p>The seed or starting point URL.
|
|
3128
|
-
* You should be authorized to crawl the URL.</p>
|
|
2750
|
+
* <p>The seed or starting point URL. You should be authorized to crawl the URL.</p>
|
|
3129
2751
|
* @public
|
|
3130
2752
|
*/
|
|
3131
2753
|
export interface SeedUrl {
|
|
@@ -3136,8 +2758,7 @@ export interface SeedUrl {
|
|
|
3136
2758
|
url?: string | undefined;
|
|
3137
2759
|
}
|
|
3138
2760
|
/**
|
|
3139
|
-
* <p>The configuration of web URLs that you want to crawl.
|
|
3140
|
-
* You should be authorized to crawl the URLs.</p>
|
|
2761
|
+
* <p>The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.</p>
|
|
3141
2762
|
* @public
|
|
3142
2763
|
*/
|
|
3143
2764
|
export interface UrlConfiguration {
|
|
@@ -3148,8 +2769,7 @@ export interface UrlConfiguration {
|
|
|
3148
2769
|
seedUrls?: SeedUrl[] | undefined;
|
|
3149
2770
|
}
|
|
3150
2771
|
/**
|
|
3151
|
-
* <p>The configuration of the URL/URLs for the web content that you want
|
|
3152
|
-
* to crawl. You should be authorized to crawl the URLs.</p>
|
|
2772
|
+
* <p>The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.</p>
|
|
3153
2773
|
* @public
|
|
3154
2774
|
*/
|
|
3155
2775
|
export interface WebSourceConfiguration {
|
|
@@ -3191,36 +2811,22 @@ export interface DataSourceConfiguration {
|
|
|
3191
2811
|
*/
|
|
3192
2812
|
s3Configuration?: S3DataSourceConfiguration | undefined;
|
|
3193
2813
|
/**
|
|
3194
|
-
* <p>The configuration of web URLs to crawl for your data source.
|
|
3195
|
-
* You should be authorized to crawl the URLs.</p>
|
|
3196
|
-
* <note>
|
|
3197
|
-
* <p>Crawling web URLs as your data source is in preview release
|
|
3198
|
-
* and is subject to change.</p>
|
|
3199
|
-
* </note>
|
|
2814
|
+
* <p>The configuration of web URLs to crawl for your data source. You should be authorized to crawl the URLs.</p> <note> <p>Crawling web URLs as your data source is in preview release and is subject to change.</p> </note>
|
|
3200
2815
|
* @public
|
|
3201
2816
|
*/
|
|
3202
2817
|
webConfiguration?: WebDataSourceConfiguration | undefined;
|
|
3203
2818
|
/**
|
|
3204
|
-
* <p>The configuration information to connect to Confluence as your data source.</p>
|
|
3205
|
-
* <note>
|
|
3206
|
-
* <p>Confluence data source connector is in preview release and is subject to change.</p>
|
|
3207
|
-
* </note>
|
|
2819
|
+
* <p>The configuration information to connect to Confluence as your data source.</p> <note> <p>Confluence data source connector is in preview release and is subject to change.</p> </note>
|
|
3208
2820
|
* @public
|
|
3209
2821
|
*/
|
|
3210
2822
|
confluenceConfiguration?: ConfluenceDataSourceConfiguration | undefined;
|
|
3211
2823
|
/**
|
|
3212
|
-
* <p>The configuration information to connect to Salesforce as your data source.</p>
|
|
3213
|
-
* <note>
|
|
3214
|
-
* <p>Salesforce data source connector is in preview release and is subject to change.</p>
|
|
3215
|
-
* </note>
|
|
2824
|
+
* <p>The configuration information to connect to Salesforce as your data source.</p> <note> <p>Salesforce data source connector is in preview release and is subject to change.</p> </note>
|
|
3216
2825
|
* @public
|
|
3217
2826
|
*/
|
|
3218
2827
|
salesforceConfiguration?: SalesforceDataSourceConfiguration | undefined;
|
|
3219
2828
|
/**
|
|
3220
|
-
* <p>The configuration information to connect to SharePoint as your data source.</p>
|
|
3221
|
-
* <note>
|
|
3222
|
-
* <p>SharePoint data source connector is in preview release and is subject to change.</p>
|
|
3223
|
-
* </note>
|
|
2829
|
+
* <p>The configuration information to connect to SharePoint as your data source.</p> <note> <p>SharePoint data source connector is in preview release and is subject to change.</p> </note>
|
|
3224
2830
|
* @public
|
|
3225
2831
|
*/
|
|
3226
2832
|
sharePointConfiguration?: SharePointDataSourceConfiguration | undefined;
|
|
@@ -3278,12 +2884,7 @@ export interface HierarchicalChunkingLevelConfiguration {
|
|
|
3278
2884
|
maxTokens: number | undefined;
|
|
3279
2885
|
}
|
|
3280
2886
|
/**
|
|
3281
|
-
* <p>Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents
|
|
3282
|
-
* into layers of chunks where the first layer contains large chunks, and the second layer contains smaller
|
|
3283
|
-
* chunks derived from the first layer.</p>
|
|
3284
|
-
* <p>You configure the number of tokens to overlap, or repeat across adjacent chunks. For example,
|
|
3285
|
-
* if you set overlap tokens to 60, the last 60 tokens in the first chunk are also included at the beginning of
|
|
3286
|
-
* the second chunk. For each layer, you must also configure the maximum number of tokens in a chunk.</p>
|
|
2887
|
+
* <p>Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.</p> <p>You configure the number of tokens to overlap, or repeat across adjacent chunks. For example, if you set overlap tokens to 60, the last 60 tokens in the first chunk are also included at the beginning of the second chunk. For each layer, you must also configure the maximum number of tokens in a chunk.</p>
|
|
3287
2888
|
* @public
|
|
3288
2889
|
*/
|
|
3289
2890
|
export interface HierarchicalChunkingConfiguration {
|
|
@@ -3299,19 +2900,7 @@ export interface HierarchicalChunkingConfiguration {
|
|
|
3299
2900
|
overlapTokens: number | undefined;
|
|
3300
2901
|
}
|
|
3301
2902
|
/**
|
|
3302
|
-
* <p>Settings for semantic document chunking for a data source. Semantic chunking splits
|
|
3303
|
-
* a document into into smaller documents based on groups of similar content derived from the text
|
|
3304
|
-
* with natural language processing.</p>
|
|
3305
|
-
* <p>With semantic chunking, each sentence is compared to the next to determine how similar they are.
|
|
3306
|
-
* You specify a threshold in the form of a percentile, where adjacent sentences that are less similar than
|
|
3307
|
-
* that percentage of sentence pairs are divided into separate chunks. For example, if you set the threshold to
|
|
3308
|
-
* 90, then the 10 percent of sentence pairs that are least similar are split. So if you have 101 sentences,
|
|
3309
|
-
* 100 sentence pairs are compared, and the 10 with the least similarity are split, creating 11 chunks. These
|
|
3310
|
-
* chunks are further split if they exceed the max token size.</p>
|
|
3311
|
-
* <p>You must also specify a buffer size, which determines whether sentences are compared in isolation, or
|
|
3312
|
-
* within a moving context window that includes the previous and following sentence. For example, if you set
|
|
3313
|
-
* the buffer size to <code>1</code>, the embedding for sentence 10 is derived from sentences 9, 10, and 11
|
|
3314
|
-
* combined.</p>
|
|
2903
|
+
* <p>Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.</p> <p>With semantic chunking, each sentence is compared to the next to determine how similar they are. You specify a threshold in the form of a percentile, where adjacent sentences that are less similar than that percentage of sentence pairs are divided into separate chunks. For example, if you set the threshold to 90, then the 10 percent of sentence pairs that are least similar are split. So if you have 101 sentences, 100 sentence pairs are compared, and the 10 with the least similarity are split, creating 11 chunks. These chunks are further split if they exceed the max token size.</p> <p>You must also specify a buffer size, which determines whether sentences are compared in isolation, or within a moving context window that includes the previous and following sentence. For example, if you set the buffer size to <code>1</code>, the embedding for sentence 10 is derived from sentences 9, 10, and 11 combined.</p>
|
|
3315
2904
|
* @public
|
|
3316
2905
|
*/
|
|
3317
2906
|
export interface SemanticChunkingConfiguration {
|
|
@@ -3337,25 +2926,7 @@ export interface SemanticChunkingConfiguration {
|
|
|
3337
2926
|
*/
|
|
3338
2927
|
export interface ChunkingConfiguration {
|
|
3339
2928
|
/**
|
|
3340
|
-
* <p>Knowledge base can split your source data into chunks. A <i>chunk</i> refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for <code>NONE</code>, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.</p>
|
|
3341
|
-
* <ul>
|
|
3342
|
-
* <li>
|
|
3343
|
-
* <p>
|
|
3344
|
-
* <code>FIXED_SIZE</code> – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the <code>fixedSizeChunkingConfiguration</code>.</p>
|
|
3345
|
-
* </li>
|
|
3346
|
-
* <li>
|
|
3347
|
-
* <p>
|
|
3348
|
-
* <code>HIERARCHICAL</code> – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.</p>
|
|
3349
|
-
* </li>
|
|
3350
|
-
* <li>
|
|
3351
|
-
* <p>
|
|
3352
|
-
* <code>SEMANTIC</code> – Split documents into chunks based on groups of similar content derived with natural language processing.</p>
|
|
3353
|
-
* </li>
|
|
3354
|
-
* <li>
|
|
3355
|
-
* <p>
|
|
3356
|
-
* <code>NONE</code> – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.</p>
|
|
3357
|
-
* </li>
|
|
3358
|
-
* </ul>
|
|
2929
|
+
* <p>Knowledge base can split your source data into chunks. A <i>chunk</i> refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for <code>NONE</code>, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.</p> <ul> <li> <p> <code>FIXED_SIZE</code> – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the <code>fixedSizeChunkingConfiguration</code>.</p> </li> <li> <p> <code>HIERARCHICAL</code> – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.</p> </li> <li> <p> <code>SEMANTIC</code> – Split documents into chunks based on groups of similar content derived with natural language processing.</p> </li> <li> <p> <code>NONE</code> – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.</p> </li> </ul>
|
|
3359
2930
|
* @public
|
|
3360
2931
|
*/
|
|
3361
2932
|
chunkingStrategy: ChunkingStrategy | undefined;
|
|
@@ -3365,16 +2936,12 @@ export interface ChunkingConfiguration {
|
|
|
3365
2936
|
*/
|
|
3366
2937
|
fixedSizeChunkingConfiguration?: FixedSizeChunkingConfiguration | undefined;
|
|
3367
2938
|
/**
|
|
3368
|
-
* <p>Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents
|
|
3369
|
-
* into layers of chunks where the first layer contains large chunks, and the second layer contains smaller
|
|
3370
|
-
* chunks derived from the first layer.</p>
|
|
2939
|
+
* <p>Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.</p>
|
|
3371
2940
|
* @public
|
|
3372
2941
|
*/
|
|
3373
2942
|
hierarchicalChunkingConfiguration?: HierarchicalChunkingConfiguration | undefined;
|
|
3374
2943
|
/**
|
|
3375
|
-
* <p>Settings for semantic document chunking for a data source. Semantic chunking splits
|
|
3376
|
-
* a document into into smaller documents based on groups of similar content derived from the text
|
|
3377
|
-
* with natural language processing.</p>
|
|
2944
|
+
* <p>Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.</p>
|
|
3378
2945
|
* @public
|
|
3379
2946
|
*/
|
|
3380
2947
|
semanticChunkingConfiguration?: SemanticChunkingConfiguration | undefined;
|
|
@@ -3402,14 +2969,12 @@ export interface EnrichmentStrategyConfiguration {
|
|
|
3402
2969
|
method: EnrichmentStrategyMethod | undefined;
|
|
3403
2970
|
}
|
|
3404
2971
|
/**
|
|
3405
|
-
* <p>Context enrichment configuration is used to provide additional context to the RAG application
|
|
3406
|
-
* using Amazon Bedrock foundation models.</p>
|
|
2972
|
+
* <p>Context enrichment configuration is used to provide additional context to the RAG application using Amazon Bedrock foundation models.</p>
|
|
3407
2973
|
* @public
|
|
3408
2974
|
*/
|
|
3409
2975
|
export interface BedrockFoundationModelContextEnrichmentConfiguration {
|
|
3410
2976
|
/**
|
|
3411
|
-
* <p>The enrichment stategy used to provide additional context. For example, Neptune GraphRAG uses
|
|
3412
|
-
* Amazon Bedrock foundation models to perform chunk entity extraction.</p>
|
|
2977
|
+
* <p>The enrichment stategy used to provide additional context. For example, Neptune GraphRAG uses Amazon Bedrock foundation models to perform chunk entity extraction.</p>
|
|
3413
2978
|
* @public
|
|
3414
2979
|
*/
|
|
3415
2980
|
enrichmentStrategyConfiguration: EnrichmentStrategyConfiguration | undefined;
|
|
@@ -3458,8 +3023,7 @@ export interface S3Location {
|
|
|
3458
3023
|
uri: string | undefined;
|
|
3459
3024
|
}
|
|
3460
3025
|
/**
|
|
3461
|
-
* <p>A location for storing content from data sources temporarily as it is processed by
|
|
3462
|
-
* custom components in the ingestion pipeline.</p>
|
|
3026
|
+
* <p>A location for storing content from data sources temporarily as it is processed by custom components in the ingestion pipeline.</p>
|
|
3463
3027
|
* @public
|
|
3464
3028
|
*/
|
|
3465
3029
|
export interface IntermediateStorage {
|
|
@@ -3503,9 +3067,7 @@ export interface TransformationFunction {
|
|
|
3503
3067
|
transformationLambdaConfiguration: TransformationLambdaConfiguration | undefined;
|
|
3504
3068
|
}
|
|
3505
3069
|
/**
|
|
3506
|
-
* <p>A custom processing step for documents moving through a data source ingestion pipeline. To
|
|
3507
|
-
* process documents after they have been converted into chunks, set the step to apply to
|
|
3508
|
-
* <code>POST_CHUNKING</code>.</p>
|
|
3070
|
+
* <p>A custom processing step for documents moving through a data source ingestion pipeline. To process documents after they have been converted into chunks, set the step to apply to <code>POST_CHUNKING</code>.</p>
|
|
3509
3071
|
* @public
|
|
3510
3072
|
*/
|
|
3511
3073
|
export interface Transformation {
|
|
@@ -3521,15 +3083,7 @@ export interface Transformation {
|
|
|
3521
3083
|
stepToApply: StepType | undefined;
|
|
3522
3084
|
}
|
|
3523
3085
|
/**
|
|
3524
|
-
* <p>Settings for customizing steps in the data source content ingestion pipeline.</p>
|
|
3525
|
-
* <p>You can configure the data source to process documents with a Lambda function after
|
|
3526
|
-
* they are parsed and converted into chunks. When you add a post-chunking transformation,
|
|
3527
|
-
* the service stores chunked documents in an S3 bucket and invokes a Lambda function to process
|
|
3528
|
-
* them.</p>
|
|
3529
|
-
* <p>To process chunked documents with a Lambda function, define an S3 bucket path for input
|
|
3530
|
-
* and output objects, and a transformation that specifies the Lambda function to invoke. You can
|
|
3531
|
-
* use the Lambda function to customize how chunks are split, and the metadata for each chunk.
|
|
3532
|
-
* </p>
|
|
3086
|
+
* <p>Settings for customizing steps in the data source content ingestion pipeline.</p> <p>You can configure the data source to process documents with a Lambda function after they are parsed and converted into chunks. When you add a post-chunking transformation, the service stores chunked documents in an S3 bucket and invokes a Lambda function to process them.</p> <p>To process chunked documents with a Lambda function, define an S3 bucket path for input and output objects, and a transformation that specifies the Lambda function to invoke. You can use the Lambda function to customize how chunks are split, and the metadata for each chunk. </p>
|
|
3533
3087
|
* @public
|
|
3534
3088
|
*/
|
|
3535
3089
|
export interface CustomTransformationConfiguration {
|
|
@@ -3611,11 +3165,7 @@ export declare const ParsingStrategy: {
|
|
|
3611
3165
|
*/
|
|
3612
3166
|
export type ParsingStrategy = (typeof ParsingStrategy)[keyof typeof ParsingStrategy];
|
|
3613
3167
|
/**
|
|
3614
|
-
* <p>Settings for parsing document contents. If you exclude this field, the default parser converts the contents of each
|
|
3615
|
-
* document into text before splitting it into chunks. Specify the parsing strategy to use in the <code>parsingStrategy</code> field and include the relevant configuration, or omit it to use the Amazon Bedrock default parser. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-advanced-parsing.html">Parsing options for your data source</a>.</p>
|
|
3616
|
-
* <note>
|
|
3617
|
-
* <p>If you specify <code>BEDROCK_DATA_AUTOMATION</code> or <code>BEDROCK_FOUNDATION_MODEL</code> and it fails to parse a file, the Amazon Bedrock default parser will be used instead.</p>
|
|
3618
|
-
* </note>
|
|
3168
|
+
* <p>Settings for parsing document contents. If you exclude this field, the default parser converts the contents of each document into text before splitting it into chunks. Specify the parsing strategy to use in the <code>parsingStrategy</code> field and include the relevant configuration, or omit it to use the Amazon Bedrock default parser. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-advanced-parsing.html">Parsing options for your data source</a>.</p> <note> <p>If you specify <code>BEDROCK_DATA_AUTOMATION</code> or <code>BEDROCK_FOUNDATION_MODEL</code> and it fails to parse a file, the Amazon Bedrock default parser will be used instead.</p> </note>
|
|
3619
3169
|
* @public
|
|
3620
3170
|
*/
|
|
3621
3171
|
export interface ParsingConfiguration {
|
|
@@ -3656,8 +3206,7 @@ export interface VectorIngestionConfiguration {
|
|
|
3656
3206
|
*/
|
|
3657
3207
|
parsingConfiguration?: ParsingConfiguration | undefined;
|
|
3658
3208
|
/**
|
|
3659
|
-
* <p>The context enrichment configuration used for ingestion of the data into the vector
|
|
3660
|
-
* store.</p>
|
|
3209
|
+
* <p>The context enrichment configuration used for ingestion of the data into the vector store.</p>
|
|
3661
3210
|
* @public
|
|
3662
3211
|
*/
|
|
3663
3212
|
contextEnrichmentConfiguration?: ContextEnrichmentConfiguration | undefined;
|
|
@@ -3672,8 +3221,7 @@ export interface CreateDataSourceRequest {
|
|
|
3672
3221
|
*/
|
|
3673
3222
|
knowledgeBaseId: string | undefined;
|
|
3674
3223
|
/**
|
|
3675
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
3676
|
-
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
3224
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
3677
3225
|
* @public
|
|
3678
3226
|
*/
|
|
3679
3227
|
clientToken?: string | undefined;
|
|
@@ -3693,22 +3241,7 @@ export interface CreateDataSourceRequest {
|
|
|
3693
3241
|
*/
|
|
3694
3242
|
dataSourceConfiguration: DataSourceConfiguration | undefined;
|
|
3695
3243
|
/**
|
|
3696
|
-
* <p>The data deletion policy for the data source.</p>
|
|
3697
|
-
* <p>You can set the data deletion policy to:</p>
|
|
3698
|
-
* <ul>
|
|
3699
|
-
* <li>
|
|
3700
|
-
* <p>DELETE: Deletes all data from your data source that’s converted
|
|
3701
|
-
* into vector embeddings upon deletion of a knowledge base or data source resource.
|
|
3702
|
-
* Note that the <b>vector store itself is not deleted</b>,
|
|
3703
|
-
* only the data. This flag is ignored if an Amazon Web Services account is deleted.</p>
|
|
3704
|
-
* </li>
|
|
3705
|
-
* <li>
|
|
3706
|
-
* <p>RETAIN: Retains all data from your data source that’s converted
|
|
3707
|
-
* into vector embeddings upon deletion of a knowledge base or data source resource.
|
|
3708
|
-
* Note that the <b>vector store itself is not deleted</b>
|
|
3709
|
-
* if you delete a knowledge base or data source resource.</p>
|
|
3710
|
-
* </li>
|
|
3711
|
-
* </ul>
|
|
3244
|
+
* <p>The data deletion policy for the data source.</p> <p>You can set the data deletion policy to:</p> <ul> <li> <p>DELETE: Deletes all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the <b>vector store itself is not deleted</b>, only the data. This flag is ignored if an Amazon Web Services account is deleted.</p> </li> <li> <p>RETAIN: Retains all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the <b>vector store itself is not deleted</b> if you delete a knowledge base or data source resource.</p> </li> </ul>
|
|
3712
3245
|
* @public
|
|
3713
3246
|
*/
|
|
3714
3247
|
dataDeletionPolicy?: DataDeletionPolicy | undefined;
|
|
@@ -3757,15 +3290,7 @@ export interface DataSource {
|
|
|
3757
3290
|
*/
|
|
3758
3291
|
name: string | undefined;
|
|
3759
3292
|
/**
|
|
3760
|
-
* <p>The status of the data source. The following statuses are possible:</p>
|
|
3761
|
-
* <ul>
|
|
3762
|
-
* <li>
|
|
3763
|
-
* <p>Available – The data source has been created and is ready for ingestion into the knowledge base.</p>
|
|
3764
|
-
* </li>
|
|
3765
|
-
* <li>
|
|
3766
|
-
* <p>Deleting – The data source is being deleted.</p>
|
|
3767
|
-
* </li>
|
|
3768
|
-
* </ul>
|
|
3293
|
+
* <p>The status of the data source. The following statuses are possible:</p> <ul> <li> <p>Available – The data source has been created and is ready for ingestion into the knowledge base.</p> </li> <li> <p>Deleting – The data source is being deleted.</p> </li> </ul>
|
|
3769
3294
|
* @public
|
|
3770
3295
|
*/
|
|
3771
3296
|
status: DataSourceStatus | undefined;
|
|
@@ -4168,14 +3693,12 @@ export type SupportedLanguages = (typeof SupportedLanguages)[keyof typeof Suppor
|
|
|
4168
3693
|
*/
|
|
4169
3694
|
export interface InlineCodeFlowNodeConfiguration {
|
|
4170
3695
|
/**
|
|
4171
|
-
* <p>The code that's executed in your inline code node. The code can access input data from previous nodes in the flow, perform operations on that data, and produce output that can be used by other nodes in your flow.</p>
|
|
4172
|
-
* <p>The code must be valid in the programming <code>language</code> that you specify.</p>
|
|
3696
|
+
* <p>The code that's executed in your inline code node. The code can access input data from previous nodes in the flow, perform operations on that data, and produce output that can be used by other nodes in your flow.</p> <p>The code must be valid in the programming <code>language</code> that you specify.</p>
|
|
4173
3697
|
* @public
|
|
4174
3698
|
*/
|
|
4175
3699
|
code: string | undefined;
|
|
4176
3700
|
/**
|
|
4177
|
-
* <p>The programming language used by your inline code node.</p>
|
|
4178
|
-
* <p>The code must be valid in the programming <code>language</code> that you specify. Currently, only Python 3 (<code>Python_3</code>) is supported.</p>
|
|
3701
|
+
* <p>The programming language used by your inline code node.</p> <p>The code must be valid in the programming <code>language</code> that you specify. Currently, only Python 3 (<code>Python_3</code>) is supported.</p>
|
|
4179
3702
|
* @public
|
|
4180
3703
|
*/
|
|
4181
3704
|
language: SupportedLanguages | undefined;
|
|
@@ -4187,8 +3710,7 @@ export interface InlineCodeFlowNodeConfiguration {
|
|
|
4187
3710
|
export interface InputFlowNodeConfiguration {
|
|
4188
3711
|
}
|
|
4189
3712
|
/**
|
|
4190
|
-
* <p>Contains configurations for an iterator node in a flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.</p>
|
|
4191
|
-
* <p>The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.</p>
|
|
3713
|
+
* <p>Contains configurations for an iterator node in a flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.</p> <p>The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.</p>
|
|
4192
3714
|
* @public
|
|
4193
3715
|
*/
|
|
4194
3716
|
export interface IteratorFlowNodeConfiguration {
|
|
@@ -4533,14 +4055,12 @@ export interface LexFlowNodeConfiguration {
|
|
|
4533
4055
|
*/
|
|
4534
4056
|
export interface LoopControllerFlowNodeConfiguration {
|
|
4535
4057
|
/**
|
|
4536
|
-
* <p>Specifies the condition that determines when the flow exits the DoWhile loop. The loop
|
|
4537
|
-
* executes until this condition evaluates to true.</p>
|
|
4058
|
+
* <p>Specifies the condition that determines when the flow exits the DoWhile loop. The loop executes until this condition evaluates to true.</p>
|
|
4538
4059
|
* @public
|
|
4539
4060
|
*/
|
|
4540
4061
|
continueCondition: FlowCondition | undefined;
|
|
4541
4062
|
/**
|
|
4542
|
-
* <p>Specifies the maximum number of times the DoWhile loop can iterate before the flow
|
|
4543
|
-
* exits the loop.</p>
|
|
4063
|
+
* <p>Specifies the maximum number of times the DoWhile loop can iterate before the flow exits the loop.</p>
|
|
4544
4064
|
* @public
|
|
4545
4065
|
*/
|
|
4546
4066
|
maxIterations?: number | undefined;
|
|
@@ -5234,8 +4754,7 @@ export interface FlowNodeInput {
|
|
|
5234
4754
|
*/
|
|
5235
4755
|
name: string | undefined;
|
|
5236
4756
|
/**
|
|
5237
|
-
* <p>Specifies the data type of the input. If the input doesn't match this type at runtime,
|
|
5238
|
-
* a validation error will be thrown.</p>
|
|
4757
|
+
* <p>Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.</p>
|
|
5239
4758
|
* @public
|
|
5240
4759
|
*/
|
|
5241
4760
|
type: FlowNodeIODataType | undefined;
|
|
@@ -5245,26 +4764,7 @@ export interface FlowNodeInput {
|
|
|
5245
4764
|
*/
|
|
5246
4765
|
expression: string | undefined;
|
|
5247
4766
|
/**
|
|
5248
|
-
* <p>Specifies how input data flows between iterations in a DoWhile
|
|
5249
|
-
* loop.</p>
|
|
5250
|
-
* <ul>
|
|
5251
|
-
* <li>
|
|
5252
|
-
* <p>
|
|
5253
|
-
* <code>LoopCondition</code> - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define
|
|
5254
|
-
* the condition that determines if the loop should continue. </p>
|
|
5255
|
-
* </li>
|
|
5256
|
-
* <li>
|
|
5257
|
-
* <p>
|
|
5258
|
-
* <code>ReturnValueToLoopStart</code> - Defines data to pass back to the start
|
|
5259
|
-
* of the loop's next iteration. Use this category for variables that you
|
|
5260
|
-
* want to update for each loop iteration.</p>
|
|
5261
|
-
* </li>
|
|
5262
|
-
* <li>
|
|
5263
|
-
* <p>
|
|
5264
|
-
* <code>ExitLoop</code> - Defines the value that's available once the loop ends.
|
|
5265
|
-
* Use this category to expose loop results to nodes outside the loop.</p>
|
|
5266
|
-
* </li>
|
|
5267
|
-
* </ul>
|
|
4767
|
+
* <p>Specifies how input data flows between iterations in a DoWhile loop.</p> <ul> <li> <p> <code>LoopCondition</code> - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define the condition that determines if the loop should continue. </p> </li> <li> <p> <code>ReturnValueToLoopStart</code> - Defines data to pass back to the start of the loop's next iteration. Use this category for variables that you want to update for each loop iteration.</p> </li> <li> <p> <code>ExitLoop</code> - Defines the value that's available once the loop ends. Use this category to expose loop results to nodes outside the loop.</p> </li> </ul>
|
|
5268
4768
|
* @public
|
|
5269
4769
|
*/
|
|
5270
4770
|
category?: FlowNodeInputCategory | undefined;
|
|
@@ -5368,17 +4868,7 @@ export type ConcurrencyType = (typeof ConcurrencyType)[keyof typeof ConcurrencyT
|
|
|
5368
4868
|
*/
|
|
5369
4869
|
export interface FlowAliasConcurrencyConfiguration {
|
|
5370
4870
|
/**
|
|
5371
|
-
* <p>The type of concurrency to use for parallel node execution. Specify one of the following options:</p>
|
|
5372
|
-
* <ul>
|
|
5373
|
-
* <li>
|
|
5374
|
-
* <p>
|
|
5375
|
-
* <code>Automatic</code> - Amazon Bedrock determines which nodes can be executed in parallel based on the flow definition and its dependencies.</p>
|
|
5376
|
-
* </li>
|
|
5377
|
-
* <li>
|
|
5378
|
-
* <p>
|
|
5379
|
-
* <code>Manual</code> - You specify which nodes can be executed in parallel.</p>
|
|
5380
|
-
* </li>
|
|
5381
|
-
* </ul>
|
|
4871
|
+
* <p>The type of concurrency to use for parallel node execution. Specify one of the following options:</p> <ul> <li> <p> <code>Automatic</code> - Amazon Bedrock determines which nodes can be executed in parallel based on the flow definition and its dependencies.</p> </li> <li> <p> <code>Manual</code> - You specify which nodes can be executed in parallel.</p> </li> </ul>
|
|
5382
4872
|
* @public
|
|
5383
4873
|
*/
|
|
5384
4874
|
type: ConcurrencyType | undefined;
|
|
@@ -5429,8 +4919,7 @@ export interface CreateFlowAliasRequest {
|
|
|
5429
4919
|
*/
|
|
5430
4920
|
flowIdentifier: string | undefined;
|
|
5431
4921
|
/**
|
|
5432
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
5433
|
-
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
4922
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
5434
4923
|
* @public
|
|
5435
4924
|
*/
|
|
5436
4925
|
clientToken?: string | undefined;
|
|
@@ -5606,15 +5095,7 @@ export interface ListFlowAliasesRequest {
|
|
|
5606
5095
|
nextToken?: string | undefined;
|
|
5607
5096
|
}
|
|
5608
5097
|
/**
|
|
5609
|
-
* <p>Contains information about an alias of a flow.</p>
|
|
5610
|
-
* <p>This data type is used in the following API operations:</p>
|
|
5611
|
-
* <ul>
|
|
5612
|
-
* <li>
|
|
5613
|
-
* <p>
|
|
5614
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListFlowAliases.html#API_agent_ListFlowAliases_ResponseSyntax">ListFlowAliases response</a>
|
|
5615
|
-
* </p>
|
|
5616
|
-
* </li>
|
|
5617
|
-
* </ul>
|
|
5098
|
+
* <p>Contains information about an alias of a flow.</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_ListFlowAliases.html#API_agent_ListFlowAliases_ResponseSyntax">ListFlowAliases response</a> </p> </li> </ul>
|
|
5618
5099
|
* @public
|
|
5619
5100
|
*/
|
|
5620
5101
|
export interface FlowAliasSummary {
|
|
@@ -5779,8 +5260,7 @@ export interface CreateFlowVersionRequest {
|
|
|
5779
5260
|
*/
|
|
5780
5261
|
description?: string | undefined;
|
|
5781
5262
|
/**
|
|
5782
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
5783
|
-
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
5263
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
5784
5264
|
* @public
|
|
5785
5265
|
*/
|
|
5786
5266
|
clientToken?: string | undefined;
|
|
@@ -5856,15 +5336,7 @@ export interface ListFlowVersionsRequest {
|
|
|
5856
5336
|
nextToken?: string | undefined;
|
|
5857
5337
|
}
|
|
5858
5338
|
/**
|
|
5859
|
-
* <p>Contains information about a version of a flow.</p>
|
|
5860
|
-
* <p>This data type is used in the following API operations:</p>
|
|
5861
|
-
* <ul>
|
|
5862
|
-
* <li>
|
|
5863
|
-
* <p>
|
|
5864
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListFlowVersions.html#API_agent_ListFlowVersions_ResponseSyntax">ListFlowVersions response</a>
|
|
5865
|
-
* </p>
|
|
5866
|
-
* </li>
|
|
5867
|
-
* </ul>
|
|
5339
|
+
* <p>Contains information about a version of a flow.</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_ListFlowVersions.html#API_agent_ListFlowVersions_ResponseSyntax">ListFlowVersions response</a> </p> </li> </ul>
|
|
5868
5340
|
* @public
|
|
5869
5341
|
*/
|
|
5870
5342
|
export interface FlowVersionSummary {
|
|
@@ -7843,20 +7315,7 @@ export declare const FlowValidationType: {
|
|
|
7843
7315
|
*/
|
|
7844
7316
|
export type FlowValidationType = (typeof FlowValidationType)[keyof typeof FlowValidationType];
|
|
7845
7317
|
/**
|
|
7846
|
-
* <p>Contains information about validation of the flow.</p>
|
|
7847
|
-
* <p>This data type is used in the following API operations:</p>
|
|
7848
|
-
* <ul>
|
|
7849
|
-
* <li>
|
|
7850
|
-
* <p>
|
|
7851
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html#API_agent_GetFlow_ResponseSyntax">GetFlow response</a>
|
|
7852
|
-
* </p>
|
|
7853
|
-
* </li>
|
|
7854
|
-
* <li>
|
|
7855
|
-
* <p>
|
|
7856
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlowVersion.html#API_agent_GetFlowVersion_ResponseSyntax">GetFlowVersion response</a>
|
|
7857
|
-
* </p>
|
|
7858
|
-
* </li>
|
|
7859
|
-
* </ul>
|
|
7318
|
+
* <p>Contains information about validation of the flow.</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_GetFlow.html#API_agent_GetFlow_ResponseSyntax">GetFlow response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlowVersion.html#API_agent_GetFlowVersion_ResponseSyntax">GetFlowVersion response</a> </p> </li> </ul>
|
|
7860
7319
|
* @public
|
|
7861
7320
|
*/
|
|
7862
7321
|
export interface FlowValidation {
|
|
@@ -7922,21 +7381,7 @@ export interface FlowSummary {
|
|
|
7922
7381
|
*/
|
|
7923
7382
|
arn: string | undefined;
|
|
7924
7383
|
/**
|
|
7925
|
-
* <p>The status of the flow. The following statuses are possible:</p>
|
|
7926
|
-
* <ul>
|
|
7927
|
-
* <li>
|
|
7928
|
-
* <p>NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the <code>DRAFT</code> version won't contain the latest changes for testing. Send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html">PrepareFlow</a> request to package the latest changes into the <code>DRAFT</code> version.</p>
|
|
7929
|
-
* </li>
|
|
7930
|
-
* <li>
|
|
7931
|
-
* <p>Preparing – The flow is being prepared so that the <code>DRAFT</code> version contains the latest changes for testing.</p>
|
|
7932
|
-
* </li>
|
|
7933
|
-
* <li>
|
|
7934
|
-
* <p>Prepared – The flow is prepared and the <code>DRAFT</code> version contains the latest changes for testing.</p>
|
|
7935
|
-
* </li>
|
|
7936
|
-
* <li>
|
|
7937
|
-
* <p>Failed – The last API operation that you invoked on the flow failed. Send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html">GetFlow</a> request and check the error message in the <code>validations</code> field.</p>
|
|
7938
|
-
* </li>
|
|
7939
|
-
* </ul>
|
|
7384
|
+
* <p>The status of the flow. The following statuses are possible:</p> <ul> <li> <p>NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the <code>DRAFT</code> version won't contain the latest changes for testing. Send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html">PrepareFlow</a> request to package the latest changes into the <code>DRAFT</code> version.</p> </li> <li> <p>Preparing – The flow is being prepared so that the <code>DRAFT</code> version contains the latest changes for testing.</p> </li> <li> <p>Prepared – The flow is prepared and the <code>DRAFT</code> version contains the latest changes for testing.</p> </li> <li> <p>Failed – The last API operation that you invoked on the flow failed. Send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html">GetFlow</a> request and check the error message in the <code>validations</code> field.</p> </li> </ul>
|
|
7940
7385
|
* @public
|
|
7941
7386
|
*/
|
|
7942
7387
|
status: FlowStatus | undefined;
|