@aws-sdk/client-bedrock 3.835.0 → 3.836.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 (54) hide show
  1. package/README.md +48 -0
  2. package/dist-cjs/index.js +417 -120
  3. package/dist-es/Bedrock.js +12 -0
  4. package/dist-es/commands/CreateFoundationModelAgreementCommand.js +22 -0
  5. package/dist-es/commands/CreateModelCustomizationJobCommand.js +1 -1
  6. package/dist-es/commands/DeleteFoundationModelAgreementCommand.js +22 -0
  7. package/dist-es/commands/GetFoundationModelAvailabilityCommand.js +22 -0
  8. package/dist-es/commands/GetModelCustomizationJobCommand.js +1 -1
  9. package/dist-es/commands/GetUseCaseForModelAccessCommand.js +22 -0
  10. package/dist-es/commands/ListFoundationModelAgreementOffersCommand.js +22 -0
  11. package/dist-es/commands/PutUseCaseForModelAccessCommand.js +22 -0
  12. package/dist-es/commands/index.js +6 -0
  13. package/dist-es/models/models_0.js +54 -126
  14. package/dist-es/models/models_1.js +95 -1
  15. package/dist-es/protocols/Aws_restJson1.js +153 -2
  16. package/dist-types/Bedrock.d.ts +43 -0
  17. package/dist-types/BedrockClient.d.ts +8 -2
  18. package/dist-types/commands/CreateFoundationModelAgreementCommand.d.ts +91 -0
  19. package/dist-types/commands/CreateModelCustomizationJobCommand.d.ts +1 -1
  20. package/dist-types/commands/DeleteFoundationModelAgreementCommand.d.ts +88 -0
  21. package/dist-types/commands/GetFoundationModelAvailabilityCommand.d.ts +94 -0
  22. package/dist-types/commands/GetModelCustomizationJobCommand.d.ts +1 -1
  23. package/dist-types/commands/GetUseCaseForModelAccessCommand.d.ts +82 -0
  24. package/dist-types/commands/ListFoundationModelAgreementOffersCommand.d.ts +116 -0
  25. package/dist-types/commands/ListModelCustomizationJobsCommand.d.ts +1 -1
  26. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  27. package/dist-types/commands/PutUseCaseForModelAccessCommand.d.ts +82 -0
  28. package/dist-types/commands/StopModelCustomizationJobCommand.d.ts +1 -1
  29. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  30. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  31. package/dist-types/commands/index.d.ts +6 -0
  32. package/dist-types/models/models_0.d.ts +239 -804
  33. package/dist-types/models/models_1.d.ts +901 -1
  34. package/dist-types/protocols/Aws_restJson1.d.ts +54 -0
  35. package/dist-types/ts3.4/Bedrock.d.ts +109 -0
  36. package/dist-types/ts3.4/BedrockClient.d.ts +36 -0
  37. package/dist-types/ts3.4/commands/CreateFoundationModelAgreementCommand.d.ts +51 -0
  38. package/dist-types/ts3.4/commands/CreateModelCustomizationJobCommand.d.ts +1 -1
  39. package/dist-types/ts3.4/commands/DeleteFoundationModelAgreementCommand.d.ts +51 -0
  40. package/dist-types/ts3.4/commands/GetFoundationModelAvailabilityCommand.d.ts +51 -0
  41. package/dist-types/ts3.4/commands/GetModelCustomizationJobCommand.d.ts +1 -1
  42. package/dist-types/ts3.4/commands/GetUseCaseForModelAccessCommand.d.ts +51 -0
  43. package/dist-types/ts3.4/commands/ListFoundationModelAgreementOffersCommand.d.ts +49 -0
  44. package/dist-types/ts3.4/commands/ListModelCustomizationJobsCommand.d.ts +1 -1
  45. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/PutUseCaseForModelAccessCommand.d.ts +51 -0
  47. package/dist-types/ts3.4/commands/StopModelCustomizationJobCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/index.d.ts +6 -0
  51. package/dist-types/ts3.4/models/models_0.d.ts +107 -425
  52. package/dist-types/ts3.4/models/models_1.d.ts +431 -1
  53. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +72 -0
  54. package/package.json +1 -1
