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.
@@ -33,7 +33,7 @@ require_relative 'aws-sdk-bedrock/customizations'
33
33
  # structure.
34
34
  #
35
35
  # bedrock = Aws::Bedrock::Client.new
36
- # resp = bedrock.create_model_customization_job(params)
36
+ # resp = bedrock.create_evaluation_job(params)
37
37
  #
38
38
  # See {Client} for more information.
39
39
  #
@@ -53,6 +53,6 @@ require_relative 'aws-sdk-bedrock/customizations'
53
53
  # @!group service
54
54
  module Aws::Bedrock
55
55
 
56
- GEM_VERSION = '1.4.0'
56
+ GEM_VERSION = '1.5.0'
57
57
 
58
58
  end
data/sig/client.rbs CHANGED
@@ -72,6 +72,164 @@ module Aws
72
72
  | (?Hash[Symbol, untyped]) -> instance
73
73
 
74
74
 
75
+ interface _CreateEvaluationJobResponseSuccess
76
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateEvaluationJobResponse]
77
+ def job_arn: () -> ::String
78
+ end
79
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#create_evaluation_job-instance_method
80
+ def create_evaluation_job: (
81
+ job_name: ::String,
82
+ ?job_description: ::String,
83
+ ?client_request_token: ::String,
84
+ role_arn: ::String,
85
+ ?customer_encryption_key_id: ::String,
86
+ ?job_tags: Array[
87
+ {
88
+ key: ::String,
89
+ value: ::String
90
+ },
91
+ ],
92
+ evaluation_config: {
93
+ automated: {
94
+ dataset_metric_configs: Array[
95
+ {
96
+ task_type: ("Summarization" | "Classification" | "QuestionAndAnswer" | "Generation" | "Custom"),
97
+ dataset: {
98
+ name: ::String,
99
+ dataset_location: {
100
+ s3_uri: ::String?
101
+ }?
102
+ },
103
+ metric_names: Array[::String]
104
+ },
105
+ ]
106
+ }?,
107
+ human: {
108
+ human_workflow_config: {
109
+ flow_definition_arn: ::String,
110
+ instructions: ::String?
111
+ }?,
112
+ custom_metrics: Array[
113
+ {
114
+ name: ::String,
115
+ description: ::String?,
116
+ rating_method: ::String
117
+ },
118
+ ]?,
119
+ dataset_metric_configs: Array[
120
+ {
121
+ task_type: ("Summarization" | "Classification" | "QuestionAndAnswer" | "Generation" | "Custom"),
122
+ dataset: {
123
+ name: ::String,
124
+ dataset_location: {
125
+ s3_uri: ::String?
126
+ }?
127
+ },
128
+ metric_names: Array[::String]
129
+ },
130
+ ]
131
+ }?
132
+ },
133
+ inference_config: {
134
+ models: Array[
135
+ {
136
+ bedrock_model: {
137
+ model_identifier: ::String,
138
+ inference_params: ::String
139
+ }?
140
+ },
141
+ ]?
142
+ },
143
+ output_data_config: {
144
+ s3_uri: ::String
145
+ }
146
+ ) -> _CreateEvaluationJobResponseSuccess
147
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateEvaluationJobResponseSuccess
148
+
149
+ interface _CreateGuardrailResponseSuccess
150
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateGuardrailResponse]
151
+ def guardrail_id: () -> ::String
152
+ def guardrail_arn: () -> ::String
153
+ def version: () -> ::String
154
+ def created_at: () -> ::Time
155
+ end
156
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#create_guardrail-instance_method
157
+ def create_guardrail: (
158
+ name: ::String,
159
+ ?description: ::String,
160
+ ?topic_policy_config: {
161
+ topics_config: Array[
162
+ {
163
+ name: ::String,
164
+ definition: ::String,
165
+ examples: Array[::String]?,
166
+ type: ("DENY")
167
+ },
168
+ ]
169
+ },
170
+ ?content_policy_config: {
171
+ filters_config: Array[
172
+ {
173
+ type: ("SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK"),
174
+ input_strength: ("NONE" | "LOW" | "MEDIUM" | "HIGH"),
175
+ output_strength: ("NONE" | "LOW" | "MEDIUM" | "HIGH")
176
+ },
177
+ ]
178
+ },
179
+ ?word_policy_config: {
180
+ words_config: Array[
181
+ {
182
+ text: ::String
183
+ },
184
+ ]?,
185
+ managed_word_lists_config: Array[
186
+ {
187
+ type: ("PROFANITY")
188
+ },
189
+ ]?
190
+ },
191
+ ?sensitive_information_policy_config: {
192
+ pii_entities_config: Array[
193
+ {
194
+ type: ("ADDRESS" | "AGE" | "AWS_ACCESS_KEY" | "AWS_SECRET_KEY" | "CA_HEALTH_NUMBER" | "CA_SOCIAL_INSURANCE_NUMBER" | "CREDIT_DEBIT_CARD_CVV" | "CREDIT_DEBIT_CARD_EXPIRY" | "CREDIT_DEBIT_CARD_NUMBER" | "DRIVER_ID" | "EMAIL" | "INTERNATIONAL_BANK_ACCOUNT_NUMBER" | "IP_ADDRESS" | "LICENSE_PLATE" | "MAC_ADDRESS" | "NAME" | "PASSWORD" | "PHONE" | "PIN" | "SWIFT_CODE" | "UK_NATIONAL_HEALTH_SERVICE_NUMBER" | "UK_NATIONAL_INSURANCE_NUMBER" | "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" | "URL" | "USERNAME" | "US_BANK_ACCOUNT_NUMBER" | "US_BANK_ROUTING_NUMBER" | "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" | "US_PASSPORT_NUMBER" | "US_SOCIAL_SECURITY_NUMBER" | "VEHICLE_IDENTIFICATION_NUMBER"),
195
+ action: ("BLOCK" | "ANONYMIZE")
196
+ },
197
+ ]?,
198
+ regexes_config: Array[
199
+ {
200
+ name: ::String,
201
+ description: ::String?,
202
+ pattern: ::String,
203
+ action: ("BLOCK" | "ANONYMIZE")
204
+ },
205
+ ]?
206
+ },
207
+ blocked_input_messaging: ::String,
208
+ blocked_outputs_messaging: ::String,
209
+ ?kms_key_id: ::String,
210
+ ?tags: Array[
211
+ {
212
+ key: ::String,
213
+ value: ::String
214
+ },
215
+ ],
216
+ ?client_request_token: ::String
217
+ ) -> _CreateGuardrailResponseSuccess
218
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateGuardrailResponseSuccess
219
+
220
+ interface _CreateGuardrailVersionResponseSuccess
221
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateGuardrailVersionResponse]
222
+ def guardrail_id: () -> ::String
223
+ def version: () -> ::String
224
+ end
225
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#create_guardrail_version-instance_method
226
+ def create_guardrail_version: (
227
+ guardrail_identifier: ::String,
228
+ ?description: ::String,
229
+ ?client_request_token: ::String
230
+ ) -> _CreateGuardrailVersionResponseSuccess
231
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateGuardrailVersionResponseSuccess
232
+
75
233
  interface _CreateModelCustomizationJobResponseSuccess
