aws-sdk-bedrock 1.4.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrock/client.rb +1068 -96
- data/lib/aws-sdk-bedrock/client_api.rb +617 -0
- data/lib/aws-sdk-bedrock/endpoints.rb +140 -0
- data/lib/aws-sdk-bedrock/plugins/endpoints.rb +20 -0
- data/lib/aws-sdk-bedrock/types.rb +2103 -320
- data/lib/aws-sdk-bedrock.rb +2 -2
- data/sig/client.rbs +322 -0
- data/sig/types.rbs +414 -0
- metadata +2 -2
@@ -23,6 +23,23 @@ module Aws::Bedrock
|
|
23
23
|
include Aws::Structure
|
24
24
|
end
|
25
25
|
|
26
|
+
# Use to specify a automatic model evaluation job. The
|
27
|
+
# `EvaluationDatasetMetricConfig` object is used to specify the prompt
|
28
|
+
# datasets, task type, and metric names.
|
29
|
+
#
|
30
|
+
# @!attribute [rw] dataset_metric_configs
|
31
|
+
# Specifies the required elements for an automatic model evaluation
|
32
|
+
# job.
|
33
|
+
# @return [Array<Types::EvaluationDatasetMetricConfig>]
|
34
|
+
#
|
35
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedEvaluationConfig AWS API Documentation
|
36
|
+
#
|
37
|
+
class AutomatedEvaluationConfig < Struct.new(
|
38
|
+
:dataset_metric_configs)
|
39
|
+
SENSITIVE = []
|
40
|
+
include Aws::Structure
|
41
|
+
end
|
42
|
+
|
26
43
|
# CloudWatch logging configuration.
|
27
44
|
#
|
28
45
|
# @!attribute [rw] log_group_name
|
@@ -30,7 +47,7 @@ module Aws::Bedrock
|
|
30
47
|
# @return [String]
|
31
48
|
#
|
32
49
|
# @!attribute [rw] role_arn
|
33
|
-
# The role ARN.
|
50
|
+
# The role Amazon Resource Name (ARN).
|
34
51
|
# @return [String]
|
35
52
|
#
|
36
53
|
# @!attribute [rw] large_data_delivery_s3_config
|
@@ -61,28 +78,275 @@ module Aws::Bedrock
|
|
61
78
|
end
|
62
79
|
|
63
80
|
# @!attribute [rw] job_name
|
64
|
-
#
|
81
|
+
# The name of the model evaluation job. Model evaluation job names
|
82
|
+
# must unique with your AWS account, and your account's AWS region.
|
83
|
+
# @return [String]
|
84
|
+
#
|
85
|
+
# @!attribute [rw] job_description
|
86
|
+
# A description of the model evaluation job.
|
87
|
+
# @return [String]
|
88
|
+
#
|
89
|
+
# @!attribute [rw] client_request_token
|
90
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
91
|
+
# completes no more than one time. If this token matches a previous
|
92
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
93
|
+
# error. For more information, see [Ensuring idempotency][1].
|
94
|
+
#
|
95
|
+
# **A suitable default value is auto-generated.** You should normally
|
96
|
+
# not need to pass this option.
|
97
|
+
#
|
98
|
+
#
|
99
|
+
#
|
100
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
101
|
+
# @return [String]
|
102
|
+
#
|
103
|
+
# @!attribute [rw] role_arn
|
104
|
+
# The Amazon Resource Name (ARN) of an IAM service role that Amazon
|
105
|
+
# Bedrock can assume to perform tasks on your behalf. The service role
|
106
|
+
# must have Amazon Bedrock as the service principal, and provide
|
107
|
+
# access to any Amazon S3 buckets specified in the `EvaluationConfig`
|
108
|
+
# object. To pass this role to Amazon Bedrock, the caller of this API
|
109
|
+
# must have the `iam:PassRole` permission. To learn more about the
|
110
|
+
# required permissions, see [Required permissions][1].
|
111
|
+
#
|
112
|
+
#
|
113
|
+
#
|
114
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-security.html
|
115
|
+
# @return [String]
|
116
|
+
#
|
117
|
+
# @!attribute [rw] customer_encryption_key_id
|
118
|
+
# Specify your customer managed key ARN that will be used to encrypt
|
119
|
+
# your model evaluation job.
|
120
|
+
# @return [String]
|
121
|
+
#
|
122
|
+
# @!attribute [rw] job_tags
|
123
|
+
# Tags to attach to the model evaluation job.
|
124
|
+
# @return [Array<Types::Tag>]
|
125
|
+
#
|
126
|
+
# @!attribute [rw] evaluation_config
|
127
|
+
# Specifies whether the model evaluation job is automatic or uses
|
128
|
+
# human worker.
|
129
|
+
# @return [Types::EvaluationConfig]
|
130
|
+
#
|
131
|
+
# @!attribute [rw] inference_config
|
132
|
+
# Specify the models you want to use in your model evaluation job.
|
133
|
+
# Automatic model evaluation jobs support a single model, and model
|
134
|
+
# evaluation job that use human workers support two models.
|
135
|
+
# @return [Types::EvaluationInferenceConfig]
|
136
|
+
#
|
137
|
+
# @!attribute [rw] output_data_config
|
138
|
+
# An object that defines where the results of model evaluation job
|
139
|
+
# will be saved in Amazon S3.
|
140
|
+
# @return [Types::EvaluationOutputDataConfig]
|
141
|
+
#
|
142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateEvaluationJobRequest AWS API Documentation
|
143
|
+
#
|
144
|
+
class CreateEvaluationJobRequest < Struct.new(
|
145
|
+
:job_name,
|
146
|
+
:job_description,
|
147
|
+
:client_request_token,
|
148
|
+
:role_arn,
|
149
|
+
:customer_encryption_key_id,
|
150
|
+
:job_tags,
|
151
|
+
:evaluation_config,
|
152
|
+
:inference_config,
|
153
|
+
:output_data_config)
|
154
|
+
SENSITIVE = [:job_description]
|
155
|
+
include Aws::Structure
|
156
|
+
end
|
157
|
+
|
158
|
+
# @!attribute [rw] job_arn
|
159
|
+
# The ARN of the model evaluation job.
|
160
|
+
# @return [String]
|
161
|
+
#
|
162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateEvaluationJobResponse AWS API Documentation
|
163
|
+
#
|
164
|
+
class CreateEvaluationJobResponse < Struct.new(
|
165
|
+
:job_arn)
|
166
|
+
SENSITIVE = []
|
167
|
+
include Aws::Structure
|
168
|
+
end
|
169
|
+
|
170
|
+
# @!attribute [rw] name
|
171
|
+
# The name to give the guardrail.
|
172
|
+
# @return [String]
|
173
|
+
#
|
174
|
+
# @!attribute [rw] description
|
175
|
+
# A description of the guardrail.
|
176
|
+
# @return [String]
|
177
|
+
#
|
178
|
+
# @!attribute [rw] topic_policy_config
|
179
|
+
# The topic policies to configure for the guardrail.
|
180
|
+
# @return [Types::GuardrailTopicPolicyConfig]
|
181
|
+
#
|
182
|
+
# @!attribute [rw] content_policy_config
|
183
|
+
# The content filter policies to configure for the guardrail.
|
184
|
+
# @return [Types::GuardrailContentPolicyConfig]
|
185
|
+
#
|
186
|
+
# @!attribute [rw] word_policy_config
|
187
|
+
# The word policy you configure for the guardrail.
|
188
|
+
# @return [Types::GuardrailWordPolicyConfig]
|
189
|
+
#
|
190
|
+
# @!attribute [rw] sensitive_information_policy_config
|
191
|
+
# The sensitive information policy to configure for the guardrail.
|
192
|
+
# @return [Types::GuardrailSensitiveInformationPolicyConfig]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] blocked_input_messaging
|
195
|
+
# The message to return when the guardrail blocks a prompt.
|
196
|
+
# @return [String]
|
197
|
+
#
|
198
|
+
# @!attribute [rw] blocked_outputs_messaging
|
199
|
+
# The message to return when the guardrail blocks a model response.
|
200
|
+
# @return [String]
|
201
|
+
#
|
202
|
+
# @!attribute [rw] kms_key_id
|
203
|
+
# The ARN of the KMS key that you use to encrypt the guardrail.
|
204
|
+
# @return [String]
|
205
|
+
#
|
206
|
+
# @!attribute [rw] tags
|
207
|
+
# The tags that you want to attach to the guardrail.
|
208
|
+
# @return [Array<Types::Tag>]
|
209
|
+
#
|
210
|
+
# @!attribute [rw] client_request_token
|
211
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
212
|
+
# completes no more than once. If this token matches a previous
|
213
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
214
|
+
# error. For more information, see [Ensuring idempotency][1] in the
|
215
|
+
# *Amazon S3 User Guide*.
|
216
|
+
#
|
217
|
+
# **A suitable default value is auto-generated.** You should normally
|
218
|
+
# not need to pass this option.
|
219
|
+
#
|
220
|
+
#
|
221
|
+
#
|
222
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
223
|
+
# @return [String]
|
224
|
+
#
|
225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateGuardrailRequest AWS API Documentation
|
226
|
+
#
|
227
|
+
class CreateGuardrailRequest < Struct.new(
|
228
|
+
:name,
|
229
|
+
:description,
|
230
|
+
:topic_policy_config,
|
231
|
+
:content_policy_config,
|
232
|
+
:word_policy_config,
|
233
|
+
:sensitive_information_policy_config,
|
234
|
+
:blocked_input_messaging,
|
235
|
+
:blocked_outputs_messaging,
|
236
|
+
:kms_key_id,
|
237
|
+
:tags,
|
238
|
+
:client_request_token)
|
239
|
+
SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]
|
240
|
+
include Aws::Structure
|
241
|
+
end
|
242
|
+
|
243
|
+
# @!attribute [rw] guardrail_id
|
244
|
+
# The unique identifier of the guardrail that was created.
|
245
|
+
# @return [String]
|
246
|
+
#
|
247
|
+
# @!attribute [rw] guardrail_arn
|
248
|
+
# The ARN of the guardrail that was created.
|
249
|
+
# @return [String]
|
250
|
+
#
|
251
|
+
# @!attribute [rw] version
|
252
|
+
# The version of the guardrail that was created. This value should be
|
253
|
+
# 1.
|
254
|
+
# @return [String]
|
255
|
+
#
|
256
|
+
# @!attribute [rw] created_at
|
257
|
+
# The time at which the guardrail was created.
|
258
|
+
# @return [Time]
|
259
|
+
#
|
260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateGuardrailResponse AWS API Documentation
|
261
|
+
#
|
262
|
+
class CreateGuardrailResponse < Struct.new(
|
263
|
+
:guardrail_id,
|
264
|
+
:guardrail_arn,
|
265
|
+
:version,
|
266
|
+
:created_at)
|
267
|
+
SENSITIVE = []
|
268
|
+
include Aws::Structure
|
269
|
+
end
|
270
|
+
|
271
|
+
# @!attribute [rw] guardrail_identifier
|
272
|
+
# The unique identifier of the guardrail.
|
273
|
+
# @return [String]
|
274
|
+
#
|
275
|
+
# @!attribute [rw] description
|
276
|
+
# A description of the guardrail version.
|
277
|
+
# @return [String]
|
278
|
+
#
|
279
|
+
# @!attribute [rw] client_request_token
|
280
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
281
|
+
# completes no more than once. If this token matches a previous
|
282
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
283
|
+
# error. For more information, see [Ensuring idempotency][1] in the
|
284
|
+
# *Amazon S3 User Guide*.
|
285
|
+
#
|
286
|
+
# **A suitable default value is auto-generated.** You should normally
|
287
|
+
# not need to pass this option.
|
288
|
+
#
|
289
|
+
#
|
290
|
+
#
|
291
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
292
|
+
# @return [String]
|
293
|
+
#
|
294
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateGuardrailVersionRequest AWS API Documentation
|
295
|
+
#
|
296
|
+
class CreateGuardrailVersionRequest < Struct.new(
|
297
|
+
:guardrail_identifier,
|
298
|
+
:description,
|
299
|
+
:client_request_token)
|
300
|
+
SENSITIVE = [:description]
|
301
|
+
include Aws::Structure
|
302
|
+
end
|
303
|
+
|
304
|
+
# @!attribute [rw] guardrail_id
|
305
|
+
# The unique identifier of the guardrail.
|
306
|
+
# @return [String]
|
307
|
+
#
|
308
|
+
# @!attribute [rw] version
|
309
|
+
# The number of the version of the guardrail.
|
310
|
+
# @return [String]
|
311
|
+
#
|
312
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateGuardrailVersionResponse AWS API Documentation
|
313
|
+
#
|
314
|
+
class CreateGuardrailVersionResponse < Struct.new(
|
315
|
+
:guardrail_id,
|
316
|
+
:version)
|
317
|
+
SENSITIVE = []
|
318
|
+
include Aws::Structure
|
319
|
+
end
|
320
|
+
|
321
|
+
# @!attribute [rw] job_name
|
322
|
+
# A name for the fine-tuning job.
|
65
323
|
# @return [String]
|
66
324
|
#
|
67
325
|
# @!attribute [rw] custom_model_name
|
68
|
-
#
|
326
|
+
# A name for the resulting custom model.
|
69
327
|
# @return [String]
|
70
328
|
#
|
71
329
|
# @!attribute [rw] role_arn
|
72
|
-
# The Amazon Resource Name (ARN) of an IAM role that Amazon
|
73
|
-
# can assume to perform tasks on your behalf. For example,
|
74
|
-
# model training, Amazon Bedrock needs your permission to read
|
75
|
-
# data from an S3 bucket, write model artifacts to an S3 bucket.
|
76
|
-
# pass this role to Amazon Bedrock, the caller of this API must
|
77
|
-
# the `iam:PassRole` permission.
|
330
|
+
# The Amazon Resource Name (ARN) of an IAM service role that Amazon
|
331
|
+
# Bedrock can assume to perform tasks on your behalf. For example,
|
332
|
+
# during model training, Amazon Bedrock needs your permission to read
|
333
|
+
# input data from an S3 bucket, write model artifacts to an S3 bucket.
|
334
|
+
# To pass this role to Amazon Bedrock, the caller of this API must
|
335
|
+
# have the `iam:PassRole` permission.
|
78
336
|
# @return [String]
|
79
337
|
#
|
80
338
|
# @!attribute [rw] client_request_token
|
81
|
-
#
|
82
|
-
#
|
339
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
340
|
+
# completes no more than one time. If this token matches a previous
|
341
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
342
|
+
# error. For more information, see [Ensuring idempotency][1].
|
83
343
|
#
|
84
344
|
# **A suitable default value is auto-generated.** You should normally
|
85
345
|
# not need to pass this option.
|
346
|
+
#
|
347
|
+
#
|
348
|
+
#
|
349
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
86
350
|
# @return [String]
|
87
351
|
#
|
88
352
|
# @!attribute [rw] base_model_identifier
|
@@ -98,11 +362,11 @@ module Aws::Bedrock
|
|
98
362
|
# @return [String]
|
99
363
|
#
|
100
364
|
# @!attribute [rw] job_tags
|
101
|
-
#
|
365
|
+
# Tags to attach to the job.
|
102
366
|
# @return [Array<Types::Tag>]
|
103
367
|
#
|
104
368
|
# @!attribute [rw] custom_model_tags
|
105
|
-
#
|
369
|
+
# Tags to attach to the resulting custom model.
|
106
370
|
# @return [Array<Types::Tag>]
|
107
371
|
#
|
108
372
|
# @!attribute [rw] training_data_config
|
@@ -118,7 +382,12 @@ module Aws::Bedrock
|
|
118
382
|
# @return [Types::OutputDataConfig]
|
119
383
|
#
|
120
384
|
# @!attribute [rw] hyper_parameters
|
121
|
-
# Parameters related to tuning the model.
|
385
|
+
# Parameters related to tuning the model. For details on the format
|
386
|
+
# for different models, see [Custom model hyperparameters][1].
|
387
|
+
#
|
388
|
+
#
|
389
|
+
#
|
390
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html
|
122
391
|
# @return [Hash<String,String>]
|
123
392
|
#
|
124
393
|
# @!attribute [rw] vpc_config
|
@@ -149,7 +418,7 @@ module Aws::Bedrock
|
|
149
418
|
end
|
150
419
|
|
151
420
|
# @!attribute [rw] job_arn
|
152
|
-
# ARN of the fine tuning job
|
421
|
+
# Amazon Resource Name (ARN) of the fine tuning job
|
153
422
|
# @return [String]
|
154
423
|
#
|
155
424
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateModelCustomizationJobResponse AWS API Documentation
|
@@ -161,33 +430,73 @@ module Aws::Bedrock
|
|
161
430
|
end
|
162
431
|
|
163
432
|
# @!attribute [rw] client_request_token
|
164
|
-
#
|
165
|
-
#
|
166
|
-
# return an
|
433
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
434
|
+
# completes no more than one time. If this token matches a previous
|
435
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
436
|
+
# error. For more information, see [Ensuring idempotency][1] in the
|
437
|
+
# Amazon S3 User Guide.
|
167
438
|
#
|
168
439
|
# **A suitable default value is auto-generated.** You should normally
|
169
440
|
# not need to pass this option.
|
441
|
+
#
|
442
|
+
#
|
443
|
+
#
|
444
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
170
445
|
# @return [String]
|
171
446
|
#
|
172
447
|
# @!attribute [rw] model_units
|
173
|
-
# Number of model units to allocate.
|
448
|
+
# Number of model units to allocate. A model unit delivers a specific
|
449
|
+
# throughput level for the specified model. The throughput level of a
|
450
|
+
# model unit specifies the total number of input and output tokens
|
451
|
+
# that it can process and generate within a span of one minute. By
|
452
|
+
# default, your account has no model units for purchasing Provisioned
|
453
|
+
# Throughputs with commitment. You must first visit the [Amazon Web
|
454
|
+
# Services support center][1] to request MUs.
|
455
|
+
#
|
456
|
+
# For model unit quotas, see [Provisioned Throughput quotas][2] in the
|
457
|
+
# Amazon Bedrock User Guide.
|
458
|
+
#
|
459
|
+
# For more information about what an MU specifies, contact your Amazon
|
460
|
+
# Web Services account manager.
|
461
|
+
#
|
462
|
+
#
|
463
|
+
#
|
464
|
+
# [1]: https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase
|
465
|
+
# [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html#prov-thru-quotas
|
174
466
|
# @return [Integer]
|
175
467
|
#
|
176
468
|
# @!attribute [rw] provisioned_model_name
|
177
|
-
#
|
469
|
+
# The name for this Provisioned Throughput.
|
178
470
|
# @return [String]
|
179
471
|
#
|
180
472
|
# @!attribute [rw] model_id
|
181
|
-
# Name or
|
182
|
-
#
|
473
|
+
# The Amazon Resource Name (ARN) or name of the model to associate
|
474
|
+
# with this Provisioned Throughput. For a list of models for which you
|
475
|
+
# can purchase Provisioned Throughput, see [Amazon Bedrock model IDs
|
476
|
+
# for purchasing Provisioned Throughput][1] in the Amazon Bedrock User
|
477
|
+
# Guide.
|
478
|
+
#
|
479
|
+
#
|
480
|
+
#
|
481
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#prov-throughput-models
|
183
482
|
# @return [String]
|
184
483
|
#
|
185
484
|
# @!attribute [rw] commitment_duration
|
186
|
-
#
|
485
|
+
# The commitment duration requested for the Provisioned Throughput.
|
486
|
+
# Billing occurs hourly and is discounted for longer commitment terms.
|
487
|
+
# To request a no-commit Provisioned Throughput, omit this field.
|
488
|
+
#
|
489
|
+
# Custom models support all levels of commitment. To see which base
|
490
|
+
# models support no commitment, see [Supported regions and models for
|
491
|
+
# Provisioned Throughput][1] in the Amazon Bedrock User Guide
|
492
|
+
#
|
493
|
+
#
|
494
|
+
#
|
495
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/pt-supported.html
|
187
496
|
# @return [String]
|
188
497
|
#
|
189
498
|
# @!attribute [rw] tags
|
190
|
-
# Tags to associate with this
|
499
|
+
# Tags to associate with this Provisioned Throughput.
|
191
500
|
# @return [Array<Types::Tag>]
|
192
501
|
#
|
193
502
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateProvisionedModelThroughputRequest AWS API Documentation
|
@@ -204,7 +513,7 @@ module Aws::Bedrock
|
|
204
513
|
end
|
205
514
|
|
206
515
|
# @!attribute [rw] provisioned_model_arn
|
207
|
-
# The ARN for this
|
516
|
+
# The Amazon Resource Name (ARN) for this Provisioned Throughput.
|
208
517
|
# @return [String]
|
209
518
|
#
|
210
519
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateProvisionedModelThroughputResponse AWS API Documentation
|
@@ -218,7 +527,7 @@ module Aws::Bedrock
|
|
218
527
|
# Summary information for a custom model.
|
219
528
|
#
|
220
529
|
# @!attribute [rw] model_arn
|
221
|
-
# The ARN of the custom model.
|
530
|
+
# The Amazon Resource Name (ARN) of the custom model.
|
222
531
|
# @return [String]
|
223
532
|
#
|
224
533
|
# @!attribute [rw] model_name
|
@@ -230,7 +539,7 @@ module Aws::Bedrock
|
|
230
539
|
# @return [Time]
|
231
540
|
#
|
232
541
|
# @!attribute [rw] base_model_arn
|
233
|
-
# The base model ARN.
|
542
|
+
# The base model Amazon Resource Name (ARN).
|
234
543
|
# @return [String]
|
235
544
|
#
|
236
545
|
# @!attribute [rw] base_model_name
|
@@ -276,6 +585,27 @@ module Aws::Bedrock
|
|
276
585
|
#
|
277
586
|
class DeleteCustomModelResponse < Aws::EmptyStructure; end
|
278
587
|
|
588
|
+
# @!attribute [rw] guardrail_identifier
|
589
|
+
# The unique identifier of the guardrail.
|
590
|
+
# @return [String]
|
591
|
+
#
|
592
|
+
# @!attribute [rw] guardrail_version
|
593
|
+
# The version of the guardrail.
|
594
|
+
# @return [String]
|
595
|
+
#
|
596
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteGuardrailRequest AWS API Documentation
|
597
|
+
#
|
598
|
+
class DeleteGuardrailRequest < Struct.new(
|
599
|
+
:guardrail_identifier,
|
600
|
+
:guardrail_version)
|
601
|
+
SENSITIVE = []
|
602
|
+
include Aws::Structure
|
603
|
+
end
|
604
|
+
|
605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteGuardrailResponse AWS API Documentation
|
606
|
+
#
|
607
|
+
class DeleteGuardrailResponse < Aws::EmptyStructure; end
|
608
|
+
|
279
609
|
# @api private
|
280
610
|
#
|
281
611
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteModelInvocationLoggingConfigurationRequest AWS API Documentation
|
@@ -287,7 +617,8 @@ module Aws::Bedrock
|
|
287
617
|
class DeleteModelInvocationLoggingConfigurationResponse < Aws::EmptyStructure; end
|
288
618
|
|
289
619
|
# @!attribute [rw] provisioned_model_id
|
290
|
-
# The ARN or name of the
|
620
|
+
# The Amazon Resource Name (ARN) or name of the Provisioned
|
621
|
+
# Throughput.
|
291
622
|
# @return [String]
|
292
623
|
#
|
293
624
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteProvisionedModelThroughputRequest AWS API Documentation
|
@@ -302,132 +633,386 @@ module Aws::Bedrock
|
|
302
633
|
#
|
303
634
|
class DeleteProvisionedModelThroughputResponse < Aws::EmptyStructure; end
|
304
635
|
|
305
|
-
#
|
636
|
+
# Contains the ARN of the Amazon Bedrock models specified in your model
|
637
|
+
# evaluation job. Each Amazon Bedrock model supports different
|
638
|
+
# `inferenceParams`. To learn more about supported inference parameters
|
639
|
+
# for Amazon Bedrock models, see [Inference parameters for foundation
|
640
|
+
# models][1].
|
306
641
|
#
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
642
|
+
# The `inferenceParams` are specified using JSON. To successfully insert
|
643
|
+
# JSON as string make sure that all quotations are properly escaped. For
|
644
|
+
# example, `"temperature":"0.25"` key value pair would need to be
|
645
|
+
# formatted as `"temperature":"0.25"` to successfully accepted in
|
646
|
+
# the request.
|
310
647
|
#
|
311
|
-
# @!attribute [rw] model_id
|
312
|
-
# The model identifier.
|
313
|
-
# @return [String]
|
314
648
|
#
|
315
|
-
#
|
316
|
-
#
|
649
|
+
#
|
650
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-prompt-datasets-custom.html
|
651
|
+
#
|
652
|
+
# @!attribute [rw] model_identifier
|
653
|
+
# The ARN of the Amazon Bedrock model specified.
|
317
654
|
# @return [String]
|
318
655
|
#
|
319
|
-
# @!attribute [rw]
|
320
|
-
#
|
656
|
+
# @!attribute [rw] inference_params
|
657
|
+
# Each Amazon Bedrock support different inference parameters that
|
658
|
+
# change how the model behaves during inference.
|
321
659
|
# @return [String]
|
322
660
|
#
|
323
|
-
#
|
324
|
-
# The input modalities that the model supports.
|
325
|
-
# @return [Array<String>]
|
661
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationBedrockModel AWS API Documentation
|
326
662
|
#
|
327
|
-
|
328
|
-
|
329
|
-
|
663
|
+
class EvaluationBedrockModel < Struct.new(
|
664
|
+
:model_identifier,
|
665
|
+
:inference_params)
|
666
|
+
SENSITIVE = [:inference_params]
|
667
|
+
include Aws::Structure
|
668
|
+
end
|
669
|
+
|
670
|
+
# Used to specify either a `AutomatedEvaluationConfig` or
|
671
|
+
# `HumanEvaluationConfig` object.
|
330
672
|
#
|
331
|
-
#
|
332
|
-
# Indicates whether the model supports streaming.
|
333
|
-
# @return [Boolean]
|
673
|
+
# @note EvaluationConfig is a union - when making an API calls you must set exactly one of the members.
|
334
674
|
#
|
335
|
-
#
|
336
|
-
# The customization that the model supports.
|
337
|
-
# @return [Array<String>]
|
675
|
+
# @note EvaluationConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationConfig corresponding to the set member.
|
338
676
|
#
|
339
|
-
# @!attribute [rw]
|
340
|
-
#
|
341
|
-
#
|
677
|
+
# @!attribute [rw] automated
|
678
|
+
# Used to specify an automated model evaluation job. See
|
679
|
+
# `AutomatedEvaluationConfig` to view the required parameters.
|
680
|
+
# @return [Types::AutomatedEvaluationConfig]
|
342
681
|
#
|
343
|
-
# @!attribute [rw]
|
344
|
-
#
|
345
|
-
#
|
346
|
-
# @return [Types::
|
682
|
+
# @!attribute [rw] human
|
683
|
+
# Used to specify a model evaluation job that uses human workers.See
|
684
|
+
# `HumanEvaluationConfig` to view the required parameters.
|
685
|
+
# @return [Types::HumanEvaluationConfig]
|
347
686
|
#
|
348
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/
|
687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationConfig AWS API Documentation
|
349
688
|
#
|
350
|
-
class
|
351
|
-
:
|
352
|
-
:
|
353
|
-
:
|
354
|
-
:provider_name,
|
355
|
-
:input_modalities,
|
356
|
-
:output_modalities,
|
357
|
-
:response_streaming_supported,
|
358
|
-
:customizations_supported,
|
359
|
-
:inference_types_supported,
|
360
|
-
:model_lifecycle)
|
689
|
+
class EvaluationConfig < Struct.new(
|
690
|
+
:automated,
|
691
|
+
:human,
|
692
|
+
:unknown)
|
361
693
|
SENSITIVE = []
|
362
694
|
include Aws::Structure
|
695
|
+
include Aws::Structure::Union
|
696
|
+
|
697
|
+
class Automated < EvaluationConfig; end
|
698
|
+
class Human < EvaluationConfig; end
|
699
|
+
class Unknown < EvaluationConfig; end
|
363
700
|
end
|
364
701
|
|
365
|
-
#
|
702
|
+
# Used to specify the name of a built-in prompt dataset and optionally,
|
703
|
+
# the Amazon S3 bucket where a custom prompt dataset is saved.
|
366
704
|
#
|
367
|
-
# @!attribute [rw]
|
368
|
-
#
|
369
|
-
#
|
705
|
+
# @!attribute [rw] name
|
706
|
+
# Used to specify supported built-in prompt datasets. Valid values are
|
707
|
+
# `Builtin.Bold`, `Builtin.BoolQ`, `Builtin.NaturalQuestions`,
|
708
|
+
# `Builtin.Gigaword`, `Builtin.RealToxicityPrompts`,
|
709
|
+
# `Builtin.TriviaQa`, `Builtin.T-Rex`,
|
710
|
+
# `Builtin.WomensEcommerceClothingReviews` and `Builtin.Wikitext2`.
|
370
711
|
# @return [String]
|
371
712
|
#
|
372
|
-
#
|
713
|
+
# @!attribute [rw] dataset_location
|
714
|
+
# For custom prompt datasets, you must specify the location in Amazon
|
715
|
+
# S3 where the prompt dataset is saved.
|
716
|
+
# @return [Types::EvaluationDatasetLocation]
|
373
717
|
#
|
374
|
-
|
375
|
-
|
376
|
-
|
718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationDataset AWS API Documentation
|
719
|
+
#
|
720
|
+
class EvaluationDataset < Struct.new(
|
721
|
+
:name,
|
722
|
+
:dataset_location)
|
723
|
+
SENSITIVE = [:name]
|
377
724
|
include Aws::Structure
|
378
725
|
end
|
379
726
|
|
380
|
-
#
|
727
|
+
# The location in Amazon S3 where your prompt dataset is stored.
|
381
728
|
#
|
382
|
-
#
|
383
|
-
# The ARN of the foundation model.
|
384
|
-
# @return [String]
|
729
|
+
# @note EvaluationDatasetLocation is a union - when making an API calls you must set exactly one of the members.
|
385
730
|
#
|
386
|
-
#
|
387
|
-
# The model Id of the foundation model.
|
388
|
-
# @return [String]
|
731
|
+
# @note EvaluationDatasetLocation is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationDatasetLocation corresponding to the set member.
|
389
732
|
#
|
390
|
-
# @!attribute [rw]
|
391
|
-
# The
|
733
|
+
# @!attribute [rw] s3_uri
|
734
|
+
# The S3 URI of the S3 bucket specified in the job.
|
392
735
|
# @return [String]
|
393
736
|
#
|
394
|
-
#
|
395
|
-
#
|
737
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationDatasetLocation AWS API Documentation
|
738
|
+
#
|
739
|
+
class EvaluationDatasetLocation < Struct.new(
|
740
|
+
:s3_uri,
|
741
|
+
:unknown)
|
742
|
+
SENSITIVE = []
|
743
|
+
include Aws::Structure
|
744
|
+
include Aws::Structure::Union
|
745
|
+
|
746
|
+
class S3Uri < EvaluationDatasetLocation; end
|
747
|
+
class Unknown < EvaluationDatasetLocation; end
|
748
|
+
end
|
749
|
+
|
750
|
+
# Defines the built-in prompt datasets, built-in metric names and custom
|
751
|
+
# metric names, and the task type.
|
752
|
+
#
|
753
|
+
# @!attribute [rw] task_type
|
754
|
+
# The task type you want the model to carry out.
|
396
755
|
# @return [String]
|
397
756
|
#
|
398
|
-
# @!attribute [rw]
|
399
|
-
#
|
400
|
-
# @return [
|
757
|
+
# @!attribute [rw] dataset
|
758
|
+
# Specifies the prompt dataset.
|
759
|
+
# @return [Types::EvaluationDataset]
|
401
760
|
#
|
402
|
-
# @!attribute [rw]
|
403
|
-
# The
|
761
|
+
# @!attribute [rw] metric_names
|
762
|
+
# The names of the metrics used. For automated model evaluation jobs
|
763
|
+
# valid values are `"Builtin.Accuracy"`, `"Builtin.Robustness"`, and
|
764
|
+
# `"Builtin.Toxicity"`. In human-based model evaluation jobs the array
|
765
|
+
# of strings must match the `name` parameter specified in
|
766
|
+
# `HumanEvaluationCustomMetric`.
|
404
767
|
# @return [Array<String>]
|
405
768
|
#
|
406
|
-
#
|
407
|
-
# Indicates whether the model supports streaming.
|
408
|
-
# @return [Boolean]
|
769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationDatasetMetricConfig AWS API Documentation
|
409
770
|
#
|
410
|
-
|
411
|
-
|
412
|
-
|
771
|
+
class EvaluationDatasetMetricConfig < Struct.new(
|
772
|
+
:task_type,
|
773
|
+
:dataset,
|
774
|
+
:metric_names)
|
775
|
+
SENSITIVE = []
|
776
|
+
include Aws::Structure
|
777
|
+
end
|
778
|
+
|
779
|
+
# Used to define the models you want used in your model evaluation job.
|
780
|
+
# Automated model evaluation jobs support only a single model. In a
|
781
|
+
# human-based model evaluation job, your annotator can compare the
|
782
|
+
# responses for up to two different models.
|
413
783
|
#
|
414
|
-
#
|
415
|
-
# The inference types that the model supports.
|
416
|
-
# @return [Array<String>]
|
784
|
+
# @note EvaluationInferenceConfig is a union - when making an API calls you must set exactly one of the members.
|
417
785
|
#
|
418
|
-
#
|
419
|
-
# Contains details about whether a model version is available or
|
420
|
-
# deprecated.
|
421
|
-
# @return [Types::FoundationModelLifecycle]
|
786
|
+
# @note EvaluationInferenceConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationInferenceConfig corresponding to the set member.
|
422
787
|
#
|
423
|
-
#
|
788
|
+
# @!attribute [rw] models
|
789
|
+
# Used to specify the models.
|
790
|
+
# @return [Array<Types::EvaluationModelConfig>]
|
424
791
|
#
|
425
|
-
|
426
|
-
|
427
|
-
|
428
|
-
:
|
429
|
-
:
|
430
|
-
|
792
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationInferenceConfig AWS API Documentation
|
793
|
+
#
|
794
|
+
class EvaluationInferenceConfig < Struct.new(
|
795
|
+
:models,
|
796
|
+
:unknown)
|
797
|
+
SENSITIVE = []
|
798
|
+
include Aws::Structure
|
799
|
+
include Aws::Structure::Union
|
800
|
+
|
801
|
+
class Models < EvaluationInferenceConfig; end
|
802
|
+
class Unknown < EvaluationInferenceConfig; end
|
803
|
+
end
|
804
|
+
|
805
|
+
# Defines the models used in the model evaluation job.
|
806
|
+
#
|
807
|
+
# @note EvaluationModelConfig is a union - when making an API calls you must set exactly one of the members.
|
808
|
+
#
|
809
|
+
# @note EvaluationModelConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationModelConfig corresponding to the set member.
|
810
|
+
#
|
811
|
+
# @!attribute [rw] bedrock_model
|
812
|
+
# Defines the Amazon Bedrock model and inference parameters you want
|
813
|
+
# used.
|
814
|
+
# @return [Types::EvaluationBedrockModel]
|
815
|
+
#
|
816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationModelConfig AWS API Documentation
|
817
|
+
#
|
818
|
+
class EvaluationModelConfig < Struct.new(
|
819
|
+
:bedrock_model,
|
820
|
+
:unknown)
|
821
|
+
SENSITIVE = []
|
822
|
+
include Aws::Structure
|
823
|
+
include Aws::Structure::Union
|
824
|
+
|
825
|
+
class BedrockModel < EvaluationModelConfig; end
|
826
|
+
class Unknown < EvaluationModelConfig; end
|
827
|
+
end
|
828
|
+
|
829
|
+
# The Amazon S3 location where the results of your model evaluation job
|
830
|
+
# are saved.
|
831
|
+
#
|
832
|
+
# @!attribute [rw] s3_uri
|
833
|
+
# The Amazon S3 URI where the results of model evaluation job are
|
834
|
+
# saved.
|
835
|
+
# @return [String]
|
836
|
+
#
|
837
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationOutputDataConfig AWS API Documentation
|
838
|
+
#
|
839
|
+
class EvaluationOutputDataConfig < Struct.new(
|
840
|
+
:s3_uri)
|
841
|
+
SENSITIVE = []
|
842
|
+
include Aws::Structure
|
843
|
+
end
|
844
|
+
|
845
|
+
# A summary of the model evaluation job.
|
846
|
+
#
|
847
|
+
# @!attribute [rw] job_arn
|
848
|
+
# The Amazon Resource Name (ARN) of the model evaluation job.
|
849
|
+
# @return [String]
|
850
|
+
#
|
851
|
+
# @!attribute [rw] job_name
|
852
|
+
# The name of the model evaluation job.
|
853
|
+
# @return [String]
|
854
|
+
#
|
855
|
+
# @!attribute [rw] status
|
856
|
+
# The current status of the model evaluation job.
|
857
|
+
# @return [String]
|
858
|
+
#
|
859
|
+
# @!attribute [rw] creation_time
|
860
|
+
# When the model evaluation job was created.
|
861
|
+
# @return [Time]
|
862
|
+
#
|
863
|
+
# @!attribute [rw] job_type
|
864
|
+
# The type, either human or automatic, of model evaluation job.
|
865
|
+
# @return [String]
|
866
|
+
#
|
867
|
+
# @!attribute [rw] evaluation_task_types
|
868
|
+
# What task type was used in the model evaluation job.
|
869
|
+
# @return [Array<String>]
|
870
|
+
#
|
871
|
+
# @!attribute [rw] model_identifiers
|
872
|
+
# The Amazon Resource Names (ARNs) of the model(s) used in the model
|
873
|
+
# evaluation job.
|
874
|
+
# @return [Array<String>]
|
875
|
+
#
|
876
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationSummary AWS API Documentation
|
877
|
+
#
|
878
|
+
class EvaluationSummary < Struct.new(
|
879
|
+
:job_arn,
|
880
|
+
:job_name,
|
881
|
+
:status,
|
882
|
+
:creation_time,
|
883
|
+
:job_type,
|
884
|
+
:evaluation_task_types,
|
885
|
+
:model_identifiers)
|
886
|
+
SENSITIVE = []
|
887
|
+
include Aws::Structure
|
888
|
+
end
|
889
|
+
|
890
|
+
# Information about a foundation model.
|
891
|
+
#
|
892
|
+
# @!attribute [rw] model_arn
|
893
|
+
# The model Amazon Resource Name (ARN).
|
894
|
+
# @return [String]
|
895
|
+
#
|
896
|
+
# @!attribute [rw] model_id
|
897
|
+
# The model identifier.
|
898
|
+
# @return [String]
|
899
|
+
#
|
900
|
+
# @!attribute [rw] model_name
|
901
|
+
# The model name.
|
902
|
+
# @return [String]
|
903
|
+
#
|
904
|
+
# @!attribute [rw] provider_name
|
905
|
+
# The model's provider name.
|
906
|
+
# @return [String]
|
907
|
+
#
|
908
|
+
# @!attribute [rw] input_modalities
|
909
|
+
# The input modalities that the model supports.
|
910
|
+
# @return [Array<String>]
|
911
|
+
#
|
912
|
+
# @!attribute [rw] output_modalities
|
913
|
+
# The output modalities that the model supports.
|
914
|
+
# @return [Array<String>]
|
915
|
+
#
|
916
|
+
# @!attribute [rw] response_streaming_supported
|
917
|
+
# Indicates whether the model supports streaming.
|
918
|
+
# @return [Boolean]
|
919
|
+
#
|
920
|
+
# @!attribute [rw] customizations_supported
|
921
|
+
# The customization that the model supports.
|
922
|
+
# @return [Array<String>]
|
923
|
+
#
|
924
|
+
# @!attribute [rw] inference_types_supported
|
925
|
+
# The inference types that the model supports.
|
926
|
+
# @return [Array<String>]
|
927
|
+
#
|
928
|
+
# @!attribute [rw] model_lifecycle
|
929
|
+
# Contains details about whether a model version is available or
|
930
|
+
# deprecated
|
931
|
+
# @return [Types::FoundationModelLifecycle]
|
932
|
+
#
|
933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/FoundationModelDetails AWS API Documentation
|
934
|
+
#
|
935
|
+
class FoundationModelDetails < Struct.new(
|
936
|
+
:model_arn,
|
937
|
+
:model_id,
|
938
|
+
:model_name,
|
939
|
+
:provider_name,
|
940
|
+
:input_modalities,
|
941
|
+
:output_modalities,
|
942
|
+
:response_streaming_supported,
|
943
|
+
:customizations_supported,
|
944
|
+
:inference_types_supported,
|
945
|
+
:model_lifecycle)
|
946
|
+
SENSITIVE = []
|
947
|
+
include Aws::Structure
|
948
|
+
end
|
949
|
+
|
950
|
+
# Details about whether a model version is available or deprecated.
|
951
|
+
#
|
952
|
+
# @!attribute [rw] status
|
953
|
+
# Specifies whether a model version is available (`ACTIVE`) or
|
954
|
+
# deprecated (`LEGACY`.
|
955
|
+
# @return [String]
|
956
|
+
#
|
957
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/FoundationModelLifecycle AWS API Documentation
|
958
|
+
#
|
959
|
+
class FoundationModelLifecycle < Struct.new(
|
960
|
+
:status)
|
961
|
+
SENSITIVE = []
|
962
|
+
include Aws::Structure
|
963
|
+
end
|
964
|
+
|
965
|
+
# Summary information for a foundation model.
|
966
|
+
#
|
967
|
+
# @!attribute [rw] model_arn
|
968
|
+
# The Amazon Resource Name (ARN) of the foundation model.
|
969
|
+
# @return [String]
|
970
|
+
#
|
971
|
+
# @!attribute [rw] model_id
|
972
|
+
# The model ID of the foundation model.
|
973
|
+
# @return [String]
|
974
|
+
#
|
975
|
+
# @!attribute [rw] model_name
|
976
|
+
# The name of the model.
|
977
|
+
# @return [String]
|
978
|
+
#
|
979
|
+
# @!attribute [rw] provider_name
|
980
|
+
# The model's provider name.
|
981
|
+
# @return [String]
|
982
|
+
#
|
983
|
+
# @!attribute [rw] input_modalities
|
984
|
+
# The input modalities that the model supports.
|
985
|
+
# @return [Array<String>]
|
986
|
+
#
|
987
|
+
# @!attribute [rw] output_modalities
|
988
|
+
# The output modalities that the model supports.
|
989
|
+
# @return [Array<String>]
|
990
|
+
#
|
991
|
+
# @!attribute [rw] response_streaming_supported
|
992
|
+
# Indicates whether the model supports streaming.
|
993
|
+
# @return [Boolean]
|
994
|
+
#
|
995
|
+
# @!attribute [rw] customizations_supported
|
996
|
+
# Whether the model supports fine-tuning or continual pre-training.
|
997
|
+
# @return [Array<String>]
|
998
|
+
#
|
999
|
+
# @!attribute [rw] inference_types_supported
|
1000
|
+
# The inference types that the model supports.
|
1001
|
+
# @return [Array<String>]
|
1002
|
+
#
|
1003
|
+
# @!attribute [rw] model_lifecycle
|
1004
|
+
# Contains details about whether a model version is available or
|
1005
|
+
# deprecated.
|
1006
|
+
# @return [Types::FoundationModelLifecycle]
|
1007
|
+
#
|
1008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/FoundationModelSummary AWS API Documentation
|
1009
|
+
#
|
1010
|
+
class FoundationModelSummary < Struct.new(
|
1011
|
+
:model_arn,
|
1012
|
+
:model_id,
|
1013
|
+
:model_name,
|
1014
|
+
:provider_name,
|
1015
|
+
:input_modalities,
|
431
1016
|
:output_modalities,
|
432
1017
|
:response_streaming_supported,
|
433
1018
|
:customizations_supported,
|
@@ -438,7 +1023,7 @@ module Aws::Bedrock
|
|
438
1023
|
end
|
439
1024
|
|
440
1025
|
# @!attribute [rw] model_identifier
|
441
|
-
# Name or ARN of the custom model.
|
1026
|
+
# Name or Amazon Resource Name (ARN) of the custom model.
|
442
1027
|
# @return [String]
|
443
1028
|
#
|
444
1029
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetCustomModelRequest AWS API Documentation
|
@@ -450,7 +1035,7 @@ module Aws::Bedrock
|
|
450
1035
|
end
|
451
1036
|
|
452
1037
|
# @!attribute [rw] model_arn
|
453
|
-
# ARN associated with this model.
|
1038
|
+
# Amazon Resource Name (ARN) associated with this model.
|
454
1039
|
# @return [String]
|
455
1040
|
#
|
456
1041
|
# @!attribute [rw] model_name
|
@@ -462,11 +1047,11 @@ module Aws::Bedrock
|
|
462
1047
|
# @return [String]
|
463
1048
|
#
|
464
1049
|
# @!attribute [rw] job_arn
|
465
|
-
# Job ARN associated with this model.
|
1050
|
+
# Job Amazon Resource Name (ARN) associated with this model.
|
466
1051
|
# @return [String]
|
467
1052
|
#
|
468
1053
|
# @!attribute [rw] base_model_arn
|
469
|
-
# ARN of the base model.
|
1054
|
+
# Amazon Resource Name (ARN) of the base model.
|
470
1055
|
# @return [String]
|
471
1056
|
#
|
472
1057
|
# @!attribute [rw] customization_type
|
@@ -478,15 +1063,20 @@ module Aws::Bedrock
|
|
478
1063
|
# @return [String]
|
479
1064
|
#
|
480
1065
|
# @!attribute [rw] hyper_parameters
|
481
|
-
# Hyperparameter values associated with this model.
|
1066
|
+
# Hyperparameter values associated with this model. For details on the
|
1067
|
+
# format for different models, see [Custom model hyperparameters][1].
|
1068
|
+
#
|
1069
|
+
#
|
1070
|
+
#
|
1071
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html
|
482
1072
|
# @return [Hash<String,String>]
|
483
1073
|
#
|
484
1074
|
# @!attribute [rw] training_data_config
|
485
|
-
#
|
1075
|
+
# Contains information about the training dataset.
|
486
1076
|
# @return [Types::TrainingDataConfig]
|
487
1077
|
#
|
488
1078
|
# @!attribute [rw] validation_data_config
|
489
|
-
#
|
1079
|
+
# Contains information about the validation dataset.
|
490
1080
|
# @return [Types::ValidationDataConfig]
|
491
1081
|
#
|
492
1082
|
# @!attribute [rw] output_data_config
|
@@ -494,7 +1084,7 @@ module Aws::Bedrock
|
|
494
1084
|
# @return [Types::OutputDataConfig]
|
495
1085
|
#
|
496
1086
|
# @!attribute [rw] training_metrics
|
497
|
-
#
|
1087
|
+
# Contains training metrics from the job creation.
|
498
1088
|
# @return [Types::TrainingMetrics]
|
499
1089
|
#
|
500
1090
|
# @!attribute [rw] validation_metrics
|
@@ -526,6 +1116,95 @@ module Aws::Bedrock
|
|
526
1116
|
include Aws::Structure
|
527
1117
|
end
|
528
1118
|
|
1119
|
+
# @!attribute [rw] job_identifier
|
1120
|
+
# The Amazon Resource Name (ARN) of the model evaluation job.
|
1121
|
+
# @return [String]
|
1122
|
+
#
|
1123
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetEvaluationJobRequest AWS API Documentation
|
1124
|
+
#
|
1125
|
+
class GetEvaluationJobRequest < Struct.new(
|
1126
|
+
:job_identifier)
|
1127
|
+
SENSITIVE = [:job_identifier]
|
1128
|
+
include Aws::Structure
|
1129
|
+
end
|
1130
|
+
|
1131
|
+
# @!attribute [rw] job_name
|
1132
|
+
# The name of the model evaluation job.
|
1133
|
+
# @return [String]
|
1134
|
+
#
|
1135
|
+
# @!attribute [rw] status
|
1136
|
+
# The status of the model evaluation job.
|
1137
|
+
# @return [String]
|
1138
|
+
#
|
1139
|
+
# @!attribute [rw] job_arn
|
1140
|
+
# The Amazon Resource Name (ARN) of the model evaluation job.
|
1141
|
+
# @return [String]
|
1142
|
+
#
|
1143
|
+
# @!attribute [rw] job_description
|
1144
|
+
# The description of the model evaluation job.
|
1145
|
+
# @return [String]
|
1146
|
+
#
|
1147
|
+
# @!attribute [rw] role_arn
|
1148
|
+
# The Amazon Resource Name (ARN) of the IAM service role used in the
|
1149
|
+
# model evaluation job.
|
1150
|
+
# @return [String]
|
1151
|
+
#
|
1152
|
+
# @!attribute [rw] customer_encryption_key_id
|
1153
|
+
# The Amazon Resource Name (ARN) of the customer managed key specified
|
1154
|
+
# when the model evaluation job was created.
|
1155
|
+
# @return [String]
|
1156
|
+
#
|
1157
|
+
# @!attribute [rw] job_type
|
1158
|
+
# The type of model evaluation job.
|
1159
|
+
# @return [String]
|
1160
|
+
#
|
1161
|
+
# @!attribute [rw] evaluation_config
|
1162
|
+
# Contains details about the type of model evaluation job, the metrics
|
1163
|
+
# used, the task type selected, the datasets used, and any custom
|
1164
|
+
# metrics you defined.
|
1165
|
+
# @return [Types::EvaluationConfig]
|
1166
|
+
#
|
1167
|
+
# @!attribute [rw] inference_config
|
1168
|
+
# Details about the models you specified in your model evaluation job.
|
1169
|
+
# @return [Types::EvaluationInferenceConfig]
|
1170
|
+
#
|
1171
|
+
# @!attribute [rw] output_data_config
|
1172
|
+
# Amazon S3 location for where output data is saved.
|
1173
|
+
# @return [Types::EvaluationOutputDataConfig]
|
1174
|
+
#
|
1175
|
+
# @!attribute [rw] creation_time
|
1176
|
+
# When the model evaluation job was created.
|
1177
|
+
# @return [Time]
|
1178
|
+
#
|
1179
|
+
# @!attribute [rw] last_modified_time
|
1180
|
+
# When the model evaluation job was last modified.
|
1181
|
+
# @return [Time]
|
1182
|
+
#
|
1183
|
+
# @!attribute [rw] failure_messages
|
1184
|
+
# An array of strings the specify why the model evaluation job has
|
1185
|
+
# failed.
|
1186
|
+
# @return [Array<String>]
|
1187
|
+
#
|
1188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetEvaluationJobResponse AWS API Documentation
|
1189
|
+
#
|
1190
|
+
class GetEvaluationJobResponse < Struct.new(
|
1191
|
+
:job_name,
|
1192
|
+
:status,
|
1193
|
+
:job_arn,
|
1194
|
+
:job_description,
|
1195
|
+
:role_arn,
|
1196
|
+
:customer_encryption_key_id,
|
1197
|
+
:job_type,
|
1198
|
+
:evaluation_config,
|
1199
|
+
:inference_config,
|
1200
|
+
:output_data_config,
|
1201
|
+
:creation_time,
|
1202
|
+
:last_modified_time,
|
1203
|
+
:failure_messages)
|
1204
|
+
SENSITIVE = [:job_description]
|
1205
|
+
include Aws::Structure
|
1206
|
+
end
|
1207
|
+
|
529
1208
|
# @!attribute [rw] model_identifier
|
530
1209
|
# The model identifier.
|
531
1210
|
# @return [String]
|
@@ -550,54 +1229,170 @@ module Aws::Bedrock
|
|
550
1229
|
include Aws::Structure
|
551
1230
|
end
|
552
1231
|
|
553
|
-
# @!attribute [rw]
|
554
|
-
#
|
1232
|
+
# @!attribute [rw] guardrail_identifier
|
1233
|
+
# The unique identifier of the guardrail for which to get details.
|
555
1234
|
# @return [String]
|
556
1235
|
#
|
557
|
-
#
|
1236
|
+
# @!attribute [rw] guardrail_version
|
1237
|
+
# The version of the guardrail for which to get details. If you don't
|
1238
|
+
# specify a version, the response returns details for the `DRAFT`
|
1239
|
+
# version.
|
1240
|
+
# @return [String]
|
558
1241
|
#
|
559
|
-
|
560
|
-
|
1242
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetGuardrailRequest AWS API Documentation
|
1243
|
+
#
|
1244
|
+
class GetGuardrailRequest < Struct.new(
|
1245
|
+
:guardrail_identifier,
|
1246
|
+
:guardrail_version)
|
561
1247
|
SENSITIVE = []
|
562
1248
|
include Aws::Structure
|
563
1249
|
end
|
564
1250
|
|
565
|
-
# @!attribute [rw]
|
566
|
-
# The
|
567
|
-
# @return [String]
|
568
|
-
#
|
569
|
-
# @!attribute [rw] job_name
|
570
|
-
# The name of the customization job.
|
1251
|
+
# @!attribute [rw] name
|
1252
|
+
# The name of the guardrail.
|
571
1253
|
# @return [String]
|
572
1254
|
#
|
573
|
-
# @!attribute [rw]
|
574
|
-
# The
|
1255
|
+
# @!attribute [rw] description
|
1256
|
+
# The description of the guardrail.
|
575
1257
|
# @return [String]
|
576
1258
|
#
|
577
|
-
# @!attribute [rw]
|
578
|
-
# The
|
1259
|
+
# @!attribute [rw] guardrail_id
|
1260
|
+
# The unique identifier of the guardrail.
|
579
1261
|
# @return [String]
|
580
1262
|
#
|
581
|
-
# @!attribute [rw]
|
582
|
-
# The
|
1263
|
+
# @!attribute [rw] guardrail_arn
|
1264
|
+
# The ARN of the guardrail that was created.
|
583
1265
|
# @return [String]
|
584
1266
|
#
|
585
|
-
# @!attribute [rw]
|
586
|
-
# The
|
1267
|
+
# @!attribute [rw] version
|
1268
|
+
# The version of the guardrail.
|
587
1269
|
# @return [String]
|
588
1270
|
#
|
589
1271
|
# @!attribute [rw] status
|
590
|
-
# The status of the
|
591
|
-
# to completed when the output model is ready to use. If the job
|
592
|
-
# failed, the failure message contains information about why the job
|
593
|
-
# failed.
|
1272
|
+
# The status of the guardrail.
|
594
1273
|
# @return [String]
|
595
1274
|
#
|
596
|
-
# @!attribute [rw]
|
597
|
-
#
|
598
|
-
# @return [
|
1275
|
+
# @!attribute [rw] topic_policy
|
1276
|
+
# The topic policy that was configured for the guardrail.
|
1277
|
+
# @return [Types::GuardrailTopicPolicy]
|
599
1278
|
#
|
600
|
-
# @!attribute [rw]
|
1279
|
+
# @!attribute [rw] content_policy
|
1280
|
+
# The content policy that was configured for the guardrail.
|
1281
|
+
# @return [Types::GuardrailContentPolicy]
|
1282
|
+
#
|
1283
|
+
# @!attribute [rw] word_policy
|
1284
|
+
# The word policy that was configured for the guardrail.
|
1285
|
+
# @return [Types::GuardrailWordPolicy]
|
1286
|
+
#
|
1287
|
+
# @!attribute [rw] sensitive_information_policy
|
1288
|
+
# The sensitive information policy that was configured for the
|
1289
|
+
# guardrail.
|
1290
|
+
# @return [Types::GuardrailSensitiveInformationPolicy]
|
1291
|
+
#
|
1292
|
+
# @!attribute [rw] created_at
|
1293
|
+
# The date and time at which the guardrail was created.
|
1294
|
+
# @return [Time]
|
1295
|
+
#
|
1296
|
+
# @!attribute [rw] updated_at
|
1297
|
+
# The date and time at which the guardrail was updated.
|
1298
|
+
# @return [Time]
|
1299
|
+
#
|
1300
|
+
# @!attribute [rw] status_reasons
|
1301
|
+
# Appears if the `status` is `FAILED`. A list of reasons for why the
|
1302
|
+
# guardrail failed to be created, updated, versioned, or deleted.
|
1303
|
+
# @return [Array<String>]
|
1304
|
+
#
|
1305
|
+
# @!attribute [rw] failure_recommendations
|
1306
|
+
# Appears if the `status` of the guardrail is `FAILED`. A list of
|
1307
|
+
# recommendations to carry out before retrying the request.
|
1308
|
+
# @return [Array<String>]
|
1309
|
+
#
|
1310
|
+
# @!attribute [rw] blocked_input_messaging
|
1311
|
+
# The message that the guardrail returns when it blocks a prompt.
|
1312
|
+
# @return [String]
|
1313
|
+
#
|
1314
|
+
# @!attribute [rw] blocked_outputs_messaging
|
1315
|
+
# The message that the guardrail returns when it blocks a model
|
1316
|
+
# response.
|
1317
|
+
# @return [String]
|
1318
|
+
#
|
1319
|
+
# @!attribute [rw] kms_key_arn
|
1320
|
+
# The ARN of the KMS key that encrypts the guardrail.
|
1321
|
+
# @return [String]
|
1322
|
+
#
|
1323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetGuardrailResponse AWS API Documentation
|
1324
|
+
#
|
1325
|
+
class GetGuardrailResponse < Struct.new(
|
1326
|
+
:name,
|
1327
|
+
:description,
|
1328
|
+
:guardrail_id,
|
1329
|
+
:guardrail_arn,
|
1330
|
+
:version,
|
1331
|
+
:status,
|
1332
|
+
:topic_policy,
|
1333
|
+
:content_policy,
|
1334
|
+
:word_policy,
|
1335
|
+
:sensitive_information_policy,
|
1336
|
+
:created_at,
|
1337
|
+
:updated_at,
|
1338
|
+
:status_reasons,
|
1339
|
+
:failure_recommendations,
|
1340
|
+
:blocked_input_messaging,
|
1341
|
+
:blocked_outputs_messaging,
|
1342
|
+
:kms_key_arn)
|
1343
|
+
SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]
|
1344
|
+
include Aws::Structure
|
1345
|
+
end
|
1346
|
+
|
1347
|
+
# @!attribute [rw] job_identifier
|
1348
|
+
# Identifier for the customization job.
|
1349
|
+
# @return [String]
|
1350
|
+
#
|
1351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelCustomizationJobRequest AWS API Documentation
|
1352
|
+
#
|
1353
|
+
class GetModelCustomizationJobRequest < Struct.new(
|
1354
|
+
:job_identifier)
|
1355
|
+
SENSITIVE = []
|
1356
|
+
include Aws::Structure
|
1357
|
+
end
|
1358
|
+
|
1359
|
+
# @!attribute [rw] job_arn
|
1360
|
+
# The Amazon Resource Name (ARN) of the customization job.
|
1361
|
+
# @return [String]
|
1362
|
+
#
|
1363
|
+
# @!attribute [rw] job_name
|
1364
|
+
# The name of the customization job.
|
1365
|
+
# @return [String]
|
1366
|
+
#
|
1367
|
+
# @!attribute [rw] output_model_name
|
1368
|
+
# The name of the output model.
|
1369
|
+
# @return [String]
|
1370
|
+
#
|
1371
|
+
# @!attribute [rw] output_model_arn
|
1372
|
+
# The Amazon Resource Name (ARN) of the output model.
|
1373
|
+
# @return [String]
|
1374
|
+
#
|
1375
|
+
# @!attribute [rw] client_request_token
|
1376
|
+
# The token that you specified in the `CreateCustomizationJob`
|
1377
|
+
# request.
|
1378
|
+
# @return [String]
|
1379
|
+
#
|
1380
|
+
# @!attribute [rw] role_arn
|
1381
|
+
# The Amazon Resource Name (ARN) of the IAM role.
|
1382
|
+
# @return [String]
|
1383
|
+
#
|
1384
|
+
# @!attribute [rw] status
|
1385
|
+
# The status of the job. A successful job transitions from in-progress
|
1386
|
+
# to completed when the output model is ready to use. If the job
|
1387
|
+
# failed, the failure message contains information about why the job
|
1388
|
+
# failed.
|
1389
|
+
# @return [String]
|
1390
|
+
#
|
1391
|
+
# @!attribute [rw] failure_message
|
1392
|
+
# Information about why the job failed.
|
1393
|
+
# @return [String]
|
1394
|
+
#
|
1395
|
+
# @!attribute [rw] creation_time
|
601
1396
|
# Time that the resource was created.
|
602
1397
|
# @return [Time]
|
603
1398
|
#
|
@@ -610,184 +1405,911 @@ module Aws::Bedrock
|
|
610
1405
|
# @return [Time]
|
611
1406
|
#
|
612
1407
|
# @!attribute [rw] base_model_arn
|
613
|
-
# ARN of the base model.
|
1408
|
+
# Amazon Resource Name (ARN) of the base model.
|
614
1409
|
# @return [String]
|
615
1410
|
#
|
616
1411
|
# @!attribute [rw] hyper_parameters
|
617
|
-
# The hyperparameter values for the job. For
|
618
|
-
#
|
619
|
-
# customization][1].
|
1412
|
+
# The hyperparameter values for the job. For details on the format for
|
1413
|
+
# different models, see [Custom model hyperparameters][1].
|
620
1414
|
#
|
621
1415
|
#
|
622
1416
|
#
|
623
|
-
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/
|
1417
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html
|
624
1418
|
# @return [Hash<String,String>]
|
625
1419
|
#
|
626
1420
|
# @!attribute [rw] training_data_config
|
627
|
-
#
|
1421
|
+
# Contains information about the training dataset.
|
628
1422
|
# @return [Types::TrainingDataConfig]
|
629
1423
|
#
|
630
|
-
# @!attribute [rw] validation_data_config
|
631
|
-
#
|
632
|
-
# @return [Types::ValidationDataConfig]
|
1424
|
+
# @!attribute [rw] validation_data_config
|
1425
|
+
# Contains information about the validation dataset.
|
1426
|
+
# @return [Types::ValidationDataConfig]
|
1427
|
+
#
|
1428
|
+
# @!attribute [rw] output_data_config
|
1429
|
+
# Output data configuration
|
1430
|
+
# @return [Types::OutputDataConfig]
|
1431
|
+
#
|
1432
|
+
# @!attribute [rw] customization_type
|
1433
|
+
# The type of model customization.
|
1434
|
+
# @return [String]
|
1435
|
+
#
|
1436
|
+
# @!attribute [rw] output_model_kms_key_arn
|
1437
|
+
# The custom model is encrypted at rest using this key.
|
1438
|
+
# @return [String]
|
1439
|
+
#
|
1440
|
+
# @!attribute [rw] training_metrics
|
1441
|
+
# Contains training metrics from the job creation.
|
1442
|
+
# @return [Types::TrainingMetrics]
|
1443
|
+
#
|
1444
|
+
# @!attribute [rw] validation_metrics
|
1445
|
+
# The loss metric for each validator that you provided in the
|
1446
|
+
# createjob request.
|
1447
|
+
# @return [Array<Types::ValidatorMetric>]
|
1448
|
+
#
|
1449
|
+
# @!attribute [rw] vpc_config
|
1450
|
+
# VPC configuration for the custom model job.
|
1451
|
+
# @return [Types::VpcConfig]
|
1452
|
+
#
|
1453
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelCustomizationJobResponse AWS API Documentation
|
1454
|
+
#
|
1455
|
+
class GetModelCustomizationJobResponse < Struct.new(
|
1456
|
+
:job_arn,
|
1457
|
+
:job_name,
|
1458
|
+
:output_model_name,
|
1459
|
+
:output_model_arn,
|
1460
|
+
:client_request_token,
|
1461
|
+
:role_arn,
|
1462
|
+
:status,
|
1463
|
+
:failure_message,
|
1464
|
+
:creation_time,
|
1465
|
+
:last_modified_time,
|
1466
|
+
:end_time,
|
1467
|
+
:base_model_arn,
|
1468
|
+
:hyper_parameters,
|
1469
|
+
:training_data_config,
|
1470
|
+
:validation_data_config,
|
1471
|
+
:output_data_config,
|
1472
|
+
:customization_type,
|
1473
|
+
:output_model_kms_key_arn,
|
1474
|
+
:training_metrics,
|
1475
|
+
:validation_metrics,
|
1476
|
+
:vpc_config)
|
1477
|
+
SENSITIVE = []
|
1478
|
+
include Aws::Structure
|
1479
|
+
end
|
1480
|
+
|
1481
|
+
# @api private
|
1482
|
+
#
|
1483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelInvocationLoggingConfigurationRequest AWS API Documentation
|
1484
|
+
#
|
1485
|
+
class GetModelInvocationLoggingConfigurationRequest < Aws::EmptyStructure; end
|
1486
|
+
|
1487
|
+
# @!attribute [rw] logging_config
|
1488
|
+
# The current configuration values.
|
1489
|
+
# @return [Types::LoggingConfig]
|
1490
|
+
#
|
1491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelInvocationLoggingConfigurationResponse AWS API Documentation
|
1492
|
+
#
|
1493
|
+
class GetModelInvocationLoggingConfigurationResponse < Struct.new(
|
1494
|
+
:logging_config)
|
1495
|
+
SENSITIVE = []
|
1496
|
+
include Aws::Structure
|
1497
|
+
end
|
1498
|
+
|
1499
|
+
# @!attribute [rw] provisioned_model_id
|
1500
|
+
# The Amazon Resource Name (ARN) or name of the Provisioned
|
1501
|
+
# Throughput.
|
1502
|
+
# @return [String]
|
1503
|
+
#
|
1504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetProvisionedModelThroughputRequest AWS API Documentation
|
1505
|
+
#
|
1506
|
+
class GetProvisionedModelThroughputRequest < Struct.new(
|
1507
|
+
:provisioned_model_id)
|
1508
|
+
SENSITIVE = []
|
1509
|
+
include Aws::Structure
|
1510
|
+
end
|
1511
|
+
|
1512
|
+
# @!attribute [rw] model_units
|
1513
|
+
# The number of model units allocated to this Provisioned Throughput.
|
1514
|
+
# @return [Integer]
|
1515
|
+
#
|
1516
|
+
# @!attribute [rw] desired_model_units
|
1517
|
+
# The number of model units that was requested for this Provisioned
|
1518
|
+
# Throughput.
|
1519
|
+
# @return [Integer]
|
1520
|
+
#
|
1521
|
+
# @!attribute [rw] provisioned_model_name
|
1522
|
+
# The name of the Provisioned Throughput.
|
1523
|
+
# @return [String]
|
1524
|
+
#
|
1525
|
+
# @!attribute [rw] provisioned_model_arn
|
1526
|
+
# The Amazon Resource Name (ARN) of the Provisioned Throughput.
|
1527
|
+
# @return [String]
|
1528
|
+
#
|
1529
|
+
# @!attribute [rw] model_arn
|
1530
|
+
# The Amazon Resource Name (ARN) of the model associated with this
|
1531
|
+
# Provisioned Throughput.
|
1532
|
+
# @return [String]
|
1533
|
+
#
|
1534
|
+
# @!attribute [rw] desired_model_arn
|
1535
|
+
# The Amazon Resource Name (ARN) of the model requested to be
|
1536
|
+
# associated to this Provisioned Throughput. This value differs from
|
1537
|
+
# the `modelArn` if updating hasn't completed.
|
1538
|
+
# @return [String]
|
1539
|
+
#
|
1540
|
+
# @!attribute [rw] foundation_model_arn
|
1541
|
+
# The Amazon Resource Name (ARN) of the base model for which the
|
1542
|
+
# Provisioned Throughput was created, or of the base model that the
|
1543
|
+
# custom model for which the Provisioned Throughput was created was
|
1544
|
+
# customized.
|
1545
|
+
# @return [String]
|
1546
|
+
#
|
1547
|
+
# @!attribute [rw] status
|
1548
|
+
# The status of the Provisioned Throughput.
|
1549
|
+
# @return [String]
|
1550
|
+
#
|
1551
|
+
# @!attribute [rw] creation_time
|
1552
|
+
# The timestamp of the creation time for this Provisioned Throughput.
|
1553
|
+
# @return [Time]
|
1554
|
+
#
|
1555
|
+
# @!attribute [rw] last_modified_time
|
1556
|
+
# The timestamp of the last time that this Provisioned Throughput was
|
1557
|
+
# modified.
|
1558
|
+
# @return [Time]
|
1559
|
+
#
|
1560
|
+
# @!attribute [rw] failure_message
|
1561
|
+
# A failure message for any issues that occurred during creation,
|
1562
|
+
# updating, or deletion of the Provisioned Throughput.
|
1563
|
+
# @return [String]
|
1564
|
+
#
|
1565
|
+
# @!attribute [rw] commitment_duration
|
1566
|
+
# Commitment duration of the Provisioned Throughput.
|
1567
|
+
# @return [String]
|
1568
|
+
#
|
1569
|
+
# @!attribute [rw] commitment_expiration_time
|
1570
|
+
# The timestamp for when the commitment term for the Provisioned
|
1571
|
+
# Throughput expires.
|
1572
|
+
# @return [Time]
|
1573
|
+
#
|
1574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetProvisionedModelThroughputResponse AWS API Documentation
|
1575
|
+
#
|
1576
|
+
class GetProvisionedModelThroughputResponse < Struct.new(
|
1577
|
+
:model_units,
|
1578
|
+
:desired_model_units,
|
1579
|
+
:provisioned_model_name,
|
1580
|
+
:provisioned_model_arn,
|
1581
|
+
:model_arn,
|
1582
|
+
:desired_model_arn,
|
1583
|
+
:foundation_model_arn,
|
1584
|
+
:status,
|
1585
|
+
:creation_time,
|
1586
|
+
:last_modified_time,
|
1587
|
+
:failure_message,
|
1588
|
+
:commitment_duration,
|
1589
|
+
:commitment_expiration_time)
|
1590
|
+
SENSITIVE = []
|
1591
|
+
include Aws::Structure
|
1592
|
+
end
|
1593
|
+
|
1594
|
+
# Contains filter strengths for harmful content. Guardrails support the
|
1595
|
+
# following content filters to detect and filter harmful user inputs and
|
1596
|
+
# FM-generated outputs.
|
1597
|
+
#
|
1598
|
+
# * **Hate** – Describes language or a statement that discriminates,
|
1599
|
+
# criticizes, insults, denounces, or dehumanizes a person or group on
|
1600
|
+
# the basis of an identity (such as race, ethnicity, gender, religion,
|
1601
|
+
# sexual orientation, ability, and national origin).
|
1602
|
+
#
|
1603
|
+
# * **Insults** – Describes language or a statement that includes
|
1604
|
+
# demeaning, humiliating, mocking, insulting, or belittling language.
|
1605
|
+
# This type of language is also labeled as bullying.
|
1606
|
+
#
|
1607
|
+
# * **Sexual** – Describes language or a statement that indicates sexual
|
1608
|
+
# interest, activity, or arousal using direct or indirect references
|
1609
|
+
# to body parts, physical traits, or sex.
|
1610
|
+
#
|
1611
|
+
# * **Violence** – Describes language or a statement that includes
|
1612
|
+
# glorification of or threats to inflict physical pain, hurt, or
|
1613
|
+
# injury toward a person, group or thing.
|
1614
|
+
#
|
1615
|
+
# Content filtering depends on the confidence classification of user
|
1616
|
+
# inputs and FM responses across each of the four harmful categories.
|
1617
|
+
# All input and output statements are classified into one of four
|
1618
|
+
# confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category.
|
1619
|
+
# For example, if a statement is classified as *Hate* with HIGH
|
1620
|
+
# confidence, the likelihood of the statement representing hateful
|
1621
|
+
# content is high. A single statement can be classified across multiple
|
1622
|
+
# categories with varying confidence levels. For example, a single
|
1623
|
+
# statement can be classified as *Hate* with HIGH confidence, *Insults*
|
1624
|
+
# with LOW confidence, *Sexual* with NONE confidence, and *Violence*
|
1625
|
+
# with MEDIUM confidence.
|
1626
|
+
#
|
1627
|
+
# For more information, see [Guardrails content filters][1].
|
1628
|
+
#
|
1629
|
+
# This data type is used in the following API operations:
|
1630
|
+
#
|
1631
|
+
# * [GetGuardrail response body][2]
|
1632
|
+
#
|
1633
|
+
# ^
|
1634
|
+
#
|
1635
|
+
#
|
1636
|
+
#
|
1637
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html
|
1638
|
+
# [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax
|
1639
|
+
#
|
1640
|
+
# @!attribute [rw] type
|
1641
|
+
# The harmful category that the content filter is applied to.
|
1642
|
+
# @return [String]
|
1643
|
+
#
|
1644
|
+
# @!attribute [rw] input_strength
|
1645
|
+
# The strength of the content filter to apply to prompts. As you
|
1646
|
+
# increase the filter strength, the likelihood of filtering harmful
|
1647
|
+
# content increases and the probability of seeing harmful content in
|
1648
|
+
# your application reduces.
|
1649
|
+
# @return [String]
|
1650
|
+
#
|
1651
|
+
# @!attribute [rw] output_strength
|
1652
|
+
# The strength of the content filter to apply to model responses. As
|
1653
|
+
# you increase the filter strength, the likelihood of filtering
|
1654
|
+
# harmful content increases and the probability of seeing harmful
|
1655
|
+
# content in your application reduces.
|
1656
|
+
# @return [String]
|
1657
|
+
#
|
1658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentFilter AWS API Documentation
|
1659
|
+
#
|
1660
|
+
class GuardrailContentFilter < Struct.new(
|
1661
|
+
:type,
|
1662
|
+
:input_strength,
|
1663
|
+
:output_strength)
|
1664
|
+
SENSITIVE = []
|
1665
|
+
include Aws::Structure
|
1666
|
+
end
|
1667
|
+
|
1668
|
+
# Contains filter strengths for harmful content. Guardrails support the
|
1669
|
+
# following content filters to detect and filter harmful user inputs and
|
1670
|
+
# FM-generated outputs.
|
1671
|
+
#
|
1672
|
+
# * **Hate** – Describes language or a statement that discriminates,
|
1673
|
+
# criticizes, insults, denounces, or dehumanizes a person or group on
|
1674
|
+
# the basis of an identity (such as race, ethnicity, gender, religion,
|
1675
|
+
# sexual orientation, ability, and national origin).
|
1676
|
+
#
|
1677
|
+
# * **Insults** – Describes language or a statement that includes
|
1678
|
+
# demeaning, humiliating, mocking, insulting, or belittling language.
|
1679
|
+
# This type of language is also labeled as bullying.
|
1680
|
+
#
|
1681
|
+
# * **Sexual** – Describes language or a statement that indicates sexual
|
1682
|
+
# interest, activity, or arousal using direct or indirect references
|
1683
|
+
# to body parts, physical traits, or sex.
|
1684
|
+
#
|
1685
|
+
# * **Violence** – Describes language or a statement that includes
|
1686
|
+
# glorification of or threats to inflict physical pain, hurt, or
|
1687
|
+
# injury toward a person, group or thing.
|
1688
|
+
#
|
1689
|
+
# Content filtering depends on the confidence classification of user
|
1690
|
+
# inputs and FM responses across each of the four harmful categories.
|
1691
|
+
# All input and output statements are classified into one of four
|
1692
|
+
# confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category.
|
1693
|
+
# For example, if a statement is classified as *Hate* with HIGH
|
1694
|
+
# confidence, the likelihood of the statement representing hateful
|
1695
|
+
# content is high. A single statement can be classified across multiple
|
1696
|
+
# categories with varying confidence levels. For example, a single
|
1697
|
+
# statement can be classified as *Hate* with HIGH confidence, *Insults*
|
1698
|
+
# with LOW confidence, *Sexual* with NONE confidence, and *Violence*
|
1699
|
+
# with MEDIUM confidence.
|
1700
|
+
#
|
1701
|
+
# For more information, see [Guardrails content filters][1].
|
1702
|
+
#
|
1703
|
+
# This data type is used in the following API operations:
|
1704
|
+
#
|
1705
|
+
# * [CreateGuardrail request body][2]
|
1706
|
+
#
|
1707
|
+
# * [UpdateGuardrail request body][3]
|
1708
|
+
#
|
1709
|
+
#
|
1710
|
+
#
|
1711
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html
|
1712
|
+
# [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax
|
1713
|
+
# [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax
|
1714
|
+
#
|
1715
|
+
# @!attribute [rw] type
|
1716
|
+
# The harmful category that the content filter is applied to.
|
1717
|
+
# @return [String]
|
1718
|
+
#
|
1719
|
+
# @!attribute [rw] input_strength
|
1720
|
+
# The strength of the content filter to apply to prompts. As you
|
1721
|
+
# increase the filter strength, the likelihood of filtering harmful
|
1722
|
+
# content increases and the probability of seeing harmful content in
|
1723
|
+
# your application reduces.
|
1724
|
+
# @return [String]
|
1725
|
+
#
|
1726
|
+
# @!attribute [rw] output_strength
|
1727
|
+
# The strength of the content filter to apply to model responses. As
|
1728
|
+
# you increase the filter strength, the likelihood of filtering
|
1729
|
+
# harmful content increases and the probability of seeing harmful
|
1730
|
+
# content in your application reduces.
|
1731
|
+
# @return [String]
|
1732
|
+
#
|
1733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentFilterConfig AWS API Documentation
|
1734
|
+
#
|
1735
|
+
class GuardrailContentFilterConfig < Struct.new(
|
1736
|
+
:type,
|
1737
|
+
:input_strength,
|
1738
|
+
:output_strength)
|
1739
|
+
SENSITIVE = []
|
1740
|
+
include Aws::Structure
|
1741
|
+
end
|
1742
|
+
|
1743
|
+
# Contains details about how to handle harmful content.
|
1744
|
+
#
|
1745
|
+
# This data type is used in the following API operations:
|
1746
|
+
#
|
1747
|
+
# * [GetGuardrail response body][1]
|
1748
|
+
#
|
1749
|
+
# ^
|
1750
|
+
#
|
1751
|
+
#
|
1752
|
+
#
|
1753
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax
|
1754
|
+
#
|
1755
|
+
# @!attribute [rw] filters
|
1756
|
+
# Contains the type of the content filter and how strongly it should
|
1757
|
+
# apply to prompts and model responses.
|
1758
|
+
# @return [Array<Types::GuardrailContentFilter>]
|
1759
|
+
#
|
1760
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentPolicy AWS API Documentation
|
1761
|
+
#
|
1762
|
+
class GuardrailContentPolicy < Struct.new(
|
1763
|
+
:filters)
|
1764
|
+
SENSITIVE = []
|
1765
|
+
include Aws::Structure
|
1766
|
+
end
|
1767
|
+
|
1768
|
+
# Contains details about how to handle harmful content.
|
1769
|
+
#
|
1770
|
+
# This data type is used in the following API operations:
|
1771
|
+
#
|
1772
|
+
# * [CreateGuardrail request body][1]
|
1773
|
+
#
|
1774
|
+
# * [UpdateGuardrail request body][2]
|
1775
|
+
#
|
1776
|
+
#
|
1777
|
+
#
|
1778
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax
|
1779
|
+
# [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax
|
1780
|
+
#
|
1781
|
+
# @!attribute [rw] filters_config
|
1782
|
+
# Contains the type of the content filter and how strongly it should
|
1783
|
+
# apply to prompts and model responses.
|
1784
|
+
# @return [Array<Types::GuardrailContentFilterConfig>]
|
1785
|
+
#
|
1786
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentPolicyConfig AWS API Documentation
|
1787
|
+
#
|
1788
|
+
class GuardrailContentPolicyConfig < Struct.new(
|
1789
|
+
:filters_config)
|
1790
|
+
SENSITIVE = []
|
1791
|
+
include Aws::Structure
|
1792
|
+
end
|
1793
|
+
|
1794
|
+
# The managed word list that was configured for the guardrail. (This is
|
1795
|
+
# a list of words that are pre-defined and managed by Guardrails only.)
|
1796
|
+
#
|
1797
|
+
# @!attribute [rw] type
|
1798
|
+
# ManagedWords$type The managed word type that was configured for the
|
1799
|
+
# guardrail. (For now, we only offer profanity word list)
|
1800
|
+
# @return [String]
|
1801
|
+
#
|
1802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailManagedWords AWS API Documentation
|
1803
|
+
#
|
1804
|
+
class GuardrailManagedWords < Struct.new(
|
1805
|
+
:type)
|
1806
|
+
SENSITIVE = []
|
1807
|
+
include Aws::Structure
|
1808
|
+
end
|
1809
|
+
|
1810
|
+
# The managed word list to configure for the guardrail.
|
1811
|
+
#
|
1812
|
+
# @!attribute [rw] type
|
1813
|
+
# The managed word type to configure for the guardrail.
|
1814
|
+
# @return [String]
|
1815
|
+
#
|
1816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailManagedWordsConfig AWS API Documentation
|
1817
|
+
#
|
1818
|
+
class GuardrailManagedWordsConfig < Struct.new(
|
1819
|
+
:type)
|
1820
|
+
SENSITIVE = []
|
1821
|
+
include Aws::Structure
|
1822
|
+
end
|
1823
|
+
|
1824
|
+
# The PII entity configured for the guardrail.
|
1825
|
+
#
|
1826
|
+
# @!attribute [rw] type
|
1827
|
+
# The type of PII entity. For example, Social Security Number.
|
1828
|
+
# @return [String]
|
1829
|
+
#
|
1830
|
+
# @!attribute [rw] action
|
1831
|
+
# The configured guardrail action when PII entity is detected.
|
1832
|
+
# @return [String]
|
1833
|
+
#
|
1834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailPiiEntity AWS API Documentation
|
1835
|
+
#
|
1836
|
+
class GuardrailPiiEntity < Struct.new(
|
1837
|
+
:type,
|
1838
|
+
:action)
|
1839
|
+
SENSITIVE = []
|
1840
|
+
include Aws::Structure
|
1841
|
+
end
|
1842
|
+
|
1843
|
+
# The PII entity to configure for the guardrail.
|
1844
|
+
#
|
1845
|
+
# @!attribute [rw] type
|
1846
|
+
# Configure guardrail type when the PII entity is detected.
|
1847
|
+
# @return [String]
|
1848
|
+
#
|
1849
|
+
# @!attribute [rw] action
|
1850
|
+
# Configure guardrail action when the PII entity is detected.
|
1851
|
+
# @return [String]
|
1852
|
+
#
|
1853
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailPiiEntityConfig AWS API Documentation
|
1854
|
+
#
|
1855
|
+
class GuardrailPiiEntityConfig < Struct.new(
|
1856
|
+
:type,
|
1857
|
+
:action)
|
1858
|
+
SENSITIVE = []
|
1859
|
+
include Aws::Structure
|
1860
|
+
end
|
1861
|
+
|
1862
|
+
# The regular expression configured for the guardrail.
|
1863
|
+
#
|
1864
|
+
# @!attribute [rw] name
|
1865
|
+
# The name of the regular expression for the guardrail.
|
1866
|
+
# @return [String]
|
1867
|
+
#
|
1868
|
+
# @!attribute [rw] description
|
1869
|
+
# The description of the regular expression for the guardrail.
|
1870
|
+
# @return [String]
|
1871
|
+
#
|
1872
|
+
# @!attribute [rw] pattern
|
1873
|
+
# The pattern of the regular expression configured for the guardrail.
|
1874
|
+
# @return [String]
|
1875
|
+
#
|
1876
|
+
# @!attribute [rw] action
|
1877
|
+
# The action taken when a match to the regular expression is detected.
|
1878
|
+
# @return [String]
|
1879
|
+
#
|
1880
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailRegex AWS API Documentation
|
1881
|
+
#
|
1882
|
+
class GuardrailRegex < Struct.new(
|
1883
|
+
:name,
|
1884
|
+
:description,
|
1885
|
+
:pattern,
|
1886
|
+
:action)
|
1887
|
+
SENSITIVE = []
|
1888
|
+
include Aws::Structure
|
1889
|
+
end
|
1890
|
+
|
1891
|
+
# The regular expression to configure for the guardrail.
|
1892
|
+
#
|
1893
|
+
# @!attribute [rw] name
|
1894
|
+
# The name of the regular expression to configure for the guardrail.
|
1895
|
+
# @return [String]
|
1896
|
+
#
|
1897
|
+
# @!attribute [rw] description
|
1898
|
+
# The description of the regular expression to configure for the
|
1899
|
+
# guardrail.
|
1900
|
+
# @return [String]
|
1901
|
+
#
|
1902
|
+
# @!attribute [rw] pattern
|
1903
|
+
# The regular expression pattern to configure for the guardrail.
|
1904
|
+
# @return [String]
|
1905
|
+
#
|
1906
|
+
# @!attribute [rw] action
|
1907
|
+
# The guardrail action to configure when matching regular expression
|
1908
|
+
# is detected.
|
1909
|
+
# @return [String]
|
1910
|
+
#
|
1911
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailRegexConfig AWS API Documentation
|
1912
|
+
#
|
1913
|
+
class GuardrailRegexConfig < Struct.new(
|
1914
|
+
:name,
|
1915
|
+
:description,
|
1916
|
+
:pattern,
|
1917
|
+
:action)
|
1918
|
+
SENSITIVE = []
|
1919
|
+
include Aws::Structure
|
1920
|
+
end
|
1921
|
+
|
1922
|
+
# Contains details about PII entities and regular expressions configured
|
1923
|
+
# for the guardrail.
|
1924
|
+
#
|
1925
|
+
# @!attribute [rw] pii_entities
|
1926
|
+
# The list of PII entities configured for the guardrail.
|
1927
|
+
# @return [Array<Types::GuardrailPiiEntity>]
|
1928
|
+
#
|
1929
|
+
# @!attribute [rw] regexes
|
1930
|
+
# The list of regular expressions configured for the guardrail.
|
1931
|
+
# @return [Array<Types::GuardrailRegex>]
|
1932
|
+
#
|
1933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailSensitiveInformationPolicy AWS API Documentation
|
1934
|
+
#
|
1935
|
+
class GuardrailSensitiveInformationPolicy < Struct.new(
|
1936
|
+
:pii_entities,
|
1937
|
+
:regexes)
|
1938
|
+
SENSITIVE = []
|
1939
|
+
include Aws::Structure
|
1940
|
+
end
|
1941
|
+
|
1942
|
+
# Contains details about PII entities and regular expressions to
|
1943
|
+
# configure for the guardrail.
|
1944
|
+
#
|
1945
|
+
# @!attribute [rw] pii_entities_config
|
1946
|
+
# A list of PII entities to configure to the guardrail.
|
1947
|
+
# @return [Array<Types::GuardrailPiiEntityConfig>]
|
1948
|
+
#
|
1949
|
+
# @!attribute [rw] regexes_config
|
1950
|
+
# A list of regular expressions to configure to the guardrail.
|
1951
|
+
# @return [Array<Types::GuardrailRegexConfig>]
|
1952
|
+
#
|
1953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailSensitiveInformationPolicyConfig AWS API Documentation
|
1954
|
+
#
|
1955
|
+
class GuardrailSensitiveInformationPolicyConfig < Struct.new(
|
1956
|
+
:pii_entities_config,
|
1957
|
+
:regexes_config)
|
1958
|
+
SENSITIVE = []
|
1959
|
+
include Aws::Structure
|
1960
|
+
end
|
1961
|
+
|
1962
|
+
# Contains details about a guardrail.
|
1963
|
+
#
|
1964
|
+
# This data type is used in the following API operations:
|
1965
|
+
#
|
1966
|
+
# * [ListGuardrails response body][1]
|
1967
|
+
#
|
1968
|
+
# ^
|
1969
|
+
#
|
1970
|
+
#
|
1971
|
+
#
|
1972
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListGuardrails.html#API_ListGuardrails_ResponseSyntax
|
1973
|
+
#
|
1974
|
+
# @!attribute [rw] id
|
1975
|
+
# The unique identifier of the guardrail.
|
1976
|
+
# @return [String]
|
1977
|
+
#
|
1978
|
+
# @!attribute [rw] arn
|
1979
|
+
# The ARN of the guardrail.
|
1980
|
+
# @return [String]
|
1981
|
+
#
|
1982
|
+
# @!attribute [rw] status
|
1983
|
+
# The status of the guardrail.
|
1984
|
+
# @return [String]
|
1985
|
+
#
|
1986
|
+
# @!attribute [rw] name
|
1987
|
+
# The name of the guardrail.
|
1988
|
+
# @return [String]
|
1989
|
+
#
|
1990
|
+
# @!attribute [rw] description
|
1991
|
+
# A description of the guardrail.
|
1992
|
+
# @return [String]
|
1993
|
+
#
|
1994
|
+
# @!attribute [rw] version
|
1995
|
+
# The version of the guardrail.
|
1996
|
+
# @return [String]
|
1997
|
+
#
|
1998
|
+
# @!attribute [rw] created_at
|
1999
|
+
# The date and time at which the guardrail was created.
|
2000
|
+
# @return [Time]
|
2001
|
+
#
|
2002
|
+
# @!attribute [rw] updated_at
|
2003
|
+
# The date and time at which the guardrail was last updated.
|
2004
|
+
# @return [Time]
|
2005
|
+
#
|
2006
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailSummary AWS API Documentation
|
2007
|
+
#
|
2008
|
+
class GuardrailSummary < Struct.new(
|
2009
|
+
:id,
|
2010
|
+
:arn,
|
2011
|
+
:status,
|
2012
|
+
:name,
|
2013
|
+
:description,
|
2014
|
+
:version,
|
2015
|
+
:created_at,
|
2016
|
+
:updated_at)
|
2017
|
+
SENSITIVE = [:name, :description]
|
2018
|
+
include Aws::Structure
|
2019
|
+
end
|
2020
|
+
|
2021
|
+
# Details about topics for the guardrail to identify and deny.
|
2022
|
+
#
|
2023
|
+
# This data type is used in the following API operations:
|
2024
|
+
#
|
2025
|
+
# * [GetGuardrail response body][1]
|
2026
|
+
#
|
2027
|
+
# ^
|
2028
|
+
#
|
2029
|
+
#
|
2030
|
+
#
|
2031
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax
|
2032
|
+
#
|
2033
|
+
# @!attribute [rw] name
|
2034
|
+
# The name of the topic to deny.
|
2035
|
+
# @return [String]
|
2036
|
+
#
|
2037
|
+
# @!attribute [rw] definition
|
2038
|
+
# A definition of the topic to deny.
|
2039
|
+
# @return [String]
|
2040
|
+
#
|
2041
|
+
# @!attribute [rw] examples
|
2042
|
+
# A list of prompts, each of which is an example of a prompt that can
|
2043
|
+
# be categorized as belonging to the topic.
|
2044
|
+
# @return [Array<String>]
|
2045
|
+
#
|
2046
|
+
# @!attribute [rw] type
|
2047
|
+
# Specifies to deny the topic.
|
2048
|
+
# @return [String]
|
2049
|
+
#
|
2050
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopic AWS API Documentation
|
2051
|
+
#
|
2052
|
+
class GuardrailTopic < Struct.new(
|
2053
|
+
:name,
|
2054
|
+
:definition,
|
2055
|
+
:examples,
|
2056
|
+
:type)
|
2057
|
+
SENSITIVE = [:name, :definition]
|
2058
|
+
include Aws::Structure
|
2059
|
+
end
|
2060
|
+
|
2061
|
+
# Details about topics for the guardrail to identify and deny.
|
2062
|
+
#
|
2063
|
+
# This data type is used in the following API operations:
|
2064
|
+
#
|
2065
|
+
# * [CreateGuardrail request body][1]
|
2066
|
+
#
|
2067
|
+
# * [UpdateGuardrail request body][2]
|
2068
|
+
#
|
2069
|
+
#
|
2070
|
+
#
|
2071
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax
|
2072
|
+
# [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax
|
2073
|
+
#
|
2074
|
+
# @!attribute [rw] name
|
2075
|
+
# The name of the topic to deny.
|
2076
|
+
# @return [String]
|
2077
|
+
#
|
2078
|
+
# @!attribute [rw] definition
|
2079
|
+
# A definition of the topic to deny.
|
2080
|
+
# @return [String]
|
2081
|
+
#
|
2082
|
+
# @!attribute [rw] examples
|
2083
|
+
# A list of prompts, each of which is an example of a prompt that can
|
2084
|
+
# be categorized as belonging to the topic.
|
2085
|
+
# @return [Array<String>]
|
2086
|
+
#
|
2087
|
+
# @!attribute [rw] type
|
2088
|
+
# Specifies to deny the topic.
|
2089
|
+
# @return [String]
|
2090
|
+
#
|
2091
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicConfig AWS API Documentation
|
2092
|
+
#
|
2093
|
+
class GuardrailTopicConfig < Struct.new(
|
2094
|
+
:name,
|
2095
|
+
:definition,
|
2096
|
+
:examples,
|
2097
|
+
:type)
|
2098
|
+
SENSITIVE = [:name, :definition]
|
2099
|
+
include Aws::Structure
|
2100
|
+
end
|
2101
|
+
|
2102
|
+
# Contains details about topics that the guardrail should identify and
|
2103
|
+
# deny.
|
2104
|
+
#
|
2105
|
+
# This data type is used in the following API operations:
|
2106
|
+
#
|
2107
|
+
# * [GetGuardrail response body][1]
|
2108
|
+
#
|
2109
|
+
# ^
|
2110
|
+
#
|
2111
|
+
#
|
2112
|
+
#
|
2113
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax
|
2114
|
+
#
|
2115
|
+
# @!attribute [rw] topics
|
2116
|
+
# A list of policies related to topics that the guardrail should deny.
|
2117
|
+
# @return [Array<Types::GuardrailTopic>]
|
2118
|
+
#
|
2119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicPolicy AWS API Documentation
|
2120
|
+
#
|
2121
|
+
class GuardrailTopicPolicy < Struct.new(
|
2122
|
+
:topics)
|
2123
|
+
SENSITIVE = []
|
2124
|
+
include Aws::Structure
|
2125
|
+
end
|
2126
|
+
|
2127
|
+
# Contains details about topics that the guardrail should identify and
|
2128
|
+
# deny.
|
2129
|
+
#
|
2130
|
+
# This data type is used in the following API operations:
|
2131
|
+
#
|
2132
|
+
# * [CreateGuardrail request body][1]
|
2133
|
+
#
|
2134
|
+
# * [UpdateGuardrail request body][2]
|
2135
|
+
#
|
2136
|
+
#
|
2137
|
+
#
|
2138
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax
|
2139
|
+
# [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax
|
633
2140
|
#
|
634
|
-
# @!attribute [rw]
|
635
|
-
#
|
636
|
-
# @return [Types::
|
2141
|
+
# @!attribute [rw] topics_config
|
2142
|
+
# A list of policies related to topics that the guardrail should deny.
|
2143
|
+
# @return [Array<Types::GuardrailTopicConfig>]
|
637
2144
|
#
|
638
|
-
#
|
639
|
-
# The type of model customization.
|
640
|
-
# @return [String]
|
2145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicPolicyConfig AWS API Documentation
|
641
2146
|
#
|
642
|
-
|
643
|
-
|
2147
|
+
class GuardrailTopicPolicyConfig < Struct.new(
|
2148
|
+
:topics_config)
|
2149
|
+
SENSITIVE = []
|
2150
|
+
include Aws::Structure
|
2151
|
+
end
|
2152
|
+
|
2153
|
+
# A word configured for the guardrail.
|
2154
|
+
#
|
2155
|
+
# @!attribute [rw] text
|
2156
|
+
# Text of the word configured for the guardrail to block.
|
644
2157
|
# @return [String]
|
645
2158
|
#
|
646
|
-
#
|
647
|
-
# Metrics associated with the custom job.
|
648
|
-
# @return [Types::TrainingMetrics]
|
2159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailWord AWS API Documentation
|
649
2160
|
#
|
650
|
-
|
651
|
-
|
652
|
-
|
653
|
-
|
2161
|
+
class GuardrailWord < Struct.new(
|
2162
|
+
:text)
|
2163
|
+
SENSITIVE = []
|
2164
|
+
include Aws::Structure
|
2165
|
+
end
|
2166
|
+
|
2167
|
+
# A word to configure for the guardrail.
|
654
2168
|
#
|
655
|
-
# @!attribute [rw]
|
656
|
-
#
|
657
|
-
# @return [
|
2169
|
+
# @!attribute [rw] text
|
2170
|
+
# Text of the word configured for the guardrail to block.
|
2171
|
+
# @return [String]
|
658
2172
|
#
|
659
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/
|
2173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailWordConfig AWS API Documentation
|
660
2174
|
#
|
661
|
-
class
|
662
|
-
:
|
663
|
-
:job_name,
|
664
|
-
:output_model_name,
|
665
|
-
:output_model_arn,
|
666
|
-
:client_request_token,
|
667
|
-
:role_arn,
|
668
|
-
:status,
|
669
|
-
:failure_message,
|
670
|
-
:creation_time,
|
671
|
-
:last_modified_time,
|
672
|
-
:end_time,
|
673
|
-
:base_model_arn,
|
674
|
-
:hyper_parameters,
|
675
|
-
:training_data_config,
|
676
|
-
:validation_data_config,
|
677
|
-
:output_data_config,
|
678
|
-
:customization_type,
|
679
|
-
:output_model_kms_key_arn,
|
680
|
-
:training_metrics,
|
681
|
-
:validation_metrics,
|
682
|
-
:vpc_config)
|
2175
|
+
class GuardrailWordConfig < Struct.new(
|
2176
|
+
:text)
|
683
2177
|
SENSITIVE = []
|
684
2178
|
include Aws::Structure
|
685
2179
|
end
|
686
2180
|
|
687
|
-
#
|
2181
|
+
# Contains details about the word policy configured for the guardrail.
|
688
2182
|
#
|
689
|
-
#
|
2183
|
+
# @!attribute [rw] words
|
2184
|
+
# A list of words configured for the guardrail.
|
2185
|
+
# @return [Array<Types::GuardrailWord>]
|
690
2186
|
#
|
691
|
-
|
692
|
-
|
693
|
-
#
|
694
|
-
# The current configuration values.
|
695
|
-
# @return [Types::LoggingConfig]
|
2187
|
+
# @!attribute [rw] managed_word_lists
|
2188
|
+
# A list of managed words configured for the guardrail.
|
2189
|
+
# @return [Array<Types::GuardrailManagedWords>]
|
696
2190
|
#
|
697
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/
|
2191
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailWordPolicy AWS API Documentation
|
698
2192
|
#
|
699
|
-
class
|
700
|
-
:
|
2193
|
+
class GuardrailWordPolicy < Struct.new(
|
2194
|
+
:words,
|
2195
|
+
:managed_word_lists)
|
701
2196
|
SENSITIVE = []
|
702
2197
|
include Aws::Structure
|
703
2198
|
end
|
704
2199
|
|
705
|
-
#
|
706
|
-
#
|
707
|
-
# @return [String]
|
2200
|
+
# Contains details about the word policy to configured for the
|
2201
|
+
# guardrail.
|
708
2202
|
#
|
709
|
-
#
|
2203
|
+
# @!attribute [rw] words_config
|
2204
|
+
# A list of words to configure for the guardrail.
|
2205
|
+
# @return [Array<Types::GuardrailWordConfig>]
|
710
2206
|
#
|
711
|
-
|
712
|
-
|
2207
|
+
# @!attribute [rw] managed_word_lists_config
|
2208
|
+
# A list of managed words to configure for the guardrail.
|
2209
|
+
# @return [Array<Types::GuardrailManagedWordsConfig>]
|
2210
|
+
#
|
2211
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailWordPolicyConfig AWS API Documentation
|
2212
|
+
#
|
2213
|
+
class GuardrailWordPolicyConfig < Struct.new(
|
2214
|
+
:words_config,
|
2215
|
+
:managed_word_lists_config)
|
713
2216
|
SENSITIVE = []
|
714
2217
|
include Aws::Structure
|
715
2218
|
end
|
716
2219
|
|
717
|
-
#
|
718
|
-
#
|
719
|
-
#
|
720
|
-
#
|
2220
|
+
# Specifies the custom metrics, how tasks will be rated, the flow
|
2221
|
+
# definition ARN, and your custom prompt datasets. Model evaluation jobs
|
2222
|
+
# use human workers *only* support the use of custom prompt datasets. To
|
2223
|
+
# learn more about custom prompt datasets and the required format, see
|
2224
|
+
# [Custom prompt datasets][1].
|
721
2225
|
#
|
722
|
-
#
|
723
|
-
#
|
724
|
-
#
|
725
|
-
#
|
2226
|
+
# When you create custom metrics in `HumanEvaluationCustomMetric` you
|
2227
|
+
# must specify the metric's `name`. The list of `names` specified in
|
2228
|
+
# the `HumanEvaluationCustomMetric` array, must match the `metricNames`
|
2229
|
+
# array of strings specified in `EvaluationDatasetMetricConfig`. For
|
2230
|
+
# example, if in the `HumanEvaluationCustomMetric` array your specified
|
2231
|
+
# the names `"accuracy", "toxicity", "readability"` as custom metrics
|
2232
|
+
# *then* the `metricNames` array would need to look like the following
|
2233
|
+
# `["accuracy", "toxicity", "readability"]` in
|
2234
|
+
# `EvaluationDatasetMetricConfig`.
|
726
2235
|
#
|
727
|
-
# @!attribute [rw] provisioned_model_name
|
728
|
-
# The name of the provisioned throughput.
|
729
|
-
# @return [String]
|
730
2236
|
#
|
731
|
-
# @!attribute [rw] provisioned_model_arn
|
732
|
-
# The ARN of the provisioned throughput.
|
733
|
-
# @return [String]
|
734
2237
|
#
|
735
|
-
#
|
736
|
-
# The ARN or name of the model associated with this provisioned
|
737
|
-
# throughput.
|
738
|
-
# @return [String]
|
2238
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-prompt-datasets-custom.html
|
739
2239
|
#
|
740
|
-
# @!attribute [rw]
|
741
|
-
# The
|
742
|
-
#
|
2240
|
+
# @!attribute [rw] human_workflow_config
|
2241
|
+
# The parameters of the human workflow.
|
2242
|
+
# @return [Types::HumanWorkflowConfig]
|
2243
|
+
#
|
2244
|
+
# @!attribute [rw] custom_metrics
|
2245
|
+
# A `HumanEvaluationCustomMetric` object. It contains the names the
|
2246
|
+
# metrics, how the metrics are to be evaluated, an optional
|
2247
|
+
# description.
|
2248
|
+
# @return [Array<Types::HumanEvaluationCustomMetric>]
|
2249
|
+
#
|
2250
|
+
# @!attribute [rw] dataset_metric_configs
|
2251
|
+
# Use to specify the metrics, task, and prompt dataset to be used in
|
2252
|
+
# your model evaluation job.
|
2253
|
+
# @return [Array<Types::EvaluationDatasetMetricConfig>]
|
2254
|
+
#
|
2255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/HumanEvaluationConfig AWS API Documentation
|
2256
|
+
#
|
2257
|
+
class HumanEvaluationConfig < Struct.new(
|
2258
|
+
:human_workflow_config,
|
2259
|
+
:custom_metrics,
|
2260
|
+
:dataset_metric_configs)
|
2261
|
+
SENSITIVE = []
|
2262
|
+
include Aws::Structure
|
2263
|
+
end
|
2264
|
+
|
2265
|
+
# In a model evaluation job that uses human workers you must define the
|
2266
|
+
# name of the metric, and how you want that metric rated `ratingMethod`,
|
2267
|
+
# and an optional description of the metric.
|
2268
|
+
#
|
2269
|
+
# @!attribute [rw] name
|
2270
|
+
# The name of the metric. Your human evaluators will see this name in
|
2271
|
+
# the evaluation UI.
|
743
2272
|
# @return [String]
|
744
2273
|
#
|
745
|
-
# @!attribute [rw]
|
746
|
-
#
|
2274
|
+
# @!attribute [rw] description
|
2275
|
+
# An optional description of the metric. Use this parameter to provide
|
2276
|
+
# more details about the metric.
|
747
2277
|
# @return [String]
|
748
2278
|
#
|
749
|
-
# @!attribute [rw]
|
750
|
-
#
|
2279
|
+
# @!attribute [rw] rating_method
|
2280
|
+
# Choose how you want your human workers to evaluation your model.
|
2281
|
+
# Valid values for rating methods are `ThumbsUpDown`,
|
2282
|
+
# `IndividualLikertScale`,`ComparisonLikertScale`, `ComparisonChoice`,
|
2283
|
+
# and `ComparisonRank`
|
751
2284
|
# @return [String]
|
752
2285
|
#
|
753
|
-
#
|
754
|
-
# The timestamp of the creation time for this provisioned throughput.
|
755
|
-
# @return [Time]
|
2286
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/HumanEvaluationCustomMetric AWS API Documentation
|
756
2287
|
#
|
757
|
-
|
758
|
-
|
759
|
-
|
760
|
-
|
2288
|
+
class HumanEvaluationCustomMetric < Struct.new(
|
2289
|
+
:name,
|
2290
|
+
:description,
|
2291
|
+
:rating_method)
|
2292
|
+
SENSITIVE = [:name, :description]
|
2293
|
+
include Aws::Structure
|
2294
|
+
end
|
2295
|
+
|
2296
|
+
# Contains `SageMakerFlowDefinition` object. The object is used to
|
2297
|
+
# specify the prompt dataset, task type, rating method and metric names.
|
761
2298
|
#
|
762
|
-
# @!attribute [rw]
|
763
|
-
#
|
2299
|
+
# @!attribute [rw] flow_definition_arn
|
2300
|
+
# The Amazon Resource Number (ARN) for the flow definition
|
764
2301
|
# @return [String]
|
765
2302
|
#
|
766
|
-
# @!attribute [rw]
|
767
|
-
#
|
2303
|
+
# @!attribute [rw] instructions
|
2304
|
+
# Instructions for the flow definition
|
768
2305
|
# @return [String]
|
769
2306
|
#
|
770
|
-
#
|
771
|
-
# Commitment expiration time for the provisioned throughput.
|
772
|
-
# @return [Time]
|
773
|
-
#
|
774
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetProvisionedModelThroughputResponse AWS API Documentation
|
2307
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/HumanWorkflowConfig AWS API Documentation
|
775
2308
|
#
|
776
|
-
class
|
777
|
-
:
|
778
|
-
:
|
779
|
-
:
|
780
|
-
:provisioned_model_arn,
|
781
|
-
:model_arn,
|
782
|
-
:desired_model_arn,
|
783
|
-
:foundation_model_arn,
|
784
|
-
:status,
|
785
|
-
:creation_time,
|
786
|
-
:last_modified_time,
|
787
|
-
:failure_message,
|
788
|
-
:commitment_duration,
|
789
|
-
:commitment_expiration_time)
|
790
|
-
SENSITIVE = []
|
2309
|
+
class HumanWorkflowConfig < Struct.new(
|
2310
|
+
:flow_definition_arn,
|
2311
|
+
:instructions)
|
2312
|
+
SENSITIVE = [:instructions]
|
791
2313
|
include Aws::Structure
|
792
2314
|
end
|
793
2315
|
|
@@ -817,13 +2339,13 @@ module Aws::Bedrock
|
|
817
2339
|
# @return [String]
|
818
2340
|
#
|
819
2341
|
# @!attribute [rw] base_model_arn_equals
|
820
|
-
# Return custom models only if the base model
|
821
|
-
# parameter.
|
2342
|
+
# Return custom models only if the base model Amazon Resource Name
|
2343
|
+
# (ARN) matches this parameter.
|
822
2344
|
# @return [String]
|
823
2345
|
#
|
824
2346
|
# @!attribute [rw] foundation_model_arn_equals
|
825
|
-
# Return custom models only if the foundation model
|
826
|
-
# parameter.
|
2347
|
+
# Return custom models only if the foundation model Amazon Resource
|
2348
|
+
# Name (ARN) matches this parameter.
|
827
2349
|
# @return [String]
|
828
2350
|
#
|
829
2351
|
# @!attribute [rw] max_results
|
@@ -877,20 +2399,100 @@ module Aws::Bedrock
|
|
877
2399
|
include Aws::Structure
|
878
2400
|
end
|
879
2401
|
|
2402
|
+
# @!attribute [rw] creation_time_after
|
2403
|
+
# A filter that includes model evaluation jobs created after the time
|
2404
|
+
# specified.
|
2405
|
+
# @return [Time]
|
2406
|
+
#
|
2407
|
+
# @!attribute [rw] creation_time_before
|
2408
|
+
# A filter that includes model evaluation jobs created prior to the
|
2409
|
+
# time specified.
|
2410
|
+
# @return [Time]
|
2411
|
+
#
|
2412
|
+
# @!attribute [rw] status_equals
|
2413
|
+
# Only return jobs where the status condition is met.
|
2414
|
+
# @return [String]
|
2415
|
+
#
|
2416
|
+
# @!attribute [rw] name_contains
|
2417
|
+
# Query parameter string for model evaluation job names.
|
2418
|
+
# @return [String]
|
2419
|
+
#
|
2420
|
+
# @!attribute [rw] max_results
|
2421
|
+
# The maximum number of results to return.
|
2422
|
+
# @return [Integer]
|
2423
|
+
#
|
2424
|
+
# @!attribute [rw] next_token
|
2425
|
+
# Continuation token from the previous response, for Amazon Bedrock to
|
2426
|
+
# list the next set of results.
|
2427
|
+
# @return [String]
|
2428
|
+
#
|
2429
|
+
# @!attribute [rw] sort_by
|
2430
|
+
# Allows you to sort model evaluation jobs by when they were created.
|
2431
|
+
# @return [String]
|
2432
|
+
#
|
2433
|
+
# @!attribute [rw] sort_order
|
2434
|
+
# How you want the order of jobs sorted.
|
2435
|
+
# @return [String]
|
2436
|
+
#
|
2437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListEvaluationJobsRequest AWS API Documentation
|
2438
|
+
#
|
2439
|
+
class ListEvaluationJobsRequest < Struct.new(
|
2440
|
+
:creation_time_after,
|
2441
|
+
:creation_time_before,
|
2442
|
+
:status_equals,
|
2443
|
+
:name_contains,
|
2444
|
+
:max_results,
|
2445
|
+
:next_token,
|
2446
|
+
:sort_by,
|
2447
|
+
:sort_order)
|
2448
|
+
SENSITIVE = []
|
2449
|
+
include Aws::Structure
|
2450
|
+
end
|
2451
|
+
|
2452
|
+
# @!attribute [rw] next_token
|
2453
|
+
# Continuation token from the previous response, for Amazon Bedrock to
|
2454
|
+
# list the next set of results.
|
2455
|
+
# @return [String]
|
2456
|
+
#
|
2457
|
+
# @!attribute [rw] job_summaries
|
2458
|
+
# A summary of the model evaluation jobs.
|
2459
|
+
# @return [Array<Types::EvaluationSummary>]
|
2460
|
+
#
|
2461
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListEvaluationJobsResponse AWS API Documentation
|
2462
|
+
#
|
2463
|
+
class ListEvaluationJobsResponse < Struct.new(
|
2464
|
+
:next_token,
|
2465
|
+
:job_summaries)
|
2466
|
+
SENSITIVE = []
|
2467
|
+
include Aws::Structure
|
2468
|
+
end
|
2469
|
+
|
880
2470
|
# @!attribute [rw] by_provider
|
881
|
-
#
|
2471
|
+
# Return models belonging to the model provider that you specify.
|
882
2472
|
# @return [String]
|
883
2473
|
#
|
884
2474
|
# @!attribute [rw] by_customization_type
|
885
|
-
#
|
2475
|
+
# Return models that support the customization type that you specify.
|
2476
|
+
# For more information, see [Custom models][1] in the Amazon Bedrock
|
2477
|
+
# User Guide.
|
2478
|
+
#
|
2479
|
+
#
|
2480
|
+
#
|
2481
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html
|
886
2482
|
# @return [String]
|
887
2483
|
#
|
888
2484
|
# @!attribute [rw] by_output_modality
|
889
|
-
#
|
2485
|
+
# Return models that support the output modality that you specify.
|
890
2486
|
# @return [String]
|
891
2487
|
#
|
892
2488
|
# @!attribute [rw] by_inference_type
|
893
|
-
#
|
2489
|
+
# Return models that support the inference type that you specify. For
|
2490
|
+
# more information, see [Provisioned Throughput][1] in the Amazon
|
2491
|
+
# Bedrock User Guide.
|
2492
|
+
#
|
2493
|
+
#
|
2494
|
+
#
|
2495
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html
|
894
2496
|
# @return [String]
|
895
2497
|
#
|
896
2498
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelsRequest AWS API Documentation
|
@@ -916,6 +2518,49 @@ module Aws::Bedrock
|
|
916
2518
|
include Aws::Structure
|
917
2519
|
end
|
918
2520
|
|
2521
|
+
# @!attribute [rw] guardrail_identifier
|
2522
|
+
# The unique identifier of the guardrail.
|
2523
|
+
# @return [String]
|
2524
|
+
#
|
2525
|
+
# @!attribute [rw] max_results
|
2526
|
+
# The maximum number of results to return in the response.
|
2527
|
+
# @return [Integer]
|
2528
|
+
#
|
2529
|
+
# @!attribute [rw] next_token
|
2530
|
+
# If there are more results than were returned in the response, the
|
2531
|
+
# response returns a `nextToken` that you can send in another
|
2532
|
+
# `ListGuardrails` request to see the next batch of results.
|
2533
|
+
# @return [String]
|
2534
|
+
#
|
2535
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListGuardrailsRequest AWS API Documentation
|
2536
|
+
#
|
2537
|
+
class ListGuardrailsRequest < Struct.new(
|
2538
|
+
:guardrail_identifier,
|
2539
|
+
:max_results,
|
2540
|
+
:next_token)
|
2541
|
+
SENSITIVE = []
|
2542
|
+
include Aws::Structure
|
2543
|
+
end
|
2544
|
+
|
2545
|
+
# @!attribute [rw] guardrails
|
2546
|
+
# A list of objects, each of which contains details about a guardrail.
|
2547
|
+
# @return [Array<Types::GuardrailSummary>]
|
2548
|
+
#
|
2549
|
+
# @!attribute [rw] next_token
|
2550
|
+
# If there are more results than were returned in the response, the
|
2551
|
+
# response returns a `nextToken` that you can send in another
|
2552
|
+
# `ListGuardrails` request to see the next batch of results.
|
2553
|
+
# @return [String]
|
2554
|
+
#
|
2555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListGuardrailsResponse AWS API Documentation
|
2556
|
+
#
|
2557
|
+
class ListGuardrailsResponse < Struct.new(
|
2558
|
+
:guardrails,
|
2559
|
+
:next_token)
|
2560
|
+
SENSITIVE = []
|
2561
|
+
include Aws::Structure
|
2562
|
+
end
|
2563
|
+
|
919
2564
|
# @!attribute [rw] creation_time_after
|
920
2565
|
# Return customization jobs created after the specified time.
|
921
2566
|
# @return [Time]
|
@@ -983,39 +2628,47 @@ module Aws::Bedrock
|
|
983
2628
|
end
|
984
2629
|
|
985
2630
|
# @!attribute [rw] creation_time_after
|
986
|
-
#
|
2631
|
+
# A filter that returns Provisioned Throughputs created after the
|
2632
|
+
# specified time.
|
987
2633
|
# @return [Time]
|
988
2634
|
#
|
989
2635
|
# @!attribute [rw] creation_time_before
|
990
|
-
#
|
2636
|
+
# A filter that returns Provisioned Throughputs created before the
|
2637
|
+
# specified time.
|
991
2638
|
# @return [Time]
|
992
2639
|
#
|
993
2640
|
# @!attribute [rw] status_equals
|
994
|
-
#
|
995
|
-
#
|
2641
|
+
# A filter that returns Provisioned Throughputs if their statuses
|
2642
|
+
# matches the value that you specify.
|
996
2643
|
# @return [String]
|
997
2644
|
#
|
998
2645
|
# @!attribute [rw] model_arn_equals
|
999
|
-
#
|
1000
|
-
# equal to
|
2646
|
+
# A filter that returns Provisioned Throughputs whose model Amazon
|
2647
|
+
# Resource Name (ARN) is equal to the value that you specify.
|
1001
2648
|
# @return [String]
|
1002
2649
|
#
|
1003
2650
|
# @!attribute [rw] name_contains
|
1004
|
-
#
|
1005
|
-
#
|
2651
|
+
# A filter that returns Provisioned Throughputs if their name contains
|
2652
|
+
# the expression that you specify.
|
1006
2653
|
# @return [String]
|
1007
2654
|
#
|
1008
2655
|
# @!attribute [rw] max_results
|
1009
|
-
# THe maximum number of results to return in the response.
|
2656
|
+
# THe maximum number of results to return in the response. If there
|
2657
|
+
# are more results than the number you specified, the response returns
|
2658
|
+
# a `nextToken` value. To see the next batch of results, send the
|
2659
|
+
# `nextToken` value in another list request.
|
1010
2660
|
# @return [Integer]
|
1011
2661
|
#
|
1012
2662
|
# @!attribute [rw] next_token
|
1013
|
-
#
|
1014
|
-
#
|
2663
|
+
# If there are more results than the number you specified in the
|
2664
|
+
# `maxResults` field, the response returns a `nextToken` value. To see
|
2665
|
+
# the next batch of results, specify the `nextToken` value in this
|
2666
|
+
# field.
|
1015
2667
|
# @return [String]
|
1016
2668
|
#
|
1017
2669
|
# @!attribute [rw] sort_by
|
1018
|
-
# The field to sort
|
2670
|
+
# The field by which to sort the returned list of Provisioned
|
2671
|
+
# Throughputs.
|
1019
2672
|
# @return [String]
|
1020
2673
|
#
|
1021
2674
|
# @!attribute [rw] sort_order
|
@@ -1039,12 +2692,14 @@ module Aws::Bedrock
|
|
1039
2692
|
end
|
1040
2693
|
|
1041
2694
|
# @!attribute [rw] next_token
|
1042
|
-
#
|
1043
|
-
#
|
2695
|
+
# If there are more results than the number you specified in the
|
2696
|
+
# `maxResults` field, this value is returned. To see the next batch of
|
2697
|
+
# results, include this value in the `nextToken` field in another list
|
2698
|
+
# request.
|
1044
2699
|
# @return [String]
|
1045
2700
|
#
|
1046
2701
|
# @!attribute [rw] provisioned_model_summaries
|
1047
|
-
#
|
2702
|
+
# A list of summaries, one for each Provisioned Throughput in the
|
1048
2703
|
# response.
|
1049
2704
|
# @return [Array<Types::ProvisionedModelSummary>]
|
1050
2705
|
#
|
@@ -1058,7 +2713,7 @@ module Aws::Bedrock
|
|
1058
2713
|
end
|
1059
2714
|
|
1060
2715
|
# @!attribute [rw] resource_arn
|
1061
|
-
# The ARN of the resource.
|
2716
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1062
2717
|
# @return [String]
|
1063
2718
|
#
|
1064
2719
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListTagsForResourceRequest AWS API Documentation
|
@@ -1081,7 +2736,7 @@ module Aws::Bedrock
|
|
1081
2736
|
include Aws::Structure
|
1082
2737
|
end
|
1083
2738
|
|
1084
|
-
# Configuration fields for
|
2739
|
+
# Configuration fields for invocation logging.
|
1085
2740
|
#
|
1086
2741
|
# @!attribute [rw] cloud_watch_config
|
1087
2742
|
# CloudWatch logging configuration.
|
@@ -1118,11 +2773,11 @@ module Aws::Bedrock
|
|
1118
2773
|
# Information about one customization job
|
1119
2774
|
#
|
1120
2775
|
# @!attribute [rw] job_arn
|
1121
|
-
# ARN of the customization job.
|
2776
|
+
# Amazon Resource Name (ARN) of the customization job.
|
1122
2777
|
# @return [String]
|
1123
2778
|
#
|
1124
2779
|
# @!attribute [rw] base_model_arn
|
1125
|
-
# ARN of the base model.
|
2780
|
+
# Amazon Resource Name (ARN) of the base model.
|
1126
2781
|
# @return [String]
|
1127
2782
|
#
|
1128
2783
|
# @!attribute [rw] job_name
|
@@ -1146,7 +2801,7 @@ module Aws::Bedrock
|
|
1146
2801
|
# @return [Time]
|
1147
2802
|
#
|
1148
2803
|
# @!attribute [rw] custom_model_arn
|
1149
|
-
# ARN of the custom model.
|
2804
|
+
# Amazon Resource Name (ARN) of the custom model.
|
1150
2805
|
# @return [String]
|
1151
2806
|
#
|
1152
2807
|
# @!attribute [rw] custom_model_name
|
@@ -1194,54 +2849,72 @@ module Aws::Bedrock
|
|
1194
2849
|
include Aws::Structure
|
1195
2850
|
end
|
1196
2851
|
|
1197
|
-
#
|
2852
|
+
# A summary of information about a Provisioned Throughput.
|
2853
|
+
#
|
2854
|
+
# This data type is used in the following API operations:
|
2855
|
+
#
|
2856
|
+
# * [ListProvisionedThroughputs response][1]
|
2857
|
+
#
|
2858
|
+
# ^
|
2859
|
+
#
|
2860
|
+
#
|
2861
|
+
#
|
2862
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListProvisionedModelThroughputs.html#API_ListProvisionedModelThroughputs_ResponseSyntax
|
1198
2863
|
#
|
1199
2864
|
# @!attribute [rw] provisioned_model_name
|
1200
|
-
# The name of the
|
2865
|
+
# The name of the Provisioned Throughput.
|
1201
2866
|
# @return [String]
|
1202
2867
|
#
|
1203
2868
|
# @!attribute [rw] provisioned_model_arn
|
1204
|
-
# The ARN of the
|
2869
|
+
# The Amazon Resource Name (ARN) of the Provisioned Throughput.
|
1205
2870
|
# @return [String]
|
1206
2871
|
#
|
1207
2872
|
# @!attribute [rw] model_arn
|
1208
|
-
# The ARN of the model associated with
|
2873
|
+
# The Amazon Resource Name (ARN) of the model associated with the
|
2874
|
+
# Provisioned Throughput.
|
1209
2875
|
# @return [String]
|
1210
2876
|
#
|
1211
2877
|
# @!attribute [rw] desired_model_arn
|
1212
|
-
#
|
2878
|
+
# The Amazon Resource Name (ARN) of the model requested to be
|
2879
|
+
# associated to this Provisioned Throughput. This value differs from
|
2880
|
+
# the `modelArn` if updating hasn't completed.
|
1213
2881
|
# @return [String]
|
1214
2882
|
#
|
1215
2883
|
# @!attribute [rw] foundation_model_arn
|
1216
|
-
#
|
2884
|
+
# The Amazon Resource Name (ARN) of the base model for which the
|
2885
|
+
# Provisioned Throughput was created, or of the base model that the
|
2886
|
+
# custom model for which the Provisioned Throughput was created was
|
2887
|
+
# customized.
|
1217
2888
|
# @return [String]
|
1218
2889
|
#
|
1219
2890
|
# @!attribute [rw] model_units
|
1220
|
-
# The number of model units allocated.
|
2891
|
+
# The number of model units allocated to the Provisioned Throughput.
|
1221
2892
|
# @return [Integer]
|
1222
2893
|
#
|
1223
2894
|
# @!attribute [rw] desired_model_units
|
1224
|
-
#
|
2895
|
+
# The number of model units that was requested to be allocated to the
|
2896
|
+
# Provisioned Throughput.
|
1225
2897
|
# @return [Integer]
|
1226
2898
|
#
|
1227
2899
|
# @!attribute [rw] status
|
1228
|
-
#
|
2900
|
+
# The status of the Provisioned Throughput.
|
1229
2901
|
# @return [String]
|
1230
2902
|
#
|
1231
2903
|
# @!attribute [rw] commitment_duration
|
1232
|
-
#
|
2904
|
+
# The duration for which the Provisioned Throughput was committed.
|
1233
2905
|
# @return [String]
|
1234
2906
|
#
|
1235
2907
|
# @!attribute [rw] commitment_expiration_time
|
1236
|
-
#
|
2908
|
+
# The timestamp for when the commitment term of the Provisioned
|
2909
|
+
# Throughput expires.
|
1237
2910
|
# @return [Time]
|
1238
2911
|
#
|
1239
2912
|
# @!attribute [rw] creation_time
|
1240
|
-
# The time that
|
2913
|
+
# The time that the Provisioned Throughput was created.
|
1241
2914
|
# @return [Time]
|
1242
2915
|
#
|
1243
2916
|
# @!attribute [rw] last_modified_time
|
1244
|
-
# The time that
|
2917
|
+
# The time that the Provisioned Throughput was last modified.
|
1245
2918
|
# @return [Time]
|
1246
2919
|
#
|
1247
2920
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ProvisionedModelSummary AWS API Documentation
|
@@ -1279,8 +2952,8 @@ module Aws::Bedrock
|
|
1279
2952
|
#
|
1280
2953
|
class PutModelInvocationLoggingConfigurationResponse < Aws::EmptyStructure; end
|
1281
2954
|
|
1282
|
-
# The specified resource ARN was not found. Check
|
1283
|
-
# request again.
|
2955
|
+
# The specified resource Amazon Resource Name (ARN) was not found. Check
|
2956
|
+
# the Amazon Resource Name (ARN) and try your request again.
|
1284
2957
|
#
|
1285
2958
|
# @!attribute [rw] message
|
1286
2959
|
# @return [String]
|
@@ -1326,6 +2999,22 @@ module Aws::Bedrock
|
|
1326
2999
|
include Aws::Structure
|
1327
3000
|
end
|
1328
3001
|
|
3002
|
+
# @!attribute [rw] job_identifier
|
3003
|
+
# The ARN of the model evaluation job you want to stop.
|
3004
|
+
# @return [String]
|
3005
|
+
#
|
3006
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/StopEvaluationJobRequest AWS API Documentation
|
3007
|
+
#
|
3008
|
+
class StopEvaluationJobRequest < Struct.new(
|
3009
|
+
:job_identifier)
|
3010
|
+
SENSITIVE = [:job_identifier]
|
3011
|
+
include Aws::Structure
|
3012
|
+
end
|
3013
|
+
|
3014
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/StopEvaluationJobResponse AWS API Documentation
|
3015
|
+
#
|
3016
|
+
class StopEvaluationJobResponse < Aws::EmptyStructure; end
|
3017
|
+
|
1329
3018
|
# @!attribute [rw] job_identifier
|
1330
3019
|
# Job identifier of the job to stop.
|
1331
3020
|
# @return [String]
|
@@ -1362,7 +3051,7 @@ module Aws::Bedrock
|
|
1362
3051
|
end
|
1363
3052
|
|
1364
3053
|
# @!attribute [rw] resource_arn
|
1365
|
-
# The ARN of the resource to tag.
|
3054
|
+
# The Amazon Resource Name (ARN) of the resource to tag.
|
1366
3055
|
# @return [String]
|
1367
3056
|
#
|
1368
3057
|
# @!attribute [rw] tags
|
@@ -1444,7 +3133,7 @@ module Aws::Bedrock
|
|
1444
3133
|
end
|
1445
3134
|
|
1446
3135
|
# @!attribute [rw] resource_arn
|
1447
|
-
# The ARN of the resource to untag.
|
3136
|
+
# The Amazon Resource Name (ARN) of the resource to untag.
|
1448
3137
|
# @return [String]
|
1449
3138
|
#
|
1450
3139
|
# @!attribute [rw] tag_keys
|
@@ -1464,17 +3153,111 @@ module Aws::Bedrock
|
|
1464
3153
|
#
|
1465
3154
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
1466
3155
|
|
3156
|
+
# @!attribute [rw] guardrail_identifier
|
3157
|
+
# The unique identifier of the guardrail
|
3158
|
+
# @return [String]
|
3159
|
+
#
|
3160
|
+
# @!attribute [rw] name
|
3161
|
+
# A name for the guardrail.
|
3162
|
+
# @return [String]
|
3163
|
+
#
|
3164
|
+
# @!attribute [rw] description
|
3165
|
+
# A description of the guardrail.
|
3166
|
+
# @return [String]
|
3167
|
+
#
|
3168
|
+
# @!attribute [rw] topic_policy_config
|
3169
|
+
# The topic policy to configure for the guardrail.
|
3170
|
+
# @return [Types::GuardrailTopicPolicyConfig]
|
3171
|
+
#
|
3172
|
+
# @!attribute [rw] content_policy_config
|
3173
|
+
# The content policy to configure for the guardrail.
|
3174
|
+
# @return [Types::GuardrailContentPolicyConfig]
|
3175
|
+
#
|
3176
|
+
# @!attribute [rw] word_policy_config
|
3177
|
+
# The word policy to configure for the guardrail.
|
3178
|
+
# @return [Types::GuardrailWordPolicyConfig]
|
3179
|
+
#
|
3180
|
+
# @!attribute [rw] sensitive_information_policy_config
|
3181
|
+
# The sensitive information policy to configure for the guardrail.
|
3182
|
+
# @return [Types::GuardrailSensitiveInformationPolicyConfig]
|
3183
|
+
#
|
3184
|
+
# @!attribute [rw] blocked_input_messaging
|
3185
|
+
# The message to return when the guardrail blocks a prompt.
|
3186
|
+
# @return [String]
|
3187
|
+
#
|
3188
|
+
# @!attribute [rw] blocked_outputs_messaging
|
3189
|
+
# The message to return when the guardrail blocks a model response.
|
3190
|
+
# @return [String]
|
3191
|
+
#
|
3192
|
+
# @!attribute [rw] kms_key_id
|
3193
|
+
# The ARN of the KMS key with which to encrypt the guardrail.
|
3194
|
+
# @return [String]
|
3195
|
+
#
|
3196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UpdateGuardrailRequest AWS API Documentation
|
3197
|
+
#
|
3198
|
+
class UpdateGuardrailRequest < Struct.new(
|
3199
|
+
:guardrail_identifier,
|
3200
|
+
:name,
|
3201
|
+
:description,
|
3202
|
+
:topic_policy_config,
|
3203
|
+
:content_policy_config,
|
3204
|
+
:word_policy_config,
|
3205
|
+
:sensitive_information_policy_config,
|
3206
|
+
:blocked_input_messaging,
|
3207
|
+
:blocked_outputs_messaging,
|
3208
|
+
:kms_key_id)
|
3209
|
+
SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging]
|
3210
|
+
include Aws::Structure
|
3211
|
+
end
|
3212
|
+
|
3213
|
+
# @!attribute [rw] guardrail_id
|
3214
|
+
# The unique identifier of the guardrail
|
3215
|
+
# @return [String]
|
3216
|
+
#
|
3217
|
+
# @!attribute [rw] guardrail_arn
|
3218
|
+
# The ARN of the guardrail that was created.
|
3219
|
+
# @return [String]
|
3220
|
+
#
|
3221
|
+
# @!attribute [rw] version
|
3222
|
+
# The version of the guardrail.
|
3223
|
+
# @return [String]
|
3224
|
+
#
|
3225
|
+
# @!attribute [rw] updated_at
|
3226
|
+
# The date and time at which the guardrail was updated.
|
3227
|
+
# @return [Time]
|
3228
|
+
#
|
3229
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UpdateGuardrailResponse AWS API Documentation
|
3230
|
+
#
|
3231
|
+
class UpdateGuardrailResponse < Struct.new(
|
3232
|
+
:guardrail_id,
|
3233
|
+
:guardrail_arn,
|
3234
|
+
:version,
|
3235
|
+
:updated_at)
|
3236
|
+
SENSITIVE = []
|
3237
|
+
include Aws::Structure
|
3238
|
+
end
|
3239
|
+
|
1467
3240
|
# @!attribute [rw] provisioned_model_id
|
1468
|
-
# The ARN or name of the
|
3241
|
+
# The Amazon Resource Name (ARN) or name of the Provisioned Throughput
|
3242
|
+
# to update.
|
1469
3243
|
# @return [String]
|
1470
3244
|
#
|
1471
3245
|
# @!attribute [rw] desired_provisioned_model_name
|
1472
|
-
# The new name for this
|
3246
|
+
# The new name for this Provisioned Throughput.
|
1473
3247
|
# @return [String]
|
1474
3248
|
#
|
1475
3249
|
# @!attribute [rw] desired_model_id
|
1476
|
-
# The ARN of the new model to associate with
|
1477
|
-
#
|
3250
|
+
# The Amazon Resource Name (ARN) of the new model to associate with
|
3251
|
+
# this Provisioned Throughput. You can't specify this field if this
|
3252
|
+
# Provisioned Throughput is associated with a base model.
|
3253
|
+
#
|
3254
|
+
# If this Provisioned Throughput is associated with a custom model,
|
3255
|
+
# you can specify one of the following options:
|
3256
|
+
#
|
3257
|
+
# * The base model from which the custom model was customized.
|
3258
|
+
#
|
3259
|
+
# * Another custom model that was customized from the same base model
|
3260
|
+
# as the custom model.
|
1478
3261
|
# @return [String]
|
1479
3262
|
#
|
1480
3263
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UpdateProvisionedModelThroughputRequest AWS API Documentation
|