@aws-sdk/client-bedrock-agent 3.540.0 → 3.549.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.
Files changed (47) hide show
  1. package/README.md +1 -2
  2. package/dist-types/BedrockAgent.d.ts +1 -2
  3. package/dist-types/BedrockAgentClient.d.ts +1 -2
  4. package/dist-types/commands/AssociateAgentKnowledgeBaseCommand.d.ts +8 -8
  5. package/dist-types/commands/CreateAgentActionGroupCommand.d.ts +9 -8
  6. package/dist-types/commands/CreateAgentAliasCommand.d.ts +8 -8
  7. package/dist-types/commands/CreateAgentCommand.d.ts +30 -7
  8. package/dist-types/commands/CreateDataSourceCommand.d.ts +11 -8
  9. package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +38 -7
  10. package/dist-types/commands/DeleteAgentActionGroupCommand.d.ts +7 -7
  11. package/dist-types/commands/DeleteAgentAliasCommand.d.ts +6 -6
  12. package/dist-types/commands/DeleteAgentCommand.d.ts +7 -7
  13. package/dist-types/commands/DeleteAgentVersionCommand.d.ts +7 -7
  14. package/dist-types/commands/DeleteDataSourceCommand.d.ts +7 -7
  15. package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +7 -7
  16. package/dist-types/commands/DisassociateAgentKnowledgeBaseCommand.d.ts +7 -7
  17. package/dist-types/commands/GetAgentActionGroupCommand.d.ts +6 -6
  18. package/dist-types/commands/GetAgentAliasCommand.d.ts +6 -6
  19. package/dist-types/commands/GetAgentCommand.d.ts +6 -6
  20. package/dist-types/commands/GetAgentKnowledgeBaseCommand.d.ts +6 -6
  21. package/dist-types/commands/GetAgentVersionCommand.d.ts +6 -6
  22. package/dist-types/commands/GetDataSourceCommand.d.ts +6 -6
  23. package/dist-types/commands/GetIngestionJobCommand.d.ts +8 -6
  24. package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +6 -6
  25. package/dist-types/commands/ListAgentActionGroupsCommand.d.ts +6 -6
  26. package/dist-types/commands/ListAgentAliasesCommand.d.ts +6 -6
  27. package/dist-types/commands/ListAgentKnowledgeBasesCommand.d.ts +6 -6
  28. package/dist-types/commands/ListAgentVersionsCommand.d.ts +6 -6
  29. package/dist-types/commands/ListAgentsCommand.d.ts +5 -5
  30. package/dist-types/commands/ListDataSourcesCommand.d.ts +6 -6
  31. package/dist-types/commands/ListIngestionJobsCommand.d.ts +8 -6
  32. package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +5 -5
  33. package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -6
  34. package/dist-types/commands/PrepareAgentCommand.d.ts +8 -8
  35. package/dist-types/commands/StartIngestionJobCommand.d.ts +10 -8
  36. package/dist-types/commands/TagResourceCommand.d.ts +7 -7
  37. package/dist-types/commands/UntagResourceCommand.d.ts +6 -6
  38. package/dist-types/commands/UpdateAgentActionGroupCommand.d.ts +8 -8
  39. package/dist-types/commands/UpdateAgentAliasCommand.d.ts +8 -8
  40. package/dist-types/commands/UpdateAgentCommand.d.ts +9 -9
  41. package/dist-types/commands/UpdateAgentKnowledgeBaseCommand.d.ts +7 -7
  42. package/dist-types/commands/UpdateDataSourceCommand.d.ts +10 -7
  43. package/dist-types/commands/UpdateKnowledgeBaseCommand.d.ts +26 -7
  44. package/dist-types/index.d.ts +1 -2
  45. package/dist-types/models/models_0.d.ts +629 -534
  46. package/dist-types/ts3.4/models/models_0.d.ts +3 -1
  47. package/package.json +6 -6
@@ -1,7 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { BedrockAgentServiceException as __BaseException } from "./BedrockAgentServiceException";
3
3
  /**
4
- * This exception is thrown when a request is denied per access permissions
4
+ * <p>The request is denied because of missing access permissions.</p>
5
5
  * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
@@ -13,7 +13,7 @@ export declare class AccessDeniedException extends __BaseException {
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
15
  /**
16
- * Type of Executors for an Action Group
16
+ * <p>Contains details about the Lambda function containing the business logic that is carried out upon invoking the action.</p>
17
17
  * @public
18
18
  */
19
19
  export type ActionGroupExecutor = ActionGroupExecutor.LambdaMember | ActionGroupExecutor.$UnknownMember;
@@ -22,7 +22,7 @@ export type ActionGroupExecutor = ActionGroupExecutor.LambdaMember | ActionGroup
22
22
  */