76
234
  include ::Seahorse::Client::_ResponseSuccess[Types::CreateModelCustomizationJobResponse]
77
235
  def job_arn: () -> ::String
@@ -147,6 +305,16 @@ module Aws
147
305
  ) -> _DeleteCustomModelResponseSuccess
148
306
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteCustomModelResponseSuccess
149
307
 
308
+ interface _DeleteGuardrailResponseSuccess
309
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteGuardrailResponse]
310
+ end
311
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#delete_guardrail-instance_method
312
+ def delete_guardrail: (
313
+ guardrail_identifier: ::String,
314
+ ?guardrail_version: ::String
315
+ ) -> _DeleteGuardrailResponseSuccess
316
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteGuardrailResponseSuccess
317
+
150
318
  interface _DeleteModelInvocationLoggingConfigurationResponseSuccess
151
319
  include ::Seahorse::Client::_ResponseSuccess[Types::DeleteModelInvocationLoggingConfigurationResponse]
152
320
  end
@@ -187,6 +355,28 @@ module Aws
187
355
  ) -> _GetCustomModelResponseSuccess
188
356
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCustomModelResponseSuccess
189
357
 
358
+ interface _GetEvaluationJobResponseSuccess
359
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetEvaluationJobResponse]
360
+ def job_name: () -> ::String
361
+ def status: () -> ("InProgress" | "Completed" | "Failed" | "Stopping" | "Stopped")
362
+ def job_arn: () -> ::String
363
+ def job_description: () -> ::String
364
+ def role_arn: () -> ::String
365
+ def customer_encryption_key_id: () -> ::String
366
+ def job_type: () -> ("Human" | "Automated")
367
+ def evaluation_config: () -> Types::EvaluationConfig
368
+ def inference_config: () -> Types::EvaluationInferenceConfig
369
+ def output_data_config: () -> Types::EvaluationOutputDataConfig
370
+ def creation_time: () -> ::Time
371
+ def last_modified_time: () -> ::Time
372
+ def failure_messages: () -> ::Array[::String]
373
+ end
374
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#get_evaluation_job-instance_method
375
+ def get_evaluation_job: (
376
+ job_identifier: ::String
377
+ ) -> _GetEvaluationJobResponseSuccess
378
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetEvaluationJobResponseSuccess
379
+
190
380
  interface _GetFoundationModelResponseSuccess
