@aws-sdk/client-bedrock 3.699.0 → 3.705.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 (27) hide show
  1. package/dist-cjs/index.js +770 -36
  2. package/dist-es/commands/CreateModelCustomizationJobCommand.js +2 -1
  3. package/dist-es/commands/GetCustomModelCommand.js +2 -1
  4. package/dist-es/commands/GetModelCustomizationJobCommand.js +2 -1
  5. package/dist-es/models/models_0.js +291 -24
  6. package/dist-es/protocols/Aws_restJson1.js +410 -3
  7. package/dist-types/commands/BatchDeleteEvaluationJobCommand.d.ts +3 -1
  8. package/dist-types/commands/CreateEvaluationJobCommand.d.ts +156 -2
  9. package/dist-types/commands/CreateGuardrailCommand.d.ts +1 -1
  10. package/dist-types/commands/CreateModelCustomizationJobCommand.d.ts +43 -3
  11. package/dist-types/commands/GetCustomModelCommand.d.ts +42 -2
  12. package/dist-types/commands/GetEvaluationJobCommand.d.ts +156 -3
  13. package/dist-types/commands/GetFoundationModelCommand.d.ts +1 -1
  14. package/dist-types/commands/GetModelCustomizationJobCommand.d.ts +43 -3
  15. package/dist-types/commands/GetModelInvocationJobCommand.d.ts +1 -1
  16. package/dist-types/commands/GetModelInvocationLoggingConfigurationCommand.d.ts +1 -0
  17. package/dist-types/commands/ListCustomModelsCommand.d.ts +1 -1
  18. package/dist-types/commands/ListEvaluationJobsCommand.d.ts +10 -2
  19. package/dist-types/commands/ListFoundationModelsCommand.d.ts +2 -2
  20. package/dist-types/commands/ListModelCustomizationJobsCommand.d.ts +1 -1
  21. package/dist-types/commands/ListModelInvocationJobsCommand.d.ts +1 -1
  22. package/dist-types/commands/PutModelInvocationLoggingConfigurationCommand.d.ts +1 -0
  23. package/dist-types/commands/StopEvaluationJobCommand.d.ts +1 -1
  24. package/dist-types/commands/StopModelInvocationJobCommand.d.ts +1 -1
  25. package/dist-types/models/models_0.d.ts +1585 -175
  26. package/dist-types/ts3.4/models/models_0.d.ts +683 -55
  27. package/package.json +1 -1
@@ -1,4 +1,5 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { DocumentType as __DocumentType } from "@smithy/types";
2
3
  import { BedrockServiceException as __BaseException } from "./BedrockServiceException";
3
4
  /**
4
5
  * <p>The request is denied because of missing access permissions.</p>
@@ -17,28 +18,28 @@ export declare class AccessDeniedException extends __BaseException {
17
18
  */
18
19
  export interface BatchDeleteEvaluationJobRequest {
19
20
  /**
20
- * <p>An array of model evaluation job ARNs to be deleted.</p>
21
+ * <p>A list of one or more evaluation job Amazon Resource Names (ARNs) you want to delete.</p>
21
22
  * @public
22
23
  */
23
24
  jobIdentifiers: string[] | undefined;
24
25
  }
25
26
  /**
26
- * <p>A JSON array that provides the status of the model evaluation jobs being deleted.</p>
27
+ * <p>A JSON array that provides the status of the evaluation jobs being deleted.</p>
27
28
  * @public
28
29
  */