@@ -1,4 +1,892 @@
1
- import { ApplicationType, EvaluationConfig, EvaluationJobStatus, EvaluationJobType, EvaluationModelConfig, EvaluationOutputDataConfig, EvaluationPrecomputedRagSourceConfig, ExternalSourcesRetrieveAndGenerateConfiguration, GenerationConfiguration, OrchestrationConfiguration, RetrievalFilter, RetrieveAndGenerateType, SearchType, Tag } from "./models_0";
1
+ import { ApplicationType, CustomizationConfig, CustomizationType, EvaluationConfig, EvaluationJobStatus, EvaluationJobType, EvaluationModelConfig, EvaluationOutputDataConfig, EvaluationPrecomputedRagSourceConfig, ExternalSourcesRetrieveAndGenerateConfiguration, FilterAttribute, GenerationConfiguration, OrchestrationConfiguration, OutputDataConfig, RetrieveAndGenerateType, SearchType, SortJobsBy, SortOrder, Tag, TermDetails, TrainingDataConfig, TrainingMetrics, ValidationDataConfig, ValidatorMetric, VpcConfig } from "./models_0";
2
+ /**
3
+ * <p>An offer dictates usage terms for the model.</p>
4
+ * @public
5
+ */
6
+ export interface Offer {
7
+ /**
8
+ * <p>Offer Id for a model offer.</p>
9
+ * @public
10
+ */
11
+ offerId?: string | undefined;
12
+ /**
13
+ * <p>Offer token.</p>
14
+ * @public
15
+ */
16
+ offerToken: string | undefined;
17
+ /**
18
+ * <p>Details about the terms of the offer.</p>
19
+ * @public
20
+ */
21
+ termDetails: TermDetails | undefined;
22
+ }
23
+ /**
24
+ * @public
25
+ */
26
+ export interface ListFoundationModelAgreementOffersResponse {
27
+ /**
28
+ * <p>Model Id of the foundation model.</p>
29
+ * @public
30
+ */
31
+ modelId: string | undefined;
32
+ /**
33
+ * <p>List of the offers associated with the specified model.</p>
34
+ * @public
35
+ */
36
+ offers: Offer[] | undefined;
37
+ }
38
+ /**
39
+ * @public
40
+ */
41
+ export interface ListTagsForResourceRequest {
42
+ /**
43
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
44
+ * @public
45
+ */
46
+ resourceARN: string | undefined;
47
+ }
48
+ /**
49
+ * @public
50
+ */
51
+ export interface ListTagsForResourceResponse {
52
+ /**
53
+ * <p>An array of the tags associated with this resource.</p>
54
+ * @public
55
+ */
56
+ tags?: Tag[] | undefined;
57
+ }
58
+ /**
59
+ * @public
60
+ */
61
+ export interface TagResourceRequest {
62
+ /**
63
+ * <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
64
+ * @public
65
+ */
66
+ resourceARN: string | undefined;
67
+ /**
68
+ * <p>Tags to associate with the resource.</p>
69
+ * @public
70
+ */
71
+ tags: Tag[] | undefined;
72
+ }
73
+ /**
74
+ * @public
75
+ */
76
+ export interface TagResourceResponse {
77
+ }
78
+ /**
79
+ * @public
80
+ */
81
+ export interface UntagResourceRequest {
82
+ /**
83
+ * <p>The Amazon Resource Name (ARN) of the resource to untag.</p>
84
+ * @public
85
+ */
86
+ resourceARN: string | undefined;
87
+ /**
88
+ * <p>Tag keys of the tags to remove from the resource.</p>
89
+ * @public
90
+ */
91
+ tagKeys: string[] | undefined;
92
+ }
93
+ /**
94
+ * @public
95
+ */
96
+ export interface UntagResourceResponse {
97
+ }
98
+ /**
99
+ * @public
100
+ */
101
+ export interface CreateModelCustomizationJobRequest {
102
+ /**
103
+ * <p>A name for the fine-tuning job.</p>
104
+ * @public
105
+ */
106
+ jobName: string | undefined;
107
+ /**
108
+ * <p>A name for the resulting custom model.</p>
109
+ * @public
110
+ */
111
+ customModelName: string | undefined;
112
+ /**
113
+ * <p>The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must have the <code>iam:PassRole</code> permission. </p>
114
+ * @public
115
+ */
116
+ roleArn: string | undefined;
117
+ /**
118
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
119
+ * @public
120
+ */
121
+ clientRequestToken?: string | undefined;
122
+ /**
123
+ * <p>Name of the base model.</p>
124
+ * @public
125
+ */
126
+ baseModelIdentifier: string | undefined;
127
+ /**
128
+ * <p>The customization type.</p>
129
+ * @public
130
+ */
131
+ customizationType?: CustomizationType | undefined;
132
+ /**
133
+ * <p>The custom model is encrypted at rest using this key.</p>
134
+ * @public
135
+ */
136
+ customModelKmsKeyId?: string | undefined;
137
+ /**
138
+ * <p>Tags to attach to the job.</p>
139
+ * @public
140
+ */
141
+ jobTags?: Tag[] | undefined;
142
+ /**
143
+ * <p>Tags to attach to the resulting custom model.</p>
144
+ * @public
145
+ */
146
+ customModelTags?: Tag[] | undefined;
147
+ /**
148
+ * <p>Information about the training dataset.</p>
149
+ * @public
150
+ */
151
+ trainingDataConfig: TrainingDataConfig | undefined;
152
+ /**
153
+ * <p>Information about the validation dataset. </p>
154
+ * @public
155
+ */
156
+ validationDataConfig?: ValidationDataConfig | undefined;
157
+ /**
158
+ * <p>S3 location for the output data.</p>
159
+ * @public
160
+ */
161
+ outputDataConfig: OutputDataConfig | undefined;
162
+ /**
163
+ * <p>Parameters related to tuning the model. For details on the format for different models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html">Custom model hyperparameters</a>.</p>
164
+ * @public
165
+ */
166
+ hyperParameters?: Record<string, string> | undefined;
167
+ /**
168
+ * <p>The configuration of the Virtual Private Cloud (VPC) that contains the resources that you're using for this job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/vpc-model-customization.html">Protect your model customization jobs using a VPC</a>.</p>
169
+ * @public
170
+ */
171
+ vpcConfig?: VpcConfig | undefined;
172
+ /**
173
+ * <p>The customization configuration for the model customization job.</p>
174
+ * @public
175
+ */
176
+ customizationConfig?: CustomizationConfig | undefined;
177
+ }
178
+ /**
179
+ * @public
180
+ */
181
+ export interface CreateModelCustomizationJobResponse {
182
+ /**
183
+ * <p>Amazon Resource Name (ARN) of the fine tuning job</p>
184
+ * @public
185
+ */
186
+ jobArn: string | undefined;
187
+ }
188
+ /**
189
+ * @public
190
+ */
191
+ export interface GetModelCustomizationJobRequest {
192
+ /**
193
+ * <p>Identifier for the customization job.</p>
194
+ * @public
195
+ */
196
+ jobIdentifier: string | undefined;
197
+ }
198
+ /**
199
+ * @public
200
+ * @enum
201
+ */
202
+ export declare const ModelCustomizationJobStatus: {
203
+ readonly COMPLETED: "Completed";
204
+ readonly FAILED: "Failed";
205
+ readonly IN_PROGRESS: "InProgress";
206
+ readonly STOPPED: "Stopped";
207
+ readonly STOPPING: "Stopping";
208
+ };
209
+ /**
210
+ * @public
211
+ */
212
+ export type ModelCustomizationJobStatus = (typeof ModelCustomizationJobStatus)[keyof typeof ModelCustomizationJobStatus];
213
+ /**
214
+ * @public
215
+ * @enum
216
+ */
217
+ export declare const JobStatusDetails: {
218
+ readonly COMPLETED: "Completed";
219
+ readonly FAILED: "Failed";
220
+ readonly IN_PROGRESS: "InProgress";
221
+ readonly NOT_STARTED: "NotStarted";
222
+ readonly STOPPED: "Stopped";
223
+ readonly STOPPING: "Stopping";
224
+ };
225
+ /**
226
+ * @public
227
+ */
228
+ export type JobStatusDetails = (typeof JobStatusDetails)[keyof typeof JobStatusDetails];
229
+ /**
230
+ * <p>For a Distillation job, the status details for the data processing sub-task of the job.</p>
231
+ * @public
232
+ */
233
+ export interface DataProcessingDetails {
234
+ /**
235
+ * <p>The status of the data processing sub-task of the job.</p>
236
+ * @public
237
+ */
238
+ status?: JobStatusDetails | undefined;
239
+ /**
240
+ * <p>The start time of the data processing sub-task of the job.</p>
241
+ * @public
242
+ */
243
+ creationTime?: Date | undefined;
244
+ /**
245
+ * <p>The latest update to the data processing sub-task of the job.</p>
246
+ * @public
247
+ */
248
+ lastModifiedTime?: Date | undefined;
249
+ }
250
+ /**
251
+ * <p>For a Distillation job, the status details for the training sub-task of the job.</p>
252
+ * @public
253
+ */
254
+ export interface TrainingDetails {
255
+ /**
256
+ * <p>The status of the training sub-task of the job.</p>
257
+ * @public
258
+ */
259
+ status?: JobStatusDetails | undefined;
260
+ /**
261
+ * <p>The start time of the training sub-task of the job.</p>
262
+ * @public
263
+ */
264
+ creationTime?: Date | undefined;
265
+ /**
266
+ * <p>The latest update to the training sub-task of the job.</p>
267
+ * @public
268
+ */
269
+ lastModifiedTime?: Date | undefined;
270
+ }
271
+ /**
272
+ * <p>For a Distillation job, the status details for the validation sub-task of the job.</p>
273
+ * @public
274
+ */
275
+ export interface ValidationDetails {
276
+ /**
277
+ * <p>The status of the validation sub-task of the job.</p>
278
+ * @public
279
+ */
280
+ status?: JobStatusDetails | undefined;
281
+ /**
282
+ * <p>The start time of the validation sub-task of the job.</p>
283
+ * @public
284
+ */
285
+ creationTime?: Date | undefined;
286
+ /**
287
+ * <p>The latest update to the validation sub-task of the job.</p>
288
+ * @public
289
+ */
290
+ lastModifiedTime?: Date | undefined;
291
+ }
292
+ /**
293
+ * <p>For a Distillation job, the status details for sub-tasks of the job. Possible statuses for each sub-task include the following:</p> <ul> <li> <p>NotStarted</p> </li> <li> <p>InProgress</p> </li> <li> <p>Completed</p> </li> <li> <p>Stopping</p> </li> <li> <p>Stopped</p> </li> <li> <p>Failed</p> </li> </ul>
294
+ * @public
295
+ */
296
+ export interface StatusDetails {
297
+ /**
298
+ * <p>The status details for the validation sub-task of the job.</p>
299
+ * @public
300
+ */
301
+ validationDetails?: ValidationDetails | undefined;
302
+ /**
303
+ * <p>The status details for the data processing sub-task of the job.</p>
304
+ * @public
305
+ */
306
+ dataProcessingDetails?: DataProcessingDetails | undefined;
307
+ /**
308
+ * <p>The status details for the training sub-task of the job.</p>
309
+ * @public
310
+ */
311
+ trainingDetails?: TrainingDetails | undefined;
312
+ }
313
+ /**
314
+ * @public
315
+ */
316
+ export interface GetModelCustomizationJobResponse {
317
+ /**
318
+ * <p>The Amazon Resource Name (ARN) of the customization job.</p>
319
+ * @public
320
+ */
321
+ jobArn: string | undefined;
322
+ /**
323
+ * <p>The name of the customization job.</p>
324
+ * @public
325
+ */
326
+ jobName: string | undefined;
327
+ /**
328
+ * <p>The name of the output model.</p>
329
+ * @public
330
+ */
331
+ outputModelName: string | undefined;
332
+ /**
333
+ * <p>The Amazon Resource Name (ARN) of the output model.</p>
334
+ * @public
335
+ */
336
+ outputModelArn?: string | undefined;
337
+ /**
338
+ * <p>The token that you specified in the <code>CreateCustomizationJob</code> request.</p>
339
+ * @public
340
+ */
341
+ clientRequestToken?: string | undefined;
342
+ /**
343
+ * <p>The Amazon Resource Name (ARN) of the IAM role.</p>
344
+ * @public
345
+ */
346
+ roleArn: string | undefined;
347
+ /**
348
+ * <p>The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use. If the job failed, the failure message contains information about why the job failed.</p>
349
+ * @public
350
+ */
351
+ status?: ModelCustomizationJobStatus | undefined;
352
+ /**
353
+ * <p>For a Distillation job, the details about the statuses of the sub-tasks of the customization job. </p>
354
+ * @public
355
+ */
356
+ statusDetails?: StatusDetails | undefined;
357
+ /**
358
+ * <p>Information about why the job failed.</p>
359
+ * @public
360
+ */
361
+ failureMessage?: string | undefined;
362
+ /**
363
+ * <p>Time that the resource was created.</p>
364
+ * @public
365
+ */
366
+ creationTime: Date | undefined;
367
+ /**
368
+ * <p>Time that the resource was last modified.</p>
369
+ * @public
370
+ */
371
+ lastModifiedTime?: Date | undefined;
372
+ /**
373
+ * <p>Time that the resource transitioned to terminal state.</p>
374
+ * @public
375
+ */
376
+ endTime?: Date | undefined;
377
+ /**
378
+ * <p>Amazon Resource Name (ARN) of the base model.</p>
379
+ * @public
380
+ */
381
+ baseModelArn: string | undefined;
382
+ /**
383
+ * <p>The hyperparameter values for the job. For details on the format for different models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html">Custom model hyperparameters</a>.</p>
384
+ * @public
385
+ */
386
+ hyperParameters?: Record<string, string> | undefined;
387
+ /**
388
+ * <p>Contains information about the training dataset.</p>
389
+ * @public
390
+ */
391
+ trainingDataConfig: TrainingDataConfig | undefined;
392
+ /**
393
+ * <p>Contains information about the validation dataset.</p>
394
+ * @public
395
+ */
396
+ validationDataConfig: ValidationDataConfig | undefined;
397
+ /**
398
+ * <p>Output data configuration </p>
399
+ * @public
400
+ */
401
+ outputDataConfig: OutputDataConfig | undefined;
402
+ /**
403
+ * <p>The type of model customization.</p>
404
+ * @public
405
+ */
406
+ customizationType?: CustomizationType | undefined;
407
+ /**
408
+ * <p>The custom model is encrypted at rest using this key.</p>
409
+ * @public
410
+ */
411
+ outputModelKmsKeyArn?: string | undefined;
412
+ /**
413
+ * <p>Contains training metrics from the job creation.</p>
414
+ * @public
415
+ */
416
+ trainingMetrics?: TrainingMetrics | undefined;
417
+ /**
418
+ * <p>The loss metric for each validator that you provided in the createjob request.</p>
419
+ * @public
420
+ */
421
+ validationMetrics?: ValidatorMetric[] | undefined;
422
+ /**
423
+ * <p>VPC configuration for the custom model job.</p>
424
+ * @public
425
+ */
426
+ vpcConfig?: VpcConfig | undefined;
427
+ /**
428
+ * <p>The customization configuration for the model customization job.</p>
429
+ * @public
430
+ */
431
+ customizationConfig?: CustomizationConfig | undefined;
432
+ }
433
+ /**
434
+ * @public
435
+ * @enum
436
+ */
437
+ export declare const FineTuningJobStatus: {
438
+ readonly COMPLETED: "Completed";
439
+ readonly FAILED: "Failed";
440
+ readonly IN_PROGRESS: "InProgress";
441
+ readonly STOPPED: "Stopped";
442
+ readonly STOPPING: "Stopping";
443
+ };
444
+ /**
445
+ * @public
446
+ */
447
+ export type FineTuningJobStatus = (typeof FineTuningJobStatus)[keyof typeof FineTuningJobStatus];
448
+ /**
449
+ * @public
450
+ */
451
+ export interface ListModelCustomizationJobsRequest {
452
+ /**
453
+ * <p>Return customization jobs created after the specified time. </p>
454
+ * @public
455
+ */
456
+ creationTimeAfter?: Date | undefined;
457
+ /**
458
+ * <p>Return customization jobs created before the specified time. </p>
459
+ * @public
460
+ */
461
+ creationTimeBefore?: Date | undefined;
462
+ /**
463
+ * <p>Return customization jobs with the specified status. </p>
464
+ * @public
465
+ */
466
+ statusEquals?: FineTuningJobStatus | undefined;
467
+ /**
468
+ * <p>Return customization jobs only if the job name contains these characters.</p>
469
+ * @public
470
+ */
471
+ nameContains?: string | undefined;
472
+ /**
473
+ * <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>
474
+ * @public
475
+ */
476
+ maxResults?: number | undefined;
477
+ /**
478
+ * <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>
479
+ * @public
480
+ */
481
+ nextToken?: string | undefined;
482
+ /**
483
+ * <p>The field to sort by in the returned list of jobs.</p>
484
+ * @public
485
+ */
486
+ sortBy?: SortJobsBy | undefined;
487
+ /**
488
+ * <p>The sort order of the results.</p>
489
+ * @public
490
+ */
491
+ sortOrder?: SortOrder | undefined;
492
+ }
493
+ /**
494
+ * <p>Information about one customization job</p>
495
+ * @public
496
+ */
497
+ export interface ModelCustomizationJobSummary {
498
+ /**
499
+ * <p>Amazon Resource Name (ARN) of the customization job.</p>
500
+ * @public
501
+ */
502
+ jobArn: string | undefined;
503
+ /**
504
+ * <p>Amazon Resource Name (ARN) of the base model.</p>
505
+ * @public
506
+ */
507
+ baseModelArn: string | undefined;
508
+ /**
509
+ * <p>Name of the customization job.</p>
510
+ * @public
511
+ */
512
+ jobName: string | undefined;
513
+ /**
514
+ * <p>Status of the customization job. </p>
515
+ * @public
516
+ */
517
+ status: ModelCustomizationJobStatus | undefined;
518
+ /**
519
+ * <p>Details about the status of the data processing sub-task of the job.</p>
520
+ * @public
521
+ */
522
+ statusDetails?: StatusDetails | undefined;
523
+ /**
524
+ * <p>Time that the customization job was last modified.</p>
525
+ * @public
526
+ */
527
+ lastModifiedTime?: Date | undefined;
528
+ /**
529
+ * <p>Creation time of the custom model. </p>
530
+ * @public
531
+ */
532
+ creationTime: Date | undefined;
533
+ /**
534
+ * <p>Time that the customization job ended.</p>
535
+ * @public
536
+ */
537
+ endTime?: Date | undefined;
538
+ /**
539
+ * <p>Amazon Resource Name (ARN) of the custom model.</p>
540
+ * @public
541
+ */
542
+ customModelArn?: string | undefined;
543
+ /**
544
+ * <p>Name of the custom model.</p>
545
+ * @public
546
+ */
547
+ customModelName?: string | undefined;
548
+ /**
549
+ * <p>Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a>.</p>
550
+ * @public
551
+ */
552
+ customizationType?: CustomizationType | undefined;
553
+ }
554
+ /**
555
+ * @public
556
+ */
557
+ export interface ListModelCustomizationJobsResponse {
558
+ /**
559
+ * <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>
560
+ * @public
561
+ */
562
+ nextToken?: string | undefined;
563
+ /**
564
+ * <p>Job summaries.</p>
565
+ * @public
566
+ */
567
+ modelCustomizationJobSummaries?: ModelCustomizationJobSummary[] | undefined;
568
+ }
569
+ /**
570
+ * @public
571
+ */
572
+ export interface StopModelCustomizationJobRequest {
573
+ /**
574
+ * <p>Job identifier of the job to stop.</p>
575
+ * @public
576
+ */
577
+ jobIdentifier: string | undefined;
578
+ }
579
+ /**
580
+ * @public
581
+ */
582
+ export interface StopModelCustomizationJobResponse {
583
+ }
584
+ /**
585
+ * <p>Specifies the filters to use on the metadata attributes/fields in the knowledge base data sources before returning results.</p>
586
+ * @public
587
+ */
588
+ export type RetrievalFilter = RetrievalFilter.AndAllMember | RetrievalFilter.EqualsMember | RetrievalFilter.GreaterThanMember | RetrievalFilter.GreaterThanOrEqualsMember | RetrievalFilter.InMember | RetrievalFilter.LessThanMember | RetrievalFilter.LessThanOrEqualsMember | RetrievalFilter.ListContainsMember | RetrievalFilter.NotEqualsMember | RetrievalFilter.NotInMember | RetrievalFilter.OrAllMember | RetrievalFilter.StartsWithMember | RetrievalFilter.StringContainsMember | RetrievalFilter.$UnknownMember;
589
+ /**
590
+ * @public
591
+ */
592
+ export declare namespace RetrievalFilter {
593
+ /**
594
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.</p> <p>The following example would return data sources with an animal attribute whose value is 'cat': <code>"equals": \{ "key": "animal", "value": "cat" \}</code> </p>
595
+ * @public
596
+ */
597
+ interface EqualsMember {
598
+ equals: FilterAttribute;
599
+ notEquals?: never;
600
+ greaterThan?: never;
601
+ greaterThanOrEquals?: never;
602
+ lessThan?: never;
603
+ lessThanOrEquals?: never;
604
+ in?: never;
605
+ notIn?: never;
606
+ startsWith?: never;
607
+ listContains?: never;
608
+ stringContains?: never;
609
+ andAll?: never;
610
+ orAll?: never;
611
+ $unknown?: never;
612
+ }
613
+ /**
614
+ * <p>Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.</p> <p>The following example would return data sources that don't contain an animal attribute whose value is 'cat': <code>"notEquals": \{ "key": "animal", "value": "cat" \}</code> </p>
615
+ * @public
616
+ */
617
+ interface NotEqualsMember {
618
+ equals?: never;
619
+ notEquals: FilterAttribute;
620
+ greaterThan?: never;
621
+ greaterThanOrEquals?: never;
622
+ lessThan?: never;
623
+ lessThanOrEquals?: never;
624
+ in?: never;
625
+ notIn?: never;
626
+ startsWith?: never;
627
+ listContains?: never;
628
+ stringContains?: never;
629
+ andAll?: never;
630
+ orAll?: never;
631
+ $unknown?: never;
632
+ }
633
+ /**
634
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.</p> <p>The following example would return data sources with an year attribute whose value is greater than '1989': <code>"greaterThan": \{ "key": "year", "value": 1989 \}</code> </p>
635
+ * @public
636
+ */
637
+ interface GreaterThanMember {
638
+ equals?: never;
639
+ notEquals?: never;
640
+ greaterThan: FilterAttribute;
641
+ greaterThanOrEquals?: never;
642
+ lessThan?: never;
643
+ lessThanOrEquals?: never;
644
+ in?: never;
645
+ notIn?: never;
646
+ startsWith?: never;
647
+ listContains?: never;
648
+ stringContains?: never;
649
+ andAll?: never;
650
+ orAll?: never;
651
+ $unknown?: never;
652
+ }
653
+ /**
654
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.</p> <p>The following example would return data sources with an year attribute whose value is greater than or equal to '1989': <code>"greaterThanOrEquals": \{ "key": "year", "value": 1989 \}</code> </p>
655
+ * @public
656
+ */
657
+ interface GreaterThanOrEqualsMember {
658
+ equals?: never;
659
+ notEquals?: never;
660
+ greaterThan?: never;
661
+ greaterThanOrEquals: FilterAttribute;
662
+ lessThan?: never;
663
+ lessThanOrEquals?: never;
664
+ in?: never;
665
+ notIn?: never;
666
+ startsWith?: never;
667
+ listContains?: never;
668
+ stringContains?: never;
669
+ andAll?: never;
670
+ orAll?: never;
671
+ $unknown?: never;
672
+ }
673
+ /**
674
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.</p> <p>The following example would return data sources with an year attribute whose value is less than to '1989': <code>"lessThan": \{ "key": "year", "value": 1989 \}</code> </p>
675
+ * @public
676
+ */
677
+ interface LessThanMember {
678
+ equals?: never;
679
+ notEquals?: never;
680
+ greaterThan?: never;
681
+ greaterThanOrEquals?: never;
682
+ lessThan: FilterAttribute;
683
+ lessThanOrEquals?: never;
684
+ in?: never;
685
+ notIn?: never;
686
+ startsWith?: never;
687
+ listContains?: never;
688
+ stringContains?: never;
689
+ andAll?: never;
690
+ orAll?: never;
691
+ $unknown?: never;
692
+ }
693
+ /**
694
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.</p> <p>The following example would return data sources with an year attribute whose value is less than or equal to '1989': <code>"lessThanOrEquals": \{ "key": "year", "value": 1989 \}</code> </p>
695
+ * @public
696
+ */
697
+ interface LessThanOrEqualsMember {
698
+ equals?: never;
699
+ notEquals?: never;
700
+ greaterThan?: never;
701
+ greaterThanOrEquals?: never;
702
+ lessThan?: never;
703
+ lessThanOrEquals: FilterAttribute;
704
+ in?: never;
705
+ notIn?: never;
706
+ startsWith?: never;
707
+ listContains?: never;
708
+ stringContains?: never;
709
+ andAll?: never;
710
+ orAll?: never;
711
+ $unknown?: never;
712
+ }
713
+ /**
714
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.</p> <p>The following example would return data sources with an animal attribute that is either 'cat' or 'dog': <code>"in": \{ "key": "animal", "value": ["cat", "dog"] \}</code> </p>
715
+ * @public
716
+ */
717
+ interface InMember {
718
+ equals?: never;
719
+ notEquals?: never;
720
+ greaterThan?: never;
721
+ greaterThanOrEquals?: never;
722
+ lessThan?: never;
723
+ lessThanOrEquals?: never;
724
+ in: FilterAttribute;
725
+ notIn?: never;
726
+ startsWith?: never;
727
+ listContains?: never;
728
+ stringContains?: never;
729
+ andAll?: never;
730
+ orAll?: never;
731
+ $unknown?: never;
732
+ }
733
+ /**
734
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.</p> <p>The following example would return data sources whose animal attribute is neither 'cat' nor 'dog': <code>"notIn": \{ "key": "animal", "value": ["cat", "dog"] \}</code> </p>
735
+ * @public
736
+ */
737
+ interface NotInMember {
738
+ equals?: never;
739
+ notEquals?: never;
740
+ greaterThan?: never;
741
+ greaterThanOrEquals?: never;
742
+ lessThan?: never;
743
+ lessThanOrEquals?: never;
744
+ in?: never;
745
+ notIn: FilterAttribute;
746
+ startsWith?: never;
747
+ listContains?: never;
748
+ stringContains?: never;
749
+ andAll?: never;
750
+ orAll?: never;
751
+ $unknown?: never;
752
+ }
753
+ /**
754
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.</p> <p>The following example would return data sources with an animal attribute starts with 'ca' (for example, 'cat' or 'camel'). <code>"startsWith": \{ "key": "animal", "value": "ca" \}</code> </p>
755
+ * @public
756
+ */
757
+ interface StartsWithMember {
758
+ equals?: never;
759
+ notEquals?: never;
760
+ greaterThan?: never;
761
+ greaterThanOrEquals?: never;
762
+ lessThan?: never;
763
+ lessThanOrEquals?: never;
764
+ in?: never;
765
+ notIn?: never;
766
+ startsWith: FilterAttribute;
767
+ listContains?: never;
768
+ stringContains?: never;
769
+ andAll?: never;
770
+ orAll?: never;
771
+ $unknown?: never;
772
+ }
773
+ /**
774
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.</p> <p>The following example would return data sources with an animals attribute that is a list containing a cat member (for example, <code>["dog", "cat"]</code>): <code>"listContains": \{ "key": "animals", "value": "cat" \}</code> </p>
775
+ * @public
776
+ */
777
+ interface ListContainsMember {
778
+ equals?: never;
779
+ notEquals?: never;
780
+ greaterThan?: never;
781
+ greaterThanOrEquals?: never;
782
+ lessThan?: never;
783
+ lessThanOrEquals?: never;
784
+ in?: never;
785
+ notIn?: never;
786
+ startsWith?: never;
787
+ listContains: FilterAttribute;
788
+ stringContains?: never;
789
+ andAll?: never;
790
+ orAll?: never;
791
+ $unknown?: never;
792
+ }
793
+ /**
794
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:</p> <p>A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example, 'cat'): <code>"stringContains": \{ "key": "animal", "value": "at" \}</code> </p> <p>A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example, <code>["dog", "cat"]</code>): <code>"stringContains": \{ "key": "animals", "value": "at" \}</code> </p>
795
+ * @public
796
+ */
797
+ interface StringContainsMember {
798
+ equals?: never;
799
+ notEquals?: never;
800
+ greaterThan?: never;
801
+ greaterThanOrEquals?: never;
802
+ lessThan?: never;
803
+ lessThanOrEquals?: never;
804
+ in?: never;
805
+ notIn?: never;
806
+ startsWith?: never;
807
+ listContains?: never;
808
+ stringContains: FilterAttribute;
809
+ andAll?: never;
810
+ orAll?: never;
811
+ $unknown?: never;
812
+ }
813
+ /**
814
+ * <p>Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.</p>
815
+ * @public
816
+ */
817
+ interface AndAllMember {
818
+ equals?: never;
819
+ notEquals?: never;
820
+ greaterThan?: never;
821
+ greaterThanOrEquals?: never;
822
+ lessThan?: never;
823
+ lessThanOrEquals?: never;
824
+ in?: never;
825
+ notIn?: never;
826
+ startsWith?: never;
827
+ listContains?: never;
828
+ stringContains?: never;
829
+ andAll: RetrievalFilter[];
830
+ orAll?: never;
831
+ $unknown?: never;
832
+ }
833
+ /**
834
+ * <p>Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.</p>
835
+ * @public
836
+ */
837
+ interface OrAllMember {
838
+ equals?: never;
839
+ notEquals?: never;
840
+ greaterThan?: never;
841
+ greaterThanOrEquals?: never;
842
+ lessThan?: never;
843
+ lessThanOrEquals?: never;
844
+ in?: never;
845
+ notIn?: never;
846
+ startsWith?: never;
847
+ listContains?: never;
848
+ stringContains?: never;
849
+ andAll?: never;
850
+ orAll: RetrievalFilter[];
851
+ $unknown?: never;
852
+ }
853
+ /**
854
+ * @public
855
+ */
856
+ interface $UnknownMember {
857
+ equals?: never;
858
+ notEquals?: never;
859
+ greaterThan?: never;
860
+ greaterThanOrEquals?: never;
861
+ lessThan?: never;
862
+ lessThanOrEquals?: never;
863
+ in?: never;
864
+ notIn?: never;
865
+ startsWith?: never;
866
+ listContains?: never;
867
+ stringContains?: never;
868
+ andAll?: never;
869
+ orAll?: never;
870
+ $unknown: [string, any];
871
+ }
872
+ interface Visitor<T> {
873
+ equals: (value: FilterAttribute) => T;
874
+ notEquals: (value: FilterAttribute) => T;
875
+ greaterThan: (value: FilterAttribute) => T;
876
+ greaterThanOrEquals: (value: FilterAttribute) => T;
877
+ lessThan: (value: FilterAttribute) => T;
878
+ lessThanOrEquals: (value: FilterAttribute) => T;
879
+ in: (value: FilterAttribute) => T;
880
+ notIn: (value: FilterAttribute) => T;
881
+ startsWith: (value: FilterAttribute) => T;
882
+ listContains: (value: FilterAttribute) => T;
883
+ stringContains: (value: FilterAttribute) => T;
884
+ andAll: (value: RetrievalFilter[]) => T;
885
+ orAll: (value: RetrievalFilter[]) => T;
886
+ _: (name: string, value: any) => T;
887
+ }
888
+ const visit: <T>(value: RetrievalFilter, visitor: Visitor<T>) => T;
889
+ }
2
890
  /**
3
891
  * <p>The configuration details for returning the results from the knowledge base vector search.</p>
4
892
  * @public
@@ -355,6 +1243,18 @@ export interface GetEvaluationJobResponse {
355
1243
  */
356
1244
  failureMessages?: string[] | undefined;
357
1245
  }
1246
+ /**
1247
+ * @internal
1248
+ */
1249
+ export declare const CreateModelCustomizationJobRequestFilterSensitiveLog: (obj: CreateModelCustomizationJobRequest) => any;
1250
+ /**
1251
+ * @internal
1252
+ */
1253
+ export declare const GetModelCustomizationJobResponseFilterSensitiveLog: (obj: GetModelCustomizationJobResponse) => any;
1254
+ /**
1255
+ * @internal
1256
+ */
1257
+ export declare const RetrievalFilterFilterSensitiveLog: (obj: RetrievalFilter) => any;
358
1258
  /**
359
1259
  * @internal
360
1260
  */