191
381
  include ::Seahorse::Client::_ResponseSuccess[Types::GetFoundationModelResponse]
192
382
  def model_details: () -> Types::FoundationModelDetails
@@ -197,6 +387,33 @@ module Aws
197
387
  ) -> _GetFoundationModelResponseSuccess
198
388
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetFoundationModelResponseSuccess
199
389
 
390
+ interface _GetGuardrailResponseSuccess
391
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetGuardrailResponse]
392
+ def name: () -> ::String
393
+ def description: () -> ::String
394
+ def guardrail_id: () -> ::String
395
+ def guardrail_arn: () -> ::String
396
+ def version: () -> ::String
397
+ def status: () -> ("CREATING" | "UPDATING" | "VERSIONING" | "READY" | "FAILED" | "DELETING")
398
+ def topic_policy: () -> Types::GuardrailTopicPolicy
399
+ def content_policy: () -> Types::GuardrailContentPolicy
400
+ def word_policy: () -> Types::GuardrailWordPolicy
401
+ def sensitive_information_policy: () -> Types::GuardrailSensitiveInformationPolicy
402
+ def created_at: () -> ::Time
403
+ def updated_at: () -> ::Time
404
+ def status_reasons: () -> ::Array[::String]
405
+ def failure_recommendations: () -> ::Array[::String]
406
+ def blocked_input_messaging: () -> ::String
407
+ def blocked_outputs_messaging: () -> ::String
408
+ def kms_key_arn: () -> ::String
409
+ end
410
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#get_guardrail-instance_method
411
+ def get_guardrail: (
412
+ guardrail_identifier: ::String,
413
+ ?guardrail_version: ::String
414
+ ) -> _GetGuardrailResponseSuccess
415
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetGuardrailResponseSuccess
416
+
200
417
  interface _GetModelCustomizationJobResponseSuccess
201
418
  include ::Seahorse::Client::_ResponseSuccess[Types::GetModelCustomizationJobResponse]
202
419
  def job_arn: () -> ::String
@@ -277,6 +494,24 @@ module Aws
277
494
  ) -> _ListCustomModelsResponseSuccess
278
495
  | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListCustomModelsResponseSuccess
279
496
 
497
+ interface _ListEvaluationJobsResponseSuccess
498
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListEvaluationJobsResponse]
499
+ def next_token: () -> ::String
500
+ def job_summaries: () -> ::Array[Types::EvaluationSummary]
501
+ end
502
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#list_evaluation_jobs-instance_method
503
+ def list_evaluation_jobs: (
504
+ ?creation_time_after: ::Time,
505
+ ?creation_time_before: ::Time,
506
+ ?status_equals: ("InProgress" | "Completed" | "Failed" | "Stopping" | "Stopped"),
507
+ ?name_contains: ::String,
508
+ ?max_results: ::Integer,
509
+ ?next_token: ::String,
510
+ ?sort_by: ("CreationTime"),
511
+ ?sort_order: ("Ascending" | "Descending")
512
+ ) -> _ListEvaluationJobsResponseSuccess
513
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListEvaluationJobsResponseSuccess
514
+
280
515
  interface _ListFoundationModelsResponseSuccess
281
516
  include ::Seahorse::Client::_ResponseSuccess[Types::ListFoundationModelsResponse]
282
517
  def model_summaries: () -> ::Array[Types::FoundationModelSummary]
@@ -290,6 +525,19 @@ module Aws
290
525
  ) -> _ListFoundationModelsResponseSuccess
291
526
  | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListFoundationModelsResponseSuccess
292
527
 
528
+ interface _ListGuardrailsResponseSuccess
529
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListGuardrailsResponse]
530
+ def guardrails: () -> ::Array[Types::GuardrailSummary]
531
+ def next_token: () -> ::String
532
+ end
533
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#list_guardrails-instance_method
534
+ def list_guardrails: (
535
+ ?guardrail_identifier: ::String,
536
+ ?max_results: ::Integer,
537
+ ?next_token: ::String
538
+ ) -> _ListGuardrailsResponseSuccess
539
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListGuardrailsResponseSuccess
540
+
293
541
  interface _ListModelCustomizationJobsResponseSuccess
294
542
  include ::Seahorse::Client::_ResponseSuccess[Types::ListModelCustomizationJobsResponse]