29
30
  export interface BatchDeleteEvaluationJobError {
30
31
  /**
31
- * <p>The ARN of the model evaluation job being deleted.</p>
32
+ * <p>The ARN of the evaluation job being deleted.</p>
32
33
  * @public
33
34
  */
34
35
  jobIdentifier: string | undefined;
35
36
  /**
36
- * <p>A HTTP status code of the model evaluation job being deleted.</p>
37
+ * <p>A HTTP status code of the evaluation job being deleted.</p>
37
38
  * @public
38
39
  */
39
40
  code: string | undefined;
40
41
  /**
41
- * <p>A status message about the model evaluation job deletion.</p>
42
+ * <p>A status message about the evaluation job deletion.</p>
42
43
  * @public
43
44
  */
44
45
  message?: string | undefined;
@@ -60,17 +61,17 @@ export declare const EvaluationJobStatus: {
60
61
  */
61
62
  export type EvaluationJobStatus = (typeof EvaluationJobStatus)[keyof typeof EvaluationJobStatus];
62
63
  /**
63
- * <p>An array of model evaluation jobs to be deleted, and their associated statuses.</p>
64
+ * <p>An evaluation job for deletion, and it’s current status.</p>
64
65
  * @public
65
66
  */
66
67
  export interface BatchDeleteEvaluationJobItem {
67
68
  /**
68
- * <p>The ARN of model evaluation job to be deleted.</p>
69
+ * <p>The Amazon Resource Name (ARN) of the evaluation job for deletion.</p>
69
70
  * @public
70
71
  */
71
72
  jobIdentifier: string | undefined;
72
73
  /**
73
- * <p>The status of the job's deletion.</p>
74
+ * <p>The status of the evaluation job for deletion.</p>
74
75
  * @public
75
76
  */
76
77
  jobStatus: EvaluationJobStatus | undefined;
@@ -80,12 +81,12 @@ export interface BatchDeleteEvaluationJobItem {
80
81
  */
81
82
  export interface BatchDeleteEvaluationJobResponse {
82
83
  /**
83
- * <p>A JSON object containing the HTTP status codes and the ARNs of model evaluation jobs that failed to be deleted.</p>
84
+ * <p>A JSON object containing the HTTP status codes and the ARNs of evaluation jobs that failed to be deleted.</p>
84
85
  * @public
85
86
  */
86
87
  errors: BatchDeleteEvaluationJobError[] | undefined;
87
88
  /**
88
- * <p>The list of model evaluation jobs to be deleted.</p>
89
+ * <p>The list of evaluation jobs for deletion.</p>
89
90
  * @public
90
91
  */
91
92
  evaluationJobs: BatchDeleteEvaluationJobItem[] | undefined;
@@ -150,6 +151,18 @@ export declare class ValidationException extends __BaseException {
150
151
  */
151
152
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
152
153
  }
154
+ /**
155
+ * @public
156
+ * @enum
157
+ */
158
+ export declare const ApplicationType: {
159
+ readonly MODEL_EVALUATION: "ModelEvaluation";
160
+ readonly RAG_EVALUATION: "RagEvaluation";
161
+ };
162
+ /**
163
+ * @public
164
+ */
165
+ export type ApplicationType = (typeof ApplicationType)[keyof typeof ApplicationType];
153
166
  /**
154
167
  * <p>The location in Amazon S3 where your prompt dataset is stored.</p>
155
168
  * @public
@@ -212,12 +225,13 @@ export declare const EvaluationTaskType: {
212
225
  */
213
226
  export type EvaluationTaskType = (typeof EvaluationTaskType)[keyof typeof EvaluationTaskType];
214
227
  /**
215
- * <p>Defines the built-in prompt datasets, built-in metric names and custom metric names, and the task type.</p>
228
+ * <p>Defines the prompt datasets, built-in metric names and custom metric names, and the task type.</p>
216
229
  * @public
217
230
  */
218
231
  export interface EvaluationDatasetMetricConfig {
219
232
  /**
220
- * <p>The task type you want the model to carry out. </p>
233
+ * <p>The the type of task you want to evaluate for your evaluation job. This applies only
234
+ * to model evaluation jobs and is ignored for knowledge base evaluation jobs.</p>
221
235
  * @public
222
236
  */
223
237
  taskType: EvaluationTaskType | undefined;
@@ -227,21 +241,78 @@ export interface EvaluationDatasetMetricConfig {
227
241
  */
228
242
  dataset: EvaluationDataset | undefined;
229
243
  /**
230
- * <p>The names of the metrics used. For automated model evaluation jobs valid values are <code>"Builtin.Accuracy"</code>, <code>"Builtin.Robustness"</code>, and <code>"Builtin.Toxicity"</code>. In human-based model evaluation jobs the array of strings must match the <code>name</code> parameter specified in <code>HumanEvaluationCustomMetric</code>. </p>
244
+ * <p>The names of the metrics you want to use for your evaluation job.</p>
245
+ * <p>For knowledge base evaluation jobs that evaluate retrieval only, valid values are
246
+ * "<code>Builtin.ContextRelevance</code>", "<code>Builtin.ContextConverage</code>".</p>
247
+ * <p>For knowledge base evaluation jobs that evaluate retrieval with response generation,
248
+ * valid values are "<code>Builtin.Correctness</code>", "<code>Builtin.Completeness</code>",
249
+ * "<code>Builtin.Helpfulness</code>", "<code>Builtin.LogicalCoherence</code>",
250
+ * "<code>Builtin.Faithfulness</code>", "<code>Builtin.Harmfulness</code>",
251
+ * "<code>Builtin.Stereotyping</code>", "<code>Builtin.Refusal</code>".</p>
252
+ * <p>For automated model evaluation jobs, valid values are "<code>Builtin.Accuracy</code>", "<code>Builtin.Robustness</code>", and "<code>Builtin.Toxicity</code>". In model evaluation jobs that use a LLM as judge you can specify "<code>Builtin.Correctness</code>", "<code>Builtin.Completeness"</code>, "<code>Builtin.Faithfulness"</code>, "<code>Builtin.Helpfulness</code>", "<code>Builtin.Coherence</code>", "<code>Builtin.Relevance</code>", "<code>Builtin.FollowingInstructions</code>", "<code>Builtin.ProfessionalStyleAndTone</code>", You can also specify the following responsible AI related metrics only for model evaluation job that use a LLM as judge "<code>Builtin.Harmfulness</code>", "<code>Builtin.Stereotyping</code>", and "<code>Builtin.Refusal</code>".</p>
253
+ * <p>For human-based model evaluation jobs, the list of strings must match the
254
+ * <code>name</code> parameter specified in <code>HumanEvaluationCustomMetric</code>.</p>
231
255
  * @public
232
256
  */
233
257
  metricNames: string[] | undefined;
234
258
  }
235
259
  /**
236
- * <p>Use to specify a automatic model evaluation job. The <code>EvaluationDatasetMetricConfig</code> object is used to specify the prompt datasets, task type, and metric names.</p>
260
+ * <p>The evaluator model used in knowledge base evaluation job or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.</p>
261
+ * @public
262
+ */
263
+ export interface BedrockEvaluatorModel {
264
+ /**
265
+ * <p>The Amazon Resource Name (ARN) of the evaluator model used used in knowledge base evaluation job or in model evaluation job that use a model as judge.</p>
266
+ * @public
267
+ */
268
+ modelIdentifier: string | undefined;
269
+ }
270
+ /**
271
+ * <p>Specifies the model configuration for the evaluator model. <code>EvaluatorModelConfig</code> is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.</p>
272
+ * @public
273
+ */
274
+ export type EvaluatorModelConfig = EvaluatorModelConfig.BedrockEvaluatorModelsMember | EvaluatorModelConfig.$UnknownMember;
275
+ /**
276
+ * @public
277
+ */
278
+ export declare namespace EvaluatorModelConfig {
279
+ /**
280
+ * <p>The evaluator model used in knowledge base evaluation job or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.</p>
281
+ * @public
282
+ */
283
+ interface BedrockEvaluatorModelsMember {
284
+ bedrockEvaluatorModels: BedrockEvaluatorModel[];
285
+ $unknown?: never;
286
+ }
287
+ /**
288
+ * @public
289
+ */
290
+ interface $UnknownMember {
291
+ bedrockEvaluatorModels?: never;
292
+ $unknown: [string, any];
293
+ }
294
+ interface Visitor<T> {
295
+ bedrockEvaluatorModels: (value: BedrockEvaluatorModel[]) => T;
296
+ _: (name: string, value: any) => T;
297
+ }
298
+ const visit: <T>(value: EvaluatorModelConfig, visitor: Visitor<T>) => T;
299
+ }
300
+ /**
301
+ * <p>The configuration details of an automated evaluation job. The <code>EvaluationDatasetMetricConfig</code> object
302
+ * is used to specify the prompt datasets, task type, and metric names.</p>
237
303
  * @public
238
304
  */
239
305
  export interface AutomatedEvaluationConfig {
240
306
  /**
241
- * <p>Specifies the required elements for an automatic model evaluation job.</p>
307
+ * <p>Configuration details of the prompt datasets and metrics you want to use for your evaluation job.</p>
242
308
  * @public
243
309
  */
244
310
  datasetMetricConfigs: EvaluationDatasetMetricConfig[] | undefined;
311
+ /**
312
+ * <p>Contains the evaluator model configuration details. <code>EvaluatorModelConfig</code> is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.</p>
313
+ * @public
314
+ */
315
+ evaluatorModelConfig?: EvaluatorModelConfig | undefined;
245
316
  }
246
317
  /**
247
318
  * <p>In a model evaluation job that uses human workers you must
@@ -306,7 +377,7 @@ export interface HumanEvaluationConfig {
306
377
  datasetMetricConfigs: EvaluationDatasetMetricConfig[] | undefined;
307
378
  }
308
379
  /**
309
- * <p>Used to specify either a <code>AutomatedEvaluationConfig</code> or <code>HumanEvaluationConfig</code> object.</p>
380
+ * <p>The configuration details of either an automated or human-based evaluation job.</p>
310
381
  * @public
311
382
  */
312
383
  export type EvaluationConfig = EvaluationConfig.AutomatedMember | EvaluationConfig.HumanMember | EvaluationConfig.$UnknownMember;
@@ -315,8 +386,7 @@ export type EvaluationConfig = EvaluationConfig.AutomatedMember | EvaluationConf
315
386
  */
316
387
  export declare namespace EvaluationConfig {
317
388
  /**
318
- * <p>Used to specify an automated model evaluation job.
319
- * See <code>AutomatedEvaluationConfig</code> to view the required parameters.</p>
389
+ * <p>Contains the configuration details of an automated evaluation job that computes metrics.</p>
320
390
  * @public
321
391
  */
322
392
  interface AutomatedMember {
@@ -325,7 +395,7 @@ export declare namespace EvaluationConfig {
325
395
  $unknown?: never;
326
396
  }
327
397
  /**
328
- * <p>Used to specify a model evaluation job that uses human workers.See <code>HumanEvaluationConfig</code> to view the required parameters.</p>
398
+ * <p>Contains the configuration details of an evaluation job that uses human workers.</p>
329
399
  * @public
330
400
  */
331
401
  interface HumanMember {
@@ -349,7 +419,7 @@ export declare namespace EvaluationConfig {
349
419
  const visit: <T>(value: EvaluationConfig, visitor: Visitor<T>) => T;
350
420
  }
351
421
  /**
352
- * <p>Contains the ARN of the Amazon Bedrock model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> specified in your model evaluation job. Each Amazon Bedrock model supports different <code>inferenceParams</code>. To learn more about supported inference parameters for Amazon Bedrock models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
422
+ * <p>Contains the ARN of the Amazon Bedrock model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> specified in your evaluation job. Each Amazon Bedrock model supports different <code>inferenceParams</code>. To learn more about supported inference parameters for Amazon Bedrock models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
353
423
  * <p>The <code>inferenceParams</code> are specified using JSON. To successfully insert JSON as string make sure that all quotations are properly escaped. For example, <code>"temperature":"0.25"</code> key value pair would need to be formatted as <code>\"temperature\":\"0.25\"</code> to successfully accepted in the request.</p>
354
424
  * @public
355
425
  */
@@ -363,7 +433,7 @@ export interface EvaluationBedrockModel {
363
433
  * <p>Each Amazon Bedrock support different inference parameters that change how the model behaves during inference.</p>
364
434
  * @public
365
435
  */
366
- inferenceParams: string | undefined;
436
+ inferenceParams?: string | undefined;
367
437
  }
368
438
  /**
369
439
  * <p>Defines the models used in the model evaluation job.</p>
@@ -396,227 +466,380 @@ export declare namespace EvaluationModelConfig {
396
466
  const visit: <T>(value: EvaluationModelConfig, visitor: Visitor<T>) => T;
397
467
  }
398
468
  /**
399
- * <p>Used to define the models you want used in your model evaluation job. Automated model evaluation jobs support only a single model. In a human-based model evaluation job, your annotator can compare the responses for up to two different models.</p>
469
+ * <p>The configuration details for the guardrail.</p>
400
470
  * @public
401
471
  */
402
- export type EvaluationInferenceConfig = EvaluationInferenceConfig.ModelsMember | EvaluationInferenceConfig.$UnknownMember;
403
- /**
404
- * @public
405
- */
406
- export declare namespace EvaluationInferenceConfig {
472
+ export interface GuardrailConfiguration {
407
473
  /**
408
- * <p>Used to specify the models.</p>
474
+ * <p>The unique identifier for the guardrail.</p>
409
475
  * @public
410
476
  */
411
- interface ModelsMember {
412
- models: EvaluationModelConfig[];
413
- $unknown?: never;
414
- }
477
+ guardrailId: string | undefined;
415
478
  /**
479
+ * <p>The version of the guardrail.</p>
416
480
  * @public
417
481
  */
418
- interface $UnknownMember {
419
- models?: never;
420
- $unknown: [string, any];
421
- }
422
- interface Visitor<T> {
423
- models: (value: EvaluationModelConfig[]) => T;
424
- _: (name: string, value: any) => T;
425
- }
426
- const visit: <T>(value: EvaluationInferenceConfig, visitor: Visitor<T>) => T;
482
+ guardrailVersion: string | undefined;
427
483
  }
428
484
  /**
429
- * <p>Definition of the key/value pair for a tag.</p>
485
+ * <p>The configuration details for text generation using a language model via the
486
+ * <code>RetrieveAndGenerate</code> function.</p>
430
487
  * @public
431
488
  */
432
- export interface Tag {
489
+ export interface TextInferenceConfig {
433
490
  /**
434
- * <p>Key for the tag.</p>
491
+ * <p>Controls the random-ness of text generated by the language model, influencing how
492
+ * much the model sticks to the most predictable next words versus exploring more
493
+ * surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs
494
+ * more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes
495
+ * the outputs more creative or unpredictable.</p>
435
496
  * @public
436
497
  */
437
- key: string | undefined;
498
+ temperature?: number | undefined;
438
499
  /**
439
- * <p>Value for the tag.</p>
500
+ * <p>A probability distribution threshold which controls what the model considers for
501
+ * the set of possible next tokens. The model will only consider the top p% of the
502
+ * probability distribution when generating the next token.</p>
440
503
  * @public
441
504
  */
442
- value: string | undefined;
505
+ topP?: number | undefined;
506
+ /**
507
+ * <p>The maximum number of tokens to generate in the output text. Do not use the minimum of 0
508
+ * or the maximum of 65536. The limit values described here are arbitrary values, for actual
509
+ * values consult the limits defined by your specific model.</p>
510
+ * @public
511
+ */
512
+ maxTokens?: number | undefined;
513
+ /**
514
+ * <p>A list of sequences of characters that, if generated, will cause the model to stop
515
+ * generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000.
516
+ * The limit values described here are arbitrary values, for actual values consult the
517
+ * limits defined by your specific model.</p>
518
+ * @public
519
+ */
520
+ stopSequences?: string[] | undefined;
443
521
  }
444
522
  /**
445
- * <p>The Amazon S3 location where the results of your model evaluation job are saved.</p>
523
+ * <p>Contains configuration details of the inference for knowledge base retrieval and response generation.</p>
446
524
  * @public
447
525
  */
448
- export interface EvaluationOutputDataConfig {
526
+ export interface KbInferenceConfig {
449
527
  /**
450
- * <p>The Amazon S3 URI where the results of model evaluation job are saved.</p>
528
+ * <p>Contains configuration details for text generation using a language model via the
529
+ * <code>RetrieveAndGenerate</code> function.</p>
451
530
  * @public
452
531
  */
453
- s3Uri: string | undefined;
532
+ textInferenceConfig?: TextInferenceConfig | undefined;
454
533
  }
455
534
  /**
535
+ * <p>The template for the prompt that's sent to the model for response generation.</p>
456
536
  * @public
457
537
  */
458
- export interface CreateEvaluationJobRequest {
538
+ export interface PromptTemplate {
459
539
  /**
460
- * <p>The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.</p>
540
+ * <p>The template for the prompt that's sent to the model for response generation. You can include
541
+ * prompt placeholders, which become replaced before the prompt is sent to the model to provide
542
+ * instructions and context to the model. In addition, you can include XML tags to delineate
543
+ * meaningful sections of the prompt template.</p>
544
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Knowledge base prompt template</a> and
545
+ * <a href="https://docs.anthropic.com/en/docs/build-with-claude/prompt-engineering/use-xml-tags">Use XML tags with Anthropic Claude models</a>.</p>
461
546
  * @public
462
547
  */
463
- jobName: string | undefined;
548
+ textPromptTemplate?: string | undefined;
549
+ }
550
+ /**
551
+ * <p>The response generation configuration of the external source wrapper object.</p>
552
+ * @public
553
+ */
554
+ export interface ExternalSourcesGenerationConfiguration {
464
555
  /**
465
- * <p>A description of the model evaluation job.</p>
556
+ * <p>Contains the template for the prompt for the external source wrapper object.</p>
466
557
  * @public
467
558
  */
468
- jobDescription?: string | undefined;
559
+ promptTemplate?: PromptTemplate | undefined;
469
560
  /**
470
- * <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,
471
- * 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>
561
+ * <p>Configuration details for the guardrail.</p>
472
562
  * @public
473
563
  */
474
- clientRequestToken?: string | undefined;
564
+ guardrailConfiguration?: GuardrailConfiguration | undefined;
475
565
  /**
476
- * <p>The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the <code>EvaluationConfig</code> object. To pass this role to Amazon Bedrock, the caller of this API must have the <code>iam:PassRole</code> permission. To learn more about the required permissions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-security.html">Required permissions</a>.</p>
566
+ * <p>Configuration details for inference when using <code>RetrieveAndGenerate</code> to generate
567
+ * responses while using an external source.</p>
477
568
  * @public
478
569
  */
479
- roleArn: string | undefined;
570
+ kbInferenceConfig?: KbInferenceConfig | undefined;
480
571
  /**
481
- * <p>Specify your customer managed key ARN that will be used to encrypt your model evaluation job.</p>
572
+ * <p>Additional model parameters and their corresponding values not included in the
573
+ * text inference configuration for an external source. Takes in custom model parameters
574
+ * specific to the language model being used.</p>
482
575
  * @public
483
576
  */
484
- customerEncryptionKeyId?: string | undefined;
577
+ additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
578
+ }
579
+ /**
580
+ * <p>Contains the document contained in the wrapper object, along with its attributes/fields.</p>
581
+ * @public
582
+ */
583
+ export interface ByteContentDoc {
485
584
  /**
486
- * <p>Tags to attach to the model evaluation job.</p>
585
+ * <p>The file name of the document contained in the wrapper object.</p>
487
586
  * @public
488
587
  */
489
- jobTags?: Tag[] | undefined;
588
+ identifier: string | undefined;
490
589
  /**
491
- * <p>Specifies whether the model evaluation job is automatic or uses human worker.</p>
590
+ * <p>The MIME type of the document contained in the wrapper object.</p>
492
591
  * @public
493
592
  */
494
- evaluationConfig: EvaluationConfig | undefined;
593
+ contentType: string | undefined;
495
594
  /**
496
- * <p>Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a>, and model evaluation job that use human workers support two models or inference profiles.</p>
595
+ * <p>The byte value of the file to upload, encoded as a Base-64 string.</p>
497
596
  * @public
498
597
  */
499
- inferenceConfig: EvaluationInferenceConfig | undefined;
598
+ data: Uint8Array | undefined;
599
+ }
600
+ /**
601
+ * <p>The unique wrapper object of the document from the S3 location.</p>
602
+ * @public
603
+ */
604
+ export interface S3ObjectDoc {
500
605
  /**
501
- * <p>An object that defines where the results of model evaluation job will be saved in Amazon S3.</p>
606
+ * <p>The S3 URI location for the wrapper object of the document.</p>
502
607
  * @public
503
608
  */
504
- outputDataConfig: EvaluationOutputDataConfig | undefined;
609
+ uri: string | undefined;
505
610
  }
506
611
  /**
507
612
  * @public
613
+ * @enum
508
614
  */
509
- export interface CreateEvaluationJobResponse {
615
+ export declare const ExternalSourceType: {
616
+ readonly BYTE_CONTENT: "BYTE_CONTENT";
617
+ readonly S3: "S3";
618
+ };
619
+ /**
620
+ * @public
621
+ */
622
+ export type ExternalSourceType = (typeof ExternalSourceType)[keyof typeof ExternalSourceType];
623
+ /**
624
+ * <p>The unique external source of the content contained in the wrapper object.</p>
625
+ * @public
626
+ */
627
+ export interface ExternalSource {
510
628
  /**
511
- * <p>The ARN of the model evaluation job.</p>
629
+ * <p>The source type of the external source wrapper object.</p>
512
630
  * @public
513
631
  */
514
- jobArn: string | undefined;
632
+ sourceType: ExternalSourceType | undefined;
633
+ /**
634
+ * <p>The S3 location of the external source wrapper object.</p>
635
+ * @public
636
+ */
637
+ s3Location?: S3ObjectDoc | undefined;
638
+ /**
639
+ * <p>The identifier, content type, and data of the external source wrapper object.</p>
640
+ * @public
641
+ */
642
+ byteContent?: ByteContentDoc | undefined;
515
643
  }
516
644
  /**
517
- * <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
645
+ * <p>The configuration of the external source wrapper object in the <code>retrieveAndGenerate</code>
646
+ * function.</p>
518
647
  * @public
519
648
  */
520
- export declare class ServiceQuotaExceededException extends __BaseException {
521
- readonly name: "ServiceQuotaExceededException";
522
- readonly $fault: "client";
649
+ export interface ExternalSourcesRetrieveAndGenerateConfiguration {
523
650
  /**
524
- * @internal
651
+ * <p>The Amazon Resource Name (ARN) of the foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a>
652
+ * used to generate responses.
653
+ * </p>
654
+ * @public
525
655
  */
526
- constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
656
+ modelArn: string | undefined;
657
+ /**
658
+ * <p>The document for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
659
+ * @public
660
+ */
661
+ sources: ExternalSource[] | undefined;
662
+ /**
663
+ * <p>Contains configurations details for response generation based on retrieved text chunks.</p>
664
+ * @public
665
+ */
666
+ generationConfiguration?: ExternalSourcesGenerationConfiguration | undefined;
527
667
  }
528
668
  /**
669
+ * <p>The configuration details for response generation based on retrieved text chunks.</p>
529
670
  * @public
530
671
  */
531
- export interface GetEvaluationJobRequest {
672
+ export interface GenerationConfiguration {
532
673
  /**
533
- * <p>The Amazon Resource Name (ARN) of the model evaluation job.</p>
674
+ * <p>Contains the template for the prompt that's sent to the model for response generation.</p>
534
675
  * @public
535
676
  */
536
- jobIdentifier: string | undefined;
677
+ promptTemplate?: PromptTemplate | undefined;
678
+ /**
679
+ * <p>Contains configuration details for the guardrail.</p>
680
+ * @public
681
+ */
682
+ guardrailConfiguration?: GuardrailConfiguration | undefined;
683
+ /**
684
+ * <p>Contains configuration details for inference for knowledge base retrieval and response generation.</p>
685
+ * @public
686
+ */
687
+ kbInferenceConfig?: KbInferenceConfig | undefined;
688
+ /**
689
+ * <p>Additional model parameters and corresponding values not included in the
690
+ * <code>textInferenceConfig</code> structure for a knowledge base. This allows
691
+ * you to provide custom model parameters specific to the language model being
692
+ * used.</p>
693
+ * @public
694
+ */
695
+ additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
537
696
  }
538
697
  /**
539
698
  * @public
540
699
  * @enum
541
700
  */
542
- export declare const EvaluationJobType: {
543
- readonly AUTOMATED: "Automated";
544
- readonly HUMAN: "Human";
701
+ export declare const QueryTransformationType: {
702
+ readonly QUERY_DECOMPOSITION: "QUERY_DECOMPOSITION";
545
703
  };
546
704
  /**
547
705
  * @public
548
706
  */
549
- export type EvaluationJobType = (typeof EvaluationJobType)[keyof typeof EvaluationJobType];
707
+ export type QueryTransformationType = (typeof QueryTransformationType)[keyof typeof QueryTransformationType];
550
708
  /**
709
+ * <p>The configuration details for transforming the prompt.</p>
551
710
  * @public
552
711
  */
553
- export interface GetEvaluationJobResponse {
712
+ export interface QueryTransformationConfiguration {
554
713
  /**
555
- * <p>The name of the model evaluation job.</p>
714
+ * <p>The type of transformation to apply to the prompt.</p>
556
715
  * @public
557
716
  */
558
- jobName: string | undefined;
559
- /**
560
- * <p>The status of the model evaluation job.</p>
561
- * @public
562
- */
563
- status: EvaluationJobStatus | undefined;
564
- /**
565
- * <p>The Amazon Resource Name (ARN) of the model evaluation job.</p>
566
- * @public
567
- */
568
- jobArn: string | undefined;
569
- /**
570
- * <p>The description of the model evaluation job.</p>
571
- * @public
572
- */
573
- jobDescription?: string | undefined;
717
+ type: QueryTransformationType | undefined;
718
+ }
719
+ /**
720
+ * <p>The configuration details for the model to process the prompt prior to retrieval and response generation.</p>
721
+ * @public
722
+ */
723
+ export interface OrchestrationConfiguration {
574
724
  /**
575
- * <p>The Amazon Resource Name (ARN) of the IAM service role used in the model evaluation job.</p>
725
+ * <p>Contains configuration details for transforming the prompt.</p>
576
726
  * @public
577
727
  */
578
- roleArn: string | undefined;
728
+ queryTransformationConfiguration: QueryTransformationConfiguration | undefined;
729
+ }
730
+ /**
731
+ * <p>Specifies the name of the metadata attribute/field to apply filters.
732
+ * You must match the name of the attribute/field in your data source/document metadata.</p>
733
+ * @public
734
+ */
735
+ export interface FilterAttribute {
579
736
  /**
580
- * <p>The Amazon Resource Name (ARN) of the customer managed key specified when the model evaluation job was created.</p>
737
+ * <p>The name of metadata attribute/field, which must match the name in your
738
+ * data source/document metadata.</p>
581
739
  * @public
582
740
  */
583
- customerEncryptionKeyId?: string | undefined;
741
+ key: string | undefined;
584
742
  /**
585
- * <p>The type of model evaluation job.</p>
743
+ * <p>The value of the metadata attribute/field.</p>
586
744
  * @public
587
745
  */
588
- jobType: EvaluationJobType | undefined;
746
+ value: __DocumentType | undefined;
747
+ }
748
+ /**
749
+ * @public
750
+ * @enum
751
+ */
752
+ export declare const SearchType: {
753
+ readonly HYBRID: "HYBRID";
754
+ readonly SEMANTIC: "SEMANTIC";
755
+ };
756
+ /**
757
+ * @public
758
+ */
759
+ export type SearchType = (typeof SearchType)[keyof typeof SearchType];
760
+ /**
761
+ * @public
762
+ * @enum
763
+ */
764
+ export declare const RetrieveAndGenerateType: {
765
+ readonly EXTERNAL_SOURCES: "EXTERNAL_SOURCES";
766
+ readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
767
+ };
768
+ /**
769
+ * @public
770
+ */
771
+ export type RetrieveAndGenerateType = (typeof RetrieveAndGenerateType)[keyof typeof RetrieveAndGenerateType];
772
+ /**
773
+ * <p>Definition of the key/value pair for a tag.</p>
774
+ * @public
775
+ */
776
+ export interface Tag {
589
777
  /**
590
- * <p>Contains details about the type of model evaluation job, the metrics used, the task type selected, the datasets used, and any custom metrics you defined.</p>
778
+ * <p>Key for the tag.</p>
591
779
  * @public
592
780
  */
593
- evaluationConfig: EvaluationConfig | undefined;
781
+ key: string | undefined;
594
782
  /**
595
- * <p>Details about the models you specified in your model evaluation job.</p>
783
+ * <p>Value for the tag.</p>
596
784
  * @public
597
785
  */
598
- inferenceConfig: EvaluationInferenceConfig | undefined;
786
+ value: string | undefined;
787
+ }
788
+ /**
789
+ * <p>The Amazon S3 location where the results of your evaluation job are saved.</p>
790
+ * @public
791
+ */
792
+ export interface EvaluationOutputDataConfig {
599
793
  /**
600
- * <p>Amazon S3 location for where output data is saved.</p>
794
+ * <p>The Amazon S3 URI where the results of the evaluation job are saved.</p>
601
795
  * @public
602
796
  */
603
- outputDataConfig: EvaluationOutputDataConfig | undefined;
797
+ s3Uri: string | undefined;
798
+ }
799
+ /**
800
+ * @public
801
+ */
802
+ export interface CreateEvaluationJobResponse {
604
803
  /**
605
- * <p>When the model evaluation job was created.</p>
804
+ * <p>The Amazon Resource Name (ARN) of the evaluation job.</p>
606
805
  * @public
607
806
  */
608
- creationTime: Date | undefined;
807
+ jobArn: string | undefined;
808
+ }
809
+ /**
810
+ * <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
811
+ * @public
812
+ */
813
+ export declare class ServiceQuotaExceededException extends __BaseException {
814
+ readonly name: "ServiceQuotaExceededException";
815
+ readonly $fault: "client";
609
816
  /**
610
- * <p>When the model evaluation job was last modified.</p>
611
- * @public
817
+ * @internal
612
818
  */
613
- lastModifiedTime?: Date | undefined;
819
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
820
+ }
821
+ /**
822
+ * @public
823
+ */
824
+ export interface GetEvaluationJobRequest {
614
825
  /**
615
- * <p>An array of strings the specify why the model evaluation job has failed.</p>
826
+ * <p>The Amazon Resource Name (ARN) of the evaluation job you want get information on.</p>
616
827
  * @public
617
828
  */
618
- failureMessages?: string[] | undefined;
829
+ jobIdentifier: string | undefined;
619
830
  }
831
+ /**
832
+ * @public
833
+ * @enum
834
+ */
835
+ export declare const EvaluationJobType: {
836
+ readonly AUTOMATED: "Automated";
837
+ readonly HUMAN: "Human";
838
+ };
839
+ /**
840
+ * @public
841
+ */
842
+ export type EvaluationJobType = (typeof EvaluationJobType)[keyof typeof EvaluationJobType];
620
843
  /**
621
844
  * @public
622
845
  * @enum
@@ -645,22 +868,27 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
645
868
  */
646
869
  export interface ListEvaluationJobsRequest {
647
870
  /**
648
- * <p>A filter that includes model evaluation jobs created after the time specified.</p>
871
+ * <p>A filter to only list evaluation jobs created after a specified time.</p>
649
872
  * @public
650
873
  */
651
874
  creationTimeAfter?: Date | undefined;
652
875
  /**
653
- * <p>A filter that includes model evaluation jobs created prior to the time specified.</p>
876
+ * <p>A filter to only list evaluation jobs created before a specified time.</p>
654
877
  * @public
655
878
  */
656
879
  creationTimeBefore?: Date | undefined;
657
880
  /**
658
- * <p>Only return jobs where the status condition is met.</p>
881
+ * <p>A filter to only list evaluation jobs that are of a certain status.</p>
659
882
  * @public
660
883
  */
661
884
  statusEquals?: EvaluationJobStatus | undefined;
662
885
  /**
663
- * <p>Query parameter string for model evaluation job names.</p>
886
+ * <p>A filter to only list evaluation jobs that are either model evaluations or knowledge base evaluations.</p>
887
+ * @public
888
+ */
889
+ applicationTypeEquals?: ApplicationType | undefined;
890
+ /**
891
+ * <p>A filter to only list evaluation jobs that contain a specified string in the job name.</p>
664
892
  * @public
665
893
  */
666
894
  nameContains?: string | undefined;
@@ -675,56 +903,71 @@ export interface ListEvaluationJobsRequest {
675
903
  */
676
904
  nextToken?: string | undefined;
677
905
  /**
678
- * <p>Allows you to sort model evaluation jobs by when they were created.</p>
906
+ * <p>Specifies a creation time to sort the list of evaluation jobs by when they were created.</p>
679
907
  * @public
680
908
  */
681
909
  sortBy?: SortJobsBy | undefined;
682
910
  /**
683
- * <p>How you want the order of jobs sorted.</p>
911
+ * <p>Specifies whether to sort the list of evaluation jobs by either ascending or descending order.</p>
684
912
  * @public
685
913
  */
686
914
  sortOrder?: SortOrder | undefined;
687
915
  }
688
916
  /**
689
- * <p>A summary of the model evaluation job.</p>
917
+ * <p>Summary information of an evaluation job.</p>
690
918
  * @public
691
919
  */
692
920
  export interface EvaluationSummary {
693
921
  /**
694
- * <p>The Amazon Resource Name (ARN) of the model evaluation job.</p>
922
+ * <p>The Amazon Resource Name (ARN) of the evaluation job.</p>
695
923
  * @public
696
924
  */
697
925
  jobArn: string | undefined;
698
926
  /**
699
- * <p>The name of the model evaluation job.</p>
927
+ * <p>The name for the evaluation job.</p>
700
928
  * @public
701
929
  */
702
930
  jobName: string | undefined;
703
931
  /**
704
- * <p>The current status of the model evaluation job. </p>
932
+ * <p>The current status of the evaluation job.</p>
705
933
  * @public
706
934
  */
707
935
  status: EvaluationJobStatus | undefined;
708
936
  /**
709
- * <p>When the model evaluation job was created.</p>
937
+ * <p>The time the evaluation job was created.</p>
710
938
  * @public
711
939
  */
712
940
  creationTime: Date | undefined;
713
941
  /**
714
- * <p>The type, either human or automatic, of model evaluation job.</p>
942
+ * <p>Specifies whether the evaluation job is automated or human-based.</p>
715
943
  * @public
716
944
  */
717
945
  jobType: EvaluationJobType | undefined;
718
946
  /**
719
- * <p>What task type was used in the model evaluation job.</p>
947
+ * <p>The type of task for model evaluation.</p>
720
948
  * @public
721
949
  */
722
950
  evaluationTaskTypes: EvaluationTaskType[] | undefined;
723
951
  /**
724
- * <p>The Amazon Resource Names (ARNs) of the model(s) used in the model evaluation job.</p>
952
+ * <p>The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.</p>
953
+ * @public
954
+ */
955
+ modelIdentifiers?: string[] | undefined;
956
+ /**
957
+ * <p>The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.</p>
725
958
  * @public
726
959
  */
727
- modelIdentifiers: string[] | undefined;
960
+ ragIdentifiers?: string[] | undefined;
961
+ /**
962
+ * <p>The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.</p>
963
+ * @public
964
+ */
965
+ evaluatorModelIdentifiers?: string[] | undefined;
966
+ /**
967
+ * <p>Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).</p>
968
+ * @public
969
+ */
970
+ applicationType?: ApplicationType | undefined;
728
971
  }
729
972
  /**
730
973
  * @public
@@ -736,7 +979,7 @@ export interface ListEvaluationJobsResponse {
736
979
  */
737
980
  nextToken?: string | undefined;
738
981
  /**
739
- * <p>A summary of the model evaluation jobs.</p>
982
+ * <p>A list of summaries of the evaluation jobs.</p>
740
983
  * @public
741
984
  */
742
985
  jobSummaries?: EvaluationSummary[] | undefined;
@@ -746,7 +989,7 @@ export interface ListEvaluationJobsResponse {
746
989
  */
747
990
  export interface StopEvaluationJobRequest {
748
991
  /**
749
- * <p>The ARN of the model evaluation job you want to stop.</p>
992
+ * <p>The Amazon Resource Name (ARN) of the evaluation job you want to stop.</p>
750
993
  * @public
751
994
  */
752
995
  jobIdentifier: string | undefined;
@@ -2532,8 +2775,13 @@ export interface LoggingConfig {
2532
2775
  * @public
2533
2776
  */
2534
2777
  embeddingDataDeliveryEnabled?: boolean | undefined;
2535
- }
2536
- /**
2778
+ /**
2779
+ * <p>Set to include video data in the log delivery.</p>
2780
+ * @public
2781
+ */
2782
+ videoDataDeliveryEnabled?: boolean | undefined;
2783
+ }
2784
+ /**
2537
2785
  * @public
2538
2786
  */
2539
2787
  export interface GetModelInvocationLoggingConfigurationResponse {
@@ -3462,7 +3710,7 @@ export interface CreateModelInvocationJobRequest {
3462
3710
  */
3463
3711
  outputDataConfig: ModelInvocationJobOutputDataConfig | undefined;
3464
3712
  /**
3465
- * <p>The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-vpc">Protect batch inference jobs using a VPC</a>.</p>
3713
+ * <p>The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc">Protect batch inference jobs using a VPC</a>.</p>
3466
3714
  * @public
3467
3715
  */
3468
3716
  vpcConfig?: VpcConfig | undefined;
@@ -3549,6 +3797,50 @@ export interface GetModelInvocationJobResponse {
3549
3797
  roleArn: string | undefined;
3550
3798
  /**
3551
3799
  * <p>The status of the batch inference job.</p>
3800
+ * <p>The following statuses are possible:</p>
3801
+ * <ul>
3802
+ * <li>
3803
+ * <p>Submitted – This job has been submitted to a queue for validation.</p>
3804
+ * </li>
3805
+ * <li>
3806
+ * <p>Validating – This job is being validated for the requirements described in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html">Format and upload your batch inference data</a>. The criteria include the following:</p>
3807
+ * <ul>
3808
+ * <li>
3809
+ * <p>Your IAM service role has access to the Amazon S3 buckets containing your files.</p>
3810
+ * </li>
3811
+ * <li>
3812
+ * <p>Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the <code>modelInput</code> value matches the request body for the model.</p>
3813
+ * </li>
3814
+ * <li>
3815
+ * <p>Your files fulfill the requirements for file size and number of records. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html">Quotas for Amazon Bedrock</a>.</p>
3816
+ * </li>
3817
+ * </ul>
3818
+ * </li>
3819
+ * <li>
3820
+ * <p>Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.</p>
3821
+ * </li>
3822
+ * <li>
3823
+ * <p>Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.</p>
3824
+ * </li>
3825
+ * <li>
3826
+ * <p>InProgress – This job has begun. You can start viewing the results in the output S3 location.</p>
3827
+ * </li>
3828
+ * <li>
3829
+ * <p>Completed – This job has successfully completed. View the output files in the output S3 location.</p>
3830
+ * </li>
3831
+ * <li>
3832
+ * <p>PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.</p>
3833
+ * </li>
3834
+ * <li>
3835
+ * <p>Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the <a href="https://console.aws.amazon.com/support/home/">Amazon Web Services Support Center</a>.</p>
3836
+ * </li>
3837
+ * <li>
3838
+ * <p>Stopped – This job was stopped by a user.</p>
3839
+ * </li>
3840
+ * <li>
3841
+ * <p>Stopping – This job is being stopped by a user.</p>
3842
+ * </li>
3843
+ * </ul>
3552
3844
  * @public
3553
3845
  */
3554
3846
  status?: ModelInvocationJobStatus | undefined;
@@ -3583,7 +3875,7 @@ export interface GetModelInvocationJobResponse {
3583
3875
  */
3584
3876
  outputDataConfig: ModelInvocationJobOutputDataConfig | undefined;
3585
3877
  /**
3586
- * <p>The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-vpc">Protect batch inference jobs using a VPC</a>.</p>
3878
+ * <p>The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc">Protect batch inference jobs using a VPC</a>.</p>
3587
3879
  * @public
3588
3880
  */
3589
3881
  vpcConfig?: VpcConfig | undefined;
@@ -3614,6 +3906,50 @@ export interface ListModelInvocationJobsRequest {
3614
3906
  submitTimeBefore?: Date | undefined;
3615
3907
  /**
3616
3908
  * <p>Specify a status to filter for batch inference jobs whose statuses match the string you specify.</p>
3909
+ * <p>The following statuses are possible:</p>
3910
+ * <ul>
3911
+ * <li>
3912
+ * <p>Submitted – This job has been submitted to a queue for validation.</p>
3913
+ * </li>
3914
+ * <li>
3915
+ * <p>Validating – This job is being validated for the requirements described in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html">Format and upload your batch inference data</a>. The criteria include the following:</p>
3916
+ * <ul>
3917
+ * <li>
3918
+ * <p>Your IAM service role has access to the Amazon S3 buckets containing your files.</p>
3919
+ * </li>
3920
+ * <li>
3921
+ * <p>Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the <code>modelInput</code> value matches the request body for the model.</p>
3922
+ * </li>
3923
+ * <li>
3924
+ * <p>Your files fulfill the requirements for file size and number of records. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html">Quotas for Amazon Bedrock</a>.</p>
3925
+ * </li>
3926
+ * </ul>
3927
+ * </li>
3928
+ * <li>
3929
+ * <p>Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.</p>
3930
+ * </li>
3931
+ * <li>
3932
+ * <p>Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.</p>
3933
+ * </li>
3934
+ * <li>
3935
+ * <p>InProgress – This job has begun. You can start viewing the results in the output S3 location.</p>
3936
+ * </li>
3937
+ * <li>
3938
+ * <p>Completed – This job has successfully completed. View the output files in the output S3 location.</p>
3939
+ * </li>
3940
+ * <li>
3941
+ * <p>PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.</p>
3942
+ * </li>
3943
+ * <li>
3944
+ * <p>Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the <a href="https://console.aws.amazon.com/support/home/">Amazon Web Services Support Center</a>.</p>
3945
+ * </li>
3946
+ * <li>
3947
+ * <p>Stopped – This job was stopped by a user.</p>
3948
+ * </li>
3949
+ * <li>
3950
+ * <p>Stopping – This job is being stopped by a user.</p>
3951
+ * </li>
3952
+ * </ul>
3617
3953
  * @public
3618
3954
  */
3619
3955
  statusEquals?: ModelInvocationJobStatus | undefined;
@@ -3680,6 +4016,50 @@ export interface ModelInvocationJobSummary {
3680
4016
  roleArn: string | undefined;
3681
4017
  /**
3682
4018
  * <p>The status of the batch inference job.</p>
4019
+ * <p>The following statuses are possible:</p>
4020
+ * <ul>
4021
+ * <li>
4022
+ * <p>Submitted – This job has been submitted to a queue for validation.</p>
4023
+ * </li>
4024
+ * <li>
4025
+ * <p>Validating – This job is being validated for the requirements described in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html">Format and upload your batch inference data</a>. The criteria include the following:</p>
4026
+ * <ul>
4027
+ * <li>
4028
+ * <p>Your IAM service role has access to the Amazon S3 buckets containing your files.</p>
4029
+ * </li>
4030
+ * <li>
4031
+ * <p>Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the <code>modelInput</code> value matches the request body for the model.</p>
4032
+ * </li>
4033
+ * <li>
4034
+ * <p>Your files fulfill the requirements for file size and number of records. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html">Quotas for Amazon Bedrock</a>.</p>
4035
+ * </li>
4036
+ * </ul>
4037
+ * </li>
4038
+ * <li>
4039
+ * <p>Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.</p>
4040
+ * </li>
4041
+ * <li>
4042
+ * <p>Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.</p>
4043
+ * </li>
4044
+ * <li>
4045
+ * <p>InProgress – This job has begun. You can start viewing the results in the output S3 location.</p>
4046
+ * </li>
4047
+ * <li>
4048
+ * <p>Completed – This job has successfully completed. View the output files in the output S3 location.</p>
4049
+ * </li>
4050
+ * <li>
4051
+ * <p>PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.</p>
4052
+ * </li>
4053
+ * <li>
4054
+ * <p>Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the <a href="https://console.aws.amazon.com/support/home/">Amazon Web Services Support Center</a>.</p>
4055
+ * </li>
4056
+ * <li>
4057
+ * <p>Stopped – This job was stopped by a user.</p>
4058
+ * </li>
4059
+ * <li>
4060
+ * <p>Stopping – This job is being stopped by a user.</p>
4061
+ * </li>
4062
+ * </ul>
3683
4063
  * @public
3684
4064
  */
3685
4065
  status?: ModelInvocationJobStatus | undefined;
@@ -3714,7 +4094,7 @@ export interface ModelInvocationJobSummary {
3714
4094
  */
3715
4095
  outputDataConfig: ModelInvocationJobOutputDataConfig | undefined;
3716
4096
  /**
3717
- * <p>The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-vpc">Protect batch inference jobs using a VPC</a>.</p>
4097
+ * <p>The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc">Protect batch inference jobs using a VPC</a>.</p>
3718
4098
  * @public
3719
4099
  */
3720
4100
  vpcConfig?: VpcConfig | undefined;
@@ -3784,12 +4164,70 @@ export interface GetCustomModelRequest {
3784
4164
  */
3785
4165
  modelIdentifier: string | undefined;
3786
4166
  }
4167
+ /**
4168
+ * <p>Details about a teacher model used for model customization.</p>
4169
+ * @public
4170
+ */
4171
+ export interface TeacherModelConfig {
4172
+ /**
4173
+ * <p>The identifier of the teacher model.</p>
4174
+ * @public
4175
+ */
4176
+ teacherModelIdentifier: string | undefined;
4177
+ /**
4178
+ * <p>The maximum number of tokens requested when the customization job invokes the teacher model.</p>
4179
+ * @public
4180
+ */
4181
+ maxResponseLengthForInference?: number | undefined;
4182
+ }
4183
+ /**
4184
+ * <p>Settings for distilling a foundation model into a smaller and more efficient model.</p>
4185
+ * @public
4186
+ */
4187
+ export interface DistillationConfig {
4188
+ /**
4189
+ * <p>The teacher model configuration.</p>
4190
+ * @public
4191
+ */
4192
+ teacherModelConfig: TeacherModelConfig | undefined;
4193
+ }
4194
+ /**
4195
+ * <p>A model customization configuration</p>
4196
+ * @public
4197
+ */
4198
+ export type CustomizationConfig = CustomizationConfig.DistillationConfigMember | CustomizationConfig.$UnknownMember;
4199
+ /**
4200
+ * @public
4201
+ */
4202
+ export declare namespace CustomizationConfig {
4203
+ /**
4204
+ * <p>The distillation configuration for the custom model.</p>
4205
+ * @public
4206
+ */
4207
+ interface DistillationConfigMember {
4208
+ distillationConfig: DistillationConfig;
4209
+ $unknown?: never;
4210
+ }
4211
+ /**
4212
+ * @public
4213
+ */
4214
+ interface $UnknownMember {
4215
+ distillationConfig?: never;
4216
+ $unknown: [string, any];
4217
+ }
4218
+ interface Visitor<T> {
4219
+ distillationConfig: (value: DistillationConfig) => T;
4220
+ _: (name: string, value: any) => T;
4221
+ }
4222
+ const visit: <T>(value: CustomizationConfig, visitor: Visitor<T>) => T;
4223
+ }
3787
4224
  /**
3788
4225
  * @public
3789
4226
  * @enum
3790
4227
  */
3791
4228
  export declare const CustomizationType: {
3792
4229
  readonly CONTINUED_PRE_TRAINING: "CONTINUED_PRE_TRAINING";
4230
+ readonly DISTILLATION: "DISTILLATION";
3793
4231
  readonly FINE_TUNING: "FINE_TUNING";
3794
4232
  };
3795
4233
  /**
@@ -3807,6 +4245,147 @@ export interface OutputDataConfig {
3807
4245
  */
3808
4246
  s3Uri: string | undefined;
3809
4247
  }
4248
+ /**
4249
+ * <p>A storage location for invocation logs.</p>
4250
+ * @public
4251
+ */
4252
+ export type InvocationLogSource = InvocationLogSource.S3UriMember | InvocationLogSource.$UnknownMember;
4253
+ /**
4254
+ * @public
4255
+ */
4256
+ export declare namespace InvocationLogSource {
4257
+ /**
4258
+ * <p>The URI of an invocation log in a bucket.</p>
4259
+ * @public
4260
+ */
4261
+ interface S3UriMember {
4262
+ s3Uri: string;
4263
+ $unknown?: never;
4264
+ }
4265
+ /**
4266
+ * @public
4267
+ */
4268
+ interface $UnknownMember {
4269
+ s3Uri?: never;
4270
+ $unknown: [string, any];
4271
+ }
4272
+ interface Visitor<T> {
4273
+ s3Uri: (value: string) => T;
4274
+ _: (name: string, value: any) => T;
4275
+ }
4276
+ const visit: <T>(value: InvocationLogSource, visitor: Visitor<T>) => T;
4277
+ }
4278
+ /**
4279
+ * <p>A mapping of a metadata key to a value that it should or should not equal.</p>
4280
+ * @public
4281
+ */
4282
+ export interface RequestMetadataBaseFilters {
4283
+ /**
4284
+ * <p>Include results where the key equals the value.</p>
4285
+ * @public
4286
+ */
4287
+ equals?: Record<string, string> | undefined;
4288
+ /**
4289
+ * <p>Include results where the key does not equal the value.</p>
4290
+ * @public
4291
+ */
4292
+ notEquals?: Record<string, string> | undefined;
4293
+ }
4294
+ /**
4295
+ * <p>Rules for filtering invocation logs. A filter can be a mapping of a metadata
4296
+ * key to a value that it should or should not equal (a base filter), or a list of base filters
4297
+ * that are all applied with <code>AND</code> or <code>OR</code> logical operators</p>
4298
+ * @public
4299
+ */
4300
+ export type RequestMetadataFilters = RequestMetadataFilters.AndAllMember | RequestMetadataFilters.EqualsMember | RequestMetadataFilters.NotEqualsMember | RequestMetadataFilters.OrAllMember | RequestMetadataFilters.$UnknownMember;
4301
+ /**
4302
+ * @public
4303
+ */
4304
+ export declare namespace RequestMetadataFilters {
4305
+ /**
4306
+ * <p>Include results where the key equals the value.</p>
4307
+ * @public
4308
+ */
4309
+ interface EqualsMember {
4310
+ equals: Record<string, string>;
4311
+ notEquals?: never;
4312
+ andAll?: never;
4313
+ orAll?: never;
4314
+ $unknown?: never;
4315
+ }
4316
+ /**
4317
+ * <p>Include results where the key does not equal the value.</p>
4318
+ * @public
4319
+ */
4320
+ interface NotEqualsMember {
4321
+ equals?: never;
4322
+ notEquals: Record<string, string>;
4323
+ andAll?: never;
4324
+ orAll?: never;
4325
+ $unknown?: never;
4326
+ }
4327
+ /**
4328
+ * <p>Include results where all of the based filters match.</p>
4329
+ * @public
4330
+ */
4331
+ interface AndAllMember {
4332
+ equals?: never;
4333
+ notEquals?: never;
4334
+ andAll: RequestMetadataBaseFilters[];
4335
+ orAll?: never;
4336
+ $unknown?: never;
4337
+ }
4338
+ /**
4339
+ * <p>Include results where any of the base filters match.</p>
4340
+ * @public
4341
+ */
4342
+ interface OrAllMember {
4343
+ equals?: never;
4344
+ notEquals?: never;
4345
+ andAll?: never;
4346
+ orAll: RequestMetadataBaseFilters[];
4347
+ $unknown?: never;
4348
+ }
4349
+ /**
4350
+ * @public
4351
+ */
4352
+ interface $UnknownMember {
4353
+ equals?: never;
4354
+ notEquals?: never;
4355
+ andAll?: never;
4356
+ orAll?: never;
4357
+ $unknown: [string, any];
4358
+ }
4359
+ interface Visitor<T> {
4360
+ equals: (value: Record<string, string>) => T;
4361
+ notEquals: (value: Record<string, string>) => T;
4362
+ andAll: (value: RequestMetadataBaseFilters[]) => T;
4363
+ orAll: (value: RequestMetadataBaseFilters[]) => T;
4364
+ _: (name: string, value: any) => T;
4365
+ }
4366
+ const visit: <T>(value: RequestMetadataFilters, visitor: Visitor<T>) => T;
4367
+ }
4368
+ /**
4369
+ * <p>Settings for using invocation logs to customize a model.</p>
4370
+ * @public
4371
+ */
4372
+ export interface InvocationLogsConfig {
4373
+ /**
4374
+ * <p>Whether to use the model's response for training, or just the prompt. The default value is <code>False</code>.</p>
4375
+ * @public
4376
+ */
4377
+ usePromptResponse?: boolean | undefined;
4378
+ /**
4379
+ * <p>The source of the invocation logs.</p>
4380
+ * @public
4381
+ */
4382
+ invocationLogSource: InvocationLogSource | undefined;
4383
+ /**
4384
+ * <p>Rules for filtering invocation logs based on request metadata.</p>
4385
+ * @public
4386
+ */
4387
+ requestMetadataFilters?: RequestMetadataFilters | undefined;
4388
+ }
3810
4389
  /**
3811
4390
  * <p>S3 Location of the training data.</p>
3812
4391
  * @public
@@ -3816,7 +4395,12 @@ export interface TrainingDataConfig {
3816
4395
  * <p>The S3 URI where the training data is stored.</p>
3817
4396
  * @public
3818
4397
  */
3819
- s3Uri: string | undefined;
4398
+ s3Uri?: string | undefined;
4399
+ /**
4400
+ * <p>Settings for using invocation logs to customize a model.</p>
4401
+ * @public
4402
+ */
4403
+ invocationLogsConfig?: InvocationLogsConfig | undefined;
3820
4404
  }
3821
4405
  /**
3822
4406
  * <p>Metrics associated with the custom job.</p>
@@ -3936,6 +4520,11 @@ export interface GetCustomModelResponse {
3936
4520
  * @public
3937
4521
  */
3938
4522
  creationTime: Date | undefined;
4523
+ /**
4524
+ * <p>The customization configuration for the custom model.</p>
4525
+ * @public
4526
+ */
4527
+ customizationConfig?: CustomizationConfig | undefined;
3939
4528
  }
3940
4529
  /**
3941
4530
  * @public
@@ -3953,6 +4542,7 @@ export interface GetFoundationModelRequest {
3953
4542
  */
3954
4543
  export declare const ModelCustomization: {
3955
4544
  readonly CONTINUED_PRE_TRAINING: "CONTINUED_PRE_TRAINING";
4545
+ readonly DISTILLATION: "DISTILLATION";
3956
4546
  readonly FINE_TUNING: "FINE_TUNING";
3957
4547
  };
3958
4548
  /**
@@ -4764,12 +5354,17 @@ export interface CreateModelCustomizationJobRequest {
4764
5354
  * <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>
4765
5355
  * @public
4766
5356
  */
4767
- hyperParameters: Record<string, string> | undefined;
5357
+ hyperParameters?: Record<string, string> | undefined;
4768
5358
  /**
4769
5359
  * <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>
4770
5360
  * @public
4771
5361
  */
4772
5362
  vpcConfig?: VpcConfig | undefined;
5363
+ /**
5364
+ * <p>The customization configuration for the model customization job.</p>
5365
+ * @public
5366
+ */
5367
+ customizationConfig?: CustomizationConfig | undefined;
4773
5368
  }
4774
5369
  /**
4775
5370
  * @public
@@ -4875,7 +5470,7 @@ export interface GetModelCustomizationJobResponse {
4875
5470
  * <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>
4876
5471
  * @public
4877
5472
  */
4878
- hyperParameters: Record<string, string> | undefined;
5473
+ hyperParameters?: Record<string, string> | undefined;
4879
5474
  /**
4880
5475
  * <p>Contains information about the training dataset.</p>
4881
5476
  * @public
@@ -4916,6 +5511,11 @@ export interface GetModelCustomizationJobResponse {
4916
5511
  * @public
4917
5512
  */
4918
5513
  vpcConfig?: VpcConfig | undefined;
5514
+ /**
5515
+ * <p>The customization configuration for the model customization job.</p>
5516
+ * @public
5517
+ */
5518
+ customizationConfig?: CustomizationConfig | undefined;
4919
5519
  }
4920
5520
  /**
4921
5521
  * @public
@@ -5064,31 +5664,757 @@ export interface StopModelCustomizationJobRequest {
5064
5664
  export interface StopModelCustomizationJobResponse {
5065
5665
  }
5066
5666
  /**
5067
- * @internal
5068
- */
5069
- export declare const BatchDeleteEvaluationJobRequestFilterSensitiveLog: (obj: BatchDeleteEvaluationJobRequest) => any;
5070
- /**
5071
- * @internal
5072
- */
5073
- export declare const BatchDeleteEvaluationJobErrorFilterSensitiveLog: (obj: BatchDeleteEvaluationJobError) => any;
5074
- /**
5075
- * @internal
5076
- */
5077
- export declare const BatchDeleteEvaluationJobItemFilterSensitiveLog: (obj: BatchDeleteEvaluationJobItem) => any;
5078
- /**
5079
- * @internal
5080
- */
5081
- export declare const BatchDeleteEvaluationJobResponseFilterSensitiveLog: (obj: BatchDeleteEvaluationJobResponse) => any;
5082
- /**
5083
- * @internal
5667
+ * <p>Specifies the filters to use on the metadata attributes/fields in the knowledge base data
5668
+ * sources before returning results.</p>
5669
+ * @public
5084
5670
  */
5085
- export declare const EvaluationDatasetFilterSensitiveLog: (obj: EvaluationDataset) => any;
5671
+ 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;
5086
5672
  /**
5087
- * @internal
5673
+ * @public
5088
5674
  */
5089
- export declare const EvaluationDatasetMetricConfigFilterSensitiveLog: (obj: EvaluationDatasetMetricConfig) => any;
5090
- /**
5091
- * @internal
5675
+ export declare namespace RetrievalFilter {
5676
+ /**
5677
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose
5678
+ * name matches the key and whose value matches the value in this object.</p>
5679
+ * <p>The following example would return data sources with an animal attribute whose value is 'cat':
5680
+ * <code>"equals": \{ "key": "animal", "value": "cat" \}</code>
5681
+ * </p>
5682
+ * @public
5683
+ */
5684
+ interface EqualsMember {
5685
+ equals: FilterAttribute;
5686
+ notEquals?: never;
5687
+ greaterThan?: never;
5688
+ greaterThanOrEquals?: never;
5689
+ lessThan?: never;
5690
+ lessThanOrEquals?: never;
5691
+ in?: never;
5692
+ notIn?: never;
5693
+ startsWith?: never;
5694
+ listContains?: never;
5695
+ stringContains?: never;
5696
+ andAll?: never;
5697
+ orAll?: never;
5698
+ $unknown?: never;
5699
+ }
5700
+ /**
5701
+ * <p>Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value
5702
+ * doesn't match the value in this object are returned.</p>
5703
+ * <p>The following example would return data sources that don't contain an animal attribute whose value is 'cat':
5704
+ * <code>"notEquals": \{ "key": "animal", "value": "cat" \}</code>
5705
+ * </p>
5706
+ * @public
5707
+ */
5708
+ interface NotEqualsMember {
5709
+ equals?: never;
5710
+ notEquals: FilterAttribute;
5711
+ greaterThan?: never;
5712
+ greaterThanOrEquals?: never;
5713
+ lessThan?: never;
5714
+ lessThanOrEquals?: never;
5715
+ in?: never;
5716
+ notIn?: never;
5717
+ startsWith?: never;
5718
+ listContains?: never;
5719
+ stringContains?: never;
5720
+ andAll?: never;
5721
+ orAll?: never;
5722
+ $unknown?: never;
5723
+ }
5724
+ /**
5725
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name
5726
+ * matches the key and whose value is greater than the value in this object.</p>
5727
+ * <p>The following example would return data sources with an year attribute whose value is
5728
+ * greater than '1989': <code>"greaterThan": \{ "key": "year", "value": 1989 \}</code>
5729
+ * </p>
5730
+ * @public
5731
+ */
5732
+ interface GreaterThanMember {
5733
+ equals?: never;
5734
+ notEquals?: never;
5735
+ greaterThan: FilterAttribute;
5736
+ greaterThanOrEquals?: never;
5737
+ lessThan?: never;
5738
+ lessThanOrEquals?: never;
5739
+ in?: never;
5740
+ notIn?: never;
5741
+ startsWith?: never;
5742
+ listContains?: never;
5743
+ stringContains?: never;
5744
+ andAll?: never;
5745
+ orAll?: never;
5746
+ $unknown?: never;
5747
+ }
5748
+ /**
5749
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name
5750
+ * matches the key and whose value is greater than or equal to the value in this object.</p>
5751
+ * <p>The following example would return data sources with an year attribute whose value is
5752
+ * greater than or equal to '1989': <code>"greaterThanOrEquals": \{ "key": "year", "value": 1989 \}</code>
5753
+ * </p>
5754
+ * @public
5755
+ */
5756
+ interface GreaterThanOrEqualsMember {
5757
+ equals?: never;
5758
+ notEquals?: never;
5759
+ greaterThan?: never;
5760
+ greaterThanOrEquals: FilterAttribute;
5761
+ lessThan?: never;
5762
+ lessThanOrEquals?: never;
5763
+ in?: never;
5764
+ notIn?: never;
5765
+ startsWith?: never;
5766
+ listContains?: never;
5767
+ stringContains?: never;
5768
+ andAll?: never;
5769
+ orAll?: never;
5770
+ $unknown?: never;
5771
+ }
5772
+ /**
5773
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the
5774
+ * key and whose value is less than the value in this object.</p>
5775
+ * <p>The following example would return data sources with an year attribute whose value is less than to '1989':
5776
+ * <code>"lessThan": \{ "key": "year", "value": 1989 \}</code>
5777
+ * </p>
5778
+ * @public
5779
+ */
5780
+ interface LessThanMember {
5781
+ equals?: never;
5782
+ notEquals?: never;
5783
+ greaterThan?: never;
5784
+ greaterThanOrEquals?: never;
5785
+ lessThan: FilterAttribute;
5786
+ lessThanOrEquals?: never;
5787
+ in?: never;
5788
+ notIn?: never;
5789
+ startsWith?: never;
5790
+ listContains?: never;
5791
+ stringContains?: never;
5792
+ andAll?: never;
5793
+ orAll?: never;
5794
+ $unknown?: never;
5795
+ }
5796
+ /**
5797
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key
5798
+ * and whose value is less than or equal to the value in this object.</p>
5799
+ * <p>The following example would return data sources with an year attribute whose value is less than or equal
5800
+ * to '1989': <code>"lessThanOrEquals": \{ "key": "year", "value": 1989 \}</code>
5801
+ * </p>
5802
+ * @public
5803
+ */
5804
+ interface LessThanOrEqualsMember {
5805
+ equals?: never;
5806
+ notEquals?: never;
5807
+ greaterThan?: never;
5808
+ greaterThanOrEquals?: never;
5809
+ lessThan?: never;
5810
+ lessThanOrEquals: FilterAttribute;
5811
+ in?: never;
5812
+ notIn?: never;
5813
+ startsWith?: never;
5814
+ listContains?: never;
5815
+ stringContains?: never;
5816
+ andAll?: never;
5817
+ orAll?: never;
5818
+ $unknown?: never;
5819
+ }
5820
+ /**
5821
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose
5822
+ * name matches the key and whose value is in the list specified in the value in this object.</p>
5823
+ * <p>The following example would return data sources with an animal attribute that is either 'cat' or 'dog':
5824
+ * <code>"in": \{ "key": "animal", "value": ["cat", "dog"] \}</code>
5825
+ * </p>
5826
+ * @public
5827
+ */
5828
+ interface InMember {
5829
+ equals?: never;
5830
+ notEquals?: never;
5831
+ greaterThan?: never;
5832
+ greaterThanOrEquals?: never;
5833
+ lessThan?: never;
5834
+ lessThanOrEquals?: never;
5835
+ in: FilterAttribute;
5836
+ notIn?: never;
5837
+ startsWith?: never;
5838
+ listContains?: never;
5839
+ stringContains?: never;
5840
+ andAll?: never;
5841
+ orAll?: never;
5842
+ $unknown?: never;
5843
+ }
5844
+ /**
5845
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key
5846
+ * and whose value isn't in the list specified in the value in this object.</p>
5847
+ * <p>The following example would return data sources whose animal attribute is neither 'cat' nor 'dog':
5848
+ * <code>"notIn": \{ "key": "animal", "value": ["cat", "dog"] \}</code>
5849
+ * </p>
5850
+ * @public
5851
+ */
5852
+ interface NotInMember {
5853
+ equals?: never;
5854
+ notEquals?: never;
5855
+ greaterThan?: never;
5856
+ greaterThanOrEquals?: never;
5857
+ lessThan?: never;
5858
+ lessThanOrEquals?: never;
5859
+ in?: never;
5860
+ notIn: FilterAttribute;
5861
+ startsWith?: never;
5862
+ listContains?: never;
5863
+ stringContains?: never;
5864
+ andAll?: never;
5865
+ orAll?: never;
5866
+ $unknown?: never;
5867
+ }
5868
+ /**
5869
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key
5870
+ * and whose value starts with the value in this object. This filter is currently only supported for
5871
+ * Amazon OpenSearch Serverless vector stores.</p>
5872
+ * <p>The following example would return data sources with an animal attribute starts with 'ca' (for example, 'cat' or 'camel').
5873
+ * <code>"startsWith": \{ "key": "animal", "value": "ca" \}</code>
5874
+ * </p>
5875
+ * @public
5876
+ */
5877
+ interface StartsWithMember {
5878
+ equals?: never;
5879
+ notEquals?: never;
5880
+ greaterThan?: never;
5881
+ greaterThanOrEquals?: never;
5882
+ lessThan?: never;
5883
+ lessThanOrEquals?: never;
5884
+ in?: never;
5885
+ notIn?: never;
5886
+ startsWith: FilterAttribute;
5887
+ listContains?: never;
5888
+ stringContains?: never;
5889
+ andAll?: never;
5890
+ orAll?: never;
5891
+ $unknown?: never;
5892
+ }
5893
+ /**
5894
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key
5895
+ * and whose value is a list that contains the value as one of its members.</p>
5896
+ * <p>The following example would return data sources with an animals attribute that is a list containing a cat
5897
+ * member (for example, <code>["dog", "cat"]</code>): <code>"listContains": \{ "key": "animals", "value": "cat" \}</code>
5898
+ * </p>
5899
+ * @public
5900
+ */
5901
+ interface ListContainsMember {
5902
+ equals?: never;
5903
+ notEquals?: never;
5904
+ greaterThan?: never;
5905
+ greaterThanOrEquals?: never;
5906
+ lessThan?: never;
5907
+ lessThanOrEquals?: never;
5908
+ in?: never;
5909
+ notIn?: never;
5910
+ startsWith?: never;
5911
+ listContains: FilterAttribute;
5912
+ stringContains?: never;
5913
+ andAll?: never;
5914
+ orAll?: never;
5915
+ $unknown?: never;
5916
+ }
5917
+ /**
5918
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key
5919
+ * and whose value is one of the following:</p>
5920
+ * <p>A string that contains the value as a substring. The following example would return data sources with an
5921
+ * animal attribute that contains the substring at (for example, 'cat'):
5922
+ * <code>"stringContains": \{ "key": "animal", "value": "at" \}</code>
5923
+ * </p>
5924
+ * <p>A list with a member that contains the value as a substring. The following example would return data
5925
+ * sources with an animals attribute that is a list containing a member that contains the substring at
5926
+ * (for example, <code>["dog", "cat"]</code>): <code>"stringContains": \{ "key": "animals", "value": "at" \}</code>
5927
+ * </p>
5928
+ * @public
5929
+ */
5930
+ interface StringContainsMember {
5931
+ equals?: never;
5932
+ notEquals?: never;
5933
+ greaterThan?: never;
5934
+ greaterThanOrEquals?: never;
5935
+ lessThan?: never;
5936
+ lessThanOrEquals?: never;
5937
+ in?: never;
5938
+ notIn?: never;
5939
+ startsWith?: never;
5940
+ listContains?: never;
5941
+ stringContains: FilterAttribute;
5942
+ andAll?: never;
5943
+ orAll?: never;
5944
+ $unknown?: never;
5945
+ }
5946
+ /**
5947
+ * <p>Knowledge base data sources are returned if their metadata attributes fulfill all the
5948
+ * filter conditions inside this list.</p>
5949
+ * @public
5950
+ */
5951
+ interface AndAllMember {
5952
+ equals?: never;
5953
+ notEquals?: never;
5954
+ greaterThan?: never;
5955
+ greaterThanOrEquals?: never;
5956
+ lessThan?: never;
5957
+ lessThanOrEquals?: never;
5958
+ in?: never;
5959
+ notIn?: never;
5960
+ startsWith?: never;
5961
+ listContains?: never;
5962
+ stringContains?: never;
5963
+ andAll: RetrievalFilter[];
5964
+ orAll?: never;
5965
+ $unknown?: never;
5966
+ }
5967
+ /**
5968
+ * <p>Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter
5969
+ * conditions inside this list.</p>
5970
+ * @public
5971
+ */
5972
+ interface OrAllMember {
5973
+ equals?: never;
5974
+ notEquals?: never;
5975
+ greaterThan?: never;
5976
+ greaterThanOrEquals?: never;
5977
+ lessThan?: never;
5978
+ lessThanOrEquals?: never;
5979
+ in?: never;
5980
+ notIn?: never;
5981
+ startsWith?: never;
5982
+ listContains?: never;
5983
+ stringContains?: never;
5984
+ andAll?: never;
5985
+ orAll: RetrievalFilter[];
5986
+ $unknown?: never;
5987
+ }
5988
+ /**
5989
+ * @public
5990
+ */
5991
+ interface $UnknownMember {
5992
+ equals?: never;
5993
+ notEquals?: never;
5994
+ greaterThan?: never;
5995
+ greaterThanOrEquals?: never;
5996
+ lessThan?: never;
5997
+ lessThanOrEquals?: never;
5998
+ in?: never;
5999
+ notIn?: never;
6000
+ startsWith?: never;
6001
+ listContains?: never;
6002
+ stringContains?: never;
6003
+ andAll?: never;
6004
+ orAll?: never;
6005
+ $unknown: [string, any];
6006
+ }
6007
+ interface Visitor<T> {
6008
+ equals: (value: FilterAttribute) => T;
6009
+ notEquals: (value: FilterAttribute) => T;
6010
+ greaterThan: (value: FilterAttribute) => T;
6011
+ greaterThanOrEquals: (value: FilterAttribute) => T;
6012
+ lessThan: (value: FilterAttribute) => T;
6013
+ lessThanOrEquals: (value: FilterAttribute) => T;
6014
+ in: (value: FilterAttribute) => T;
6015
+ notIn: (value: FilterAttribute) => T;
6016
+ startsWith: (value: FilterAttribute) => T;
6017
+ listContains: (value: FilterAttribute) => T;
6018
+ stringContains: (value: FilterAttribute) => T;
6019
+ andAll: (value: RetrievalFilter[]) => T;
6020
+ orAll: (value: RetrievalFilter[]) => T;
6021
+ _: (name: string, value: any) => T;
6022
+ }
6023
+ const visit: <T>(value: RetrievalFilter, visitor: Visitor<T>) => T;
6024
+ }
6025
+ /**
6026
+ * <p>The configuration details for returning the results from the knowledge base vector search.</p>
6027
+ * @public
6028
+ */
6029
+ export interface KnowledgeBaseVectorSearchConfiguration {
6030
+ /**
6031
+ * <p>The number of text chunks to retrieve; the number of results to return.</p>
6032
+ * @public
6033
+ */
6034
+ numberOfResults?: number | undefined;
6035
+ /**
6036
+ * <p>By default, Amazon Bedrock decides a search strategy for you. If you're using an
6037
+ * Amazon OpenSearch Serverless vector store that contains a filterable text field, you
6038
+ * can specify whether to query the knowledge base with a <code>HYBRID</code> search
6039
+ * using both vector embeddings and raw text, or <code>SEMANTIC</code> search using
6040
+ * only vector embeddings. For other vector store configurations, only <code>SEMANTIC</code>
6041
+ * search is available.</p>
6042
+ * @public
6043
+ */
6044
+ overrideSearchType?: SearchType | undefined;
6045
+ /**
6046
+ * <p>Specifies the filters to use on the metadata fields in the knowledge base data sources before returning results.</p>
6047
+ * @public
6048
+ */
6049
+ filter?: RetrievalFilter | undefined;
6050
+ }
6051
+ /**
6052
+ * <p>Contains configuration details for retrieving information from a knowledge base.</p>
6053
+ * @public
6054
+ */
6055
+ export interface KnowledgeBaseRetrievalConfiguration {
6056
+ /**
6057
+ * <p>Contains configuration details for returning the results from the vector search.</p>
6058
+ * @public
6059
+ */
6060
+ vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined;
6061
+ }
6062
+ /**
6063
+ * <p>Contains configuration details for retrieving information from a knowledge base and generating responses.</p>
6064
+ * @public
6065
+ */
6066
+ export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
6067
+ /**
6068
+ * <p>The unique identifier of the knowledge base.</p>
6069
+ * @public
6070
+ */
6071
+ knowledgeBaseId: string | undefined;
6072
+ /**
6073
+ * <p>The Amazon Resource Name (ARN) of the foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a>
6074
+ * used to generate responses.</p>
6075
+ * @public
6076
+ */
6077
+ modelArn: string | undefined;
6078
+ /**
6079
+ * <p>Contains configuration details for retrieving text chunks.</p>
6080
+ * @public
6081
+ */
6082
+ retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
6083
+ /**
6084
+ * <p>Contains configurations details for response generation based on retrieved text chunks.</p>
6085
+ * @public
6086
+ */
6087
+ generationConfiguration?: GenerationConfiguration | undefined;
6088
+ /**
6089
+ * <p>Contains configuration details for the model to process the prompt prior to retrieval and response generation.</p>
6090
+ * @public
6091
+ */
6092
+ orchestrationConfiguration?: OrchestrationConfiguration | undefined;
6093
+ }
6094
+ /**
6095
+ * <p>The configuration details for retrieving information from a knowledge base.</p>
6096
+ * @public
6097
+ */
6098
+ export interface RetrieveConfig {
6099
+ /**
6100
+ * <p>The unique identifier of the knowledge base.</p>
6101
+ * @public
6102
+ */
6103
+ knowledgeBaseId: string | undefined;
6104
+ /**
6105
+ * <p>Contains configuration details for knowledge base retrieval.</p>
6106
+ * @public
6107
+ */
6108
+ knowledgeBaseRetrievalConfiguration: KnowledgeBaseRetrievalConfiguration | undefined;
6109
+ }
6110
+ /**
6111
+ * <p>Contains configuration details for a knowledge base retrieval and response generation.</p>
6112
+ * @public
6113
+ */
6114
+ export interface RetrieveAndGenerateConfiguration {
6115
+ /**
6116
+ * <p>The type of resource that contains your data for retrieving information and generating responses.</p>
6117
+ * <p>If you choose to use <code>EXTERNAL_SOURCES</code>, then currently only Claude 3 Sonnet models for knowledge bases are supported.</p>
6118
+ * @public
6119
+ */
6120
+ type: RetrieveAndGenerateType | undefined;
6121
+ /**
6122
+ * <p>Contains configuration details for the knowledge base retrieval and response generation.</p>
6123
+ * @public
6124
+ */
6125
+ knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration | undefined;
6126
+ /**
6127
+ * <p>The configuration for the external source wrapper object in the
6128
+ * <code>retrieveAndGenerate</code> function.</p>
6129
+ * @public
6130
+ */
6131
+ externalSourcesConfiguration?: ExternalSourcesRetrieveAndGenerateConfiguration | undefined;
6132
+ }
6133
+ /**
6134
+ * <p>The configuration details for retrieving information from a knowledge base and generating responses.</p>
6135
+ * @public
6136
+ */
6137
+ export type KnowledgeBaseConfig = KnowledgeBaseConfig.RetrieveAndGenerateConfigMember | KnowledgeBaseConfig.RetrieveConfigMember | KnowledgeBaseConfig.$UnknownMember;
6138
+ /**
6139
+ * @public
6140
+ */
6141
+ export declare namespace KnowledgeBaseConfig {
6142
+ /**
6143
+ * <p>Contains configuration details for retrieving information from a knowledge base.</p>
6144
+ * @public
6145
+ */
6146
+ interface RetrieveConfigMember {
6147
+ retrieveConfig: RetrieveConfig;
6148
+ retrieveAndGenerateConfig?: never;
6149
+ $unknown?: never;
6150
+ }
6151
+ /**
6152
+ * <p>Contains configuration details for retrieving information from a knowledge base and generating responses.</p>
6153
+ * @public
6154
+ */
6155
+ interface RetrieveAndGenerateConfigMember {
6156
+ retrieveConfig?: never;
6157
+ retrieveAndGenerateConfig: RetrieveAndGenerateConfiguration;
6158
+ $unknown?: never;
6159
+ }
6160
+ /**
6161
+ * @public
6162
+ */
6163
+ interface $UnknownMember {
6164
+ retrieveConfig?: never;
6165
+ retrieveAndGenerateConfig?: never;
6166
+ $unknown: [string, any];
6167
+ }
6168
+ interface Visitor<T> {
6169
+ retrieveConfig: (value: RetrieveConfig) => T;
6170
+ retrieveAndGenerateConfig: (value: RetrieveAndGenerateConfiguration) => T;
6171
+ _: (name: string, value: any) => T;
6172
+ }
6173
+ const visit: <T>(value: KnowledgeBaseConfig, visitor: Visitor<T>) => T;
6174
+ }
6175
+ /**
6176
+ * <p>Contains configuration details for retrieval of information and response generation.</p>
6177
+ * @public
6178
+ */
6179
+ export type RAGConfig = RAGConfig.KnowledgeBaseConfigMember | RAGConfig.$UnknownMember;
6180
+ /**
6181
+ * @public
6182
+ */
6183
+ export declare namespace RAGConfig {
6184
+ /**
6185
+ * <p>Contains configuration details for knowledge base retrieval and response generation.</p>
6186
+ * @public
6187
+ */
6188
+ interface KnowledgeBaseConfigMember {
6189
+ knowledgeBaseConfig: KnowledgeBaseConfig;
6190
+ $unknown?: never;
6191
+ }
6192
+ /**
6193
+ * @public
6194
+ */
6195
+ interface $UnknownMember {
6196
+ knowledgeBaseConfig?: never;
6197
+ $unknown: [string, any];
6198
+ }
6199
+ interface Visitor<T> {
6200
+ knowledgeBaseConfig: (value: KnowledgeBaseConfig) => T;
6201
+ _: (name: string, value: any) => T;
6202
+ }
6203
+ const visit: <T>(value: RAGConfig, visitor: Visitor<T>) => T;
6204
+ }
6205
+ /**
6206
+ * <p>The configuration details of the inference model for an evaluation job.</p>
6207
+ * <p>For automated model evaluation jobs, only a single model is supported.</p>
6208
+ * <p>For human-based model evaluation jobs, your annotator can compare the responses for up to two different models.</p>
6209
+ * @public
6210
+ */
6211
+ export type EvaluationInferenceConfig = EvaluationInferenceConfig.ModelsMember | EvaluationInferenceConfig.RagConfigsMember | EvaluationInferenceConfig.$UnknownMember;
6212
+ /**
6213
+ * @public
6214
+ */
6215
+ export declare namespace EvaluationInferenceConfig {
6216
+ /**
6217
+ * <p>Specifies the inference models.</p>
6218
+ * @public
6219
+ */
6220
+ interface ModelsMember {
6221
+ models: EvaluationModelConfig[];
6222
+ ragConfigs?: never;
6223
+ $unknown?: never;
6224
+ }
6225
+ /**
6226
+ * <p>Contains the configuration details of the inference for a knowledge base evaluation
6227
+ * job, including either the retrieval only configuration or the retrieval with response
6228
+ * generation configuration.</p>
6229
+ * @public
6230
+ */
6231
+ interface RagConfigsMember {
6232
+ models?: never;
6233
+ ragConfigs: RAGConfig[];
6234
+ $unknown?: never;
6235
+ }
6236
+ /**
6237
+ * @public
6238
+ */
6239
+ interface $UnknownMember {
6240
+ models?: never;
6241
+ ragConfigs?: never;
6242
+ $unknown: [string, any];
6243
+ }
6244
+ interface Visitor<T> {
6245
+ models: (value: EvaluationModelConfig[]) => T;
6246
+ ragConfigs: (value: RAGConfig[]) => T;
6247
+ _: (name: string, value: any) => T;
6248
+ }
6249
+ const visit: <T>(value: EvaluationInferenceConfig, visitor: Visitor<T>) => T;
6250
+ }
6251
+ /**
6252
+ * @public
6253
+ */
6254
+ export interface CreateEvaluationJobRequest {
6255
+ /**
6256
+ * <p>A name for the evaluation job. Names must unique with your Amazon Web Services account,
6257
+ * and your account's Amazon Web Services region.</p>
6258
+ * @public
6259
+ */
6260
+ jobName: string | undefined;
6261
+ /**
6262
+ * <p>A description of the evaluation job.</p>
6263
+ * @public
6264
+ */
6265
+ jobDescription?: string | undefined;
6266
+ /**
6267
+ * <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,
6268
+ * 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>
6269
+ * @public
6270
+ */
6271
+ clientRequestToken?: string | undefined;
6272
+ /**
6273
+ * <p>The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can
6274
+ * assume to perform tasks on your behalf. To learn more about the required permissions,
6275
+ * see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-security.html">Required
6276
+ * permissions for model evaluations</a>.</p>
6277
+ * @public
6278
+ */
6279
+ roleArn: string | undefined;
6280
+ /**
6281
+ * <p>Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.</p>
6282
+ * @public
6283
+ */
6284
+ customerEncryptionKeyId?: string | undefined;
6285
+ /**
6286
+ * <p>Tags to attach to the model evaluation job.</p>
6287
+ * @public
6288
+ */
6289
+ jobTags?: Tag[] | undefined;
6290
+ /**
6291
+ * <p>Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base
6292
+ * (retrieval and response generation).</p>
6293
+ * @public
6294
+ */
6295
+ applicationType?: ApplicationType | undefined;
6296
+ /**
6297
+ * <p>Contains the configuration details of either an automated or human-based evaluation job.</p>
6298
+ * @public
6299
+ */
6300
+ evaluationConfig: EvaluationConfig | undefined;
6301
+ /**
6302
+ * <p>Contains the configuration details of the inference model for the evaluation job.</p>
6303
+ * <p>For model evaluation jobs, automated jobs support a single model or
6304
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a>, and jobs that use human workers support
6305
+ * two models or inference profiles.</p>
6306
+ * @public
6307
+ */
6308
+ inferenceConfig: EvaluationInferenceConfig | undefined;
6309
+ /**
6310
+ * <p>Contains the configuration details of the Amazon S3 bucket for storing the results
6311
+ * of the evaluation job.</p>
6312
+ * @public
6313
+ */
6314
+ outputDataConfig: EvaluationOutputDataConfig | undefined;
6315
+ }
6316
+ /**
6317
+ * @public
6318
+ */
6319
+ export interface GetEvaluationJobResponse {
6320
+ /**
6321
+ * <p>The name for the evaluation job.</p>
6322
+ * @public
6323
+ */
6324
+ jobName: string | undefined;
6325
+ /**
6326
+ * <p>The current status of the evaluation job.</p>
6327
+ * @public
6328
+ */
6329
+ status: EvaluationJobStatus | undefined;
6330
+ /**
6331
+ * <p>The Amazon Resource Name (ARN) of the evaluation job.</p>
6332
+ * @public
6333
+ */
6334
+ jobArn: string | undefined;
6335
+ /**
6336
+ * <p>The description of the evaluation job.</p>
6337
+ * @public
6338
+ */
6339
+ jobDescription?: string | undefined;
6340
+ /**
6341
+ * <p>The Amazon Resource Name (ARN) of the IAM service role used in the evaluation job.</p>
6342
+ * @public
6343
+ */
6344
+ roleArn: string | undefined;
6345
+ /**
6346
+ * <p>The Amazon Resource Name (ARN) of the customer managed encryption key specified when the evaluation job was created.</p>
6347
+ * @public
6348
+ */
6349
+ customerEncryptionKeyId?: string | undefined;
6350
+ /**
6351
+ * <p>Specifies whether the evaluation job is automated or human-based.</p>
6352
+ * @public
6353
+ */
6354
+ jobType: EvaluationJobType | undefined;
6355
+ /**
6356
+ * <p>Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).</p>
6357
+ * @public
6358
+ */
6359
+ applicationType?: ApplicationType | undefined;
6360
+ /**
6361
+ * <p>Contains the configuration details of either an automated or human-based evaluation job.</p>
6362
+ * @public
6363
+ */
6364
+ evaluationConfig: EvaluationConfig | undefined;
6365
+ /**
6366
+ * <p>Contains the configuration details of the inference model used for the evaluation job. </p>
6367
+ * @public
6368
+ */
6369
+ inferenceConfig: EvaluationInferenceConfig | undefined;
6370
+ /**
6371
+ * <p>Contains the configuration details of the Amazon S3 bucket for
6372
+ * storing the results of the evaluation job.</p>
6373
+ * @public
6374
+ */
6375
+ outputDataConfig: EvaluationOutputDataConfig | undefined;
6376
+ /**
6377
+ * <p>The time the evaluation job was created.</p>
6378
+ * @public
6379
+ */
6380
+ creationTime: Date | undefined;
6381
+ /**
6382
+ * <p>The time the evaluation job was last modified.</p>
6383
+ * @public
6384
+ */
6385
+ lastModifiedTime?: Date | undefined;
6386
+ /**
6387
+ * <p>A list of strings that specify why the evaluation job failed to create.</p>
6388
+ * @public
6389
+ */
6390
+ failureMessages?: string[] | undefined;
6391
+ }
6392
+ /**
6393
+ * @internal
6394
+ */
6395
+ export declare const BatchDeleteEvaluationJobRequestFilterSensitiveLog: (obj: BatchDeleteEvaluationJobRequest) => any;
6396
+ /**
6397
+ * @internal
6398
+ */
6399
+ export declare const BatchDeleteEvaluationJobErrorFilterSensitiveLog: (obj: BatchDeleteEvaluationJobError) => any;
6400
+ /**
6401
+ * @internal
6402
+ */
6403
+ export declare const BatchDeleteEvaluationJobItemFilterSensitiveLog: (obj: BatchDeleteEvaluationJobItem) => any;
6404
+ /**
6405
+ * @internal
6406
+ */
6407
+ export declare const BatchDeleteEvaluationJobResponseFilterSensitiveLog: (obj: BatchDeleteEvaluationJobResponse) => any;
6408
+ /**
6409
+ * @internal
6410
+ */
6411
+ export declare const EvaluationDatasetFilterSensitiveLog: (obj: EvaluationDataset) => any;
6412
+ /**
6413
+ * @internal
6414
+ */
6415
+ export declare const EvaluationDatasetMetricConfigFilterSensitiveLog: (obj: EvaluationDatasetMetricConfig) => any;
6416
+ /**
6417
+ * @internal
5092
6418
  */
5093
6419
  export declare const AutomatedEvaluationConfigFilterSensitiveLog: (obj: AutomatedEvaluationConfig) => any;
5094
6420
  /**
@@ -5118,19 +6444,31 @@ export declare const EvaluationModelConfigFilterSensitiveLog: (obj: EvaluationMo
5118
6444
  /**
5119
6445
  * @internal
5120
6446
  */
5121
- export declare const EvaluationInferenceConfigFilterSensitiveLog: (obj: EvaluationInferenceConfig) => any;
6447
+ export declare const PromptTemplateFilterSensitiveLog: (obj: PromptTemplate) => any;
5122
6448
  /**
5123
6449
  * @internal
5124
6450
  */
5125
- export declare const CreateEvaluationJobRequestFilterSensitiveLog: (obj: CreateEvaluationJobRequest) => any;
6451
+ export declare const ExternalSourcesGenerationConfigurationFilterSensitiveLog: (obj: ExternalSourcesGenerationConfiguration) => any;
5126
6452
  /**
5127
6453
  * @internal
5128
6454
  */
5129
- export declare const GetEvaluationJobRequestFilterSensitiveLog: (obj: GetEvaluationJobRequest) => any;
6455
+ export declare const ByteContentDocFilterSensitiveLog: (obj: ByteContentDoc) => any;
5130
6456
  /**
5131
6457
  * @internal
5132
6458
  */
5133
- export declare const GetEvaluationJobResponseFilterSensitiveLog: (obj: GetEvaluationJobResponse) => any;
6459
+ export declare const ExternalSourceFilterSensitiveLog: (obj: ExternalSource) => any;
6460
+ /**
6461
+ * @internal
6462
+ */
6463
+ export declare const ExternalSourcesRetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: ExternalSourcesRetrieveAndGenerateConfiguration) => any;
6464
+ /**
6465
+ * @internal
6466
+ */
6467
+ export declare const GenerationConfigurationFilterSensitiveLog: (obj: GenerationConfiguration) => any;
6468
+ /**
6469
+ * @internal
6470
+ */
6471
+ export declare const GetEvaluationJobRequestFilterSensitiveLog: (obj: GetEvaluationJobRequest) => any;
5134
6472
  /**
5135
6473
  * @internal
5136
6474
  */
@@ -5203,3 +6541,75 @@ export declare const ModelInvocationJobSummaryFilterSensitiveLog: (obj: ModelInv
5203
6541
  * @internal
5204
6542
  */
5205
6543
  export declare const ListModelInvocationJobsResponseFilterSensitiveLog: (obj: ListModelInvocationJobsResponse) => any;
6544
+ /**
6545
+ * @internal
6546
+ */
6547
+ export declare const RequestMetadataBaseFiltersFilterSensitiveLog: (obj: RequestMetadataBaseFilters) => any;
6548
+ /**
6549
+ * @internal
6550
+ */
6551
+ export declare const RequestMetadataFiltersFilterSensitiveLog: (obj: RequestMetadataFilters) => any;
6552
+ /**
6553
+ * @internal
6554
+ */
6555
+ export declare const InvocationLogsConfigFilterSensitiveLog: (obj: InvocationLogsConfig) => any;
6556
+ /**
6557
+ * @internal
6558
+ */
6559
+ export declare const TrainingDataConfigFilterSensitiveLog: (obj: TrainingDataConfig) => any;
6560
+ /**
6561
+ * @internal
6562
+ */
6563
+ export declare const GetCustomModelResponseFilterSensitiveLog: (obj: GetCustomModelResponse) => any;
6564
+ /**
6565
+ * @internal
6566
+ */
6567
+ export declare const CreateModelCustomizationJobRequestFilterSensitiveLog: (obj: CreateModelCustomizationJobRequest) => any;
6568
+ /**
6569
+ * @internal
6570
+ */
6571
+ export declare const GetModelCustomizationJobResponseFilterSensitiveLog: (obj: GetModelCustomizationJobResponse) => any;
6572
+ /**
6573
+ * @internal
6574
+ */
6575
+ export declare const RetrievalFilterFilterSensitiveLog: (obj: RetrievalFilter) => any;
6576
+ /**
6577
+ * @internal
6578
+ */
6579
+ export declare const KnowledgeBaseVectorSearchConfigurationFilterSensitiveLog: (obj: KnowledgeBaseVectorSearchConfiguration) => any;
6580
+ /**
6581
+ * @internal
6582
+ */
6583
+ export declare const KnowledgeBaseRetrievalConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrievalConfiguration) => any;
6584
+ /**
6585
+ * @internal
6586
+ */
6587
+ export declare const KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrieveAndGenerateConfiguration) => any;
6588
+ /**
6589
+ * @internal
6590
+ */
6591
+ export declare const RetrieveConfigFilterSensitiveLog: (obj: RetrieveConfig) => any;
6592
+ /**
6593
+ * @internal
6594
+ */
6595
+ export declare const RetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: RetrieveAndGenerateConfiguration) => any;
6596
+ /**
6597
+ * @internal
6598
+ */
6599
+ export declare const KnowledgeBaseConfigFilterSensitiveLog: (obj: KnowledgeBaseConfig) => any;
6600
+ /**
6601
+ * @internal
6602
+ */
6603
+ export declare const RAGConfigFilterSensitiveLog: (obj: RAGConfig) => any;
6604
+ /**
6605
+ * @internal
6606
+ */
6607
+ export declare const EvaluationInferenceConfigFilterSensitiveLog: (obj: EvaluationInferenceConfig) => any;
6608
+ /**
6609
+ * @internal
6610
+ */
6611
+ export declare const CreateEvaluationJobRequestFilterSensitiveLog: (obj: CreateEvaluationJobRequest) => any;
6612
+ /**
6613
+ * @internal
6614
+ */
6615
+ export declare const GetEvaluationJobResponseFilterSensitiveLog: (obj: GetEvaluationJobResponse) => any;