@aws-sdk/client-bedrock 3.934.0 → 3.935.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +389 -389
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +355 -0
- package/dist-es/models/errors.js +123 -0
- package/dist-es/models/models_0.js +1 -355
- package/dist-es/models/models_1.js +1 -123
- package/dist-es/schemas/schemas_0.js +1 -1
- package/dist-types/commands/CreateGuardrailCommand.d.ts +1 -1
- package/dist-types/commands/CreateGuardrailVersionCommand.d.ts +1 -1
- package/dist-types/commands/CreateInferenceProfileCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGuardrailCommand.d.ts +1 -1
- package/dist-types/commands/DeleteInferenceProfileCommand.d.ts +1 -1
- package/dist-types/commands/DeleteModelInvocationLoggingConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetGuardrailCommand.d.ts +1 -1
- package/dist-types/commands/GetInferenceProfileCommand.d.ts +1 -1
- package/dist-types/commands/GetModelInvocationLoggingConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/ListGuardrailsCommand.d.ts +1 -1
- package/dist-types/commands/ListInferenceProfilesCommand.d.ts +1 -1
- package/dist-types/commands/PutModelInvocationLoggingConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateGuardrailCommand.d.ts +1 -1
- package/dist-types/index.d.ts +4 -1
- package/dist-types/models/enums.d.ts +891 -0
- package/dist-types/models/errors.d.ts +127 -0
- package/dist-types/models/models_0.d.ts +1306 -696
- package/dist-types/models/models_1.d.ts +2 -1628
- package/dist-types/ts3.4/commands/CreateGuardrailCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateGuardrailVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateInferenceProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteGuardrailCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteInferenceProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteModelInvocationLoggingConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetGuardrailCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInferenceProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetModelInvocationLoggingConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListGuardrailsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListInferenceProfilesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutModelInvocationLoggingConfigurationCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateGuardrailCommand.d.ts +1 -1
- package/dist-types/ts3.4/index.d.ts +4 -1
- package/dist-types/ts3.4/models/enums.d.ts +478 -0
- package/dist-types/ts3.4/models/errors.d.ts +71 -0
- package/dist-types/ts3.4/models/models_0.d.ts +371 -380
- package/dist-types/ts3.4/models/models_1.d.ts +30 -520
- package/package.json +13 -13
- package/dist-es/models/index.js +0 -2
- package/dist-types/models/index.d.ts +0 -2
- package/dist-types/ts3.4/models/index.d.ts +0 -2
|
@@ -1,32 +1,5 @@
|
|
|
1
|
-
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
1
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
|
-
import {
|
|
4
|
-
/**
|
|
5
|
-
* <p>The request is denied because of missing access permissions.</p>
|
|
6
|
-
* @public
|
|
7
|
-
*/
|
|
8
|
-
export declare class AccessDeniedException extends __BaseException {
|
|
9
|
-
readonly name: "AccessDeniedException";
|
|
10
|
-
readonly $fault: "client";
|
|
11
|
-
/**
|
|
12
|
-
* @internal
|
|
13
|
-
*/
|
|
14
|
-
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* @public
|
|
18
|
-
* @enum
|
|
19
|
-
*/
|
|
20
|
-
export declare const AgreementStatus: {
|
|
21
|
-
readonly AVAILABLE: "AVAILABLE";
|
|
22
|
-
readonly ERROR: "ERROR";
|
|
23
|
-
readonly NOT_AVAILABLE: "NOT_AVAILABLE";
|
|
24
|
-
readonly PENDING: "PENDING";
|
|
25
|
-
};
|
|
26
|
-
/**
|
|
27
|
-
* @public
|
|
28
|
-
*/
|
|
29
|
-
export type AgreementStatus = (typeof AgreementStatus)[keyof typeof AgreementStatus];
|
|
2
|
+
import { AgreementStatus, ApplicationType, AttributeType, AutomatedReasoningCheckLogicWarningType, AutomatedReasoningCheckResult, AutomatedReasoningPolicyAnnotationStatus, AutomatedReasoningPolicyBuildDocumentContentType, AutomatedReasoningPolicyBuildMessageType, AutomatedReasoningPolicyBuildResultAssetType, AutomatedReasoningPolicyBuildWorkflowStatus, AutomatedReasoningPolicyBuildWorkflowType, AutomatedReasoningPolicyTestRunResult, AutomatedReasoningPolicyTestRunStatus, CustomizationType, CustomModelDeploymentStatus, EvaluationJobStatus, EvaluationJobType, EvaluationTaskType, ExternalSourceType, GuardrailContentFilterAction, GuardrailContentFiltersTierName, GuardrailContentFilterType, GuardrailContextualGroundingAction, GuardrailContextualGroundingFilterType, GuardrailFilterStrength, GuardrailManagedWordsType, GuardrailModality, GuardrailPiiEntityType, GuardrailSensitiveInformationAction, GuardrailStatus, GuardrailTopicAction, GuardrailTopicsTierName, GuardrailTopicType, GuardrailWordAction, InferenceProfileStatus, InferenceProfileType, ModelStatus, PerformanceConfigLatency, QueryTransformationType, RerankingMetadataSelectionMode, SortJobsBy, SortModelsBy, SortOrder, Status, VectorSearchRerankingConfigurationType } from "./enums";
|
|
30
3
|
/**
|
|
31
4
|
* <p>Information about the agreement availability</p>
|
|
32
5
|
* @public
|
|
@@ -58,54 +31,6 @@ export interface GetUseCaseForModelAccessResponse {
|
|
|
58
31
|
*/
|
|
59
32
|
formData: Uint8Array | undefined;
|
|
60
33
|
}
|
|
61
|
-
/**
|
|
62
|
-
* <p>An internal server error occurred. Retry your request.</p>
|
|
63
|
-
* @public
|
|
64
|
-
*/
|
|
65
|
-
export declare class InternalServerException extends __BaseException {
|
|
66
|
-
readonly name: "InternalServerException";
|
|
67
|
-
readonly $fault: "server";
|
|
68
|
-
/**
|
|
69
|
-
* @internal
|
|
70
|
-
*/
|
|
71
|
-
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
72
|
-
}
|
|
73
|
-
/**
|
|
74
|
-
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
75
|
-
* @public
|
|
76
|
-
*/
|
|
77
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
78
|
-
readonly name: "ResourceNotFoundException";
|
|
79
|
-
readonly $fault: "client";
|
|
80
|
-
/**
|
|
81
|
-
* @internal
|
|
82
|
-
*/
|
|
83
|
-
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
84
|
-
}
|
|
85
|
-
/**
|
|
86
|
-
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
87
|
-
* @public
|
|
88
|
-
*/
|
|
89
|
-
export declare class ThrottlingException extends __BaseException {
|
|
90
|
-
readonly name: "ThrottlingException";
|
|
91
|
-
readonly $fault: "client";
|
|
92
|
-
/**
|
|
93
|
-
* @internal
|
|
94
|
-
*/
|
|
95
|
-
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
96
|
-
}
|
|
97
|
-
/**
|
|
98
|
-
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
99
|
-
* @public
|
|
100
|
-
*/
|
|
101
|
-
export declare class ValidationException extends __BaseException {
|
|
102
|
-
readonly name: "ValidationException";
|
|
103
|
-
readonly $fault: "client";
|
|
104
|
-
/**
|
|
105
|
-
* @internal
|
|
106
|
-
*/
|
|
107
|
-
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
108
|
-
}
|
|
109
34
|
/**
|
|
110
35
|
* @public
|
|
111
36
|
*/
|
|
@@ -141,18 +66,6 @@ export interface CancelAutomatedReasoningPolicyBuildWorkflowRequest {
|
|
|
141
66
|
*/
|
|
142
67
|
export interface CancelAutomatedReasoningPolicyBuildWorkflowResponse {
|
|
143
68
|
}
|
|
144
|
-
/**
|
|
145
|
-
* <p>Error occurred because of a conflict while performing an operation.</p>
|
|
146
|
-
* @public
|
|
147
|
-
*/
|
|
148
|
-
export declare class ConflictException extends __BaseException {
|
|
149
|
-
readonly name: "ConflictException";
|
|
150
|
-
readonly $fault: "client";
|
|
151
|
-
/**
|
|
152
|
-
* @internal
|
|
153
|
-
*/
|
|
154
|
-
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
155
|
-
}
|
|
156
69
|
/**
|
|
157
70
|
* <p>Represents a formal logic rule in an Automated Reasoning policy. For example, rules can be expressed as if-then statements that define logical constraints.</p>
|
|
158
71
|
* @public
|
|
@@ -349,52 +262,6 @@ export interface CreateAutomatedReasoningPolicyResponse {
|
|
|
349
262
|
*/
|
|
350
263
|
updatedAt: Date | undefined;
|
|
351
264
|
}
|
|
352
|
-
/**
|
|
353
|
-
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
354
|
-
* @public
|
|
355
|
-
*/
|
|
356
|
-
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
357
|
-
readonly name: "ServiceQuotaExceededException";
|
|
358
|
-
readonly $fault: "client";
|
|
359
|
-
/**
|
|
360
|
-
* @internal
|
|
361
|
-
*/
|
|
362
|
-
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
363
|
-
}
|
|
364
|
-
/**
|
|
365
|
-
* <p>The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. </p>
|
|
366
|
-
* @public
|
|
367
|
-
*/
|
|
368
|
-
export declare class TooManyTagsException extends __BaseException {
|
|
369
|
-
readonly name: "TooManyTagsException";
|
|
370
|
-
readonly $fault: "client";
|
|
371
|
-
/**
|
|
372
|
-
* <p>The name of the resource with too many tags.</p>
|
|
373
|
-
* @public
|
|
374
|
-
*/
|
|
375
|
-
resourceName?: string | undefined;
|
|
376
|
-
/**
|
|
377
|
-
* @internal
|
|
378
|
-
*/
|
|
379
|
-
constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
|
|
380
|
-
}
|
|
381
|
-
/**
|
|
382
|
-
* @public
|
|
383
|
-
* @enum
|
|
384
|
-
*/
|
|
385
|
-
export declare const AutomatedReasoningCheckResult: {
|
|
386
|
-
readonly IMPOSSIBLE: "IMPOSSIBLE";
|
|
387
|
-
readonly INVALID: "INVALID";
|
|
388
|
-
readonly NO_TRANSLATION: "NO_TRANSLATION";
|
|
389
|
-
readonly SATISFIABLE: "SATISFIABLE";
|
|
390
|
-
readonly TOO_COMPLEX: "TOO_COMPLEX";
|
|
391
|
-
readonly TRANSLATION_AMBIGUOUS: "TRANSLATION_AMBIGUOUS";
|
|
392
|
-
readonly VALID: "VALID";
|
|
393
|
-
};
|
|
394
|
-
/**
|
|
395
|
-
* @public
|
|
396
|
-
*/
|
|
397
|
-
export type AutomatedReasoningCheckResult = (typeof AutomatedReasoningCheckResult)[keyof typeof AutomatedReasoningCheckResult];
|
|
398
265
|
/**
|
|
399
266
|
* @public
|
|
400
267
|
*/
|
|
@@ -525,18 +392,6 @@ export interface DeleteAutomatedReasoningPolicyRequest {
|
|
|
525
392
|
*/
|
|
526
393
|
export interface DeleteAutomatedReasoningPolicyResponse {
|
|
527
394
|
}
|
|
528
|
-
/**
|
|
529
|
-
* <p>Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.</p>
|
|
530
|
-
* @public
|
|
531
|
-
*/
|
|
532
|
-
export declare class ResourceInUseException extends __BaseException {
|
|
533
|
-
readonly name: "ResourceInUseException";
|
|
534
|
-
readonly $fault: "client";
|
|
535
|
-
/**
|
|
536
|
-
* @internal
|
|
537
|
-
*/
|
|
538
|
-
constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
|
|
539
|
-
}
|
|
540
395
|
/**
|
|
541
396
|
* @public
|
|
542
397
|
*/
|
|
@@ -1356,49 +1211,6 @@ export interface GetAutomatedReasoningPolicyBuildWorkflowRequest {
|
|
|
1356
1211
|
*/
|
|
1357
1212
|
buildWorkflowId: string | undefined;
|
|
1358
1213
|
}
|
|
1359
|
-
/**
|
|
1360
|
-
* @public
|
|
1361
|
-
* @enum
|
|
1362
|
-
*/
|
|
1363
|
-
export declare const AutomatedReasoningPolicyBuildWorkflowType: {
|
|
1364
|
-
readonly IMPORT_POLICY: "IMPORT_POLICY";
|
|
1365
|
-
readonly INGEST_CONTENT: "INGEST_CONTENT";
|
|
1366
|
-
readonly REFINE_POLICY: "REFINE_POLICY";
|
|
1367
|
-
};
|
|
1368
|
-
/**
|
|
1369
|
-
* @public
|
|
1370
|
-
*/
|
|
1371
|
-
export type AutomatedReasoningPolicyBuildWorkflowType = (typeof AutomatedReasoningPolicyBuildWorkflowType)[keyof typeof AutomatedReasoningPolicyBuildWorkflowType];
|
|
1372
|
-
/**
|
|
1373
|
-
* @public
|
|
1374
|
-
* @enum
|
|
1375
|
-
*/
|
|
1376
|
-
export declare const AutomatedReasoningPolicyBuildDocumentContentType: {
|
|
1377
|
-
readonly PDF: "pdf";
|
|
1378
|
-
readonly TEXT: "txt";
|
|
1379
|
-
};
|
|
1380
|
-
/**
|
|
1381
|
-
* @public
|
|
1382
|
-
*/
|
|
1383
|
-
export type AutomatedReasoningPolicyBuildDocumentContentType = (typeof AutomatedReasoningPolicyBuildDocumentContentType)[keyof typeof AutomatedReasoningPolicyBuildDocumentContentType];
|
|
1384
|
-
/**
|
|
1385
|
-
* @public
|
|
1386
|
-
* @enum
|
|
1387
|
-
*/
|
|
1388
|
-
export declare const AutomatedReasoningPolicyBuildWorkflowStatus: {
|
|
1389
|
-
readonly BUILDING: "BUILDING";
|
|
1390
|
-
readonly CANCELLED: "CANCELLED";
|
|
1391
|
-
readonly CANCEL_REQUESTED: "CANCEL_REQUESTED";
|
|
1392
|
-
readonly COMPLETED: "COMPLETED";
|
|
1393
|
-
readonly FAILED: "FAILED";
|
|
1394
|
-
readonly PREPROCESSING: "PREPROCESSING";
|
|
1395
|
-
readonly SCHEDULED: "SCHEDULED";
|
|
1396
|
-
readonly TESTING: "TESTING";
|
|
1397
|
-
};
|
|
1398
|
-
/**
|
|
1399
|
-
* @public
|
|
1400
|
-
*/
|
|
1401
|
-
export type AutomatedReasoningPolicyBuildWorkflowStatus = (typeof AutomatedReasoningPolicyBuildWorkflowStatus)[keyof typeof AutomatedReasoningPolicyBuildWorkflowStatus];
|
|
1402
1214
|
/**
|
|
1403
1215
|
* @public
|
|
1404
1216
|
*/
|
|
@@ -1449,20 +1261,6 @@ export interface GetAutomatedReasoningPolicyBuildWorkflowResponse {
|
|
|
1449
1261
|
*/
|
|
1450
1262
|
updatedAt: Date | undefined;
|
|
1451
1263
|
}
|
|
1452
|
-
/**
|
|
1453
|
-
* @public
|
|
1454
|
-
* @enum
|
|
1455
|
-
*/
|
|
1456
|
-
export declare const AutomatedReasoningPolicyBuildResultAssetType: {
|
|
1457
|
-
readonly BUILD_LOG: "BUILD_LOG";
|
|
1458
|
-
readonly GENERATED_TEST_CASES: "GENERATED_TEST_CASES";
|
|
1459
|
-
readonly POLICY_DEFINITION: "POLICY_DEFINITION";
|
|
1460
|
-
readonly QUALITY_REPORT: "QUALITY_REPORT";
|
|
1461
|
-
};
|
|
1462
|
-
/**
|
|
1463
|
-
* @public
|
|
1464
|
-
*/
|
|
1465
|
-
export type AutomatedReasoningPolicyBuildResultAssetType = (typeof AutomatedReasoningPolicyBuildResultAssetType)[keyof typeof AutomatedReasoningPolicyBuildResultAssetType];
|
|
1466
1264
|
/**
|
|
1467
1265
|
* @public
|
|
1468
1266
|
*/
|
|
@@ -1818,19 +1616,6 @@ export declare namespace AutomatedReasoningPolicyBuildStepContext {
|
|
|
1818
1616
|
_: (name: string, value: any) => T;
|
|
1819
1617
|
}
|
|
1820
1618
|
}
|
|
1821
|
-
/**
|
|
1822
|
-
* @public
|
|
1823
|
-
* @enum
|
|
1824
|
-
*/
|
|
1825
|
-
export declare const AutomatedReasoningPolicyBuildMessageType: {
|
|
1826
|
-
readonly ERROR: "ERROR";
|
|
1827
|
-
readonly INFO: "INFO";
|
|
1828
|
-
readonly WARNING: "WARNING";
|
|
1829
|
-
};
|
|
1830
|
-
/**
|
|
1831
|
-
* @public
|
|
1832
|
-
*/
|
|
1833
|
-
export type AutomatedReasoningPolicyBuildMessageType = (typeof AutomatedReasoningPolicyBuildMessageType)[keyof typeof AutomatedReasoningPolicyBuildMessageType];
|
|
1834
1619
|
/**
|
|
1835
1620
|
* <p>Represents a message generated during a build step, providing information about what happened or any issues encountered.</p>
|
|
1836
1621
|
* @public
|
|
@@ -1927,18 +1712,6 @@ export interface AutomatedReasoningPolicyBuildStep {
|
|
|
1927
1712
|
*/
|
|
1928
1713
|
messages: AutomatedReasoningPolicyBuildStepMessage[] | undefined;
|
|
1929
1714
|
}
|
|
1930
|
-
/**
|
|
1931
|
-
* @public
|
|
1932
|
-
* @enum
|
|
1933
|
-
*/
|
|
1934
|
-
export declare const AutomatedReasoningPolicyAnnotationStatus: {
|
|
1935
|
-
readonly APPLIED: "APPLIED";
|
|
1936
|
-
readonly FAILED: "FAILED";
|
|
1937
|
-
};
|
|
1938
|
-
/**
|
|
1939
|
-
* @public
|
|
1940
|
-
*/
|
|
1941
|
-
export type AutomatedReasoningPolicyAnnotationStatus = (typeof AutomatedReasoningPolicyAnnotationStatus)[keyof typeof AutomatedReasoningPolicyAnnotationStatus];
|
|
1942
1715
|
/**
|
|
1943
1716
|
* <p>Represents a single entry in the policy build log, containing information about a specific step or event in the build process.</p>
|
|
1944
1717
|
* @public
|
|
@@ -2355,18 +2128,6 @@ export interface AutomatedReasoningLogicStatement {
|
|
|
2355
2128
|
*/
|
|
2356
2129
|
naturalLanguage?: string | undefined;
|
|
2357
2130
|
}
|
|
2358
|
-
/**
|
|
2359
|
-
* @public
|
|
2360
|
-
* @enum
|
|
2361
|
-
*/
|
|
2362
|
-
export declare const AutomatedReasoningCheckLogicWarningType: {
|
|
2363
|
-
readonly ALWAYS_FALSE: "ALWAYS_FALSE";
|
|
2364
|
-
readonly ALWAYS_TRUE: "ALWAYS_TRUE";
|
|
2365
|
-
};
|
|
2366
|
-
/**
|
|
2367
|
-
* @public
|
|
2368
|
-
*/
|
|
2369
|
-
export type AutomatedReasoningCheckLogicWarningType = (typeof AutomatedReasoningCheckLogicWarningType)[keyof typeof AutomatedReasoningCheckLogicWarningType];
|
|
2370
2131
|
/**
|
|
2371
2132
|
* <p>Identifies logical issues in the translated statements that exist independent of any policy rules, such as statements that are always true or always false.</p>
|
|
2372
2133
|
* @public
|
|
@@ -2709,33 +2470,6 @@ export declare namespace AutomatedReasoningCheckFinding {
|
|
|
2709
2470
|
_: (name: string, value: any) => T;
|
|
2710
2471
|
}
|
|
2711
2472
|
}
|
|
2712
|
-
/**
|
|
2713
|
-
* @public
|
|
2714
|
-
* @enum
|
|
2715
|
-
*/
|
|
2716
|
-
export declare const AutomatedReasoningPolicyTestRunResult: {
|
|
2717
|
-
readonly FAILED: "FAILED";
|
|
2718
|
-
readonly PASSED: "PASSED";
|
|
2719
|
-
};
|
|
2720
|
-
/**
|
|
2721
|
-
* @public
|
|
2722
|
-
*/
|
|
2723
|
-
export type AutomatedReasoningPolicyTestRunResult = (typeof AutomatedReasoningPolicyTestRunResult)[keyof typeof AutomatedReasoningPolicyTestRunResult];
|
|
2724
|
-
/**
|
|
2725
|
-
* @public
|
|
2726
|
-
* @enum
|
|
2727
|
-
*/
|
|
2728
|
-
export declare const AutomatedReasoningPolicyTestRunStatus: {
|
|
2729
|
-
readonly COMPLETED: "COMPLETED";
|
|
2730
|
-
readonly FAILED: "FAILED";
|
|
2731
|
-
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
2732
|
-
readonly NOT_STARTED: "NOT_STARTED";
|
|
2733
|
-
readonly SCHEDULED: "SCHEDULED";
|
|
2734
|
-
};
|
|
2735
|
-
/**
|
|
2736
|
-
* @public
|
|
2737
|
-
*/
|
|
2738
|
-
export type AutomatedReasoningPolicyTestRunStatus = (typeof AutomatedReasoningPolicyTestRunStatus)[keyof typeof AutomatedReasoningPolicyTestRunStatus];
|
|
2739
2473
|
/**
|
|
2740
2474
|
* <p>Contains the results of testing an Automated Reasoning policy against various scenarios and validation checks.</p>
|
|
2741
2475
|
* @public
|
|
@@ -3457,18 +3191,6 @@ export interface CreateMarketplaceModelEndpointRequest {
|
|
|
3457
3191
|
*/
|
|
3458
3192
|
tags?: Tag[] | undefined;
|
|
3459
3193
|
}
|
|
3460
|
-
/**
|
|
3461
|
-
* @public
|
|
3462
|
-
* @enum
|
|
3463
|
-
*/
|
|
3464
|
-
export declare const Status: {
|
|
3465
|
-
readonly INCOMPATIBLE_ENDPOINT: "INCOMPATIBLE_ENDPOINT";
|
|
3466
|
-
readonly REGISTERED: "REGISTERED";
|
|
3467
|
-
};
|
|
3468
|
-
/**
|
|
3469
|
-
* @public
|
|
3470
|
-
*/
|
|
3471
|
-
export type Status = (typeof Status)[keyof typeof Status];
|
|
3472
3194
|
/**
|
|
3473
3195
|
* <p>Contains details about an endpoint for a model from Amazon Bedrock Marketplace.</p>
|
|
3474
3196
|
* @public
|
|
@@ -3560,18 +3282,6 @@ export interface DeregisterMarketplaceModelEndpointRequest {
|
|
|
3560
3282
|
*/
|
|
3561
3283
|
export interface DeregisterMarketplaceModelEndpointResponse {
|
|
3562
3284
|
}
|
|
3563
|
-
/**
|
|
3564
|
-
* <p>Returned if the service cannot complete the request.</p>
|
|
3565
|
-
* @public
|
|
3566
|
-
*/
|
|
3567
|
-
export declare class ServiceUnavailableException extends __BaseException {
|
|
3568
|
-
readonly name: "ServiceUnavailableException";
|
|
3569
|
-
readonly $fault: "server";
|
|
3570
|
-
/**
|
|
3571
|
-
* @internal
|
|
3572
|
-
*/
|
|
3573
|
-
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
3574
|
-
}
|
|
3575
3285
|
/**
|
|
3576
3286
|
* @public
|
|
3577
3287
|
*/
|
|
@@ -3783,19 +3493,6 @@ export interface GetCustomModelDeploymentRequest {
|
|
|
3783
3493
|
*/
|
|
3784
3494
|
customModelDeploymentIdentifier: string | undefined;
|
|
3785
3495
|
}
|
|
3786
|
-
/**
|
|
3787
|
-
* @public
|
|
3788
|
-
* @enum
|
|
3789
|
-
*/
|
|
3790
|
-
export declare const CustomModelDeploymentStatus: {
|
|
3791
|
-
readonly ACTIVE: "Active";
|
|
3792
|
-
readonly CREATING: "Creating";
|
|
3793
|
-
readonly FAILED: "Failed";
|
|
3794
|
-
};
|
|
3795
|
-
/**
|
|
3796
|
-
* @public
|
|
3797
|
-
*/
|
|
3798
|
-
export type CustomModelDeploymentStatus = (typeof CustomModelDeploymentStatus)[keyof typeof CustomModelDeploymentStatus];
|
|
3799
3496
|
/**
|
|
3800
3497
|
* @public
|
|
3801
3498
|
*/
|
|
@@ -3841,29 +3538,6 @@ export interface GetCustomModelDeploymentResponse {
|
|
|
3841
3538
|
*/
|
|
3842
3539
|
lastUpdatedAt?: Date | undefined;
|
|
3843
3540
|
}
|
|
3844
|
-
/**
|
|
3845
|
-
* @public
|
|
3846
|
-
* @enum
|
|
3847
|
-
*/
|
|
3848
|
-
export declare const SortModelsBy: {
|
|
3849
|
-
readonly CREATION_TIME: "CreationTime";
|
|
3850
|
-
};
|
|
3851
|
-
/**
|
|
3852
|
-
* @public
|
|
3853
|
-
*/
|
|
3854
|
-
export type SortModelsBy = (typeof SortModelsBy)[keyof typeof SortModelsBy];
|
|
3855
|
-
/**
|
|
3856
|
-
* @public
|
|
3857
|
-
* @enum
|
|
3858
|
-
*/
|
|
3859
|
-
export declare const SortOrder: {
|
|
3860
|
-
readonly ASCENDING: "Ascending";
|
|
3861
|
-
readonly DESCENDING: "Descending";
|
|
3862
|
-
};
|
|
3863
|
-
/**
|
|
3864
|
-
* @public
|
|
3865
|
-
*/
|
|
3866
|
-
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
3867
3541
|
/**
|
|
3868
3542
|
* @public
|
|
3869
3543
|
*/
|
|
@@ -4144,33 +3818,6 @@ export declare namespace CustomizationConfig {
|
|
|
4144
3818
|
_: (name: string, value: any) => T;
|
|
4145
3819
|
}
|
|
4146
3820
|
}
|
|
4147
|
-
/**
|
|
4148
|
-
* @public
|
|
4149
|
-
* @enum
|
|
4150
|
-
*/
|
|
4151
|
-
export declare const CustomizationType: {
|
|
4152
|
-
readonly CONTINUED_PRE_TRAINING: "CONTINUED_PRE_TRAINING";
|
|
4153
|
-
readonly DISTILLATION: "DISTILLATION";
|
|
4154
|
-
readonly FINE_TUNING: "FINE_TUNING";
|
|
4155
|
-
readonly IMPORTED: "IMPORTED";
|
|
4156
|
-
};
|
|
4157
|
-
/**
|
|
4158
|
-
* @public
|
|
4159
|
-
*/
|
|
4160
|
-
export type CustomizationType = (typeof CustomizationType)[keyof typeof CustomizationType];
|
|
4161
|
-
/**
|
|
4162
|
-
* @public
|
|
4163
|
-
* @enum
|
|
4164
|
-
*/
|
|
4165
|
-
export declare const ModelStatus: {
|
|
4166
|
-
readonly ACTIVE: "Active";
|
|
4167
|
-
readonly CREATING: "Creating";
|
|
4168
|
-
readonly FAILED: "Failed";
|
|
4169
|
-
};
|
|
4170
|
-
/**
|
|
4171
|
-
* @public
|
|
4172
|
-
*/
|
|
4173
|
-
export type ModelStatus = (typeof ModelStatus)[keyof typeof ModelStatus];
|
|
4174
3821
|
/**
|
|
4175
3822
|
* <p>S3 Location of the output data.</p>
|
|
4176
3823
|
* @public
|
|
@@ -4629,22 +4276,6 @@ export interface BatchDeleteEvaluationJobError {
|
|
|
4629
4276
|
*/
|
|
4630
4277
|
message?: string | undefined;
|
|
4631
4278
|
}
|
|
4632
|
-
/**
|
|
4633
|
-
* @public
|
|
4634
|
-
* @enum
|
|
4635
|
-
*/
|
|
4636
|
-
export declare const EvaluationJobStatus: {
|
|
4637
|
-
readonly COMPLETED: "Completed";
|
|
4638
|
-
readonly DELETING: "Deleting";
|
|
4639
|
-
readonly FAILED: "Failed";
|
|
4640
|
-
readonly IN_PROGRESS: "InProgress";
|
|
4641
|
-
readonly STOPPED: "Stopped";
|
|
4642
|
-
readonly STOPPING: "Stopping";
|
|
4643
|
-
};
|
|
4644
|
-
/**
|
|
4645
|
-
* @public
|
|
4646
|
-
*/
|
|
4647
|
-
export type EvaluationJobStatus = (typeof EvaluationJobStatus)[keyof typeof EvaluationJobStatus];
|
|
4648
4279
|
/**
|
|
4649
4280
|
* <p>An evaluation job for deletion, and it’s current status.</p>
|
|
4650
4281
|
* @public
|
|
@@ -4676,18 +4307,6 @@ export interface BatchDeleteEvaluationJobResponse {
|
|
|
4676
4307
|
*/
|
|
4677
4308
|
evaluationJobs: BatchDeleteEvaluationJobItem[] | undefined;
|
|
4678
4309
|
}
|
|
4679
|
-
/**
|
|
4680
|
-
* @public
|
|
4681
|
-
* @enum
|
|
4682
|
-
*/
|
|
4683
|
-
export declare const ApplicationType: {
|
|
4684
|
-
readonly MODEL_EVALUATION: "ModelEvaluation";
|
|
4685
|
-
readonly RAG_EVALUATION: "RagEvaluation";
|
|
4686
|
-
};
|
|
4687
|
-
/**
|
|
4688
|
-
* @public
|
|
4689
|
-
*/
|
|
4690
|
-
export type ApplicationType = (typeof ApplicationType)[keyof typeof ApplicationType];
|
|
4691
4310
|
/**
|
|
4692
4311
|
* <p>Defines the value for one rating in a custom metric rating scale.</p>
|
|
4693
4312
|
* @public
|
|
@@ -4890,21 +4509,6 @@ export interface EvaluationDataset {
|
|
|
4890
4509
|
*/
|
|
4891
4510
|
datasetLocation?: EvaluationDatasetLocation | undefined;
|
|
4892
4511
|
}
|
|
4893
|
-
/**
|
|
4894
|
-
* @public
|
|
4895
|
-
* @enum
|
|
4896
|
-
*/
|
|
4897
|
-
export declare const EvaluationTaskType: {
|
|
4898
|
-
readonly CLASSIFICATION: "Classification";
|
|
4899
|
-
readonly CUSTOM: "Custom";
|
|
4900
|
-
readonly GENERATION: "Generation";
|
|
4901
|
-
readonly QUESTION_AND_ANSWER: "QuestionAndAnswer";
|
|
4902
|
-
readonly SUMMARIZATION: "Summarization";
|
|
4903
|
-
};
|
|
4904
|
-
/**
|
|
4905
|
-
* @public
|
|
4906
|
-
*/
|
|
4907
|
-
export type EvaluationTaskType = (typeof EvaluationTaskType)[keyof typeof EvaluationTaskType];
|
|
4908
4512
|
/**
|
|
4909
4513
|
* <p>Defines the prompt datasets, built-in metric names and custom metric names, and the task type.</p>
|
|
4910
4514
|
* @public
|
|
@@ -5094,18 +4698,6 @@ export declare namespace EvaluationConfig {
|
|
|
5094
4698
|
_: (name: string, value: any) => T;
|
|
5095
4699
|
}
|
|
5096
4700
|
}
|
|
5097
|
-
/**
|
|
5098
|
-
* @public
|
|
5099
|
-
* @enum
|
|
5100
|
-
*/
|
|
5101
|
-
export declare const PerformanceConfigLatency: {
|
|
5102
|
-
readonly OPTIMIZED: "optimized";
|
|
5103
|
-
readonly STANDARD: "standard";
|
|
5104
|
-
};
|
|
5105
|
-
/**
|
|
5106
|
-
* @public
|
|
5107
|
-
*/
|
|
5108
|
-
export type PerformanceConfigLatency = (typeof PerformanceConfigLatency)[keyof typeof PerformanceConfigLatency];
|
|
5109
4701
|
/**
|
|
5110
4702
|
* <p>Contains performance settings for a model.</p>
|
|
5111
4703
|
* @public
|
|
@@ -5316,18 +4908,6 @@ export interface S3ObjectDoc {
|
|
|
5316
4908
|
*/
|
|
5317
4909
|
uri: string | undefined;
|
|
5318
4910
|
}
|
|
5319
|
-
/**
|
|
5320
|
-
* @public
|
|
5321
|
-
* @enum
|
|
5322
|
-
*/
|
|
5323
|
-
export declare const ExternalSourceType: {
|
|
5324
|
-
readonly BYTE_CONTENT: "BYTE_CONTENT";
|
|
5325
|
-
readonly S3: "S3";
|
|
5326
|
-
};
|
|
5327
|
-
/**
|
|
5328
|
-
* @public
|
|
5329
|
-
*/
|
|
5330
|
-
export type ExternalSourceType = (typeof ExternalSourceType)[keyof typeof ExternalSourceType];
|
|
5331
4911
|
/**
|
|
5332
4912
|
* <p>The unique external source of the content contained in the wrapper object.</p>
|
|
5333
4913
|
* @public
|
|
@@ -5396,17 +4976,6 @@ export interface GenerationConfiguration {
|
|
|
5396
4976
|
*/
|
|
5397
4977
|
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
5398
4978
|
}
|
|
5399
|
-
/**
|
|
5400
|
-
* @public
|
|
5401
|
-
* @enum
|
|
5402
|
-
*/
|
|
5403
|
-
export declare const QueryTransformationType: {
|
|
5404
|
-
readonly QUERY_DECOMPOSITION: "QUERY_DECOMPOSITION";
|
|
5405
|
-
};
|
|
5406
|
-
/**
|
|
5407
|
-
* @public
|
|
5408
|
-
*/
|
|
5409
|
-
export type QueryTransformationType = (typeof QueryTransformationType)[keyof typeof QueryTransformationType];
|
|
5410
4979
|
/**
|
|
5411
4980
|
* <p>The configuration details for transforming the prompt.</p>
|
|
5412
4981
|
* @public
|
|
@@ -5445,20 +5014,6 @@ export interface FilterAttribute {
|
|
|
5445
5014
|
*/
|
|
5446
5015
|
value: __DocumentType | undefined;
|
|
5447
5016
|
}
|
|
5448
|
-
/**
|
|
5449
|
-
* @public
|
|
5450
|
-
* @enum
|
|
5451
|
-
*/
|
|
5452
|
-
export declare const AttributeType: {
|
|
5453
|
-
readonly BOOLEAN: "BOOLEAN";
|
|
5454
|
-
readonly NUMBER: "NUMBER";
|
|
5455
|
-
readonly STRING: "STRING";
|
|
5456
|
-
readonly STRING_LIST: "STRING_LIST";
|
|
5457
|
-
};
|
|
5458
|
-
/**
|
|
5459
|
-
* @public
|
|
5460
|
-
*/
|
|
5461
|
-
export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType];
|
|
5462
5017
|
/**
|
|
5463
5018
|
* <p>Defines the schema for a metadata attribute used in Knowledge Base vector searches. Metadata attributes provide additional context for documents and can be used for filtering and reranking search results.</p>
|
|
5464
5019
|
* @public
|
|
@@ -5496,30 +5051,6 @@ export interface ImplicitFilterConfiguration {
|
|
|
5496
5051
|
*/
|
|
5497
5052
|
modelArn: string | undefined;
|
|
5498
5053
|
}
|
|
5499
|
-
/**
|
|
5500
|
-
* @public
|
|
5501
|
-
* @enum
|
|
5502
|
-
*/
|
|
5503
|
-
export declare const SearchType: {
|
|
5504
|
-
readonly HYBRID: "HYBRID";
|
|
5505
|
-
readonly SEMANTIC: "SEMANTIC";
|
|
5506
|
-
};
|
|
5507
|
-
/**
|
|
5508
|
-
* @public
|
|
5509
|
-
*/
|
|
5510
|
-
export type SearchType = (typeof SearchType)[keyof typeof SearchType];
|
|
5511
|
-
/**
|
|
5512
|
-
* @public
|
|
5513
|
-
* @enum
|
|
5514
|
-
*/
|
|
5515
|
-
export declare const RerankingMetadataSelectionMode: {
|
|
5516
|
-
readonly ALL: "ALL";
|
|
5517
|
-
readonly SELECTIVE: "SELECTIVE";
|
|
5518
|
-
};
|
|
5519
|
-
/**
|
|
5520
|
-
* @public
|
|
5521
|
-
*/
|
|
5522
|
-
export type RerankingMetadataSelectionMode = (typeof RerankingMetadataSelectionMode)[keyof typeof RerankingMetadataSelectionMode];
|
|
5523
5054
|
/**
|
|
5524
5055
|
* <p>Specifies a field to be used during the reranking process in a Knowledge Base vector search. This structure identifies metadata fields that should be considered when reordering search results to improve relevance.</p>
|
|
5525
5056
|
* @public
|
|
@@ -5629,17 +5160,6 @@ export interface VectorSearchBedrockRerankingConfiguration {
|
|
|
5629
5160
|
*/
|
|
5630
5161
|
metadataConfiguration?: MetadataConfigurationForReranking | undefined;
|
|
5631
5162
|
}
|
|
5632
|
-
/**
|
|
5633
|
-
* @public
|
|
5634
|
-
* @enum
|
|
5635
|
-
*/
|
|
5636
|
-
export declare const VectorSearchRerankingConfigurationType: {
|
|
5637
|
-
readonly BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL";
|
|
5638
|
-
};
|
|
5639
|
-
/**
|
|
5640
|
-
* @public
|
|
5641
|
-
*/
|
|
5642
|
-
export type VectorSearchRerankingConfigurationType = (typeof VectorSearchRerankingConfigurationType)[keyof typeof VectorSearchRerankingConfigurationType];
|
|
5643
5163
|
/**
|
|
5644
5164
|
* <p>Configuration for reranking vector search results to improve relevance. Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria.</p>
|
|
5645
5165
|
* @public
|
|
@@ -5656,18 +5176,6 @@ export interface VectorSearchRerankingConfiguration {
|
|
|
5656
5176
|
*/
|
|
5657
5177
|
bedrockRerankingConfiguration?: VectorSearchBedrockRerankingConfiguration | undefined;
|
|
5658
5178
|
}
|
|
5659
|
-
/**
|
|
5660
|
-
* @public
|
|
5661
|
-
* @enum
|
|
5662
|
-
*/
|
|
5663
|
-
export declare const RetrieveAndGenerateType: {
|
|
5664
|
-
readonly EXTERNAL_SOURCES: "EXTERNAL_SOURCES";
|
|
5665
|
-
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
5666
|
-
};
|
|
5667
|
-
/**
|
|
5668
|
-
* @public
|
|
5669
|
-
*/
|
|
5670
|
-
export type RetrieveAndGenerateType = (typeof RetrieveAndGenerateType)[keyof typeof RetrieveAndGenerateType];
|
|
5671
5179
|
/**
|
|
5672
5180
|
* <p>A summary of a RAG source used for a retrieve-and-generate Knowledge Base evaluation job where you provide your own inference response data.</p>
|
|
5673
5181
|
* @public
|
|
@@ -5766,29 +5274,6 @@ export interface GetEvaluationJobRequest {
|
|
|
5766
5274
|
*/
|
|
5767
5275
|
jobIdentifier: string | undefined;
|
|
5768
5276
|
}
|
|
5769
|
-
/**
|
|
5770
|
-
* @public
|
|
5771
|
-
* @enum
|
|
5772
|
-
*/
|
|
5773
|
-
export declare const EvaluationJobType: {
|
|
5774
|
-
readonly AUTOMATED: "Automated";
|
|
5775
|
-
readonly HUMAN: "Human";
|
|
5776
|
-
};
|
|
5777
|
-
/**
|
|
5778
|
-
* @public
|
|
5779
|
-
*/
|
|
5780
|
-
export type EvaluationJobType = (typeof EvaluationJobType)[keyof typeof EvaluationJobType];
|
|
5781
|
-
/**
|
|
5782
|
-
* @public
|
|
5783
|
-
* @enum
|
|
5784
|
-
*/
|
|
5785
|
-
export declare const SortJobsBy: {
|
|
5786
|
-
readonly CREATION_TIME: "CreationTime";
|
|
5787
|
-
};
|
|
5788
|
-
/**
|
|
5789
|
-
* @public
|
|
5790
|
-
*/
|
|
5791
|
-
export type SortJobsBy = (typeof SortJobsBy)[keyof typeof SortJobsBy];
|
|
5792
5277
|
/**
|
|
5793
5278
|
* @public
|
|
5794
5279
|
*/
|
|
@@ -6004,61 +5489,7 @@ export interface GuardrailAutomatedReasoningPolicyConfig {
|
|
|
6004
5489
|
confidenceThreshold?: number | undefined;
|
|
6005
5490
|
}
|
|
6006
5491
|
/**
|
|
6007
|
-
*
|
|
6008
|
-
* @enum
|
|
6009
|
-
*/
|
|
6010
|
-
export declare const GuardrailContentFilterAction: {
|
|
6011
|
-
readonly BLOCK: "BLOCK";
|
|
6012
|
-
readonly NONE: "NONE";
|
|
6013
|
-
};
|
|
6014
|
-
/**
|
|
6015
|
-
* @public
|
|
6016
|
-
*/
|
|
6017
|
-
export type GuardrailContentFilterAction = (typeof GuardrailContentFilterAction)[keyof typeof GuardrailContentFilterAction];
|
|
6018
|
-
/**
|
|
6019
|
-
* @public
|
|
6020
|
-
* @enum
|
|
6021
|
-
*/
|
|
6022
|
-
export declare const GuardrailModality: {
|
|
6023
|
-
readonly IMAGE: "IMAGE";
|
|
6024
|
-
readonly TEXT: "TEXT";
|
|
6025
|
-
};
|
|
6026
|
-
/**
|
|
6027
|
-
* @public
|
|
6028
|
-
*/
|
|
6029
|
-
export type GuardrailModality = (typeof GuardrailModality)[keyof typeof GuardrailModality];
|
|
6030
|
-
/**
|
|
6031
|
-
* @public
|
|
6032
|
-
* @enum
|
|
6033
|
-
*/
|
|
6034
|
-
export declare const GuardrailFilterStrength: {
|
|
6035
|
-
readonly HIGH: "HIGH";
|
|
6036
|
-
readonly LOW: "LOW";
|
|
6037
|
-
readonly MEDIUM: "MEDIUM";
|
|
6038
|
-
readonly NONE: "NONE";
|
|
6039
|
-
};
|
|
6040
|
-
/**
|
|
6041
|
-
* @public
|
|
6042
|
-
*/
|
|
6043
|
-
export type GuardrailFilterStrength = (typeof GuardrailFilterStrength)[keyof typeof GuardrailFilterStrength];
|
|
6044
|
-
/**
|
|
6045
|
-
* @public
|
|
6046
|
-
* @enum
|
|
6047
|
-
*/
|
|
6048
|
-
export declare const GuardrailContentFilterType: {
|
|
6049
|
-
readonly HATE: "HATE";
|
|
6050
|
-
readonly INSULTS: "INSULTS";
|
|
6051
|
-
readonly MISCONDUCT: "MISCONDUCT";
|
|
6052
|
-
readonly PROMPT_ATTACK: "PROMPT_ATTACK";
|
|
6053
|
-
readonly SEXUAL: "SEXUAL";
|
|
6054
|
-
readonly VIOLENCE: "VIOLENCE";
|
|
6055
|
-
};
|
|
6056
|
-
/**
|
|
6057
|
-
* @public
|
|
6058
|
-
*/
|
|
6059
|
-
export type GuardrailContentFilterType = (typeof GuardrailContentFilterType)[keyof typeof GuardrailContentFilterType];
|
|
6060
|
-
/**
|
|
6061
|
-
* <p>Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.</p> <ul> <li> <p> <b>Hate</b> – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).</p> </li> <li> <p> <b>Insults</b> – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.</p> </li> <li> <p> <b>Sexual</b> – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.</p> </li> <li> <p> <b>Violence</b> – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.</p> </li> </ul> <p>Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as <i>Hate</i> with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as <i>Hate</i> with HIGH confidence, <i>Insults</i> with LOW confidence, <i>Sexual</i> with NONE confidence, and <i>Violence</i> with MEDIUM confidence.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html">Guardrails content filters</a>.</p>
|
|
5492
|
+
* <p>Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.</p> <ul> <li> <p> <b>Hate</b> – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).</p> </li> <li> <p> <b>Insults</b> – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.</p> </li> <li> <p> <b>Sexual</b> – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.</p> </li> <li> <p> <b>Violence</b> – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.</p> </li> </ul> <p>Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as <i>Hate</i> with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as <i>Hate</i> with HIGH confidence, <i>Insults</i> with LOW confidence, <i>Sexual</i> with NONE confidence, and <i>Violence</i> with MEDIUM confidence.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html">Guardrails content filters</a>.</p>
|
|
6062
5493
|
* @public
|
|
6063
5494
|
*/
|
|
6064
5495
|
export interface GuardrailContentFilterConfig {
|
|
@@ -6108,18 +5539,6 @@ export interface GuardrailContentFilterConfig {
|
|
|
6108
5539
|
*/
|
|
6109
5540
|
outputEnabled?: boolean | undefined;
|
|
6110
5541
|
}
|
|
6111
|
-
/**
|
|
6112
|
-
* @public
|
|
6113
|
-
* @enum
|
|
6114
|
-
*/
|
|
6115
|
-
export declare const GuardrailContentFiltersTierName: {
|
|
6116
|
-
readonly CLASSIC: "CLASSIC";
|
|
6117
|
-
readonly STANDARD: "STANDARD";
|
|
6118
|
-
};
|
|
6119
|
-
/**
|
|
6120
|
-
* @public
|
|
6121
|
-
*/
|
|
6122
|
-
export type GuardrailContentFiltersTierName = (typeof GuardrailContentFiltersTierName)[keyof typeof GuardrailContentFiltersTierName];
|
|
6123
5542
|
/**
|
|
6124
5543
|
* <p>The tier that your guardrail uses for content filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.</p>
|
|
6125
5544
|
* @public
|
|
@@ -6147,30 +5566,6 @@ export interface GuardrailContentPolicyConfig {
|
|
|
6147
5566
|
*/
|
|
6148
5567
|
tierConfig?: GuardrailContentFiltersTierConfig | undefined;
|
|
6149
5568
|
}
|
|
6150
|
-
/**
|
|
6151
|
-
* @public
|
|
6152
|
-
* @enum
|
|
6153
|
-
*/
|
|
6154
|
-
export declare const GuardrailContextualGroundingAction: {
|
|
6155
|
-
readonly BLOCK: "BLOCK";
|
|
6156
|
-
readonly NONE: "NONE";
|
|
6157
|
-
};
|
|
6158
|
-
/**
|
|
6159
|
-
* @public
|
|
6160
|
-
*/
|
|
6161
|
-
export type GuardrailContextualGroundingAction = (typeof GuardrailContextualGroundingAction)[keyof typeof GuardrailContextualGroundingAction];
|
|
6162
|
-
/**
|
|
6163
|
-
* @public
|
|
6164
|
-
* @enum
|
|
6165
|
-
*/
|
|
6166
|
-
export declare const GuardrailContextualGroundingFilterType: {
|
|
6167
|
-
readonly GROUNDING: "GROUNDING";
|
|
6168
|
-
readonly RELEVANCE: "RELEVANCE";
|
|
6169
|
-
};
|
|
6170
|
-
/**
|
|
6171
|
-
* @public
|
|
6172
|
-
*/
|
|
6173
|
-
export type GuardrailContextualGroundingFilterType = (typeof GuardrailContextualGroundingFilterType)[keyof typeof GuardrailContextualGroundingFilterType];
|
|
6174
5569
|
/**
|
|
6175
5570
|
* <p>The filter configuration details for the guardrails contextual grounding filter.</p>
|
|
6176
5571
|
* @public
|
|
@@ -6219,60 +5614,6 @@ export interface GuardrailCrossRegionConfig {
|
|
|
6219
5614
|
*/
|
|
6220
5615
|
guardrailProfileIdentifier: string | undefined;
|
|
6221
5616
|
}
|
|
6222
|
-
/**
|
|
6223
|
-
* @public
|
|
6224
|
-
* @enum
|
|
6225
|
-
*/
|
|
6226
|
-
export declare const GuardrailSensitiveInformationAction: {
|
|
6227
|
-
readonly ANONYMIZE: "ANONYMIZE";
|
|
6228
|
-
readonly BLOCK: "BLOCK";
|
|
6229
|
-
readonly NONE: "NONE";
|
|
6230
|
-
};
|
|
6231
|
-
/**
|
|
6232
|
-
* @public
|
|
6233
|
-
*/
|
|
6234
|
-
export type GuardrailSensitiveInformationAction = (typeof GuardrailSensitiveInformationAction)[keyof typeof GuardrailSensitiveInformationAction];
|
|
6235
|
-
/**
|
|
6236
|
-
* @public
|
|
6237
|
-
* @enum
|
|
6238
|
-
*/
|
|
6239
|
-
export declare const GuardrailPiiEntityType: {
|
|
6240
|
-
readonly ADDRESS: "ADDRESS";
|
|
6241
|
-
readonly AGE: "AGE";
|
|
6242
|
-
readonly AWS_ACCESS_KEY: "AWS_ACCESS_KEY";
|
|
6243
|
-
readonly AWS_SECRET_KEY: "AWS_SECRET_KEY";
|
|
6244
|
-
readonly CA_HEALTH_NUMBER: "CA_HEALTH_NUMBER";
|
|
6245
|
-
readonly CA_SOCIAL_INSURANCE_NUMBER: "CA_SOCIAL_INSURANCE_NUMBER";
|
|
6246
|
-
readonly CREDIT_DEBIT_CARD_CVV: "CREDIT_DEBIT_CARD_CVV";
|
|
6247
|
-
readonly CREDIT_DEBIT_CARD_EXPIRY: "CREDIT_DEBIT_CARD_EXPIRY";
|
|
6248
|
-
readonly CREDIT_DEBIT_CARD_NUMBER: "CREDIT_DEBIT_CARD_NUMBER";
|
|
6249
|
-
readonly DRIVER_ID: "DRIVER_ID";
|
|
6250
|
-
readonly EMAIL: "EMAIL";
|
|
6251
|
-
readonly INTERNATIONAL_BANK_ACCOUNT_NUMBER: "INTERNATIONAL_BANK_ACCOUNT_NUMBER";
|
|
6252
|
-
readonly IP_ADDRESS: "IP_ADDRESS";
|
|
6253
|
-
readonly LICENSE_PLATE: "LICENSE_PLATE";
|
|
6254
|
-
readonly MAC_ADDRESS: "MAC_ADDRESS";
|
|
6255
|
-
readonly NAME: "NAME";
|
|
6256
|
-
readonly PASSWORD: "PASSWORD";
|
|
6257
|
-
readonly PHONE: "PHONE";
|
|
6258
|
-
readonly PIN: "PIN";
|
|
6259
|
-
readonly SWIFT_CODE: "SWIFT_CODE";
|
|
6260
|
-
readonly UK_NATIONAL_HEALTH_SERVICE_NUMBER: "UK_NATIONAL_HEALTH_SERVICE_NUMBER";
|
|
6261
|
-
readonly UK_NATIONAL_INSURANCE_NUMBER: "UK_NATIONAL_INSURANCE_NUMBER";
|
|
6262
|
-
readonly UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER: "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER";
|
|
6263
|
-
readonly URL: "URL";
|
|
6264
|
-
readonly USERNAME: "USERNAME";
|
|
6265
|
-
readonly US_BANK_ACCOUNT_NUMBER: "US_BANK_ACCOUNT_NUMBER";
|
|
6266
|
-
readonly US_BANK_ROUTING_NUMBER: "US_BANK_ROUTING_NUMBER";
|
|
6267
|
-
readonly US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER: "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER";
|
|
6268
|
-
readonly US_PASSPORT_NUMBER: "US_PASSPORT_NUMBER";
|
|
6269
|
-
readonly US_SOCIAL_SECURITY_NUMBER: "US_SOCIAL_SECURITY_NUMBER";
|
|
6270
|
-
readonly VEHICLE_IDENTIFICATION_NUMBER: "VEHICLE_IDENTIFICATION_NUMBER";
|
|
6271
|
-
};
|
|
6272
|
-
/**
|
|
6273
|
-
* @public
|
|
6274
|
-
*/
|
|
6275
|
-
export type GuardrailPiiEntityType = (typeof GuardrailPiiEntityType)[keyof typeof GuardrailPiiEntityType];
|
|
6276
5617
|
/**
|
|
6277
5618
|
* <p>The PII entity to configure for the guardrail.</p>
|
|
6278
5619
|
* @public
|
|
@@ -6371,18 +5712,6 @@ export interface GuardrailSensitiveInformationPolicyConfig {
|
|
|
6371
5712
|
*/
|
|
6372
5713
|
regexesConfig?: GuardrailRegexConfig[] | undefined;
|
|
6373
5714
|
}
|
|
6374
|
-
/**
|
|
6375
|
-
* @public
|
|
6376
|
-
* @enum
|
|
6377
|
-
*/
|
|
6378
|
-
export declare const GuardrailTopicsTierName: {
|
|
6379
|
-
readonly CLASSIC: "CLASSIC";
|
|
6380
|
-
readonly STANDARD: "STANDARD";
|
|
6381
|
-
};
|
|
6382
|
-
/**
|
|
6383
|
-
* @public
|
|
6384
|
-
*/
|
|
6385
|
-
export type GuardrailTopicsTierName = (typeof GuardrailTopicsTierName)[keyof typeof GuardrailTopicsTierName];
|
|
6386
5715
|
/**
|
|
6387
5716
|
* <p>The tier that your guardrail uses for denied topic filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.</p>
|
|
6388
5717
|
* @public
|
|
@@ -6394,29 +5723,6 @@ export interface GuardrailTopicsTierConfig {
|
|
|
6394
5723
|
*/
|
|
6395
5724
|
tierName: GuardrailTopicsTierName | undefined;
|
|
6396
5725
|
}
|
|
6397
|
-
/**
|
|
6398
|
-
* @public
|
|
6399
|
-
* @enum
|
|
6400
|
-
*/
|
|
6401
|
-
export declare const GuardrailTopicAction: {
|
|
6402
|
-
readonly BLOCK: "BLOCK";
|
|
6403
|
-
readonly NONE: "NONE";
|
|
6404
|
-
};
|
|
6405
|
-
/**
|
|
6406
|
-
* @public
|
|
6407
|
-
*/
|
|
6408
|
-
export type GuardrailTopicAction = (typeof GuardrailTopicAction)[keyof typeof GuardrailTopicAction];
|
|
6409
|
-
/**
|
|
6410
|
-
* @public
|
|
6411
|
-
* @enum
|
|
6412
|
-
*/
|
|
6413
|
-
export declare const GuardrailTopicType: {
|
|
6414
|
-
readonly DENY: "DENY";
|
|
6415
|
-
};
|
|
6416
|
-
/**
|
|
6417
|
-
* @public
|
|
6418
|
-
*/
|
|
6419
|
-
export type GuardrailTopicType = (typeof GuardrailTopicType)[keyof typeof GuardrailTopicType];
|
|
6420
5726
|
/**
|
|
6421
5727
|
* <p>Details about topics for the guardrail to identify and deny.</p>
|
|
6422
5728
|
* @public
|
|
@@ -6463,3 +5769,1307 @@ export interface GuardrailTopicConfig {
|
|
|
6463
5769
|
*/
|
|
6464
5770
|
outputEnabled?: boolean | undefined;
|
|
6465
5771
|
}
|
|
5772
|
+
/**
|
|
5773
|
+
* <p>Contains details about topics that the guardrail should identify and deny.</p>
|
|
5774
|
+
* @public
|
|
5775
|
+
*/
|
|
5776
|
+
export interface GuardrailTopicPolicyConfig {
|
|
5777
|
+
/**
|
|
5778
|
+
* <p>A list of policies related to topics that the guardrail should deny.</p>
|
|
5779
|
+
* @public
|
|
5780
|
+
*/
|
|
5781
|
+
topicsConfig: GuardrailTopicConfig[] | undefined;
|
|
5782
|
+
/**
|
|
5783
|
+
* <p>The tier that your guardrail uses for denied topic filters.</p>
|
|
5784
|
+
* @public
|
|
5785
|
+
*/
|
|
5786
|
+
tierConfig?: GuardrailTopicsTierConfig | undefined;
|
|
5787
|
+
}
|
|
5788
|
+
/**
|
|
5789
|
+
* <p>The managed word list to configure for the guardrail.</p>
|
|
5790
|
+
* @public
|
|
5791
|
+
*/
|
|
5792
|
+
export interface GuardrailManagedWordsConfig {
|
|
5793
|
+
/**
|
|
5794
|
+
* <p>The managed word type to configure for the guardrail.</p>
|
|
5795
|
+
* @public
|
|
5796
|
+
*/
|
|
5797
|
+
type: GuardrailManagedWordsType | undefined;
|
|
5798
|
+
/**
|
|
5799
|
+
* <p>Specifies the action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
5800
|
+
* @public
|
|
5801
|
+
*/
|
|
5802
|
+
inputAction?: GuardrailWordAction | undefined;
|
|
5803
|
+
/**
|
|
5804
|
+
* <p>Specifies the action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
5805
|
+
* @public
|
|
5806
|
+
*/
|
|
5807
|
+
outputAction?: GuardrailWordAction | undefined;
|
|
5808
|
+
/**
|
|
5809
|
+
* <p>Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
5810
|
+
* @public
|
|
5811
|
+
*/
|
|
5812
|
+
inputEnabled?: boolean | undefined;
|
|
5813
|
+
/**
|
|
5814
|
+
* <p>Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
5815
|
+
* @public
|
|
5816
|
+
*/
|
|
5817
|
+
outputEnabled?: boolean | undefined;
|
|
5818
|
+
}
|
|
5819
|
+
/**
|
|
5820
|
+
* <p>A word to configure for the guardrail.</p>
|
|
5821
|
+
* @public
|
|
5822
|
+
*/
|
|
5823
|
+
export interface GuardrailWordConfig {
|
|
5824
|
+
/**
|
|
5825
|
+
* <p>Text of the word configured for the guardrail to block.</p>
|
|
5826
|
+
* @public
|
|
5827
|
+
*/
|
|
5828
|
+
text: string | undefined;
|
|
5829
|
+
/**
|
|
5830
|
+
* <p>Specifies the action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
5831
|
+
* @public
|
|
5832
|
+
*/
|
|
5833
|
+
inputAction?: GuardrailWordAction | undefined;
|
|
5834
|
+
/**
|
|
5835
|
+
* <p>Specifies the action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
5836
|
+
* @public
|
|
5837
|
+
*/
|
|
5838
|
+
outputAction?: GuardrailWordAction | undefined;
|
|
5839
|
+
/**
|
|
5840
|
+
* <p>Specifies whether to enable guardrail evaluation on the intput. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
5841
|
+
* @public
|
|
5842
|
+
*/
|
|
5843
|
+
inputEnabled?: boolean | undefined;
|
|
5844
|
+
/**
|
|
5845
|
+
* <p>Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
5846
|
+
* @public
|
|
5847
|
+
*/
|
|
5848
|
+
outputEnabled?: boolean | undefined;
|
|
5849
|
+
}
|
|
5850
|
+
/**
|
|
5851
|
+
* <p>Contains details about the word policy to configured for the guardrail.</p>
|
|
5852
|
+
* @public
|
|
5853
|
+
*/
|
|
5854
|
+
export interface GuardrailWordPolicyConfig {
|
|
5855
|
+
/**
|
|
5856
|
+
* <p>A list of words to configure for the guardrail.</p>
|
|
5857
|
+
* @public
|
|
5858
|
+
*/
|
|
5859
|
+
wordsConfig?: GuardrailWordConfig[] | undefined;
|
|
5860
|
+
/**
|
|
5861
|
+
* <p>A list of managed words to configure for the guardrail.</p>
|
|
5862
|
+
* @public
|
|
5863
|
+
*/
|
|
5864
|
+
managedWordListsConfig?: GuardrailManagedWordsConfig[] | undefined;
|
|
5865
|
+
}
|
|
5866
|
+
/**
|
|
5867
|
+
* @public
|
|
5868
|
+
*/
|
|
5869
|
+
export interface CreateGuardrailRequest {
|
|
5870
|
+
/**
|
|
5871
|
+
* <p>The name to give the guardrail.</p>
|
|
5872
|
+
* @public
|
|
5873
|
+
*/
|
|
5874
|
+
name: string | undefined;
|
|
5875
|
+
/**
|
|
5876
|
+
* <p>A description of the guardrail.</p>
|
|
5877
|
+
* @public
|
|
5878
|
+
*/
|
|
5879
|
+
description?: string | undefined;
|
|
5880
|
+
/**
|
|
5881
|
+
* <p>The topic policies to configure for the guardrail.</p>
|
|
5882
|
+
* @public
|
|
5883
|
+
*/
|
|
5884
|
+
topicPolicyConfig?: GuardrailTopicPolicyConfig | undefined;
|
|
5885
|
+
/**
|
|
5886
|
+
* <p>The content filter policies to configure for the guardrail.</p>
|
|
5887
|
+
* @public
|
|
5888
|
+
*/
|
|
5889
|
+
contentPolicyConfig?: GuardrailContentPolicyConfig | undefined;
|
|
5890
|
+
/**
|
|
5891
|
+
* <p>The word policy you configure for the guardrail.</p>
|
|
5892
|
+
* @public
|
|
5893
|
+
*/
|
|
5894
|
+
wordPolicyConfig?: GuardrailWordPolicyConfig | undefined;
|
|
5895
|
+
/**
|
|
5896
|
+
* <p>The sensitive information policy to configure for the guardrail.</p>
|
|
5897
|
+
* @public
|
|
5898
|
+
*/
|
|
5899
|
+
sensitiveInformationPolicyConfig?: GuardrailSensitiveInformationPolicyConfig | undefined;
|
|
5900
|
+
/**
|
|
5901
|
+
* <p>The contextual grounding policy configuration used to create a guardrail.</p>
|
|
5902
|
+
* @public
|
|
5903
|
+
*/
|
|
5904
|
+
contextualGroundingPolicyConfig?: GuardrailContextualGroundingPolicyConfig | undefined;
|
|
5905
|
+
/**
|
|
5906
|
+
* <p>Optional configuration for integrating Automated Reasoning policies with the new guardrail.</p>
|
|
5907
|
+
* @public
|
|
5908
|
+
*/
|
|
5909
|
+
automatedReasoningPolicyConfig?: GuardrailAutomatedReasoningPolicyConfig | undefined;
|
|
5910
|
+
/**
|
|
5911
|
+
* <p>The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">Amazon Bedrock User Guide</a>.</p>
|
|
5912
|
+
* @public
|
|
5913
|
+
*/
|
|
5914
|
+
crossRegionConfig?: GuardrailCrossRegionConfig | undefined;
|
|
5915
|
+
/**
|
|
5916
|
+
* <p>The message to return when the guardrail blocks a prompt.</p>
|
|
5917
|
+
* @public
|
|
5918
|
+
*/
|
|
5919
|
+
blockedInputMessaging: string | undefined;
|
|
5920
|
+
/**
|
|
5921
|
+
* <p>The message to return when the guardrail blocks a model response.</p>
|
|
5922
|
+
* @public
|
|
5923
|
+
*/
|
|
5924
|
+
blockedOutputsMessaging: string | undefined;
|
|
5925
|
+
/**
|
|
5926
|
+
* <p>The ARN of the KMS key that you use to encrypt the guardrail.</p>
|
|
5927
|
+
* @public
|
|
5928
|
+
*/
|
|
5929
|
+
kmsKeyId?: string | undefined;
|
|
5930
|
+
/**
|
|
5931
|
+
* <p>The tags that you want to attach to the guardrail. </p>
|
|
5932
|
+
* @public
|
|
5933
|
+
*/
|
|
5934
|
+
tags?: Tag[] | undefined;
|
|
5935
|
+
/**
|
|
5936
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5937
|
+
* @public
|
|
5938
|
+
*/
|
|
5939
|
+
clientRequestToken?: string | undefined;
|
|
5940
|
+
}
|
|
5941
|
+
/**
|
|
5942
|
+
* @public
|
|
5943
|
+
*/
|
|
5944
|
+
export interface CreateGuardrailResponse {
|
|
5945
|
+
/**
|
|
5946
|
+
* <p>The unique identifier of the guardrail that was created.</p>
|
|
5947
|
+
* @public
|
|
5948
|
+
*/
|
|
5949
|
+
guardrailId: string | undefined;
|
|
5950
|
+
/**
|
|
5951
|
+
* <p>The ARN of the guardrail.</p>
|
|
5952
|
+
* @public
|
|
5953
|
+
*/
|
|
5954
|
+
guardrailArn: string | undefined;
|
|
5955
|
+
/**
|
|
5956
|
+
* <p>The version of the guardrail that was created. This value will always be <code>DRAFT</code>.</p>
|
|
5957
|
+
* @public
|
|
5958
|
+
*/
|
|
5959
|
+
version: string | undefined;
|
|
5960
|
+
/**
|
|
5961
|
+
* <p>The time at which the guardrail was created.</p>
|
|
5962
|
+
* @public
|
|
5963
|
+
*/
|
|
5964
|
+
createdAt: Date | undefined;
|
|
5965
|
+
}
|
|
5966
|
+
/**
|
|
5967
|
+
* @public
|
|
5968
|
+
*/
|
|
5969
|
+
export interface CreateGuardrailVersionRequest {
|
|
5970
|
+
/**
|
|
5971
|
+
* <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
|
|
5972
|
+
* @public
|
|
5973
|
+
*/
|
|
5974
|
+
guardrailIdentifier: string | undefined;
|
|
5975
|
+
/**
|
|
5976
|
+
* <p>A description of the guardrail version.</p>
|
|
5977
|
+
* @public
|
|
5978
|
+
*/
|
|
5979
|
+
description?: string | undefined;
|
|
5980
|
+
/**
|
|
5981
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5982
|
+
* @public
|
|
5983
|
+
*/
|
|
5984
|
+
clientRequestToken?: string | undefined;
|
|
5985
|
+
}
|
|
5986
|
+
/**
|
|
5987
|
+
* @public
|
|
5988
|
+
*/
|
|
5989
|
+
export interface CreateGuardrailVersionResponse {
|
|
5990
|
+
/**
|
|
5991
|
+
* <p>The unique identifier of the guardrail.</p>
|
|
5992
|
+
* @public
|
|
5993
|
+
*/
|
|
5994
|
+
guardrailId: string | undefined;
|
|
5995
|
+
/**
|
|
5996
|
+
* <p>The number of the version of the guardrail.</p>
|
|
5997
|
+
* @public
|
|
5998
|
+
*/
|
|
5999
|
+
version: string | undefined;
|
|
6000
|
+
}
|
|
6001
|
+
/**
|
|
6002
|
+
* @public
|
|
6003
|
+
*/
|
|
6004
|
+
export interface DeleteGuardrailRequest {
|
|
6005
|
+
/**
|
|
6006
|
+
* <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
|
|
6007
|
+
* @public
|
|
6008
|
+
*/
|
|
6009
|
+
guardrailIdentifier: string | undefined;
|
|
6010
|
+
/**
|
|
6011
|
+
* <p>The version of the guardrail.</p>
|
|
6012
|
+
* @public
|
|
6013
|
+
*/
|
|
6014
|
+
guardrailVersion?: string | undefined;
|
|
6015
|
+
}
|
|
6016
|
+
/**
|
|
6017
|
+
* @public
|
|
6018
|
+
*/
|
|
6019
|
+
export interface DeleteGuardrailResponse {
|
|
6020
|
+
}
|
|
6021
|
+
/**
|
|
6022
|
+
* @public
|
|
6023
|
+
*/
|
|
6024
|
+
export interface GetGuardrailRequest {
|
|
6025
|
+
/**
|
|
6026
|
+
* <p>The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.</p>
|
|
6027
|
+
* @public
|
|
6028
|
+
*/
|
|
6029
|
+
guardrailIdentifier: string | undefined;
|
|
6030
|
+
/**
|
|
6031
|
+
* <p>The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the <code>DRAFT</code> version.</p>
|
|
6032
|
+
* @public
|
|
6033
|
+
*/
|
|
6034
|
+
guardrailVersion?: string | undefined;
|
|
6035
|
+
}
|
|
6036
|
+
/**
|
|
6037
|
+
* <p>Represents the configuration of Automated Reasoning policies within a Amazon Bedrock Guardrail, including the policies to apply and confidence thresholds.</p>
|
|
6038
|
+
* @public
|
|
6039
|
+
*/
|
|
6040
|
+
export interface GuardrailAutomatedReasoningPolicy {
|
|
6041
|
+
/**
|
|
6042
|
+
* <p>The list of Automated Reasoning policy ARNs that should be applied as part of this guardrail configuration.</p>
|
|
6043
|
+
* @public
|
|
6044
|
+
*/
|
|
6045
|
+
policies: string[] | undefined;
|
|
6046
|
+
/**
|
|
6047
|
+
* <p>The minimum confidence level required for Automated Reasoning policy violations to trigger guardrail actions. Values range from 0.0 to 1.0.</p>
|
|
6048
|
+
* @public
|
|
6049
|
+
*/
|
|
6050
|
+
confidenceThreshold?: number | undefined;
|
|
6051
|
+
}
|
|
6052
|
+
/**
|
|
6053
|
+
* <p>Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.</p> <ul> <li> <p> <b>Hate</b> – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).</p> </li> <li> <p> <b>Insults</b> – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.</p> </li> <li> <p> <b>Sexual</b> – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.</p> </li> <li> <p> <b>Violence</b> – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.</p> </li> </ul> <p>Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as <i>Hate</i> with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as <i>Hate</i> with HIGH confidence, <i>Insults</i> with LOW confidence, <i>Sexual</i> with NONE confidence, and <i>Violence</i> with MEDIUM confidence.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html">Guardrails content filters</a>.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
|
|
6054
|
+
* @public
|
|
6055
|
+
*/
|
|
6056
|
+
export interface GuardrailContentFilter {
|
|
6057
|
+
/**
|
|
6058
|
+
* <p>The harmful category that the content filter is applied to.</p>
|
|
6059
|
+
* @public
|
|
6060
|
+
*/
|
|
6061
|
+
type: GuardrailContentFilterType | undefined;
|
|
6062
|
+
/**
|
|
6063
|
+
* <p>The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.</p>
|
|
6064
|
+
* @public
|
|
6065
|
+
*/
|
|
6066
|
+
inputStrength: GuardrailFilterStrength | undefined;
|
|
6067
|
+
/**
|
|
6068
|
+
* <p>The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.</p>
|
|
6069
|
+
* @public
|
|
6070
|
+
*/
|
|
6071
|
+
outputStrength: GuardrailFilterStrength | undefined;
|
|
6072
|
+
/**
|
|
6073
|
+
* <p>The input modalities selected for the guardrail content filter.</p>
|
|
6074
|
+
* @public
|
|
6075
|
+
*/
|
|
6076
|
+
inputModalities?: GuardrailModality[] | undefined;
|
|
6077
|
+
/**
|
|
6078
|
+
* <p>The output modalities selected for the guardrail content filter.</p>
|
|
6079
|
+
* @public
|
|
6080
|
+
*/
|
|
6081
|
+
outputModalities?: GuardrailModality[] | undefined;
|
|
6082
|
+
/**
|
|
6083
|
+
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6084
|
+
* @public
|
|
6085
|
+
*/
|
|
6086
|
+
inputAction?: GuardrailContentFilterAction | undefined;
|
|
6087
|
+
/**
|
|
6088
|
+
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6089
|
+
* @public
|
|
6090
|
+
*/
|
|
6091
|
+
outputAction?: GuardrailContentFilterAction | undefined;
|
|
6092
|
+
/**
|
|
6093
|
+
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6094
|
+
* @public
|
|
6095
|
+
*/
|
|
6096
|
+
inputEnabled?: boolean | undefined;
|
|
6097
|
+
/**
|
|
6098
|
+
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6099
|
+
* @public
|
|
6100
|
+
*/
|
|
6101
|
+
outputEnabled?: boolean | undefined;
|
|
6102
|
+
}
|
|
6103
|
+
/**
|
|
6104
|
+
* <p>The tier that your guardrail uses for content filters.</p>
|
|
6105
|
+
* @public
|
|
6106
|
+
*/
|
|
6107
|
+
export interface GuardrailContentFiltersTier {
|
|
6108
|
+
/**
|
|
6109
|
+
* <p>The tier that your guardrail uses for content filters. Valid values include:</p> <ul> <li> <p> <code>CLASSIC</code> tier – Provides established guardrails functionality supporting English, French, and Spanish languages.</p> </li> <li> <p> <code>STANDARD</code> tier – Provides a more robust solution than the <code>CLASSIC</code> tier and has more comprehensive language support. This tier requires that your guardrail use <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">cross-Region inference</a>.</p> </li> </ul>
|
|
6110
|
+
* @public
|
|
6111
|
+
*/
|
|
6112
|
+
tierName: GuardrailContentFiltersTierName | undefined;
|
|
6113
|
+
}
|
|
6114
|
+
/**
|
|
6115
|
+
* <p>Contains details about how to handle harmful content.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
|
|
6116
|
+
* @public
|
|
6117
|
+
*/
|
|
6118
|
+
export interface GuardrailContentPolicy {
|
|
6119
|
+
/**
|
|
6120
|
+
* <p>Contains the type of the content filter and how strongly it should apply to prompts and model responses.</p>
|
|
6121
|
+
* @public
|
|
6122
|
+
*/
|
|
6123
|
+
filters?: GuardrailContentFilter[] | undefined;
|
|
6124
|
+
/**
|
|
6125
|
+
* <p>The tier that your guardrail uses for content filters.</p>
|
|
6126
|
+
* @public
|
|
6127
|
+
*/
|
|
6128
|
+
tier?: GuardrailContentFiltersTier | undefined;
|
|
6129
|
+
}
|
|
6130
|
+
/**
|
|
6131
|
+
* <p>The details for the guardrails contextual grounding filter.</p>
|
|
6132
|
+
* @public
|
|
6133
|
+
*/
|
|
6134
|
+
export interface GuardrailContextualGroundingFilter {
|
|
6135
|
+
/**
|
|
6136
|
+
* <p>The filter type details for the guardrails contextual grounding filter.</p>
|
|
6137
|
+
* @public
|
|
6138
|
+
*/
|
|
6139
|
+
type: GuardrailContextualGroundingFilterType | undefined;
|
|
6140
|
+
/**
|
|
6141
|
+
* <p>The threshold details for the guardrails contextual grounding filter.</p>
|
|
6142
|
+
* @public
|
|
6143
|
+
*/
|
|
6144
|
+
threshold: number | undefined;
|
|
6145
|
+
/**
|
|
6146
|
+
* <p>The action to take when content fails the contextual grounding evaluation. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6147
|
+
* @public
|
|
6148
|
+
*/
|
|
6149
|
+
action?: GuardrailContextualGroundingAction | undefined;
|
|
6150
|
+
/**
|
|
6151
|
+
* <p>Indicates whether contextual grounding is enabled for evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6152
|
+
* @public
|
|
6153
|
+
*/
|
|
6154
|
+
enabled?: boolean | undefined;
|
|
6155
|
+
}
|
|
6156
|
+
/**
|
|
6157
|
+
* <p>The details for the guardrails contextual grounding policy.</p>
|
|
6158
|
+
* @public
|
|
6159
|
+
*/
|
|
6160
|
+
export interface GuardrailContextualGroundingPolicy {
|
|
6161
|
+
/**
|
|
6162
|
+
* <p>The filter details for the guardrails contextual grounding policy.</p>
|
|
6163
|
+
* @public
|
|
6164
|
+
*/
|
|
6165
|
+
filters: GuardrailContextualGroundingFilter[] | undefined;
|
|
6166
|
+
}
|
|
6167
|
+
/**
|
|
6168
|
+
* <p>Contains details about the system-defined guardrail profile that you're using with your guardrail for cross-Region inference.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">Amazon Bedrock User Guide</a>.</p>
|
|
6169
|
+
* @public
|
|
6170
|
+
*/
|
|
6171
|
+
export interface GuardrailCrossRegionDetails {
|
|
6172
|
+
/**
|
|
6173
|
+
* <p>The ID of the guardrail profile that your guardrail is using. Profile availability depends on your current Amazon Web Services Region. For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region-support.html">Amazon Bedrock User Guide</a>.</p>
|
|
6174
|
+
* @public
|
|
6175
|
+
*/
|
|
6176
|
+
guardrailProfileId?: string | undefined;
|
|
6177
|
+
/**
|
|
6178
|
+
* <p>The Amazon Resource Name (ARN) of the guardrail profile that you're using with your guardrail.</p>
|
|
6179
|
+
* @public
|
|
6180
|
+
*/
|
|
6181
|
+
guardrailProfileArn?: string | undefined;
|
|
6182
|
+
}
|
|
6183
|
+
/**
|
|
6184
|
+
* <p>The PII entity configured for the guardrail.</p>
|
|
6185
|
+
* @public
|
|
6186
|
+
*/
|
|
6187
|
+
export interface GuardrailPiiEntity {
|
|
6188
|
+
/**
|
|
6189
|
+
* <p>The type of PII entity. For example, Social Security Number.</p>
|
|
6190
|
+
* @public
|
|
6191
|
+
*/
|
|
6192
|
+
type: GuardrailPiiEntityType | undefined;
|
|
6193
|
+
/**
|
|
6194
|
+
* <p>The configured guardrail action when PII entity is detected.</p>
|
|
6195
|
+
* @public
|
|
6196
|
+
*/
|
|
6197
|
+
action: GuardrailSensitiveInformationAction | undefined;
|
|
6198
|
+
/**
|
|
6199
|
+
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>ANONYMIZE</code> – Mask the content and replace it with identifier tags.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6200
|
+
* @public
|
|
6201
|
+
*/
|
|
6202
|
+
inputAction?: GuardrailSensitiveInformationAction | undefined;
|
|
6203
|
+
/**
|
|
6204
|
+
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>ANONYMIZE</code> – Mask the content and replace it with identifier tags.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6205
|
+
* @public
|
|
6206
|
+
*/
|
|
6207
|
+
outputAction?: GuardrailSensitiveInformationAction | undefined;
|
|
6208
|
+
/**
|
|
6209
|
+
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6210
|
+
* @public
|
|
6211
|
+
*/
|
|
6212
|
+
inputEnabled?: boolean | undefined;
|
|
6213
|
+
/**
|
|
6214
|
+
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6215
|
+
* @public
|
|
6216
|
+
*/
|
|
6217
|
+
outputEnabled?: boolean | undefined;
|
|
6218
|
+
}
|
|
6219
|
+
/**
|
|
6220
|
+
* <p>The regular expression configured for the guardrail.</p>
|
|
6221
|
+
* @public
|
|
6222
|
+
*/
|
|
6223
|
+
export interface GuardrailRegex {
|
|
6224
|
+
/**
|
|
6225
|
+
* <p>The name of the regular expression for the guardrail.</p>
|
|
6226
|
+
* @public
|
|
6227
|
+
*/
|
|
6228
|
+
name: string | undefined;
|
|
6229
|
+
/**
|
|
6230
|
+
* <p>The description of the regular expression for the guardrail.</p>
|
|
6231
|
+
* @public
|
|
6232
|
+
*/
|
|
6233
|
+
description?: string | undefined;
|
|
6234
|
+
/**
|
|
6235
|
+
* <p>The pattern of the regular expression configured for the guardrail.</p>
|
|
6236
|
+
* @public
|
|
6237
|
+
*/
|
|
6238
|
+
pattern: string | undefined;
|
|
6239
|
+
/**
|
|
6240
|
+
* <p>The action taken when a match to the regular expression is detected.</p>
|
|
6241
|
+
* @public
|
|
6242
|
+
*/
|
|
6243
|
+
action: GuardrailSensitiveInformationAction | undefined;
|
|
6244
|
+
/**
|
|
6245
|
+
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6246
|
+
* @public
|
|
6247
|
+
*/
|
|
6248
|
+
inputAction?: GuardrailSensitiveInformationAction | undefined;
|
|
6249
|
+
/**
|
|
6250
|
+
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6251
|
+
* @public
|
|
6252
|
+
*/
|
|
6253
|
+
outputAction?: GuardrailSensitiveInformationAction | undefined;
|
|
6254
|
+
/**
|
|
6255
|
+
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6256
|
+
* @public
|
|
6257
|
+
*/
|
|
6258
|
+
inputEnabled?: boolean | undefined;
|
|
6259
|
+
/**
|
|
6260
|
+
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6261
|
+
* @public
|
|
6262
|
+
*/
|
|
6263
|
+
outputEnabled?: boolean | undefined;
|
|
6264
|
+
}
|
|
6265
|
+
/**
|
|
6266
|
+
* <p>Contains details about PII entities and regular expressions configured for the guardrail.</p>
|
|
6267
|
+
* @public
|
|
6268
|
+
*/
|
|
6269
|
+
export interface GuardrailSensitiveInformationPolicy {
|
|
6270
|
+
/**
|
|
6271
|
+
* <p>The list of PII entities configured for the guardrail.</p>
|
|
6272
|
+
* @public
|
|
6273
|
+
*/
|
|
6274
|
+
piiEntities?: GuardrailPiiEntity[] | undefined;
|
|
6275
|
+
/**
|
|
6276
|
+
* <p>The list of regular expressions configured for the guardrail.</p>
|
|
6277
|
+
* @public
|
|
6278
|
+
*/
|
|
6279
|
+
regexes?: GuardrailRegex[] | undefined;
|
|
6280
|
+
}
|
|
6281
|
+
/**
|
|
6282
|
+
* <p>The tier that your guardrail uses for denied topic filters.</p>
|
|
6283
|
+
* @public
|
|
6284
|
+
*/
|
|
6285
|
+
export interface GuardrailTopicsTier {
|
|
6286
|
+
/**
|
|
6287
|
+
* <p>The tier that your guardrail uses for denied topic filters. Valid values include:</p> <ul> <li> <p> <code>CLASSIC</code> tier – Provides established guardrails functionality supporting English, French, and Spanish languages.</p> </li> <li> <p> <code>STANDARD</code> tier – Provides a more robust solution than the <code>CLASSIC</code> tier and has more comprehensive language support. This tier requires that your guardrail use <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">cross-Region inference</a>.</p> </li> </ul>
|
|
6288
|
+
* @public
|
|
6289
|
+
*/
|
|
6290
|
+
tierName: GuardrailTopicsTierName | undefined;
|
|
6291
|
+
}
|
|
6292
|
+
/**
|
|
6293
|
+
* <p>Details about topics for the guardrail to identify and deny.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
|
|
6294
|
+
* @public
|
|
6295
|
+
*/
|
|
6296
|
+
export interface GuardrailTopic {
|
|
6297
|
+
/**
|
|
6298
|
+
* <p>The name of the topic to deny.</p>
|
|
6299
|
+
* @public
|
|
6300
|
+
*/
|
|
6301
|
+
name: string | undefined;
|
|
6302
|
+
/**
|
|
6303
|
+
* <p>A definition of the topic to deny.</p>
|
|
6304
|
+
* @public
|
|
6305
|
+
*/
|
|
6306
|
+
definition: string | undefined;
|
|
6307
|
+
/**
|
|
6308
|
+
* <p>A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.</p>
|
|
6309
|
+
* @public
|
|
6310
|
+
*/
|
|
6311
|
+
examples?: string[] | undefined;
|
|
6312
|
+
/**
|
|
6313
|
+
* <p>Specifies to deny the topic.</p>
|
|
6314
|
+
* @public
|
|
6315
|
+
*/
|
|
6316
|
+
type?: GuardrailTopicType | undefined;
|
|
6317
|
+
/**
|
|
6318
|
+
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6319
|
+
* @public
|
|
6320
|
+
*/
|
|
6321
|
+
inputAction?: GuardrailTopicAction | undefined;
|
|
6322
|
+
/**
|
|
6323
|
+
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6324
|
+
* @public
|
|
6325
|
+
*/
|
|
6326
|
+
outputAction?: GuardrailTopicAction | undefined;
|
|
6327
|
+
/**
|
|
6328
|
+
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6329
|
+
* @public
|
|
6330
|
+
*/
|
|
6331
|
+
inputEnabled?: boolean | undefined;
|
|
6332
|
+
/**
|
|
6333
|
+
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6334
|
+
* @public
|
|
6335
|
+
*/
|
|
6336
|
+
outputEnabled?: boolean | undefined;
|
|
6337
|
+
}
|
|
6338
|
+
/**
|
|
6339
|
+
* <p>Contains details about topics that the guardrail should identify and deny.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
|
|
6340
|
+
* @public
|
|
6341
|
+
*/
|
|
6342
|
+
export interface GuardrailTopicPolicy {
|
|
6343
|
+
/**
|
|
6344
|
+
* <p>A list of policies related to topics that the guardrail should deny.</p>
|
|
6345
|
+
* @public
|
|
6346
|
+
*/
|
|
6347
|
+
topics: GuardrailTopic[] | undefined;
|
|
6348
|
+
/**
|
|
6349
|
+
* <p>The tier that your guardrail uses for denied topic filters.</p>
|
|
6350
|
+
* @public
|
|
6351
|
+
*/
|
|
6352
|
+
tier?: GuardrailTopicsTier | undefined;
|
|
6353
|
+
}
|
|
6354
|
+
/**
|
|
6355
|
+
* <p>The managed word list that was configured for the guardrail. (This is a list of words that are pre-defined and managed by guardrails only.)</p>
|
|
6356
|
+
* @public
|
|
6357
|
+
*/
|
|
6358
|
+
export interface GuardrailManagedWords {
|
|
6359
|
+
/**
|
|
6360
|
+
* <p>ManagedWords$type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)</p>
|
|
6361
|
+
* @public
|
|
6362
|
+
*/
|
|
6363
|
+
type: GuardrailManagedWordsType | undefined;
|
|
6364
|
+
/**
|
|
6365
|
+
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6366
|
+
* @public
|
|
6367
|
+
*/
|
|
6368
|
+
inputAction?: GuardrailWordAction | undefined;
|
|
6369
|
+
/**
|
|
6370
|
+
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6371
|
+
* @public
|
|
6372
|
+
*/
|
|
6373
|
+
outputAction?: GuardrailWordAction | undefined;
|
|
6374
|
+
/**
|
|
6375
|
+
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6376
|
+
* @public
|
|
6377
|
+
*/
|
|
6378
|
+
inputEnabled?: boolean | undefined;
|
|
6379
|
+
/**
|
|
6380
|
+
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6381
|
+
* @public
|
|
6382
|
+
*/
|
|
6383
|
+
outputEnabled?: boolean | undefined;
|
|
6384
|
+
}
|
|
6385
|
+
/**
|
|
6386
|
+
* <p>A word configured for the guardrail.</p>
|
|
6387
|
+
* @public
|
|
6388
|
+
*/
|
|
6389
|
+
export interface GuardrailWord {
|
|
6390
|
+
/**
|
|
6391
|
+
* <p>Text of the word configured for the guardrail to block.</p>
|
|
6392
|
+
* @public
|
|
6393
|
+
*/
|
|
6394
|
+
text: string | undefined;
|
|
6395
|
+
/**
|
|
6396
|
+
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6397
|
+
* @public
|
|
6398
|
+
*/
|
|
6399
|
+
inputAction?: GuardrailWordAction | undefined;
|
|
6400
|
+
/**
|
|
6401
|
+
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
6402
|
+
* @public
|
|
6403
|
+
*/
|
|
6404
|
+
outputAction?: GuardrailWordAction | undefined;
|
|
6405
|
+
/**
|
|
6406
|
+
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6407
|
+
* @public
|
|
6408
|
+
*/
|
|
6409
|
+
inputEnabled?: boolean | undefined;
|
|
6410
|
+
/**
|
|
6411
|
+
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
6412
|
+
* @public
|
|
6413
|
+
*/
|
|
6414
|
+
outputEnabled?: boolean | undefined;
|
|
6415
|
+
}
|
|
6416
|
+
/**
|
|
6417
|
+
* <p>Contains details about the word policy configured for the guardrail.</p>
|
|
6418
|
+
* @public
|
|
6419
|
+
*/
|
|
6420
|
+
export interface GuardrailWordPolicy {
|
|
6421
|
+
/**
|
|
6422
|
+
* <p>A list of words configured for the guardrail.</p>
|
|
6423
|
+
* @public
|
|
6424
|
+
*/
|
|
6425
|
+
words?: GuardrailWord[] | undefined;
|
|
6426
|
+
/**
|
|
6427
|
+
* <p>A list of managed words configured for the guardrail.</p>
|
|
6428
|
+
* @public
|
|
6429
|
+
*/
|
|
6430
|
+
managedWordLists?: GuardrailManagedWords[] | undefined;
|
|
6431
|
+
}
|
|
6432
|
+
/**
|
|
6433
|
+
* @public
|
|
6434
|
+
*/
|
|
6435
|
+
export interface GetGuardrailResponse {
|
|
6436
|
+
/**
|
|
6437
|
+
* <p>The name of the guardrail.</p>
|
|
6438
|
+
* @public
|
|
6439
|
+
*/
|
|
6440
|
+
name: string | undefined;
|
|
6441
|
+
/**
|
|
6442
|
+
* <p>The description of the guardrail.</p>
|
|
6443
|
+
* @public
|
|
6444
|
+
*/
|
|
6445
|
+
description?: string | undefined;
|
|
6446
|
+
/**
|
|
6447
|
+
* <p>The unique identifier of the guardrail.</p>
|
|
6448
|
+
* @public
|
|
6449
|
+
*/
|
|
6450
|
+
guardrailId: string | undefined;
|
|
6451
|
+
/**
|
|
6452
|
+
* <p>The ARN of the guardrail.</p>
|
|
6453
|
+
* @public
|
|
6454
|
+
*/
|
|
6455
|
+
guardrailArn: string | undefined;
|
|
6456
|
+
/**
|
|
6457
|
+
* <p>The version of the guardrail.</p>
|
|
6458
|
+
* @public
|
|
6459
|
+
*/
|
|
6460
|
+
version: string | undefined;
|
|
6461
|
+
/**
|
|
6462
|
+
* <p>The status of the guardrail.</p>
|
|
6463
|
+
* @public
|
|
6464
|
+
*/
|
|
6465
|
+
status: GuardrailStatus | undefined;
|
|
6466
|
+
/**
|
|
6467
|
+
* <p>The topic policy that was configured for the guardrail.</p>
|
|
6468
|
+
* @public
|
|
6469
|
+
*/
|
|
6470
|
+
topicPolicy?: GuardrailTopicPolicy | undefined;
|
|
6471
|
+
/**
|
|
6472
|
+
* <p>The content policy that was configured for the guardrail.</p>
|
|
6473
|
+
* @public
|
|
6474
|
+
*/
|
|
6475
|
+
contentPolicy?: GuardrailContentPolicy | undefined;
|
|
6476
|
+
/**
|
|
6477
|
+
* <p>The word policy that was configured for the guardrail.</p>
|
|
6478
|
+
* @public
|
|
6479
|
+
*/
|
|
6480
|
+
wordPolicy?: GuardrailWordPolicy | undefined;
|
|
6481
|
+
/**
|
|
6482
|
+
* <p>The sensitive information policy that was configured for the guardrail.</p>
|
|
6483
|
+
* @public
|
|
6484
|
+
*/
|
|
6485
|
+
sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicy | undefined;
|
|
6486
|
+
/**
|
|
6487
|
+
* <p>The contextual grounding policy used in the guardrail.</p>
|
|
6488
|
+
* @public
|
|
6489
|
+
*/
|
|
6490
|
+
contextualGroundingPolicy?: GuardrailContextualGroundingPolicy | undefined;
|
|
6491
|
+
/**
|
|
6492
|
+
* <p>The current Automated Reasoning policy configuration for the guardrail, if any is configured.</p>
|
|
6493
|
+
* @public
|
|
6494
|
+
*/
|
|
6495
|
+
automatedReasoningPolicy?: GuardrailAutomatedReasoningPolicy | undefined;
|
|
6496
|
+
/**
|
|
6497
|
+
* <p>Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).</p>
|
|
6498
|
+
* @public
|
|
6499
|
+
*/
|
|
6500
|
+
crossRegionDetails?: GuardrailCrossRegionDetails | undefined;
|
|
6501
|
+
/**
|
|
6502
|
+
* <p>The date and time at which the guardrail was created.</p>
|
|
6503
|
+
* @public
|
|
6504
|
+
*/
|
|
6505
|
+
createdAt: Date | undefined;
|
|
6506
|
+
/**
|
|
6507
|
+
* <p>The date and time at which the guardrail was updated.</p>
|
|
6508
|
+
* @public
|
|
6509
|
+
*/
|
|
6510
|
+
updatedAt: Date | undefined;
|
|
6511
|
+
/**
|
|
6512
|
+
* <p>Appears if the <code>status</code> is <code>FAILED</code>. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.</p>
|
|
6513
|
+
* @public
|
|
6514
|
+
*/
|
|
6515
|
+
statusReasons?: string[] | undefined;
|
|
6516
|
+
/**
|
|
6517
|
+
* <p>Appears if the <code>status</code> of the guardrail is <code>FAILED</code>. A list of recommendations to carry out before retrying the request.</p>
|
|
6518
|
+
* @public
|
|
6519
|
+
*/
|
|
6520
|
+
failureRecommendations?: string[] | undefined;
|
|
6521
|
+
/**
|
|
6522
|
+
* <p>The message that the guardrail returns when it blocks a prompt.</p>
|
|
6523
|
+
* @public
|
|
6524
|
+
*/
|
|
6525
|
+
blockedInputMessaging: string | undefined;
|
|
6526
|
+
/**
|
|
6527
|
+
* <p>The message that the guardrail returns when it blocks a model response.</p>
|
|
6528
|
+
* @public
|
|
6529
|
+
*/
|
|
6530
|
+
blockedOutputsMessaging: string | undefined;
|
|
6531
|
+
/**
|
|
6532
|
+
* <p>The ARN of the KMS key that encrypts the guardrail.</p>
|
|
6533
|
+
* @public
|
|
6534
|
+
*/
|
|
6535
|
+
kmsKeyArn?: string | undefined;
|
|
6536
|
+
}
|
|
6537
|
+
/**
|
|
6538
|
+
* @public
|
|
6539
|
+
*/
|
|
6540
|
+
export interface ListGuardrailsRequest {
|
|
6541
|
+
/**
|
|
6542
|
+
* <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
|
|
6543
|
+
* @public
|
|
6544
|
+
*/
|
|
6545
|
+
guardrailIdentifier?: string | undefined;
|
|
6546
|
+
/**
|
|
6547
|
+
* <p>The maximum number of results to return in the response.</p>
|
|
6548
|
+
* @public
|
|
6549
|
+
*/
|
|
6550
|
+
maxResults?: number | undefined;
|
|
6551
|
+
/**
|
|
6552
|
+
* <p>If there are more results than were returned in the response, the response returns a <code>nextToken</code> that you can send in another <code>ListGuardrails</code> request to see the next batch of results.</p>
|
|
6553
|
+
* @public
|
|
6554
|
+
*/
|
|
6555
|
+
nextToken?: string | undefined;
|
|
6556
|
+
}
|
|
6557
|
+
/**
|
|
6558
|
+
* <p>Contains details about a guardrail.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListGuardrails.html#API_ListGuardrails_ResponseSyntax">ListGuardrails response body</a> </p> </li> </ul>
|
|
6559
|
+
* @public
|
|
6560
|
+
*/
|
|
6561
|
+
export interface GuardrailSummary {
|
|
6562
|
+
/**
|
|
6563
|
+
* <p>The unique identifier of the guardrail.</p>
|
|
6564
|
+
* @public
|
|
6565
|
+
*/
|
|
6566
|
+
id: string | undefined;
|
|
6567
|
+
/**
|
|
6568
|
+
* <p>The ARN of the guardrail.</p>
|
|
6569
|
+
* @public
|
|
6570
|
+
*/
|
|
6571
|
+
arn: string | undefined;
|
|
6572
|
+
/**
|
|
6573
|
+
* <p>The status of the guardrail.</p>
|
|
6574
|
+
* @public
|
|
6575
|
+
*/
|
|
6576
|
+
status: GuardrailStatus | undefined;
|
|
6577
|
+
/**
|
|
6578
|
+
* <p>The name of the guardrail.</p>
|
|
6579
|
+
* @public
|
|
6580
|
+
*/
|
|
6581
|
+
name: string | undefined;
|
|
6582
|
+
/**
|
|
6583
|
+
* <p>A description of the guardrail.</p>
|
|
6584
|
+
* @public
|
|
6585
|
+
*/
|
|
6586
|
+
description?: string | undefined;
|
|
6587
|
+
/**
|
|
6588
|
+
* <p>The version of the guardrail.</p>
|
|
6589
|
+
* @public
|
|
6590
|
+
*/
|
|
6591
|
+
version: string | undefined;
|
|
6592
|
+
/**
|
|
6593
|
+
* <p>The date and time at which the guardrail was created.</p>
|
|
6594
|
+
* @public
|
|
6595
|
+
*/
|
|
6596
|
+
createdAt: Date | undefined;
|
|
6597
|
+
/**
|
|
6598
|
+
* <p>The date and time at which the guardrail was last updated.</p>
|
|
6599
|
+
* @public
|
|
6600
|
+
*/
|
|
6601
|
+
updatedAt: Date | undefined;
|
|
6602
|
+
/**
|
|
6603
|
+
* <p>Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).</p>
|
|
6604
|
+
* @public
|
|
6605
|
+
*/
|
|
6606
|
+
crossRegionDetails?: GuardrailCrossRegionDetails | undefined;
|
|
6607
|
+
}
|
|
6608
|
+
/**
|
|
6609
|
+
* @public
|
|
6610
|
+
*/
|
|
6611
|
+
export interface ListGuardrailsResponse {
|
|
6612
|
+
/**
|
|
6613
|
+
* <p>A list of objects, each of which contains details about a guardrail.</p>
|
|
6614
|
+
* @public
|
|
6615
|
+
*/
|
|
6616
|
+
guardrails: GuardrailSummary[] | undefined;
|
|
6617
|
+
/**
|
|
6618
|
+
* <p>If there are more results than were returned in the response, the response returns a <code>nextToken</code> that you can send in another <code>ListGuardrails</code> request to see the next batch of results.</p>
|
|
6619
|
+
* @public
|
|
6620
|
+
*/
|
|
6621
|
+
nextToken?: string | undefined;
|
|
6622
|
+
}
|
|
6623
|
+
/**
|
|
6624
|
+
* @public
|
|
6625
|
+
*/
|
|
6626
|
+
export interface UpdateGuardrailRequest {
|
|
6627
|
+
/**
|
|
6628
|
+
* <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
|
|
6629
|
+
* @public
|
|
6630
|
+
*/
|
|
6631
|
+
guardrailIdentifier: string | undefined;
|
|
6632
|
+
/**
|
|
6633
|
+
* <p>A name for the guardrail.</p>
|
|
6634
|
+
* @public
|
|
6635
|
+
*/
|
|
6636
|
+
name: string | undefined;
|
|
6637
|
+
/**
|
|
6638
|
+
* <p>A description of the guardrail.</p>
|
|
6639
|
+
* @public
|
|
6640
|
+
*/
|
|
6641
|
+
description?: string | undefined;
|
|
6642
|
+
/**
|
|
6643
|
+
* <p>The topic policy to configure for the guardrail.</p>
|
|
6644
|
+
* @public
|
|
6645
|
+
*/
|
|
6646
|
+
topicPolicyConfig?: GuardrailTopicPolicyConfig | undefined;
|
|
6647
|
+
/**
|
|
6648
|
+
* <p>The content policy to configure for the guardrail.</p>
|
|
6649
|
+
* @public
|
|
6650
|
+
*/
|
|
6651
|
+
contentPolicyConfig?: GuardrailContentPolicyConfig | undefined;
|
|
6652
|
+
/**
|
|
6653
|
+
* <p>The word policy to configure for the guardrail.</p>
|
|
6654
|
+
* @public
|
|
6655
|
+
*/
|
|
6656
|
+
wordPolicyConfig?: GuardrailWordPolicyConfig | undefined;
|
|
6657
|
+
/**
|
|
6658
|
+
* <p>The sensitive information policy to configure for the guardrail.</p>
|
|
6659
|
+
* @public
|
|
6660
|
+
*/
|
|
6661
|
+
sensitiveInformationPolicyConfig?: GuardrailSensitiveInformationPolicyConfig | undefined;
|
|
6662
|
+
/**
|
|
6663
|
+
* <p>The contextual grounding policy configuration used to update a guardrail.</p>
|
|
6664
|
+
* @public
|
|
6665
|
+
*/
|
|
6666
|
+
contextualGroundingPolicyConfig?: GuardrailContextualGroundingPolicyConfig | undefined;
|
|
6667
|
+
/**
|
|
6668
|
+
* <p>Updated configuration for Automated Reasoning policies associated with the guardrail.</p>
|
|
6669
|
+
* @public
|
|
6670
|
+
*/
|
|
6671
|
+
automatedReasoningPolicyConfig?: GuardrailAutomatedReasoningPolicyConfig | undefined;
|
|
6672
|
+
/**
|
|
6673
|
+
* <p>The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">Amazon Bedrock User Guide</a>.</p>
|
|
6674
|
+
* @public
|
|
6675
|
+
*/
|
|
6676
|
+
crossRegionConfig?: GuardrailCrossRegionConfig | undefined;
|
|
6677
|
+
/**
|
|
6678
|
+
* <p>The message to return when the guardrail blocks a prompt.</p>
|
|
6679
|
+
* @public
|
|
6680
|
+
*/
|
|
6681
|
+
blockedInputMessaging: string | undefined;
|
|
6682
|
+
/**
|
|
6683
|
+
* <p>The message to return when the guardrail blocks a model response.</p>
|
|
6684
|
+
* @public
|
|
6685
|
+
*/
|
|
6686
|
+
blockedOutputsMessaging: string | undefined;
|
|
6687
|
+
/**
|
|
6688
|
+
* <p>The ARN of the KMS key with which to encrypt the guardrail.</p>
|
|
6689
|
+
* @public
|
|
6690
|
+
*/
|
|
6691
|
+
kmsKeyId?: string | undefined;
|
|
6692
|
+
}
|
|
6693
|
+
/**
|
|
6694
|
+
* @public
|
|
6695
|
+
*/
|
|
6696
|
+
export interface UpdateGuardrailResponse {
|
|
6697
|
+
/**
|
|
6698
|
+
* <p>The unique identifier of the guardrail</p>
|
|
6699
|
+
* @public
|
|
6700
|
+
*/
|
|
6701
|
+
guardrailId: string | undefined;
|
|
6702
|
+
/**
|
|
6703
|
+
* <p>The ARN of the guardrail.</p>
|
|
6704
|
+
* @public
|
|
6705
|
+
*/
|
|
6706
|
+
guardrailArn: string | undefined;
|
|
6707
|
+
/**
|
|
6708
|
+
* <p>The version of the guardrail.</p>
|
|
6709
|
+
* @public
|
|
6710
|
+
*/
|
|
6711
|
+
version: string | undefined;
|
|
6712
|
+
/**
|
|
6713
|
+
* <p>The date and time at which the guardrail was updated.</p>
|
|
6714
|
+
* @public
|
|
6715
|
+
*/
|
|
6716
|
+
updatedAt: Date | undefined;
|
|
6717
|
+
}
|
|
6718
|
+
/**
|
|
6719
|
+
* <p>Contains information about the model or system-defined inference profile that is the source for an inference profile..</p>
|
|
6720
|
+
* @public
|
|
6721
|
+
*/
|
|
6722
|
+
export type InferenceProfileModelSource = InferenceProfileModelSource.CopyFromMember | InferenceProfileModelSource.$UnknownMember;
|
|
6723
|
+
/**
|
|
6724
|
+
* @public
|
|
6725
|
+
*/
|
|
6726
|
+
export declare namespace InferenceProfileModelSource {
|
|
6727
|
+
/**
|
|
6728
|
+
* <p>The ARN of the model or system-defined inference profile that is the source for the inference profile.</p>
|
|
6729
|
+
* @public
|
|
6730
|
+
*/
|
|
6731
|
+
interface CopyFromMember {
|
|
6732
|
+
copyFrom: string;
|
|
6733
|
+
$unknown?: never;
|
|
6734
|
+
}
|
|
6735
|
+
/**
|
|
6736
|
+
* @public
|
|
6737
|
+
*/
|
|
6738
|
+
interface $UnknownMember {
|
|
6739
|
+
copyFrom?: never;
|
|
6740
|
+
$unknown: [string, any];
|
|
6741
|
+
}
|
|
6742
|
+
/**
|
|
6743
|
+
* @deprecated unused in schema-serde mode.
|
|
6744
|
+
*
|
|
6745
|
+
*/
|
|
6746
|
+
interface Visitor<T> {
|
|
6747
|
+
copyFrom: (value: string) => T;
|
|
6748
|
+
_: (name: string, value: any) => T;
|
|
6749
|
+
}
|
|
6750
|
+
}
|
|
6751
|
+
/**
|
|
6752
|
+
* @public
|
|
6753
|
+
*/
|
|
6754
|
+
export interface CreateInferenceProfileRequest {
|
|
6755
|
+
/**
|
|
6756
|
+
* <p>A name for the inference profile.</p>
|
|
6757
|
+
* @public
|
|
6758
|
+
*/
|
|
6759
|
+
inferenceProfileName: string | undefined;
|
|
6760
|
+
/**
|
|
6761
|
+
* <p>A description for the inference profile.</p>
|
|
6762
|
+
* @public
|
|
6763
|
+
*/
|
|
6764
|
+
description?: string | undefined;
|
|
6765
|
+
/**
|
|
6766
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
6767
|
+
* @public
|
|
6768
|
+
*/
|
|
6769
|
+
clientRequestToken?: string | undefined;
|
|
6770
|
+
/**
|
|
6771
|
+
* <p>The foundation model or system-defined inference profile that the inference profile will track metrics and costs for.</p>
|
|
6772
|
+
* @public
|
|
6773
|
+
*/
|
|
6774
|
+
modelSource: InferenceProfileModelSource | undefined;
|
|
6775
|
+
/**
|
|
6776
|
+
* <p>An array of objects, each of which contains a tag and its value. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Tagging resources</a> in the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Amazon Bedrock User Guide</a>.</p>
|
|
6777
|
+
* @public
|
|
6778
|
+
*/
|
|
6779
|
+
tags?: Tag[] | undefined;
|
|
6780
|
+
}
|
|
6781
|
+
/**
|
|
6782
|
+
* @public
|
|
6783
|
+
*/
|
|
6784
|
+
export interface CreateInferenceProfileResponse {
|
|
6785
|
+
/**
|
|
6786
|
+
* <p>The ARN of the inference profile that you created.</p>
|
|
6787
|
+
* @public
|
|
6788
|
+
*/
|
|
6789
|
+
inferenceProfileArn: string | undefined;
|
|
6790
|
+
/**
|
|
6791
|
+
* <p>The status of the inference profile. <code>ACTIVE</code> means that the inference profile is ready to be used.</p>
|
|
6792
|
+
* @public
|
|
6793
|
+
*/
|
|
6794
|
+
status?: InferenceProfileStatus | undefined;
|
|
6795
|
+
}
|
|
6796
|
+
/**
|
|
6797
|
+
* @public
|
|
6798
|
+
*/
|
|
6799
|
+
export interface DeleteInferenceProfileRequest {
|
|
6800
|
+
/**
|
|
6801
|
+
* <p>The Amazon Resource Name (ARN) or ID of the application inference profile to delete.</p>
|
|
6802
|
+
* @public
|
|
6803
|
+
*/
|
|
6804
|
+
inferenceProfileIdentifier: string | undefined;
|
|
6805
|
+
}
|
|
6806
|
+
/**
|
|
6807
|
+
* @public
|
|
6808
|
+
*/
|
|
6809
|
+
export interface DeleteInferenceProfileResponse {
|
|
6810
|
+
}
|
|
6811
|
+
/**
|
|
6812
|
+
* @public
|
|
6813
|
+
*/
|
|
6814
|
+
export interface GetInferenceProfileRequest {
|
|
6815
|
+
/**
|
|
6816
|
+
* <p>The ID or Amazon Resource Name (ARN) of the inference profile.</p>
|
|
6817
|
+
* @public
|
|
6818
|
+
*/
|
|
6819
|
+
inferenceProfileIdentifier: string | undefined;
|
|
6820
|
+
}
|
|
6821
|
+
/**
|
|
6822
|
+
* <p>Contains information about a model.</p>
|
|
6823
|
+
* @public
|
|
6824
|
+
*/
|
|
6825
|
+
export interface InferenceProfileModel {
|
|
6826
|
+
/**
|
|
6827
|
+
* <p>The Amazon Resource Name (ARN) of the model.</p>
|
|
6828
|
+
* @public
|
|
6829
|
+
*/
|
|
6830
|
+
modelArn?: string | undefined;
|
|
6831
|
+
}
|
|
6832
|
+
/**
|
|
6833
|
+
* @public
|
|
6834
|
+
*/
|
|
6835
|
+
export interface GetInferenceProfileResponse {
|
|
6836
|
+
/**
|
|
6837
|
+
* <p>The name of the inference profile.</p>
|
|
6838
|
+
* @public
|
|
6839
|
+
*/
|
|
6840
|
+
inferenceProfileName: string | undefined;
|
|
6841
|
+
/**
|
|
6842
|
+
* <p>The description of the inference profile.</p>
|
|
6843
|
+
* @public
|
|
6844
|
+
*/
|
|
6845
|
+
description?: string | undefined;
|
|
6846
|
+
/**
|
|
6847
|
+
* <p>The time at which the inference profile was created.</p>
|
|
6848
|
+
* @public
|
|
6849
|
+
*/
|
|
6850
|
+
createdAt?: Date | undefined;
|
|
6851
|
+
/**
|
|
6852
|
+
* <p>The time at which the inference profile was last updated.</p>
|
|
6853
|
+
* @public
|
|
6854
|
+
*/
|
|
6855
|
+
updatedAt?: Date | undefined;
|
|
6856
|
+
/**
|
|
6857
|
+
* <p>The Amazon Resource Name (ARN) of the inference profile.</p>
|
|
6858
|
+
* @public
|
|
6859
|
+
*/
|
|
6860
|
+
inferenceProfileArn: string | undefined;
|
|
6861
|
+
/**
|
|
6862
|
+
* <p>A list of information about each model in the inference profile.</p>
|
|
6863
|
+
* @public
|
|
6864
|
+
*/
|
|
6865
|
+
models: InferenceProfileModel[] | undefined;
|
|
6866
|
+
/**
|
|
6867
|
+
* <p>The unique identifier of the inference profile.</p>
|
|
6868
|
+
* @public
|
|
6869
|
+
*/
|
|
6870
|
+
inferenceProfileId: string | undefined;
|
|
6871
|
+
/**
|
|
6872
|
+
* <p>The status of the inference profile. <code>ACTIVE</code> means that the inference profile is ready to be used.</p>
|
|
6873
|
+
* @public
|
|
6874
|
+
*/
|
|
6875
|
+
status: InferenceProfileStatus | undefined;
|
|
6876
|
+
/**
|
|
6877
|
+
* <p>The type of the inference profile. The following types are possible:</p> <ul> <li> <p> <code>SYSTEM_DEFINED</code> – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.</p> </li> <li> <p> <code>APPLICATION</code> – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.</p> </li> </ul>
|
|
6878
|
+
* @public
|
|
6879
|
+
*/
|
|
6880
|
+
type: InferenceProfileType | undefined;
|
|
6881
|
+
}
|
|
6882
|
+
/**
|
|
6883
|
+
* @public
|
|
6884
|
+
*/
|
|
6885
|
+
export interface ListInferenceProfilesRequest {
|
|
6886
|
+
/**
|
|
6887
|
+
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
6888
|
+
* @public
|
|
6889
|
+
*/
|
|
6890
|
+
maxResults?: number | undefined;
|
|
6891
|
+
/**
|
|
6892
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
6893
|
+
* @public
|
|
6894
|
+
*/
|
|
6895
|
+
nextToken?: string | undefined;
|
|
6896
|
+
/**
|
|
6897
|
+
* <p>Filters for inference profiles that match the type you specify.</p> <ul> <li> <p> <code>SYSTEM_DEFINED</code> – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.</p> </li> <li> <p> <code>APPLICATION</code> – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.</p> </li> </ul>
|
|
6898
|
+
* @public
|
|
6899
|
+
*/
|
|
6900
|
+
typeEquals?: InferenceProfileType | undefined;
|
|
6901
|
+
}
|
|
6902
|
+
/**
|
|
6903
|
+
* <p>Contains information about an inference profile.</p>
|
|
6904
|
+
* @public
|
|
6905
|
+
*/
|
|
6906
|
+
export interface InferenceProfileSummary {
|
|
6907
|
+
/**
|
|
6908
|
+
* <p>The name of the inference profile.</p>
|
|
6909
|
+
* @public
|
|
6910
|
+
*/
|
|
6911
|
+
inferenceProfileName: string | undefined;
|
|
6912
|
+
/**
|
|
6913
|
+
* <p>The description of the inference profile.</p>
|
|
6914
|
+
* @public
|
|
6915
|
+
*/
|
|
6916
|
+
description?: string | undefined;
|
|
6917
|
+
/**
|
|
6918
|
+
* <p>The time at which the inference profile was created.</p>
|
|
6919
|
+
* @public
|
|
6920
|
+
*/
|
|
6921
|
+
createdAt?: Date | undefined;
|
|
6922
|
+
/**
|
|
6923
|
+
* <p>The time at which the inference profile was last updated.</p>
|
|
6924
|
+
* @public
|
|
6925
|
+
*/
|
|
6926
|
+
updatedAt?: Date | undefined;
|
|
6927
|
+
/**
|
|
6928
|
+
* <p>The Amazon Resource Name (ARN) of the inference profile.</p>
|
|
6929
|
+
* @public
|
|
6930
|
+
*/
|
|
6931
|
+
inferenceProfileArn: string | undefined;
|
|
6932
|
+
/**
|
|
6933
|
+
* <p>A list of information about each model in the inference profile.</p>
|
|
6934
|
+
* @public
|
|
6935
|
+
*/
|
|
6936
|
+
models: InferenceProfileModel[] | undefined;
|
|
6937
|
+
/**
|
|
6938
|
+
* <p>The unique identifier of the inference profile.</p>
|
|
6939
|
+
* @public
|
|
6940
|
+
*/
|
|
6941
|
+
inferenceProfileId: string | undefined;
|
|
6942
|
+
/**
|
|
6943
|
+
* <p>The status of the inference profile. <code>ACTIVE</code> means that the inference profile is ready to be used.</p>
|
|
6944
|
+
* @public
|
|
6945
|
+
*/
|
|
6946
|
+
status: InferenceProfileStatus | undefined;
|
|
6947
|
+
/**
|
|
6948
|
+
* <p>The type of the inference profile. The following types are possible:</p> <ul> <li> <p> <code>SYSTEM_DEFINED</code> – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.</p> </li> <li> <p> <code>APPLICATION</code> – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.</p> </li> </ul>
|
|
6949
|
+
* @public
|
|
6950
|
+
*/
|
|
6951
|
+
type: InferenceProfileType | undefined;
|
|
6952
|
+
}
|
|
6953
|
+
/**
|
|
6954
|
+
* @public
|
|
6955
|
+
*/
|
|
6956
|
+
export interface ListInferenceProfilesResponse {
|
|
6957
|
+
/**
|
|
6958
|
+
* <p>A list of information about each inference profile that you can use.</p>
|
|
6959
|
+
* @public
|
|
6960
|
+
*/
|
|
6961
|
+
inferenceProfileSummaries?: InferenceProfileSummary[] | undefined;
|
|
6962
|
+
/**
|
|
6963
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
6964
|
+
* @public
|
|
6965
|
+
*/
|
|
6966
|
+
nextToken?: string | undefined;
|
|
6967
|
+
}
|
|
6968
|
+
/**
|
|
6969
|
+
* @public
|
|
6970
|
+
*/
|
|
6971
|
+
export interface DeleteModelInvocationLoggingConfigurationRequest {
|
|
6972
|
+
}
|
|
6973
|
+
/**
|
|
6974
|
+
* @public
|
|
6975
|
+
*/
|
|
6976
|
+
export interface DeleteModelInvocationLoggingConfigurationResponse {
|
|
6977
|
+
}
|
|
6978
|
+
/**
|
|
6979
|
+
* @public
|
|
6980
|
+
*/
|
|
6981
|
+
export interface GetModelInvocationLoggingConfigurationRequest {
|
|
6982
|
+
}
|
|
6983
|
+
/**
|
|
6984
|
+
* <p>S3 configuration for storing log data.</p>
|
|
6985
|
+
* @public
|
|
6986
|
+
*/
|
|
6987
|
+
export interface S3Config {
|
|
6988
|
+
/**
|
|
6989
|
+
* <p>S3 bucket name.</p>
|
|
6990
|
+
* @public
|
|
6991
|
+
*/
|
|
6992
|
+
bucketName: string | undefined;
|
|
6993
|
+
/**
|
|
6994
|
+
* <p>S3 prefix. </p>
|
|
6995
|
+
* @public
|
|
6996
|
+
*/
|
|
6997
|
+
keyPrefix?: string | undefined;
|
|
6998
|
+
}
|
|
6999
|
+
/**
|
|
7000
|
+
* <p>CloudWatch logging configuration.</p>
|
|
7001
|
+
* @public
|
|
7002
|
+
*/
|
|
7003
|
+
export interface CloudWatchConfig {
|
|
7004
|
+
/**
|
|
7005
|
+
* <p>The log group name.</p>
|
|
7006
|
+
* @public
|
|
7007
|
+
*/
|
|
7008
|
+
logGroupName: string | undefined;
|
|
7009
|
+
/**
|
|
7010
|
+
* <p>The role Amazon Resource Name (ARN).</p>
|
|
7011
|
+
* @public
|
|
7012
|
+
*/
|
|
7013
|
+
roleArn: string | undefined;
|
|
7014
|
+
/**
|
|
7015
|
+
* <p>S3 configuration for delivering a large amount of data.</p>
|
|
7016
|
+
* @public
|
|
7017
|
+
*/
|
|
7018
|
+
largeDataDeliveryS3Config?: S3Config | undefined;
|
|
7019
|
+
}
|
|
7020
|
+
/**
|
|
7021
|
+
* <p>Configuration fields for invocation logging.</p>
|
|
7022
|
+
* @public
|
|
7023
|
+
*/
|
|
7024
|
+
export interface LoggingConfig {
|
|
7025
|
+
/**
|
|
7026
|
+
* <p>CloudWatch logging configuration.</p>
|
|
7027
|
+
* @public
|
|
7028
|
+
*/
|
|
7029
|
+
cloudWatchConfig?: CloudWatchConfig | undefined;
|
|
7030
|
+
/**
|
|
7031
|
+
* <p>S3 configuration for storing log data.</p>
|
|
7032
|
+
* @public
|
|
7033
|
+
*/
|
|
7034
|
+
s3Config?: S3Config | undefined;
|
|
7035
|
+
/**
|
|
7036
|
+
* <p>Set to include text data in the log delivery.</p>
|
|
7037
|
+
* @public
|
|
7038
|
+
*/
|
|
7039
|
+
textDataDeliveryEnabled?: boolean | undefined;
|
|
7040
|
+
/**
|
|
7041
|
+
* <p>Set to include image data in the log delivery.</p>
|
|
7042
|
+
* @public
|
|
7043
|
+
*/
|
|
7044
|
+
imageDataDeliveryEnabled?: boolean | undefined;
|
|
7045
|
+
/**
|
|
7046
|
+
* <p>Set to include embeddings data in the log delivery.</p>
|
|
7047
|
+
* @public
|
|
7048
|
+
*/
|
|
7049
|
+
embeddingDataDeliveryEnabled?: boolean | undefined;
|
|
7050
|
+
/**
|
|
7051
|
+
* <p>Set to include video data in the log delivery.</p>
|
|
7052
|
+
* @public
|
|
7053
|
+
*/
|
|
7054
|
+
videoDataDeliveryEnabled?: boolean | undefined;
|
|
7055
|
+
}
|
|
7056
|
+
/**
|
|
7057
|
+
* @public
|
|
7058
|
+
*/
|
|
7059
|
+
export interface GetModelInvocationLoggingConfigurationResponse {
|
|
7060
|
+
/**
|
|
7061
|
+
* <p>The current configuration values.</p>
|
|
7062
|
+
* @public
|
|
7063
|
+
*/
|
|
7064
|
+
loggingConfig?: LoggingConfig | undefined;
|
|
7065
|
+
}
|
|
7066
|
+
/**
|
|
7067
|
+
* @public
|
|
7068
|
+
*/
|
|
7069
|
+
export interface PutModelInvocationLoggingConfigurationRequest {
|
|
7070
|
+
/**
|
|
7071
|
+
* <p>The logging configuration values to set.</p>
|
|
7072
|
+
* @public
|
|
7073
|
+
*/
|
|
7074
|
+
loggingConfig: LoggingConfig | undefined;
|
|
7075
|
+
}
|