295
543
  def next_token: () -> ::String
@@ -362,6 +610,15 @@ module Aws
362
610
  ) -> _PutModelInvocationLoggingConfigurationResponseSuccess
363
611
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutModelInvocationLoggingConfigurationResponseSuccess
364
612
 
613
+ interface _StopEvaluationJobResponseSuccess
614
+ include ::Seahorse::Client::_ResponseSuccess[Types::StopEvaluationJobResponse]
615
+ end
616
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#stop_evaluation_job-instance_method
617
+ def stop_evaluation_job: (
618
+ job_identifier: ::String
619
+ ) -> _StopEvaluationJobResponseSuccess
620
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StopEvaluationJobResponseSuccess
621
+
365
622
  interface _StopModelCustomizationJobResponseSuccess
366
623
  include ::Seahorse::Client::_ResponseSuccess[Types::StopModelCustomizationJobResponse]
367
624
  end
@@ -396,6 +653,71 @@ module Aws
396
653
  ) -> _UntagResourceResponseSuccess
397
654
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
398
655
 
656
+ interface _UpdateGuardrailResponseSuccess
657
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateGuardrailResponse]
658
+ def guardrail_id: () -> ::String
659
+ def guardrail_arn: () -> ::String
660
+ def version: () -> ::String
661
+ def updated_at: () -> ::Time
662
+ end
663
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#update_guardrail-instance_method
664
+ def update_guardrail: (
665
+ guardrail_identifier: ::String,
666
+ name: ::String,
667
+ ?description: ::String,
668
+ ?topic_policy_config: {
669
+ topics_config: Array[
670
+ {
671
+ name: ::String,
672
+ definition: ::String,
673
+ examples: Array[::String]?,
674
+ type: ("DENY")
675
+ },
676
+ ]
677
+ },
678
+ ?content_policy_config: {
679
+ filters_config: Array[
680
+ {
681
+ type: ("SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK"),
682
+ input_strength: ("NONE" | "LOW" | "MEDIUM" | "HIGH"),
683
+ output_strength: ("NONE" | "LOW" | "MEDIUM" | "HIGH")
684
+ },
685
+ ]
686
+ },
687
+ ?word_policy_config: {
688
+ words_config: Array[
689
+ {
690
+ text: ::String
691
+ },
692
+ ]?,
693
+ managed_word_lists_config: Array[
694
+ {
695
+ type: ("PROFANITY")
696
+ },
697
+ ]?
698
+ },
699
+ ?sensitive_information_policy_config: {
700
+ pii_entities_config: Array[
701
+ {
702
+ type: ("ADDRESS" | "AGE" | "AWS_ACCESS_KEY" | "AWS_SECRET_KEY" | "CA_HEALTH_NUMBER" | "CA_SOCIAL_INSURANCE_NUMBER" | "CREDIT_DEBIT_CARD_CVV" | "CREDIT_DEBIT_CARD_EXPIRY" | "CREDIT_DEBIT_CARD_NUMBER" | "DRIVER_ID" | "EMAIL" | "INTERNATIONAL_BANK_ACCOUNT_NUMBER" | "IP_ADDRESS" | "LICENSE_PLATE" | "MAC_ADDRESS" | "NAME" | "PASSWORD" | "PHONE" | "PIN" | "SWIFT_CODE" | "UK_NATIONAL_HEALTH_SERVICE_NUMBER" | "UK_NATIONAL_INSURANCE_NUMBER" | "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" | "URL" | "USERNAME" | "US_BANK_ACCOUNT_NUMBER" | "US_BANK_ROUTING_NUMBER" | "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" | "US_PASSPORT_NUMBER" | "US_SOCIAL_SECURITY_NUMBER" | "VEHICLE_IDENTIFICATION_NUMBER"),
703
+ action: ("BLOCK" | "ANONYMIZE")
704
+ },
705
+ ]?,
706
+ regexes_config: Array[
707
+ {
708
+ name: ::String,
709
+ description: ::String?,
710
+ pattern: ::String,
711
+ action: ("BLOCK" | "ANONYMIZE")
712
+ },
713
+ ]?
714
+ },
715
+ blocked_input_messaging: ::String,
716
+ blocked_outputs_messaging: ::String,
717
+ ?kms_key_id: ::String
718
+ ) -> _UpdateGuardrailResponseSuccess
719
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateGuardrailResponseSuccess
720
+
399
721
  interface _UpdateProvisionedModelThroughputResponseSuccess
400
722
  include ::Seahorse::Client::_ResponseSuccess[Types::UpdateProvisionedModelThroughputResponse]
401
723
  end