23
23
  export declare namespace ActionGroupExecutor {
24
24
  /**
25
- * ARN of a Lambda.
25
+ * <p>The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.</p>
26
26
  * @public
27
27
  */
28
28
  interface LambdaMember {
@@ -43,7 +43,7 @@ export declare namespace ActionGroupExecutor {
43
43
  const visit: <T>(value: ActionGroupExecutor, visitor: Visitor<T>) => T;
44
44
  }
45
45
  /**
46
- * This exception is thrown when there is a conflict performing an operation
46
+ * <p>There was a conflict performing an operation.</p>
47
47
  * @public
48
48
  */
49
49
  export declare class ConflictException extends __BaseException {
@@ -67,23 +67,23 @@ export declare const ActionGroupState: {
67
67
  */
68
68
  export type ActionGroupState = (typeof ActionGroupState)[keyof typeof ActionGroupState];
69
69
  /**
70
- * The identifier for the S3 resource.
70
+ * <p>Contains information about the S3 object containing the resource.</p>
71
71
  * @public
72
72
  */
73
73
  export interface S3Identifier {
74
74
  /**
75
- * A bucket in S3.
75
+ * <p>The name of the S3 bucket.</p>
76
76
  * @public
77
77
  */
78
78
  s3BucketName?: string;
79
79
  /**
80
- * A object key in S3.
80
+ * <p>The S3 object key containing the resource.</p>
81
81
  * @public
82
82
  */
83
83
  s3ObjectKey?: string;
84
84
  }
85
85
  /**
86
- * Contains information about the API Schema for the Action Group
86
+ * <p>Contains details about the OpenAPI schema for the action group. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>. You can either include the schema directly in the <code>payload</code> field or you can upload it to an S3 bucket and specify the S3 bucket location in the <code>s3</code> field.</p>
87
87
  * @public
88
88
  */
89
89
  export type APISchema = APISchema.PayloadMember | APISchema.S3Member | APISchema.$UnknownMember;
@@ -92,7 +92,7 @@ export type APISchema = APISchema.PayloadMember | APISchema.S3Member | APISchema
92
92
  */
93
93
  export declare namespace APISchema {
94
94
  /**
95
- * The identifier for the S3 resource.
95
+ * <p>Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>.</p>
96
96
  * @public
97
97
  */
98
98
  interface S3Member {
@@ -101,7 +101,7 @@ export declare namespace APISchema {
101
101
  $unknown?: never;
102
102
  }
103
103
  /**
104
- * String OpenAPI Payload
104
+ * <p>The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>.</p>
105
105
  * @public
106
106
  */
107
107
  interface PayloadMember {
@@ -136,135 +136,137 @@ export declare const ActionGroupSignature: {
136
136
  */
137
137
  export type ActionGroupSignature = (typeof ActionGroupSignature)[keyof typeof ActionGroupSignature];
138
138
  /**
139
- * Create Action Group Request
140
139
  * @public
141
140
  */
142
141
  export interface CreateAgentActionGroupRequest {
143
142
  /**
144
- * Id generated at the server side when an Agent is created
143
+ * <p>The unique identifier of the agent for which to create the action group.</p>
145
144
  * @public
146
145
  */
147
146
  agentId: string | undefined;
148
147
  /**
149
- * Draft Version of the Agent.
148
+ * <p>The version of the agent for which to create the action group.</p>
150
149
  * @public
151
150
  */
152
151
  agentVersion: string | undefined;
153
152
  /**
154
- * Name for a resource.
153
+ * <p>The name to give the action group.</p>
155
154
  * @public
156
155
  */
157
156
  actionGroupName: string | undefined;
158
157
  /**
159
- * Client specified token used for idempotency checks
158
+ * <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,
159
+ * 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>
160
160
  * @public
161
161
  */
162
162
  clientToken?: string;
163
163
  /**
164
- * Description of the Resource.
164
+ * <p>A description of the action group.</p>
165
165
  * @public
166
166
  */
167
167
  description?: string;
168
168
  /**
169
- * Action Group Signature for a BuiltIn Action
169
+ * <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>. You must leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields blank for this action group.</p>
170
+ * <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>
170
171
  * @public
171
172
  */
172
173
  parentActionGroupSignature?: ActionGroupSignature;
173
174
  /**
174
- * Type of Executors for an Action Group
175
+ * <p>The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.</p>
175
176
  * @public
176
177
  */
177
178
  actionGroupExecutor?: ActionGroupExecutor;
178
179
  /**
179
- * Contains information about the API Schema for the Action Group
180
+ * <p>Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>.</p>
180
181
  * @public
181
182
  */
182
183
  apiSchema?: APISchema;
183
184
  /**
184
- * State of the action group
185
+ * <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>
185
186
  * @public
186
187
  */
187
188
  actionGroupState?: ActionGroupState;
188
189
  }
189
190
  /**
190
- * Contains the information of an Agent Action Group
191
+ * <p>Contains details about an action group.</p>
191
192
  * @public
192
193
  */
193
194
  export interface AgentActionGroup {
194
195
  /**
195
- * Identifier for a resource.
196
+ * <p>The unique identifier of the agent to which the action group belongs.</p>
196
197
  * @public
197
198
  */
198
199
  agentId: string | undefined;
199
200
  /**
200
- * Agent Version.
201
+ * <p>The version of the agent to which the action group belongs.</p>
201
202
  * @public
202
203
  */
203
204
  agentVersion: string | undefined;
204
205
  /**
205
- * Identifier for a resource.
206
+ * <p>The unique identifier of the action group.</p>
206
207
  * @public
207
208
  */
208
209
  actionGroupId: string | undefined;
209
210
  /**
210
- * Name for a resource.
211
+ * <p>The name of the action group.</p>
211
212
  * @public
212
213
  */
213
214
  actionGroupName: string | undefined;
214
215
  /**
215
- * Client specified token used for idempotency checks
216
+ * <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,
217
+ * 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>
216
218
  * @public
217
219
  */
218
220
  clientToken?: string;
219
221
  /**
220
- * Description of the Resource.
222
+ * <p>The description of the action group.</p>
221
223
  * @public
222
224
  */
223
225
  description?: string;
224
226
  /**
225
- * Time Stamp.
227
+ * <p>The time at which the action group was created.</p>
226
228
  * @public
227
229
  */
228
230
  createdAt: Date | undefined;
229
231
  /**
230
- * Time Stamp.
232
+ * <p>The time at which the action group was last updated.</p>
231
233
  * @public
232
234
  */
233
235
  updatedAt: Date | undefined;
234
236
  /**
235
- * Action Group Signature for a BuiltIn Action
237
+ * <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>
238
+ * <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>
236
239
  * @public
237
240
  */
238
241
  parentActionSignature?: ActionGroupSignature;
239
242
  /**
240
- * Type of Executors for an Action Group
243
+ * <p>The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.</p>
241
244
  * @public
242
245
  */
243
246
  actionGroupExecutor?: ActionGroupExecutor;
244
247
  /**
245
- * Contains information about the API Schema for the Action Group
248
+ * <p>Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>.</p>
246
249
  * @public
247
250
  */
248
251
  apiSchema?: APISchema;
249
252
  /**
250
- * State of the action group
253
+ * <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>
251
254
  * @public
252
255
  */
253
256
  actionGroupState: ActionGroupState | undefined;
254
257
  }
255
258
  /**
256
- * Create Action Group Response
257
259
  * @public
258
260
  */
259
261
  export interface CreateAgentActionGroupResponse {
260
262
  /**
261
- * Contains the information of an Agent Action Group
263
+ * <p>Contains details about the action group that was created.</p>
262
264
  * @public
263
265
  */
264
266
  agentActionGroup: AgentActionGroup | undefined;
265
267
  }
266
268
  /**
267
- * This exception is thrown if there was an unexpected error during processing of request
269
+ * <p>An internal server error occurred. Retry your request.</p>
268
270
  * @public
269
271
  */
270
272
  export declare class InternalServerException extends __BaseException {
@@ -276,7 +278,7 @@ export declare class InternalServerException extends __BaseException {
276
278
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
277
279
  }
278
280
  /**
279
- * This exception is thrown when a resource referenced by the operation does not exist
281
+ * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
280
282
  * @public
281
283
  */
282
284
  export declare class ResourceNotFoundException extends __BaseException {
@@ -288,7 +290,7 @@ export declare class ResourceNotFoundException extends __BaseException {
288
290
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
289
291
  }
290
292
  /**
291
- * This exception is thrown when a request is made beyond the service quota
293
+ * <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
292
294
  * @public
293
295
  */
294
296
  export declare class ServiceQuotaExceededException extends __BaseException {
@@ -300,7 +302,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
300
302
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
301
303
  }
302
304
  /**
303
- * This exception is thrown when the number of requests exceeds the limit
305
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
304
306
  * @public
305
307
  */
306
308
  export declare class ThrottlingException extends __BaseException {
@@ -312,30 +314,30 @@ export declare class ThrottlingException extends __BaseException {
312
314
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
313
315
  }
314
316
  /**
315
- * Stores information about a field passed inside a request that resulted in an exception
317
+ * <p>Stores information about a field passed inside a request that resulted in an validation error.</p>
316
318
  * @public
317
319
  */
318
320
  export interface ValidationExceptionField {
319
321
  /**
320
- * Non Blank String
322
+ * <p>The name of the field.</p>
321
323
  * @public
322
324
  */
323
325
  name: string | undefined;
324
326
  /**
325
- * Non Blank String
327
+ * <p>A message describing why this field failed validation.</p>
326
328
  * @public
327
329
  */
328
330
  message: string | undefined;
329
331
  }
330
332
  /**
331
- * This exception is thrown when the request's input validation fails
333
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
332
334
  * @public
333
335
  */
334
336
  export declare class ValidationException extends __BaseException {
335
337
  readonly name: "ValidationException";
336
338
  readonly $fault: "client";
337
339
  /**
338
- * list of ValidationExceptionField
340
+ * <p>A list of objects containing fields that caused validation errors and their corresponding validation error messages.</p>
339
341
  * @public
340
342
  */
341
343
  fieldList?: ValidationExceptionField[];
@@ -345,200 +347,195 @@ export declare class ValidationException extends __BaseException {
345
347
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
346
348
  }
347
349
  /**
348
- * Delete Action Group Request
349
350
  * @public
350
351
  */
351
352
  export interface DeleteAgentActionGroupRequest {
352
353
  /**
353
- * Id generated at the server side when an Agent is created
354
+ * <p>The unique identifier of the agent that the action group belongs to.</p>
354
355
  * @public
355
356
  */
356
357
  agentId: string | undefined;
357
358
  /**
358
- * Draft Version of the Agent.
359
+ * <p>The version of the agent that the action group belongs to.</p>
359
360
  * @public
360
361
  */
361
362
  agentVersion: string | undefined;
362
363
  /**
363
- * Id generated at the server side when an Agent ActionGroup is created
364
+ * <p>The unique identifier of the action group to delete.</p>
364
365
  * @public
365
366
  */
366
367
  actionGroupId: string | undefined;
367
368
  /**
368
- * Skips checking if resource is in use when set to true. Defaults to false
369
+ * <p>By default, this value is <code>false</code> and deletion is stopped if the resource is in use. If you set it to <code>true</code>, the resource will be deleted even if the resource is in use.</p>
369
370
  * @public
370
371
  */
371
372
  skipResourceInUseCheck?: boolean;
372
373
  }
373
374
  /**
374
- * Delete Action Group Response
375
375
  * @public
376
376
  */
377
377
  export interface DeleteAgentActionGroupResponse {
378
378
  }
379
379
  /**
380
- * Get Action Group Request
381
380
  * @public
382
381
  */
383
382
  export interface GetAgentActionGroupRequest {
384
383
  /**
385
- * Id generated at the server side when an Agent is created
384
+ * <p>The unique identifier of the agent that the action group belongs to.</p>
386
385
  * @public
387
386
  */
388
387
  agentId: string | undefined;
389
388
  /**
390
- * Version number generated when a version is created
389
+ * <p>The version of the agent that the action group belongs to.</p>
391
390
  * @public
392
391
  */
393
392
  agentVersion: string | undefined;
394
393
  /**
395
- * Id generated at the server side when an Agent Action Group is created
394
+ * <p>The unique identifier of the action group for which to get information.</p>
396
395
  * @public
397
396
  */
398
397
  actionGroupId: string | undefined;
399
398
  }
400
399
  /**
401
- * Get Action Group Response
402
400
  * @public
403
401
  */
404
402
  export interface GetAgentActionGroupResponse {
405
403
  /**
406
- * Contains the information of an Agent Action Group
404
+ * <p>Contains details about the action group.</p>
407
405
  * @public
408
406
  */
409
407
  agentActionGroup: AgentActionGroup | undefined;
410
408
  }
411
409
  /**
412
- * List Action Groups Request
413
410
  * @public
414
411
  */
415
412
  export interface ListAgentActionGroupsRequest {
416
413
  /**
417
- * Id generated at the server side when an Agent is Listed
414
+ * <p>The unique identifier of the agent.</p>
418
415
  * @public
419
416
  */
420
417
  agentId: string | undefined;
421
418
  /**
422
- * Id generated at the server side when an Agent is Listed
419
+ * <p>The version of the agent.</p>
423
420
  * @public
424
421
  */
425
422
  agentVersion: string | undefined;
426
423
  /**
427
- * Max Results.
424
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
428
425
  * @public
429
426
  */
430
427
  maxResults?: number;
431
428
  /**
432
- * Opaque continuation token of previous paginated response.
429
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
433
430
  * @public
434
431
  */
435
432
  nextToken?: string;
436
433
  }
437
434
  /**
438
- * ActionGroup Summary
435
+ * <p>Contains details about an action group.</p>
439
436
  * @public
440
437
  */
441
438
  export interface ActionGroupSummary {
442
439
  /**
443
- * Identifier for a resource.
440
+ * <p>The unique identifier of the action group.</p>
444
441
  * @public
445
442
  */
446
443
  actionGroupId: string | undefined;
447
444
  /**
448
- * Name for a resource.
445
+ * <p>The name of the action group.</p>
449
446
  * @public
450
447
  */
451
448
  actionGroupName: string | undefined;
452
449
  /**
453
- * State of the action group
450
+ * <p>Specifies whether the action group is available for the agent to invoke or not when
451
+ * sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a>
452
+ * request.</p>
454
453
  * @public
455
454
  */
456
455
  actionGroupState: ActionGroupState | undefined;
457
456
  /**
458
- * Description of the Resource.
457
+ * <p>The description of the action group.</p>
459
458
  * @public
460
459
  */
461
460
  description?: string;
462
461
  /**
463
- * Time Stamp.
462
+ * <p>The time at which the action group was last updated.</p>
464
463
  * @public
465
464
  */
466
465
  updatedAt: Date | undefined;
467
466
  }
468
467
  /**
469
- * List Action Groups Response
470
468
  * @public
471
469
  */
472
470
  export interface ListAgentActionGroupsResponse {
473
471
  /**
474
- * List of ActionGroup Summaries
472
+ * <p>A list of objects, each of which contains information about an action group.</p>
475
473
  * @public
476
474
  */
477
475
  actionGroupSummaries: ActionGroupSummary[] | undefined;
478
476
  /**
479
- * Opaque continuation token of previous paginated response.
477
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
480
478
  * @public
481
479
  */
482
480
  nextToken?: string;
483
481
  }
484
482
  /**
485
- * Update Action Group Request
486
483
  * @public
487
484
  */
488
485
  export interface UpdateAgentActionGroupRequest {
489
486
  /**
490
- * Id generated at the server side when an Agent is created
487
+ * <p>The unique identifier of the agent for which to update the action group.</p>
491
488
  * @public
492
489
  */
493
490
  agentId: string | undefined;
494
491
  /**
495
- * Draft Version of the Agent.
492
+ * <p>The unique identifier of the agent version for which to update the action group.</p>
496
493
  * @public
497
494
  */
498
495
  agentVersion: string | undefined;
499
496
  /**
500
- * Id generated at the server side when an Action Group is created under Agent
497
+ * <p>The unique identifier of the action group.</p>
501
498
  * @public
502
499
  */
503
500
  actionGroupId: string | undefined;
504
501
  /**
505
- * Name for a resource.
502
+ * <p>Specifies a new name for the action group.</p>
506
503
  * @public
507
504
  */
508
505
  actionGroupName: string | undefined;
509
506
  /**
510
- * Description of the Resource.
507
+ * <p>Specifies a new name for the action group.</p>
511
508
  * @public
512
509
  */
513
510
  description?: string;
514
511
  /**
515
- * Action Group Signature for a BuiltIn Action
512
+ * <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>. You must leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields blank for this action group.</p>
513
+ * <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>
516
514
  * @public
517
515
  */
518
516
  parentActionGroupSignature?: ActionGroupSignature;
519
517
  /**
520
- * Type of Executors for an Action Group
518
+ * <p>The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.</p>
521
519
  * @public
522
520
  */
523
521
  actionGroupExecutor?: ActionGroupExecutor;
524
522
  /**
525
- * State of the action group
523
+ * <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>
526
524
  * @public
527
525
  */
528
526
  actionGroupState?: ActionGroupState;
529
527
  /**
530
- * Contains information about the API Schema for the Action Group
528
+ * <p>Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>.</p>
531
529
  * @public
532
530
  */
533
531
  apiSchema?: APISchema;
534
532
  }
535
533
  /**
536
- * Update Action Group Response
537
534
  * @public
538
535
  */
539
536
  export interface UpdateAgentActionGroupResponse {
540
537
  /**
541
- * Contains the information of an Agent Action Group
538
+ * <p>Contains details about the action group that was updated.</p>
542
539
  * @public
543
540
  */
544
541
  agentActionGroup: AgentActionGroup | undefined;
@@ -562,32 +559,32 @@ export declare const AgentStatus: {
562
559
  */
563
560
  export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus];
564
561
  /**
565
- * Configuration for inference in prompt configuration
562
+ * <p>Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the <code>promptType</code>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
566
563
  * @public
567
564
  */
568
565
  export interface InferenceConfiguration {
569
566
  /**
570
- * Controls randomness, higher values increase diversity
567
+ * <p>The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.</p>
571
568
  * @public
572
569
  */
573
570
  temperature?: number;
574
571
  /**
575
- * Cumulative probability cutoff for token selection
572
+ * <p>While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for <code>Top P</code> determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set <code>topP</code> to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.</p>
576
573
  * @public
577
574
  */
578
575
  topP?: number;
579
576
  /**
580
- * Sample from the k most likely next tokens
577
+ * <p>While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for <code>topK</code> is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set <code>topK</code> to 50, the model selects the next token from among the top 50 most likely choices.</p>
581
578
  * @public
582
579
  */
583
580
  topK?: number;
584
581
  /**
585
- * Maximum length of output
582
+ * <p>The maximum number of tokens to allow in the generated response.</p>
586
583
  * @public
587
584
  */
588
585
  maximumLength?: number;
589
586
  /**
590
- * List of stop sequences
587
+ * <p>A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.</p>
591
588
  * @public
592
589
  */
593
590
  stopSequences?: string[];
@@ -631,181 +628,228 @@ export declare const PromptType: {
631
628
  */
632
629
  export type PromptType = (typeof PromptType)[keyof typeof PromptType];
633
630
  /**
634
- * BasePromptConfiguration per Prompt Type.
631
+ * <p>Contains configurations to override a prompt template in one part of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
635
632
  * @public
636
633
  */
637
634
  export interface PromptConfiguration {
638
635
  /**
639
- * Prompt Type.
636
+ * <p>The step in the agent sequence that this prompt configuration applies to.</p>
640
637
  * @public
641
638
  */
642
639
  promptType?: PromptType;
643
640
  /**
644
- * Creation Mode for Prompt Configuration.
641
+ * <p>Specifies whether to override the default prompt template for this <code>promptType</code>. Set this value to <code>OVERRIDDEN</code> to use the prompt that you provide in the <code>basePromptTemplate</code>. If you leave it as <code>DEFAULT</code>, the agent uses a default prompt template.</p>
645
642
  * @public
646
643
  */
647
644
  promptCreationMode?: CreationMode;
648
645
  /**
649
- * Prompt State.
646
+ * <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>
647
+ * <ul>
648
+ * <li>
649
+ * <p>
650
+ * <code>PRE_PROCESSING</code> – <code>ENABLED</code>
651
+ * </p>
652
+ * </li>
653
+ * <li>
654
+ * <p>
655
+ * <code>ORCHESTRATION</code> – <code>ENABLED</code>
656
+ * </p>
657
+ * </li>
658
+ * <li>
659
+ * <p>
660
+ * <code>KNOWLEDGE_BASE_RESPONSE_GENERATION</code> – <code>ENABLED</code>
661
+ * </p>
662
+ * </li>
663
+ * <li>
664
+ * <p>
665
+ * <code>POST_PROCESSING</code> – <code>DISABLED</code>
666
+ * </p>
667
+ * </li>
668
+ * </ul>
650
669
  * @public
651
670
  */
652
671
  promptState?: PromptState;
653
672
  /**
654
- * Base Prompt Template.
673
+ * <p>Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Prompt template placeholder variables</a>.</p>
655
674
  * @public
656
675
  */
657
676
  basePromptTemplate?: string;
658
677
  /**
659
- * Configuration for inference in prompt configuration
678
+ * <p>Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the <code>promptType</code>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
660
679
  * @public
661
680
  */
662
681
  inferenceConfiguration?: InferenceConfiguration;
663
682
  /**
664
- * Creation Mode for Prompt Configuration.
683
+ * <p>Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the <code>promptType</code>. If you set the field as <code>OVERRIDEN</code>, the <code>overrideLambda</code> field in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> must be specified with the ARN of a Lambda function.</p>
665
684
  * @public
666
685
  */
667
686
  parserMode?: CreationMode;
668
687
  }
669
688
  /**
670
- * Configuration for prompt override.
689
+ * <p>Contains configurations to override prompts in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
671
690
  * @public
672
691
  */
673
692
  export interface PromptOverrideConfiguration {
674
693
  /**
675
- * List of BasePromptConfiguration
694
+ * <p>Contains configurations to override a prompt template in one part of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
676
695
  * @public
677
696
  */
678
697
  promptConfigurations: PromptConfiguration[] | undefined;
679
698
  /**
680
- * ARN of a Lambda.
699
+ * <p>The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the <code>promptConfigurations</code> must contain a <code>parserMode</code> value that is set to <code>OVERRIDDEN</code>.</p>
681
700
  * @public
682
701
  */
683
702
  overrideLambda?: string;
684
703
  }
685
704
  /**
686
- * Contains the information of an agent
705
+ * <p>Contains details about an agent.</p>
687
706
  * @public
688
707
  */
689
708
  export interface Agent {
690
709
  /**
691
- * Identifier for a resource.
710
+ * <p>The unique identifier of the agent.</p>
692
711
  * @public
693
712
  */
694
713
  agentId: string | undefined;
695
714
  /**
696
- * Name for a resource.
715
+ * <p>The name of the agent.</p>
697
716
  * @public
698
717
  */
699
718
  agentName: string | undefined;
700
719
  /**
701
- * Arn representation of the Agent.
720
+ * <p>The ARN of the agent.</p>
702
721
  * @public
703
722
  */
704
723
  agentArn: string | undefined;
705
724
  /**
706
- * Draft Agent Version.
725
+ * <p>The version of the agent.</p>
707
726
  * @public
708
727
  */
709
728
  agentVersion: string | undefined;
710
729
  /**
711
- * Client specified token used for idempotency checks
730
+ * <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,
731
+ * 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>
712
732
  * @public
713
733
  */
714
734
  clientToken?: string;
715
735
  /**
716
- * Instruction for the agent.
736
+ * <p>Instructions that tell the agent what it should do and how it should interact with users.</p>
717
737
  * @public
718
738
  */
719
739
  instruction?: string;
720
740
  /**
721
- * Schema Type for Action APIs.
741
+ * <p>The status of the agent and whether it is ready for use. The following statuses are possible:</p>
742
+ * <ul>
743
+ * <li>
744
+ * <p>CREATING – The agent is being created.</p>
745
+ * </li>
746
+ * <li>
747
+ * <p>PREPARING – The agent is being prepared.</p>
748
+ * </li>
749
+ * <li>
750
+ * <p>PREPARED – The agent is prepared and ready to be invoked.</p>
751
+ * </li>
752
+ * <li>
753
+ * <p>NOT_PREPARED – The agent has been created but not yet prepared.</p>
754
+ * </li>
755
+ * <li>
756
+ * <p>FAILED – The agent API operation failed.</p>
757
+ * </li>
758
+ * <li>
759
+ * <p>UPDATING – The agent is being updated.</p>
760
+ * </li>
761
+ * <li>
762
+ * <p>DELETING – The agent is being deleted.</p>
763
+ * </li>
764
+ * </ul>
722
765
  * @public
723
766
  */
724
767
  agentStatus: AgentStatus | undefined;
725
768
  /**
726
- * ARN or name of a Bedrock model.
769
+ * <p>The foundation model used for orchestration by the agent.</p>
727
770
  * @public
728
771
  */
729
772
  foundationModel?: string;
730
773
  /**
731
- * Description of the Resource.
774
+ * <p>The description of the agent.</p>
732
775
  * @public
733
776
  */
734
777
  description?: string;
735
778
  /**
736
- * Max Session Time.
779
+ * <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
780
+ * <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>
737
781
  * @public
738
782
  */
739
783
  idleSessionTTLInSeconds: number | undefined;
740
784
  /**
741
- * ARN of a IAM role.
785
+ * <p>The ARN of the IAM role with permissions to call API operations on the agent. The ARN must begin with <code>AmazonBedrockExecutionRoleForAgents_</code>.</p>
742
786
  * @public
743
787
  */
744
788
  agentResourceRoleArn: string | undefined;
745
789
  /**
746
- * A KMS key ARN
790
+ * <p>The ARN of the KMS key that encrypts the agent.</p>
747
791
  * @public
748
792
  */
749
793
  customerEncryptionKeyArn?: string;
750
794
  /**
751
- * Time Stamp.
795
+ * <p>The time at which the agent was created.</p>
752
796
  * @public
753
797
  */
754
798
  createdAt: Date | undefined;
755
799
  /**
756
- * Time Stamp.
800
+ * <p>The time at which the agent was last updated.</p>
757
801
  * @public
758
802
  */
759
803
  updatedAt: Date | undefined;
760
804
  /**
761
- * Time Stamp.
805
+ * <p>The time at which the agent was last prepared.</p>
762
806
  * @public
763
807
  */
764
808
  preparedAt?: Date;
765
809
  /**
766
- * Failure Reasons for Error.
810
+ * <p>Contains reasons that the agent-related API that you invoked failed.</p>
767
811
  * @public
768
812
  */
769
813
  failureReasons?: string[];
770
814
  /**
771
- * The recommended actions users can take to resolve an error in failureReasons.
815
+ * <p>Contains recommended actions to take for the agent-related API that you invoked to succeed.</p>
772
816
  * @public
773
817
  */
774
818
  recommendedActions?: string[];
775
819
  /**
776
- * Configuration for prompt override.
820
+ * <p>Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
777
821
  * @public
778
822
  */
779
823
  promptOverrideConfiguration?: PromptOverrideConfiguration;
780
824
  }
781
825
  /**
782
- * Details about the routing configuration for an Agent alias.
826
+ * <p>Contains details about the routing configuration of the alias.</p>
783
827
  * @public
784
828
  */
785
829
  export interface AgentAliasRoutingConfigurationListItem {
786
830
  /**
787
- * Agent Version.
831
+ * <p>The version of the agent with which the alias is associated.</p>
788
832
  * @public
789
833
  */
790
834
  agentVersion: string | undefined;
791
835
  }
792
836
  /**
793
- * History event for an alias for an Agent.
837
+ * <p>Contains details about the history of the alias.</p>
794
838
  * @public
795
839
  */
796
840
  export interface AgentAliasHistoryEvent {
797
841
  /**
798
- * Routing configuration for an Agent alias.
842
+ * <p>Contains details about the version of the agent with which the alias is associated.</p>
799
843
  * @public
800
844
  */
801
845
  routingConfiguration?: AgentAliasRoutingConfigurationListItem[];
802
846
  /**
803
- * Time Stamp.
847
+ * <p>The date that the alias stopped being associated to the version in the <code>routingConfiguration</code> object</p>
804
848
  * @public
805
849
  */
806
850
  endDate?: Date;
807
851
  /**
808
- * Time Stamp.
852
+ * <p>The date that the alias began being associated to the version in the <code>routingConfiguration</code> object.</p>
809
853
  * @public
810
854
  */
811
855
  startDate?: Date;
@@ -826,103 +870,121 @@ export declare const AgentAliasStatus: {
826
870
  */
827
871
  export type AgentAliasStatus = (typeof AgentAliasStatus)[keyof typeof AgentAliasStatus];
828
872
  /**
829
- * Contains the information of an agent alias
873
+ * <p>Contains details about an alias of an agent.</p>
830
874
  * @public
831
875
  */
832
876
  export interface AgentAlias {
833
877
  /**
834
- * Identifier for a resource.
878
+ * <p>The unique identifier of the agent.</p>
835
879
  * @public
836
880
  */
837
881
  agentId: string | undefined;
838
882
  /**
839
- * Id for an Agent Alias generated at the server side.
883
+ * <p>The unique identifier of the alias of the agent.</p>
840
884
  * @public
841
885
  */
842
886
  agentAliasId: string | undefined;
843
887
  /**
844
- * Name for a resource.
888
+ * <p>The name of the alias of the agent.</p>
845
889
  * @public
846
890
  */
847
891
  agentAliasName: string | undefined;
848
892
  /**
849
- * Arn representation of the Agent Alias.
893
+ * <p>The ARN of the alias of the agent.</p>
850
894
  * @public
851
895
  */
852
896
  agentAliasArn: string | undefined;
853
897
  /**
854
- * Client specified token used for idempotency checks
898
+ * <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,
899
+ * 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>
855
900
  * @public
856
901
  */
857
902
  clientToken?: string;
858
903
  /**
859
- * Description of the Resource.
904
+ * <p>The description of the alias of the agent.</p>
860
905
  * @public
861
906
  */
862
907
  description?: string;
863
908
  /**
864
- * Routing configuration for an Agent alias.
909
+ * <p>Contains details about the routing configuration of the alias.</p>
865
910
  * @public
866
911
  */
867
912
  routingConfiguration: AgentAliasRoutingConfigurationListItem[] | undefined;
868
913
  /**
869
- * Time Stamp.
914
+ * <p>The time at which the alias of the agent was created.</p>
870
915
  * @public
871
916
  */
872
917
  createdAt: Date | undefined;
873
918
  /**
874
- * Time Stamp.
919
+ * <p>The time at which the alias was last updated.</p>
875
920
  * @public
876
921
  */
877
922
  updatedAt: Date | undefined;
878
923
  /**
879
- * The list of history events for an alias for an Agent.
924
+ * <p>Contains details about the history of the alias.</p>
880
925
  * @public
881
926
  */
882
927
  agentAliasHistoryEvents?: AgentAliasHistoryEvent[];
883
928
  /**
884
- * The statuses an Agent Alias can be in.
929
+ * <p>The status of the alias of the agent and whether it is ready for use. The following statuses are possible:</p>
930
+ * <ul>
931
+ * <li>
932
+ * <p>CREATING – The agent alias is being created.</p>
933
+ * </li>
934
+ * <li>
935
+ * <p>PREPARED – The agent alias is finished being created or updated and is ready to be invoked.</p>
936
+ * </li>
937
+ * <li>
938
+ * <p>FAILED – The agent alias API operation failed.</p>
939
+ * </li>
940
+ * <li>
941
+ * <p>UPDATING – The agent alias is being updated.</p>
942
+ * </li>
943
+ * <li>
944
+ * <p>DELETING – The agent alias is being deleted.</p>
945
+ * </li>
946
+ * </ul>
885
947
  * @public
886
948
  */
887
949
  agentAliasStatus: AgentAliasStatus | undefined;
888
950
  }
889
951
  /**
890
- * Summary of an alias for an Agent.
952
+ * <p>Contains details about an alias of an agent.</p>
891
953
  * @public
892
954
  */
893
955
  export interface AgentAliasSummary {
894
956
  /**
895
- * Id for an Agent Alias generated at the server side.
957
+ * <p>Contains details about </p>
896
958
  * @public
897
959
  */
898
960
  agentAliasId: string | undefined;
899
961
  /**
900
- * Name for a resource.
962
+ * <p>The name of the alias.</p>
901
963
  * @public
902
964
  */
903
965
  agentAliasName: string | undefined;
904
966
  /**
905
- * Description of the Resource.
967
+ * <p>The description of the alias.</p>
906
968
  * @public
907
969
  */
908
970
  description?: string;
909
971
  /**
910
- * Routing configuration for an Agent alias.
972
+ * <p>Contains details about the version of the agent with which the alias is associated.</p>
911
973
  * @public
912
974
  */
913
975
  routingConfiguration?: AgentAliasRoutingConfigurationListItem[];
914
976
  /**
915
- * The statuses an Agent Alias can be in.
977
+ * <p>The status of the alias.</p>
916
978
  * @public
917
979
  */
918
980
  agentAliasStatus: AgentAliasStatus | undefined;
919
981
  /**
920
- * Time Stamp.
982
+ * <p>The time at which the alias of the agent was created.</p>
921
983
  * @public
922
984
  */
923
985
  createdAt: Date | undefined;
924
986
  /**
925
- * Time Stamp.
987
+ * <p>The time at which the alias was last updated.</p>
926
988
  * @public
927
989
  */
928
990
  updatedAt: Date | undefined;
@@ -940,684 +1002,667 @@ export declare const KnowledgeBaseState: {
940
1002
  */
941
1003
  export type KnowledgeBaseState = (typeof KnowledgeBaseState)[keyof typeof KnowledgeBaseState];
942
1004
  /**
943
- * Contains the information of an Agent Knowledge Base.
1005
+ * <p>Contains details about a knowledge base that is associated with an agent.</p>
944
1006
  * @public
945
1007
  */
946
1008
  export interface AgentKnowledgeBase {
947
1009
  /**
948
- * Identifier for a resource.
1010
+ * <p>The unique identifier of the agent with which the knowledge base is associated.</p>
949
1011
  * @public
950
1012
  */
951
1013
  agentId: string | undefined;
952
1014
  /**
953
- * Agent Version.
1015
+ * <p>The version of the agent with which the knowledge base is associated.</p>
954
1016
  * @public
955
1017
  */
956
1018
  agentVersion: string | undefined;
957
1019
  /**
958
- * Identifier for a resource.
1020
+ * <p>The unique identifier of the association between the agent and the knowledge base.</p>
959
1021
  * @public
960
1022
  */
961
1023
  knowledgeBaseId: string | undefined;
962
1024
  /**
963
- * Description of the Resource.
1025
+ * <p>The description of the association between the agent and the knowledge base.</p>
964
1026
  * @public
965
1027
  */
966
1028
  description: string | undefined;
967
1029
  /**
968
- * Time Stamp.
1030
+ * <p>The time at which the association between the agent and the knowledge base was created.</p>
969
1031
  * @public
970
1032
  */
971
1033
  createdAt: Date | undefined;
972
1034
  /**
973
- * Time Stamp.
1035
+ * <p>The time at which the association between the agent and the knowledge base was last updated.</p>
974
1036
  * @public
975
1037
  */
976
1038
  updatedAt: Date | undefined;
977
1039
  /**
978
- * State of the knowledge base; whether it is enabled or disabled
1040
+ * <p>Specifies whether to use the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
979
1041
  * @public
980
1042
  */
981
1043
  knowledgeBaseState: KnowledgeBaseState | undefined;
982
1044
  }
983
1045
  /**
984
- * Agent Knowledge Base Summary
1046
+ * <p>Contains details about a knowledge base associated with an agent.</p>
985
1047
  * @public
986
1048
  */
987
1049
  export interface AgentKnowledgeBaseSummary {
988
1050
  /**
989
- * Identifier for a resource.
1051
+ * <p>The unique identifier of the knowledge base associated with an agent.</p>
990
1052
  * @public
991
1053
  */
992
1054
  knowledgeBaseId: string | undefined;
993
1055
  /**
994
- * Description of the Resource.
1056
+ * <p>The description of the knowledge base associated with an agent.</p>
995
1057
  * @public
996
1058
  */
997
1059
  description?: string;
998
1060
  /**
999
- * State of the knowledge base; whether it is enabled or disabled
1061
+ * <p>Specifies whether the agent uses the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
1000
1062
  * @public
1001
1063
  */
1002
1064
  knowledgeBaseState: KnowledgeBaseState | undefined;
1003
1065
  /**
1004
- * Time Stamp.
1066
+ * <p>The time at which the knowledge base associated with an agent was last updated.</p>
1005
1067
  * @public
1006
1068
  */
1007
1069
  updatedAt: Date | undefined;
1008
1070
  }
1009
1071
  /**
1010
- * Create Agent Request
1011
1072
  * @public
1012
1073
  */
1013
1074
  export interface CreateAgentRequest {
1014
1075
  /**
1015
- * Name for a resource.
1076
+ * <p>A name for the agent that you create.</p>
1016
1077
  * @public
1017
1078
  */
1018
1079
  agentName: string | undefined;
1019
1080
  /**
1020
- * Client specified token used for idempotency checks
1081
+ * <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,
1082
+ * 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>
1021
1083
  * @public
1022
1084
  */
1023
1085
  clientToken?: string;
1024
1086
  /**
1025
- * Instruction for the agent.
1087
+ * <p>Instructions that tell the agent what it should do and how it should interact with users.</p>
1026
1088
  * @public
1027
1089
  */
1028
1090
  instruction?: string;
1029
1091
  /**
1030
- * ARN or name of a Bedrock model.
1092
+ * <p>The foundation model to be used for orchestration by the agent you create.</p>
1031
1093
  * @public
1032
1094
  */
1033
1095
  foundationModel?: string;
1034
1096
  /**
1035
- * Description of the Resource.
1097
+ * <p>A description of the agent.</p>
1036
1098
  * @public
1037
1099
  */
1038
1100
  description?: string;
1039
1101
  /**
1040
- * Max Session Time.
1102
+ * <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
1103
+ * <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>
1041
1104
  * @public
1042
1105
  */
1043
1106
  idleSessionTTLInSeconds?: number;
1044
1107
  /**
1045
- * ARN of a IAM role.
1108
+ * <p>The ARN of the IAM role with permissions to create the agent. The ARN must begin with <code>AmazonBedrockExecutionRoleForAgents_</code>.</p>
1046
1109
  * @public
1047
1110
  */
1048
1111
  agentResourceRoleArn: string | undefined;
1049
1112
  /**
1050
- * A KMS key ARN
1113
+ * <p>The ARN of the KMS key with which to encrypt the agent.</p>
1051
1114
  * @public
1052
1115
  */
1053
1116
  customerEncryptionKeyArn?: string;
1054
1117
  /**
1055
- * A map of tag keys and values
1118
+ * <p>Any tags that you want to attach to the agent.</p>
1056
1119
  * @public
1057
1120
  */
1058
1121
  tags?: Record<string, string>;
1059
1122
  /**
1060
- * Configuration for prompt override.
1123
+ * <p>Contains configurations to override prompts in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
1061
1124
  * @public
1062
1125
  */
1063
1126
  promptOverrideConfiguration?: PromptOverrideConfiguration;
1064
1127
  }
1065
1128
  /**
1066
- * Create Agent Response
1067
1129
  * @public
1068
1130
  */
1069
1131
  export interface CreateAgentResponse {
1070
1132
  /**
1071
- * Contains the information of an agent
1133
+ * <p>Contains details about the agent created.</p>
1072
1134
  * @public
1073
1135
  */
1074
1136
  agent: Agent | undefined;
1075
1137
  }
1076
1138
  /**
1077
- * Delete Agent Request
1078
1139
  * @public
1079
1140
  */
1080
1141
  export interface DeleteAgentRequest {
1081
1142
  /**
1082
- * Id generated at the server side when an Agent is created
1143
+ * <p>The unique identifier of the agent to delete.</p>
1083
1144
  * @public
1084
1145
  */
1085
1146
  agentId: string | undefined;
1086
1147
  /**
1087
- * Skips checking if resource is in use when set to true. Defaults to false
1148
+ * <p>By default, this value is <code>false</code> and deletion is stopped if the resource is in use. If you set it to <code>true</code>, the resource will be deleted even if the resource is in use.</p>
1088
1149
  * @public
1089
1150
  */
1090
1151
  skipResourceInUseCheck?: boolean;
1091
1152
  }
1092
1153
  /**
1093
- * Delete Agent Response
1094
1154
  * @public
1095
1155
  */
1096
1156
  export interface DeleteAgentResponse {
1097
1157
  /**
1098
- * Identifier for a resource.
1158
+ * <p>The unique identifier of the agent that was deleted.</p>
1099
1159
  * @public
1100
1160
  */
1101
1161
  agentId: string | undefined;
1102
1162
  /**
1103
- * Schema Type for Action APIs.
1163
+ * <p>The status of the agent.</p>
1104
1164
  * @public
1105
1165
  */
1106
1166
  agentStatus: AgentStatus | undefined;
1107
1167
  }
1108
1168
  /**
1109
- * Get Agent Request
1110
1169
  * @public
1111
1170
  */
1112
1171
  export interface GetAgentRequest {
1113
1172
  /**
1114
- * Id generated at the server side when an Agent is created
1173
+ * <p>The unique identifier of the agent.</p>
1115
1174
  * @public
1116
1175
  */
1117
1176
  agentId: string | undefined;
1118
1177
  }
1119
1178
  /**
1120
- * Get Agent Response
1121
1179
  * @public
1122
1180
  */
1123
1181
  export interface GetAgentResponse {
1124
1182
  /**
1125
- * Contains the information of an agent
1183
+ * <p>Contains details about the agent.</p>
1126
1184
  * @public
1127
1185
  */
1128
1186
  agent: Agent | undefined;
1129
1187
  }
1130
1188
  /**
1131
- * List Agent Request
1132
1189
  * @public
1133
1190
  */
1134
1191
  export interface ListAgentsRequest {
1135
1192
  /**
1136
- * Max Results.
1193
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
1137
1194
  * @public
1138
1195
  */
1139
1196
  maxResults?: number;
1140
1197
  /**
1141
- * Opaque continuation token of previous paginated response.
1198
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
1142
1199
  * @public
1143
1200
  */
1144
1201
  nextToken?: string;
1145
1202
  }
1146
1203
  /**
1147
- * Summary of Agent.
1204
+ * <p>Contains details about an agent.</p>
1148
1205
  * @public
1149
1206
  */
1150
1207
  export interface AgentSummary {
1151
1208
  /**
1152
- * Identifier for a resource.
1209
+ * <p>The unique identifier of the agent.</p>
1153
1210
  * @public
1154
1211
  */
1155
1212
  agentId: string | undefined;
1156
1213
  /**
1157
- * Name for a resource.
1214
+ * <p>The name of the agent.</p>
1158
1215
  * @public
1159
1216
  */
1160
1217
  agentName: string | undefined;
1161
1218
  /**
1162
- * Schema Type for Action APIs.
1219
+ * <p>The status of the agent.</p>
1163
1220
  * @public
1164
1221
  */
1165
1222
  agentStatus: AgentStatus | undefined;
1166
1223
  /**
1167
- * Description of the Resource.
1224
+ * <p>The description of the agent.</p>
1168
1225
  * @public
1169
1226
  */
1170
1227
  description?: string;
1171
1228
  /**
1172
- * Time Stamp.
1229
+ * <p>The time at which the agent was last updated.</p>
1173
1230
  * @public
1174
1231
  */
1175
1232
  updatedAt: Date | undefined;
1176
1233
  /**
1177
- * Agent Version.
1234
+ * <p>The latest version of the agent.</p>
1178
1235
  * @public
1179
1236
  */
1180
1237
  latestAgentVersion?: string;
1181
1238
  }
1182
1239
  /**
1183
- * List Agent Response
1184
1240
  * @public
1185
1241
  */
1186
1242
  export interface ListAgentsResponse {
1187
1243
  /**
1188
- * List of AgentSummary.
1244
+ * <p>A list of objects, each of which contains information about an agent.</p>
1189
1245
  * @public
1190
1246
  */
1191
1247
  agentSummaries: AgentSummary[] | undefined;
1192
1248
  /**
1193
- * Opaque continuation token of previous paginated response.
1249
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
1194
1250
  * @public
1195
1251
  */
1196
1252
  nextToken?: string;
1197
1253
  }
1198
1254
  /**
1199
- * PrepareAgent Request
1200
1255
  * @public
1201
1256
  */
1202
1257
  export interface PrepareAgentRequest {
1203
1258
  /**
1204
- * Id generated at the server side when an Agent is created
1259
+ * <p>The unique identifier of the agent for which to create a <code>DRAFT</code> version.</p>
1205
1260
  * @public
1206
1261
  */
1207
1262
  agentId: string | undefined;
1208
1263
  }
1209
1264
  /**
1210
- * PrepareAgent Response
1211
1265
  * @public
1212
1266
  */
1213
1267
  export interface PrepareAgentResponse {
1214
1268
  /**
1215
- * Identifier for a resource.
1269
+ * <p>The unique identifier of the agent for which the <code>DRAFT</code> version was created.</p>
1216
1270
  * @public
1217
1271
  */
1218
1272
  agentId: string | undefined;
1219
1273
  /**
1220
- * Schema Type for Action APIs.
1274
+ * <p>The status of the <code>DRAFT</code> version and whether it is ready for use.</p>
1221
1275
  * @public
1222
1276
  */
1223
1277
  agentStatus: AgentStatus | undefined;
1224
1278
  /**
1225
- * Agent Version.
1279
+ * <p>The version of the agent.</p>
1226
1280
  * @public
1227
1281
  */
1228
1282
  agentVersion: string | undefined;
1229
1283
  /**
1230
- * Time Stamp.
1284
+ * <p>The time at which the <code>DRAFT</code> version of the agent was last prepared.</p>
1231
1285
  * @public
1232
1286
  */
1233
1287
  preparedAt: Date | undefined;
1234
1288
  }
1235
1289
  /**
1236
- * Update Agent Request
1237
1290
  * @public
1238
1291
  */
1239
1292
  export interface UpdateAgentRequest {
1240
1293
  /**
1241
- * Id generated at the server side when an Agent is created
1294
+ * <p>The unique identifier of the agent.</p>
1242
1295
  * @public
1243
1296
  */
1244
1297
  agentId: string | undefined;
1245
1298
  /**
1246
- * Name for a resource.
1299
+ * <p>Specifies a new name for the agent.</p>
1247
1300
  * @public
1248
1301
  */
1249
1302
  agentName: string | undefined;
1250
1303
  /**
1251
- * Instruction for the agent.
1304
+ * <p>Specifies new instructions that tell the agent what it should do and how it should interact with users.</p>
1252
1305
  * @public
1253
1306
  */
1254
1307
  instruction?: string;
1255
1308
  /**
1256
- * ARN or name of a Bedrock model.
1309
+ * <p>Specifies a new foundation model to be used for orchestration by the agent.</p>
1257
1310
  * @public
1258
1311
  */
1259
- foundationModel?: string;
1312
+ foundationModel: string | undefined;
1260
1313
  /**
1261
- * Description of the Resource.
1314
+ * <p>Specifies a new description of the agent.</p>
1262
1315
  * @public
1263
1316
  */
1264
1317
  description?: string;
1265
1318
  /**
1266
- * Max Session Time.
1319
+ * <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
1320
+ * <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>
1267
1321
  * @public
1268
1322
  */
1269
1323
  idleSessionTTLInSeconds?: number;
1270
1324
  /**
1271
- * ARN of a IAM role.
1325
+ * <p>The ARN of the IAM role with permissions to update the agent. The ARN must begin with <code>AmazonBedrockExecutionRoleForAgents_</code>.</p>
1272
1326
  * @public
1273
1327
  */
1274
1328
  agentResourceRoleArn: string | undefined;
1275
1329
  /**
1276
- * A KMS key ARN
1330
+ * <p>The ARN of the KMS key with which to encrypt the agent.</p>
1277
1331
  * @public
1278
1332
  */
1279
1333
  customerEncryptionKeyArn?: string;
1280
1334
  /**
1281
- * Configuration for prompt override.
1335
+ * <p>Contains configurations to override prompts in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
1282
1336
  * @public
1283
1337
  */
1284
1338
  promptOverrideConfiguration?: PromptOverrideConfiguration;
1285
1339
  }
1286
1340
  /**
1287
- * Update Agent Response
1288
1341
  * @public
1289
1342
  */
1290
1343
  export interface UpdateAgentResponse {
1291
1344
  /**
1292
- * Contains the information of an agent
1345
+ * <p>Contains details about the agent that was updated.</p>
1293
1346
  * @public
1294
1347
  */
1295
1348
  agent: Agent | undefined;
1296
1349
  }
1297
1350
  /**
1298
- * Contains the information of an agent version.
1351
+ * <p>Contains details about a version of an agent.</p>
1299
1352
  * @public
1300
1353
  */
1301
1354
  export interface AgentVersion {
1302
1355
  /**
1303
- * Identifier for a resource.
1356
+ * <p>The unique identifier of the agent that the version belongs to.</p>
1304
1357
  * @public
1305
1358
  */
1306
1359
  agentId: string | undefined;
1307
1360
  /**
1308
- * Name for a resource.
1361
+ * <p>The name of the agent that the version belongs to.</p>
1309
1362
  * @public
1310
1363
  */
1311
1364
  agentName: string | undefined;
1312
1365
  /**
1313
- * Arn representation of the Agent.
1366
+ * <p>The ARN of the agent that the version belongs to.</p>
1314
1367
  * @public
1315
1368
  */
1316
1369
  agentArn: string | undefined;
1317
1370
  /**
1318
- * Numerical Agent Version.
1371
+ * <p>The version number.</p>
1319
1372
  * @public
1320
1373
  */
1321
1374
  version: string | undefined;
1322
1375
  /**
1323
- * Instruction for the agent.
1376
+ * <p>The instructions provided to the agent.</p>
1324
1377
  * @public
1325
1378
  */
1326
1379
  instruction?: string;
1327
1380
  /**
1328
- * Schema Type for Action APIs.
1381
+ * <p>The status of the agent that the version belongs to.</p>
1329
1382
  * @public
1330
1383
  */
1331
1384
  agentStatus: AgentStatus | undefined;
1332
1385
  /**
1333
- * ARN or name of a Bedrock model.
1386
+ * <p>The foundation model that the version invokes.</p>
1334
1387
  * @public
1335
1388
  */
1336
1389
  foundationModel?: string;
1337
1390
  /**
1338
- * Description of the Resource.
1391
+ * <p>The description of the version.</p>
1339
1392
  * @public
1340
1393
  */
1341
1394
  description?: string;
1342
1395
  /**
1343
- * Max Session Time.
1396
+ * <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
1397
+ * <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>
1344
1398
  * @public
1345
1399
  */
1346
1400
  idleSessionTTLInSeconds: number | undefined;
1347
1401
  /**
1348
- * ARN of a IAM role.
1402
+ * <p>The ARN of the IAM role with permissions to invoke API operations on the agent. The ARN must begin with <code>AmazonBedrockExecutionRoleForAgents_</code>.</p>
1349
1403
  * @public
1350
1404
  */
1351
1405
  agentResourceRoleArn: string | undefined;
1352
1406
  /**
1353
- * A KMS key ARN
1407
+ * <p>The ARN of the KMS key that encrypts the agent.</p>
1354
1408
  * @public
1355
1409
  */
1356
1410
  customerEncryptionKeyArn?: string;
1357
1411
  /**
1358
- * Time Stamp.
1412
+ * <p>The time at which the version was created.</p>
1359
1413
  * @public
1360
1414
  */
1361
1415
  createdAt: Date | undefined;
1362
1416
  /**
1363
- * Time Stamp.
1417
+ * <p>The time at which the version was last updated.</p>
1364
1418
  * @public
1365
1419
  */
1366
1420
  updatedAt: Date | undefined;
1367
1421
  /**
1368
- * Failure Reasons for Error.
1422
+ * <p>A list of reasons that the API operation on the version failed.</p>
1369
1423
  * @public
1370
1424
  */
1371
1425
  failureReasons?: string[];
1372
1426
  /**
1373
- * The recommended actions users can take to resolve an error in failureReasons.
1427
+ * <p>A list of recommended actions to take for the failed API operation on the version to succeed.</p>
1374
1428
  * @public
1375
1429
  */
1376
1430
  recommendedActions?: string[];
1377
1431
  /**
1378
- * Configuration for prompt override.
1432
+ * <p>Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
1379
1433
  * @public
1380
1434
  */
1381
1435
  promptOverrideConfiguration?: PromptOverrideConfiguration;
1382
1436
  }
1383
1437
  /**
1384
- * Summary of agent version.
1438
+ * <p>Contains details about a version of an agent.</p>
1385
1439
  * @public
1386
1440
  */
1387
1441
  export interface AgentVersionSummary {
1388
1442
  /**
1389
- * Name for a resource.
1443
+ * <p>The name of the agent to which the version belongs.</p>
1390
1444
  * @public
1391
1445
  */
1392
1446
  agentName: string | undefined;
1393
1447
  /**
1394
- * Schema Type for Action APIs.
1448
+ * <p>The status of the agent to which the version belongs.</p>
1395
1449
  * @public
1396
1450
  */
1397
1451
  agentStatus: AgentStatus | undefined;
1398
1452
  /**
1399
- * Agent Version.
1453
+ * <p>The version of the agent.</p>
1400
1454
  * @public
1401
1455
  */
1402
1456
  agentVersion: string | undefined;
1403
1457
  /**
1404
- * Time Stamp.
1458
+ * <p>The time at which the version was created.</p>
1405
1459
  * @public
1406
1460
  */
1407
1461
  createdAt: Date | undefined;
1408
1462
  /**
1409
- * Time Stamp.
1463
+ * <p>The time at which the version was last updated.</p>
1410
1464
  * @public
1411
1465
  */
1412
1466
  updatedAt: Date | undefined;
1413
1467
  /**
1414
- * Description of the Resource.
1468
+ * <p>The description of the version of the agent.</p>
1415
1469
  * @public
1416
1470
  */
1417
1471
  description?: string;
1418
1472
  }
1419
1473
  /**
1420
- * Create Agent Alias Request
1421
1474
  * @public
1422
1475
  */
1423
1476
  export interface CreateAgentAliasRequest {
1424
1477
  /**
1425
- * Id generated at the server side when an Agent is created
1478
+ * <p>The unique identifier of the agent.</p>
1426
1479
  * @public
1427
1480
  */
1428
1481
  agentId: string | undefined;
1429
1482
  /**
1430
- * Name for a resource.
1483
+ * <p>The name of the alias.</p>
1431
1484
  * @public
1432
1485
  */
1433
1486
  agentAliasName: string | undefined;
1434
1487
  /**
1435
- * Client specified token used for idempotency checks
1488
+ * <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,
1489
+ * 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>
1436
1490
  * @public
1437
1491
  */
1438
1492
  clientToken?: string;
1439
1493
  /**
1440
- * Description of the Resource.
1494
+ * <p>A description of the alias of the agent.</p>
1441
1495
  * @public
1442
1496
  */
1443
1497
  description?: string;
1444
1498
  /**
1445
- * Routing configuration for an Agent alias.
1499
+ * <p>Contains details about the routing configuration of the alias.</p>
1446
1500
  * @public
1447
1501
  */
1448
1502
  routingConfiguration?: AgentAliasRoutingConfigurationListItem[];
1449
1503
  /**
1450
- * A map of tag keys and values
1504
+ * <p>Any tags that you want to attach to the alias of the agent.</p>
1451
1505
  * @public
1452
1506
  */
1453
1507
  tags?: Record<string, string>;
1454
1508
  }
1455
1509
  /**
1456
- * Create Agent Alias Response
1457
1510
  * @public
1458
1511
  */
1459
1512
  export interface CreateAgentAliasResponse {
1460
1513
  /**
1461
- * Contains the information of an agent alias
1514
+ * <p>Contains details about the alias that was created.</p>
1462
1515
  * @public
1463
1516
  */
1464
1517
  agentAlias: AgentAlias | undefined;
1465
1518
  }
1466
1519
  /**
1467
- * Delete Agent Alias Request
1468
1520
  * @public
1469
1521
  */
1470
1522
  export interface DeleteAgentAliasRequest {
1471
1523
  /**
1472
- * Id generated at the server side when an Agent is created
1524
+ * <p>The unique identifier of the agent that the alias belongs to.</p>
1473
1525
  * @public
1474
1526
  */
1475
1527
  agentId: string | undefined;
1476
1528
  /**
1477
- * Id generated at the server side when an Agent Alias is created
1529
+ * <p>The unique identifier of the alias to delete.</p>
1478
1530
  * @public
1479
1531
  */
1480
1532
  agentAliasId: string | undefined;
1481
1533
  }
1482
1534
  /**
1483
- * Delete Agent Alias Response
1484
1535
  * @public
1485
1536
  */
1486
1537
  export interface DeleteAgentAliasResponse {
1487
1538
  /**
1488
- * Identifier for a resource.
1539
+ * <p>The unique identifier of the agent that the alias belongs to.</p>
1489
1540
  * @public
1490
1541
  */
1491
1542
  agentId: string | undefined;
1492
1543
  /**
1493
- * Id for an Agent Alias generated at the server side.
1544
+ * <p>The unique identifier of the alias that was deleted.</p>
1494
1545
  * @public
1495
1546
  */
1496
1547
  agentAliasId: string | undefined;
1497
1548
  /**
1498
- * The statuses an Agent Alias can be in.
1549
+ * <p>The status of the alias.</p>
1499
1550
  * @public
1500
1551
  */
1501
1552
  agentAliasStatus: AgentAliasStatus | undefined;
1502
1553
  }
1503
1554
  /**
1504
- * Get Agent Alias Request
1505
1555
  * @public
1506
1556
  */
1507
1557
  export interface GetAgentAliasRequest {
1508
1558
  /**
1509
- * Id generated at the server side when an Agent is created
1559
+ * <p>The unique identifier of the agent to which the alias to get information belongs.</p>
1510
1560
  * @public
1511
1561
  */
1512
1562
  agentId: string | undefined;
1513
1563
  /**
1514
- * Id generated at the server side when an Agent Alias is created
1564
+ * <p>The unique identifier of the alias for which to get information.</p>
1515
1565
  * @public
1516
1566
  */
1517
1567
  agentAliasId: string | undefined;
1518
1568
  }
1519
1569
  /**
1520
- * Get Agent Alias Response
1521
1570
  * @public
1522
1571
  */
1523
1572
  export interface GetAgentAliasResponse {
1524
1573
  /**
1525
- * Contains the information of an agent alias
1574
+ * <p>Contains information about the alias.</p>
1526
1575
  * @public
1527
1576
  */
1528
1577
  agentAlias: AgentAlias | undefined;
1529
1578
  }
1530
1579
  /**
1531
- * List Agent Aliases Request
1532
1580
  * @public
1533
1581
  */
1534
1582
  export interface ListAgentAliasesRequest {
1535
1583
  /**
1536
- * Id generated at the server side when an Agent is created
1584
+ * <p>The unique identifier of the agent.</p>
1537
1585
  * @public
1538
1586
  */
1539
1587
  agentId: string | undefined;
1540
1588
  /**
1541
- * Max Results.
1589
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
1542
1590
  * @public
1543
1591
  */
1544
1592
  maxResults?: number;
1545
1593
  /**
1546
- * Opaque continuation token of previous paginated response.
1594
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
1547
1595
  * @public
1548
1596
  */
1549
1597
  nextToken?: string;
1550
1598
  }
1551
1599
  /**
1552
- * List Agent Aliases Response
1553
1600
  * @public
1554
1601
  */
1555
1602
  export interface ListAgentAliasesResponse {
1556
1603
  /**
1557
- * The list of summaries of all the aliases for an Agent.
1604
+ * <p>A list of objects, each of which contains information about an alias of the agent.</p>
1558
1605
  * @public
1559
1606
  */
1560
1607
  agentAliasSummaries: AgentAliasSummary[] | undefined;
1561
1608
  /**
1562
- * Opaque continuation token of previous paginated response.
1609
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
1563
1610
  * @public
1564
1611
  */
1565
1612
  nextToken?: string;
1566
1613
  }
1567
1614
  /**
1568
- * Update Agent Alias Request
1569
1615
  * @public
1570
1616
  */
1571
1617
  export interface UpdateAgentAliasRequest {
1572
1618
  /**
1573
- * Id generated at the server side when an Agent is created
1619
+ * <p>The unique identifier of the agent.</p>
1574
1620
  * @public
1575
1621
  */
1576
1622
  agentId: string | undefined;
1577
1623
  /**
1578
- * Id generated at the server side when an Agent Alias is created
1624
+ * <p>The unique identifier of the alias.</p>
1579
1625
  * @public
1580
1626
  */
1581
1627
  agentAliasId: string | undefined;
1582
1628
  /**
1583
- * Name for a resource.
1629
+ * <p>Specifies a new name for the alias.</p>
1584
1630
  * @public
1585
1631
  */
1586
1632
  agentAliasName: string | undefined;
1587
1633
  /**
1588
- * Description of the Resource.
1634
+ * <p>Specifies a new description for the alias.</p>
1589
1635
  * @public
1590
1636
  */
1591
1637
  description?: string;
1592
1638
  /**
1593
- * Routing configuration for an Agent alias.
1639
+ * <p>Contains details about the routing configuration of the alias.</p>
1594
1640
  * @public
1595
1641
  */
1596
1642
  routingConfiguration?: AgentAliasRoutingConfigurationListItem[];
1597
1643
  }
1598
1644
  /**
1599
- * Update Agent Alias Response
1600
1645
  * @public
1601
1646
  */
1602
1647
  export interface UpdateAgentAliasResponse {
1603
1648
  /**
1604
- * Contains the information of an agent alias
1649
+ * <p>Contains details about the alias that was updated.</p>
1605
1650
  * @public
1606
1651
  */
1607
1652
  agentAlias: AgentAlias | undefined;
1608
1653
  }
1609
1654
  /**
1610
- * Configures an S3 data source location.
1655
+ * <p>Contains information about the S3 configuration of the data source.</p>
1611
1656
  * @public
1612
1657
  */
1613
1658
  export interface S3DataSourceConfiguration {
1614
1659
  /**
1615
- * A S3 bucket ARN
1660
+ * <p>The ARN of the bucket that contains the data source.</p>
1616
1661
  * @public
1617
1662
  */
1618
1663
  bucketArn: string | undefined;
1619
1664
  /**
1620
- * A list of S3 prefixes.
1665
+ * <p>A list of S3 prefixes that define the object containing the data sources. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a>.</p>
1621
1666
  * @public
1622
1667
  */
1623
1668
  inclusionPrefixes?: string[];
@@ -1634,28 +1679,28 @@ export declare const DataSourceType: {
1634
1679
  */
1635
1680
  export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType];
1636
1681
  /**
1637
- * Specifies a raw data source location to ingest.
1682
+ * <p>Contains details about how a data source is stored.</p>
1638
1683
  * @public
1639
1684
  */
1640
1685
  export interface DataSourceConfiguration {
1641
1686
  /**
1642
- * The type of the data source location.
1687
+ * <p>The type of storage for the data source.</p>
1643
1688
  * @public
1644
1689
  */
1645
1690
  type: DataSourceType | undefined;
1646
1691
  /**
1647
- * Configures an S3 data source location.
1692
+ * <p>Contains details about the configuration of the S3 object containing the data source.</p>
1648
1693
  * @public
1649
1694
  */
1650
1695
  s3Configuration?: S3DataSourceConfiguration;
1651
1696
  }
1652
1697
  /**
1653
- * Server-side encryption configuration.
1698
+ * <p>Contains the configuration for server-side encryption.</p>
1654
1699
  * @public
1655
1700
  */
1656
1701
  export interface ServerSideEncryptionConfiguration {
1657
1702
  /**
1658
- * A KMS key ARN
1703
+ * <p>The ARN of the KMS key used to encrypt the resource.</p>
1659
1704
  * @public
1660
1705
  */
1661
1706
  kmsKeyArn?: string;
@@ -1673,44 +1718,54 @@ export declare const ChunkingStrategy: {
1673
1718
  */
1674
1719
  export type ChunkingStrategy = (typeof ChunkingStrategy)[keyof typeof ChunkingStrategy];
1675
1720
  /**
1676
- * Configures fixed size chunking strategy
1721
+ * <p>Configurations for when you choose fixed-size chunking. If you set the <code>chunkingStrategy</code> as <code>NONE</code>, exclude this field.</p>
1677
1722
  * @public
1678
1723
  */
1679
1724
  export interface FixedSizeChunkingConfiguration {
1680
1725
  /**
1681
- * The maximum number of tokens per chunk.
1726
+ * <p>The maximum number of tokens to include in a chunk.</p>
1682
1727
  * @public
1683
1728
  */
1684
1729
  maxTokens: number | undefined;
1685
1730
  /**
1686
- * The overlap percentage between adjacent chunks.
1731
+ * <p>The percentage of overlap between adjacent chunks of a data source.</p>
1687
1732
  * @public
1688
1733
  */
1689
1734
  overlapPercentage: number | undefined;
1690
1735
  }
1691
1736
  /**
1692
- * Configures chunking strategy
1737
+ * <p>Details about how to chunk the documents in the data source. 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.</p>
1693
1738
  * @public
1694
1739
  */
1695
1740
  export interface ChunkingConfiguration {
1696
1741
  /**
1697
- * The type of chunking strategy
1742
+ * <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>
1743
+ * <ul>
1744
+ * <li>
1745
+ * <p>
1746
+ * <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>
1747
+ * </li>
1748
+ * <li>
1749
+ * <p>
1750
+ * <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>
1751
+ * </li>
1752
+ * </ul>
1698
1753
  * @public
1699
1754
  */
1700
1755
  chunkingStrategy: ChunkingStrategy | undefined;
1701
1756
  /**
1702
- * Configures fixed size chunking strategy
1757
+ * <p>Configurations for when you choose fixed-size chunking. If you set the <code>chunkingStrategy</code> as <code>NONE</code>, exclude this field.</p>
1703
1758
  * @public
1704
1759
  */
1705
1760
  fixedSizeChunkingConfiguration?: FixedSizeChunkingConfiguration;
1706
1761
  }
1707
1762
  /**
1708
- * Configures ingestion for a vector knowledge base
1763
+ * <p>Contains details about how to ingest the documents in a data source.</p>
1709
1764
  * @public
1710
1765
  */
1711
1766
  export interface VectorIngestionConfiguration {
1712
1767
  /**
1713
- * Configures chunking strategy
1768
+ * <p>Details about how to chunk the documents in the data source. 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.</p>
1714
1769
  * @public
1715
1770
  */
1716
1771
  chunkingConfiguration?: ChunkingConfiguration;
@@ -1720,37 +1775,38 @@ export interface VectorIngestionConfiguration {
1720
1775
  */
1721
1776
  export interface CreateDataSourceRequest {
1722
1777
  /**
1723
- * Identifier for a resource.
1778
+ * <p>The unique identifier of the knowledge base to which to add the data source.</p>
1724
1779
  * @public
1725
1780
  */
1726
1781
  knowledgeBaseId: string | undefined;
1727
1782
  /**
1728
- * Client specified token used for idempotency checks
1783
+ * <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,
1784
+ * 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>
1729
1785
  * @public
1730
1786
  */
1731
1787
  clientToken?: string;
1732
1788
  /**
1733
- * Name for a resource.
1789
+ * <p>The name of the data source.</p>
1734
1790
  * @public
1735
1791
  */
1736
1792
  name: string | undefined;
1737
1793
  /**
1738
- * Description of the Resource.
1794
+ * <p>A description of the data source.</p>
1739
1795
  * @public
1740
1796
  */
1741
1797
  description?: string;
1742
1798
  /**
1743
- * Specifies a raw data source location to ingest.
1799
+ * <p>Contains metadata about where the data source is stored.</p>
1744
1800
  * @public
1745
1801
  */
1746
1802
  dataSourceConfiguration: DataSourceConfiguration | undefined;
1747
1803
  /**
1748
- * Server-side encryption configuration.
1804
+ * <p>Contains details about the server-side encryption for the data source.</p>
1749
1805
  * @public
1750
1806
  */
1751
1807
  serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
1752
1808
  /**
1753
- * Configures ingestion for a vector knowledge base
1809
+ * <p>Contains details about how to ingest the documents in the data source.</p>
1754
1810
  * @public
1755
1811
  */
1756
1812
  vectorIngestionConfiguration?: VectorIngestionConfiguration;
@@ -1768,57 +1824,65 @@ export declare const DataSourceStatus: {
1768
1824
  */
1769
1825
  export type DataSourceStatus = (typeof DataSourceStatus)[keyof typeof DataSourceStatus];
1770
1826
  /**
1771
- * Contains the information of a data source.
1827
+ * <p>Contains details about a data source.</p>
1772
1828
  * @public
1773
1829
  */
1774
1830
  export interface DataSource {
1775
1831
  /**
1776
- * Identifier for a resource.
1832
+ * <p>The unique identifier of the knowledge base to which the data source belongs.</p>
1777
1833
  * @public
1778
1834
  */
1779
1835
  knowledgeBaseId: string | undefined;
1780
1836
  /**
1781
- * Identifier for a resource.
1837
+ * <p>The unique identifier of the data source.</p>
1782
1838
  * @public
1783
1839
  */
1784
1840
  dataSourceId: string | undefined;
1785
1841
  /**
1786
- * Name for a resource.
1842
+ * <p>The name of the data source.</p>
1787
1843
  * @public
1788
1844
  */
1789
1845
  name: string | undefined;
1790
1846
  /**
1791
- * The status of a data source.
1847
+ * <p>The status of the data source. The following statuses are possible:</p>
1848
+ * <ul>
1849
+ * <li>
1850
+ * <p>Available – The data source has been created and is ready for ingestion into the knowledge base.</p>
1851
+ * </li>
1852
+ * <li>
1853
+ * <p>Deleting – The data source is being deleted.</p>
1854
+ * </li>
1855
+ * </ul>
1792
1856
  * @public
1793
1857
  */
1794
1858
  status: DataSourceStatus | undefined;
1795
1859
  /**
1796
- * Description of the Resource.
1860
+ * <p>The description of the data source.</p>
1797
1861
  * @public
1798
1862
  */
1799
1863
  description?: string;
1800
1864
  /**
1801
- * Specifies a raw data source location to ingest.
1865
+ * <p>Contains details about how the data source is stored.</p>
1802
1866
  * @public
1803
1867
  */
1804
1868
  dataSourceConfiguration: DataSourceConfiguration | undefined;
1805
1869
  /**
1806
- * Server-side encryption configuration.
1870
+ * <p>Contains details about the configuration of the server-side encryption.</p>
1807
1871
  * @public
1808
1872
  */
1809
1873
  serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
1810
1874
  /**
1811
- * Configures ingestion for a vector knowledge base
1875
+ * <p>Contains details about how to ingest the documents in the data source.</p>
1812
1876
  * @public
1813
1877
  */
1814
1878
  vectorIngestionConfiguration?: VectorIngestionConfiguration;
1815
1879
  /**
1816
- * Time Stamp.
1880
+ * <p>The time at which the data source was created.</p>
1817
1881
  * @public
1818
1882
  */
1819
1883
  createdAt: Date | undefined;
1820
1884
  /**
1821
- * Time Stamp.
1885
+ * <p>The time at which the data source was last updated.</p>
1822
1886
  * @public
1823
1887
  */
1824
1888
  updatedAt: Date | undefined;
@@ -1828,7 +1892,7 @@ export interface DataSource {
1828
1892
  */
1829
1893
  export interface CreateDataSourceResponse {
1830
1894
  /**
1831
- * Contains the information of a data source.
1895
+ * <p>Contains details about the data source.</p>
1832
1896
  * @public
1833
1897
  */
1834
1898
  dataSource: DataSource | undefined;
@@ -1838,12 +1902,12 @@ export interface CreateDataSourceResponse {
1838
1902
  */
1839
1903
  export interface DeleteDataSourceRequest {
1840
1904
  /**
1841
- * Identifier for a resource.
1905
+ * <p>The unique identifier of the knowledge base from which to delete the data source.</p>
1842
1906
  * @public
1843
1907
  */
1844
1908
  knowledgeBaseId: string | undefined;
1845
1909
  /**
1846
- * Identifier for a resource.
1910
+ * <p>The unique identifier of the data source to delete.</p>
1847
1911
  * @public
1848
1912
  */
1849
1913
  dataSourceId: string | undefined;
@@ -1853,17 +1917,17 @@ export interface DeleteDataSourceRequest {
1853
1917
  */
1854
1918
  export interface DeleteDataSourceResponse {
1855
1919
  /**
1856
- * Identifier for a resource.
1920
+ * <p>The unique identifier of the knowledge base to which the data source that was deleted belonged.</p>
1857
1921
  * @public
1858
1922
  */
1859
1923
  knowledgeBaseId: string | undefined;
1860
1924
  /**
1861
- * Identifier for a resource.
1925
+ * <p>The unique identifier of the data source that was deleted.</p>
1862
1926
  * @public
1863
1927
  */
1864
1928
  dataSourceId: string | undefined;
1865
1929
  /**
1866
- * The status of a data source.
1930
+ * <p>The status of the data source.</p>
1867
1931
  * @public
1868
1932
  */
1869
1933
  status: DataSourceStatus | undefined;
@@ -1873,12 +1937,12 @@ export interface DeleteDataSourceResponse {
1873
1937
  */
1874
1938
  export interface GetDataSourceRequest {
1875
1939
  /**
1876
- * Identifier for a resource.
1940
+ * <p>The unique identifier of the knowledge base that the data source was added to.</p>
1877
1941
  * @public
1878
1942
  */
1879
1943
  knowledgeBaseId: string | undefined;
1880
1944
  /**
1881
- * Identifier for a resource.
1945
+ * <p>The unique identifier of the data source.</p>
1882
1946
  * @public
1883
1947
  */
1884
1948
  dataSourceId: string | undefined;
@@ -1888,7 +1952,7 @@ export interface GetDataSourceRequest {
1888
1952
  */
1889
1953
  export interface GetDataSourceResponse {
1890
1954
  /**
1891
- * Contains the information of a data source.
1955
+ * <p>Contains details about the data source.</p>
1892
1956
  * @public
1893
1957
  */
1894
1958
  dataSource: DataSource | undefined;
@@ -1898,53 +1962,53 @@ export interface GetDataSourceResponse {
1898
1962
  */
1899
1963
  export interface ListDataSourcesRequest {
1900
1964
  /**
1901
- * Identifier for a resource.
1965
+ * <p>The unique identifier of the knowledge base for which to return a list of information.</p>
1902
1966
  * @public
1903
1967
  */
1904
1968
  knowledgeBaseId: string | undefined;
1905
1969
  /**
1906
- * Max Results.
1970
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
1907
1971
  * @public
1908
1972
  */
1909
1973
  maxResults?: number;
1910
1974
  /**
1911
- * Opaque continuation token of previous paginated response.
1975
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
1912
1976
  * @public
1913
1977
  */
1914
1978
  nextToken?: string;
1915
1979
  }
1916
1980
  /**
1917
- * Summary information of a data source.
1981
+ * <p>Contains details about a data source.</p>
1918
1982
  * @public
1919
1983
  */
1920
1984
  export interface DataSourceSummary {
1921
1985
  /**
1922
- * Identifier for a resource.
1986
+ * <p>The unique identifier of the knowledge base to which the data source belongs.</p>
1923
1987
  * @public
1924
1988
  */
1925
1989
  knowledgeBaseId: string | undefined;
1926
1990
  /**
1927
- * Identifier for a resource.
1991
+ * <p>The unique identifier of the data source.</p>
1928
1992
  * @public
1929
1993
  */
1930
1994
  dataSourceId: string | undefined;
1931
1995
  /**
1932
- * Name for a resource.
1996
+ * <p>The name of the data source.</p>
1933
1997
  * @public
1934
1998
  */
1935
1999
  name: string | undefined;
1936
2000
  /**
1937
- * The status of a data source.
2001
+ * <p>The status of the data source.</p>
1938
2002
  * @public
1939
2003
  */
1940
2004
  status: DataSourceStatus | undefined;
1941
2005
  /**
1942
- * Description of the Resource.
2006
+ * <p>The description of the data source.</p>
1943
2007
  * @public
1944
2008
  */
1945
2009
  description?: string;
1946
2010
  /**
1947
- * Time Stamp.
2011
+ * <p>The time at which the data source was last updated.</p>
1948
2012
  * @public
1949
2013
  */
1950
2014
  updatedAt: Date | undefined;
@@ -1954,12 +2018,12 @@ export interface DataSourceSummary {
1954
2018
  */
1955
2019
  export interface ListDataSourcesResponse {
1956
2020
  /**
1957
- * list of data source summaries
2021
+ * <p>A list of objects, each of which contains information about a data source.</p>
1958
2022
  * @public
1959
2023
  */
1960
2024
  dataSourceSummaries: DataSourceSummary[] | undefined;
1961
2025
  /**
1962
- * Opaque continuation token of previous paginated response.
2026
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
1963
2027
  * @public
1964
2028
  */
1965
2029
  nextToken?: string;
@@ -1969,37 +2033,37 @@ export interface ListDataSourcesResponse {
1969
2033
  */
1970
2034
  export interface UpdateDataSourceRequest {
1971
2035
  /**
1972
- * Identifier for a resource.
2036
+ * <p>The unique identifier of the knowledge base to which the data source belongs.</p>
1973
2037
  * @public
1974
2038
  */
1975
2039
  knowledgeBaseId: string | undefined;
1976
2040
  /**
1977
- * Identifier for a resource.
2041
+ * <p>The unique identifier of the data source.</p>
1978
2042
  * @public
1979
2043
  */
1980
2044
  dataSourceId: string | undefined;
1981
2045
  /**
1982
- * Name for a resource.
2046
+ * <p>Specifies a new name for the data source.</p>
1983
2047
  * @public
1984
2048
  */
1985
2049
  name: string | undefined;
1986
2050
  /**
1987
- * Description of the Resource.
2051
+ * <p>Specifies a new description for the data source.</p>
1988
2052
  * @public
1989
2053
  */
1990
2054
  description?: string;
1991
2055
  /**
1992
- * Specifies a raw data source location to ingest.
2056
+ * <p>Contains details about the storage configuration of the data source.</p>
1993
2057
  * @public
1994
2058
  */
1995
2059
  dataSourceConfiguration: DataSourceConfiguration | undefined;
1996
2060
  /**
1997
- * Server-side encryption configuration.
2061
+ * <p>Contains details about server-side encryption of the data source.</p>
1998
2062
  * @public
1999
2063
  */
2000
2064
  serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
2001
2065
  /**
2002
- * Configures ingestion for a vector knowledge base
2066
+ * <p>Contains details about how to ingest the documents in the data source.</p>
2003
2067
  * @public
2004
2068
  */
2005
2069
  vectorIngestionConfiguration?: VectorIngestionConfiguration;
@@ -2009,7 +2073,7 @@ export interface UpdateDataSourceRequest {
2009
2073
  */
2010
2074
  export interface UpdateDataSourceResponse {
2011
2075
  /**
2012
- * Contains the information of a data source.
2076
+ * <p>Contains details about the data source.</p>
2013
2077
  * @public
2014
2078
  */
2015
2079
  dataSource: DataSource | undefined;
@@ -2019,48 +2083,58 @@ export interface UpdateDataSourceResponse {
2019
2083
  */
2020
2084
  export interface GetIngestionJobRequest {
2021
2085
  /**
2022
- * Identifier for a resource.
2086
+ * <p>The unique identifier of the knowledge base for which the ingestion job applies.</p>
2023
2087
  * @public
2024
2088
  */
2025
2089
  knowledgeBaseId: string | undefined;
2026
2090
  /**
2027
- * Identifier for a resource.
2091
+ * <p>The unique identifier of the data source in the ingestion job.</p>
2028
2092
  * @public
2029
2093
  */
2030
2094
  dataSourceId: string | undefined;
2031
2095
  /**
2032
- * Identifier for a resource.
2096
+ * <p>The unique identifier of the ingestion job.</p>
2033
2097
  * @public
2034
2098
  */
2035
2099
  ingestionJobId: string | undefined;
2036
2100
  }
2037
2101
  /**
2038
- * The document level statistics of an ingestion job
2102
+ * <p>Contains the statistics for the ingestion job.</p>
2039
2103
  * @public
2040
2104
  */
2041
2105
  export interface IngestionJobStatistics {
2042
2106
  /**
2043
- * Number of scanned documents
2107
+ * <p>The total number of source documents that were scanned. Includes new, updated, and unchanged documents.</p>
2044
2108
  * @public
2045
2109
  */
2046
2110
  numberOfDocumentsScanned?: number;
2047
2111
  /**
2048
- * Number of indexed documents
2112
+ * <p>The total number of metadata files that were scanned. Includes new, updated, and unchanged files.</p>
2113
+ * @public
2114
+ */
2115
+ numberOfMetadataDocumentsScanned?: number;
2116
+ /**
2117
+ * <p>The number of new source documents in the data source that were successfully indexed.</p>
2049
2118
  * @public
2050
2119
  */
2051
2120
  numberOfNewDocumentsIndexed?: number;
2052
2121
  /**
2053
- * Number of modified documents indexed
2122
+ * <p>The number of modified source documents in the data source that were successfully indexed.</p>
2054
2123
  * @public
2055
2124
  */
2056
2125
  numberOfModifiedDocumentsIndexed?: number;
2057
2126
  /**
2058
- * Number of deleted documents
2127
+ * <p>The number of metadata files that were updated or deleted.</p>
2128
+ * @public
2129
+ */
2130
+ numberOfMetadataDocumentsModified?: number;
2131
+ /**
2132
+ * <p>The number of source documents that was deleted.</p>
2059
2133
  * @public
2060
2134
  */
2061
2135
  numberOfDocumentsDeleted?: number;
2062
2136
  /**
2063
- * Number of failed documents
2137
+ * <p>The number of source documents that failed to be ingested.</p>
2064
2138
  * @public
2065
2139
  */
2066
2140
  numberOfDocumentsFailed?: number;
@@ -2080,52 +2154,70 @@ export declare const IngestionJobStatus: {
2080
2154
  */
2081
2155
  export type IngestionJobStatus = (typeof IngestionJobStatus)[keyof typeof IngestionJobStatus];
2082
2156
  /**
2083
- * Contains the information of an ingestion job.
2157
+ * <p>Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.</p>
2158
+ * <p>This data type is used in the following API operations:</p>
2159
+ * <ul>
2160
+ * <li>
2161
+ * <p>
2162
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_StartIngestionJob.html#API_agent_StartIngestionJob_ResponseSyntax">StartIngestionJob response</a>
2163
+ * </p>
2164
+ * </li>
2165
+ * <li>
2166
+ * <p>
2167
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetIngestionJob.html#API_agent_GetIngestionJob_ResponseSyntax">GetIngestionJob response</a>
2168
+ * </p>
2169
+ * </li>
2170
+ * <li>
2171
+ * <p>
2172
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJob.html#API_agent_ListIngestionJob_ResponseSyntax">ListIngestionJob response</a>
2173
+ * </p>
2174
+ * </li>
2175
+ * </ul>
2084
2176
  * @public
2085
2177
  */
2086
2178
  export interface IngestionJob {
2087
2179
  /**
2088
- * Identifier for a resource.
2180
+ * <p>The unique identifier of the knowledge base to which the data source is being added.</p>
2089
2181
  * @public
2090
2182
  */
2091
2183
  knowledgeBaseId: string | undefined;
2092
2184
  /**
2093
- * Identifier for a resource.
2185
+ * <p>The unique identifier of the ingested data source.</p>
2094
2186
  * @public
2095
2187
  */
2096
2188
  dataSourceId: string | undefined;
2097
2189
  /**
2098
- * Identifier for a resource.
2190
+ * <p>The unique identifier of the ingestion job.</p>
2099
2191
  * @public
2100
2192
  */
2101
2193
  ingestionJobId: string | undefined;
2102
2194
  /**
2103
- * Description of the Resource.
2195
+ * <p>The description of the ingestion job.</p>
2104
2196
  * @public
2105
2197
  */
2106
2198
  description?: string;
2107
2199
  /**
2108
- * The status of an ingestion job.
2200
+ * <p>The status of the ingestion job.</p>
2109
2201
  * @public
2110
2202
  */
2111
2203
  status: IngestionJobStatus | undefined;
2112
2204
  /**
2113
- * The document level statistics of an ingestion job
2205
+ * <p>Contains statistics about the ingestion job.</p>
2114
2206
  * @public
2115
2207
  */
2116
2208
  statistics?: IngestionJobStatistics;
2117
2209
  /**
2118
- * Failure Reasons for Error.
2210
+ * <p>A list of reasons that the ingestion job failed.</p>
2119
2211
  * @public
2120
2212
  */
2121
2213
  failureReasons?: string[];
2122
2214
  /**
2123
- * Time Stamp.
2215
+ * <p>The time at which the ingestion job started.</p>
2124
2216
  * @public
2125
2217
  */
2126
2218
  startedAt: Date | undefined;
2127
2219
  /**
2128
- * Time Stamp.
2220
+ * <p>The time at which the ingestion job was last updated.</p>
2129
2221
  * @public
2130
2222
  */
2131
2223
  updatedAt: Date | undefined;
@@ -2135,7 +2227,7 @@ export interface IngestionJob {
2135
2227
  */
2136
2228
  export interface GetIngestionJobResponse {
2137
2229
  /**
2138
- * Contains the information of an ingestion job.
2230
+ * <p>Contains details about the ingestion job.</p>
2139
2231
  * @public
2140
2232
  */
2141
2233
  ingestionJob: IngestionJob | undefined;
@@ -2163,22 +2255,22 @@ export declare const IngestionJobFilterOperator: {
2163
2255
  */
2164
2256
  export type IngestionJobFilterOperator = (typeof IngestionJobFilterOperator)[keyof typeof IngestionJobFilterOperator];
2165
2257
  /**
2166
- * Filters the response returned by ListIngestionJobs operation.
2258
+ * <p>Defines a filter by which to filter the results.</p>
2167
2259
  * @public
2168
2260
  */
2169
2261
  export interface IngestionJobFilter {
2170
2262
  /**
2171
- * The name of the field to filter ingestion jobs.
2263
+ * <p>The attribute by which to filter the results.</p>
2172
2264
  * @public
2173
2265
  */
2174
2266
  attribute: IngestionJobFilterAttribute | undefined;
2175
2267
  /**
2176
- * The operator used to filter ingestion jobs.
2268
+ * <p>The operation to carry out between the attribute and the values.</p>
2177
2269
  * @public
2178
2270
  */
2179
2271
  operator: IngestionJobFilterOperator | undefined;
2180
2272
  /**
2181
- * The list of values used to filter ingestion jobs.
2273
+ * <p>A list of values for the attribute.</p>
2182
2274
  * @public
2183
2275
  */
2184
2276
  values: string[] | undefined;
@@ -2208,17 +2300,17 @@ export declare const SortOrder: {
2208
2300
  */
2209
2301
  export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
2210
2302
  /**
2211
- * Sorts the response returned by ListIngestionJobs operation.
2303
+ * <p>Parameters by which to sort the results.</p>
2212
2304
  * @public
2213
2305
  */
2214
2306
  export interface IngestionJobSortBy {
2215
2307
  /**
2216
- * The name of the field to sort ingestion jobs.
2308
+ * <p>The attribute by which to sort the results.</p>
2217
2309
  * @public
2218
2310
  */
2219
2311
  attribute: IngestionJobSortByAttribute | undefined;
2220
2312
  /**
2221
- * Order to sort results by.
2313
+ * <p>The order by which to sort the results.</p>
2222
2314
  * @public
2223
2315
  */
2224
2316
  order: SortOrder | undefined;
@@ -2228,78 +2320,78 @@ export interface IngestionJobSortBy {
2228
2320
  */
2229
2321
  export interface ListIngestionJobsRequest {
2230
2322
  /**
2231
- * Identifier for a resource.
2323
+ * <p>The unique identifier of the knowledge base for which to return ingestion jobs.</p>
2232
2324
  * @public
2233
2325
  */
2234
2326
  knowledgeBaseId: string | undefined;
2235
2327
  /**
2236
- * Identifier for a resource.
2328
+ * <p>The unique identifier of the data source for which to return ingestion jobs.</p>
2237
2329
  * @public
2238
2330
  */
2239
2331
  dataSourceId: string | undefined;
2240
2332
  /**
2241
- * List of IngestionJobFilters
2333
+ * <p>Contains a definition of a filter for which to filter the results.</p>
2242
2334
  * @public
2243
2335
  */
2244
2336
  filters?: IngestionJobFilter[];
2245
2337
  /**
2246
- * Sorts the response returned by ListIngestionJobs operation.
2338
+ * <p>Contains details about how to sort the results.</p>
2247
2339
  * @public
2248
2340
  */
2249
2341
  sortBy?: IngestionJobSortBy;
2250
2342
  /**
2251
- * Max Results.
2343
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
2252
2344
  * @public
2253
2345
  */
2254
2346
  maxResults?: number;
2255
2347
  /**
2256
- * Opaque continuation token of previous paginated response.
2348
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
2257
2349
  * @public
2258
2350
  */
2259
2351
  nextToken?: string;
2260
2352
  }
2261
2353
  /**
2262
- * Summary information of an ingestion job.
2354
+ * <p>Contains details about an ingestion job.</p>
2263
2355
  * @public
2264
2356
  */
2265
2357
  export interface IngestionJobSummary {
2266
2358
  /**
2267
- * Identifier for a resource.
2359
+ * <p>The unique identifier of the knowledge base to which the data source is added.</p>
2268
2360
  * @public
2269
2361
  */
2270
2362
  knowledgeBaseId: string | undefined;
2271
2363
  /**
2272
- * Identifier for a resource.
2364
+ * <p>The unique identifier of the data source in the ingestion job.</p>
2273
2365
  * @public
2274
2366
  */
2275
2367
  dataSourceId: string | undefined;
2276
2368
  /**
2277
- * Identifier for a resource.
2369
+ * <p>The unique identifier of the ingestion job.</p>
2278
2370
  * @public
2279
2371
  */
2280
2372
  ingestionJobId: string | undefined;
2281
2373
  /**
2282
- * Description of the Resource.
2374
+ * <p>The description of the ingestion job.</p>
2283
2375
  * @public
2284
2376
  */
2285
2377
  description?: string;
2286
2378
  /**
2287
- * The status of an ingestion job.
2379
+ * <p>The status of the ingestion job.</p>
2288
2380
  * @public
2289
2381
  */
2290
2382
  status: IngestionJobStatus | undefined;
2291
2383
  /**
2292
- * Time Stamp.
2384
+ * <p>The time at which the ingestion job was started.</p>
2293
2385
  * @public
2294
2386
  */
2295
2387
  startedAt: Date | undefined;
2296
2388
  /**
2297
- * Time Stamp.
2389
+ * <p>The time at which the ingestion job was last updated.</p>
2298
2390
  * @public
2299
2391
  */
2300
2392
  updatedAt: Date | undefined;
2301
2393
  /**
2302
- * The document level statistics of an ingestion job
2394
+ * <p>Contains statistics for the ingestion job.</p>
2303
2395
  * @public
2304
2396
  */
2305
2397
  statistics?: IngestionJobStatistics;
@@ -2309,12 +2401,12 @@ export interface IngestionJobSummary {
2309
2401
  */
2310
2402
  export interface ListIngestionJobsResponse {
2311
2403
  /**
2312
- * List of IngestionJobSummaries
2404
+ * <p>A list of objects, each of which contains information about an ingestion job.</p>
2313
2405
  * @public
2314
2406
  */
2315
2407
  ingestionJobSummaries: IngestionJobSummary[] | undefined;
2316
2408
  /**
2317
- * Opaque continuation token of previous paginated response.
2409
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
2318
2410
  * @public
2319
2411
  */
2320
2412
  nextToken?: string;
@@ -2324,22 +2416,23 @@ export interface ListIngestionJobsResponse {
2324
2416
  */
2325
2417
  export interface StartIngestionJobRequest {
2326
2418
  /**
2327
- * Identifier for a resource.
2419
+ * <p>The unique identifier of the knowledge base to which to add the data source.</p>
2328
2420
  * @public
2329
2421
  */
2330
2422
  knowledgeBaseId: string | undefined;
2331
2423
  /**
2332
- * Identifier for a resource.
2424
+ * <p>The unique identifier of the data source to ingest.</p>
2333
2425
  * @public
2334
2426
  */
2335
2427
  dataSourceId: string | undefined;
2336
2428
  /**
2337
- * Client specified token used for idempotency checks
2429
+ * <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,
2430
+ * 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>
2338
2431
  * @public
2339
2432
  */
2340
2433
  clientToken?: string;
2341
2434
  /**
2342
- * Description of the Resource.
2435
+ * <p>A description of the ingestion job.</p>
2343
2436
  * @public
2344
2437
  */
2345
2438
  description?: string;
@@ -2349,49 +2442,47 @@ export interface StartIngestionJobRequest {
2349
2442
  */
2350
2443
  export interface StartIngestionJobResponse {
2351
2444
  /**
2352
- * Contains the information of an ingestion job.
2445
+ * <p>An object containing information about the ingestion job.</p>
2353
2446
  * @public
2354
2447
  */
2355
2448
  ingestionJob: IngestionJob | undefined;
2356
2449
  }
2357
2450
  /**
2358
- * Associate Agent Knowledge Base Request
2359
2451
  * @public
2360
2452
  */
2361
2453
  export interface AssociateAgentKnowledgeBaseRequest {
2362
2454
  /**
2363
- * Id generated at the server side when an Agent is created
2455
+ * <p>The unique identifier of the agent with which you want to associate the knowledge base.</p>
2364
2456
  * @public
2365
2457
  */
2366
2458
  agentId: string | undefined;
2367
2459
  /**
2368
- * Draft Version of the Agent.
2460
+ * <p>The version of the agent with which you want to associate the knowledge base.</p>
2369
2461
  * @public
2370
2462
  */
2371
2463
  agentVersion: string | undefined;
2372
2464
  /**
2373
- * Identifier for a resource.
2465
+ * <p>The unique identifier of the knowledge base to associate with the agent.</p>
2374
2466
  * @public
2375
2467
  */
2376
2468
  knowledgeBaseId: string | undefined;
2377
2469
  /**
2378
- * Description of the Resource.
2470
+ * <p>A description of what the agent should use the knowledge base for.</p>
2379
2471
  * @public
2380
2472
  */
2381
2473
  description: string | undefined;
2382
2474
  /**
2383
- * State of the knowledge base; whether it is enabled or disabled
2475
+ * <p>Specifies whether to use the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
2384
2476
  * @public
2385
2477
  */
2386
2478
  knowledgeBaseState?: KnowledgeBaseState;
2387
2479
  }
2388
2480
  /**
2389
- * Associate Agent Knowledge Base Response
2390
2481
  * @public
2391
2482
  */
2392
2483
  export interface AssociateAgentKnowledgeBaseResponse {
2393
2484
  /**
2394
- * Contains the information of an Agent Knowledge Base.
2485
+ * <p>Contains details about the knowledge base that has been associated with the agent.</p>
2395
2486
  * @public
2396
2487
  */
2397
2488
  agentKnowledgeBase: AgentKnowledgeBase | undefined;
@@ -2408,216 +2499,216 @@ export declare const KnowledgeBaseType: {
2408
2499
  */
2409
2500
  export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType];
2410
2501
  /**
2411
- * Configurations for a vector knowledge base.
2502
+ * <p>Contains details about the model used to create vector embeddings for the knowledge base.</p>
2412
2503
  * @public
2413
2504
  */
2414
2505
  export interface VectorKnowledgeBaseConfiguration {
2415
2506
  /**
2416
- * Arn of a Bedrock model.
2507
+ * <p>The ARN of the model used to create vector embeddings for the knowledge base.</p>
2417
2508
  * @public
2418
2509
  */
2419
2510
  embeddingModelArn: string | undefined;
2420
2511
  }
2421
2512
  /**
2422
- * Configures a bedrock knowledge base.
2513
+ * <p>Contains details about the embeddings configuration of the knowledge base.</p>
2423
2514
  * @public
2424
2515
  */
2425
2516
  export interface KnowledgeBaseConfiguration {
2426
2517
  /**
2427
- * The type of a knowledge base.
2518
+ * <p>The type of data that the data source is converted into for the knowledge base.</p>
2428
2519
  * @public
2429
2520
  */
2430
2521
  type: KnowledgeBaseType | undefined;
2431
2522
  /**
2432
- * Configurations for a vector knowledge base.
2523
+ * <p>Contains details about the embeddings model that'sused to convert the data source.</p>
2433
2524
  * @public
2434
2525
  */
2435
2526
  vectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration;
2436
2527
  }
2437
2528
  /**
2438
- * A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names
2529
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
2439
2530
  * @public
2440
2531
  */
2441
2532
  export interface OpenSearchServerlessFieldMapping {
2442
2533
  /**
2443
- * Name of the field
2534
+ * <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
2444
2535
  * @public
2445
2536
  */
2446
2537
  vectorField: string | undefined;
2447
2538
  /**
2448
- * Name of the field
2539
+ * <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
2449
2540
  * @public
2450
2541
  */
2451
2542
  textField: string | undefined;
2452
2543
  /**
2453
- * Name of the field
2544
+ * <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
2454
2545
  * @public
2455
2546
  */
2456
2547
  metadataField: string | undefined;
2457
2548
  }
2458
2549
  /**
2459
- * Contains the configurations to use OpenSearch Serverless to store knowledge base data.
2550
+ * <p>Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html">Create a vector index in Amazon OpenSearch Service</a>.</p>
2460
2551
  * @public
2461
2552
  */
2462
2553
  export interface OpenSearchServerlessConfiguration {
2463
2554
  /**
2464
- * Arn of an OpenSearch Serverless collection.
2555
+ * <p>The ARN of the OpenSearch Service vector store.</p>
2465
2556
  * @public
2466
2557
  */
2467
2558
  collectionArn: string | undefined;
2468
2559
  /**
2469
- * Arn of an OpenSearch Serverless index.
2560
+ * <p>The name of the vector store.</p>
2470
2561
  * @public
2471
2562
  */
2472
2563
  vectorIndexName: string | undefined;
2473
2564
  /**
2474
- * A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names
2565
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
2475
2566
  * @public
2476
2567
  */
2477
2568
  fieldMapping: OpenSearchServerlessFieldMapping | undefined;
2478
2569
  }
2479
2570
  /**
2480
- * A mapping of Bedrock Knowledge Base fields to Pinecone field names
2571
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
2481
2572
  * @public
2482
2573
  */
2483
2574
  export interface PineconeFieldMapping {
2484
2575
  /**
2485
- * Name of the field
2576
+ * <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
2486
2577
  * @public
2487
2578
  */
2488
2579
  textField: string | undefined;
2489
2580
  /**
2490
- * Name of the field
2581
+ * <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
2491
2582
  * @public
2492
2583
  */
2493
2584
  metadataField: string | undefined;
2494
2585
  }
2495
2586
  /**
2496
- * Contains the configurations to use Pinecone to store knowledge base data.
2587
+ * <p>Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html">Create a vector index in Pinecone</a>.</p>
2497
2588
  * @public
2498
2589
  */
2499
2590
  export interface PineconeConfiguration {
2500
2591
  /**
2501
- * Pinecone connection string
2592
+ * <p>The endpoint URL for your index management page.</p>
2502
2593
  * @public
2503
2594
  */
2504
2595
  connectionString: string | undefined;
2505
2596
  /**
2506
- * Arn of a SecretsManager Secret.
2597
+ * <p>The ARN of the secret that you created in Secrets Manager that is linked to your Pinecone API key.</p>
2507
2598
  * @public
2508
2599
  */
2509
2600
  credentialsSecretArn: string | undefined;
2510
2601
  /**
2511
- * Pinecone namespace
2602
+ * <p>The namespace to be used to write new data to your database.</p>
2512
2603
  * @public
2513
2604
  */
2514
2605
  namespace?: string;
2515
2606
  /**
2516
- * A mapping of Bedrock Knowledge Base fields to Pinecone field names
2607
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
2517
2608
  * @public
2518
2609
  */
2519
2610
  fieldMapping: PineconeFieldMapping | undefined;
2520
2611
  }
2521
2612
  /**
2522
- * A mapping of Bedrock Knowledge Base fields to RDS column names
2613
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
2523
2614
  * @public
2524
2615
  */
2525
2616
  export interface RdsFieldMapping {
2526
2617
  /**
2527
- * Name of the column
2618
+ * <p>The name of the field in which Amazon Bedrock stores the ID for each entry.</p>
2528
2619
  * @public
2529
2620
  */
2530
2621
  primaryKeyField: string | undefined;
2531
2622
  /**
2532
- * Name of the column
2623
+ * <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
2533
2624
  * @public
2534
2625
  */
2535
2626
  vectorField: string | undefined;
2536
2627
  /**
2537
- * Name of the column
2628
+ * <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
2538
2629
  * @public
2539
2630
  */
2540
2631
  textField: string | undefined;
2541
2632
  /**
2542
- * Name of the column
2633
+ * <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
2543
2634
  * @public
2544
2635
  */
2545
2636
  metadataField: string | undefined;
2546
2637
  }
2547
2638
  /**
2548
- * Contains the configurations to use RDS to store knowledge base data.
2639
+ * <p>Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html">Create a vector index in Amazon RDS</a>.</p>
2549
2640
  * @public
2550
2641
  */
2551
2642
  export interface RdsConfiguration {
2552
2643
  /**
2553
- * Arn of a RDS Resource.
2644
+ * <p>The ARN of the vector store.</p>
2554
2645
  * @public
2555
2646
  */
2556
2647
  resourceArn: string | undefined;
2557
2648
  /**
2558
- * Arn of a SecretsManager Secret.
2649
+ * <p>The ARN of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.</p>
2559
2650
  * @public
2560
2651
  */
2561
2652
  credentialsSecretArn: string | undefined;
2562
2653
  /**
2563
- * Name of the database within RDS
2654
+ * <p>The name of your Amazon RDS database.</p>
2564
2655
  * @public
2565
2656
  */
2566
2657
  databaseName: string | undefined;
2567
2658
  /**
2568
- * Name of the table within RDS
2659
+ * <p>The name of the table in the database.</p>
2569
2660
  * @public
2570
2661
  */
2571
2662
  tableName: string | undefined;
2572
2663
  /**
2573
- * A mapping of Bedrock Knowledge Base fields to RDS column names
2664
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
2574
2665
  * @public
2575
2666
  */
2576
2667
  fieldMapping: RdsFieldMapping | undefined;
2577
2668
  }
2578
2669
  /**
2579
- * A mapping of Bedrock Knowledge Base fields to Redis Cloud field names
2670
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
2580
2671
  * @public
2581
2672
  */
2582
2673
  export interface RedisEnterpriseCloudFieldMapping {
2583
2674
  /**
2584
- * Name of the field
2675
+ * <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
2585
2676
  * @public
2586
2677
  */
2587
2678
  vectorField: string | undefined;
2588
2679
  /**
2589
- * Name of the field
2680
+ * <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
2590
2681
  * @public
2591
2682
  */
2592
2683
  textField: string | undefined;
2593
2684
  /**
2594
- * Name of the field
2685
+ * <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
2595
2686
  * @public
2596
2687
  */
2597
2688
  metadataField: string | undefined;
2598
2689
  }
2599
2690
  /**
2600
- * Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.
2691
+ * <p>Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html">Create a vector index in Redis Enterprise Cloud</a>.</p>
2601
2692
  * @public
2602
2693
  */
2603
2694
  export interface RedisEnterpriseCloudConfiguration {
2604
2695
  /**
2605
- * Redis enterprise cloud endpoint
2696
+ * <p>The endpoint URL of the Redis Enterprise Cloud database.</p>
2606
2697
  * @public
2607
2698
  */
2608
2699
  endpoint: string | undefined;
2609
2700
  /**
2610
- * Name of a redis enterprise cloud index
2701
+ * <p>The name of the vector index.</p>
2611
2702
  * @public
2612
2703
  */
2613
2704
  vectorIndexName: string | undefined;
2614
2705
  /**
2615
- * Arn of a SecretsManager Secret.
2706
+ * <p>The ARN of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.</p>
2616
2707
  * @public
2617
2708
  */
2618
2709
  credentialsSecretArn: string | undefined;
2619
2710
  /**
2620
- * A mapping of Bedrock Knowledge Base fields to Redis Cloud field names
2711
+ * <p>Contains the names of the fields to which to map information about the vector store.</p>
2621
2712
  * @public
2622
2713
  */
2623
2714
  fieldMapping: RedisEnterpriseCloudFieldMapping | undefined;
@@ -2637,32 +2728,32 @@ export declare const KnowledgeBaseStorageType: {
2637
2728
  */
2638
2729
  export type KnowledgeBaseStorageType = (typeof KnowledgeBaseStorageType)[keyof typeof KnowledgeBaseStorageType];
2639
2730
  /**
2640
- * Configures the physical storage of ingested data in a knowledge base.
2731
+ * <p>Contains the storage configuration of the knowledge base.</p>
2641
2732
  * @public
2642
2733
  */
2643
2734
  export interface StorageConfiguration {
2644
2735
  /**
2645
- * The storage type of a knowledge base.
2736
+ * <p>The vector store service in which the knowledge base is stored.</p>
2646
2737
  * @public
2647
2738
  */
2648
2739
  type: KnowledgeBaseStorageType | undefined;
2649
2740
  /**
2650
- * Contains the configurations to use OpenSearch Serverless to store knowledge base data.
2741
+ * <p>Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.</p>
2651
2742
  * @public
2652
2743
  */
2653
2744
  opensearchServerlessConfiguration?: OpenSearchServerlessConfiguration;
2654
2745
  /**
2655
- * Contains the configurations to use Pinecone to store knowledge base data.
2746
+ * <p>Contains the storage configuration of the knowledge base in Pinecone.</p>
2656
2747
  * @public
2657
2748
  */
2658
2749
  pineconeConfiguration?: PineconeConfiguration;
2659
2750
  /**
2660
- * Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.
2751
+ * <p>Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.</p>
2661
2752
  * @public
2662
2753
  */
2663
2754
  redisEnterpriseCloudConfiguration?: RedisEnterpriseCloudConfiguration;
2664
2755
  /**
2665
- * Contains the configurations to use RDS to store knowledge base data.
2756
+ * <p>Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html">Create a vector index in Amazon RDS</a>.</p>
2666
2757
  * @public
2667
2758
  */
2668
2759
  rdsConfiguration?: RdsConfiguration;
@@ -2672,37 +2763,38 @@ export interface StorageConfiguration {
2672
2763
  */
2673
2764
  export interface CreateKnowledgeBaseRequest {
2674
2765
  /**
2675
- * Client specified token used for idempotency checks
2766
+ * <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,
2767
+ * 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>
2676
2768
  * @public
2677
2769
  */
2678
2770
  clientToken?: string;
2679
2771
  /**
2680
- * Name for a resource.
2772
+ * <p>A name for the knowledge base.</p>
2681
2773
  * @public
2682
2774
  */
2683
2775
  name: string | undefined;
2684
2776
  /**
2685
- * Description of the Resource.
2777
+ * <p>A description of the knowledge base.</p>
2686
2778
  * @public
2687
2779
  */
2688
2780
  description?: string;
2689
2781
  /**
2690
- * ARN of a IAM role.
2782
+ * <p>The ARN of the IAM role with permissions to create the knowledge base.</p>
2691
2783
  * @public
2692
2784
  */
2693
2785
  roleArn: string | undefined;
2694
2786
  /**
2695
- * Configures a bedrock knowledge base.
2787
+ * <p>Contains details about the embeddings model used for the knowledge base.</p>
2696
2788
  * @public
2697
2789
  */
2698
2790
  knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
2699
2791
  /**
2700
- * Configures the physical storage of ingested data in a knowledge base.
2792
+ * <p>Contains details about the configuration of the vector database used for the knowledge base.</p>
2701
2793
  * @public
2702
2794
  */
2703
2795
  storageConfiguration: StorageConfiguration | undefined;
2704
2796
  /**
2705
- * A map of tag keys and values
2797
+ * <p>Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.</p>
2706
2798
  * @public
2707
2799
  */
2708
2800
  tags?: Record<string, string>;
@@ -2723,62 +2815,79 @@ export declare const KnowledgeBaseStatus: {
2723
2815
  */
2724
2816
  export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof KnowledgeBaseStatus];
2725
2817
  /**
2726
- * Contains the information of a knowledge base.
2818
+ * <p>Contains information about a knowledge base.</p>
2727
2819
  * @public
2728
2820
  */
2729
2821
  export interface KnowledgeBase {
2730
2822
  /**
2731
- * Identifier for a resource.
2823
+ * <p>The unique identifier of the knowledge base.</p>
2732
2824
  * @public
2733
2825
  */
2734
2826
  knowledgeBaseId: string | undefined;
2735
2827
  /**
2736
- * Name for a resource.
2828
+ * <p>The name of the knowledge base.</p>
2737
2829
  * @public
2738
2830
  */
2739
2831
  name: string | undefined;
2740
2832
  /**
2741
- * ARN of a KnowledgeBase
2833
+ * <p>The ARN of the knowledge base.</p>
2742
2834
  * @public
2743
2835
  */
2744
2836
  knowledgeBaseArn: string | undefined;
2745
2837
  /**
2746
- * Description of the Resource.
2838
+ * <p>The description of the knowledge base.</p>
2747
2839
  * @public
2748
2840
  */
2749
2841
  description?: string;
2750
2842
  /**
2751
- * ARN of a IAM role.
2843
+ * <p>The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with <code>AmazonBedrockExecutionRoleForKnowledgeBase_</code>.</p>
2752
2844
  * @public
2753
2845
  */
2754
2846
  roleArn: string | undefined;
2755
2847
  /**
2756
- * Configures a bedrock knowledge base.
2848
+ * <p>Contains details about the embeddings configuration of the knowledge base.</p>
2757
2849
  * @public
2758
2850
  */
2759
2851
  knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
2760
2852
  /**
2761
- * Configures the physical storage of ingested data in a knowledge base.
2853
+ * <p>Contains details about the storage configuration of the knowledge base.</p>
2762
2854
  * @public
2763
2855
  */
2764
2856
  storageConfiguration: StorageConfiguration | undefined;
2765
2857
  /**
2766
- * The status of a knowledge base.
2858
+ * <p>The status of the knowledge base. The following statuses are possible:</p>
2859
+ * <ul>
2860
+ * <li>
2861
+ * <p>CREATING – The knowledge base is being created.</p>
2862
+ * </li>
2863
+ * <li>
2864
+ * <p>ACTIVE – The knowledge base is ready to be queried.</p>
2865
+ * </li>
2866
+ * <li>
2867
+ * <p>DELETING – The knowledge base is being deleted.</p>
2868
+ * </li>
2869
+ * <li>
2870
+ * <p>UPDATING – The knowledge base is being updated.</p>
2871
+ * </li>
2872
+ * <li>
2873
+ * <p>FAILED – The knowledge base API operation failed.</p>
2874
+ * </li>
2875
+ * </ul>
2767
2876
  * @public
2768
2877
  */
2769
2878
  status: KnowledgeBaseStatus | undefined;
2770
2879
  /**
2771
- * Time Stamp.
2880
+ * <p>The time at which the knowledge base was created.</p>
2772
2881
  * @public
2773
2882
  */
2774
2883
  createdAt: Date | undefined;
2775
2884
  /**
2776
- * Time Stamp.
2885
+ * <p>The time at which the knowledge base was last updated.</p>
2777
2886
  * @public
2778
2887
  */
2779
2888
  updatedAt: Date | undefined;
2780
2889
  /**
2781
- * Failure Reasons for Error.
2890
+ * <p>A list of reasons that the API operation on the knowledge base failed.</p>
2782
2891
  * @public
2783
2892
  */
2784
2893
  failureReasons?: string[];
@@ -2788,7 +2897,7 @@ export interface KnowledgeBase {
2788
2897
  */
2789
2898
  export interface CreateKnowledgeBaseResponse {
2790
2899
  /**
2791
- * Contains the information of a knowledge base.
2900
+ * <p>Contains details about the knowledge base.</p>
2792
2901
  * @public
2793
2902
  */
2794
2903
  knowledgeBase: KnowledgeBase | undefined;
@@ -2798,7 +2907,7 @@ export interface CreateKnowledgeBaseResponse {
2798
2907
  */
2799
2908
  export interface DeleteKnowledgeBaseRequest {
2800
2909
  /**
2801
- * Identifier for a resource.
2910
+ * <p>The unique identifier of the knowledge base to delete.</p>
2802
2911
  * @public
2803
2912
  */
2804
2913
  knowledgeBaseId: string | undefined;
@@ -2808,71 +2917,67 @@ export interface DeleteKnowledgeBaseRequest {
2808
2917
  */
2809
2918
  export interface DeleteKnowledgeBaseResponse {
2810
2919
  /**
2811
- * Identifier for a resource.
2920
+ * <p>The unique identifier of the knowledge base that was deleted.</p>
2812
2921
  * @public
2813
2922
  */
2814
2923
  knowledgeBaseId: string | undefined;
2815
2924
  /**
2816
- * The status of a knowledge base.
2925
+ * <p>The status of the knowledge base and whether it has been successfully deleted.</p>
2817
2926
  * @public
2818
2927
  */
2819
2928
  status: KnowledgeBaseStatus | undefined;
2820
2929
  }
2821
2930
  /**
2822
- * Disassociate Agent Knowledge Base Request
2823
2931
  * @public
2824
2932
  */
2825
2933
  export interface DisassociateAgentKnowledgeBaseRequest {
2826
2934
  /**
2827
- * Id generated at the server side when an Agent is created
2935
+ * <p>The unique identifier of the agent from which to disassociate the knowledge base.</p>
2828
2936
  * @public
2829
2937
  */
2830
2938
  agentId: string | undefined;
2831
2939
  /**
2832
- * Draft Version of the Agent.
2940
+ * <p>The version of the agent from which to disassociate the knowledge base.</p>
2833
2941
  * @public
2834
2942
  */
2835
2943
  agentVersion: string | undefined;
2836
2944
  /**
2837
- * Id generated at the server side when a Knowledge Base is associated to an Agent
2945
+ * <p>The unique identifier of the knowledge base to disassociate.</p>
2838
2946
  * @public
2839
2947
  */
2840
2948
  knowledgeBaseId: string | undefined;
2841
2949
  }
2842
2950
  /**
2843
- * Disassociate Agent Knowledge Base Response
2844
2951
  * @public
2845
2952
  */
2846
2953
  export interface DisassociateAgentKnowledgeBaseResponse {
2847
2954
  }
2848
2955
  /**
2849
- * Get Agent Knowledge Base Request
2850
2956
  * @public
2851
2957
  */
2852
2958
  export interface GetAgentKnowledgeBaseRequest {
2853
2959
  /**
2854
- * Id generated at the server side when an Agent is created
2960
+ * <p>The unique identifier of the agent with which the knowledge base is associated.</p>
2855
2961
  * @public
2856
2962
  */
2857
2963
  agentId: string | undefined;
2858
2964
  /**
2859
- * Version number generated when a version is created
2965
+ * <p>The version of the agent with which the knowledge base is associated.</p>
2860
2966
  * @public
2861
2967
  */
2862
2968
  agentVersion: string | undefined;
2863
2969
  /**
2864
- * Id generated at the server side when a Knowledge Base is associated
2970
+ * <p>The unique identifier of the knowledge base associated with the agent.</p>
2865
2971
  * @public
2866
2972
  */
2867
2973
  knowledgeBaseId: string | undefined;
2868
2974
  }
2869
2975
  /**
2870
- * Get Agent Knowledge Base Response
2871
2976
  * @public
2872
2977
  */
2873
2978
  export interface GetAgentKnowledgeBaseResponse {
2874
2979
  /**
2875
- * Contains the information of an Agent Knowledge Base.
2980
+ * <p>Contains details about a knowledge base attached to an agent.</p>
2876
2981
  * @public
2877
2982
  */
2878
2983
  agentKnowledgeBase: AgentKnowledgeBase | undefined;
@@ -2882,7 +2987,7 @@ export interface GetAgentKnowledgeBaseResponse {
2882
2987
  */
2883
2988
  export interface GetKnowledgeBaseRequest {
2884
2989
  /**
2885
- * Identifier for a resource.
2990
+ * <p>The unique identifier of the knowledge base for which to get information.</p>
2886
2991
  * @public
2887
2992
  */
2888
2993
  knowledgeBaseId: string | undefined;
@@ -2892,49 +2997,47 @@ export interface GetKnowledgeBaseRequest {
2892
2997
  */
2893
2998
  export interface GetKnowledgeBaseResponse {
2894
2999
  /**
2895
- * Contains the information of a knowledge base.
3000
+ * <p>Contains details about the knowledge base.</p>
2896
3001
  * @public
2897
3002
  */
2898
3003
  knowledgeBase: KnowledgeBase | undefined;
2899
3004
  }
2900
3005
  /**
2901
- * List Agent Knowledge Bases Request
2902
3006
  * @public
2903
3007
  */
2904
3008
  export interface ListAgentKnowledgeBasesRequest {
2905
3009
  /**
2906
- * Id generated at the server side when an Agent is created
3010
+ * <p>The unique identifier of the agent for which to return information about knowledge bases associated with it.</p>
2907
3011
  * @public
2908
3012
  */
2909
3013
  agentId: string | undefined;
2910
3014
  /**
2911
- * Version number generated when a version is created
3015
+ * <p>The version of the agent for which to return information about knowledge bases associated with it.</p>
2912
3016
  * @public
2913
3017
  */
2914
3018
  agentVersion: string | undefined;
2915
3019
  /**
2916
- * Max Results.
3020
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
2917
3021
  * @public
2918
3022
  */
2919
3023
  maxResults?: number;
2920
3024
  /**
2921
- * Opaque continuation token of previous paginated response.
3025
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
2922
3026
  * @public
2923
3027
  */
2924
3028
  nextToken?: string;
2925
3029
  }
2926
3030
  /**
2927
- * List Agent Knowledge Bases Response
2928
3031
  * @public
2929
3032
  */
2930
3033
  export interface ListAgentKnowledgeBasesResponse {
2931
3034
  /**
2932
- * List of Agent Knowledge Base Summaries
3035
+ * <p>A list of objects, each of which contains information about a knowledge base associated with the agent.</p>
2933
3036
  * @public
2934
3037
  */
2935
3038
  agentKnowledgeBaseSummaries: AgentKnowledgeBaseSummary[] | undefined;
2936
3039
  /**
2937
- * Opaque continuation token of previous paginated response.
3040
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
2938
3041
  * @public
2939
3042
  */
2940
3043
  nextToken?: string;
@@ -2944,43 +3047,43 @@ export interface ListAgentKnowledgeBasesResponse {
2944
3047
  */
2945
3048
  export interface ListKnowledgeBasesRequest {
2946
3049
  /**
2947
- * Max Results.
3050
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
2948
3051
  * @public
2949
3052
  */
2950
3053
  maxResults?: number;
2951
3054
  /**
2952
- * Opaque continuation token of previous paginated response.
3055
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
2953
3056
  * @public
2954
3057
  */
2955
3058
  nextToken?: string;
2956
3059
  }
2957
3060
  /**
2958
- * Summary information of a knowledge base.
3061
+ * <p>Contains details about a knowledge base.</p>
2959
3062
  * @public
2960
3063
  */
2961
3064
  export interface KnowledgeBaseSummary {
2962
3065
  /**
2963
- * Identifier for a resource.
3066
+ * <p>The unique identifier of the knowledge base.</p>
2964
3067
  * @public
2965
3068
  */
2966
3069
  knowledgeBaseId: string | undefined;
2967
3070
  /**
2968
- * Name for a resource.
3071
+ * <p>The name of the knowledge base.</p>
2969
3072
  * @public
2970
3073
  */
2971
3074
  name: string | undefined;
2972
3075
  /**
2973
- * Description of the Resource.
3076
+ * <p>The description of the knowledge base.</p>
2974
3077
  * @public
2975
3078
  */
2976
3079
  description?: string;
2977
3080
  /**
2978
- * The status of a knowledge base.
3081
+ * <p>The status of the knowledge base.</p>
2979
3082
  * @public
2980
3083
  */
2981
3084
  status: KnowledgeBaseStatus | undefined;
2982
3085
  /**
2983
- * Time Stamp.
3086
+ * <p>The time at which the knowledge base was last updated.</p>
2984
3087
  * @public
2985
3088
  */
2986
3089
  updatedAt: Date | undefined;
@@ -2990,54 +3093,52 @@ export interface KnowledgeBaseSummary {
2990
3093
  */
2991
3094
  export interface ListKnowledgeBasesResponse {
2992
3095
  /**
2993
- * List of KnowledgeBaseSummaries
3096
+ * <p>A list of objects, each of which contains information about a knowledge base.</p>
2994
3097
  * @public
2995
3098
  */
2996
3099
  knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
2997
3100
  /**
2998
- * Opaque continuation token of previous paginated response.
3101
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
2999
3102
  * @public
3000
3103
  */
3001
3104
  nextToken?: string;
3002
3105
  }
3003
3106
  /**
3004
- * Update Agent Knowledge Base Request
3005
3107
  * @public
3006
3108
  */
3007
3109
  export interface UpdateAgentKnowledgeBaseRequest {
3008
3110
  /**
3009
- * Id generated at the server side when an Agent is created
3111
+ * <p>The unique identifier of the agent associated with the knowledge base that you want to update.</p>
3010
3112
  * @public
3011
3113
  */
3012
3114
  agentId: string | undefined;
3013
3115
  /**
3014
- * Draft Version of the Agent.
3116
+ * <p>The version of the agent associated with the knowledge base that you want to update.</p>
3015
3117
  * @public
3016
3118
  */
3017
3119
  agentVersion: string | undefined;
3018
3120
  /**
3019
- * Id generated at the server side when a Knowledge Base is associated to an Agent
3121
+ * <p>The unique identifier of the knowledge base that has been associated with an agent.</p>
3020
3122
  * @public
3021
3123
  */
3022
3124
  knowledgeBaseId: string | undefined;
3023
3125
  /**
3024
- * Description of the Resource.
3126
+ * <p>Specifies a new description for the knowledge base associated with an agent.</p>
3025
3127
  * @public
3026
3128
  */
3027
3129
  description?: string;
3028
3130
  /**
3029
- * State of the knowledge base; whether it is enabled or disabled
3131
+ * <p>Specifies whether the agent uses the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
3030
3132
  * @public
3031
3133
  */
3032
3134
  knowledgeBaseState?: KnowledgeBaseState;
3033
3135
  }
3034
3136
  /**
3035
- * Update Agent Knowledge Base Response
3036
3137
  * @public
3037
3138
  */
3038
3139
  export interface UpdateAgentKnowledgeBaseResponse {
3039
3140
  /**
3040
- * Contains the information of an Agent Knowledge Base.
3141
+ * <p>Contains details about the knowledge base that has been associated with an agent.</p>
3041
3142
  * @public
3042
3143
  */
3043
3144
  agentKnowledgeBase: AgentKnowledgeBase | undefined;
@@ -3047,32 +3148,32 @@ export interface UpdateAgentKnowledgeBaseResponse {
3047
3148
  */
3048
3149
  export interface UpdateKnowledgeBaseRequest {
3049
3150
  /**
3050
- * Identifier for a resource.
3151
+ * <p>The unique identifier of the knowledge base to update.</p>
3051
3152
  * @public
3052
3153
  */
3053
3154
  knowledgeBaseId: string | undefined;
3054
3155
  /**
3055
- * Name for a resource.
3156
+ * <p>Specifies a new name for the knowledge base.</p>
3056
3157
  * @public
3057
3158
  */
3058
3159
  name: string | undefined;
3059
3160
  /**
3060
- * Description of the Resource.
3161
+ * <p>Specifies a new description for the knowledge base.</p>
3061
3162
  * @public
3062
3163
  */
3063
3164
  description?: string;
3064
3165
  /**
3065
- * ARN of a IAM role.
3166
+ * <p>Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to modify the knowledge base.</p>
3066
3167
  * @public
3067
3168
  */
3068
3169
  roleArn: string | undefined;
3069
3170
  /**
3070
- * Configures a bedrock knowledge base.
3171
+ * <p>Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.</p>
3071
3172
  * @public
3072
3173
  */
3073
3174
  knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
3074
3175
  /**
3075
- * Configures the physical storage of ingested data in a knowledge base.
3176
+ * <p>Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.</p>
3076
3177
  * @public
3077
3178
  */
3078
3179
  storageConfiguration: StorageConfiguration | undefined;
@@ -3082,7 +3183,7 @@ export interface UpdateKnowledgeBaseRequest {
3082
3183
  */
3083
3184
  export interface UpdateKnowledgeBaseResponse {
3084
3185
  /**
3085
- * Contains the information of a knowledge base.
3186
+ * <p>Contains details about the knowledge base.</p>
3086
3187
  * @public
3087
3188
  */
3088
3189
  knowledgeBase: KnowledgeBase | undefined;
@@ -3092,7 +3193,7 @@ export interface UpdateKnowledgeBaseResponse {
3092
3193
  */
3093
3194
  export interface ListTagsForResourceRequest {
3094
3195
  /**
3095
- * ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]
3196
+ * <p>The ARN of the resource for which to list tags.</p>
3096
3197
  * @public
3097
3198
  */
3098
3199
  resourceArn: string | undefined;
@@ -3102,7 +3203,7 @@ export interface ListTagsForResourceRequest {
3102
3203
  */
3103
3204
  export interface ListTagsForResourceResponse {
3104
3205
  /**
3105
- * A map of tag keys and values
3206
+ * <p>The key-value pairs for the tags associated with the resource.</p>
3106
3207
  * @public
3107
3208
  */
3108
3209
  tags?: Record<string, string>;
@@ -3112,12 +3213,12 @@ export interface ListTagsForResourceResponse {
3112
3213
  */
3113
3214
  export interface TagResourceRequest {
3114
3215
  /**
3115
- * ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]
3216
+ * <p>The ARN of the resource to tag.</p>
3116
3217
  * @public
3117
3218
  */
3118
3219
  resourceArn: string | undefined;
3119
3220
  /**
3120
- * A map of tag keys and values
3221
+ * <p>An object containing key-value pairs that define the tags to attach to the resource.</p>
3121
3222
  * @public
3122
3223
  */
3123
3224
  tags: Record<string, string> | undefined;
@@ -3132,12 +3233,12 @@ export interface TagResourceResponse {
3132
3233
  */
3133
3234
  export interface UntagResourceRequest {
3134
3235
  /**
3135
- * ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]
3236
+ * <p>The ARN of the resource from which to remove tags.</p>
3136
3237
  * @public
3137
3238
  */
3138
3239
  resourceArn: string | undefined;
3139
3240
  /**
3140
- * List of Tag Keys
3241
+ * <p>A list of keys of the tags to remove from the resource.</p>
3141
3242
  * @public
3142
3243
  */
3143
3244
  tagKeys: string[] | undefined;
@@ -3148,107 +3249,101 @@ export interface UntagResourceRequest {
3148
3249
  export interface UntagResourceResponse {
3149
3250
  }
3150
3251
  /**
3151
- * Delete Agent Version Request
3152
3252
  * @public
3153
3253
  */
3154
3254
  export interface DeleteAgentVersionRequest {
3155
3255
  /**
3156
- * Id generated at the server side when an Agent is created
3256
+ * <p>The unique identifier of the agent that the version belongs to.</p>
3157
3257
  * @public
3158
3258
  */
3159
3259
  agentId: string | undefined;
3160
3260
  /**
3161
- * Numerical Agent Version.
3261
+ * <p>The version of the agent to delete.</p>
3162
3262
  * @public
3163
3263
  */
3164
3264
  agentVersion: string | undefined;
3165
3265
  /**
3166
- * Skips checking if resource is in use when set to true. Defaults to false
3266
+ * <p>By default, this value is <code>false</code> and deletion is stopped if the resource is in use. If you set it to <code>true</code>, the resource will be deleted even if the resource is in use.</p>
3167
3267
  * @public
3168
3268
  */
3169
3269
  skipResourceInUseCheck?: boolean;
3170
3270
  }
3171
3271
  /**
3172
- * Delete Agent Version Response
3173
3272
  * @public
3174
3273
  */
3175
3274
  export interface DeleteAgentVersionResponse {
3176
3275
  /**
3177
- * Identifier for a resource.
3276
+ * <p>The unique identifier of the agent that the version belongs to.</p>
3178
3277
  * @public
3179
3278
  */
3180
3279
  agentId: string | undefined;
3181
3280
  /**
3182
- * Numerical Agent Version.
3281
+ * <p>The version that was deleted.</p>
3183
3282
  * @public
3184
3283
  */
3185
3284
  agentVersion: string | undefined;
3186
3285
  /**
3187
- * Schema Type for Action APIs.
3286
+ * <p>The status of the agent version.</p>
3188
3287
  * @public
3189
3288
  */
3190
3289
  agentStatus: AgentStatus | undefined;
3191
3290
  }
3192
3291
  /**
3193
- * Get Agent Version Request
3194
3292
  * @public
3195
3293
  */
3196
3294
  export interface GetAgentVersionRequest {
3197
3295
  /**
3198
- * Id generated at the server side when an Agent is created
3296
+ * <p>The unique identifier of the agent.</p>
3199
3297
  * @public
3200
3298
  */
3201
3299
  agentId: string | undefined;
3202
3300
  /**
3203
- * Numerical Agent Version.
3301
+ * <p>The version of the agent.</p>
3204
3302
  * @public
3205
3303
  */
3206
3304
  agentVersion: string | undefined;
3207
3305
  }
3208
3306
  /**
3209
- * Get Agent Version Response
3210
3307
  * @public
3211
3308
  */
3212
3309
  export interface GetAgentVersionResponse {
3213
3310
  /**
3214
- * Contains the information of an agent version.
3311
+ * <p>Contains details about the version of the agent.</p>
3215
3312
  * @public
3216
3313
  */
3217
3314
  agentVersion: AgentVersion | undefined;
3218
3315
  }
3219
3316
  /**
3220
- * List Agent Versions Request
3221
3317
  * @public
3222
3318
  */
3223
3319
  export interface ListAgentVersionsRequest {
3224
3320
  /**
3225
- * Id generated at the server side when an Agent is created
3321
+ * <p>The unique identifier of the agent.</p>
3226
3322
  * @public
3227
3323
  */
3228
3324
  agentId: string | undefined;
3229
3325
  /**
3230
- * Max Results.
3326
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
3231
3327
  * @public
3232
3328
  */
3233
3329
  maxResults?: number;
3234
3330
  /**
3235
- * Opaque continuation token of previous paginated response.
3331
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
3236
3332
  * @public
3237
3333
  */
3238
3334
  nextToken?: string;
3239
3335
  }
3240
3336
  /**
3241
- * List Agent Versions Response
3242
3337
  * @public
3243
3338
  */
3244
3339
  export interface ListAgentVersionsResponse {
3245
3340
  /**
3246
- * List of AgentVersionSummary.
3341
+ * <p>A list of objects, each of which contains information about a version of the agent.</p>
3247
3342
  * @public
3248
3343
  */
3249
3344
  agentVersionSummaries: AgentVersionSummary[] | undefined;
3250
3345
  /**
3251
- * Opaque continuation token of previous paginated response.
3346
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
3252
3347
  * @public
3253
3348
  */
3254
3349
  nextToken?: string;