@aws-sdk/client-bedrock 3.556.0 → 3.561.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/README.md +81 -1
- package/dist-cjs/index.js +1005 -79
- package/dist-es/Bedrock.js +20 -0
- package/dist-es/commands/CreateEvaluationJobCommand.js +25 -0
- package/dist-es/commands/CreateGuardrailCommand.js +25 -0
- package/dist-es/commands/CreateGuardrailVersionCommand.js +25 -0
- package/dist-es/commands/DeleteGuardrailCommand.js +24 -0
- package/dist-es/commands/GetEvaluationJobCommand.js +25 -0
- package/dist-es/commands/GetGuardrailCommand.js +25 -0
- package/dist-es/commands/ListEvaluationJobsCommand.js +24 -0
- package/dist-es/commands/ListGuardrailsCommand.js +25 -0
- package/dist-es/commands/StopEvaluationJobCommand.js +25 -0
- package/dist-es/commands/UpdateGuardrailCommand.js +25 -0
- package/dist-es/commands/index.js +10 -0
- package/dist-es/models/models_0.js +312 -48
- package/dist-es/pagination/ListEvaluationJobsPaginator.js +4 -0
- package/dist-es/pagination/ListGuardrailsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +374 -4
- package/dist-types/Bedrock.d.ts +73 -1
- package/dist-types/BedrockClient.d.ts +13 -3
- package/dist-types/commands/CreateEvaluationJobCommand.d.ts +148 -0
- package/dist-types/commands/CreateGuardrailCommand.d.ts +186 -0
- package/dist-types/commands/CreateGuardrailVersionCommand.d.ts +84 -0
- package/dist-types/commands/CreateModelCustomizationJobCommand.d.ts +6 -8
- package/dist-types/commands/CreateProvisionedModelThroughputCommand.d.ts +2 -3
- package/dist-types/commands/DeleteCustomModelCommand.d.ts +2 -2
- package/dist-types/commands/DeleteGuardrailCommand.d.ts +84 -0
- package/dist-types/commands/DeleteProvisionedModelThroughputCommand.d.ts +2 -2
- package/dist-types/commands/GetCustomModelCommand.d.ts +2 -2
- package/dist-types/commands/GetEvaluationJobCommand.d.ts +144 -0
- package/dist-types/commands/GetFoundationModelCommand.d.ts +1 -1
- package/dist-types/commands/GetGuardrailCommand.d.ts +140 -0
- package/dist-types/commands/GetModelCustomizationJobCommand.d.ts +2 -2
- package/dist-types/commands/GetProvisionedModelThroughputCommand.d.ts +2 -2
- package/dist-types/commands/ListCustomModelsCommand.d.ts +1 -1
- package/dist-types/commands/ListEvaluationJobsCommand.d.ts +93 -0
- package/dist-types/commands/ListFoundationModelsCommand.d.ts +1 -1
- package/dist-types/commands/ListGuardrailsCommand.d.ts +89 -0
- package/dist-types/commands/ListModelCustomizationJobsCommand.d.ts +2 -2
- package/dist-types/commands/ListProvisionedModelThroughputsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/StopEvaluationJobCommand.d.ts +75 -0
- package/dist-types/commands/StopModelCustomizationJobCommand.d.ts +2 -2
- package/dist-types/commands/TagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateGuardrailCommand.d.ts +176 -0
- package/dist-types/commands/UpdateProvisionedModelThroughputCommand.d.ts +2 -2
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +1926 -215
- package/dist-types/pagination/ListEvaluationJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListGuardrailsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +90 -0
- package/dist-types/ts3.4/Bedrock.d.ts +172 -0
- package/dist-types/ts3.4/BedrockClient.d.ts +60 -0
- package/dist-types/ts3.4/commands/CreateEvaluationJobCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateGuardrailCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateGuardrailVersionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteGuardrailCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetEvaluationJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetGuardrailCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListEvaluationJobsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListGuardrailsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StopEvaluationJobCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateGuardrailCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +10 -0
- package/dist-types/ts3.4/models/models_0.d.ts +572 -49
- package/dist-types/ts3.4/pagination/ListEvaluationJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListGuardrailsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +120 -0
- package/package.json +1 -1
|
@@ -7,25 +7,35 @@ import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol
|
|
|
7
7
|
import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
|
|
8
8
|
import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
|
|
9
9
|
import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
|
|
10
|
+
import { CreateEvaluationJobCommandInput, CreateEvaluationJobCommandOutput } from "./commands/CreateEvaluationJobCommand";
|
|
11
|
+
import { CreateGuardrailCommandInput, CreateGuardrailCommandOutput } from "./commands/CreateGuardrailCommand";
|
|
12
|
+
import { CreateGuardrailVersionCommandInput, CreateGuardrailVersionCommandOutput } from "./commands/CreateGuardrailVersionCommand";
|
|
10
13
|
import { CreateModelCustomizationJobCommandInput, CreateModelCustomizationJobCommandOutput } from "./commands/CreateModelCustomizationJobCommand";
|
|
11
14
|
import { CreateProvisionedModelThroughputCommandInput, CreateProvisionedModelThroughputCommandOutput } from "./commands/CreateProvisionedModelThroughputCommand";
|
|
12
15
|
import { DeleteCustomModelCommandInput, DeleteCustomModelCommandOutput } from "./commands/DeleteCustomModelCommand";
|
|
16
|
+
import { DeleteGuardrailCommandInput, DeleteGuardrailCommandOutput } from "./commands/DeleteGuardrailCommand";
|
|
13
17
|
import { DeleteModelInvocationLoggingConfigurationCommandInput, DeleteModelInvocationLoggingConfigurationCommandOutput } from "./commands/DeleteModelInvocationLoggingConfigurationCommand";
|
|
14
18
|
import { DeleteProvisionedModelThroughputCommandInput, DeleteProvisionedModelThroughputCommandOutput } from "./commands/DeleteProvisionedModelThroughputCommand";
|
|
15
19
|
import { GetCustomModelCommandInput, GetCustomModelCommandOutput } from "./commands/GetCustomModelCommand";
|
|
20
|
+
import { GetEvaluationJobCommandInput, GetEvaluationJobCommandOutput } from "./commands/GetEvaluationJobCommand";
|
|
16
21
|
import { GetFoundationModelCommandInput, GetFoundationModelCommandOutput } from "./commands/GetFoundationModelCommand";
|
|
22
|
+
import { GetGuardrailCommandInput, GetGuardrailCommandOutput } from "./commands/GetGuardrailCommand";
|
|
17
23
|
import { GetModelCustomizationJobCommandInput, GetModelCustomizationJobCommandOutput } from "./commands/GetModelCustomizationJobCommand";
|
|
18
24
|
import { GetModelInvocationLoggingConfigurationCommandInput, GetModelInvocationLoggingConfigurationCommandOutput } from "./commands/GetModelInvocationLoggingConfigurationCommand";
|
|
19
25
|
import { GetProvisionedModelThroughputCommandInput, GetProvisionedModelThroughputCommandOutput } from "./commands/GetProvisionedModelThroughputCommand";
|
|
20
26
|
import { ListCustomModelsCommandInput, ListCustomModelsCommandOutput } from "./commands/ListCustomModelsCommand";
|
|
27
|
+
import { ListEvaluationJobsCommandInput, ListEvaluationJobsCommandOutput } from "./commands/ListEvaluationJobsCommand";
|
|
21
28
|
import { ListFoundationModelsCommandInput, ListFoundationModelsCommandOutput } from "./commands/ListFoundationModelsCommand";
|
|
29
|
+
import { ListGuardrailsCommandInput, ListGuardrailsCommandOutput } from "./commands/ListGuardrailsCommand";
|
|
22
30
|
import { ListModelCustomizationJobsCommandInput, ListModelCustomizationJobsCommandOutput } from "./commands/ListModelCustomizationJobsCommand";
|
|
23
31
|
import { ListProvisionedModelThroughputsCommandInput, ListProvisionedModelThroughputsCommandOutput } from "./commands/ListProvisionedModelThroughputsCommand";
|
|
24
32
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
25
33
|
import { PutModelInvocationLoggingConfigurationCommandInput, PutModelInvocationLoggingConfigurationCommandOutput } from "./commands/PutModelInvocationLoggingConfigurationCommand";
|
|
34
|
+
import { StopEvaluationJobCommandInput, StopEvaluationJobCommandOutput } from "./commands/StopEvaluationJobCommand";
|
|
26
35
|
import { StopModelCustomizationJobCommandInput, StopModelCustomizationJobCommandOutput } from "./commands/StopModelCustomizationJobCommand";
|
|
27
36
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
28
37
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
38
|
+
import { UpdateGuardrailCommandInput, UpdateGuardrailCommandOutput } from "./commands/UpdateGuardrailCommand";
|
|
29
39
|
import { UpdateProvisionedModelThroughputCommandInput, UpdateProvisionedModelThroughputCommandOutput } from "./commands/UpdateProvisionedModelThroughputCommand";
|
|
30
40
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
31
41
|
import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
|
|
@@ -33,11 +43,11 @@ export { __Client };
|
|
|
33
43
|
/**
|
|
34
44
|
* @public
|
|
35
45
|
*/
|
|
36
|
-
export type ServiceInputTypes = CreateModelCustomizationJobCommandInput | CreateProvisionedModelThroughputCommandInput | DeleteCustomModelCommandInput | DeleteModelInvocationLoggingConfigurationCommandInput | DeleteProvisionedModelThroughputCommandInput | GetCustomModelCommandInput | GetFoundationModelCommandInput | GetModelCustomizationJobCommandInput | GetModelInvocationLoggingConfigurationCommandInput | GetProvisionedModelThroughputCommandInput | ListCustomModelsCommandInput | ListFoundationModelsCommandInput | ListModelCustomizationJobsCommandInput | ListProvisionedModelThroughputsCommandInput | ListTagsForResourceCommandInput | PutModelInvocationLoggingConfigurationCommandInput | StopModelCustomizationJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateProvisionedModelThroughputCommandInput;
|
|
46
|
+
export type ServiceInputTypes = CreateEvaluationJobCommandInput | CreateGuardrailCommandInput | CreateGuardrailVersionCommandInput | CreateModelCustomizationJobCommandInput | CreateProvisionedModelThroughputCommandInput | DeleteCustomModelCommandInput | DeleteGuardrailCommandInput | DeleteModelInvocationLoggingConfigurationCommandInput | DeleteProvisionedModelThroughputCommandInput | GetCustomModelCommandInput | GetEvaluationJobCommandInput | GetFoundationModelCommandInput | GetGuardrailCommandInput | GetModelCustomizationJobCommandInput | GetModelInvocationLoggingConfigurationCommandInput | GetProvisionedModelThroughputCommandInput | ListCustomModelsCommandInput | ListEvaluationJobsCommandInput | ListFoundationModelsCommandInput | ListGuardrailsCommandInput | ListModelCustomizationJobsCommandInput | ListProvisionedModelThroughputsCommandInput | ListTagsForResourceCommandInput | PutModelInvocationLoggingConfigurationCommandInput | StopEvaluationJobCommandInput | StopModelCustomizationJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGuardrailCommandInput | UpdateProvisionedModelThroughputCommandInput;
|
|
37
47
|
/**
|
|
38
48
|
* @public
|
|
39
49
|
*/
|
|
40
|
-
export type ServiceOutputTypes = CreateModelCustomizationJobCommandOutput | CreateProvisionedModelThroughputCommandOutput | DeleteCustomModelCommandOutput | DeleteModelInvocationLoggingConfigurationCommandOutput | DeleteProvisionedModelThroughputCommandOutput | GetCustomModelCommandOutput | GetFoundationModelCommandOutput | GetModelCustomizationJobCommandOutput | GetModelInvocationLoggingConfigurationCommandOutput | GetProvisionedModelThroughputCommandOutput | ListCustomModelsCommandOutput | ListFoundationModelsCommandOutput | ListModelCustomizationJobsCommandOutput | ListProvisionedModelThroughputsCommandOutput | ListTagsForResourceCommandOutput | PutModelInvocationLoggingConfigurationCommandOutput | StopModelCustomizationJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateProvisionedModelThroughputCommandOutput;
|
|
50
|
+
export type ServiceOutputTypes = CreateEvaluationJobCommandOutput | CreateGuardrailCommandOutput | CreateGuardrailVersionCommandOutput | CreateModelCustomizationJobCommandOutput | CreateProvisionedModelThroughputCommandOutput | DeleteCustomModelCommandOutput | DeleteGuardrailCommandOutput | DeleteModelInvocationLoggingConfigurationCommandOutput | DeleteProvisionedModelThroughputCommandOutput | GetCustomModelCommandOutput | GetEvaluationJobCommandOutput | GetFoundationModelCommandOutput | GetGuardrailCommandOutput | GetModelCustomizationJobCommandOutput | GetModelInvocationLoggingConfigurationCommandOutput | GetProvisionedModelThroughputCommandOutput | ListCustomModelsCommandOutput | ListEvaluationJobsCommandOutput | ListFoundationModelsCommandOutput | ListGuardrailsCommandOutput | ListModelCustomizationJobsCommandOutput | ListProvisionedModelThroughputsCommandOutput | ListTagsForResourceCommandOutput | PutModelInvocationLoggingConfigurationCommandOutput | StopEvaluationJobCommandOutput | StopModelCustomizationJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGuardrailCommandOutput | UpdateProvisionedModelThroughputCommandOutput;
|
|
41
51
|
/**
|
|
42
52
|
* @public
|
|
43
53
|
*/
|
|
@@ -171,7 +181,7 @@ export type BedrockClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht
|
|
|
171
181
|
export interface BedrockClientResolvedConfig extends BedrockClientResolvedConfigType {
|
|
172
182
|
}
|
|
173
183
|
/**
|
|
174
|
-
* <p>Describes the API operations for creating and
|
|
184
|
+
* <p>Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.</p>
|
|
175
185
|
* @public
|
|
176
186
|
*/
|
|
177
187
|
export declare class BedrockClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, BedrockClientResolvedConfig> {
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockClient";
|
|
4
|
+
import { CreateEvaluationJobRequest, CreateEvaluationJobResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link CreateEvaluationJobCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface CreateEvaluationJobCommandInput extends CreateEvaluationJobRequest {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link CreateEvaluationJobCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface CreateEvaluationJobCommandOutput extends CreateEvaluationJobResponse, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const CreateEvaluationJobCommand_base: {
|
|
24
|
+
new (input: CreateEvaluationJobCommandInput): import("@smithy/smithy-client").CommandImpl<CreateEvaluationJobCommandInput, CreateEvaluationJobCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: CreateEvaluationJobCommandInput): import("@smithy/smithy-client").CommandImpl<CreateEvaluationJobCommandInput, CreateEvaluationJobCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation.html">Model evaluations</a>.</p>
|
|
30
|
+
* @example
|
|
31
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
32
|
+
* ```javascript
|
|
33
|
+
* import { BedrockClient, CreateEvaluationJobCommand } from "@aws-sdk/client-bedrock"; // ES Modules import
|
|
34
|
+
* // const { BedrockClient, CreateEvaluationJobCommand } = require("@aws-sdk/client-bedrock"); // CommonJS import
|
|
35
|
+
* const client = new BedrockClient(config);
|
|
36
|
+
* const input = { // CreateEvaluationJobRequest
|
|
37
|
+
* jobName: "STRING_VALUE", // required
|
|
38
|
+
* jobDescription: "STRING_VALUE",
|
|
39
|
+
* clientRequestToken: "STRING_VALUE",
|
|
40
|
+
* roleArn: "STRING_VALUE", // required
|
|
41
|
+
* customerEncryptionKeyId: "STRING_VALUE",
|
|
42
|
+
* jobTags: [ // TagList
|
|
43
|
+
* { // Tag
|
|
44
|
+
* key: "STRING_VALUE", // required
|
|
45
|
+
* value: "STRING_VALUE", // required
|
|
46
|
+
* },
|
|
47
|
+
* ],
|
|
48
|
+
* evaluationConfig: { // EvaluationConfig Union: only one key present
|
|
49
|
+
* automated: { // AutomatedEvaluationConfig
|
|
50
|
+
* datasetMetricConfigs: [ // EvaluationDatasetMetricConfigs // required
|
|
51
|
+
* { // EvaluationDatasetMetricConfig
|
|
52
|
+
* taskType: "Summarization" || "Classification" || "QuestionAndAnswer" || "Generation" || "Custom", // required
|
|
53
|
+
* dataset: { // EvaluationDataset
|
|
54
|
+
* name: "STRING_VALUE", // required
|
|
55
|
+
* datasetLocation: { // EvaluationDatasetLocation Union: only one key present
|
|
56
|
+
* s3Uri: "STRING_VALUE",
|
|
57
|
+
* },
|
|
58
|
+
* },
|
|
59
|
+
* metricNames: [ // EvaluationMetricNames // required
|
|
60
|
+
* "STRING_VALUE",
|
|
61
|
+
* ],
|
|
62
|
+
* },
|
|
63
|
+
* ],
|
|
64
|
+
* },
|
|
65
|
+
* human: { // HumanEvaluationConfig
|
|
66
|
+
* humanWorkflowConfig: { // HumanWorkflowConfig
|
|
67
|
+
* flowDefinitionArn: "STRING_VALUE", // required
|
|
68
|
+
* instructions: "STRING_VALUE",
|
|
69
|
+
* },
|
|
70
|
+
* customMetrics: [ // HumanEvaluationCustomMetrics
|
|
71
|
+
* { // HumanEvaluationCustomMetric
|
|
72
|
+
* name: "STRING_VALUE", // required
|
|
73
|
+
* description: "STRING_VALUE",
|
|
74
|
+
* ratingMethod: "STRING_VALUE", // required
|
|
75
|
+
* },
|
|
76
|
+
* ],
|
|
77
|
+
* datasetMetricConfigs: [ // required
|
|
78
|
+
* {
|
|
79
|
+
* taskType: "Summarization" || "Classification" || "QuestionAndAnswer" || "Generation" || "Custom", // required
|
|
80
|
+
* dataset: {
|
|
81
|
+
* name: "STRING_VALUE", // required
|
|
82
|
+
* datasetLocation: {// Union: only one key present
|
|
83
|
+
* s3Uri: "STRING_VALUE",
|
|
84
|
+
* },
|
|
85
|
+
* },
|
|
86
|
+
* metricNames: [ // required
|
|
87
|
+
* "STRING_VALUE",
|
|
88
|
+
* ],
|
|
89
|
+
* },
|
|
90
|
+
* ],
|
|
91
|
+
* },
|
|
92
|
+
* },
|
|
93
|
+
* inferenceConfig: { // EvaluationInferenceConfig Union: only one key present
|
|
94
|
+
* models: [ // EvaluationModelConfigs
|
|
95
|
+
* { // EvaluationModelConfig Union: only one key present
|
|
96
|
+
* bedrockModel: { // EvaluationBedrockModel
|
|
97
|
+
* modelIdentifier: "STRING_VALUE", // required
|
|
98
|
+
* inferenceParams: "STRING_VALUE", // required
|
|
99
|
+
* },
|
|
100
|
+
* },
|
|
101
|
+
* ],
|
|
102
|
+
* },
|
|
103
|
+
* outputDataConfig: { // EvaluationOutputDataConfig
|
|
104
|
+
* s3Uri: "STRING_VALUE", // required
|
|
105
|
+
* },
|
|
106
|
+
* };
|
|
107
|
+
* const command = new CreateEvaluationJobCommand(input);
|
|
108
|
+
* const response = await client.send(command);
|
|
109
|
+
* // { // CreateEvaluationJobResponse
|
|
110
|
+
* // jobArn: "STRING_VALUE", // required
|
|
111
|
+
* // };
|
|
112
|
+
*
|
|
113
|
+
* ```
|
|
114
|
+
*
|
|
115
|
+
* @param CreateEvaluationJobCommandInput - {@link CreateEvaluationJobCommandInput}
|
|
116
|
+
* @returns {@link CreateEvaluationJobCommandOutput}
|
|
117
|
+
* @see {@link CreateEvaluationJobCommandInput} for command's `input` shape.
|
|
118
|
+
* @see {@link CreateEvaluationJobCommandOutput} for command's `response` shape.
|
|
119
|
+
* @see {@link BedrockClientResolvedConfig | config} for BedrockClient's `config` shape.
|
|
120
|
+
*
|
|
121
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
122
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link ConflictException} (client fault)
|
|
125
|
+
* <p>Error occurred because of a conflict while performing an operation.</p>
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link InternalServerException} (server fault)
|
|
128
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
131
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
134
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
135
|
+
*
|
|
136
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
137
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
138
|
+
*
|
|
139
|
+
* @throws {@link ValidationException} (client fault)
|
|
140
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
141
|
+
*
|
|
142
|
+
* @throws {@link BedrockServiceException}
|
|
143
|
+
* <p>Base exception class for all service exceptions from Bedrock service.</p>
|
|
144
|
+
*
|
|
145
|
+
* @public
|
|
146
|
+
*/
|
|
147
|
+
export declare class CreateEvaluationJobCommand extends CreateEvaluationJobCommand_base {
|
|
148
|
+
}
|
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockClient";
|
|
4
|
+
import { CreateGuardrailRequest, CreateGuardrailResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link CreateGuardrailCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface CreateGuardrailCommandInput extends CreateGuardrailRequest {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link CreateGuardrailCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface CreateGuardrailCommandOutput extends CreateGuardrailResponse, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const CreateGuardrailCommand_base: {
|
|
24
|
+
new (input: CreateGuardrailCommandInput): import("@smithy/smithy-client").CommandImpl<CreateGuardrailCommandInput, CreateGuardrailCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: CreateGuardrailCommandInput): import("@smithy/smithy-client").CommandImpl<CreateGuardrailCommandInput, CreateGuardrailCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>Creates a guardrail to block topics and to filter out harmful content.</p>
|
|
30
|
+
* <ul>
|
|
31
|
+
* <li>
|
|
32
|
+
* <p>Specify a <code>name</code> and optional <code>description</code>.</p>
|
|
33
|
+
* </li>
|
|
34
|
+
* <li>
|
|
35
|
+
* <p>Specify messages for when the guardrail successfully blocks a prompt or a model response in the <code>blockedInputMessaging</code> and <code>blockedOutputsMessaging</code> fields.</p>
|
|
36
|
+
* </li>
|
|
37
|
+
* <li>
|
|
38
|
+
* <p>Specify topics for the guardrail to deny in the <code>topicPolicyConfig</code> object. Each <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailTopicConfig.html">GuardrailTopicConfig</a> object in the <code>topicsConfig</code> list pertains to one topic.</p>
|
|
39
|
+
* <ul>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>Give a <code>name</code> and <code>description</code> so that the guardrail can properly identify the topic.</p>
|
|
42
|
+
* </li>
|
|
43
|
+
* <li>
|
|
44
|
+
* <p>Specify <code>DENY</code> in the <code>type</code> field.</p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the <code>examples</code> list.</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* </ul>
|
|
50
|
+
* </li>
|
|
51
|
+
* <li>
|
|
52
|
+
* <p>Specify filter strengths for the harmful categories defined in Amazon Bedrock in the <code>contentPolicyConfig</code> object. Each <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html">GuardrailContentFilterConfig</a> object in the <code>filtersConfig</code> list pertains to a harmful category. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters">Content filters</a>. For more information about the fields in a content filter, see <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html">GuardrailContentFilterConfig</a>.</p>
|
|
53
|
+
* <ul>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>Specify the category in the <code>type</code> field.</p>
|
|
56
|
+
* </li>
|
|
57
|
+
* <li>
|
|
58
|
+
* <p>Specify the strength of the filter for prompts in the <code>inputStrength</code> field and for model responses in the <code>strength</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html">GuardrailContentFilterConfig</a>.</p>
|
|
59
|
+
* </li>
|
|
60
|
+
* </ul>
|
|
61
|
+
* </li>
|
|
62
|
+
* <li>
|
|
63
|
+
* <p>(Optional) For security, include the ARN of a KMS key in the <code>kmsKeyId</code> field.</p>
|
|
64
|
+
* </li>
|
|
65
|
+
* <li>
|
|
66
|
+
* <p>(Optional) Attach any tags to the guardrail in the <code>tags</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging">Tag resources</a>.</p>
|
|
67
|
+
* </li>
|
|
68
|
+
* </ul>
|
|
69
|
+
* @example
|
|
70
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
71
|
+
* ```javascript
|
|
72
|
+
* import { BedrockClient, CreateGuardrailCommand } from "@aws-sdk/client-bedrock"; // ES Modules import
|
|
73
|
+
* // const { BedrockClient, CreateGuardrailCommand } = require("@aws-sdk/client-bedrock"); // CommonJS import
|
|
74
|
+
* const client = new BedrockClient(config);
|
|
75
|
+
* const input = { // CreateGuardrailRequest
|
|
76
|
+
* name: "STRING_VALUE", // required
|
|
77
|
+
* description: "STRING_VALUE",
|
|
78
|
+
* topicPolicyConfig: { // GuardrailTopicPolicyConfig
|
|
79
|
+
* topicsConfig: [ // GuardrailTopicsConfig // required
|
|
80
|
+
* { // GuardrailTopicConfig
|
|
81
|
+
* name: "STRING_VALUE", // required
|
|
82
|
+
* definition: "STRING_VALUE", // required
|
|
83
|
+
* examples: [ // GuardrailTopicExamples
|
|
84
|
+
* "STRING_VALUE",
|
|
85
|
+
* ],
|
|
86
|
+
* type: "DENY", // required
|
|
87
|
+
* },
|
|
88
|
+
* ],
|
|
89
|
+
* },
|
|
90
|
+
* contentPolicyConfig: { // GuardrailContentPolicyConfig
|
|
91
|
+
* filtersConfig: [ // GuardrailContentFiltersConfig // required
|
|
92
|
+
* { // GuardrailContentFilterConfig
|
|
93
|
+
* type: "SEXUAL" || "VIOLENCE" || "HATE" || "INSULTS" || "MISCONDUCT" || "PROMPT_ATTACK", // required
|
|
94
|
+
* inputStrength: "NONE" || "LOW" || "MEDIUM" || "HIGH", // required
|
|
95
|
+
* outputStrength: "NONE" || "LOW" || "MEDIUM" || "HIGH", // required
|
|
96
|
+
* },
|
|
97
|
+
* ],
|
|
98
|
+
* },
|
|
99
|
+
* wordPolicyConfig: { // GuardrailWordPolicyConfig
|
|
100
|
+
* wordsConfig: [ // GuardrailWordsConfig
|
|
101
|
+
* { // GuardrailWordConfig
|
|
102
|
+
* text: "STRING_VALUE", // required
|
|
103
|
+
* },
|
|
104
|
+
* ],
|
|
105
|
+
* managedWordListsConfig: [ // GuardrailManagedWordListsConfig
|
|
106
|
+
* { // GuardrailManagedWordsConfig
|
|
107
|
+
* type: "PROFANITY", // required
|
|
108
|
+
* },
|
|
109
|
+
* ],
|
|
110
|
+
* },
|
|
111
|
+
* sensitiveInformationPolicyConfig: { // GuardrailSensitiveInformationPolicyConfig
|
|
112
|
+
* piiEntitiesConfig: [ // GuardrailPiiEntitiesConfig
|
|
113
|
+
* { // GuardrailPiiEntityConfig
|
|
114
|
+
* type: "ADDRESS" || "AGE" || "AWS_ACCESS_KEY" || "AWS_SECRET_KEY" || "CA_HEALTH_NUMBER" || "CA_SOCIAL_INSURANCE_NUMBER" || "CREDIT_DEBIT_CARD_CVV" || "CREDIT_DEBIT_CARD_EXPIRY" || "CREDIT_DEBIT_CARD_NUMBER" || "DRIVER_ID" || "EMAIL" || "INTERNATIONAL_BANK_ACCOUNT_NUMBER" || "IP_ADDRESS" || "LICENSE_PLATE" || "MAC_ADDRESS" || "NAME" || "PASSWORD" || "PHONE" || "PIN" || "SWIFT_CODE" || "UK_NATIONAL_HEALTH_SERVICE_NUMBER" || "UK_NATIONAL_INSURANCE_NUMBER" || "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" || "URL" || "USERNAME" || "US_BANK_ACCOUNT_NUMBER" || "US_BANK_ROUTING_NUMBER" || "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" || "US_PASSPORT_NUMBER" || "US_SOCIAL_SECURITY_NUMBER" || "VEHICLE_IDENTIFICATION_NUMBER", // required
|
|
115
|
+
* action: "BLOCK" || "ANONYMIZE", // required
|
|
116
|
+
* },
|
|
117
|
+
* ],
|
|
118
|
+
* regexesConfig: [ // GuardrailRegexesConfig
|
|
119
|
+
* { // GuardrailRegexConfig
|
|
120
|
+
* name: "STRING_VALUE", // required
|
|
121
|
+
* description: "STRING_VALUE",
|
|
122
|
+
* pattern: "STRING_VALUE", // required
|
|
123
|
+
* action: "BLOCK" || "ANONYMIZE", // required
|
|
124
|
+
* },
|
|
125
|
+
* ],
|
|
126
|
+
* },
|
|
127
|
+
* blockedInputMessaging: "STRING_VALUE", // required
|
|
128
|
+
* blockedOutputsMessaging: "STRING_VALUE", // required
|
|
129
|
+
* kmsKeyId: "STRING_VALUE",
|
|
130
|
+
* tags: [ // TagList
|
|
131
|
+
* { // Tag
|
|
132
|
+
* key: "STRING_VALUE", // required
|
|
133
|
+
* value: "STRING_VALUE", // required
|
|
134
|
+
* },
|
|
135
|
+
* ],
|
|
136
|
+
* clientRequestToken: "STRING_VALUE",
|
|
137
|
+
* };
|
|
138
|
+
* const command = new CreateGuardrailCommand(input);
|
|
139
|
+
* const response = await client.send(command);
|
|
140
|
+
* // { // CreateGuardrailResponse
|
|
141
|
+
* // guardrailId: "STRING_VALUE", // required
|
|
142
|
+
* // guardrailArn: "STRING_VALUE", // required
|
|
143
|
+
* // version: "STRING_VALUE", // required
|
|
144
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
145
|
+
* // };
|
|
146
|
+
*
|
|
147
|
+
* ```
|
|
148
|
+
*
|
|
149
|
+
* @param CreateGuardrailCommandInput - {@link CreateGuardrailCommandInput}
|
|
150
|
+
* @returns {@link CreateGuardrailCommandOutput}
|
|
151
|
+
* @see {@link CreateGuardrailCommandInput} for command's `input` shape.
|
|
152
|
+
* @see {@link CreateGuardrailCommandOutput} for command's `response` shape.
|
|
153
|
+
* @see {@link BedrockClientResolvedConfig | config} for BedrockClient's `config` shape.
|
|
154
|
+
*
|
|
155
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
156
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
157
|
+
*
|
|
158
|
+
* @throws {@link ConflictException} (client fault)
|
|
159
|
+
* <p>Error occurred because of a conflict while performing an operation.</p>
|
|
160
|
+
*
|
|
161
|
+
* @throws {@link InternalServerException} (server fault)
|
|
162
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
163
|
+
*
|
|
164
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
165
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
166
|
+
*
|
|
167
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
168
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
169
|
+
*
|
|
170
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
171
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
172
|
+
*
|
|
173
|
+
* @throws {@link TooManyTagsException} (client fault)
|
|
174
|
+
* <p>The request contains more tags than can be associated with a resource (50 tags per resource).
|
|
175
|
+
* The maximum number of tags includes both existing tags and those included in your current request. </p>
|
|
176
|
+
*
|
|
177
|
+
* @throws {@link ValidationException} (client fault)
|
|
178
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
179
|
+
*
|
|
180
|
+
* @throws {@link BedrockServiceException}
|
|
181
|
+
* <p>Base exception class for all service exceptions from Bedrock service.</p>
|
|
182
|
+
*
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
export declare class CreateGuardrailCommand extends CreateGuardrailCommand_base {
|
|
186
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockClient";
|
|
4
|
+
import { CreateGuardrailVersionRequest, CreateGuardrailVersionResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link CreateGuardrailVersionCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface CreateGuardrailVersionCommandInput extends CreateGuardrailVersionRequest {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link CreateGuardrailVersionCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface CreateGuardrailVersionCommandOutput extends CreateGuardrailVersionResponse, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const CreateGuardrailVersionCommand_base: {
|
|
24
|
+
new (input: CreateGuardrailVersionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateGuardrailVersionCommandInput, CreateGuardrailVersionCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: CreateGuardrailVersionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateGuardrailVersionCommandInput, CreateGuardrailVersionCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>Creates a version of the guardrail. Use this API to create a snapshot of the
|
|
30
|
+
* guardrail when you are satisfied with a configuration, or to compare the configuration with another version.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockClient, CreateGuardrailVersionCommand } from "@aws-sdk/client-bedrock"; // ES Modules import
|
|
35
|
+
* // const { BedrockClient, CreateGuardrailVersionCommand } = require("@aws-sdk/client-bedrock"); // CommonJS import
|
|
36
|
+
* const client = new BedrockClient(config);
|
|
37
|
+
* const input = { // CreateGuardrailVersionRequest
|
|
38
|
+
* guardrailIdentifier: "STRING_VALUE", // required
|
|
39
|
+
* description: "STRING_VALUE",
|
|
40
|
+
* clientRequestToken: "STRING_VALUE",
|
|
41
|
+
* };
|
|
42
|
+
* const command = new CreateGuardrailVersionCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // CreateGuardrailVersionResponse
|
|
45
|
+
* // guardrailId: "STRING_VALUE", // required
|
|
46
|
+
* // version: "STRING_VALUE", // required
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param CreateGuardrailVersionCommandInput - {@link CreateGuardrailVersionCommandInput}
|
|
52
|
+
* @returns {@link CreateGuardrailVersionCommandOutput}
|
|
53
|
+
* @see {@link CreateGuardrailVersionCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link CreateGuardrailVersionCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link BedrockClientResolvedConfig | config} for BedrockClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
58
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ConflictException} (client fault)
|
|
61
|
+
* <p>Error occurred because of a conflict while performing an operation.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link InternalServerException} (server fault)
|
|
64
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
70
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
73
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ValidationException} (client fault)
|
|
76
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link BedrockServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from Bedrock service.</p>
|
|
80
|
+
*
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export declare class CreateGuardrailVersionCommand extends CreateGuardrailVersionCommand_base {
|
|
84
|
+
}
|
|
@@ -28,15 +28,13 @@ declare const CreateModelCustomizationJobCommand_base: {
|
|
|
28
28
|
/**
|
|
29
29
|
* <p>Creates a fine-tuning job to customize a base model.</p>
|
|
30
30
|
* <p>You specify the base foundation model and the location of the training data.
|
|
31
|
-
* After the model-customization job completes successfully, your custom model resource will be ready to use.
|
|
32
|
-
* contains input and output text for each record in a JSONL format. Optionally, you can specify validation data
|
|
33
|
-
* in the same format as the training data. Amazon Bedrock returns validation loss metrics and output generations
|
|
34
|
-
* after the job completes.
|
|
31
|
+
* After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes.
|
|
35
32
|
* </p>
|
|
33
|
+
* <p>For information on the format of training and validation data, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-prepare.html">Prepare the datasets</a>.</p>
|
|
36
34
|
* <p>
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the Bedrock User Guide.</p>
|
|
35
|
+
* Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size.
|
|
36
|
+
* To monitor a job, use the <code>GetModelCustomizationJob</code> operation to retrieve the job status.</p>
|
|
37
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the Amazon Bedrock User Guide.</p>
|
|
40
38
|
* @example
|
|
41
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
40
|
* ```javascript
|
|
@@ -112,7 +110,7 @@ declare const CreateModelCustomizationJobCommand_base: {
|
|
|
112
110
|
* <p>An internal server error occurred. Retry your request.</p>
|
|
113
111
|
*
|
|
114
112
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
115
|
-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
113
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
116
114
|
*
|
|
117
115
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
118
116
|
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
@@ -26,8 +26,7 @@ declare const CreateProvisionedModelThroughputCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Creates a
|
|
30
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Provisioned throughput</a> in the Bedrock User Guide.</p>
|
|
29
|
+
* <p>Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see <a href="http://aws.amazon.com/bedrock/pricing/">Amazon Bedrock Pricing</a>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
|
|
31
30
|
* @example
|
|
32
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
32
|
* ```javascript
|
|
@@ -68,7 +67,7 @@ declare const CreateProvisionedModelThroughputCommand_base: {
|
|
|
68
67
|
* <p>An internal server error occurred. Retry your request.</p>
|
|
69
68
|
*
|
|
70
69
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
71
|
-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
70
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
72
71
|
*
|
|
73
72
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
74
73
|
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
@@ -26,7 +26,7 @@ declare const DeleteCustomModelCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Deletes a custom model that you created earlier. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the Bedrock User Guide.</p>
|
|
29
|
+
* <p>Deletes a custom model that you created earlier. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the Amazon Bedrock User Guide.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -58,7 +58,7 @@ declare const DeleteCustomModelCommand_base: {
|
|
|
58
58
|
* <p>An internal server error occurred. Retry your request.</p>
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
61
|
-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
61
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link ThrottlingException} (client fault)
|
|
64
64
|
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockClient";
|
|
4
|
+
import { DeleteGuardrailRequest, DeleteGuardrailResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link DeleteGuardrailCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface DeleteGuardrailCommandInput extends DeleteGuardrailRequest {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link DeleteGuardrailCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface DeleteGuardrailCommandOutput extends DeleteGuardrailResponse, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const DeleteGuardrailCommand_base: {
|
|
24
|
+
new (input: DeleteGuardrailCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteGuardrailCommandInput, DeleteGuardrailCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DeleteGuardrailCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteGuardrailCommandInput, DeleteGuardrailCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>Deletes a guardrail.</p>
|
|
30
|
+
* <ul>
|
|
31
|
+
* <li>
|
|
32
|
+
* <p>To delete a guardrail, only specify the ARN of the guardrail in the <code>guardrailIdentifier</code> field. If you delete a guardrail, all of its versions will be deleted.</p>
|
|
33
|
+
* </li>
|
|
34
|
+
* <li>
|
|
35
|
+
* <p>To delete a version of a guardrail, specify the ARN of the guardrail in the <code>guardrailIdentifier</code> field and the version in the <code>guardrailVersion</code> field.</p>
|
|
36
|
+
* </li>
|
|
37
|
+
* </ul>
|
|
38
|
+
* @example
|
|
39
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
40
|
+
* ```javascript
|
|
41
|
+
* import { BedrockClient, DeleteGuardrailCommand } from "@aws-sdk/client-bedrock"; // ES Modules import
|
|
42
|
+
* // const { BedrockClient, DeleteGuardrailCommand } = require("@aws-sdk/client-bedrock"); // CommonJS import
|
|
43
|
+
* const client = new BedrockClient(config);
|
|
44
|
+
* const input = { // DeleteGuardrailRequest
|
|
45
|
+
* guardrailIdentifier: "STRING_VALUE", // required
|
|
46
|
+
* guardrailVersion: "STRING_VALUE",
|
|
47
|
+
* };
|
|
48
|
+
* const command = new DeleteGuardrailCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* // {};
|
|
51
|
+
*
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @param DeleteGuardrailCommandInput - {@link DeleteGuardrailCommandInput}
|
|
55
|
+
* @returns {@link DeleteGuardrailCommandOutput}
|
|
56
|
+
* @see {@link DeleteGuardrailCommandInput} for command's `input` shape.
|
|
57
|
+
* @see {@link DeleteGuardrailCommandOutput} for command's `response` shape.
|
|
58
|
+
* @see {@link BedrockClientResolvedConfig | config} for BedrockClient's `config` shape.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
61
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ConflictException} (client fault)
|
|
64
|
+
* <p>Error occurred because of a conflict while performing an operation.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalServerException} (server fault)
|
|
67
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
73
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ValidationException} (client fault)
|
|
76
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link BedrockServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from Bedrock service.</p>
|
|
80
|
+
*
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export declare class DeleteGuardrailCommand extends DeleteGuardrailCommand_base {
|
|
84
|
+
}
|