cdk-lambda-subminute 2.0.437 → 2.0.439
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/.jsii +4 -4
- package/lib/cdk-lambda-subminute.js +3 -3
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/bedrock-2023-04-20.min.json +1059 -90
- package/node_modules/aws-sdk/apis/bedrock-2023-04-20.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/bedrock-agent-2023-06-05.min.json +41 -34
- package/node_modules/aws-sdk/apis/bedrock-agent-runtime-2023-07-26.min.json +68 -7
- package/node_modules/aws-sdk/apis/bedrock-runtime-2023-09-30.min.json +24 -0
- package/node_modules/aws-sdk/apis/ce-2017-10-25.min.json +2 -1
- package/node_modules/aws-sdk/apis/datasync-2018-11-09.min.json +46 -35
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +146 -82
- package/node_modules/aws-sdk/apis/emr-containers-2020-10-01.min.json +182 -19
- package/node_modules/aws-sdk/apis/emr-containers-2020-10-01.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/entityresolution-2018-05-10.min.json +165 -93
- package/node_modules/aws-sdk/apis/gamelift-2015-10-01.min.json +586 -188
- package/node_modules/aws-sdk/apis/gamelift-2015-10-01.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/ssm-2014-11-06.min.json +235 -129
- package/node_modules/aws-sdk/apis/ssm-2014-11-06.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/workspaces-web-2020-07-08.min.json +84 -43
- package/node_modules/aws-sdk/clients/bedrock.d.ts +1082 -118
- package/node_modules/aws-sdk/clients/bedrockagent.d.ts +24 -2
- package/node_modules/aws-sdk/clients/bedrockagentruntime.d.ts +65 -1
- package/node_modules/aws-sdk/clients/bedrockruntime.d.ts +37 -10
- package/node_modules/aws-sdk/clients/costexplorer.d.ts +11 -7
- package/node_modules/aws-sdk/clients/datasync.d.ts +67 -42
- package/node_modules/aws-sdk/clients/ec2.d.ts +112 -40
- package/node_modules/aws-sdk/clients/emrcontainers.d.ts +205 -0
- package/node_modules/aws-sdk/clients/entityresolution.d.ts +64 -0
- package/node_modules/aws-sdk/clients/gamelift.d.ts +592 -88
- package/node_modules/aws-sdk/clients/pi.d.ts +5 -5
- package/node_modules/aws-sdk/clients/rds.d.ts +1 -1
- package/node_modules/aws-sdk/clients/ssm.d.ts +186 -6
- package/node_modules/aws-sdk/clients/workspacesweb.d.ts +89 -23
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +1 -1
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +17 -17
- package/node_modules/aws-sdk/dist/aws-sdk.js +984 -403
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +78 -78
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +2 -2
@@ -12,29 +12,61 @@ declare class Bedrock extends Service {
|
|
12
12
|
constructor(options?: Bedrock.Types.ClientConfiguration)
|
13
13
|
config: Config & Bedrock.Types.ClientConfiguration;
|
14
14
|
/**
|
15
|
-
*
|
15
|
+
* 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, Model evaluations.
|
16
|
+
*/
|
17
|
+
createEvaluationJob(params: Bedrock.Types.CreateEvaluationJobRequest, callback?: (err: AWSError, data: Bedrock.Types.CreateEvaluationJobResponse) => void): Request<Bedrock.Types.CreateEvaluationJobResponse, AWSError>;
|
18
|
+
/**
|
19
|
+
* 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, Model evaluations.
|
20
|
+
*/
|
21
|
+
createEvaluationJob(callback?: (err: AWSError, data: Bedrock.Types.CreateEvaluationJobResponse) => void): Request<Bedrock.Types.CreateEvaluationJobResponse, AWSError>;
|
22
|
+
/**
|
23
|
+
* Creates a guardrail to block topics and to filter out harmful content. Specify a name and optional description. Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields. Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic. Give a name and description so that the guardrail can properly identify the topic. Specify DENY in the type field. (Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list. Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig. Specify the category in the type field. Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig. (Optional) For security, include the ARN of a KMS key in the kmsKeyId field. (Optional) Attach any tags to the guardrail in the tags object. For more information, see Tag resources.
|
24
|
+
*/
|
25
|
+
createGuardrail(params: Bedrock.Types.CreateGuardrailRequest, callback?: (err: AWSError, data: Bedrock.Types.CreateGuardrailResponse) => void): Request<Bedrock.Types.CreateGuardrailResponse, AWSError>;
|
26
|
+
/**
|
27
|
+
* Creates a guardrail to block topics and to filter out harmful content. Specify a name and optional description. Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields. Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic. Give a name and description so that the guardrail can properly identify the topic. Specify DENY in the type field. (Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list. Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig. Specify the category in the type field. Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig. (Optional) For security, include the ARN of a KMS key in the kmsKeyId field. (Optional) Attach any tags to the guardrail in the tags object. For more information, see Tag resources.
|
28
|
+
*/
|
29
|
+
createGuardrail(callback?: (err: AWSError, data: Bedrock.Types.CreateGuardrailResponse) => void): Request<Bedrock.Types.CreateGuardrailResponse, AWSError>;
|
30
|
+
/**
|
31
|
+
* Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.
|
32
|
+
*/
|
33
|
+
createGuardrailVersion(params: Bedrock.Types.CreateGuardrailVersionRequest, callback?: (err: AWSError, data: Bedrock.Types.CreateGuardrailVersionResponse) => void): Request<Bedrock.Types.CreateGuardrailVersionResponse, AWSError>;
|
34
|
+
/**
|
35
|
+
* Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.
|
36
|
+
*/
|
37
|
+
createGuardrailVersion(callback?: (err: AWSError, data: Bedrock.Types.CreateGuardrailVersionResponse) => void): Request<Bedrock.Types.CreateGuardrailVersionResponse, AWSError>;
|
38
|
+
/**
|
39
|
+
* Creates a fine-tuning job to customize a base model. You specify the base foundation model and the location of the training data. 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. For information on the format of training and validation data, see Prepare the datasets. Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status. For more information, see Custom models in the Amazon Bedrock User Guide.
|
16
40
|
*/
|
17
41
|
createModelCustomizationJob(params: Bedrock.Types.CreateModelCustomizationJobRequest, callback?: (err: AWSError, data: Bedrock.Types.CreateModelCustomizationJobResponse) => void): Request<Bedrock.Types.CreateModelCustomizationJobResponse, AWSError>;
|
18
42
|
/**
|
19
|
-
* Creates a fine-tuning job to customize a base model. You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use.
|
43
|
+
* Creates a fine-tuning job to customize a base model. You specify the base foundation model and the location of the training data. 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. For information on the format of training and validation data, see Prepare the datasets. Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status. For more information, see Custom models in the Amazon Bedrock User Guide.
|
20
44
|
*/
|
21
45
|
createModelCustomizationJob(callback?: (err: AWSError, data: Bedrock.Types.CreateModelCustomizationJobResponse) => void): Request<Bedrock.Types.CreateModelCustomizationJobResponse, AWSError>;
|
22
46
|
/**
|
23
|
-
* Creates a
|
47
|
+
* Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
|
24
48
|
*/
|
25
49
|
createProvisionedModelThroughput(params: Bedrock.Types.CreateProvisionedModelThroughputRequest, callback?: (err: AWSError, data: Bedrock.Types.CreateProvisionedModelThroughputResponse) => void): Request<Bedrock.Types.CreateProvisionedModelThroughputResponse, AWSError>;
|
26
50
|
/**
|
27
|
-
* Creates a
|
51
|
+
* Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
|
28
52
|
*/
|
29
53
|
createProvisionedModelThroughput(callback?: (err: AWSError, data: Bedrock.Types.CreateProvisionedModelThroughputResponse) => void): Request<Bedrock.Types.CreateProvisionedModelThroughputResponse, AWSError>;
|
30
54
|
/**
|
31
|
-
* Deletes a custom model that you created earlier. For more information, see Custom models in the Bedrock User Guide.
|
55
|
+
* Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.
|
32
56
|
*/
|
33
57
|
deleteCustomModel(params: Bedrock.Types.DeleteCustomModelRequest, callback?: (err: AWSError, data: Bedrock.Types.DeleteCustomModelResponse) => void): Request<Bedrock.Types.DeleteCustomModelResponse, AWSError>;
|
34
58
|
/**
|
35
|
-
* Deletes a custom model that you created earlier. For more information, see Custom models in the Bedrock User Guide.
|
59
|
+
* Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.
|
36
60
|
*/
|
37
61
|
deleteCustomModel(callback?: (err: AWSError, data: Bedrock.Types.DeleteCustomModelResponse) => void): Request<Bedrock.Types.DeleteCustomModelResponse, AWSError>;
|
62
|
+
/**
|
63
|
+
* Deletes a guardrail. To delete a guardrail, only specify the ARN of the guardrail in the guardrailIdentifier field. If you delete a guardrail, all of its versions will be deleted. To delete a version of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field and the version in the guardrailVersion field.
|
64
|
+
*/
|
65
|
+
deleteGuardrail(params: Bedrock.Types.DeleteGuardrailRequest, callback?: (err: AWSError, data: Bedrock.Types.DeleteGuardrailResponse) => void): Request<Bedrock.Types.DeleteGuardrailResponse, AWSError>;
|
66
|
+
/**
|
67
|
+
* Deletes a guardrail. To delete a guardrail, only specify the ARN of the guardrail in the guardrailIdentifier field. If you delete a guardrail, all of its versions will be deleted. To delete a version of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field and the version in the guardrailVersion field.
|
68
|
+
*/
|
69
|
+
deleteGuardrail(callback?: (err: AWSError, data: Bedrock.Types.DeleteGuardrailResponse) => void): Request<Bedrock.Types.DeleteGuardrailResponse, AWSError>;
|
38
70
|
/**
|
39
71
|
* Delete the invocation logging.
|
40
72
|
*/
|
@@ -44,21 +76,29 @@ declare class Bedrock extends Service {
|
|
44
76
|
*/
|
45
77
|
deleteModelInvocationLoggingConfiguration(callback?: (err: AWSError, data: Bedrock.Types.DeleteModelInvocationLoggingConfigurationResponse) => void): Request<Bedrock.Types.DeleteModelInvocationLoggingConfigurationResponse, AWSError>;
|
46
78
|
/**
|
47
|
-
* Deletes a
|
79
|
+
* Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
|
48
80
|
*/
|
49
81
|
deleteProvisionedModelThroughput(params: Bedrock.Types.DeleteProvisionedModelThroughputRequest, callback?: (err: AWSError, data: Bedrock.Types.DeleteProvisionedModelThroughputResponse) => void): Request<Bedrock.Types.DeleteProvisionedModelThroughputResponse, AWSError>;
|
50
82
|
/**
|
51
|
-
* Deletes a
|
83
|
+
* Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
|
52
84
|
*/
|
53
85
|
deleteProvisionedModelThroughput(callback?: (err: AWSError, data: Bedrock.Types.DeleteProvisionedModelThroughputResponse) => void): Request<Bedrock.Types.DeleteProvisionedModelThroughputResponse, AWSError>;
|
54
86
|
/**
|
55
|
-
* Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.
|
87
|
+
* Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide.
|
56
88
|
*/
|
57
89
|
getCustomModel(params: Bedrock.Types.GetCustomModelRequest, callback?: (err: AWSError, data: Bedrock.Types.GetCustomModelResponse) => void): Request<Bedrock.Types.GetCustomModelResponse, AWSError>;
|
58
90
|
/**
|
59
|
-
* Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.
|
91
|
+
* Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide.
|
60
92
|
*/
|
61
93
|
getCustomModel(callback?: (err: AWSError, data: Bedrock.Types.GetCustomModelResponse) => void): Request<Bedrock.Types.GetCustomModelResponse, AWSError>;
|
94
|
+
/**
|
95
|
+
* Retrieves the properties associated with a model evaluation job, including the status of the job. For more information, see Model evaluations.
|
96
|
+
*/
|
97
|
+
getEvaluationJob(params: Bedrock.Types.GetEvaluationJobRequest, callback?: (err: AWSError, data: Bedrock.Types.GetEvaluationJobResponse) => void): Request<Bedrock.Types.GetEvaluationJobResponse, AWSError>;
|
98
|
+
/**
|
99
|
+
* Retrieves the properties associated with a model evaluation job, including the status of the job. For more information, see Model evaluations.
|
100
|
+
*/
|
101
|
+
getEvaluationJob(callback?: (err: AWSError, data: Bedrock.Types.GetEvaluationJobResponse) => void): Request<Bedrock.Types.GetEvaluationJobResponse, AWSError>;
|
62
102
|
/**
|
63
103
|
* Get details about a Amazon Bedrock foundation model.
|
64
104
|
*/
|
@@ -68,11 +108,19 @@ declare class Bedrock extends Service {
|
|
68
108
|
*/
|
69
109
|
getFoundationModel(callback?: (err: AWSError, data: Bedrock.Types.GetFoundationModelResponse) => void): Request<Bedrock.Types.GetFoundationModelResponse, AWSError>;
|
70
110
|
/**
|
71
|
-
*
|
111
|
+
* Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.
|
112
|
+
*/
|
113
|
+
getGuardrail(params: Bedrock.Types.GetGuardrailRequest, callback?: (err: AWSError, data: Bedrock.Types.GetGuardrailResponse) => void): Request<Bedrock.Types.GetGuardrailResponse, AWSError>;
|
114
|
+
/**
|
115
|
+
* Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.
|
116
|
+
*/
|
117
|
+
getGuardrail(callback?: (err: AWSError, data: Bedrock.Types.GetGuardrailResponse) => void): Request<Bedrock.Types.GetGuardrailResponse, AWSError>;
|
118
|
+
/**
|
119
|
+
* Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models in the Amazon Bedrock User Guide.
|
72
120
|
*/
|
73
121
|
getModelCustomizationJob(params: Bedrock.Types.GetModelCustomizationJobRequest, callback?: (err: AWSError, data: Bedrock.Types.GetModelCustomizationJobResponse) => void): Request<Bedrock.Types.GetModelCustomizationJobResponse, AWSError>;
|
74
122
|
/**
|
75
|
-
* Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models in the Bedrock User Guide.
|
123
|
+
* Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models in the Amazon Bedrock User Guide.
|
76
124
|
*/
|
77
125
|
getModelCustomizationJob(callback?: (err: AWSError, data: Bedrock.Types.GetModelCustomizationJobResponse) => void): Request<Bedrock.Types.GetModelCustomizationJobResponse, AWSError>;
|
78
126
|
/**
|
@@ -84,51 +132,67 @@ declare class Bedrock extends Service {
|
|
84
132
|
*/
|
85
133
|
getModelInvocationLoggingConfiguration(callback?: (err: AWSError, data: Bedrock.Types.GetModelInvocationLoggingConfigurationResponse) => void): Request<Bedrock.Types.GetModelInvocationLoggingConfigurationResponse, AWSError>;
|
86
134
|
/**
|
87
|
-
*
|
135
|
+
* Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
|
88
136
|
*/
|
89
137
|
getProvisionedModelThroughput(params: Bedrock.Types.GetProvisionedModelThroughputRequest, callback?: (err: AWSError, data: Bedrock.Types.GetProvisionedModelThroughputResponse) => void): Request<Bedrock.Types.GetProvisionedModelThroughputResponse, AWSError>;
|
90
138
|
/**
|
91
|
-
*
|
139
|
+
* Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
|
92
140
|
*/
|
93
141
|
getProvisionedModelThroughput(callback?: (err: AWSError, data: Bedrock.Types.GetProvisionedModelThroughputResponse) => void): Request<Bedrock.Types.GetProvisionedModelThroughputResponse, AWSError>;
|
94
142
|
/**
|
95
|
-
* Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation. For more information, see Custom models in the Bedrock User Guide.
|
143
|
+
* Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation. For more information, see Custom models in the Amazon Bedrock User Guide.
|
96
144
|
*/
|
97
145
|
listCustomModels(params: Bedrock.Types.ListCustomModelsRequest, callback?: (err: AWSError, data: Bedrock.Types.ListCustomModelsResponse) => void): Request<Bedrock.Types.ListCustomModelsResponse, AWSError>;
|
98
146
|
/**
|
99
|
-
* Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation. For more information, see Custom models in the Bedrock User Guide.
|
147
|
+
* Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation. For more information, see Custom models in the Amazon Bedrock User Guide.
|
100
148
|
*/
|
101
149
|
listCustomModels(callback?: (err: AWSError, data: Bedrock.Types.ListCustomModelsResponse) => void): Request<Bedrock.Types.ListCustomModelsResponse, AWSError>;
|
102
150
|
/**
|
103
|
-
*
|
151
|
+
* Lists model evaluation jobs.
|
152
|
+
*/
|
153
|
+
listEvaluationJobs(params: Bedrock.Types.ListEvaluationJobsRequest, callback?: (err: AWSError, data: Bedrock.Types.ListEvaluationJobsResponse) => void): Request<Bedrock.Types.ListEvaluationJobsResponse, AWSError>;
|
154
|
+
/**
|
155
|
+
* Lists model evaluation jobs.
|
156
|
+
*/
|
157
|
+
listEvaluationJobs(callback?: (err: AWSError, data: Bedrock.Types.ListEvaluationJobsResponse) => void): Request<Bedrock.Types.ListEvaluationJobsResponse, AWSError>;
|
158
|
+
/**
|
159
|
+
* Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.
|
104
160
|
*/
|
105
161
|
listFoundationModels(params: Bedrock.Types.ListFoundationModelsRequest, callback?: (err: AWSError, data: Bedrock.Types.ListFoundationModelsResponse) => void): Request<Bedrock.Types.ListFoundationModelsResponse, AWSError>;
|
106
162
|
/**
|
107
|
-
*
|
163
|
+
* Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.
|
108
164
|
*/
|
109
165
|
listFoundationModels(callback?: (err: AWSError, data: Bedrock.Types.ListFoundationModelsResponse) => void): Request<Bedrock.Types.ListFoundationModelsResponse, AWSError>;
|
110
166
|
/**
|
111
|
-
*
|
167
|
+
* Lists details about all the guardrails in an account. To list the DRAFT version of all your guardrails, don't specify the guardrailIdentifier field. To list all versions of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field. You can set the maximum number of results to return in a response in the maxResults field. If there are more results than the number you set, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.
|
168
|
+
*/
|
169
|
+
listGuardrails(params: Bedrock.Types.ListGuardrailsRequest, callback?: (err: AWSError, data: Bedrock.Types.ListGuardrailsResponse) => void): Request<Bedrock.Types.ListGuardrailsResponse, AWSError>;
|
170
|
+
/**
|
171
|
+
* Lists details about all the guardrails in an account. To list the DRAFT version of all your guardrails, don't specify the guardrailIdentifier field. To list all versions of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field. You can set the maximum number of results to return in a response in the maxResults field. If there are more results than the number you set, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.
|
172
|
+
*/
|
173
|
+
listGuardrails(callback?: (err: AWSError, data: Bedrock.Types.ListGuardrailsResponse) => void): Request<Bedrock.Types.ListGuardrailsResponse, AWSError>;
|
174
|
+
/**
|
175
|
+
* Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see Custom models in the Amazon Bedrock User Guide.
|
112
176
|
*/
|
113
177
|
listModelCustomizationJobs(params: Bedrock.Types.ListModelCustomizationJobsRequest, callback?: (err: AWSError, data: Bedrock.Types.ListModelCustomizationJobsResponse) => void): Request<Bedrock.Types.ListModelCustomizationJobsResponse, AWSError>;
|
114
178
|
/**
|
115
|
-
* Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see Custom models in the Bedrock User Guide.
|
179
|
+
* Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see Custom models in the Amazon Bedrock User Guide.
|
116
180
|
*/
|
117
181
|
listModelCustomizationJobs(callback?: (err: AWSError, data: Bedrock.Types.ListModelCustomizationJobsResponse) => void): Request<Bedrock.Types.ListModelCustomizationJobsResponse, AWSError>;
|
118
182
|
/**
|
119
|
-
*
|
183
|
+
* Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
|
120
184
|
*/
|
121
185
|
listProvisionedModelThroughputs(params: Bedrock.Types.ListProvisionedModelThroughputsRequest, callback?: (err: AWSError, data: Bedrock.Types.ListProvisionedModelThroughputsResponse) => void): Request<Bedrock.Types.ListProvisionedModelThroughputsResponse, AWSError>;
|
122
186
|
/**
|
123
|
-
*
|
187
|
+
* Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
|
124
188
|
*/
|
125
189
|
listProvisionedModelThroughputs(callback?: (err: AWSError, data: Bedrock.Types.ListProvisionedModelThroughputsResponse) => void): Request<Bedrock.Types.ListProvisionedModelThroughputsResponse, AWSError>;
|
126
190
|
/**
|
127
|
-
* List the tags associated with the specified resource. For more information, see Tagging resources in the Bedrock User Guide.
|
191
|
+
* List the tags associated with the specified resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
|
128
192
|
*/
|
129
193
|
listTagsForResource(params: Bedrock.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Bedrock.Types.ListTagsForResourceResponse) => void): Request<Bedrock.Types.ListTagsForResourceResponse, AWSError>;
|
130
194
|
/**
|
131
|
-
* List the tags associated with the specified resource. For more information, see Tagging resources in the Bedrock User Guide.
|
195
|
+
* List the tags associated with the specified resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
|
132
196
|
*/
|
133
197
|
listTagsForResource(callback?: (err: AWSError, data: Bedrock.Types.ListTagsForResourceResponse) => void): Request<Bedrock.Types.ListTagsForResourceResponse, AWSError>;
|
134
198
|
/**
|
@@ -140,39 +204,61 @@ declare class Bedrock extends Service {
|
|
140
204
|
*/
|
141
205
|
putModelInvocationLoggingConfiguration(callback?: (err: AWSError, data: Bedrock.Types.PutModelInvocationLoggingConfigurationResponse) => void): Request<Bedrock.Types.PutModelInvocationLoggingConfigurationResponse, AWSError>;
|
142
206
|
/**
|
143
|
-
* Stops an
|
207
|
+
* Stops an in progress model evaluation job.
|
208
|
+
*/
|
209
|
+
stopEvaluationJob(params: Bedrock.Types.StopEvaluationJobRequest, callback?: (err: AWSError, data: Bedrock.Types.StopEvaluationJobResponse) => void): Request<Bedrock.Types.StopEvaluationJobResponse, AWSError>;
|
210
|
+
/**
|
211
|
+
* Stops an in progress model evaluation job.
|
212
|
+
*/
|
213
|
+
stopEvaluationJob(callback?: (err: AWSError, data: Bedrock.Types.StopEvaluationJobResponse) => void): Request<Bedrock.Types.StopEvaluationJobResponse, AWSError>;
|
214
|
+
/**
|
215
|
+
* Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.
|
144
216
|
*/
|
145
217
|
stopModelCustomizationJob(params: Bedrock.Types.StopModelCustomizationJobRequest, callback?: (err: AWSError, data: Bedrock.Types.StopModelCustomizationJobResponse) => void): Request<Bedrock.Types.StopModelCustomizationJobResponse, AWSError>;
|
146
218
|
/**
|
147
|
-
* Stops an active model customization job. For more information, see Custom models in the Bedrock User Guide.
|
219
|
+
* Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.
|
148
220
|
*/
|
149
221
|
stopModelCustomizationJob(callback?: (err: AWSError, data: Bedrock.Types.StopModelCustomizationJobResponse) => void): Request<Bedrock.Types.StopModelCustomizationJobResponse, AWSError>;
|
150
222
|
/**
|
151
|
-
* Associate tags with a resource. For more information, see Tagging resources in the Bedrock User Guide.
|
223
|
+
* Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
|
152
224
|
*/
|
153
225
|
tagResource(params: Bedrock.Types.TagResourceRequest, callback?: (err: AWSError, data: Bedrock.Types.TagResourceResponse) => void): Request<Bedrock.Types.TagResourceResponse, AWSError>;
|
154
226
|
/**
|
155
|
-
* Associate tags with a resource. For more information, see Tagging resources in the Bedrock User Guide.
|
227
|
+
* Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
|
156
228
|
*/
|
157
229
|
tagResource(callback?: (err: AWSError, data: Bedrock.Types.TagResourceResponse) => void): Request<Bedrock.Types.TagResourceResponse, AWSError>;
|
158
230
|
/**
|
159
|
-
* Remove one or more tags from a resource. For more information, see Tagging resources in the Bedrock User Guide.
|
231
|
+
* Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
|
160
232
|
*/
|
161
233
|
untagResource(params: Bedrock.Types.UntagResourceRequest, callback?: (err: AWSError, data: Bedrock.Types.UntagResourceResponse) => void): Request<Bedrock.Types.UntagResourceResponse, AWSError>;
|
162
234
|
/**
|
163
|
-
* Remove one or more tags from a resource. For more information, see Tagging resources in the Bedrock User Guide.
|
235
|
+
* Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
|
164
236
|
*/
|
165
237
|
untagResource(callback?: (err: AWSError, data: Bedrock.Types.UntagResourceResponse) => void): Request<Bedrock.Types.UntagResourceResponse, AWSError>;
|
166
238
|
/**
|
167
|
-
*
|
239
|
+
* Updates a guardrail with the values you specify. Specify a name and optional description. Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields. Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic. Give a name and description so that the guardrail can properly identify the topic. Specify DENY in the type field. (Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list. Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig. Specify the category in the type field. Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig. (Optional) For security, include the ARN of a KMS key in the kmsKeyId field. (Optional) Attach any tags to the guardrail in the tags object. For more information, see Tag resources.
|
240
|
+
*/
|
241
|
+
updateGuardrail(params: Bedrock.Types.UpdateGuardrailRequest, callback?: (err: AWSError, data: Bedrock.Types.UpdateGuardrailResponse) => void): Request<Bedrock.Types.UpdateGuardrailResponse, AWSError>;
|
242
|
+
/**
|
243
|
+
* Updates a guardrail with the values you specify. Specify a name and optional description. Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields. Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic. Give a name and description so that the guardrail can properly identify the topic. Specify DENY in the type field. (Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list. Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig. Specify the category in the type field. Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig. (Optional) For security, include the ARN of a KMS key in the kmsKeyId field. (Optional) Attach any tags to the guardrail in the tags object. For more information, see Tag resources.
|
244
|
+
*/
|
245
|
+
updateGuardrail(callback?: (err: AWSError, data: Bedrock.Types.UpdateGuardrailResponse) => void): Request<Bedrock.Types.UpdateGuardrailResponse, AWSError>;
|
246
|
+
/**
|
247
|
+
* Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
|
168
248
|
*/
|
169
249
|
updateProvisionedModelThroughput(params: Bedrock.Types.UpdateProvisionedModelThroughputRequest, callback?: (err: AWSError, data: Bedrock.Types.UpdateProvisionedModelThroughputResponse) => void): Request<Bedrock.Types.UpdateProvisionedModelThroughputResponse, AWSError>;
|
170
250
|
/**
|
171
|
-
*
|
251
|
+
* Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
|
172
252
|
*/
|
173
253
|
updateProvisionedModelThroughput(callback?: (err: AWSError, data: Bedrock.Types.UpdateProvisionedModelThroughputResponse) => void): Request<Bedrock.Types.UpdateProvisionedModelThroughputResponse, AWSError>;
|
174
254
|
}
|
175
255
|
declare namespace Bedrock {
|
256
|
+
export interface AutomatedEvaluationConfig {
|
257
|
+
/**
|
258
|
+
* Specifies the required elements for an automatic model evaluation job.
|
259
|
+
*/
|
260
|
+
datasetMetricConfigs: EvaluationDatasetMetricConfigs;
|
261
|
+
}
|
176
262
|
export type BaseModelIdentifier = string;
|
177
263
|
export type BedrockModelId = string;
|
178
264
|
export type Boolean = boolean;
|
@@ -184,7 +270,7 @@ declare namespace Bedrock {
|
|
184
270
|
*/
|
185
271
|
logGroupName: LogGroupName;
|
186
272
|
/**
|
187
|
-
* The role ARN.
|
273
|
+
* The role Amazon Resource Name (ARN).
|
188
274
|
*/
|
189
275
|
roleArn: RoleArn;
|
190
276
|
/**
|
@@ -193,21 +279,153 @@ declare namespace Bedrock {
|
|
193
279
|
largeDataDeliveryS3Config?: S3Config;
|
194
280
|
}
|
195
281
|
export type CommitmentDuration = "OneMonth"|"SixMonths"|string;
|
282
|
+
export interface CreateEvaluationJobRequest {
|
283
|
+
/**
|
284
|
+
* The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.
|
285
|
+
*/
|
286
|
+
jobName: EvaluationJobName;
|
287
|
+
/**
|
288
|
+
* A description of the model evaluation job.
|
289
|
+
*/
|
290
|
+
jobDescription?: EvaluationJobDescription;
|
291
|
+
/**
|
292
|
+
* 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 Ensuring idempotency.
|
293
|
+
*/
|
294
|
+
clientRequestToken?: IdempotencyToken;
|
295
|
+
/**
|
296
|
+
* The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions.
|
297
|
+
*/
|
298
|
+
roleArn: RoleArn;
|
299
|
+
/**
|
300
|
+
* Specify your customer managed key ARN that will be used to encrypt your model evaluation job.
|
301
|
+
*/
|
302
|
+
customerEncryptionKeyId?: KmsKeyId;
|
303
|
+
/**
|
304
|
+
* Tags to attach to the model evaluation job.
|
305
|
+
*/
|
306
|
+
jobTags?: TagList;
|
307
|
+
/**
|
308
|
+
* Specifies whether the model evaluation job is automatic or uses human worker.
|
309
|
+
*/
|
310
|
+
evaluationConfig: EvaluationConfig;
|
311
|
+
/**
|
312
|
+
* Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.
|
313
|
+
*/
|
314
|
+
inferenceConfig: EvaluationInferenceConfig;
|
315
|
+
/**
|
316
|
+
* An object that defines where the results of model evaluation job will be saved in Amazon S3.
|
317
|
+
*/
|
318
|
+
outputDataConfig: EvaluationOutputDataConfig;
|
319
|
+
}
|
320
|
+
export interface CreateEvaluationJobResponse {
|
321
|
+
/**
|
322
|
+
* The ARN of the model evaluation job.
|
323
|
+
*/
|
324
|
+
jobArn: EvaluationJobArn;
|
325
|
+
}
|
326
|
+
export interface CreateGuardrailRequest {
|
327
|
+
/**
|
328
|
+
* The name to give the guardrail.
|
329
|
+
*/
|
330
|
+
name: GuardrailName;
|
331
|
+
/**
|
332
|
+
* A description of the guardrail.
|
333
|
+
*/
|
334
|
+
description?: GuardrailDescription;
|
335
|
+
/**
|
336
|
+
* The topic policies to configure for the guardrail.
|
337
|
+
*/
|
338
|
+
topicPolicyConfig?: GuardrailTopicPolicyConfig;
|
339
|
+
/**
|
340
|
+
* The content filter policies to configure for the guardrail.
|
341
|
+
*/
|
342
|
+
contentPolicyConfig?: GuardrailContentPolicyConfig;
|
343
|
+
/**
|
344
|
+
* The word policy you configure for the guardrail.
|
345
|
+
*/
|
346
|
+
wordPolicyConfig?: GuardrailWordPolicyConfig;
|
347
|
+
/**
|
348
|
+
* The sensitive information policy to configure for the guardrail.
|
349
|
+
*/
|
350
|
+
sensitiveInformationPolicyConfig?: GuardrailSensitiveInformationPolicyConfig;
|
351
|
+
/**
|
352
|
+
* The message to return when the guardrail blocks a prompt.
|
353
|
+
*/
|
354
|
+
blockedInputMessaging: GuardrailBlockedMessaging;
|
355
|
+
/**
|
356
|
+
* The message to return when the guardrail blocks a model response.
|
357
|
+
*/
|
358
|
+
blockedOutputsMessaging: GuardrailBlockedMessaging;
|
359
|
+
/**
|
360
|
+
* The ARN of the KMS key that you use to encrypt the guardrail.
|
361
|
+
*/
|
362
|
+
kmsKeyId?: KmsKeyId;
|
363
|
+
/**
|
364
|
+
* The tags that you want to attach to the guardrail.
|
365
|
+
*/
|
366
|
+
tags?: TagList;
|
367
|
+
/**
|
368
|
+
* 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 Ensuring idempotency in the Amazon S3 User Guide.
|
369
|
+
*/
|
370
|
+
clientRequestToken?: IdempotencyToken;
|
371
|
+
}
|
372
|
+
export interface CreateGuardrailResponse {
|
373
|
+
/**
|
374
|
+
* The unique identifier of the guardrail that was created.
|
375
|
+
*/
|
376
|
+
guardrailId: GuardrailId;
|
377
|
+
/**
|
378
|
+
* The ARN of the guardrail that was created.
|
379
|
+
*/
|
380
|
+
guardrailArn: GuardrailArn;
|
381
|
+
/**
|
382
|
+
* The version of the guardrail that was created. This value should be 1.
|
383
|
+
*/
|
384
|
+
version: GuardrailDraftVersion;
|
385
|
+
/**
|
386
|
+
* The time at which the guardrail was created.
|
387
|
+
*/
|
388
|
+
createdAt: Timestamp;
|
389
|
+
}
|
390
|
+
export interface CreateGuardrailVersionRequest {
|
391
|
+
/**
|
392
|
+
* The unique identifier of the guardrail.
|
393
|
+
*/
|
394
|
+
guardrailIdentifier: GuardrailIdentifier;
|
395
|
+
/**
|
396
|
+
* A description of the guardrail version.
|
397
|
+
*/
|
398
|
+
description?: GuardrailDescription;
|
399
|
+
/**
|
400
|
+
* 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 Ensuring idempotency in the Amazon S3 User Guide.
|
401
|
+
*/
|
402
|
+
clientRequestToken?: IdempotencyToken;
|
403
|
+
}
|
404
|
+
export interface CreateGuardrailVersionResponse {
|
405
|
+
/**
|
406
|
+
* The unique identifier of the guardrail.
|
407
|
+
*/
|
408
|
+
guardrailId: GuardrailId;
|
409
|
+
/**
|
410
|
+
* The number of the version of the guardrail.
|
411
|
+
*/
|
412
|
+
version: GuardrailNumericalVersion;
|
413
|
+
}
|
196
414
|
export interface CreateModelCustomizationJobRequest {
|
197
415
|
/**
|
198
|
-
*
|
416
|
+
* A name for the fine-tuning job.
|
199
417
|
*/
|
200
418
|
jobName: JobName;
|
201
419
|
/**
|
202
|
-
*
|
420
|
+
* A name for the resulting custom model.
|
203
421
|
*/
|
204
422
|
customModelName: CustomModelName;
|
205
423
|
/**
|
206
|
-
* The Amazon Resource Name (ARN) of an IAM role that Amazon Bedrock can assume to perform tasks on your behalf. For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.
|
424
|
+
* The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.
|
207
425
|
*/
|
208
426
|
roleArn: RoleArn;
|
209
427
|
/**
|
210
|
-
*
|
428
|
+
* 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 Ensuring idempotency.
|
211
429
|
*/
|
212
430
|
clientRequestToken?: IdempotencyToken;
|
213
431
|
/**
|
@@ -223,11 +441,11 @@ declare namespace Bedrock {
|
|
223
441
|
*/
|
224
442
|
customModelKmsKeyId?: KmsKeyId;
|
225
443
|
/**
|
226
|
-
*
|
444
|
+
* Tags to attach to the job.
|
227
445
|
*/
|
228
446
|
jobTags?: TagList;
|
229
447
|
/**
|
230
|
-
*
|
448
|
+
* Tags to attach to the resulting custom model.
|
231
449
|
*/
|
232
450
|
customModelTags?: TagList;
|
233
451
|
/**
|
@@ -243,7 +461,7 @@ declare namespace Bedrock {
|
|
243
461
|
*/
|
244
462
|
outputDataConfig: OutputDataConfig;
|
245
463
|
/**
|
246
|
-
* Parameters related to tuning the model.
|
464
|
+
* Parameters related to tuning the model. For details on the format for different models, see Custom model hyperparameters.
|
247
465
|
*/
|
248
466
|
hyperParameters: ModelCustomizationHyperParameters;
|
249
467
|
/**
|
@@ -253,39 +471,39 @@ declare namespace Bedrock {
|
|
253
471
|
}
|
254
472
|
export interface CreateModelCustomizationJobResponse {
|
255
473
|
/**
|
256
|
-
* ARN of the fine tuning job
|
474
|
+
* Amazon Resource Name (ARN) of the fine tuning job
|
257
475
|
*/
|
258
476
|
jobArn: ModelCustomizationJobArn;
|
259
477
|
}
|
260
478
|
export interface CreateProvisionedModelThroughputRequest {
|
261
479
|
/**
|
262
|
-
*
|
480
|
+
* 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 Ensuring idempotency in the Amazon S3 User Guide.
|
263
481
|
*/
|
264
482
|
clientRequestToken?: IdempotencyToken;
|
265
483
|
/**
|
266
|
-
* Number of model units to allocate.
|
484
|
+
* Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the Amazon Web Services support center to request MUs. For model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide. For more information about what an MU specifies, contact your Amazon Web Services account manager.
|
267
485
|
*/
|
268
486
|
modelUnits: PositiveInteger;
|
269
487
|
/**
|
270
|
-
*
|
488
|
+
* The name for this Provisioned Throughput.
|
271
489
|
*/
|
272
490
|
provisionedModelName: ProvisionedModelName;
|
273
491
|
/**
|
274
|
-
* Name or
|
492
|
+
* The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see Amazon Bedrock model IDs for purchasing Provisioned Throughput in the Amazon Bedrock User Guide.
|
275
493
|
*/
|
276
494
|
modelId: ModelIdentifier;
|
277
495
|
/**
|
278
|
-
*
|
496
|
+
* The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field. Custom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide
|
279
497
|
*/
|
280
498
|
commitmentDuration?: CommitmentDuration;
|
281
499
|
/**
|
282
|
-
* Tags to associate with this
|
500
|
+
* Tags to associate with this Provisioned Throughput.
|
283
501
|
*/
|
284
502
|
tags?: TagList;
|
285
503
|
}
|
286
504
|
export interface CreateProvisionedModelThroughputResponse {
|
287
505
|
/**
|
288
|
-
* The ARN for this
|
506
|
+
* The Amazon Resource Name (ARN) for this Provisioned Throughput.
|
289
507
|
*/
|
290
508
|
provisionedModelArn: ProvisionedModelArn;
|
291
509
|
}
|
@@ -293,7 +511,7 @@ declare namespace Bedrock {
|
|
293
511
|
export type CustomModelName = string;
|
294
512
|
export interface CustomModelSummary {
|
295
513
|
/**
|
296
|
-
* The ARN of the custom model.
|
514
|
+
* The Amazon Resource Name (ARN) of the custom model.
|
297
515
|
*/
|
298
516
|
modelArn: CustomModelArn;
|
299
517
|
/**
|
@@ -305,7 +523,7 @@ declare namespace Bedrock {
|
|
305
523
|
*/
|
306
524
|
creationTime: Timestamp;
|
307
525
|
/**
|
308
|
-
* The base model ARN.
|
526
|
+
* The base model Amazon Resource Name (ARN).
|
309
527
|
*/
|
310
528
|
baseModelArn: ModelArn;
|
311
529
|
/**
|
@@ -327,24 +545,154 @@ declare namespace Bedrock {
|
|
327
545
|
}
|
328
546
|
export interface DeleteCustomModelResponse {
|
329
547
|
}
|
548
|
+
export interface DeleteGuardrailRequest {
|
549
|
+
/**
|
550
|
+
* The unique identifier of the guardrail.
|
551
|
+
*/
|
552
|
+
guardrailIdentifier: GuardrailIdentifier;
|
553
|
+
/**
|
554
|
+
* The version of the guardrail.
|
555
|
+
*/
|
556
|
+
guardrailVersion?: GuardrailNumericalVersion;
|
557
|
+
}
|
558
|
+
export interface DeleteGuardrailResponse {
|
559
|
+
}
|
330
560
|
export interface DeleteModelInvocationLoggingConfigurationRequest {
|
331
561
|
}
|
332
562
|
export interface DeleteModelInvocationLoggingConfigurationResponse {
|
333
563
|
}
|
334
564
|
export interface DeleteProvisionedModelThroughputRequest {
|
335
565
|
/**
|
336
|
-
* The ARN or name of the
|
566
|
+
* The Amazon Resource Name (ARN) or name of the Provisioned Throughput.
|
337
567
|
*/
|
338
568
|
provisionedModelId: ProvisionedModelId;
|
339
569
|
}
|
340
570
|
export interface DeleteProvisionedModelThroughputResponse {
|
341
571
|
}
|
342
572
|
export type ErrorMessage = string;
|
573
|
+
export type ErrorMessages = ErrorMessage[];
|
574
|
+
export interface EvaluationBedrockModel {
|
575
|
+
/**
|
576
|
+
* The ARN of the Amazon Bedrock model specified.
|
577
|
+
*/
|
578
|
+
modelIdentifier: EvaluationModelIdentifier;
|
579
|
+
/**
|
580
|
+
* Each Amazon Bedrock support different inference parameters that change how the model behaves during inference.
|
581
|
+
*/
|
582
|
+
inferenceParams: EvaluationModelInferenceParams;
|
583
|
+
}
|
584
|
+
export interface EvaluationConfig {
|
585
|
+
/**
|
586
|
+
* Used to specify an automated model evaluation job. See AutomatedEvaluationConfig to view the required parameters.
|
587
|
+
*/
|
588
|
+
automated?: AutomatedEvaluationConfig;
|
589
|
+
/**
|
590
|
+
* Used to specify a model evaluation job that uses human workers.See HumanEvaluationConfig to view the required parameters.
|
591
|
+
*/
|
592
|
+
human?: HumanEvaluationConfig;
|
593
|
+
}
|
594
|
+
export interface EvaluationDataset {
|
595
|
+
/**
|
596
|
+
* Used to specify supported built-in prompt datasets. Valid values are Builtin.Bold, Builtin.BoolQ, Builtin.NaturalQuestions, Builtin.Gigaword, Builtin.RealToxicityPrompts, Builtin.TriviaQa, Builtin.T-Rex, Builtin.WomensEcommerceClothingReviews and Builtin.Wikitext2.
|
597
|
+
*/
|
598
|
+
name: EvaluationDatasetName;
|
599
|
+
/**
|
600
|
+
* For custom prompt datasets, you must specify the location in Amazon S3 where the prompt dataset is saved.
|
601
|
+
*/
|
602
|
+
datasetLocation?: EvaluationDatasetLocation;
|
603
|
+
}
|
604
|
+
export interface EvaluationDatasetLocation {
|
605
|
+
/**
|
606
|
+
* The S3 URI of the S3 bucket specified in the job.
|
607
|
+
*/
|
608
|
+
s3Uri?: S3Uri;
|
609
|
+
}
|
610
|
+
export interface EvaluationDatasetMetricConfig {
|
611
|
+
/**
|
612
|
+
* The task type you want the model to carry out.
|
613
|
+
*/
|
614
|
+
taskType: EvaluationTaskType;
|
615
|
+
/**
|
616
|
+
* Specifies the prompt dataset.
|
617
|
+
*/
|
618
|
+
dataset: EvaluationDataset;
|
619
|
+
/**
|
620
|
+
* The names of the metrics used. For automated model evaluation jobs valid values are "Builtin.Accuracy", "Builtin.Robustness", and "Builtin.Toxicity". In human-based model evaluation jobs the array of strings must match the name parameter specified in HumanEvaluationCustomMetric.
|
621
|
+
*/
|
622
|
+
metricNames: EvaluationMetricNames;
|
623
|
+
}
|
624
|
+
export type EvaluationDatasetMetricConfigs = EvaluationDatasetMetricConfig[];
|
625
|
+
export type EvaluationDatasetName = string;
|
626
|
+
export interface EvaluationInferenceConfig {
|
627
|
+
/**
|
628
|
+
* Used to specify the models.
|
629
|
+
*/
|
630
|
+
models?: EvaluationModelConfigs;
|
631
|
+
}
|
632
|
+
export type EvaluationJobArn = string;
|
633
|
+
export type EvaluationJobDescription = string;
|
634
|
+
export type EvaluationJobIdentifier = string;
|
635
|
+
export type EvaluationJobName = string;
|
636
|
+
export type EvaluationJobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|string;
|
637
|
+
export type EvaluationJobType = "Human"|"Automated"|string;
|
638
|
+
export type EvaluationMetricDescription = string;
|
639
|
+
export type EvaluationMetricName = string;
|
640
|
+
export type EvaluationMetricNames = EvaluationMetricName[];
|
641
|
+
export interface EvaluationModelConfig {
|
642
|
+
/**
|
643
|
+
* Defines the Amazon Bedrock model and inference parameters you want used.
|
644
|
+
*/
|
645
|
+
bedrockModel?: EvaluationBedrockModel;
|
646
|
+
}
|
647
|
+
export type EvaluationModelConfigs = EvaluationModelConfig[];
|
648
|
+
export type EvaluationModelIdentifier = string;
|
649
|
+
export type EvaluationModelIdentifiers = EvaluationModelIdentifier[];
|
650
|
+
export type EvaluationModelInferenceParams = string;
|
651
|
+
export interface EvaluationOutputDataConfig {
|
652
|
+
/**
|
653
|
+
* The Amazon S3 URI where the results of model evaluation job are saved.
|
654
|
+
*/
|
655
|
+
s3Uri: S3Uri;
|
656
|
+
}
|
657
|
+
export type EvaluationRatingMethod = string;
|
658
|
+
export type EvaluationSummaries = EvaluationSummary[];
|
659
|
+
export interface EvaluationSummary {
|
660
|
+
/**
|
661
|
+
* The Amazon Resource Name (ARN) of the model evaluation job.
|
662
|
+
*/
|
663
|
+
jobArn: EvaluationJobArn;
|
664
|
+
/**
|
665
|
+
* The name of the model evaluation job.
|
666
|
+
*/
|
667
|
+
jobName: EvaluationJobName;
|
668
|
+
/**
|
669
|
+
* The current status of the model evaluation job.
|
670
|
+
*/
|
671
|
+
status: EvaluationJobStatus;
|
672
|
+
/**
|
673
|
+
* When the model evaluation job was created.
|
674
|
+
*/
|
675
|
+
creationTime: Timestamp;
|
676
|
+
/**
|
677
|
+
* The type, either human or automatic, of model evaluation job.
|
678
|
+
*/
|
679
|
+
jobType: EvaluationJobType;
|
680
|
+
/**
|
681
|
+
* What task type was used in the model evaluation job.
|
682
|
+
*/
|
683
|
+
evaluationTaskTypes: EvaluationTaskTypes;
|
684
|
+
/**
|
685
|
+
* The Amazon Resource Names (ARNs) of the model(s) used in the model evaluation job.
|
686
|
+
*/
|
687
|
+
modelIdentifiers: EvaluationModelIdentifiers;
|
688
|
+
}
|
689
|
+
export type EvaluationTaskType = "Summarization"|"Classification"|"QuestionAndAnswer"|"Generation"|"Custom"|string;
|
690
|
+
export type EvaluationTaskTypes = EvaluationTaskType[];
|
343
691
|
export type FineTuningJobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|string;
|
344
692
|
export type FoundationModelArn = string;
|
345
693
|
export interface FoundationModelDetails {
|
346
694
|
/**
|
347
|
-
* The model ARN.
|
695
|
+
* The model Amazon Resource Name (ARN).
|
348
696
|
*/
|
349
697
|
modelArn: FoundationModelArn;
|
350
698
|
/**
|
@@ -356,7 +704,7 @@ declare namespace Bedrock {
|
|
356
704
|
*/
|
357
705
|
modelName?: BrandedName;
|
358
706
|
/**
|
359
|
-
*
|
707
|
+
* The model's provider name.
|
360
708
|
*/
|
361
709
|
providerName?: BrandedName;
|
362
710
|
/**
|
@@ -393,11 +741,11 @@ declare namespace Bedrock {
|
|
393
741
|
export type FoundationModelLifecycleStatus = "ACTIVE"|"LEGACY"|string;
|
394
742
|
export interface FoundationModelSummary {
|
395
743
|
/**
|
396
|
-
* The ARN of the foundation model.
|
744
|
+
* The Amazon Resource Name (ARN) of the foundation model.
|
397
745
|
*/
|
398
746
|
modelArn: FoundationModelArn;
|
399
747
|
/**
|
400
|
-
* The model
|
748
|
+
* The model ID of the foundation model.
|
401
749
|
*/
|
402
750
|
modelId: BedrockModelId;
|
403
751
|
/**
|
@@ -436,13 +784,13 @@ declare namespace Bedrock {
|
|
436
784
|
export type FoundationModelSummaryList = FoundationModelSummary[];
|
437
785
|
export interface GetCustomModelRequest {
|
438
786
|
/**
|
439
|
-
* Name or ARN of the custom model.
|
787
|
+
* Name or Amazon Resource Name (ARN) of the custom model.
|
440
788
|
*/
|
441
789
|
modelIdentifier: ModelIdentifier;
|
442
790
|
}
|
443
791
|
export interface GetCustomModelResponse {
|
444
792
|
/**
|
445
|
-
* ARN associated with this model.
|
793
|
+
* Amazon Resource Name (ARN) associated with this model.
|
446
794
|
*/
|
447
795
|
modelArn: ModelArn;
|
448
796
|
/**
|
@@ -454,11 +802,11 @@ declare namespace Bedrock {
|
|
454
802
|
*/
|
455
803
|
jobName?: JobName;
|
456
804
|
/**
|
457
|
-
* Job ARN associated with this model.
|
805
|
+
* Job Amazon Resource Name (ARN) associated with this model.
|
458
806
|
*/
|
459
807
|
jobArn: ModelCustomizationJobArn;
|
460
808
|
/**
|
461
|
-
* ARN of the base model.
|
809
|
+
* Amazon Resource Name (ARN) of the base model.
|
462
810
|
*/
|
463
811
|
baseModelArn: ModelArn;
|
464
812
|
/**
|
@@ -470,20 +818,23 @@ declare namespace Bedrock {
|
|
470
818
|
*/
|
471
819
|
modelKmsKeyArn?: KmsKeyArn;
|
472
820
|
/**
|
473
|
-
* Hyperparameter values associated with this model.
|
821
|
+
* Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.
|
474
822
|
*/
|
475
823
|
hyperParameters?: ModelCustomizationHyperParameters;
|
476
824
|
/**
|
477
|
-
*
|
825
|
+
* Contains information about the training dataset.
|
478
826
|
*/
|
479
827
|
trainingDataConfig: TrainingDataConfig;
|
828
|
+
/**
|
829
|
+
* Contains information about the validation dataset.
|
830
|
+
*/
|
480
831
|
validationDataConfig?: ValidationDataConfig;
|
481
832
|
/**
|
482
833
|
* Output data configuration associated with this custom model.
|
483
834
|
*/
|
484
835
|
outputDataConfig: OutputDataConfig;
|
485
836
|
/**
|
486
|
-
*
|
837
|
+
* Contains training metrics from the job creation.
|
487
838
|
*/
|
488
839
|
trainingMetrics?: TrainingMetrics;
|
489
840
|
/**
|
@@ -495,6 +846,66 @@ declare namespace Bedrock {
|
|
495
846
|
*/
|
496
847
|
creationTime: Timestamp;
|
497
848
|
}
|
849
|
+
export interface GetEvaluationJobRequest {
|
850
|
+
/**
|
851
|
+
* The Amazon Resource Name (ARN) of the model evaluation job.
|
852
|
+
*/
|
853
|
+
jobIdentifier: EvaluationJobIdentifier;
|
854
|
+
}
|
855
|
+
export interface GetEvaluationJobResponse {
|
856
|
+
/**
|
857
|
+
* The name of the model evaluation job.
|
858
|
+
*/
|
859
|
+
jobName: EvaluationJobName;
|
860
|
+
/**
|
861
|
+
* The status of the model evaluation job.
|
862
|
+
*/
|
863
|
+
status: EvaluationJobStatus;
|
864
|
+
/**
|
865
|
+
* The Amazon Resource Name (ARN) of the model evaluation job.
|
866
|
+
*/
|
867
|
+
jobArn: EvaluationJobArn;
|
868
|
+
/**
|
869
|
+
* The description of the model evaluation job.
|
870
|
+
*/
|
871
|
+
jobDescription?: EvaluationJobDescription;
|
872
|
+
/**
|
873
|
+
* The Amazon Resource Name (ARN) of the IAM service role used in the model evaluation job.
|
874
|
+
*/
|
875
|
+
roleArn: RoleArn;
|
876
|
+
/**
|
877
|
+
* The Amazon Resource Name (ARN) of the customer managed key specified when the model evaluation job was created.
|
878
|
+
*/
|
879
|
+
customerEncryptionKeyId?: KmsKeyId;
|
880
|
+
/**
|
881
|
+
* The type of model evaluation job.
|
882
|
+
*/
|
883
|
+
jobType: EvaluationJobType;
|
884
|
+
/**
|
885
|
+
* Contains details about the type of model evaluation job, the metrics used, the task type selected, the datasets used, and any custom metrics you defined.
|
886
|
+
*/
|
887
|
+
evaluationConfig: EvaluationConfig;
|
888
|
+
/**
|
889
|
+
* Details about the models you specified in your model evaluation job.
|
890
|
+
*/
|
891
|
+
inferenceConfig: EvaluationInferenceConfig;
|
892
|
+
/**
|
893
|
+
* Amazon S3 location for where output data is saved.
|
894
|
+
*/
|
895
|
+
outputDataConfig: EvaluationOutputDataConfig;
|
896
|
+
/**
|
897
|
+
* When the model evaluation job was created.
|
898
|
+
*/
|
899
|
+
creationTime: Timestamp;
|
900
|
+
/**
|
901
|
+
* When the model evaluation job was last modified.
|
902
|
+
*/
|
903
|
+
lastModifiedTime?: Timestamp;
|
904
|
+
/**
|
905
|
+
* An array of strings the specify why the model evaluation job has failed.
|
906
|
+
*/
|
907
|
+
failureMessages?: ErrorMessages;
|
908
|
+
}
|
498
909
|
export interface GetFoundationModelRequest {
|
499
910
|
/**
|
500
911
|
* The model identifier.
|
@@ -507,6 +918,86 @@ declare namespace Bedrock {
|
|
507
918
|
*/
|
508
919
|
modelDetails?: FoundationModelDetails;
|
509
920
|
}
|
921
|
+
export interface GetGuardrailRequest {
|
922
|
+
/**
|
923
|
+
* The unique identifier of the guardrail for which to get details.
|
924
|
+
*/
|
925
|
+
guardrailIdentifier: GuardrailIdentifier;
|
926
|
+
/**
|
927
|
+
* The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the DRAFT version.
|
928
|
+
*/
|
929
|
+
guardrailVersion?: GuardrailVersion;
|
930
|
+
}
|
931
|
+
export interface GetGuardrailResponse {
|
932
|
+
/**
|
933
|
+
* The name of the guardrail.
|
934
|
+
*/
|
935
|
+
name: GuardrailName;
|
936
|
+
/**
|
937
|
+
* The description of the guardrail.
|
938
|
+
*/
|
939
|
+
description?: GuardrailDescription;
|
940
|
+
/**
|
941
|
+
* The unique identifier of the guardrail.
|
942
|
+
*/
|
943
|
+
guardrailId: GuardrailId;
|
944
|
+
/**
|
945
|
+
* The ARN of the guardrail that was created.
|
946
|
+
*/
|
947
|
+
guardrailArn: GuardrailArn;
|
948
|
+
/**
|
949
|
+
* The version of the guardrail.
|
950
|
+
*/
|
951
|
+
version: GuardrailVersion;
|
952
|
+
/**
|
953
|
+
* The status of the guardrail.
|
954
|
+
*/
|
955
|
+
status: GuardrailStatus;
|
956
|
+
/**
|
957
|
+
* The topic policy that was configured for the guardrail.
|
958
|
+
*/
|
959
|
+
topicPolicy?: GuardrailTopicPolicy;
|
960
|
+
/**
|
961
|
+
* The content policy that was configured for the guardrail.
|
962
|
+
*/
|
963
|
+
contentPolicy?: GuardrailContentPolicy;
|
964
|
+
/**
|
965
|
+
* The word policy that was configured for the guardrail.
|
966
|
+
*/
|
967
|
+
wordPolicy?: GuardrailWordPolicy;
|
968
|
+
/**
|
969
|
+
* The sensitive information policy that was configured for the guardrail.
|
970
|
+
*/
|
971
|
+
sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicy;
|
972
|
+
/**
|
973
|
+
* The date and time at which the guardrail was created.
|
974
|
+
*/
|
975
|
+
createdAt: Timestamp;
|
976
|
+
/**
|
977
|
+
* The date and time at which the guardrail was updated.
|
978
|
+
*/
|
979
|
+
updatedAt: Timestamp;
|
980
|
+
/**
|
981
|
+
* Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.
|
982
|
+
*/
|
983
|
+
statusReasons?: GuardrailStatusReasons;
|
984
|
+
/**
|
985
|
+
* Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.
|
986
|
+
*/
|
987
|
+
failureRecommendations?: GuardrailFailureRecommendations;
|
988
|
+
/**
|
989
|
+
* The message that the guardrail returns when it blocks a prompt.
|
990
|
+
*/
|
991
|
+
blockedInputMessaging: GuardrailBlockedMessaging;
|
992
|
+
/**
|
993
|
+
* The message that the guardrail returns when it blocks a model response.
|
994
|
+
*/
|
995
|
+
blockedOutputsMessaging: GuardrailBlockedMessaging;
|
996
|
+
/**
|
997
|
+
* The ARN of the KMS key that encrypts the guardrail.
|
998
|
+
*/
|
999
|
+
kmsKeyArn?: KmsKeyArn;
|
1000
|
+
}
|
510
1001
|
export interface GetModelCustomizationJobRequest {
|
511
1002
|
/**
|
512
1003
|
* Identifier for the customization job.
|
@@ -515,7 +1006,7 @@ declare namespace Bedrock {
|
|
515
1006
|
}
|
516
1007
|
export interface GetModelCustomizationJobResponse {
|
517
1008
|
/**
|
518
|
-
* The ARN of the customization job.
|
1009
|
+
* The Amazon Resource Name (ARN) of the customization job.
|
519
1010
|
*/
|
520
1011
|
jobArn: ModelCustomizationJobArn;
|
521
1012
|
/**
|
@@ -527,7 +1018,7 @@ declare namespace Bedrock {
|
|
527
1018
|
*/
|
528
1019
|
outputModelName: CustomModelName;
|
529
1020
|
/**
|
530
|
-
* The ARN of the output model.
|
1021
|
+
* The Amazon Resource Name (ARN) of the output model.
|
531
1022
|
*/
|
532
1023
|
outputModelArn?: CustomModelArn;
|
533
1024
|
/**
|
@@ -535,7 +1026,7 @@ declare namespace Bedrock {
|
|
535
1026
|
*/
|
536
1027
|
clientRequestToken?: IdempotencyToken;
|
537
1028
|
/**
|
538
|
-
* The ARN of the IAM role.
|
1029
|
+
* The Amazon Resource Name (ARN) of the IAM role.
|
539
1030
|
*/
|
540
1031
|
roleArn: RoleArn;
|
541
1032
|
/**
|
@@ -559,14 +1050,20 @@ declare namespace Bedrock {
|
|
559
1050
|
*/
|
560
1051
|
endTime?: Timestamp;
|
561
1052
|
/**
|
562
|
-
* ARN of the base model.
|
1053
|
+
* Amazon Resource Name (ARN) of the base model.
|
563
1054
|
*/
|
564
1055
|
baseModelArn: FoundationModelArn;
|
565
1056
|
/**
|
566
|
-
* The hyperparameter values for the job. For
|
1057
|
+
* The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters.
|
567
1058
|
*/
|
568
1059
|
hyperParameters: ModelCustomizationHyperParameters;
|
1060
|
+
/**
|
1061
|
+
* Contains information about the training dataset.
|
1062
|
+
*/
|
569
1063
|
trainingDataConfig: TrainingDataConfig;
|
1064
|
+
/**
|
1065
|
+
* Contains information about the validation dataset.
|
1066
|
+
*/
|
570
1067
|
validationDataConfig: ValidationDataConfig;
|
571
1068
|
/**
|
572
1069
|
* Output data configuration
|
@@ -580,6 +1077,9 @@ declare namespace Bedrock {
|
|
580
1077
|
* The custom model is encrypted at rest using this key.
|
581
1078
|
*/
|
582
1079
|
outputModelKmsKeyArn?: KmsKeyArn;
|
1080
|
+
/**
|
1081
|
+
* Contains training metrics from the job creation.
|
1082
|
+
*/
|
583
1083
|
trainingMetrics?: TrainingMetrics;
|
584
1084
|
/**
|
585
1085
|
* The loss metric for each validator that you provided in the createjob request.
|
@@ -600,64 +1100,391 @@ declare namespace Bedrock {
|
|
600
1100
|
}
|
601
1101
|
export interface GetProvisionedModelThroughputRequest {
|
602
1102
|
/**
|
603
|
-
* The ARN or name of the
|
1103
|
+
* The Amazon Resource Name (ARN) or name of the Provisioned Throughput.
|
604
1104
|
*/
|
605
1105
|
provisionedModelId: ProvisionedModelId;
|
606
1106
|
}
|
607
1107
|
export interface GetProvisionedModelThroughputResponse {
|
608
1108
|
/**
|
609
|
-
* The
|
1109
|
+
* The number of model units allocated to this Provisioned Throughput.
|
610
1110
|
*/
|
611
1111
|
modelUnits: PositiveInteger;
|
612
1112
|
/**
|
613
|
-
* The
|
1113
|
+
* The number of model units that was requested for this Provisioned Throughput.
|
614
1114
|
*/
|
615
1115
|
desiredModelUnits: PositiveInteger;
|
616
1116
|
/**
|
617
|
-
* The name of the
|
1117
|
+
* The name of the Provisioned Throughput.
|
618
1118
|
*/
|
619
1119
|
provisionedModelName: ProvisionedModelName;
|
620
1120
|
/**
|
621
|
-
* The ARN of the
|
1121
|
+
* The Amazon Resource Name (ARN) of the Provisioned Throughput.
|
622
1122
|
*/
|
623
1123
|
provisionedModelArn: ProvisionedModelArn;
|
624
1124
|
/**
|
625
|
-
* The
|
1125
|
+
* The Amazon Resource Name (ARN) of the model associated with this Provisioned Throughput.
|
626
1126
|
*/
|
627
1127
|
modelArn: ModelArn;
|
628
1128
|
/**
|
629
|
-
* The ARN of the
|
1129
|
+
* The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.
|
630
1130
|
*/
|
631
1131
|
desiredModelArn: ModelArn;
|
632
1132
|
/**
|
633
|
-
* ARN of the
|
1133
|
+
* The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.
|
634
1134
|
*/
|
635
1135
|
foundationModelArn: FoundationModelArn;
|
636
1136
|
/**
|
637
|
-
*
|
1137
|
+
* The status of the Provisioned Throughput.
|
638
1138
|
*/
|
639
1139
|
status: ProvisionedModelStatus;
|
640
1140
|
/**
|
641
|
-
* The timestamp of the creation time for this
|
1141
|
+
* The timestamp of the creation time for this Provisioned Throughput.
|
642
1142
|
*/
|
643
1143
|
creationTime: Timestamp;
|
644
1144
|
/**
|
645
|
-
* The timestamp of the last
|
1145
|
+
* The timestamp of the last time that this Provisioned Throughput was modified.
|
646
1146
|
*/
|
647
1147
|
lastModifiedTime: Timestamp;
|
648
1148
|
/**
|
649
|
-
*
|
1149
|
+
* A failure message for any issues that occurred during creation, updating, or deletion of the Provisioned Throughput.
|
650
1150
|
*/
|
651
1151
|
failureMessage?: ErrorMessage;
|
652
1152
|
/**
|
653
|
-
* Commitment duration of the
|
1153
|
+
* Commitment duration of the Provisioned Throughput.
|
654
1154
|
*/
|
655
1155
|
commitmentDuration?: CommitmentDuration;
|
656
1156
|
/**
|
657
|
-
*
|
1157
|
+
* The timestamp for when the commitment term for the Provisioned Throughput expires.
|
658
1158
|
*/
|
659
1159
|
commitmentExpirationTime?: Timestamp;
|
660
1160
|
}
|
1161
|
+
export type GuardrailArn = string;
|
1162
|
+
export type GuardrailBlockedMessaging = string;
|
1163
|
+
export interface GuardrailContentFilter {
|
1164
|
+
/**
|
1165
|
+
* The harmful category that the content filter is applied to.
|
1166
|
+
*/
|
1167
|
+
type: GuardrailContentFilterType;
|
1168
|
+
/**
|
1169
|
+
* 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.
|
1170
|
+
*/
|
1171
|
+
inputStrength: GuardrailFilterStrength;
|
1172
|
+
/**
|
1173
|
+
* 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.
|
1174
|
+
*/
|
1175
|
+
outputStrength: GuardrailFilterStrength;
|
1176
|
+
}
|
1177
|
+
export interface GuardrailContentFilterConfig {
|
1178
|
+
/**
|
1179
|
+
* The harmful category that the content filter is applied to.
|
1180
|
+
*/
|
1181
|
+
type: GuardrailContentFilterType;
|
1182
|
+
/**
|
1183
|
+
* 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.
|
1184
|
+
*/
|
1185
|
+
inputStrength: GuardrailFilterStrength;
|
1186
|
+
/**
|
1187
|
+
* 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.
|
1188
|
+
*/
|
1189
|
+
outputStrength: GuardrailFilterStrength;
|
1190
|
+
}
|
1191
|
+
export type GuardrailContentFilterType = "SEXUAL"|"VIOLENCE"|"HATE"|"INSULTS"|"MISCONDUCT"|"PROMPT_ATTACK"|string;
|
1192
|
+
export type GuardrailContentFilters = GuardrailContentFilter[];
|
1193
|
+
export type GuardrailContentFiltersConfig = GuardrailContentFilterConfig[];
|
1194
|
+
export interface GuardrailContentPolicy {
|
1195
|
+
/**
|
1196
|
+
* Contains the type of the content filter and how strongly it should apply to prompts and model responses.
|
1197
|
+
*/
|
1198
|
+
filters?: GuardrailContentFilters;
|
1199
|
+
}
|
1200
|
+
export interface GuardrailContentPolicyConfig {
|
1201
|
+
/**
|
1202
|
+
* Contains the type of the content filter and how strongly it should apply to prompts and model responses.
|
1203
|
+
*/
|
1204
|
+
filtersConfig: GuardrailContentFiltersConfig;
|
1205
|
+
}
|
1206
|
+
export type GuardrailDescription = string;
|
1207
|
+
export type GuardrailDraftVersion = string;
|
1208
|
+
export type GuardrailFailureRecommendation = string;
|
1209
|
+
export type GuardrailFailureRecommendations = GuardrailFailureRecommendation[];
|
1210
|
+
export type GuardrailFilterStrength = "NONE"|"LOW"|"MEDIUM"|"HIGH"|string;
|
1211
|
+
export type GuardrailId = string;
|
1212
|
+
export type GuardrailIdentifier = string;
|
1213
|
+
export type GuardrailManagedWordLists = GuardrailManagedWords[];
|
1214
|
+
export type GuardrailManagedWordListsConfig = GuardrailManagedWordsConfig[];
|
1215
|
+
export interface GuardrailManagedWords {
|
1216
|
+
/**
|
1217
|
+
* ManagedWords$type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)
|
1218
|
+
*/
|
1219
|
+
type: GuardrailManagedWordsType;
|
1220
|
+
}
|
1221
|
+
export interface GuardrailManagedWordsConfig {
|
1222
|
+
/**
|
1223
|
+
* The managed word type to configure for the guardrail.
|
1224
|
+
*/
|
1225
|
+
type: GuardrailManagedWordsType;
|
1226
|
+
}
|
1227
|
+
export type GuardrailManagedWordsType = "PROFANITY"|string;
|
1228
|
+
export type GuardrailName = string;
|
1229
|
+
export type GuardrailNumericalVersion = string;
|
1230
|
+
export type GuardrailPiiEntities = GuardrailPiiEntity[];
|
1231
|
+
export type GuardrailPiiEntitiesConfig = GuardrailPiiEntityConfig[];
|
1232
|
+
export interface GuardrailPiiEntity {
|
1233
|
+
/**
|
1234
|
+
* The type of PII entity. For example, Social Security Number.
|
1235
|
+
*/
|
1236
|
+
type: GuardrailPiiEntityType;
|
1237
|
+
/**
|
1238
|
+
* The configured guardrail action when PII entity is detected.
|
1239
|
+
*/
|
1240
|
+
action: GuardrailSensitiveInformationAction;
|
1241
|
+
}
|
1242
|
+
export interface GuardrailPiiEntityConfig {
|
1243
|
+
/**
|
1244
|
+
* Configure guardrail type when the PII entity is detected.
|
1245
|
+
*/
|
1246
|
+
type: GuardrailPiiEntityType;
|
1247
|
+
/**
|
1248
|
+
* Configure guardrail action when the PII entity is detected.
|
1249
|
+
*/
|
1250
|
+
action: GuardrailSensitiveInformationAction;
|
1251
|
+
}
|
1252
|
+
export type GuardrailPiiEntityType = "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"|string;
|
1253
|
+
export interface GuardrailRegex {
|
1254
|
+
/**
|
1255
|
+
* The name of the regular expression for the guardrail.
|
1256
|
+
*/
|
1257
|
+
name: GuardrailRegexNameString;
|
1258
|
+
/**
|
1259
|
+
* The description of the regular expression for the guardrail.
|
1260
|
+
*/
|
1261
|
+
description?: GuardrailRegexDescriptionString;
|
1262
|
+
/**
|
1263
|
+
* The pattern of the regular expression configured for the guardrail.
|
1264
|
+
*/
|
1265
|
+
pattern: GuardrailRegexPatternString;
|
1266
|
+
/**
|
1267
|
+
* The action taken when a match to the regular expression is detected.
|
1268
|
+
*/
|
1269
|
+
action: GuardrailSensitiveInformationAction;
|
1270
|
+
}
|
1271
|
+
export interface GuardrailRegexConfig {
|
1272
|
+
/**
|
1273
|
+
* The name of the regular expression to configure for the guardrail.
|
1274
|
+
*/
|
1275
|
+
name: GuardrailRegexConfigNameString;
|
1276
|
+
/**
|
1277
|
+
* The description of the regular expression to configure for the guardrail.
|
1278
|
+
*/
|
1279
|
+
description?: GuardrailRegexConfigDescriptionString;
|
1280
|
+
/**
|
1281
|
+
* The regular expression pattern to configure for the guardrail.
|
1282
|
+
*/
|
1283
|
+
pattern: GuardrailRegexConfigPatternString;
|
1284
|
+
/**
|
1285
|
+
* The guardrail action to configure when matching regular expression is detected.
|
1286
|
+
*/
|
1287
|
+
action: GuardrailSensitiveInformationAction;
|
1288
|
+
}
|
1289
|
+
export type GuardrailRegexConfigDescriptionString = string;
|
1290
|
+
export type GuardrailRegexConfigNameString = string;
|
1291
|
+
export type GuardrailRegexConfigPatternString = string;
|
1292
|
+
export type GuardrailRegexDescriptionString = string;
|
1293
|
+
export type GuardrailRegexNameString = string;
|
1294
|
+
export type GuardrailRegexPatternString = string;
|
1295
|
+
export type GuardrailRegexes = GuardrailRegex[];
|
1296
|
+
export type GuardrailRegexesConfig = GuardrailRegexConfig[];
|
1297
|
+
export type GuardrailSensitiveInformationAction = "BLOCK"|"ANONYMIZE"|string;
|
1298
|
+
export interface GuardrailSensitiveInformationPolicy {
|
1299
|
+
/**
|
1300
|
+
* The list of PII entities configured for the guardrail.
|
1301
|
+
*/
|
1302
|
+
piiEntities?: GuardrailPiiEntities;
|
1303
|
+
/**
|
1304
|
+
* The list of regular expressions configured for the guardrail.
|
1305
|
+
*/
|
1306
|
+
regexes?: GuardrailRegexes;
|
1307
|
+
}
|
1308
|
+
export interface GuardrailSensitiveInformationPolicyConfig {
|
1309
|
+
/**
|
1310
|
+
* A list of PII entities to configure to the guardrail.
|
1311
|
+
*/
|
1312
|
+
piiEntitiesConfig?: GuardrailPiiEntitiesConfig;
|
1313
|
+
/**
|
1314
|
+
* A list of regular expressions to configure to the guardrail.
|
1315
|
+
*/
|
1316
|
+
regexesConfig?: GuardrailRegexesConfig;
|
1317
|
+
}
|
1318
|
+
export type GuardrailStatus = "CREATING"|"UPDATING"|"VERSIONING"|"READY"|"FAILED"|"DELETING"|string;
|
1319
|
+
export type GuardrailStatusReason = string;
|
1320
|
+
export type GuardrailStatusReasons = GuardrailStatusReason[];
|
1321
|
+
export type GuardrailSummaries = GuardrailSummary[];
|
1322
|
+
export interface GuardrailSummary {
|
1323
|
+
/**
|
1324
|
+
* The unique identifier of the guardrail.
|
1325
|
+
*/
|
1326
|
+
id: GuardrailId;
|
1327
|
+
/**
|
1328
|
+
* The ARN of the guardrail.
|
1329
|
+
*/
|
1330
|
+
arn: GuardrailArn;
|
1331
|
+
/**
|
1332
|
+
* The status of the guardrail.
|
1333
|
+
*/
|
1334
|
+
status: GuardrailStatus;
|
1335
|
+
/**
|
1336
|
+
* The name of the guardrail.
|
1337
|
+
*/
|
1338
|
+
name: GuardrailName;
|
1339
|
+
/**
|
1340
|
+
* A description of the guardrail.
|
1341
|
+
*/
|
1342
|
+
description?: GuardrailDescription;
|
1343
|
+
/**
|
1344
|
+
* The version of the guardrail.
|
1345
|
+
*/
|
1346
|
+
version: GuardrailVersion;
|
1347
|
+
/**
|
1348
|
+
* The date and time at which the guardrail was created.
|
1349
|
+
*/
|
1350
|
+
createdAt: Timestamp;
|
1351
|
+
/**
|
1352
|
+
* The date and time at which the guardrail was last updated.
|
1353
|
+
*/
|
1354
|
+
updatedAt: Timestamp;
|
1355
|
+
}
|
1356
|
+
export interface GuardrailTopic {
|
1357
|
+
/**
|
1358
|
+
* The name of the topic to deny.
|
1359
|
+
*/
|
1360
|
+
name: GuardrailTopicName;
|
1361
|
+
/**
|
1362
|
+
* A definition of the topic to deny.
|
1363
|
+
*/
|
1364
|
+
definition: GuardrailTopicDefinition;
|
1365
|
+
/**
|
1366
|
+
* A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
|
1367
|
+
*/
|
1368
|
+
examples?: GuardrailTopicExamples;
|
1369
|
+
/**
|
1370
|
+
* Specifies to deny the topic.
|
1371
|
+
*/
|
1372
|
+
type?: GuardrailTopicType;
|
1373
|
+
}
|
1374
|
+
export interface GuardrailTopicConfig {
|
1375
|
+
/**
|
1376
|
+
* The name of the topic to deny.
|
1377
|
+
*/
|
1378
|
+
name: GuardrailTopicName;
|
1379
|
+
/**
|
1380
|
+
* A definition of the topic to deny.
|
1381
|
+
*/
|
1382
|
+
definition: GuardrailTopicDefinition;
|
1383
|
+
/**
|
1384
|
+
* A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
|
1385
|
+
*/
|
1386
|
+
examples?: GuardrailTopicExamples;
|
1387
|
+
/**
|
1388
|
+
* Specifies to deny the topic.
|
1389
|
+
*/
|
1390
|
+
type: GuardrailTopicType;
|
1391
|
+
}
|
1392
|
+
export type GuardrailTopicDefinition = string;
|
1393
|
+
export type GuardrailTopicExample = string;
|
1394
|
+
export type GuardrailTopicExamples = GuardrailTopicExample[];
|
1395
|
+
export type GuardrailTopicName = string;
|
1396
|
+
export interface GuardrailTopicPolicy {
|
1397
|
+
/**
|
1398
|
+
* A list of policies related to topics that the guardrail should deny.
|
1399
|
+
*/
|
1400
|
+
topics: GuardrailTopics;
|
1401
|
+
}
|
1402
|
+
export interface GuardrailTopicPolicyConfig {
|
1403
|
+
/**
|
1404
|
+
* A list of policies related to topics that the guardrail should deny.
|
1405
|
+
*/
|
1406
|
+
topicsConfig: GuardrailTopicsConfig;
|
1407
|
+
}
|
1408
|
+
export type GuardrailTopicType = "DENY"|string;
|
1409
|
+
export type GuardrailTopics = GuardrailTopic[];
|
1410
|
+
export type GuardrailTopicsConfig = GuardrailTopicConfig[];
|
1411
|
+
export type GuardrailVersion = string;
|
1412
|
+
export interface GuardrailWord {
|
1413
|
+
/**
|
1414
|
+
* Text of the word configured for the guardrail to block.
|
1415
|
+
*/
|
1416
|
+
text: GuardrailWordTextString;
|
1417
|
+
}
|
1418
|
+
export interface GuardrailWordConfig {
|
1419
|
+
/**
|
1420
|
+
* Text of the word configured for the guardrail to block.
|
1421
|
+
*/
|
1422
|
+
text: GuardrailWordConfigTextString;
|
1423
|
+
}
|
1424
|
+
export type GuardrailWordConfigTextString = string;
|
1425
|
+
export interface GuardrailWordPolicy {
|
1426
|
+
/**
|
1427
|
+
* A list of words configured for the guardrail.
|
1428
|
+
*/
|
1429
|
+
words?: GuardrailWords;
|
1430
|
+
/**
|
1431
|
+
* A list of managed words configured for the guardrail.
|
1432
|
+
*/
|
1433
|
+
managedWordLists?: GuardrailManagedWordLists;
|
1434
|
+
}
|
1435
|
+
export interface GuardrailWordPolicyConfig {
|
1436
|
+
/**
|
1437
|
+
* A list of words to configure for the guardrail.
|
1438
|
+
*/
|
1439
|
+
wordsConfig?: GuardrailWordsConfig;
|
1440
|
+
/**
|
1441
|
+
* A list of managed words to configure for the guardrail.
|
1442
|
+
*/
|
1443
|
+
managedWordListsConfig?: GuardrailManagedWordListsConfig;
|
1444
|
+
}
|
1445
|
+
export type GuardrailWordTextString = string;
|
1446
|
+
export type GuardrailWords = GuardrailWord[];
|
1447
|
+
export type GuardrailWordsConfig = GuardrailWordConfig[];
|
1448
|
+
export interface HumanEvaluationConfig {
|
1449
|
+
/**
|
1450
|
+
* The parameters of the human workflow.
|
1451
|
+
*/
|
1452
|
+
humanWorkflowConfig?: HumanWorkflowConfig;
|
1453
|
+
/**
|
1454
|
+
* A HumanEvaluationCustomMetric object. It contains the names the metrics, how the metrics are to be evaluated, an optional description.
|
1455
|
+
*/
|
1456
|
+
customMetrics?: HumanEvaluationCustomMetrics;
|
1457
|
+
/**
|
1458
|
+
* Use to specify the metrics, task, and prompt dataset to be used in your model evaluation job.
|
1459
|
+
*/
|
1460
|
+
datasetMetricConfigs: EvaluationDatasetMetricConfigs;
|
1461
|
+
}
|
1462
|
+
export interface HumanEvaluationCustomMetric {
|
1463
|
+
/**
|
1464
|
+
* The name of the metric. Your human evaluators will see this name in the evaluation UI.
|
1465
|
+
*/
|
1466
|
+
name: EvaluationMetricName;
|
1467
|
+
/**
|
1468
|
+
* An optional description of the metric. Use this parameter to provide more details about the metric.
|
1469
|
+
*/
|
1470
|
+
description?: EvaluationMetricDescription;
|
1471
|
+
/**
|
1472
|
+
* Choose how you want your human workers to evaluation your model. Valid values for rating methods are ThumbsUpDown, IndividualLikertScale,ComparisonLikertScale, ComparisonChoice, and ComparisonRank
|
1473
|
+
*/
|
1474
|
+
ratingMethod: EvaluationRatingMethod;
|
1475
|
+
}
|
1476
|
+
export type HumanEvaluationCustomMetrics = HumanEvaluationCustomMetric[];
|
1477
|
+
export type HumanTaskInstructions = string;
|
1478
|
+
export interface HumanWorkflowConfig {
|
1479
|
+
/**
|
1480
|
+
* The Amazon Resource Number (ARN) for the flow definition
|
1481
|
+
*/
|
1482
|
+
flowDefinitionArn: SageMakerFlowDefinitionArn;
|
1483
|
+
/**
|
1484
|
+
* Instructions for the flow definition
|
1485
|
+
*/
|
1486
|
+
instructions?: HumanTaskInstructions;
|
1487
|
+
}
|
661
1488
|
export type IdempotencyToken = string;
|
662
1489
|
export type InferenceType = "ON_DEMAND"|"PROVISIONED"|string;
|
663
1490
|
export type InferenceTypeList = InferenceType[];
|
@@ -679,11 +1506,11 @@ declare namespace Bedrock {
|
|
679
1506
|
*/
|
680
1507
|
nameContains?: CustomModelName;
|
681
1508
|
/**
|
682
|
-
* Return custom models only if the base model ARN matches this parameter.
|
1509
|
+
* Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.
|
683
1510
|
*/
|
684
1511
|
baseModelArnEquals?: ModelArn;
|
685
1512
|
/**
|
686
|
-
* Return custom models only if the foundation model ARN matches this parameter.
|
1513
|
+
* Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.
|
687
1514
|
*/
|
688
1515
|
foundationModelArnEquals?: FoundationModelArn;
|
689
1516
|
/**
|
@@ -713,21 +1540,65 @@ declare namespace Bedrock {
|
|
713
1540
|
*/
|
714
1541
|
modelSummaries?: CustomModelSummaryList;
|
715
1542
|
}
|
1543
|
+
export interface ListEvaluationJobsRequest {
|
1544
|
+
/**
|
1545
|
+
* A filter that includes model evaluation jobs created after the time specified.
|
1546
|
+
*/
|
1547
|
+
creationTimeAfter?: Timestamp;
|
1548
|
+
/**
|
1549
|
+
* A filter that includes model evaluation jobs created prior to the time specified.
|
1550
|
+
*/
|
1551
|
+
creationTimeBefore?: Timestamp;
|
1552
|
+
/**
|
1553
|
+
* Only return jobs where the status condition is met.
|
1554
|
+
*/
|
1555
|
+
statusEquals?: EvaluationJobStatus;
|
1556
|
+
/**
|
1557
|
+
* Query parameter string for model evaluation job names.
|
1558
|
+
*/
|
1559
|
+
nameContains?: EvaluationJobName;
|
1560
|
+
/**
|
1561
|
+
* The maximum number of results to return.
|
1562
|
+
*/
|
1563
|
+
maxResults?: MaxResults;
|
1564
|
+
/**
|
1565
|
+
* Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
|
1566
|
+
*/
|
1567
|
+
nextToken?: PaginationToken;
|
1568
|
+
/**
|
1569
|
+
* Allows you to sort model evaluation jobs by when they were created.
|
1570
|
+
*/
|
1571
|
+
sortBy?: SortJobsBy;
|
1572
|
+
/**
|
1573
|
+
* How you want the order of jobs sorted.
|
1574
|
+
*/
|
1575
|
+
sortOrder?: SortOrder;
|
1576
|
+
}
|
1577
|
+
export interface ListEvaluationJobsResponse {
|
1578
|
+
/**
|
1579
|
+
* Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
|
1580
|
+
*/
|
1581
|
+
nextToken?: PaginationToken;
|
1582
|
+
/**
|
1583
|
+
* A summary of the model evaluation jobs.
|
1584
|
+
*/
|
1585
|
+
jobSummaries?: EvaluationSummaries;
|
1586
|
+
}
|
716
1587
|
export interface ListFoundationModelsRequest {
|
717
1588
|
/**
|
718
|
-
*
|
1589
|
+
* Return models belonging to the model provider that you specify.
|
719
1590
|
*/
|
720
1591
|
byProvider?: Provider;
|
721
1592
|
/**
|
722
|
-
*
|
1593
|
+
* Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.
|
723
1594
|
*/
|
724
1595
|
byCustomizationType?: ModelCustomization;
|
725
1596
|
/**
|
726
|
-
*
|
1597
|
+
* Return models that support the output modality that you specify.
|
727
1598
|
*/
|
728
1599
|
byOutputModality?: ModelModality;
|
729
1600
|
/**
|
730
|
-
*
|
1601
|
+
* Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
|
731
1602
|
*/
|
732
1603
|
byInferenceType?: InferenceType;
|
733
1604
|
}
|
@@ -737,6 +1608,30 @@ declare namespace Bedrock {
|
|
737
1608
|
*/
|
738
1609
|
modelSummaries?: FoundationModelSummaryList;
|
739
1610
|
}
|
1611
|
+
export interface ListGuardrailsRequest {
|
1612
|
+
/**
|
1613
|
+
* The unique identifier of the guardrail.
|
1614
|
+
*/
|
1615
|
+
guardrailIdentifier?: GuardrailIdentifier;
|
1616
|
+
/**
|
1617
|
+
* The maximum number of results to return in the response.
|
1618
|
+
*/
|
1619
|
+
maxResults?: MaxResults;
|
1620
|
+
/**
|
1621
|
+
* If there are more results than were returned in the response, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.
|
1622
|
+
*/
|
1623
|
+
nextToken?: PaginationToken;
|
1624
|
+
}
|
1625
|
+
export interface ListGuardrailsResponse {
|
1626
|
+
/**
|
1627
|
+
* A list of objects, each of which contains details about a guardrail.
|
1628
|
+
*/
|
1629
|
+
guardrails: GuardrailSummaries;
|
1630
|
+
/**
|
1631
|
+
* If there are more results than were returned in the response, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.
|
1632
|
+
*/
|
1633
|
+
nextToken?: PaginationToken;
|
1634
|
+
}
|
740
1635
|
export interface ListModelCustomizationJobsRequest {
|
741
1636
|
/**
|
742
1637
|
* Return customization jobs created after the specified time.
|
@@ -783,35 +1678,35 @@ declare namespace Bedrock {
|
|
783
1678
|
}
|
784
1679
|
export interface ListProvisionedModelThroughputsRequest {
|
785
1680
|
/**
|
786
|
-
*
|
1681
|
+
* A filter that returns Provisioned Throughputs created after the specified time.
|
787
1682
|
*/
|
788
1683
|
creationTimeAfter?: Timestamp;
|
789
1684
|
/**
|
790
|
-
*
|
1685
|
+
* A filter that returns Provisioned Throughputs created before the specified time.
|
791
1686
|
*/
|
792
1687
|
creationTimeBefore?: Timestamp;
|
793
1688
|
/**
|
794
|
-
*
|
1689
|
+
* A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.
|
795
1690
|
*/
|
796
1691
|
statusEquals?: ProvisionedModelStatus;
|
797
1692
|
/**
|
798
|
-
*
|
1693
|
+
* A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify.
|
799
1694
|
*/
|
800
1695
|
modelArnEquals?: ModelArn;
|
801
1696
|
/**
|
802
|
-
*
|
1697
|
+
* A filter that returns Provisioned Throughputs if their name contains the expression that you specify.
|
803
1698
|
*/
|
804
1699
|
nameContains?: ProvisionedModelName;
|
805
1700
|
/**
|
806
|
-
* THe maximum number of results to return in the response.
|
1701
|
+
* THe maximum number of results to return in the response. If there are more results than the number you specified, the response returns a nextToken value. To see the next batch of results, send the nextToken value in another list request.
|
807
1702
|
*/
|
808
1703
|
maxResults?: MaxResults;
|
809
1704
|
/**
|
810
|
-
*
|
1705
|
+
* If there are more results than the number you specified in the maxResults field, the response returns a nextToken value. To see the next batch of results, specify the nextToken value in this field.
|
811
1706
|
*/
|
812
1707
|
nextToken?: PaginationToken;
|
813
1708
|
/**
|
814
|
-
* The field to sort
|
1709
|
+
* The field by which to sort the returned list of Provisioned Throughputs.
|
815
1710
|
*/
|
816
1711
|
sortBy?: SortByProvisionedModels;
|
817
1712
|
/**
|
@@ -821,17 +1716,17 @@ declare namespace Bedrock {
|
|
821
1716
|
}
|
822
1717
|
export interface ListProvisionedModelThroughputsResponse {
|
823
1718
|
/**
|
824
|
-
*
|
1719
|
+
* If there are more results than the number you specified in the maxResults field, this value is returned. To see the next batch of results, include this value in the nextToken field in another list request.
|
825
1720
|
*/
|
826
1721
|
nextToken?: PaginationToken;
|
827
1722
|
/**
|
828
|
-
*
|
1723
|
+
* A list of summaries, one for each Provisioned Throughput in the response.
|
829
1724
|
*/
|
830
1725
|
provisionedModelSummaries?: ProvisionedModelSummaries;
|
831
1726
|
}
|
832
1727
|
export interface ListTagsForResourceRequest {
|
833
1728
|
/**
|
834
|
-
* The ARN of the resource.
|
1729
|
+
* The Amazon Resource Name (ARN) of the resource.
|
835
1730
|
*/
|
836
1731
|
resourceARN: TaggableResourcesArn;
|
837
1732
|
}
|
@@ -875,11 +1770,11 @@ declare namespace Bedrock {
|
|
875
1770
|
export type ModelCustomizationJobSummaries = ModelCustomizationJobSummary[];
|
876
1771
|
export interface ModelCustomizationJobSummary {
|
877
1772
|
/**
|
878
|
-
* ARN of the customization job.
|
1773
|
+
* Amazon Resource Name (ARN) of the customization job.
|
879
1774
|
*/
|
880
1775
|
jobArn: ModelCustomizationJobArn;
|
881
1776
|
/**
|
882
|
-
* ARN of the base model.
|
1777
|
+
* Amazon Resource Name (ARN) of the base model.
|
883
1778
|
*/
|
884
1779
|
baseModelArn: ModelArn;
|
885
1780
|
/**
|
@@ -903,7 +1798,7 @@ declare namespace Bedrock {
|
|
903
1798
|
*/
|
904
1799
|
endTime?: Timestamp;
|
905
1800
|
/**
|
906
|
-
* ARN of the custom model.
|
1801
|
+
* Amazon Resource Name (ARN) of the custom model.
|
907
1802
|
*/
|
908
1803
|
customModelArn?: CustomModelArn;
|
909
1804
|
/**
|
@@ -936,51 +1831,51 @@ declare namespace Bedrock {
|
|
936
1831
|
export type ProvisionedModelSummaries = ProvisionedModelSummary[];
|
937
1832
|
export interface ProvisionedModelSummary {
|
938
1833
|
/**
|
939
|
-
* The name of the
|
1834
|
+
* The name of the Provisioned Throughput.
|
940
1835
|
*/
|
941
1836
|
provisionedModelName: ProvisionedModelName;
|
942
1837
|
/**
|
943
|
-
* The ARN of the
|
1838
|
+
* The Amazon Resource Name (ARN) of the Provisioned Throughput.
|
944
1839
|
*/
|
945
1840
|
provisionedModelArn: ProvisionedModelArn;
|
946
1841
|
/**
|
947
|
-
* The ARN of the model associated with
|
1842
|
+
* The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput.
|
948
1843
|
*/
|
949
1844
|
modelArn: ModelArn;
|
950
1845
|
/**
|
951
|
-
*
|
1846
|
+
* The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.
|
952
1847
|
*/
|
953
1848
|
desiredModelArn: ModelArn;
|
954
1849
|
/**
|
955
|
-
*
|
1850
|
+
* The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.
|
956
1851
|
*/
|
957
1852
|
foundationModelArn: FoundationModelArn;
|
958
1853
|
/**
|
959
|
-
* The number of model units allocated.
|
1854
|
+
* The number of model units allocated to the Provisioned Throughput.
|
960
1855
|
*/
|
961
1856
|
modelUnits: PositiveInteger;
|
962
1857
|
/**
|
963
|
-
*
|
1858
|
+
* The number of model units that was requested to be allocated to the Provisioned Throughput.
|
964
1859
|
*/
|
965
1860
|
desiredModelUnits: PositiveInteger;
|
966
1861
|
/**
|
967
|
-
*
|
1862
|
+
* The status of the Provisioned Throughput.
|
968
1863
|
*/
|
969
1864
|
status: ProvisionedModelStatus;
|
970
1865
|
/**
|
971
|
-
*
|
1866
|
+
* The duration for which the Provisioned Throughput was committed.
|
972
1867
|
*/
|
973
1868
|
commitmentDuration?: CommitmentDuration;
|
974
1869
|
/**
|
975
|
-
*
|
1870
|
+
* The timestamp for when the commitment term of the Provisioned Throughput expires.
|
976
1871
|
*/
|
977
1872
|
commitmentExpirationTime?: Timestamp;
|
978
1873
|
/**
|
979
|
-
* The time that
|
1874
|
+
* The time that the Provisioned Throughput was created.
|
980
1875
|
*/
|
981
1876
|
creationTime: Timestamp;
|
982
1877
|
/**
|
983
|
-
* The time that
|
1878
|
+
* The time that the Provisioned Throughput was last modified.
|
984
1879
|
*/
|
985
1880
|
lastModifiedTime: Timestamp;
|
986
1881
|
}
|
@@ -1004,12 +1899,21 @@ declare namespace Bedrock {
|
|
1004
1899
|
keyPrefix?: KeyPrefix;
|
1005
1900
|
}
|
1006
1901
|
export type S3Uri = string;
|
1902
|
+
export type SageMakerFlowDefinitionArn = string;
|
1007
1903
|
export type SecurityGroupId = string;
|
1008
1904
|
export type SecurityGroupIds = SecurityGroupId[];
|
1009
1905
|
export type SortByProvisionedModels = "CreationTime"|string;
|
1010
1906
|
export type SortJobsBy = "CreationTime"|string;
|
1011
1907
|
export type SortModelsBy = "CreationTime"|string;
|
1012
1908
|
export type SortOrder = "Ascending"|"Descending"|string;
|
1909
|
+
export interface StopEvaluationJobRequest {
|
1910
|
+
/**
|
1911
|
+
* The ARN of the model evaluation job you want to stop.
|
1912
|
+
*/
|
1913
|
+
jobIdentifier: EvaluationJobIdentifier;
|
1914
|
+
}
|
1915
|
+
export interface StopEvaluationJobResponse {
|
1916
|
+
}
|
1013
1917
|
export interface StopModelCustomizationJobRequest {
|
1014
1918
|
/**
|
1015
1919
|
* Job identifier of the job to stop.
|
@@ -1036,7 +1940,7 @@ declare namespace Bedrock {
|
|
1036
1940
|
export type TagList = Tag[];
|
1037
1941
|
export interface TagResourceRequest {
|
1038
1942
|
/**
|
1039
|
-
* The ARN of the resource to tag.
|
1943
|
+
* The Amazon Resource Name (ARN) of the resource to tag.
|
1040
1944
|
*/
|
1041
1945
|
resourceARN: TaggableResourcesArn;
|
1042
1946
|
/**
|
@@ -1063,7 +1967,7 @@ declare namespace Bedrock {
|
|
1063
1967
|
}
|
1064
1968
|
export interface UntagResourceRequest {
|
1065
1969
|
/**
|
1066
|
-
* The ARN of the resource to untag.
|
1970
|
+
* The Amazon Resource Name (ARN) of the resource to untag.
|
1067
1971
|
*/
|
1068
1972
|
resourceARN: TaggableResourcesArn;
|
1069
1973
|
/**
|
@@ -1073,17 +1977,77 @@ declare namespace Bedrock {
|
|
1073
1977
|
}
|
1074
1978
|
export interface UntagResourceResponse {
|
1075
1979
|
}
|
1980
|
+
export interface UpdateGuardrailRequest {
|
1981
|
+
/**
|
1982
|
+
* The unique identifier of the guardrail
|
1983
|
+
*/
|
1984
|
+
guardrailIdentifier: GuardrailIdentifier;
|
1985
|
+
/**
|
1986
|
+
* A name for the guardrail.
|
1987
|
+
*/
|
1988
|
+
name: GuardrailName;
|
1989
|
+
/**
|
1990
|
+
* A description of the guardrail.
|
1991
|
+
*/
|
1992
|
+
description?: GuardrailDescription;
|
1993
|
+
/**
|
1994
|
+
* The topic policy to configure for the guardrail.
|
1995
|
+
*/
|
1996
|
+
topicPolicyConfig?: GuardrailTopicPolicyConfig;
|
1997
|
+
/**
|
1998
|
+
* The content policy to configure for the guardrail.
|
1999
|
+
*/
|
2000
|
+
contentPolicyConfig?: GuardrailContentPolicyConfig;
|
2001
|
+
/**
|
2002
|
+
* The word policy to configure for the guardrail.
|
2003
|
+
*/
|
2004
|
+
wordPolicyConfig?: GuardrailWordPolicyConfig;
|
2005
|
+
/**
|
2006
|
+
* The sensitive information policy to configure for the guardrail.
|
2007
|
+
*/
|
2008
|
+
sensitiveInformationPolicyConfig?: GuardrailSensitiveInformationPolicyConfig;
|
2009
|
+
/**
|
2010
|
+
* The message to return when the guardrail blocks a prompt.
|
2011
|
+
*/
|
2012
|
+
blockedInputMessaging: GuardrailBlockedMessaging;
|
2013
|
+
/**
|
2014
|
+
* The message to return when the guardrail blocks a model response.
|
2015
|
+
*/
|
2016
|
+
blockedOutputsMessaging: GuardrailBlockedMessaging;
|
2017
|
+
/**
|
2018
|
+
* The ARN of the KMS key with which to encrypt the guardrail.
|
2019
|
+
*/
|
2020
|
+
kmsKeyId?: KmsKeyId;
|
2021
|
+
}
|
2022
|
+
export interface UpdateGuardrailResponse {
|
2023
|
+
/**
|
2024
|
+
* The unique identifier of the guardrail
|
2025
|
+
*/
|
2026
|
+
guardrailId: GuardrailId;
|
2027
|
+
/**
|
2028
|
+
* The ARN of the guardrail that was created.
|
2029
|
+
*/
|
2030
|
+
guardrailArn: GuardrailArn;
|
2031
|
+
/**
|
2032
|
+
* The version of the guardrail.
|
2033
|
+
*/
|
2034
|
+
version: GuardrailDraftVersion;
|
2035
|
+
/**
|
2036
|
+
* The date and time at which the guardrail was updated.
|
2037
|
+
*/
|
2038
|
+
updatedAt: Timestamp;
|
2039
|
+
}
|
1076
2040
|
export interface UpdateProvisionedModelThroughputRequest {
|
1077
2041
|
/**
|
1078
|
-
* The ARN or name of the
|
2042
|
+
* The Amazon Resource Name (ARN) or name of the Provisioned Throughput to update.
|
1079
2043
|
*/
|
1080
2044
|
provisionedModelId: ProvisionedModelId;
|
1081
2045
|
/**
|
1082
|
-
* The new name for this
|
2046
|
+
* The new name for this Provisioned Throughput.
|
1083
2047
|
*/
|
1084
2048
|
desiredProvisionedModelName?: ProvisionedModelName;
|
1085
2049
|
/**
|
1086
|
-
* The ARN of the new model to associate with this
|
2050
|
+
* The Amazon Resource Name (ARN) of the new model to associate with this Provisioned Throughput. You can't specify this field if this Provisioned Throughput is associated with a base model. If this Provisioned Throughput is associated with a custom model, you can specify one of the following options: The base model from which the custom model was customized. Another custom model that was customized from the same base model as the custom model.
|
1087
2051
|
*/
|
1088
2052
|
desiredModelId?: ModelIdentifier;
|
1089
2053
|
}
|