aws-sdk-bedrock 1.57.0 → 1.59.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.
@@ -128,6 +128,1872 @@ module Aws::Bedrock
128
128
  class Unknown < AutomatedEvaluationCustomMetricSource; end
129
129
  end
130
130
 
131
+ # Represents the result of an Automated Reasoning validation check,
132
+ # indicating whether the content is logically valid, invalid, or falls
133
+ # into other categories based on the policy rules.
134
+ #
135
+ # @note AutomatedReasoningCheckFinding is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AutomatedReasoningCheckFinding corresponding to the set member.
136
+ #
137
+ # @!attribute [rw] valid
138
+ # Indicates that the claims are true. The claims are implied by the
139
+ # premises and the Automated Reasoning policy. Given the Automated
140
+ # Reasoning policy and premises, it is not possible for these claims
141
+ # to be false.
142
+ # @return [Types::AutomatedReasoningCheckValidFinding]
143
+ #
144
+ # @!attribute [rw] invalid
145
+ # Indicates that the claims are false. The claims are not implied by
146
+ # the premises and Automated Reasoning policy. Furthermore, there
147
+ # exist different claims that are consistent with the premises and
148
+ # Automated Reasoning policy.
149
+ # @return [Types::AutomatedReasoningCheckInvalidFinding]
150
+ #
151
+ # @!attribute [rw] satisfiable
152
+ # Indicates that the claims can be true or false. It depends on what
153
+ # assumptions are made for the claim to be implied from the premises
154
+ # and Automated Reasoning policy rules. In this situation, different
155
+ # assumptions can make input claims false and alternative claims true.
156
+ # @return [Types::AutomatedReasoningCheckSatisfiableFinding]
157
+ #
158
+ # @!attribute [rw] impossible
159
+ # Indicates that Automated Reasoning cannot make a statement about the
160
+ # claims. This can happen if the premises are logically incorrect, or
161
+ # if there is a conflict within the Automated Reasoning policy itself.
162
+ # @return [Types::AutomatedReasoningCheckImpossibleFinding]
163
+ #
164
+ # @!attribute [rw] translation_ambiguous
165
+ # Indicates that an ambiguity was detected in the translation, making
166
+ # it unsound to continue with validity checking. Additional context or
167
+ # follow-up questions might be needed to get translation to succeed.
168
+ # @return [Types::AutomatedReasoningCheckTranslationAmbiguousFinding]
169
+ #
170
+ # @!attribute [rw] too_complex
171
+ # Indicates that the input contains too much information for Automated
172
+ # Reasoning to process within its latency limits.
173
+ # @return [Types::AutomatedReasoningCheckTooComplexFinding]
174
+ #
175
+ # @!attribute [rw] no_translations
176
+ # Identifies that some or all of the input prompt wasn't translated
177
+ # into logic. This can happen if the input isn't relevant to the
178
+ # Automated Reasoning policy, or if the policy doesn't have variables
179
+ # to model relevant input.
180
+ # @return [Types::AutomatedReasoningCheckNoTranslationsFinding]
181
+ #
182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningCheckFinding AWS API Documentation
183
+ #
184
+ class AutomatedReasoningCheckFinding < Struct.new(
185
+ :valid,
186
+ :invalid,
187
+ :satisfiable,
188
+ :impossible,
189
+ :translation_ambiguous,
190
+ :too_complex,
191
+ :no_translations,
192
+ :unknown)
193
+ SENSITIVE = []
194
+ include Aws::Structure
195
+ include Aws::Structure::Union
196
+
197
+ class Valid < AutomatedReasoningCheckFinding; end
198
+ class Invalid < AutomatedReasoningCheckFinding; end
199
+ class Satisfiable < AutomatedReasoningCheckFinding; end
200
+ class Impossible < AutomatedReasoningCheckFinding; end
201
+ class TranslationAmbiguous < AutomatedReasoningCheckFinding; end
202
+ class TooComplex < AutomatedReasoningCheckFinding; end
203
+ class NoTranslations < AutomatedReasoningCheckFinding; end
204
+ class Unknown < AutomatedReasoningCheckFinding; end
205
+ end
206
+
207
+ # Indicates that no valid claims can be made due to logical
208
+ # contradictions in the premises or rules.
209
+ #
210
+ # @!attribute [rw] translation
211
+ # The logical translation of the input that this finding evaluates.
212
+ # @return [Types::AutomatedReasoningCheckTranslation]
213
+ #
214
+ # @!attribute [rw] contradicting_rules
215
+ # The automated reasoning policy rules that contradict the claims
216
+ # and/or premises in the input.
217
+ # @return [Array<Types::AutomatedReasoningCheckRule>]
218
+ #
219
+ # @!attribute [rw] logic_warning
220
+ # Indication of a logic issue with the translation without needing to
221
+ # consider the automated reasoning policy rules.
222
+ # @return [Types::AutomatedReasoningCheckLogicWarning]
223
+ #
224
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningCheckImpossibleFinding AWS API Documentation
225
+ #
226
+ class AutomatedReasoningCheckImpossibleFinding < Struct.new(
227
+ :translation,
228
+ :contradicting_rules,
229
+ :logic_warning)
230
+ SENSITIVE = []
231
+ include Aws::Structure
232
+ end
233
+
234
+ # References a portion of the original input text that corresponds to
235
+ # logical elements.
236
+ #
237
+ # @!attribute [rw] text
238
+ # The specific text from the original input that this reference points
239
+ # to.
240
+ # @return [String]
241
+ #
242
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningCheckInputTextReference AWS API Documentation
243
+ #
244
+ class AutomatedReasoningCheckInputTextReference < Struct.new(
245
+ :text)
246
+ SENSITIVE = [:text]
247
+ include Aws::Structure
248
+ end
249
+
250
+ # Indicates that the claims are logically false and contradictory to the
251
+ # established rules or premises.
252
+ #
253
+ # @!attribute [rw] translation
254
+ # The logical translation of the input that this finding invalidates.
255
+ # @return [Types::AutomatedReasoningCheckTranslation]
256
+ #
257
+ # @!attribute [rw] contradicting_rules
258
+ # The automated reasoning policy rules that contradict the claims in
259
+ # the input.
260
+ # @return [Array<Types::AutomatedReasoningCheckRule>]
261
+ #
262
+ # @!attribute [rw] logic_warning
263
+ # Indication of a logic issue with the translation without needing to
264
+ # consider the automated reasoning policy rules.
265
+ # @return [Types::AutomatedReasoningCheckLogicWarning]
266
+ #
267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningCheckInvalidFinding AWS API Documentation
268
+ #
269
+ class AutomatedReasoningCheckInvalidFinding < Struct.new(
270
+ :translation,
271
+ :contradicting_rules,
272
+ :logic_warning)
273
+ SENSITIVE = []
274
+ include Aws::Structure
275
+ end
276
+
277
+ # Identifies logical issues in the translated statements that exist
278
+ # independent of any policy rules, such as statements that are always
279
+ # true or always false.
280
+ #
281
+ # @!attribute [rw] type
282
+ # The category of the detected logical issue, such as statements that
283
+ # are always true or always false.
284
+ # @return [String]
285
+ #
286
+ # @!attribute [rw] premises
287
+ # The logical statements that serve as premises under which the claims
288
+ # are validated.
289
+ # @return [Array<Types::AutomatedReasoningLogicStatement>]
290
+ #
291
+ # @!attribute [rw] claims
292
+ # The logical statements that are validated while assuming the policy
293
+ # and premises.
294
+ # @return [Array<Types::AutomatedReasoningLogicStatement>]
295
+ #
296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningCheckLogicWarning AWS API Documentation
297
+ #
298
+ class AutomatedReasoningCheckLogicWarning < Struct.new(
299
+ :type,
300
+ :premises,
301
+ :claims)
302
+ SENSITIVE = []
303
+ include Aws::Structure
304
+ end
305
+
306
+ # Indicates that no relevant logical information could be extracted from
307
+ # the input for validation.
308
+ #
309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningCheckNoTranslationsFinding AWS API Documentation
310
+ #
311
+ class AutomatedReasoningCheckNoTranslationsFinding < Aws::EmptyStructure; end
312
+
313
+ # References a specific automated reasoning policy rule that was applied
314
+ # during evaluation.
315
+ #
316
+ # @!attribute [rw] id
317
+ # The unique identifier of the automated reasoning rule.
318
+ # @return [String]
319
+ #
320
+ # @!attribute [rw] policy_version_arn
321
+ # The ARN of the automated reasoning policy version that contains this
322
+ # rule.
323
+ # @return [String]
324
+ #
325
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningCheckRule AWS API Documentation
326
+ #
327
+ class AutomatedReasoningCheckRule < Struct.new(
328
+ :id,
329
+ :policy_version_arn)
330
+ SENSITIVE = []
331
+ include Aws::Structure
332
+ end
333
+
334
+ # Indicates that the claims could be either true or false depending on
335
+ # additional assumptions not provided in the input.
336
+ #
337
+ # @!attribute [rw] translation
338
+ # The logical translation of the input that this finding evaluates.
339
+ # @return [Types::AutomatedReasoningCheckTranslation]
340
+ #
341
+ # @!attribute [rw] claims_true_scenario
342
+ # An example scenario demonstrating how the claims could be logically
343
+ # true.
344
+ # @return [Types::AutomatedReasoningCheckScenario]
345
+ #
346
+ # @!attribute [rw] claims_false_scenario
347
+ # An example scenario demonstrating how the claims could be logically
348
+ # false.
349
+ # @return [Types::AutomatedReasoningCheckScenario]
350
+ #
351
+ # @!attribute [rw] logic_warning
352
+ # Indication of a logic issue with the translation without needing to
353
+ # consider the automated reasoning policy rules.
354
+ # @return [Types::AutomatedReasoningCheckLogicWarning]
355
+ #
356
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningCheckSatisfiableFinding AWS API Documentation
357
+ #
358
+ class AutomatedReasoningCheckSatisfiableFinding < Struct.new(
359
+ :translation,
360
+ :claims_true_scenario,
361
+ :claims_false_scenario,
362
+ :logic_warning)
363
+ SENSITIVE = []
364
+ include Aws::Structure
365
+ end
366
+
367
+ # Represents a logical scenario where claims can be evaluated as true or
368
+ # false, containing specific logical assignments.
369
+ #
370
+ # @!attribute [rw] statements
371
+ # List of logical assignments and statements that define this
372
+ # scenario.
373
+ # @return [Array<Types::AutomatedReasoningLogicStatement>]
374
+ #
375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningCheckScenario AWS API Documentation
376
+ #
377
+ class AutomatedReasoningCheckScenario < Struct.new(
378
+ :statements)
379
+ SENSITIVE = []
380
+ include Aws::Structure
381
+ end
382
+
383
+ # Indicates that the input exceeds the processing capacity due to the
384
+ # volume or complexity of the logical information.
385
+ #
386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningCheckTooComplexFinding AWS API Documentation
387
+ #
388
+ class AutomatedReasoningCheckTooComplexFinding < Aws::EmptyStructure; end
389
+
390
+ # Contains the logical translation of natural language input into formal
391
+ # logical statements, including premises, claims, and confidence scores.
392
+ #
393
+ # @!attribute [rw] premises
394
+ # The logical statements that serve as the foundation or assumptions
395
+ # for the claims.
396
+ # @return [Array<Types::AutomatedReasoningLogicStatement>]
397
+ #
398
+ # @!attribute [rw] claims
399
+ # The logical statements that are being validated against the premises
400
+ # and policy rules.
401
+ # @return [Array<Types::AutomatedReasoningLogicStatement>]
402
+ #
403
+ # @!attribute [rw] untranslated_premises
404
+ # References to portions of the original input text that correspond to
405
+ # the premises but could not be fully translated.
406
+ # @return [Array<Types::AutomatedReasoningCheckInputTextReference>]
407
+ #
408
+ # @!attribute [rw] untranslated_claims
409
+ # References to portions of the original input text that correspond to
410
+ # the claims but could not be fully translated.
411
+ # @return [Array<Types::AutomatedReasoningCheckInputTextReference>]
412
+ #
413
+ # @!attribute [rw] confidence
414
+ # A confidence score between 0 and 1 indicating how certain the system
415
+ # is about the logical translation.
416
+ # @return [Float]
417
+ #
418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningCheckTranslation AWS API Documentation
419
+ #
420
+ class AutomatedReasoningCheckTranslation < Struct.new(
421
+ :premises,
422
+ :claims,
423
+ :untranslated_premises,
424
+ :untranslated_claims,
425
+ :confidence)
426
+ SENSITIVE = []
427
+ include Aws::Structure
428
+ end
429
+
430
+ # Indicates that the input has multiple valid logical interpretations,
431
+ # requiring additional context or clarification.
432
+ #
433
+ # @!attribute [rw] options
434
+ # Different logical interpretations that were detected during
435
+ # translation of the input.
436
+ # @return [Array<Types::AutomatedReasoningCheckTranslationOption>]
437
+ #
438
+ # @!attribute [rw] difference_scenarios
439
+ # Scenarios showing how the different translation options differ in
440
+ # meaning.
441
+ # @return [Array<Types::AutomatedReasoningCheckScenario>]
442
+ #
443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningCheckTranslationAmbiguousFinding AWS API Documentation
444
+ #
445
+ class AutomatedReasoningCheckTranslationAmbiguousFinding < Struct.new(
446
+ :options,
447
+ :difference_scenarios)
448
+ SENSITIVE = []
449
+ include Aws::Structure
450
+ end
451
+
452
+ # Represents one possible logical interpretation of ambiguous input
453
+ # content.
454
+ #
455
+ # @!attribute [rw] translations
456
+ # Different logical interpretations that were detected during
457
+ # translation of the input.
458
+ # @return [Array<Types::AutomatedReasoningCheckTranslation>]
459
+ #
460
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningCheckTranslationOption AWS API Documentation
461
+ #
462
+ class AutomatedReasoningCheckTranslationOption < Struct.new(
463
+ :translations)
464
+ SENSITIVE = []
465
+ include Aws::Structure
466
+ end
467
+
468
+ # Indicates that the claims are definitively true and logically implied
469
+ # by the premises, with no possible alternative interpretations.
470
+ #
471
+ # @!attribute [rw] translation
472
+ # The logical translation of the input that this finding validates.
473
+ # @return [Types::AutomatedReasoningCheckTranslation]
474
+ #
475
+ # @!attribute [rw] claims_true_scenario
476
+ # An example scenario demonstrating how the claims are logically true.
477
+ # @return [Types::AutomatedReasoningCheckScenario]
478
+ #
479
+ # @!attribute [rw] supporting_rules
480
+ # The automated reasoning policy rules that support why this result is
481
+ # considered valid.
482
+ # @return [Array<Types::AutomatedReasoningCheckRule>]
483
+ #
484
+ # @!attribute [rw] logic_warning
485
+ # Indication of a logic issue with the translation without needing to
486
+ # consider the automated reasoning policy rules.
487
+ # @return [Types::AutomatedReasoningCheckLogicWarning]
488
+ #
489
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningCheckValidFinding AWS API Documentation
490
+ #
491
+ class AutomatedReasoningCheckValidFinding < Struct.new(
492
+ :translation,
493
+ :claims_true_scenario,
494
+ :supporting_rules,
495
+ :logic_warning)
496
+ SENSITIVE = []
497
+ include Aws::Structure
498
+ end
499
+
500
+ # Represents a logical statement that can be expressed both in formal
501
+ # logic notation and natural language, providing dual representations
502
+ # for better understanding and validation.
503
+ #
504
+ # @!attribute [rw] logic
505
+ # The formal logic representation of the statement using mathematical
506
+ # notation and logical operators.
507
+ # @return [String]
508
+ #
509
+ # @!attribute [rw] natural_language
510
+ # The natural language representation of the logical statement,
511
+ # providing a human-readable interpretation of the formal logic.
512
+ # @return [String]
513
+ #
514
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningLogicStatement AWS API Documentation
515
+ #
516
+ class AutomatedReasoningLogicStatement < Struct.new(
517
+ :logic,
518
+ :natural_language)
519
+ SENSITIVE = [:logic, :natural_language]
520
+ include Aws::Structure
521
+ end
522
+
523
+ # An annotation for adding a new rule to an Automated Reasoning policy
524
+ # using a formal logical expression.
525
+ #
526
+ # @!attribute [rw] expression
527
+ # The formal logical expression that defines the rule, using
528
+ # mathematical notation and referencing policy variables and types.
529
+ # @return [String]
530
+ #
531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyAddRuleAnnotation AWS API Documentation
532
+ #
533
+ class AutomatedReasoningPolicyAddRuleAnnotation < Struct.new(
534
+ :expression)
535
+ SENSITIVE = [:expression]
536
+ include Aws::Structure
537
+ end
538
+
539
+ # An annotation for adding a new rule to the policy by converting a
540
+ # natural language description into a formal logical expression.
541
+ #
542
+ # @!attribute [rw] natural_language
543
+ # The natural language description of the rule that should be
544
+ # converted into a formal logical expression.
545
+ # @return [String]
546
+ #
547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation AWS API Documentation
548
+ #
549
+ class AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation < Struct.new(
550
+ :natural_language)
551
+ SENSITIVE = [:natural_language]
552
+ include Aws::Structure
553
+ end
554
+
555
+ # A mutation operation that adds a new rule to the policy definition
556
+ # during the build process.
557
+ #
558
+ # @!attribute [rw] rule
559
+ # The rule definition that specifies the formal logical expression and
560
+ # metadata for the new rule being added to the policy.
561
+ # @return [Types::AutomatedReasoningPolicyDefinitionRule]
562
+ #
563
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyAddRuleMutation AWS API Documentation
564
+ #
565
+ class AutomatedReasoningPolicyAddRuleMutation < Struct.new(
566
+ :rule)
567
+ SENSITIVE = []
568
+ include Aws::Structure
569
+ end
570
+
571
+ # An annotation for adding a new custom type to an Automated Reasoning
572
+ # policy, defining a set of possible values for variables.
573
+ #
574
+ # @!attribute [rw] name
575
+ # The name of the new custom type. This name will be used to reference
576
+ # the type in variable definitions and rules.
577
+ # @return [String]
578
+ #
579
+ # @!attribute [rw] description
580
+ # A description of what the custom type represents and how it should
581
+ # be used in the policy.
582
+ # @return [String]
583
+ #
584
+ # @!attribute [rw] values
585
+ # The list of possible values that variables of this type can take,
586
+ # each with its own description and identifier.
587
+ # @return [Array<Types::AutomatedReasoningPolicyDefinitionTypeValue>]
588
+ #
589
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyAddTypeAnnotation AWS API Documentation
590
+ #
591
+ class AutomatedReasoningPolicyAddTypeAnnotation < Struct.new(
592
+ :name,
593
+ :description,
594
+ :values)
595
+ SENSITIVE = [:name, :description]
596
+ include Aws::Structure
597
+ end
598
+
599
+ # A mutation operation that adds a new custom type to the policy
600
+ # definition during the build process.
601
+ #
602
+ # @!attribute [rw] type
603
+ # The type definition that specifies the name, description, and
604
+ # possible values for the new custom type being added to the policy.
605
+ # @return [Types::AutomatedReasoningPolicyDefinitionType]
606
+ #
607
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyAddTypeMutation AWS API Documentation
608
+ #
609
+ class AutomatedReasoningPolicyAddTypeMutation < Struct.new(
610
+ :type)
611
+ SENSITIVE = []
612
+ include Aws::Structure
613
+ end
614
+
615
+ # Represents a single value that can be added to an existing custom type
616
+ # in the policy.
617
+ #
618
+ # @!attribute [rw] value
619
+ # The identifier or name of the new value to add to the type.
620
+ # @return [String]
621
+ #
622
+ # @!attribute [rw] description
623
+ # A description of what this new type value represents and when it
624
+ # should be used.
625
+ # @return [String]
626
+ #
627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyAddTypeValue AWS API Documentation
628
+ #
629
+ class AutomatedReasoningPolicyAddTypeValue < Struct.new(
630
+ :value,
631
+ :description)
632
+ SENSITIVE = [:description]
633
+ include Aws::Structure
634
+ end
635
+
636
+ # An annotation for adding a new variable to an Automated Reasoning
637
+ # policy, which can be used in rule expressions.
638
+ #
639
+ # @!attribute [rw] name
640
+ # The name of the new variable. This name will be used to reference
641
+ # the variable in rule expressions.
642
+ # @return [String]
643
+ #
644
+ # @!attribute [rw] type
645
+ # The type of the variable, which can be a built-in type (like string
646
+ # or number) or a custom type defined in the policy.
647
+ # @return [String]
648
+ #
649
+ # @!attribute [rw] description
650
+ # A description of what the variable represents and how it should be
651
+ # used in rules.
652
+ # @return [String]
653
+ #
654
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyAddVariableAnnotation AWS API Documentation
655
+ #
656
+ class AutomatedReasoningPolicyAddVariableAnnotation < Struct.new(
657
+ :name,
658
+ :type,
659
+ :description)
660
+ SENSITIVE = [:name, :type, :description]
661
+ include Aws::Structure
662
+ end
663
+
664
+ # A mutation operation that adds a new variable to the policy definition
665
+ # during the build process.
666
+ #
667
+ # @!attribute [rw] variable
668
+ # The variable definition that specifies the name, type, and
669
+ # description for the new variable being added to the policy.
670
+ # @return [Types::AutomatedReasoningPolicyDefinitionVariable]
671
+ #
672
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyAddVariableMutation AWS API Documentation
673
+ #
674
+ class AutomatedReasoningPolicyAddVariableMutation < Struct.new(
675
+ :variable)
676
+ SENSITIVE = []
677
+ include Aws::Structure
678
+ end
679
+
680
+ # Contains the various operations that can be performed on an Automated
681
+ # Reasoning policy, including adding, updating, and deleting rules,
682
+ # variables, and types.
683
+ #
684
+ # @note AutomatedReasoningPolicyAnnotation is a union - when making an API calls you must set exactly one of the members.
685
+ #
686
+ # @note AutomatedReasoningPolicyAnnotation is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AutomatedReasoningPolicyAnnotation corresponding to the set member.
687
+ #
688
+ # @!attribute [rw] add_type
689
+ # An operation to add a new custom type to the policy, defining a set
690
+ # of possible values for policy variables.
691
+ # @return [Types::AutomatedReasoningPolicyAddTypeAnnotation]
692
+ #
693
+ # @!attribute [rw] update_type
694
+ # An operation to modify an existing custom type in the policy, such
695
+ # as changing its name, description, or allowed values.
696
+ # @return [Types::AutomatedReasoningPolicyUpdateTypeAnnotation]
697
+ #
698
+ # @!attribute [rw] delete_type
699
+ # An operation to remove a custom type from the policy. The type must
700
+ # not be referenced by any variables or rules.
701
+ # @return [Types::AutomatedReasoningPolicyDeleteTypeAnnotation]
702
+ #
703
+ # @!attribute [rw] add_variable
704
+ # An operation to add a new variable to the policy, which can be used
705
+ # in rule expressions to represent dynamic values.
706
+ # @return [Types::AutomatedReasoningPolicyAddVariableAnnotation]
707
+ #
708
+ # @!attribute [rw] update_variable
709
+ # An operation to modify an existing variable in the policy, such as
710
+ # changing its name, type, or description.
711
+ # @return [Types::AutomatedReasoningPolicyUpdateVariableAnnotation]
712
+ #
713
+ # @!attribute [rw] delete_variable
714
+ # An operation to remove a variable from the policy. The variable must
715
+ # not be referenced by any rules.
716
+ # @return [Types::AutomatedReasoningPolicyDeleteVariableAnnotation]
717
+ #
718
+ # @!attribute [rw] add_rule
719
+ # An operation to add a new logical rule to the policy using formal
720
+ # mathematical expressions.
721
+ # @return [Types::AutomatedReasoningPolicyAddRuleAnnotation]
722
+ #
723
+ # @!attribute [rw] update_rule
724
+ # An operation to modify an existing rule in the policy, such as
725
+ # changing its logical expression or conditions.
726
+ # @return [Types::AutomatedReasoningPolicyUpdateRuleAnnotation]
727
+ #
728
+ # @!attribute [rw] delete_rule
729
+ # An operation to remove a rule from the policy.
730
+ # @return [Types::AutomatedReasoningPolicyDeleteRuleAnnotation]
731
+ #
732
+ # @!attribute [rw] add_rule_from_natural_language
733
+ # An operation to add a new rule by converting natural language
734
+ # descriptions into formal logical expressions.
735
+ # @return [Types::AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation]
736
+ #
737
+ # @!attribute [rw] update_from_rules_feedback
738
+ # An operation to update the policy based on feedback about how
739
+ # specific rules performed during testing or validation.
740
+ # @return [Types::AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation]
741
+ #
742
+ # @!attribute [rw] update_from_scenario_feedback
743
+ # An operation to update the policy based on feedback about how it
744
+ # performed on specific test scenarios.
745
+ # @return [Types::AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation]
746
+ #
747
+ # @!attribute [rw] ingest_content
748
+ # An operation to process and incorporate new content into the policy,
749
+ # extracting additional rules and concepts.
750
+ # @return [Types::AutomatedReasoningPolicyIngestContentAnnotation]
751
+ #
752
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyAnnotation AWS API Documentation
753
+ #
754
+ class AutomatedReasoningPolicyAnnotation < Struct.new(
755
+ :add_type,
756
+ :update_type,
757
+ :delete_type,
758
+ :add_variable,
759
+ :update_variable,
760
+ :delete_variable,
761
+ :add_rule,
762
+ :update_rule,
763
+ :delete_rule,
764
+ :add_rule_from_natural_language,
765
+ :update_from_rules_feedback,
766
+ :update_from_scenario_feedback,
767
+ :ingest_content,
768
+ :unknown)
769
+ SENSITIVE = []
770
+ include Aws::Structure
771
+ include Aws::Structure::Union
772
+
773
+ class AddType < AutomatedReasoningPolicyAnnotation; end
774
+ class UpdateType < AutomatedReasoningPolicyAnnotation; end
775
+ class DeleteType < AutomatedReasoningPolicyAnnotation; end
776
+ class AddVariable < AutomatedReasoningPolicyAnnotation; end
777
+ class UpdateVariable < AutomatedReasoningPolicyAnnotation; end
778
+ class DeleteVariable < AutomatedReasoningPolicyAnnotation; end
779
+ class AddRule < AutomatedReasoningPolicyAnnotation; end
780
+ class UpdateRule < AutomatedReasoningPolicyAnnotation; end
781
+ class DeleteRule < AutomatedReasoningPolicyAnnotation; end
782
+ class AddRuleFromNaturalLanguage < AutomatedReasoningPolicyAnnotation; end
783
+ class UpdateFromRulesFeedback < AutomatedReasoningPolicyAnnotation; end
784
+ class UpdateFromScenarioFeedback < AutomatedReasoningPolicyAnnotation; end
785
+ class IngestContent < AutomatedReasoningPolicyAnnotation; end
786
+ class Unknown < AutomatedReasoningPolicyAnnotation; end
787
+ end
788
+
789
+ # Contains detailed logging information about the policy build process,
790
+ # including steps taken, decisions made, and any issues encountered.
791
+ #
792
+ # @!attribute [rw] entries
793
+ # A list of log entries documenting each step in the policy build
794
+ # process, including timestamps, status, and detailed messages.
795
+ # @return [Array<Types::AutomatedReasoningPolicyBuildLogEntry>]
796
+ #
797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyBuildLog AWS API Documentation
798
+ #
799
+ class AutomatedReasoningPolicyBuildLog < Struct.new(
800
+ :entries)
801
+ SENSITIVE = []
802
+ include Aws::Structure
803
+ end
804
+
805
+ # Represents a single entry in the policy build log, containing
806
+ # information about a specific step or event in the build process.
807
+ #
808
+ # @!attribute [rw] annotation
809
+ # The annotation or operation that was being processed when this log
810
+ # entry was created.
811
+ # @return [Types::AutomatedReasoningPolicyAnnotation]
812
+ #
813
+ # @!attribute [rw] status
814
+ # The status of the build step (e.g., SUCCESS, FAILED, IN\_PROGRESS).
815
+ # @return [String]
816
+ #
817
+ # @!attribute [rw] build_steps
818
+ # Detailed information about the specific build steps that were
819
+ # executed, including any sub-operations or transformations.
820
+ # @return [Array<Types::AutomatedReasoningPolicyBuildStep>]
821
+ #
822
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyBuildLogEntry AWS API Documentation
823
+ #
824
+ class AutomatedReasoningPolicyBuildLogEntry < Struct.new(
825
+ :annotation,
826
+ :status,
827
+ :build_steps)
828
+ SENSITIVE = []
829
+ include Aws::Structure
830
+ end
831
+
832
+ # Contains the various assets generated during a policy build workflow,
833
+ # including logs, quality reports, and the final policy definition.
834
+ #
835
+ # @note AutomatedReasoningPolicyBuildResultAssets is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AutomatedReasoningPolicyBuildResultAssets corresponding to the set member.
836
+ #
837
+ # @!attribute [rw] policy_definition
838
+ # The complete policy definition generated by the build workflow,
839
+ # containing all rules, variables, and custom types extracted from the
840
+ # source documents.
841
+ # @return [Types::AutomatedReasoningPolicyDefinition]
842
+ #
843
+ # @!attribute [rw] quality_report
844
+ # A comprehensive report analyzing the quality of the generated
845
+ # policy, including metrics about rule coverage, potential conflicts,
846
+ # and unused elements.
847
+ # @return [Types::AutomatedReasoningPolicyDefinitionQualityReport]
848
+ #
849
+ # @!attribute [rw] build_log
850
+ # The complete build log containing detailed information about each
851
+ # step in the policy generation process.
852
+ # @return [Types::AutomatedReasoningPolicyBuildLog]
853
+ #
854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyBuildResultAssets AWS API Documentation
855
+ #
856
+ class AutomatedReasoningPolicyBuildResultAssets < Struct.new(
857
+ :policy_definition,
858
+ :quality_report,
859
+ :build_log,
860
+ :unknown)
861
+ SENSITIVE = []
862
+ include Aws::Structure
863
+ include Aws::Structure::Union
864
+
865
+ class PolicyDefinition < AutomatedReasoningPolicyBuildResultAssets; end
866
+ class QualityReport < AutomatedReasoningPolicyBuildResultAssets; end
867
+ class BuildLog < AutomatedReasoningPolicyBuildResultAssets; end
868
+ class Unknown < AutomatedReasoningPolicyBuildResultAssets; end
869
+ end
870
+
871
+ # Represents a single step in the policy build process, containing
872
+ # context about what was being processed and any messages or results.
873
+ #
874
+ # @!attribute [rw] context
875
+ # Contextual information about what was being processed during this
876
+ # build step, such as the type of operation or the source material
877
+ # being analyzed.
878
+ # @return [Types::AutomatedReasoningPolicyBuildStepContext]
879
+ #
880
+ # @!attribute [rw] prior_element
881
+ # Reference to the previous element or step in the build process,
882
+ # helping to trace the sequence of operations.
883
+ # @return [Types::AutomatedReasoningPolicyDefinitionElement]
884
+ #
885
+ # @!attribute [rw] messages
886
+ # A list of messages generated during this build step, including
887
+ # informational messages, warnings, and error details.
888
+ # @return [Array<Types::AutomatedReasoningPolicyBuildStepMessage>]
889
+ #
890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyBuildStep AWS API Documentation
891
+ #
892
+ class AutomatedReasoningPolicyBuildStep < Struct.new(
893
+ :context,
894
+ :prior_element,
895
+ :messages)
896
+ SENSITIVE = []
897
+ include Aws::Structure
898
+ end
899
+
900
+ # Provides context about what type of operation was being performed
901
+ # during a build step.
902
+ #
903
+ # @note AutomatedReasoningPolicyBuildStepContext is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AutomatedReasoningPolicyBuildStepContext corresponding to the set member.
904
+ #
905
+ # @!attribute [rw] planning
906
+ # Indicates that this build step was part of the planning phase, where
907
+ # the system determines what operations to perform.
908
+ # @return [Types::AutomatedReasoningPolicyPlanning]
909
+ #
910
+ # @!attribute [rw] mutation
911
+ # Indicates that this build step involved modifying the policy
912
+ # structure, such as adding or updating rules, variables, or types.
913
+ # @return [Types::AutomatedReasoningPolicyMutation]
914
+ #
915
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyBuildStepContext AWS API Documentation
916
+ #
917
+ class AutomatedReasoningPolicyBuildStepContext < Struct.new(
918
+ :planning,
919
+ :mutation,
920
+ :unknown)
921
+ SENSITIVE = []
922
+ include Aws::Structure
923
+ include Aws::Structure::Union
924
+
925
+ class Planning < AutomatedReasoningPolicyBuildStepContext; end
926
+ class Mutation < AutomatedReasoningPolicyBuildStepContext; end
927
+ class Unknown < AutomatedReasoningPolicyBuildStepContext; end
928
+ end
929
+
930
+ # Represents a message generated during a build step, providing
931
+ # information about what happened or any issues encountered.
932
+ #
933
+ # @!attribute [rw] message
934
+ # The content of the message, describing what occurred during the
935
+ # build step.
936
+ # @return [String]
937
+ #
938
+ # @!attribute [rw] message_type
939
+ # The type of message (e.g., INFO, WARNING, ERROR) indicating its
940
+ # severity and purpose.
941
+ # @return [String]
942
+ #
943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyBuildStepMessage AWS API Documentation
944
+ #
945
+ class AutomatedReasoningPolicyBuildStepMessage < Struct.new(
946
+ :message,
947
+ :message_type)
948
+ SENSITIVE = []
949
+ include Aws::Structure
950
+ end
951
+
952
+ # Represents a source document used in the policy build workflow,
953
+ # containing the content and metadata needed for policy generation.
954
+ #
955
+ # @!attribute [rw] document
956
+ # The actual content of the source document that will be analyzed to
957
+ # extract policy rules and concepts.
958
+ # @return [String]
959
+ #
960
+ # @!attribute [rw] document_content_type
961
+ # The MIME type of the document content (e.g., text/plain,
962
+ # application/pdf, text/markdown).
963
+ # @return [String]
964
+ #
965
+ # @!attribute [rw] document_name
966
+ # A descriptive name for the document that helps identify its purpose
967
+ # and content.
968
+ # @return [String]
969
+ #
970
+ # @!attribute [rw] document_description
971
+ # A detailed description of the document's content and how it should
972
+ # be used in the policy generation process.
973
+ # @return [String]
974
+ #
975
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowDocument AWS API Documentation
976
+ #
977
+ class AutomatedReasoningPolicyBuildWorkflowDocument < Struct.new(
978
+ :document,
979
+ :document_content_type,
980
+ :document_name,
981
+ :document_description)
982
+ SENSITIVE = [:document_name, :document_description]
983
+ include Aws::Structure
984
+ end
985
+
986
+ # Contains content and instructions for repairing or improving an
987
+ # existing Automated Reasoning policy.
988
+ #
989
+ # @!attribute [rw] annotations
990
+ # Specific annotations or modifications to apply during the policy
991
+ # repair process, such as rule corrections or variable updates.
992
+ # @return [Array<Types::AutomatedReasoningPolicyAnnotation>]
993
+ #
994
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowRepairContent AWS API Documentation
995
+ #
996
+ class AutomatedReasoningPolicyBuildWorkflowRepairContent < Struct.new(
997
+ :annotations)
998
+ SENSITIVE = []
999
+ include Aws::Structure
1000
+ end
1001
+
1002
+ # Defines the source content for a policy build workflow, which can
1003
+ # include documents, repair instructions, or other input materials.
1004
+ #
1005
+ # @!attribute [rw] policy_definition
1006
+ # An existing policy definition that serves as the starting point for
1007
+ # the build workflow, typically used in policy repair or update
1008
+ # scenarios.
1009
+ # @return [Types::AutomatedReasoningPolicyDefinition]
1010
+ #
1011
+ # @!attribute [rw] workflow_content
1012
+ # The actual content to be processed in the build workflow, such as
1013
+ # documents to analyze or repair instructions to apply.
1014
+ # @return [Types::AutomatedReasoningPolicyWorkflowTypeContent]
1015
+ #
1016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowSource AWS API Documentation
1017
+ #
1018
+ class AutomatedReasoningPolicyBuildWorkflowSource < Struct.new(
1019
+ :policy_definition,
1020
+ :workflow_content)
1021
+ SENSITIVE = []
1022
+ include Aws::Structure
1023
+ end
1024
+
1025
+ # Provides a summary of a policy build workflow, including its current
1026
+ # status, timing information, and key identifiers.
1027
+ #
1028
+ # @!attribute [rw] policy_arn
1029
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy
1030
+ # associated with this build workflow.
1031
+ # @return [String]
1032
+ #
1033
+ # @!attribute [rw] build_workflow_id
1034
+ # The unique identifier of the build workflow.
1035
+ # @return [String]
1036
+ #
1037
+ # @!attribute [rw] status
1038
+ # The current status of the build workflow (e.g., RUNNING, COMPLETED,
1039
+ # FAILED, CANCELLED).
1040
+ # @return [String]
1041
+ #
1042
+ # @!attribute [rw] build_workflow_type
1043
+ # The type of build workflow (e.g., DOCUMENT\_INGESTION,
1044
+ # POLICY\_REPAIR).
1045
+ # @return [String]
1046
+ #
1047
+ # @!attribute [rw] created_at
1048
+ # The timestamp when the build workflow was created.
1049
+ # @return [Time]
1050
+ #
1051
+ # @!attribute [rw] updated_at
1052
+ # The timestamp when the build workflow was last updated.
1053
+ # @return [Time]
1054
+ #
1055
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowSummary AWS API Documentation
1056
+ #
1057
+ class AutomatedReasoningPolicyBuildWorkflowSummary < Struct.new(
1058
+ :policy_arn,
1059
+ :build_workflow_id,
1060
+ :status,
1061
+ :build_workflow_type,
1062
+ :created_at,
1063
+ :updated_at)
1064
+ SENSITIVE = []
1065
+ include Aws::Structure
1066
+ end
1067
+
1068
+ # Contains the formal logic rules, variables, and custom variable types
1069
+ # that define an Automated Reasoning policy. The policy definition
1070
+ # specifies the constraints used to validate foundation model responses
1071
+ # for accuracy and logical consistency.
1072
+ #
1073
+ # @!attribute [rw] version
1074
+ # The version of the policy definition format.
1075
+ # @return [String]
1076
+ #
1077
+ # @!attribute [rw] types
1078
+ # The custom user-defined vairable types used in the policy. Types are
1079
+ # enum-based variable types that provide additional context beyond the
1080
+ # predefined variable types.
1081
+ # @return [Array<Types::AutomatedReasoningPolicyDefinitionType>]
1082
+ #
1083
+ # @!attribute [rw] rules
1084
+ # The formal logic rules extracted from the source document. Rules
1085
+ # define the logical constraints that determine whether model
1086
+ # responses are valid, invalid, or satisfiable.
1087
+ # @return [Array<Types::AutomatedReasoningPolicyDefinitionRule>]
1088
+ #
1089
+ # @!attribute [rw] variables
1090
+ # The variables that represent concepts in the policy. Variables can
1091
+ # have values assigned when translating natural language into formal
1092
+ # logic. Their descriptions are crucial for accurate translation.
1093
+ # @return [Array<Types::AutomatedReasoningPolicyDefinitionVariable>]
1094
+ #
1095
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDefinition AWS API Documentation
1096
+ #
1097
+ class AutomatedReasoningPolicyDefinition < Struct.new(
1098
+ :version,
1099
+ :types,
1100
+ :rules,
1101
+ :variables)
1102
+ SENSITIVE = []
1103
+ include Aws::Structure
1104
+ end
1105
+
1106
+ # Represents a single element in an Automated Reasoning policy
1107
+ # definition, such as a rule, variable, or type definition.
1108
+ #
1109
+ # @note AutomatedReasoningPolicyDefinitionElement is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AutomatedReasoningPolicyDefinitionElement corresponding to the set member.
1110
+ #
1111
+ # @!attribute [rw] policy_definition_variable
1112
+ # A variable element within the policy definition that represents a
1113
+ # concept used in logical expressions and rules.
1114
+ # @return [Types::AutomatedReasoningPolicyDefinitionVariable]
1115
+ #
1116
+ # @!attribute [rw] policy_definition_type
1117
+ # A custom type element within the policy definition that defines a
1118
+ # set of possible values for variables.
1119
+ # @return [Types::AutomatedReasoningPolicyDefinitionType]
1120
+ #
1121
+ # @!attribute [rw] policy_definition_rule
1122
+ # A rule element within the policy definition that contains a formal
1123
+ # logical expression used for validation.
1124
+ # @return [Types::AutomatedReasoningPolicyDefinitionRule]
1125
+ #
1126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionElement AWS API Documentation
1127
+ #
1128
+ class AutomatedReasoningPolicyDefinitionElement < Struct.new(
1129
+ :policy_definition_variable,
1130
+ :policy_definition_type,
1131
+ :policy_definition_rule,
1132
+ :unknown)
1133
+ SENSITIVE = []
1134
+ include Aws::Structure
1135
+ include Aws::Structure::Union
1136
+
1137
+ class PolicyDefinitionVariable < AutomatedReasoningPolicyDefinitionElement; end
1138
+ class PolicyDefinitionType < AutomatedReasoningPolicyDefinitionElement; end
1139
+ class PolicyDefinitionRule < AutomatedReasoningPolicyDefinitionElement; end
1140
+ class Unknown < AutomatedReasoningPolicyDefinitionElement; end
1141
+ end
1142
+
1143
+ # Provides a comprehensive analysis of the quality and completeness of
1144
+ # an Automated Reasoning policy definition, highlighting potential
1145
+ # issues and optimization opportunities.
1146
+ #
1147
+ # @!attribute [rw] type_count
1148
+ # The total number of custom types defined in the policy.
1149
+ # @return [Integer]
1150
+ #
1151
+ # @!attribute [rw] variable_count
1152
+ # The total number of variables defined in the policy.
1153
+ # @return [Integer]
1154
+ #
1155
+ # @!attribute [rw] rule_count
1156
+ # The total number of rules defined in the policy.
1157
+ # @return [Integer]
1158
+ #
1159
+ # @!attribute [rw] unused_types
1160
+ # A list of custom types that are defined but not referenced by any
1161
+ # variables or rules, suggesting they may be unnecessary.
1162
+ # @return [Array<String>]
1163
+ #
1164
+ # @!attribute [rw] unused_type_values
1165
+ # A list of type values that are defined but never used in any rules,
1166
+ # indicating potential cleanup opportunities.
1167
+ # @return [Array<Types::AutomatedReasoningPolicyDefinitionTypeValuePair>]
1168
+ #
1169
+ # @!attribute [rw] unused_variables
1170
+ # A list of variables that are defined but not referenced by any
1171
+ # rules, suggesting they may be unnecessary.
1172
+ # @return [Array<String>]
1173
+ #
1174
+ # @!attribute [rw] conflicting_rules
1175
+ # A list of rules that may conflict with each other, potentially
1176
+ # leading to inconsistent policy behavior.
1177
+ # @return [Array<String>]
1178
+ #
1179
+ # @!attribute [rw] disjoint_rule_sets
1180
+ # Groups of rules that operate on completely separate sets of
1181
+ # variables, indicating the policy may be addressing multiple
1182
+ # unrelated concerns.
1183
+ # @return [Array<Types::AutomatedReasoningPolicyDisjointRuleSet>]
1184
+ #
1185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionQualityReport AWS API Documentation
1186
+ #
1187
+ class AutomatedReasoningPolicyDefinitionQualityReport < Struct.new(
1188
+ :type_count,
1189
+ :variable_count,
1190
+ :rule_count,
1191
+ :unused_types,
1192
+ :unused_type_values,
1193
+ :unused_variables,
1194
+ :conflicting_rules,
1195
+ :disjoint_rule_sets)
1196
+ SENSITIVE = [:unused_types, :unused_variables]
1197
+ include Aws::Structure
1198
+ end
1199
+
1200
+ # Represents a formal logic rule in an Automated Reasoning policy. For
1201
+ # example, rules can be expressed as if-then statements that define
1202
+ # logical constraints.
1203
+ #
1204
+ # @!attribute [rw] id
1205
+ # The unique identifier of the rule within the policy.
1206
+ # @return [String]
1207
+ #
1208
+ # @!attribute [rw] expression
1209
+ # The formal logic expression of the rule.
1210
+ # @return [String]
1211
+ #
1212
+ # @!attribute [rw] alternate_expression
1213
+ # The human-readable form of the rule expression, often in natural
1214
+ # language or simplified notation.
1215
+ # @return [String]
1216
+ #
1217
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionRule AWS API Documentation
1218
+ #
1219
+ class AutomatedReasoningPolicyDefinitionRule < Struct.new(
1220
+ :id,
1221
+ :expression,
1222
+ :alternate_expression)
1223
+ SENSITIVE = [:expression, :alternate_expression]
1224
+ include Aws::Structure
1225
+ end
1226
+
1227
+ # Represents a custom user-defined viarble type in an Automated
1228
+ # Reasoning policy. Types are enum-based and provide additional context
1229
+ # beyond predefined variable types.
1230
+ #
1231
+ # @!attribute [rw] name
1232
+ # The name of the custom type.
1233
+ # @return [String]
1234
+ #
1235
+ # @!attribute [rw] description
1236
+ # The description of what the custom type represents.
1237
+ # @return [String]
1238
+ #
1239
+ # @!attribute [rw] values
1240
+ # The possible values for this enum-based type, each with its own
1241
+ # description.
1242
+ # @return [Array<Types::AutomatedReasoningPolicyDefinitionTypeValue>]
1243
+ #
1244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionType AWS API Documentation
1245
+ #
1246
+ class AutomatedReasoningPolicyDefinitionType < Struct.new(
1247
+ :name,
1248
+ :description,
1249
+ :values)
1250
+ SENSITIVE = [:name, :description]
1251
+ include Aws::Structure
1252
+ end
1253
+
1254
+ # Represents a single value within a custom type definition, including
1255
+ # its identifier and description.
1256
+ #
1257
+ # @!attribute [rw] value
1258
+ # The actual value or identifier for this type value.
1259
+ # @return [String]
1260
+ #
1261
+ # @!attribute [rw] description
1262
+ # A human-readable description explaining what this type value
1263
+ # represents and when it should be used.
1264
+ # @return [String]
1265
+ #
1266
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionTypeValue AWS API Documentation
1267
+ #
1268
+ class AutomatedReasoningPolicyDefinitionTypeValue < Struct.new(
1269
+ :value,
1270
+ :description)
1271
+ SENSITIVE = [:description]
1272
+ include Aws::Structure
1273
+ end
1274
+
1275
+ # Associates a type name with a specific value name, used for
1276
+ # referencing type values in rules and other policy elements.
1277
+ #
1278
+ # @!attribute [rw] type_name
1279
+ # The name of the custom type that contains the referenced value.
1280
+ # @return [String]
1281
+ #
1282
+ # @!attribute [rw] value_name
1283
+ # The name of the specific value within the type.
1284
+ # @return [String]
1285
+ #
1286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionTypeValuePair AWS API Documentation
1287
+ #
1288
+ class AutomatedReasoningPolicyDefinitionTypeValuePair < Struct.new(
1289
+ :type_name,
1290
+ :value_name)
1291
+ SENSITIVE = [:type_name]
1292
+ include Aws::Structure
1293
+ end
1294
+
1295
+ # Represents a variable in an Automated Reasoning policy. Variables
1296
+ # represent concepts that can have values assigned during natural
1297
+ # language translation.
1298
+ #
1299
+ # @!attribute [rw] name
1300
+ # The name of the variable. Use descriptive names that clearly
1301
+ # indicate the concept being represented.
1302
+ # @return [String]
1303
+ #
1304
+ # @!attribute [rw] type
1305
+ # The data type of the variable. Valid types include bool, int, real,
1306
+ # enum, and custom types that you can provide.
1307
+ # @return [String]
1308
+ #
1309
+ # @!attribute [rw] description
1310
+ # The description of the variable that explains what it represents and
1311
+ # how users might refer to it. Clear and comprehensive descriptions
1312
+ # are essential for accurate natural language translation.
1313
+ # @return [String]
1314
+ #
1315
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionVariable AWS API Documentation
1316
+ #
1317
+ class AutomatedReasoningPolicyDefinitionVariable < Struct.new(
1318
+ :name,
1319
+ :type,
1320
+ :description)
1321
+ SENSITIVE = [:name, :type, :description]
1322
+ include Aws::Structure
1323
+ end
1324
+
1325
+ # An annotation for removing a rule from an Automated Reasoning policy.
1326
+ #
1327
+ # @!attribute [rw] rule_id
1328
+ # The unique identifier of the rule to delete from the policy.
1329
+ # @return [String]
1330
+ #
1331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteRuleAnnotation AWS API Documentation
1332
+ #
1333
+ class AutomatedReasoningPolicyDeleteRuleAnnotation < Struct.new(
1334
+ :rule_id)
1335
+ SENSITIVE = []
1336
+ include Aws::Structure
1337
+ end
1338
+
1339
+ # A mutation operation that removes a rule from the policy definition
1340
+ # during the build process.
1341
+ #
1342
+ # @!attribute [rw] id
1343
+ # The unique identifier of the rule to delete.
1344
+ # @return [String]
1345
+ #
1346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteRuleMutation AWS API Documentation
1347
+ #
1348
+ class AutomatedReasoningPolicyDeleteRuleMutation < Struct.new(
1349
+ :id)
1350
+ SENSITIVE = []
1351
+ include Aws::Structure
1352
+ end
1353
+
1354
+ # An annotation for removing a custom type from an Automated Reasoning
1355
+ # policy.
1356
+ #
1357
+ # @!attribute [rw] name
1358
+ # The name of the custom type to delete from the policy. The type must
1359
+ # not be referenced by any variables or rules.
1360
+ # @return [String]
1361
+ #
1362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteTypeAnnotation AWS API Documentation
1363
+ #
1364
+ class AutomatedReasoningPolicyDeleteTypeAnnotation < Struct.new(
1365
+ :name)
1366
+ SENSITIVE = [:name]
1367
+ include Aws::Structure
1368
+ end
1369
+
1370
+ # A mutation operation that removes a custom type from the policy
1371
+ # definition during the build process.
1372
+ #
1373
+ # @!attribute [rw] name
1374
+ # The name of the custom type to delete.
1375
+ # @return [String]
1376
+ #
1377
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteTypeMutation AWS API Documentation
1378
+ #
1379
+ class AutomatedReasoningPolicyDeleteTypeMutation < Struct.new(
1380
+ :name)
1381
+ SENSITIVE = [:name]
1382
+ include Aws::Structure
1383
+ end
1384
+
1385
+ # Represents a value to be removed from an existing custom type in the
1386
+ # policy.
1387
+ #
1388
+ # @!attribute [rw] value
1389
+ # The identifier or name of the value to remove from the type.
1390
+ # @return [String]
1391
+ #
1392
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteTypeValue AWS API Documentation
1393
+ #
1394
+ class AutomatedReasoningPolicyDeleteTypeValue < Struct.new(
1395
+ :value)
1396
+ SENSITIVE = []
1397
+ include Aws::Structure
1398
+ end
1399
+
1400
+ # An annotation for removing a variable from an Automated Reasoning
1401
+ # policy.
1402
+ #
1403
+ # @!attribute [rw] name
1404
+ # The name of the variable to delete from the policy. The variable
1405
+ # must not be referenced by any rules.
1406
+ # @return [String]
1407
+ #
1408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteVariableAnnotation AWS API Documentation
1409
+ #
1410
+ class AutomatedReasoningPolicyDeleteVariableAnnotation < Struct.new(
1411
+ :name)
1412
+ SENSITIVE = [:name]
1413
+ include Aws::Structure
1414
+ end
1415
+
1416
+ # A mutation operation that removes a variable from the policy
1417
+ # definition during the build process.
1418
+ #
1419
+ # @!attribute [rw] name
1420
+ # The name of the variable to delete.
1421
+ # @return [String]
1422
+ #
1423
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteVariableMutation AWS API Documentation
1424
+ #
1425
+ class AutomatedReasoningPolicyDeleteVariableMutation < Struct.new(
1426
+ :name)
1427
+ SENSITIVE = [:name]
1428
+ include Aws::Structure
1429
+ end
1430
+
1431
+ # Represents a set of rules that operate on completely separate
1432
+ # variables, indicating they address different concerns or domains
1433
+ # within the policy.
1434
+ #
1435
+ # @!attribute [rw] variables
1436
+ # The set of variables that are used by the rules in this disjoint
1437
+ # set.
1438
+ # @return [Array<String>]
1439
+ #
1440
+ # @!attribute [rw] rules
1441
+ # The list of rules that form this disjoint set, all operating on the
1442
+ # same set of variables.
1443
+ # @return [Array<String>]
1444
+ #
1445
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyDisjointRuleSet AWS API Documentation
1446
+ #
1447
+ class AutomatedReasoningPolicyDisjointRuleSet < Struct.new(
1448
+ :variables,
1449
+ :rules)
1450
+ SENSITIVE = [:variables]
1451
+ include Aws::Structure
1452
+ end
1453
+
1454
+ # An annotation for processing and incorporating new content into an
1455
+ # Automated Reasoning policy.
1456
+ #
1457
+ # @!attribute [rw] content
1458
+ # The new content to be analyzed and incorporated into the policy,
1459
+ # such as additional documents or rule descriptions.
1460
+ # @return [String]
1461
+ #
1462
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyIngestContentAnnotation AWS API Documentation
1463
+ #
1464
+ class AutomatedReasoningPolicyIngestContentAnnotation < Struct.new(
1465
+ :content)
1466
+ SENSITIVE = [:content]
1467
+ include Aws::Structure
1468
+ end
1469
+
1470
+ # A container for various mutation operations that can be applied to an
1471
+ # Automated Reasoning policy, including adding, updating, and deleting
1472
+ # policy elements.
1473
+ #
1474
+ # @note AutomatedReasoningPolicyMutation is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AutomatedReasoningPolicyMutation corresponding to the set member.
1475
+ #
1476
+ # @!attribute [rw] add_type
1477
+ # A mutation to add a new custom type to the policy.
1478
+ # @return [Types::AutomatedReasoningPolicyAddTypeMutation]
1479
+ #
1480
+ # @!attribute [rw] update_type
1481
+ # A mutation to modify an existing custom type in the policy.
1482
+ # @return [Types::AutomatedReasoningPolicyUpdateTypeMutation]
1483
+ #
1484
+ # @!attribute [rw] delete_type
1485
+ # A mutation to remove a custom type from the policy.
1486
+ # @return [Types::AutomatedReasoningPolicyDeleteTypeMutation]
1487
+ #
1488
+ # @!attribute [rw] add_variable
1489
+ # A mutation to add a new variable to the policy.
1490
+ # @return [Types::AutomatedReasoningPolicyAddVariableMutation]
1491
+ #
1492
+ # @!attribute [rw] update_variable
1493
+ # A mutation to modify an existing variable in the policy.
1494
+ # @return [Types::AutomatedReasoningPolicyUpdateVariableMutation]
1495
+ #
1496
+ # @!attribute [rw] delete_variable
1497
+ # A mutation to remove a variable from the policy.
1498
+ # @return [Types::AutomatedReasoningPolicyDeleteVariableMutation]
1499
+ #
1500
+ # @!attribute [rw] add_rule
1501
+ # A mutation to add a new rule to the policy.
1502
+ # @return [Types::AutomatedReasoningPolicyAddRuleMutation]
1503
+ #
1504
+ # @!attribute [rw] update_rule
1505
+ # A mutation to modify an existing rule in the policy.
1506
+ # @return [Types::AutomatedReasoningPolicyUpdateRuleMutation]
1507
+ #
1508
+ # @!attribute [rw] delete_rule
1509
+ # A mutation to remove a rule from the policy.
1510
+ # @return [Types::AutomatedReasoningPolicyDeleteRuleMutation]
1511
+ #
1512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyMutation AWS API Documentation
1513
+ #
1514
+ class AutomatedReasoningPolicyMutation < Struct.new(
1515
+ :add_type,
1516
+ :update_type,
1517
+ :delete_type,
1518
+ :add_variable,
1519
+ :update_variable,
1520
+ :delete_variable,
1521
+ :add_rule,
1522
+ :update_rule,
1523
+ :delete_rule,
1524
+ :unknown)
1525
+ SENSITIVE = []
1526
+ include Aws::Structure
1527
+ include Aws::Structure::Union
1528
+
1529
+ class AddType < AutomatedReasoningPolicyMutation; end
1530
+ class UpdateType < AutomatedReasoningPolicyMutation; end
1531
+ class DeleteType < AutomatedReasoningPolicyMutation; end
1532
+ class AddVariable < AutomatedReasoningPolicyMutation; end
1533
+ class UpdateVariable < AutomatedReasoningPolicyMutation; end
1534
+ class DeleteVariable < AutomatedReasoningPolicyMutation; end
1535
+ class AddRule < AutomatedReasoningPolicyMutation; end
1536
+ class UpdateRule < AutomatedReasoningPolicyMutation; end
1537
+ class DeleteRule < AutomatedReasoningPolicyMutation; end
1538
+ class Unknown < AutomatedReasoningPolicyMutation; end
1539
+ end
1540
+
1541
+ # Represents the planning phase of policy build workflow, where the
1542
+ # system analyzes source content and determines what operations to
1543
+ # perform.
1544
+ #
1545
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyPlanning AWS API Documentation
1546
+ #
1547
+ class AutomatedReasoningPolicyPlanning < Aws::EmptyStructure; end
1548
+
1549
+ # Represents a test scenario used to validate an Automated Reasoning
1550
+ # policy, including the test conditions and expected outcomes.
1551
+ #
1552
+ # @!attribute [rw] expression
1553
+ # The logical expression or condition that defines this test scenario.
1554
+ # @return [String]
1555
+ #
1556
+ # @!attribute [rw] alternate_expression
1557
+ # An alternative way to express the same test scenario, used for
1558
+ # validation and comparison purposes.
1559
+ # @return [String]
1560
+ #
1561
+ # @!attribute [rw] rule_ids
1562
+ # The list of rule identifiers that are expected to be triggered or
1563
+ # evaluated by this test scenario.
1564
+ # @return [Array<String>]
1565
+ #
1566
+ # @!attribute [rw] expected_result
1567
+ # The expected outcome when this scenario is evaluated against the
1568
+ # policy (e.g., PASS, FAIL, VIOLATION).
1569
+ # @return [String]
1570
+ #
1571
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyScenario AWS API Documentation
1572
+ #
1573
+ class AutomatedReasoningPolicyScenario < Struct.new(
1574
+ :expression,
1575
+ :alternate_expression,
1576
+ :rule_ids,
1577
+ :expected_result)
1578
+ SENSITIVE = [:expression, :alternate_expression]
1579
+ include Aws::Structure
1580
+ end
1581
+
1582
+ # Contains summary information about an Automated Reasoning policy,
1583
+ # including metadata and timestamps.
1584
+ #
1585
+ # @!attribute [rw] policy_arn
1586
+ # The Amazon Resource Name (ARN) of the policy.
1587
+ # @return [String]
1588
+ #
1589
+ # @!attribute [rw] name
1590
+ # The name of the policy.
1591
+ # @return [String]
1592
+ #
1593
+ # @!attribute [rw] description
1594
+ # The description of the policy.
1595
+ # @return [String]
1596
+ #
1597
+ # @!attribute [rw] version
1598
+ # The version of the policy.
1599
+ # @return [String]
1600
+ #
1601
+ # @!attribute [rw] policy_id
1602
+ # The unique identifier of the policy.
1603
+ # @return [String]
1604
+ #
1605
+ # @!attribute [rw] created_at
1606
+ # The timestamp when the policy was created.
1607
+ # @return [Time]
1608
+ #
1609
+ # @!attribute [rw] updated_at
1610
+ # The timestamp when the policy was last updated.
1611
+ # @return [Time]
1612
+ #
1613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicySummary AWS API Documentation
1614
+ #
1615
+ class AutomatedReasoningPolicySummary < Struct.new(
1616
+ :policy_arn,
1617
+ :name,
1618
+ :description,
1619
+ :version,
1620
+ :policy_id,
1621
+ :created_at,
1622
+ :updated_at)
1623
+ SENSITIVE = [:name, :description]
1624
+ include Aws::Structure
1625
+ end
1626
+
1627
+ # Represents a test for validating an Automated Reasoning policy. tests
1628
+ # contain sample inputs and expected outcomes to verify policy behavior.
1629
+ #
1630
+ # @!attribute [rw] test_case_id
1631
+ # The unique identifier of the test.
1632
+ # @return [String]
1633
+ #
1634
+ # @!attribute [rw] guard_content
1635
+ # The output content to be validated by the policy, typically
1636
+ # representing a foundation model response.
1637
+ # @return [String]
1638
+ #
1639
+ # @!attribute [rw] query_content
1640
+ # The input query or prompt that generated the content. This provides
1641
+ # context for the validation.
1642
+ # @return [String]
1643
+ #
1644
+ # @!attribute [rw] expected_aggregated_findings_result
1645
+ # The expected result of the Automated Reasoning check for this test.
1646
+ # @return [String]
1647
+ #
1648
+ # @!attribute [rw] created_at
1649
+ # The timestamp when the test was created.
1650
+ # @return [Time]
1651
+ #
1652
+ # @!attribute [rw] updated_at
1653
+ # The timestamp when the test was last updated.
1654
+ # @return [Time]
1655
+ #
1656
+ # @!attribute [rw] confidence_threshold
1657
+ # The minimum confidence level for logic validation. Content meeting
1658
+ # this threshold is considered high-confidence and can be validated.
1659
+ # @return [Float]
1660
+ #
1661
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyTestCase AWS API Documentation
1662
+ #
1663
+ class AutomatedReasoningPolicyTestCase < Struct.new(
1664
+ :test_case_id,
1665
+ :guard_content,
1666
+ :query_content,
1667
+ :expected_aggregated_findings_result,
1668
+ :created_at,
1669
+ :updated_at,
1670
+ :confidence_threshold)
1671
+ SENSITIVE = [:guard_content, :query_content]
1672
+ include Aws::Structure
1673
+ end
1674
+
1675
+ # Contains the results of testing an Automated Reasoning policy against
1676
+ # various scenarios and validation checks.
1677
+ #
1678
+ # @!attribute [rw] test_case
1679
+ # The test case that was executed, including the input content,
1680
+ # expected results, and configuration parameters used during
1681
+ # validation.
1682
+ # @return [Types::AutomatedReasoningPolicyTestCase]
1683
+ #
1684
+ # @!attribute [rw] policy_arn
1685
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy
1686
+ # that was tested.
1687
+ # @return [String]
1688
+ #
1689
+ # @!attribute [rw] test_run_status
1690
+ # The overall status of the test run (e.g., COMPLETED, FAILED,
1691
+ # IN\_PROGRESS).
1692
+ # @return [String]
1693
+ #
1694
+ # @!attribute [rw] test_findings
1695
+ # Detailed findings from the test run, including any issues,
1696
+ # violations, or unexpected behaviors discovered.
1697
+ # @return [Array<Types::AutomatedReasoningCheckFinding>]
1698
+ #
1699
+ # @!attribute [rw] test_run_result
1700
+ # The overall result of the test run, indicating whether the policy
1701
+ # passed or failed validation.
1702
+ # @return [String]
1703
+ #
1704
+ # @!attribute [rw] aggregated_test_findings_result
1705
+ # A summary of all test findings, aggregated to provide an overall
1706
+ # assessment of policy quality and correctness.
1707
+ # @return [String]
1708
+ #
1709
+ # @!attribute [rw] updated_at
1710
+ # The timestamp when the test results were last updated.
1711
+ # @return [Time]
1712
+ #
1713
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyTestResult AWS API Documentation
1714
+ #
1715
+ class AutomatedReasoningPolicyTestResult < Struct.new(
1716
+ :test_case,
1717
+ :policy_arn,
1718
+ :test_run_status,
1719
+ :test_findings,
1720
+ :test_run_result,
1721
+ :aggregated_test_findings_result,
1722
+ :updated_at)
1723
+ SENSITIVE = []
1724
+ include Aws::Structure
1725
+ end
1726
+
1727
+ # An annotation for managing values within custom types, including
1728
+ # adding, updating, or removing specific type values.
1729
+ #
1730
+ # @note AutomatedReasoningPolicyTypeValueAnnotation is a union - when making an API calls you must set exactly one of the members.
1731
+ #
1732
+ # @note AutomatedReasoningPolicyTypeValueAnnotation is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AutomatedReasoningPolicyTypeValueAnnotation corresponding to the set member.
1733
+ #
1734
+ # @!attribute [rw] add_type_value
1735
+ # An operation to add a new value to an existing custom type.
1736
+ # @return [Types::AutomatedReasoningPolicyAddTypeValue]
1737
+ #
1738
+ # @!attribute [rw] update_type_value
1739
+ # An operation to modify an existing value within a custom type.
1740
+ # @return [Types::AutomatedReasoningPolicyUpdateTypeValue]
1741
+ #
1742
+ # @!attribute [rw] delete_type_value
1743
+ # An operation to remove a value from an existing custom type.
1744
+ # @return [Types::AutomatedReasoningPolicyDeleteTypeValue]
1745
+ #
1746
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyTypeValueAnnotation AWS API Documentation
1747
+ #
1748
+ class AutomatedReasoningPolicyTypeValueAnnotation < Struct.new(
1749
+ :add_type_value,
1750
+ :update_type_value,
1751
+ :delete_type_value,
1752
+ :unknown)
1753
+ SENSITIVE = []
1754
+ include Aws::Structure
1755
+ include Aws::Structure::Union
1756
+
1757
+ class AddTypeValue < AutomatedReasoningPolicyTypeValueAnnotation; end
1758
+ class UpdateTypeValue < AutomatedReasoningPolicyTypeValueAnnotation; end
1759
+ class DeleteTypeValue < AutomatedReasoningPolicyTypeValueAnnotation; end
1760
+ class Unknown < AutomatedReasoningPolicyTypeValueAnnotation; end
1761
+ end
1762
+
1763
+ # An annotation for updating the policy based on feedback about how
1764
+ # specific rules performed during testing or real-world usage.
1765
+ #
1766
+ # @!attribute [rw] rule_ids
1767
+ # The list of rule identifiers that the feedback applies to.
1768
+ # @return [Array<String>]
1769
+ #
1770
+ # @!attribute [rw] feedback
1771
+ # The feedback information about rule performance, including
1772
+ # suggestions for improvements or corrections.
1773
+ # @return [String]
1774
+ #
1775
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation AWS API Documentation
1776
+ #
1777
+ class AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation < Struct.new(
1778
+ :rule_ids,
1779
+ :feedback)
1780
+ SENSITIVE = [:feedback]
1781
+ include Aws::Structure
1782
+ end
1783
+
1784
+ # An annotation for updating the policy based on feedback about how it
1785
+ # performed on specific test scenarios.
1786
+ #
1787
+ # @!attribute [rw] rule_ids
1788
+ # The list of rule identifiers that were involved in the scenario
1789
+ # being evaluated.
1790
+ # @return [Array<String>]
1791
+ #
1792
+ # @!attribute [rw] scenario_expression
1793
+ # The logical expression that defines the test scenario that generated
1794
+ # this feedback.
1795
+ # @return [String]
1796
+ #
1797
+ # @!attribute [rw] feedback
1798
+ # The feedback information about scenario performance, including any
1799
+ # issues or improvements identified.
1800
+ # @return [String]
1801
+ #
1802
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation AWS API Documentation
1803
+ #
1804
+ class AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation < Struct.new(
1805
+ :rule_ids,
1806
+ :scenario_expression,
1807
+ :feedback)
1808
+ SENSITIVE = [:scenario_expression, :feedback]
1809
+ include Aws::Structure
1810
+ end
1811
+
1812
+ # An annotation for modifying an existing rule in an Automated Reasoning
1813
+ # policy.
1814
+ #
1815
+ # @!attribute [rw] rule_id
1816
+ # The unique identifier of the rule to update.
1817
+ # @return [String]
1818
+ #
1819
+ # @!attribute [rw] expression
1820
+ # The new formal logical expression for the rule, replacing the
1821
+ # previous expression.
1822
+ # @return [String]
1823
+ #
1824
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateRuleAnnotation AWS API Documentation
1825
+ #
1826
+ class AutomatedReasoningPolicyUpdateRuleAnnotation < Struct.new(
1827
+ :rule_id,
1828
+ :expression)
1829
+ SENSITIVE = [:expression]
1830
+ include Aws::Structure
1831
+ end
1832
+
1833
+ # A mutation operation that modifies an existing rule in the policy
1834
+ # definition during the build process.
1835
+ #
1836
+ # @!attribute [rw] rule
1837
+ # The updated rule definition containing the modified formal logical
1838
+ # expression and any changed metadata for the existing rule.
1839
+ # @return [Types::AutomatedReasoningPolicyDefinitionRule]
1840
+ #
1841
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateRuleMutation AWS API Documentation
1842
+ #
1843
+ class AutomatedReasoningPolicyUpdateRuleMutation < Struct.new(
1844
+ :rule)
1845
+ SENSITIVE = []
1846
+ include Aws::Structure
1847
+ end
1848
+
1849
+ # An annotation for modifying an existing custom type in an Automated
1850
+ # Reasoning policy.
1851
+ #
1852
+ # @!attribute [rw] name
1853
+ # The current name of the custom type to update.
1854
+ # @return [String]
1855
+ #
1856
+ # @!attribute [rw] new_name
1857
+ # The new name for the custom type, if you want to rename it. If not
1858
+ # provided, the name remains unchanged.
1859
+ # @return [String]
1860
+ #
1861
+ # @!attribute [rw] description
1862
+ # The new description for the custom type, replacing the previous
1863
+ # description.
1864
+ # @return [String]
1865
+ #
1866
+ # @!attribute [rw] values
1867
+ # The updated list of values for the custom type, which can include
1868
+ # additions, modifications, or removals.
1869
+ # @return [Array<Types::AutomatedReasoningPolicyTypeValueAnnotation>]
1870
+ #
1871
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateTypeAnnotation AWS API Documentation
1872
+ #
1873
+ class AutomatedReasoningPolicyUpdateTypeAnnotation < Struct.new(
1874
+ :name,
1875
+ :new_name,
1876
+ :description,
1877
+ :values)
1878
+ SENSITIVE = [:name, :new_name, :description]
1879
+ include Aws::Structure
1880
+ end
1881
+
1882
+ # A mutation operation that modifies an existing custom type in the
1883
+ # policy definition during the build process.
1884
+ #
1885
+ # @!attribute [rw] type
1886
+ # The updated type definition containing the modified name,
1887
+ # description, or values for the existing custom type.
1888
+ # @return [Types::AutomatedReasoningPolicyDefinitionType]
1889
+ #
1890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateTypeMutation AWS API Documentation
1891
+ #
1892
+ class AutomatedReasoningPolicyUpdateTypeMutation < Struct.new(
1893
+ :type)
1894
+ SENSITIVE = []
1895
+ include Aws::Structure
1896
+ end
1897
+
1898
+ # Represents a modification to a value within an existing custom type.
1899
+ #
1900
+ # @!attribute [rw] value
1901
+ # The current identifier or name of the type value to update.
1902
+ # @return [String]
1903
+ #
1904
+ # @!attribute [rw] new_value
1905
+ # The new identifier or name for the type value, if you want to rename
1906
+ # it.
1907
+ # @return [String]
1908
+ #
1909
+ # @!attribute [rw] description
1910
+ # The new description for the type value, replacing the previous
1911
+ # description.
1912
+ # @return [String]
1913
+ #
1914
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateTypeValue AWS API Documentation
1915
+ #
1916
+ class AutomatedReasoningPolicyUpdateTypeValue < Struct.new(
1917
+ :value,
1918
+ :new_value,
1919
+ :description)
1920
+ SENSITIVE = [:description]
1921
+ include Aws::Structure
1922
+ end
1923
+
1924
+ # An annotation for modifying an existing variable in an Automated
1925
+ # Reasoning policy.
1926
+ #
1927
+ # @!attribute [rw] name
1928
+ # The current name of the variable to update.
1929
+ # @return [String]
1930
+ #
1931
+ # @!attribute [rw] new_name
1932
+ # The new name for the variable, if you want to rename it. If not
1933
+ # provided, the name remains unchanged.
1934
+ # @return [String]
1935
+ #
1936
+ # @!attribute [rw] description
1937
+ # The new description for the variable, replacing the previous
1938
+ # description.
1939
+ # @return [String]
1940
+ #
1941
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateVariableAnnotation AWS API Documentation
1942
+ #
1943
+ class AutomatedReasoningPolicyUpdateVariableAnnotation < Struct.new(
1944
+ :name,
1945
+ :new_name,
1946
+ :description)
1947
+ SENSITIVE = [:name, :new_name, :description]
1948
+ include Aws::Structure
1949
+ end
1950
+
1951
+ # A mutation operation that modifies an existing variable in the policy
1952
+ # definition during the build process.
1953
+ #
1954
+ # @!attribute [rw] variable
1955
+ # The updated variable definition containing the modified name, type,
1956
+ # or description for the existing variable.
1957
+ # @return [Types::AutomatedReasoningPolicyDefinitionVariable]
1958
+ #
1959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateVariableMutation AWS API Documentation
1960
+ #
1961
+ class AutomatedReasoningPolicyUpdateVariableMutation < Struct.new(
1962
+ :variable)
1963
+ SENSITIVE = []
1964
+ include Aws::Structure
1965
+ end
1966
+
1967
+ # Defines the content and configuration for different types of policy
1968
+ # build workflows.
1969
+ #
1970
+ # @note AutomatedReasoningPolicyWorkflowTypeContent is a union - when making an API calls you must set exactly one of the members.
1971
+ #
1972
+ # @!attribute [rw] documents
1973
+ # The list of documents to be processed in a document ingestion
1974
+ # workflow.
1975
+ # @return [Array<Types::AutomatedReasoningPolicyBuildWorkflowDocument>]
1976
+ #
1977
+ # @!attribute [rw] policy_repair_assets
1978
+ # The assets and instructions needed for a policy repair workflow,
1979
+ # including repair annotations and guidance.
1980
+ # @return [Types::AutomatedReasoningPolicyBuildWorkflowRepairContent]
1981
+ #
1982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedReasoningPolicyWorkflowTypeContent AWS API Documentation
1983
+ #
1984
+ class AutomatedReasoningPolicyWorkflowTypeContent < Struct.new(
1985
+ :documents,
1986
+ :policy_repair_assets,
1987
+ :unknown)
1988
+ SENSITIVE = []
1989
+ include Aws::Structure
1990
+ include Aws::Structure::Union
1991
+
1992
+ class Documents < AutomatedReasoningPolicyWorkflowTypeContent; end
1993
+ class PolicyRepairAssets < AutomatedReasoningPolicyWorkflowTypeContent; end
1994
+ class Unknown < AutomatedReasoningPolicyWorkflowTypeContent; end
1995
+ end
1996
+
131
1997
  # A JSON array that provides the status of the evaluation jobs being
132
1998
  # deleted.
133
1999
  #
@@ -246,6 +2112,30 @@ module Aws::Bedrock
246
2112
  include Aws::Structure
247
2113
  end
248
2114
 
2115
+ # @!attribute [rw] policy_arn
2116
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy
2117
+ # whose build workflow you want to cancel.
2118
+ # @return [String]
2119
+ #
2120
+ # @!attribute [rw] build_workflow_id
2121
+ # The unique identifier of the build workflow to cancel. You can get
2122
+ # this ID from the StartAutomatedReasoningPolicyBuildWorkflow response
2123
+ # or by listing build workflows.
2124
+ # @return [String]
2125
+ #
2126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflowRequest AWS API Documentation
2127
+ #
2128
+ class CancelAutomatedReasoningPolicyBuildWorkflowRequest < Struct.new(
2129
+ :policy_arn,
2130
+ :build_workflow_id)
2131
+ SENSITIVE = []
2132
+ include Aws::Structure
2133
+ end
2134
+
2135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflowResponse AWS API Documentation
2136
+ #
2137
+ class CancelAutomatedReasoningPolicyBuildWorkflowResponse < Aws::EmptyStructure; end
2138
+
249
2139
  # CloudWatch logging configuration.
250
2140
  #
251
2141
  # @!attribute [rw] log_group_name
@@ -283,6 +2173,277 @@ module Aws::Bedrock
283
2173
  include Aws::Structure
284
2174
  end
285
2175
 
2176
+ # @!attribute [rw] name
2177
+ # A unique name for the Automated Reasoning policy. The name must be
2178
+ # between 1 and 63 characters and can contain letters, numbers,
2179
+ # hyphens, and underscores.
2180
+ # @return [String]
2181
+ #
2182
+ # @!attribute [rw] description
2183
+ # A description of the Automated Reasoning policy. Use this to provide
2184
+ # context about the policy's purpose and the types of validations it
2185
+ # performs.
2186
+ # @return [String]
2187
+ #
2188
+ # @!attribute [rw] client_request_token
2189
+ # A unique, case-sensitive identifier to ensure that the operation
2190
+ # completes no more than once. If this token matches a previous
2191
+ # request, Amazon Bedrock ignores the request but doesn't return an
2192
+ # error.
2193
+ #
2194
+ # **A suitable default value is auto-generated.** You should normally
2195
+ # not need to pass this option.
2196
+ # @return [String]
2197
+ #
2198
+ # @!attribute [rw] policy_definition
2199
+ # The policy definition that contains the formal logic rules,
2200
+ # variables, and custom variable types used to validate foundation
2201
+ # model responses in your application.
2202
+ # @return [Types::AutomatedReasoningPolicyDefinition]
2203
+ #
2204
+ # @!attribute [rw] tags
2205
+ # A list of tags to associate with the Automated Reasoning policy.
2206
+ # Tags help you organize and manage your policies.
2207
+ # @return [Array<Types::Tag>]
2208
+ #
2209
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateAutomatedReasoningPolicyRequest AWS API Documentation
2210
+ #
2211
+ class CreateAutomatedReasoningPolicyRequest < Struct.new(
2212
+ :name,
2213
+ :description,
2214
+ :client_request_token,
2215
+ :policy_definition,
2216
+ :tags)
2217
+ SENSITIVE = [:name, :description]
2218
+ include Aws::Structure
2219
+ end
2220
+
2221
+ # @!attribute [rw] policy_arn
2222
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy
2223
+ # that you created.
2224
+ # @return [String]
2225
+ #
2226
+ # @!attribute [rw] version
2227
+ # The version number of the newly created Automated Reasoning policy.
2228
+ # The initial version is always DRAFT.
2229
+ # @return [String]
2230
+ #
2231
+ # @!attribute [rw] name
2232
+ # The name of the Automated Reasoning policy.
2233
+ # @return [String]
2234
+ #
2235
+ # @!attribute [rw] description
2236
+ # The description of the Automated Reasoning policy.
2237
+ # @return [String]
2238
+ #
2239
+ # @!attribute [rw] definition_hash
2240
+ # The hash of the policy definition. This is used as a concurrency
2241
+ # token for creating policy versions that you can use in your
2242
+ # application.
2243
+ # @return [String]
2244
+ #
2245
+ # @!attribute [rw] created_at
2246
+ # The timestamp when the policy was created.
2247
+ # @return [Time]
2248
+ #
2249
+ # @!attribute [rw] updated_at
2250
+ # The timestamp when the policy was last updated.
2251
+ # @return [Time]
2252
+ #
2253
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateAutomatedReasoningPolicyResponse AWS API Documentation
2254
+ #
2255
+ class CreateAutomatedReasoningPolicyResponse < Struct.new(
2256
+ :policy_arn,
2257
+ :version,
2258
+ :name,
2259
+ :description,
2260
+ :definition_hash,
2261
+ :created_at,
2262
+ :updated_at)
2263
+ SENSITIVE = [:name, :description]
2264
+ include Aws::Structure
2265
+ end
2266
+
2267
+ # @!attribute [rw] policy_arn
2268
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy for
2269
+ # which to create the test.
2270
+ # @return [String]
2271
+ #
2272
+ # @!attribute [rw] guard_content
2273
+ # The output content that's validated by the Automated Reasoning
2274
+ # policy. This represents the foundation model response that will be
2275
+ # checked for accuracy.
2276
+ # @return [String]
2277
+ #
2278
+ # @!attribute [rw] query_content
2279
+ # The input query or prompt that generated the content. This provides
2280
+ # context for the validation.
2281
+ # @return [String]
2282
+ #
2283
+ # @!attribute [rw] expected_aggregated_findings_result
2284
+ # The expected result of the Automated Reasoning check. Valid values
2285
+ # include: , TOO\_COMPLEX, and NO\_TRANSLATIONS.
2286
+ #
2287
+ # * `VALID` - The claims are true. The claims are implied by the
2288
+ # premises and the Automated Reasoning policy. Given the Automated
2289
+ # Reasoning policy and premises, it is not possible for these claims
2290
+ # to be false. In other words, there are no alternative answers that
2291
+ # are true that contradict the claims.
2292
+ #
2293
+ # * `INVALID` - The claims are false. The claims are not implied by
2294
+ # the premises and Automated Reasoning policy. Furthermore, there
2295
+ # exists different claims that are consistent with the premises and
2296
+ # Automated Reasoning policy.
2297
+ #
2298
+ # * `SATISFIABLE` - The claims can be true or false. It depends on
2299
+ # what assumptions are made for the claim to be implied from the
2300
+ # premises and Automated Reasoning policy rules. In this situation,
2301
+ # different assumptions can make input claims false and alternative
2302
+ # claims true.
2303
+ #
2304
+ # * `IMPOSSIBLE` - Automated Reasoning can’t make a statement about
2305
+ # the claims. This can happen if the premises are logically
2306
+ # incorrect, or if there is a conflict within the Automated
2307
+ # Reasoning policy itself.
2308
+ #
2309
+ # * `TRANSLATION_AMBIGUOUS` - Detected an ambiguity in the translation
2310
+ # meant it would be unsound to continue with validity checking.
2311
+ # Additional context or follow-up questions might be needed to get
2312
+ # translation to succeed.
2313
+ #
2314
+ # * `TOO_COMPLEX` - The input contains too much information for
2315
+ # Automated Reasoning to process within its latency limits.
2316
+ #
2317
+ # * `NO_TRANSLATIONS` - Identifies that some or all of the input
2318
+ # prompt wasn't translated into logic. This can happen if the input
2319
+ # isn't relevant to the Automated Reasoning policy, or if the
2320
+ # policy doesn't have variables to model relevant input. If
2321
+ # Automated Reasoning can't translate anything, you get a single
2322
+ # `NO_TRANSLATIONS` finding. You might also see a `NO_TRANSLATIONS`
2323
+ # (along with other findings) if some part of the validation isn't
2324
+ # translated.
2325
+ # @return [String]
2326
+ #
2327
+ # @!attribute [rw] client_request_token
2328
+ # A unique, case-sensitive identifier to ensure that the operation
2329
+ # completes no more than one time. If this token matches a previous
2330
+ # request, Amazon Bedrock ignores the request, but does not return an
2331
+ # error.
2332
+ #
2333
+ # **A suitable default value is auto-generated.** You should normally
2334
+ # not need to pass this option.
2335
+ # @return [String]
2336
+ #
2337
+ # @!attribute [rw] confidence_threshold
2338
+ # The minimum confidence level for logic validation. Content that
2339
+ # meets the threshold is considered a high-confidence finding that can
2340
+ # be validated.
2341
+ # @return [Float]
2342
+ #
2343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCaseRequest AWS API Documentation
2344
+ #
2345
+ class CreateAutomatedReasoningPolicyTestCaseRequest < Struct.new(
2346
+ :policy_arn,
2347
+ :guard_content,
2348
+ :query_content,
2349
+ :expected_aggregated_findings_result,
2350
+ :client_request_token,
2351
+ :confidence_threshold)
2352
+ SENSITIVE = [:guard_content, :query_content]
2353
+ include Aws::Structure
2354
+ end
2355
+
2356
+ # @!attribute [rw] policy_arn
2357
+ # The Amazon Resource Name (ARN) of the policy for which the test was
2358
+ # created.
2359
+ # @return [String]
2360
+ #
2361
+ # @!attribute [rw] test_case_id
2362
+ # The unique identifier of the created test.
2363
+ # @return [String]
2364
+ #
2365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCaseResponse AWS API Documentation
2366
+ #
2367
+ class CreateAutomatedReasoningPolicyTestCaseResponse < Struct.new(
2368
+ :policy_arn,
2369
+ :test_case_id)
2370
+ SENSITIVE = []
2371
+ include Aws::Structure
2372
+ end
2373
+
2374
+ # @!attribute [rw] policy_arn
2375
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy for
2376
+ # which to create a version.
2377
+ # @return [String]
2378
+ #
2379
+ # @!attribute [rw] client_request_token
2380
+ # A unique, case-sensitive identifier to ensure that the operation
2381
+ # completes no more than one time. If this token matches a previous
2382
+ # request, Amazon Bedrock ignores the request, but does not return an
2383
+ # error.
2384
+ #
2385
+ # **A suitable default value is auto-generated.** You should normally
2386
+ # not need to pass this option.
2387
+ # @return [String]
2388
+ #
2389
+ # @!attribute [rw] last_updated_definition_hash
2390
+ # The hash of the current policy definition used as a concurrency
2391
+ # token to ensure the policy hasn't been modified since you last
2392
+ # retrieved it.
2393
+ # @return [String]
2394
+ #
2395
+ # @!attribute [rw] tags
2396
+ # A list of tags to associate with the policy version.
2397
+ # @return [Array<Types::Tag>]
2398
+ #
2399
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersionRequest AWS API Documentation
2400
+ #
2401
+ class CreateAutomatedReasoningPolicyVersionRequest < Struct.new(
2402
+ :policy_arn,
2403
+ :client_request_token,
2404
+ :last_updated_definition_hash,
2405
+ :tags)
2406
+ SENSITIVE = []
2407
+ include Aws::Structure
2408
+ end
2409
+
2410
+ # @!attribute [rw] policy_arn
2411
+ # The versioned Amazon Resource Name (ARN) of the policy version.
2412
+ # @return [String]
2413
+ #
2414
+ # @!attribute [rw] version
2415
+ # The version number of the policy version.
2416
+ # @return [String]
2417
+ #
2418
+ # @!attribute [rw] name
2419
+ # The name of the policy version.
2420
+ # @return [String]
2421
+ #
2422
+ # @!attribute [rw] description
2423
+ # The description of the policy version.
2424
+ # @return [String]
2425
+ #
2426
+ # @!attribute [rw] definition_hash
2427
+ # The hash of the policy definition for this version.
2428
+ # @return [String]
2429
+ #
2430
+ # @!attribute [rw] created_at
2431
+ # The timestamp when the policy version was created.
2432
+ # @return [Time]
2433
+ #
2434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersionResponse AWS API Documentation
2435
+ #
2436
+ class CreateAutomatedReasoningPolicyVersionResponse < Struct.new(
2437
+ :policy_arn,
2438
+ :version,
2439
+ :name,
2440
+ :description,
2441
+ :definition_hash,
2442
+ :created_at)
2443
+ SENSITIVE = [:name, :description]
2444
+ include Aws::Structure
2445
+ end
2446
+
286
2447
  # @!attribute [rw] model_deployment_name
287
2448
  # The name for the custom model deployment. The name must be unique
288
2449
  # within your Amazon Web Services account and Region.
@@ -594,6 +2755,11 @@ module Aws::Bedrock
594
2755
  # guardrail.
595
2756
  # @return [Types::GuardrailContextualGroundingPolicyConfig]
596
2757
  #
2758
+ # @!attribute [rw] automated_reasoning_policy_config
2759
+ # Optional configuration for integrating Automated Reasoning policies
2760
+ # with the new guardrail.
2761
+ # @return [Types::GuardrailAutomatedReasoningPolicyConfig]
2762
+ #
597
2763
  # @!attribute [rw] cross_region_config
598
2764
  # The system-defined guardrail profile that you're using with your
599
2765
  # guardrail. Guardrail profiles define the destination Amazon Web
@@ -648,6 +2814,7 @@ module Aws::Bedrock
648
2814
  :word_policy_config,
649
2815
  :sensitive_information_policy_config,
650
2816
  :contextual_grounding_policy_config,
2817
+ :automated_reasoning_policy_config,
651
2818
  :cross_region_config,
652
2819
  :blocked_input_messaging,
653
2820
  :blocked_outputs_messaging,
@@ -1605,54 +3772,128 @@ module Aws::Bedrock
1605
3772
  include Aws::Structure
1606
3773
  end
1607
3774
 
1608
- # A model customization configuration
1609
- #
1610
- # @note CustomizationConfig is a union - when making an API calls you must set exactly one of the members.
1611
- #
1612
- # @note CustomizationConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of CustomizationConfig corresponding to the set member.
3775
+ # A model customization configuration
3776
+ #
3777
+ # @note CustomizationConfig is a union - when making an API calls you must set exactly one of the members.
3778
+ #
3779
+ # @note CustomizationConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of CustomizationConfig corresponding to the set member.
3780
+ #
3781
+ # @!attribute [rw] distillation_config
3782
+ # The Distillation configuration for the custom model.
3783
+ # @return [Types::DistillationConfig]
3784
+ #
3785
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CustomizationConfig AWS API Documentation
3786
+ #
3787
+ class CustomizationConfig < Struct.new(
3788
+ :distillation_config,
3789
+ :unknown)
3790
+ SENSITIVE = []
3791
+ include Aws::Structure
3792
+ include Aws::Structure::Union
3793
+
3794
+ class DistillationConfig < CustomizationConfig; end
3795
+ class Unknown < CustomizationConfig; end
3796
+ end
3797
+
3798
+ # For a Distillation job, the status details for the data processing
3799
+ # sub-task of the job.
3800
+ #
3801
+ # @!attribute [rw] status
3802
+ # The status of the data processing sub-task of the job.
3803
+ # @return [String]
3804
+ #
3805
+ # @!attribute [rw] creation_time
3806
+ # The start time of the data processing sub-task of the job.
3807
+ # @return [Time]
3808
+ #
3809
+ # @!attribute [rw] last_modified_time
3810
+ # The latest update to the data processing sub-task of the job.
3811
+ # @return [Time]
3812
+ #
3813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DataProcessingDetails AWS API Documentation
3814
+ #
3815
+ class DataProcessingDetails < Struct.new(
3816
+ :status,
3817
+ :creation_time,
3818
+ :last_modified_time)
3819
+ SENSITIVE = []
3820
+ include Aws::Structure
3821
+ end
3822
+
3823
+ # @!attribute [rw] policy_arn
3824
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy
3825
+ # whose build workflow you want to delete.
3826
+ # @return [String]
3827
+ #
3828
+ # @!attribute [rw] build_workflow_id
3829
+ # The unique identifier of the build workflow to delete.
3830
+ # @return [String]
3831
+ #
3832
+ # @!attribute [rw] last_updated_at
3833
+ # The timestamp when the build workflow was last updated. This is used
3834
+ # for optimistic concurrency control to prevent accidental deletion of
3835
+ # workflows that have been modified.
3836
+ # @return [Time]
3837
+ #
3838
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflowRequest AWS API Documentation
3839
+ #
3840
+ class DeleteAutomatedReasoningPolicyBuildWorkflowRequest < Struct.new(
3841
+ :policy_arn,
3842
+ :build_workflow_id,
3843
+ :last_updated_at)
3844
+ SENSITIVE = []
3845
+ include Aws::Structure
3846
+ end
3847
+
3848
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflowResponse AWS API Documentation
1613
3849
  #
1614
- # @!attribute [rw] distillation_config
1615
- # The Distillation configuration for the custom model.
1616
- # @return [Types::DistillationConfig]
3850
+ class DeleteAutomatedReasoningPolicyBuildWorkflowResponse < Aws::EmptyStructure; end
3851
+
3852
+ # @!attribute [rw] policy_arn
3853
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy to
3854
+ # delete.
3855
+ # @return [String]
1617
3856
  #
1618
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CustomizationConfig AWS API Documentation
3857
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyRequest AWS API Documentation
1619
3858
  #
1620
- class CustomizationConfig < Struct.new(
1621
- :distillation_config,
1622
- :unknown)
3859
+ class DeleteAutomatedReasoningPolicyRequest < Struct.new(
3860
+ :policy_arn)
1623
3861
  SENSITIVE = []
1624
3862
  include Aws::Structure
1625
- include Aws::Structure::Union
1626
-
1627
- class DistillationConfig < CustomizationConfig; end
1628
- class Unknown < CustomizationConfig; end
1629
3863
  end
1630
3864
 
1631
- # For a Distillation job, the status details for the data processing
1632
- # sub-task of the job.
3865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyResponse AWS API Documentation
1633
3866
  #
1634
- # @!attribute [rw] status
1635
- # The status of the data processing sub-task of the job.
3867
+ class DeleteAutomatedReasoningPolicyResponse < Aws::EmptyStructure; end
3868
+
3869
+ # @!attribute [rw] policy_arn
3870
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy
3871
+ # that contains the test.
1636
3872
  # @return [String]
1637
3873
  #
1638
- # @!attribute [rw] creation_time
1639
- # The start time of the data processing sub-task of the job.
1640
- # @return [Time]
3874
+ # @!attribute [rw] test_case_id
3875
+ # The unique identifier of the test to delete.
3876
+ # @return [String]
1641
3877
  #
1642
- # @!attribute [rw] last_modified_time
1643
- # The latest update to the data processing sub-task of the job.
3878
+ # @!attribute [rw] last_updated_at
3879
+ # The timestamp when the test was last updated. This is used as a
3880
+ # concurrency token to prevent conflicting modifications.
1644
3881
  # @return [Time]
1645
3882
  #
1646
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DataProcessingDetails AWS API Documentation
3883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCaseRequest AWS API Documentation
1647
3884
  #
1648
- class DataProcessingDetails < Struct.new(
1649
- :status,
1650
- :creation_time,
1651
- :last_modified_time)
3885
+ class DeleteAutomatedReasoningPolicyTestCaseRequest < Struct.new(
3886
+ :policy_arn,
3887
+ :test_case_id,
3888
+ :last_updated_at)
1652
3889
  SENSITIVE = []
1653
3890
  include Aws::Structure
1654
3891
  end
1655
3892
 
3893
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCaseResponse AWS API Documentation
3894
+ #
3895
+ class DeleteAutomatedReasoningPolicyTestCaseResponse < Aws::EmptyStructure; end
3896
+
1656
3897
  # @!attribute [rw] custom_model_deployment_identifier
1657
3898
  # The Amazon Resource Name (ARN) or name of the custom model
1658
3899
  # deployment to delete.
@@ -2421,6 +4662,33 @@ module Aws::Bedrock
2421
4662
  class Unknown < EvaluatorModelConfig; end
2422
4663
  end
2423
4664
 
4665
+ # @!attribute [rw] policy_arn
4666
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy to
4667
+ # export. Can be either the unversioned ARN for the draft policy or a
4668
+ # versioned ARN for a specific policy version.
4669
+ # @return [String]
4670
+ #
4671
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersionRequest AWS API Documentation
4672
+ #
4673
+ class ExportAutomatedReasoningPolicyVersionRequest < Struct.new(
4674
+ :policy_arn)
4675
+ SENSITIVE = []
4676
+ include Aws::Structure
4677
+ end
4678
+
4679
+ # @!attribute [rw] policy_definition
4680
+ # The exported policy definition containing the formal logic rules,
4681
+ # variables, and custom variable types.
4682
+ # @return [Types::AutomatedReasoningPolicyDefinition]
4683
+ #
4684
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersionResponse AWS API Documentation
4685
+ #
4686
+ class ExportAutomatedReasoningPolicyVersionResponse < Struct.new(
4687
+ :policy_definition)
4688
+ SENSITIVE = []
4689
+ include Aws::Structure
4690
+ end
4691
+
2424
4692
  # The unique external source of the content contained in the wrapper
2425
4693
  # object.
2426
4694
  #
@@ -2631,95 +4899,449 @@ module Aws::Bedrock
2631
4899
 
2632
4900
  # Summary information for a foundation model.
2633
4901
  #
2634
- # @!attribute [rw] model_arn
2635
- # The Amazon Resource Name (ARN) of the foundation model.
4902
+ # @!attribute [rw] model_arn
4903
+ # The Amazon Resource Name (ARN) of the foundation model.
4904
+ # @return [String]
4905
+ #
4906
+ # @!attribute [rw] model_id
4907
+ # The model ID of the foundation model.
4908
+ # @return [String]
4909
+ #
4910
+ # @!attribute [rw] model_name
4911
+ # The name of the model.
4912
+ # @return [String]
4913
+ #
4914
+ # @!attribute [rw] provider_name
4915
+ # The model's provider name.
4916
+ # @return [String]
4917
+ #
4918
+ # @!attribute [rw] input_modalities
4919
+ # The input modalities that the model supports.
4920
+ # @return [Array<String>]
4921
+ #
4922
+ # @!attribute [rw] output_modalities
4923
+ # The output modalities that the model supports.
4924
+ # @return [Array<String>]
4925
+ #
4926
+ # @!attribute [rw] response_streaming_supported
4927
+ # Indicates whether the model supports streaming.
4928
+ # @return [Boolean]
4929
+ #
4930
+ # @!attribute [rw] customizations_supported
4931
+ # Whether the model supports fine-tuning or continual pre-training.
4932
+ # @return [Array<String>]
4933
+ #
4934
+ # @!attribute [rw] inference_types_supported
4935
+ # The inference types that the model supports.
4936
+ # @return [Array<String>]
4937
+ #
4938
+ # @!attribute [rw] model_lifecycle
4939
+ # Contains details about whether a model version is available or
4940
+ # deprecated.
4941
+ # @return [Types::FoundationModelLifecycle]
4942
+ #
4943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/FoundationModelSummary AWS API Documentation
4944
+ #
4945
+ class FoundationModelSummary < Struct.new(
4946
+ :model_arn,
4947
+ :model_id,
4948
+ :model_name,
4949
+ :provider_name,
4950
+ :input_modalities,
4951
+ :output_modalities,
4952
+ :response_streaming_supported,
4953
+ :customizations_supported,
4954
+ :inference_types_supported,
4955
+ :model_lifecycle)
4956
+ SENSITIVE = []
4957
+ include Aws::Structure
4958
+ end
4959
+
4960
+ # The configuration details for response generation based on retrieved
4961
+ # text chunks.
4962
+ #
4963
+ # @!attribute [rw] prompt_template
4964
+ # Contains the template for the prompt that's sent to the model for
4965
+ # response generation.
4966
+ # @return [Types::PromptTemplate]
4967
+ #
4968
+ # @!attribute [rw] guardrail_configuration
4969
+ # Contains configuration details for the guardrail.
4970
+ # @return [Types::GuardrailConfiguration]
4971
+ #
4972
+ # @!attribute [rw] kb_inference_config
4973
+ # Contains configuration details for inference for knowledge base
4974
+ # retrieval and response generation.
4975
+ # @return [Types::KbInferenceConfig]
4976
+ #
4977
+ # @!attribute [rw] additional_model_request_fields
4978
+ # Additional model parameters and corresponding values not included in
4979
+ # the `textInferenceConfig` structure for a knowledge base. This
4980
+ # allows you to provide custom model parameters specific to the
4981
+ # language model being used.
4982
+ # @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
4983
+ #
4984
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GenerationConfiguration AWS API Documentation
4985
+ #
4986
+ class GenerationConfiguration < Struct.new(
4987
+ :prompt_template,
4988
+ :guardrail_configuration,
4989
+ :kb_inference_config,
4990
+ :additional_model_request_fields)
4991
+ SENSITIVE = []
4992
+ include Aws::Structure
4993
+ end
4994
+
4995
+ # @!attribute [rw] policy_arn
4996
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy
4997
+ # whose annotations you want to retrieve.
4998
+ # @return [String]
4999
+ #
5000
+ # @!attribute [rw] build_workflow_id
5001
+ # The unique identifier of the build workflow whose annotations you
5002
+ # want to retrieve.
5003
+ # @return [String]
5004
+ #
5005
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotationsRequest AWS API Documentation
5006
+ #
5007
+ class GetAutomatedReasoningPolicyAnnotationsRequest < Struct.new(
5008
+ :policy_arn,
5009
+ :build_workflow_id)
5010
+ SENSITIVE = []
5011
+ include Aws::Structure
5012
+ end
5013
+
5014
+ # @!attribute [rw] policy_arn
5015
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy.
5016
+ # @return [String]
5017
+ #
5018
+ # @!attribute [rw] name
5019
+ # The name of the Automated Reasoning policy.
5020
+ # @return [String]
5021
+ #
5022
+ # @!attribute [rw] build_workflow_id
5023
+ # The unique identifier of the build workflow.
5024
+ # @return [String]
5025
+ #
5026
+ # @!attribute [rw] annotations
5027
+ # The current set of annotations containing rules, variables, and
5028
+ # types extracted from the source documents. These can be modified
5029
+ # before finalizing the policy.
5030
+ # @return [Array<Types::AutomatedReasoningPolicyAnnotation>]
5031
+ #
5032
+ # @!attribute [rw] annotation_set_hash
5033
+ # A hash value representing the current state of the annotations. This
5034
+ # is used for optimistic concurrency control when updating
5035
+ # annotations.
5036
+ # @return [String]
5037
+ #
5038
+ # @!attribute [rw] updated_at
5039
+ # The timestamp when the annotations were last updated.
5040
+ # @return [Time]
5041
+ #
5042
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotationsResponse AWS API Documentation
5043
+ #
5044
+ class GetAutomatedReasoningPolicyAnnotationsResponse < Struct.new(
5045
+ :policy_arn,
5046
+ :name,
5047
+ :build_workflow_id,
5048
+ :annotations,
5049
+ :annotation_set_hash,
5050
+ :updated_at)
5051
+ SENSITIVE = [:name]
5052
+ include Aws::Structure
5053
+ end
5054
+
5055
+ # @!attribute [rw] policy_arn
5056
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy
5057
+ # whose build workflow you want to retrieve.
5058
+ # @return [String]
5059
+ #
5060
+ # @!attribute [rw] build_workflow_id
5061
+ # The unique identifier of the build workflow to retrieve.
5062
+ # @return [String]
5063
+ #
5064
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowRequest AWS API Documentation
5065
+ #
5066
+ class GetAutomatedReasoningPolicyBuildWorkflowRequest < Struct.new(
5067
+ :policy_arn,
5068
+ :build_workflow_id)
5069
+ SENSITIVE = []
5070
+ include Aws::Structure
5071
+ end
5072
+
5073
+ # @!attribute [rw] policy_arn
5074
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy.
5075
+ # @return [String]
5076
+ #
5077
+ # @!attribute [rw] build_workflow_id
5078
+ # The unique identifier of the build workflow.
5079
+ # @return [String]
5080
+ #
5081
+ # @!attribute [rw] status
5082
+ # The current status of the build workflow (e.g., RUNNING, COMPLETED,
5083
+ # FAILED, CANCELLED).
5084
+ # @return [String]
5085
+ #
5086
+ # @!attribute [rw] build_workflow_type
5087
+ # The type of build workflow being executed (e.g.,
5088
+ # DOCUMENT\_INGESTION, POLICY\_REPAIR).
5089
+ # @return [String]
5090
+ #
5091
+ # @!attribute [rw] document_name
5092
+ # The name of the source document used in the build workflow.
5093
+ # @return [String]
5094
+ #
5095
+ # @!attribute [rw] document_content_type
5096
+ # The content type of the source document (e.g., text/plain,
5097
+ # application/pdf).
5098
+ # @return [String]
5099
+ #
5100
+ # @!attribute [rw] document_description
5101
+ # A detailed description of the document's content and how it should
5102
+ # be used in the policy generation process.
5103
+ # @return [String]
5104
+ #
5105
+ # @!attribute [rw] created_at
5106
+ # The timestamp when the build workflow was created.
5107
+ # @return [Time]
5108
+ #
5109
+ # @!attribute [rw] updated_at
5110
+ # The timestamp when the build workflow was last updated.
5111
+ # @return [Time]
5112
+ #
5113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResponse AWS API Documentation
5114
+ #
5115
+ class GetAutomatedReasoningPolicyBuildWorkflowResponse < Struct.new(
5116
+ :policy_arn,
5117
+ :build_workflow_id,
5118
+ :status,
5119
+ :build_workflow_type,
5120
+ :document_name,
5121
+ :document_content_type,
5122
+ :document_description,
5123
+ :created_at,
5124
+ :updated_at)
5125
+ SENSITIVE = [:document_name, :document_description]
5126
+ include Aws::Structure
5127
+ end
5128
+
5129
+ # @!attribute [rw] policy_arn
5130
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy
5131
+ # whose build workflow assets you want to retrieve.
5132
+ # @return [String]
5133
+ #
5134
+ # @!attribute [rw] build_workflow_id
5135
+ # The unique identifier of the build workflow whose result assets you
5136
+ # want to retrieve.
5137
+ # @return [String]
5138
+ #
5139
+ # @!attribute [rw] asset_type
5140
+ # The type of asset to retrieve (e.g., BUILD\_LOG, QUALITY\_REPORT,
5141
+ # POLICY\_DEFINITION).
5142
+ # @return [String]
5143
+ #
5144
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssetsRequest AWS API Documentation
5145
+ #
5146
+ class GetAutomatedReasoningPolicyBuildWorkflowResultAssetsRequest < Struct.new(
5147
+ :policy_arn,
5148
+ :build_workflow_id,
5149
+ :asset_type)
5150
+ SENSITIVE = []
5151
+ include Aws::Structure
5152
+ end
5153
+
5154
+ # @!attribute [rw] policy_arn
5155
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy.
5156
+ # @return [String]
5157
+ #
5158
+ # @!attribute [rw] build_workflow_id
5159
+ # The unique identifier of the build workflow.
5160
+ # @return [String]
5161
+ #
5162
+ # @!attribute [rw] build_workflow_assets
5163
+ # The requested build workflow asset. This is a union type that
5164
+ # returns only one of the available asset types (logs, reports, or
5165
+ # generated artifacts) based on the specific asset type requested in
5166
+ # the API call.
5167
+ # @return [Types::AutomatedReasoningPolicyBuildResultAssets]
5168
+ #
5169
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssetsResponse AWS API Documentation
5170
+ #
5171
+ class GetAutomatedReasoningPolicyBuildWorkflowResultAssetsResponse < Struct.new(
5172
+ :policy_arn,
5173
+ :build_workflow_id,
5174
+ :build_workflow_assets)
5175
+ SENSITIVE = []
5176
+ include Aws::Structure
5177
+ end
5178
+
5179
+ # @!attribute [rw] policy_arn
5180
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy for
5181
+ # which you want to get the next test scenario.
5182
+ # @return [String]
5183
+ #
5184
+ # @!attribute [rw] build_workflow_id
5185
+ # The unique identifier of the build workflow associated with the test
5186
+ # scenarios.
5187
+ # @return [String]
5188
+ #
5189
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenarioRequest AWS API Documentation
5190
+ #
5191
+ class GetAutomatedReasoningPolicyNextScenarioRequest < Struct.new(
5192
+ :policy_arn,
5193
+ :build_workflow_id)
5194
+ SENSITIVE = []
5195
+ include Aws::Structure
5196
+ end
5197
+
5198
+ # @!attribute [rw] policy_arn
5199
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy.
5200
+ # @return [String]
5201
+ #
5202
+ # @!attribute [rw] scenario
5203
+ # The next test scenario to validate, including the test expression
5204
+ # and expected results.
5205
+ # @return [Types::AutomatedReasoningPolicyScenario]
5206
+ #
5207
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenarioResponse AWS API Documentation
5208
+ #
5209
+ class GetAutomatedReasoningPolicyNextScenarioResponse < Struct.new(
5210
+ :policy_arn,
5211
+ :scenario)
5212
+ SENSITIVE = []
5213
+ include Aws::Structure
5214
+ end
5215
+
5216
+ # @!attribute [rw] policy_arn
5217
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy to
5218
+ # retrieve. Can be either the unversioned ARN for the draft policy or
5219
+ # an ARN for a specific policy version.
5220
+ # @return [String]
5221
+ #
5222
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetAutomatedReasoningPolicyRequest AWS API Documentation
5223
+ #
5224
+ class GetAutomatedReasoningPolicyRequest < Struct.new(
5225
+ :policy_arn)
5226
+ SENSITIVE = []
5227
+ include Aws::Structure
5228
+ end
5229
+
5230
+ # @!attribute [rw] policy_arn
5231
+ # The Amazon Resource Name (ARN) of the policy.
5232
+ # @return [String]
5233
+ #
5234
+ # @!attribute [rw] name
5235
+ # The name of the policy.
2636
5236
  # @return [String]
2637
5237
  #
2638
- # @!attribute [rw] model_id
2639
- # The model ID of the foundation model.
5238
+ # @!attribute [rw] version
5239
+ # The version of the policy.
2640
5240
  # @return [String]
2641
5241
  #
2642
- # @!attribute [rw] model_name
2643
- # The name of the model.
5242
+ # @!attribute [rw] policy_id
5243
+ # The unique identifier of the policy.
2644
5244
  # @return [String]
2645
5245
  #
2646
- # @!attribute [rw] provider_name
2647
- # The model's provider name.
5246
+ # @!attribute [rw] description
5247
+ # The description of the policy.
2648
5248
  # @return [String]
2649
5249
  #
2650
- # @!attribute [rw] input_modalities
2651
- # The input modalities that the model supports.
2652
- # @return [Array<String>]
5250
+ # @!attribute [rw] definition_hash
5251
+ # The hash of the policy definition used as a concurrency token.
5252
+ # @return [String]
2653
5253
  #
2654
- # @!attribute [rw] output_modalities
2655
- # The output modalities that the model supports.
2656
- # @return [Array<String>]
5254
+ # @!attribute [rw] created_at
5255
+ # The timestamp when the policy was created.
5256
+ # @return [Time]
2657
5257
  #
2658
- # @!attribute [rw] response_streaming_supported
2659
- # Indicates whether the model supports streaming.
2660
- # @return [Boolean]
5258
+ # @!attribute [rw] updated_at
5259
+ # The timestamp when the policy was last updated.
5260
+ # @return [Time]
2661
5261
  #
2662
- # @!attribute [rw] customizations_supported
2663
- # Whether the model supports fine-tuning or continual pre-training.
2664
- # @return [Array<String>]
5262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetAutomatedReasoningPolicyResponse AWS API Documentation
2665
5263
  #
2666
- # @!attribute [rw] inference_types_supported
2667
- # The inference types that the model supports.
2668
- # @return [Array<String>]
5264
+ class GetAutomatedReasoningPolicyResponse < Struct.new(
5265
+ :policy_arn,
5266
+ :name,
5267
+ :version,
5268
+ :policy_id,
5269
+ :description,
5270
+ :definition_hash,
5271
+ :created_at,
5272
+ :updated_at)
5273
+ SENSITIVE = [:name, :description]
5274
+ include Aws::Structure
5275
+ end
5276
+
5277
+ # @!attribute [rw] policy_arn
5278
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy
5279
+ # that contains the test.
5280
+ # @return [String]
2669
5281
  #
2670
- # @!attribute [rw] model_lifecycle
2671
- # Contains details about whether a model version is available or
2672
- # deprecated.
2673
- # @return [Types::FoundationModelLifecycle]
5282
+ # @!attribute [rw] test_case_id
5283
+ # The unique identifier of the test to retrieve.
5284
+ # @return [String]
2674
5285
  #
2675
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/FoundationModelSummary AWS API Documentation
5286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCaseRequest AWS API Documentation
2676
5287
  #
2677
- class FoundationModelSummary < Struct.new(
2678
- :model_arn,
2679
- :model_id,
2680
- :model_name,
2681
- :provider_name,
2682
- :input_modalities,
2683
- :output_modalities,
2684
- :response_streaming_supported,
2685
- :customizations_supported,
2686
- :inference_types_supported,
2687
- :model_lifecycle)
5288
+ class GetAutomatedReasoningPolicyTestCaseRequest < Struct.new(
5289
+ :policy_arn,
5290
+ :test_case_id)
2688
5291
  SENSITIVE = []
2689
5292
  include Aws::Structure
2690
5293
  end
2691
5294
 
2692
- # The configuration details for response generation based on retrieved
2693
- # text chunks.
5295
+ # @!attribute [rw] policy_arn
5296
+ # The Amazon Resource Name (ARN) of the policy that contains the test.
5297
+ # @return [String]
2694
5298
  #
2695
- # @!attribute [rw] prompt_template
2696
- # Contains the template for the prompt that's sent to the model for
2697
- # response generation.
2698
- # @return [Types::PromptTemplate]
5299
+ # @!attribute [rw] test_case
5300
+ # The test details including the content, query, expected result, and
5301
+ # metadata.
5302
+ # @return [Types::AutomatedReasoningPolicyTestCase]
2699
5303
  #
2700
- # @!attribute [rw] guardrail_configuration
2701
- # Contains configuration details for the guardrail.
2702
- # @return [Types::GuardrailConfiguration]
5304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCaseResponse AWS API Documentation
2703
5305
  #
2704
- # @!attribute [rw] kb_inference_config
2705
- # Contains configuration details for inference for knowledge base
2706
- # retrieval and response generation.
2707
- # @return [Types::KbInferenceConfig]
5306
+ class GetAutomatedReasoningPolicyTestCaseResponse < Struct.new(
5307
+ :policy_arn,
5308
+ :test_case)
5309
+ SENSITIVE = []
5310
+ include Aws::Structure
5311
+ end
5312
+
5313
+ # @!attribute [rw] policy_arn
5314
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy.
5315
+ # @return [String]
2708
5316
  #
2709
- # @!attribute [rw] additional_model_request_fields
2710
- # Additional model parameters and corresponding values not included in
2711
- # the `textInferenceConfig` structure for a knowledge base. This
2712
- # allows you to provide custom model parameters specific to the
2713
- # language model being used.
2714
- # @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
5317
+ # @!attribute [rw] build_workflow_id
5318
+ # The build workflow identifier. The build workflow must display a
5319
+ # `COMPLETED` status to get results.
5320
+ # @return [String]
2715
5321
  #
2716
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GenerationConfiguration AWS API Documentation
5322
+ # @!attribute [rw] test_case_id
5323
+ # The unique identifier of the test for which to retrieve results.
5324
+ # @return [String]
2717
5325
  #
2718
- class GenerationConfiguration < Struct.new(
2719
- :prompt_template,
2720
- :guardrail_configuration,
2721
- :kb_inference_config,
2722
- :additional_model_request_fields)
5326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResultRequest AWS API Documentation
5327
+ #
5328
+ class GetAutomatedReasoningPolicyTestResultRequest < Struct.new(
5329
+ :policy_arn,
5330
+ :build_workflow_id,
5331
+ :test_case_id)
5332
+ SENSITIVE = []
5333
+ include Aws::Structure
5334
+ end
5335
+
5336
+ # @!attribute [rw] test_result
5337
+ # The test result containing validation findings, execution status,
5338
+ # and detailed analysis.
5339
+ # @return [Types::AutomatedReasoningPolicyTestResult]
5340
+ #
5341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResultResponse AWS API Documentation
5342
+ #
5343
+ class GetAutomatedReasoningPolicyTestResultResponse < Struct.new(
5344
+ :test_result)
2723
5345
  SENSITIVE = []
2724
5346
  include Aws::Structure
2725
5347
  end
@@ -3150,6 +5772,11 @@ module Aws::Bedrock
3150
5772
  # The contextual grounding policy used in the guardrail.
3151
5773
  # @return [Types::GuardrailContextualGroundingPolicy]
3152
5774
  #
5775
+ # @!attribute [rw] automated_reasoning_policy
5776
+ # The current Automated Reasoning policy configuration for the
5777
+ # guardrail, if any is configured.
5778
+ # @return [Types::GuardrailAutomatedReasoningPolicy]
5779
+ #
3153
5780
  # @!attribute [rw] cross_region_details
3154
5781
  # Details about the system-defined guardrail profile that you're
3155
5782
  # using with your guardrail, including the guardrail profile ID and
@@ -3201,6 +5828,7 @@ module Aws::Bedrock
3201
5828
  :word_policy,
3202
5829
  :sensitive_information_policy,
3203
5830
  :contextual_grounding_policy,
5831
+ :automated_reasoning_policy,
3204
5832
  :cross_region_details,
3205
5833
  :created_at,
3206
5834
  :updated_at,
@@ -4058,6 +6686,52 @@ module Aws::Bedrock
4058
6686
  include Aws::Structure
4059
6687
  end
4060
6688
 
6689
+ # Represents the configuration of Automated Reasoning policies within a
6690
+ # Amazon Bedrock Guardrail, including the policies to apply and
6691
+ # confidence thresholds.
6692
+ #
6693
+ # @!attribute [rw] policies
6694
+ # The list of Automated Reasoning policy ARNs that should be applied
6695
+ # as part of this guardrail configuration.
6696
+ # @return [Array<String>]
6697
+ #
6698
+ # @!attribute [rw] confidence_threshold
6699
+ # The minimum confidence level required for Automated Reasoning policy
6700
+ # violations to trigger guardrail actions. Values range from 0.0 to
6701
+ # 1.0.
6702
+ # @return [Float]
6703
+ #
6704
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailAutomatedReasoningPolicy AWS API Documentation
6705
+ #
6706
+ class GuardrailAutomatedReasoningPolicy < Struct.new(
6707
+ :policies,
6708
+ :confidence_threshold)
6709
+ SENSITIVE = []
6710
+ include Aws::Structure
6711
+ end
6712
+
6713
+ # Configuration settings for integrating Automated Reasoning policies
6714
+ # with Amazon Bedrock Guardrails.
6715
+ #
6716
+ # @!attribute [rw] policies
6717
+ # The list of Automated Reasoning policy ARNs to include in the
6718
+ # guardrail configuration.
6719
+ # @return [Array<String>]
6720
+ #
6721
+ # @!attribute [rw] confidence_threshold
6722
+ # The confidence threshold for triggering guardrail actions based on
6723
+ # Automated Reasoning policy violations.
6724
+ # @return [Float]
6725
+ #
6726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailAutomatedReasoningPolicyConfig AWS API Documentation
6727
+ #
6728
+ class GuardrailAutomatedReasoningPolicyConfig < Struct.new(
6729
+ :policies,
6730
+ :confidence_threshold)
6731
+ SENSITIVE = []
6732
+ include Aws::Structure
6733
+ end
6734
+
4061
6735
  # The configuration details for the guardrail.
4062
6736
  #
4063
6737
  # @!attribute [rw] guardrail_id
@@ -6053,90 +8727,269 @@ module Aws::Bedrock
6053
8727
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html
6054
8728
  # @return [String]
6055
8729
  #
6056
- # @!attribute [rw] retrieval_configuration
6057
- # Contains configuration details for retrieving text chunks.
6058
- # @return [Types::KnowledgeBaseRetrievalConfiguration]
6059
- #
6060
- # @!attribute [rw] generation_configuration
6061
- # Contains configurations details for response generation based on
6062
- # retrieved text chunks.
6063
- # @return [Types::GenerationConfiguration]
8730
+ # @!attribute [rw] retrieval_configuration
8731
+ # Contains configuration details for retrieving text chunks.
8732
+ # @return [Types::KnowledgeBaseRetrievalConfiguration]
8733
+ #
8734
+ # @!attribute [rw] generation_configuration
8735
+ # Contains configurations details for response generation based on
8736
+ # retrieved text chunks.
8737
+ # @return [Types::GenerationConfiguration]
8738
+ #
8739
+ # @!attribute [rw] orchestration_configuration
8740
+ # Contains configuration details for the model to process the prompt
8741
+ # prior to retrieval and response generation.
8742
+ # @return [Types::OrchestrationConfiguration]
8743
+ #
8744
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/KnowledgeBaseRetrieveAndGenerateConfiguration AWS API Documentation
8745
+ #
8746
+ class KnowledgeBaseRetrieveAndGenerateConfiguration < Struct.new(
8747
+ :knowledge_base_id,
8748
+ :model_arn,
8749
+ :retrieval_configuration,
8750
+ :generation_configuration,
8751
+ :orchestration_configuration)
8752
+ SENSITIVE = []
8753
+ include Aws::Structure
8754
+ end
8755
+
8756
+ # The configuration details for returning the results from the knowledge
8757
+ # base vector search.
8758
+ #
8759
+ # @!attribute [rw] number_of_results
8760
+ # The number of text chunks to retrieve; the number of results to
8761
+ # return.
8762
+ # @return [Integer]
8763
+ #
8764
+ # @!attribute [rw] override_search_type
8765
+ # By default, Amazon Bedrock decides a search strategy for you. If
8766
+ # you're using an Amazon OpenSearch Serverless vector store that
8767
+ # contains a filterable text field, you can specify whether to query
8768
+ # the knowledge base with a `HYBRID` search using both vector
8769
+ # embeddings and raw text, or `SEMANTIC` search using only vector
8770
+ # embeddings. For other vector store configurations, only `SEMANTIC`
8771
+ # search is available.
8772
+ # @return [String]
8773
+ #
8774
+ # @!attribute [rw] filter
8775
+ # Specifies the filters to use on the metadata fields in the knowledge
8776
+ # base data sources before returning results.
8777
+ # @return [Types::RetrievalFilter]
8778
+ #
8779
+ # @!attribute [rw] implicit_filter_configuration
8780
+ # Configuration for implicit filtering in Knowledge Base vector
8781
+ # searches. This allows the system to automatically apply filters
8782
+ # based on the query context without requiring explicit filter
8783
+ # expressions.
8784
+ # @return [Types::ImplicitFilterConfiguration]
8785
+ #
8786
+ # @!attribute [rw] reranking_configuration
8787
+ # Configuration for reranking search results in Knowledge Base vector
8788
+ # searches. Reranking improves search relevance by reordering initial
8789
+ # vector search results using more sophisticated relevance models.
8790
+ # @return [Types::VectorSearchRerankingConfiguration]
8791
+ #
8792
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/KnowledgeBaseVectorSearchConfiguration AWS API Documentation
8793
+ #
8794
+ class KnowledgeBaseVectorSearchConfiguration < Struct.new(
8795
+ :number_of_results,
8796
+ :override_search_type,
8797
+ :filter,
8798
+ :implicit_filter_configuration,
8799
+ :reranking_configuration)
8800
+ SENSITIVE = [:filter]
8801
+ include Aws::Structure
8802
+ end
8803
+
8804
+ # The legal term of the agreement.
8805
+ #
8806
+ # @!attribute [rw] url
8807
+ # URL to the legal term document.
8808
+ # @return [String]
8809
+ #
8810
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/LegalTerm AWS API Documentation
8811
+ #
8812
+ class LegalTerm < Struct.new(
8813
+ :url)
8814
+ SENSITIVE = []
8815
+ include Aws::Structure
8816
+ end
8817
+
8818
+ # @!attribute [rw] policy_arn
8819
+ # Optional filter to list only the policy versions with the specified
8820
+ # Amazon Resource Name (ARN). If not provided, the DRAFT versions for
8821
+ # all policies are listed.
8822
+ # @return [String]
8823
+ #
8824
+ # @!attribute [rw] next_token
8825
+ # The pagination token from a previous request to retrieve the next
8826
+ # page of results.
8827
+ # @return [String]
8828
+ #
8829
+ # @!attribute [rw] max_results
8830
+ # The maximum number of policies to return in a single call.
8831
+ # @return [Integer]
8832
+ #
8833
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListAutomatedReasoningPoliciesRequest AWS API Documentation
8834
+ #
8835
+ class ListAutomatedReasoningPoliciesRequest < Struct.new(
8836
+ :policy_arn,
8837
+ :next_token,
8838
+ :max_results)
8839
+ SENSITIVE = []
8840
+ include Aws::Structure
8841
+ end
8842
+
8843
+ # @!attribute [rw] automated_reasoning_policy_summaries
8844
+ # A list of Automated Reasoning policy summaries.
8845
+ # @return [Array<Types::AutomatedReasoningPolicySummary>]
8846
+ #
8847
+ # @!attribute [rw] next_token
8848
+ # The pagination token to use in a subsequent request to retrieve the
8849
+ # next page of results.
8850
+ # @return [String]
8851
+ #
8852
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListAutomatedReasoningPoliciesResponse AWS API Documentation
8853
+ #
8854
+ class ListAutomatedReasoningPoliciesResponse < Struct.new(
8855
+ :automated_reasoning_policy_summaries,
8856
+ :next_token)
8857
+ SENSITIVE = []
8858
+ include Aws::Structure
8859
+ end
8860
+
8861
+ # @!attribute [rw] policy_arn
8862
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy
8863
+ # whose build workflows you want to list.
8864
+ # @return [String]
8865
+ #
8866
+ # @!attribute [rw] next_token
8867
+ # A pagination token from a previous request to continue listing build
8868
+ # workflows from where the previous request left off.
8869
+ # @return [String]
8870
+ #
8871
+ # @!attribute [rw] max_results
8872
+ # The maximum number of build workflows to return in a single
8873
+ # response. Valid range is 1-100.
8874
+ # @return [Integer]
8875
+ #
8876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflowsRequest AWS API Documentation
8877
+ #
8878
+ class ListAutomatedReasoningPolicyBuildWorkflowsRequest < Struct.new(
8879
+ :policy_arn,
8880
+ :next_token,
8881
+ :max_results)
8882
+ SENSITIVE = []
8883
+ include Aws::Structure
8884
+ end
8885
+
8886
+ # @!attribute [rw] automated_reasoning_policy_build_workflow_summaries
8887
+ # A list of build workflow summaries, each containing key information
8888
+ # about a build workflow including its status and timestamps.
8889
+ # @return [Array<Types::AutomatedReasoningPolicyBuildWorkflowSummary>]
8890
+ #
8891
+ # @!attribute [rw] next_token
8892
+ # A pagination token to use in subsequent requests to retrieve
8893
+ # additional build workflows.
8894
+ # @return [String]
8895
+ #
8896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflowsResponse AWS API Documentation
8897
+ #
8898
+ class ListAutomatedReasoningPolicyBuildWorkflowsResponse < Struct.new(
8899
+ :automated_reasoning_policy_build_workflow_summaries,
8900
+ :next_token)
8901
+ SENSITIVE = []
8902
+ include Aws::Structure
8903
+ end
8904
+
8905
+ # @!attribute [rw] policy_arn
8906
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy for
8907
+ # which to list tests.
8908
+ # @return [String]
8909
+ #
8910
+ # @!attribute [rw] next_token
8911
+ # The pagination token from a previous request to retrieve the next
8912
+ # page of results.
8913
+ # @return [String]
6064
8914
  #
6065
- # @!attribute [rw] orchestration_configuration
6066
- # Contains configuration details for the model to process the prompt
6067
- # prior to retrieval and response generation.
6068
- # @return [Types::OrchestrationConfiguration]
8915
+ # @!attribute [rw] max_results
8916
+ # The maximum number of tests to return in a single call.
8917
+ # @return [Integer]
6069
8918
  #
6070
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/KnowledgeBaseRetrieveAndGenerateConfiguration AWS API Documentation
8919
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCasesRequest AWS API Documentation
6071
8920
  #
6072
- class KnowledgeBaseRetrieveAndGenerateConfiguration < Struct.new(
6073
- :knowledge_base_id,
6074
- :model_arn,
6075
- :retrieval_configuration,
6076
- :generation_configuration,
6077
- :orchestration_configuration)
8921
+ class ListAutomatedReasoningPolicyTestCasesRequest < Struct.new(
8922
+ :policy_arn,
8923
+ :next_token,
8924
+ :max_results)
6078
8925
  SENSITIVE = []
6079
8926
  include Aws::Structure
6080
8927
  end
6081
8928
 
6082
- # The configuration details for returning the results from the knowledge
6083
- # base vector search.
8929
+ # @!attribute [rw] test_cases
8930
+ # A list of tests for the specified policy.
8931
+ # @return [Array<Types::AutomatedReasoningPolicyTestCase>]
6084
8932
  #
6085
- # @!attribute [rw] number_of_results
6086
- # The number of text chunks to retrieve; the number of results to
6087
- # return.
6088
- # @return [Integer]
8933
+ # @!attribute [rw] next_token
8934
+ # The pagination token to use in a subsequent request to retrieve the
8935
+ # next page of results.
8936
+ # @return [String]
6089
8937
  #
6090
- # @!attribute [rw] override_search_type
6091
- # By default, Amazon Bedrock decides a search strategy for you. If
6092
- # you're using an Amazon OpenSearch Serverless vector store that
6093
- # contains a filterable text field, you can specify whether to query
6094
- # the knowledge base with a `HYBRID` search using both vector
6095
- # embeddings and raw text, or `SEMANTIC` search using only vector
6096
- # embeddings. For other vector store configurations, only `SEMANTIC`
6097
- # search is available.
8938
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCasesResponse AWS API Documentation
8939
+ #
8940
+ class ListAutomatedReasoningPolicyTestCasesResponse < Struct.new(
8941
+ :test_cases,
8942
+ :next_token)
8943
+ SENSITIVE = []
8944
+ include Aws::Structure
8945
+ end
8946
+
8947
+ # @!attribute [rw] policy_arn
8948
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy
8949
+ # whose test results you want to list.
6098
8950
  # @return [String]
6099
8951
  #
6100
- # @!attribute [rw] filter
6101
- # Specifies the filters to use on the metadata fields in the knowledge
6102
- # base data sources before returning results.
6103
- # @return [Types::RetrievalFilter]
8952
+ # @!attribute [rw] build_workflow_id
8953
+ # The unique identifier of the build workflow whose test results you
8954
+ # want to list.
8955
+ # @return [String]
6104
8956
  #
6105
- # @!attribute [rw] implicit_filter_configuration
6106
- # Configuration for implicit filtering in Knowledge Base vector
6107
- # searches. This allows the system to automatically apply filters
6108
- # based on the query context without requiring explicit filter
6109
- # expressions.
6110
- # @return [Types::ImplicitFilterConfiguration]
8957
+ # @!attribute [rw] next_token
8958
+ # A pagination token from a previous request to continue listing test
8959
+ # results from where the previous request left off.
8960
+ # @return [String]
6111
8961
  #
6112
- # @!attribute [rw] reranking_configuration
6113
- # Configuration for reranking search results in Knowledge Base vector
6114
- # searches. Reranking improves search relevance by reordering initial
6115
- # vector search results using more sophisticated relevance models.
6116
- # @return [Types::VectorSearchRerankingConfiguration]
8962
+ # @!attribute [rw] max_results
8963
+ # The maximum number of test results to return in a single response.
8964
+ # Valid range is 1-100.
8965
+ # @return [Integer]
6117
8966
  #
6118
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/KnowledgeBaseVectorSearchConfiguration AWS API Documentation
8967
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResultsRequest AWS API Documentation
6119
8968
  #
6120
- class KnowledgeBaseVectorSearchConfiguration < Struct.new(
6121
- :number_of_results,
6122
- :override_search_type,
6123
- :filter,
6124
- :implicit_filter_configuration,
6125
- :reranking_configuration)
6126
- SENSITIVE = [:filter]
8969
+ class ListAutomatedReasoningPolicyTestResultsRequest < Struct.new(
8970
+ :policy_arn,
8971
+ :build_workflow_id,
8972
+ :next_token,
8973
+ :max_results)
8974
+ SENSITIVE = []
6127
8975
  include Aws::Structure
6128
8976
  end
6129
8977
 
6130
- # The legal term of the agreement.
8978
+ # @!attribute [rw] test_results
8979
+ # A list of test results, each containing information about how the
8980
+ # policy performed on specific test scenarios.
8981
+ # @return [Array<Types::AutomatedReasoningPolicyTestResult>]
6131
8982
  #
6132
- # @!attribute [rw] url
6133
- # URL to the legal term document.
8983
+ # @!attribute [rw] next_token
8984
+ # A pagination token to use in subsequent requests to retrieve
8985
+ # additional test results.
6134
8986
  # @return [String]
6135
8987
  #
6136
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/LegalTerm AWS API Documentation
8988
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResultsResponse AWS API Documentation
6137
8989
  #
6138
- class LegalTerm < Struct.new(
6139
- :url)
8990
+ class ListAutomatedReasoningPolicyTestResultsResponse < Struct.new(
8991
+ :test_results,
8992
+ :next_token)
6140
8993
  SENSITIVE = []
6141
8994
  include Aws::Structure
6142
8995
  end
@@ -8411,6 +11264,22 @@ module Aws::Bedrock
8411
11264
  class Unknown < RerankingMetadataSelectiveModeConfiguration; end
8412
11265
  end
8413
11266
 
11267
+ # Thrown when attempting to delete or modify a resource that is
11268
+ # currently being used by other resources or operations. For example,
11269
+ # trying to delete an Automated Reasoning policy that is referenced by
11270
+ # an active guardrail.
11271
+ #
11272
+ # @!attribute [rw] message
11273
+ # @return [String]
11274
+ #
11275
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ResourceInUseException AWS API Documentation
11276
+ #
11277
+ class ResourceInUseException < Struct.new(
11278
+ :message)
11279
+ SENSITIVE = []
11280
+ include Aws::Structure
11281
+ end
11282
+
8414
11283
  # The specified resource Amazon Resource Name (ARN) was not found. Check
8415
11284
  # the Amazon Resource Name (ARN) and try your request again.
8416
11285
  #
@@ -8778,6 +11647,110 @@ module Aws::Bedrock
8778
11647
  include Aws::Structure
8779
11648
  end
8780
11649
 
11650
+ # @!attribute [rw] policy_arn
11651
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy for
11652
+ # which to start the build workflow.
11653
+ # @return [String]
11654
+ #
11655
+ # @!attribute [rw] build_workflow_type
11656
+ # The type of build workflow to start (e.g., DOCUMENT\_INGESTION for
11657
+ # processing new documents, POLICY\_REPAIR for fixing existing
11658
+ # policies).
11659
+ # @return [String]
11660
+ #
11661
+ # @!attribute [rw] client_request_token
11662
+ # A unique, case-sensitive identifier to ensure that the operation
11663
+ # completes no more than once. If this token matches a previous
11664
+ # request, Amazon Bedrock ignores the request but doesn't return an
11665
+ # error.
11666
+ #
11667
+ # **A suitable default value is auto-generated.** You should normally
11668
+ # not need to pass this option.
11669
+ # @return [String]
11670
+ #
11671
+ # @!attribute [rw] source_content
11672
+ # The source content for the build workflow, such as documents to
11673
+ # analyze or repair instructions for existing policies.
11674
+ # @return [Types::AutomatedReasoningPolicyBuildWorkflowSource]
11675
+ #
11676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflowRequest AWS API Documentation
11677
+ #
11678
+ class StartAutomatedReasoningPolicyBuildWorkflowRequest < Struct.new(
11679
+ :policy_arn,
11680
+ :build_workflow_type,
11681
+ :client_request_token,
11682
+ :source_content)
11683
+ SENSITIVE = []
11684
+ include Aws::Structure
11685
+ end
11686
+
11687
+ # @!attribute [rw] policy_arn
11688
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy.
11689
+ # @return [String]
11690
+ #
11691
+ # @!attribute [rw] build_workflow_id
11692
+ # The unique identifier of the newly started build workflow. Use this
11693
+ # ID to track the workflow's progress and retrieve its results.
11694
+ # @return [String]
11695
+ #
11696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflowResponse AWS API Documentation
11697
+ #
11698
+ class StartAutomatedReasoningPolicyBuildWorkflowResponse < Struct.new(
11699
+ :policy_arn,
11700
+ :build_workflow_id)
11701
+ SENSITIVE = []
11702
+ include Aws::Structure
11703
+ end
11704
+
11705
+ # @!attribute [rw] policy_arn
11706
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy to
11707
+ # test.
11708
+ # @return [String]
11709
+ #
11710
+ # @!attribute [rw] build_workflow_id
11711
+ # The build workflow identifier. The build workflow must show a
11712
+ # `COMPLETED` status before running tests.
11713
+ # @return [String]
11714
+ #
11715
+ # @!attribute [rw] test_case_ids
11716
+ # The list of test identifiers to run. If not provided, all tests for
11717
+ # the policy are run.
11718
+ # @return [Array<String>]
11719
+ #
11720
+ # @!attribute [rw] client_request_token
11721
+ # A unique, case-sensitive identifier to ensure that the operation
11722
+ # completes no more than one time. If this token matches a previous
11723
+ # request, Amazon Bedrock ignores the request but doesn't return an
11724
+ # error.
11725
+ #
11726
+ # **A suitable default value is auto-generated.** You should normally
11727
+ # not need to pass this option.
11728
+ # @return [String]
11729
+ #
11730
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflowRequest AWS API Documentation
11731
+ #
11732
+ class StartAutomatedReasoningPolicyTestWorkflowRequest < Struct.new(
11733
+ :policy_arn,
11734
+ :build_workflow_id,
11735
+ :test_case_ids,
11736
+ :client_request_token)
11737
+ SENSITIVE = []
11738
+ include Aws::Structure
11739
+ end
11740
+
11741
+ # @!attribute [rw] policy_arn
11742
+ # The Amazon Resource Name (ARN) of the policy for which the test
11743
+ # workflow was started.
11744
+ # @return [String]
11745
+ #
11746
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflowResponse AWS API Documentation
11747
+ #
11748
+ class StartAutomatedReasoningPolicyTestWorkflowResponse < Struct.new(
11749
+ :policy_arn)
11750
+ SENSITIVE = []
11751
+ include Aws::Structure
11752
+ end
11753
+
8781
11754
  # For a Distillation job, the status details for sub-tasks of the job.
8782
11755
  # Possible statuses for each sub-task include the following:
8783
11756
  #
@@ -9124,6 +12097,203 @@ module Aws::Bedrock
9124
12097
  #
9125
12098
  class UntagResourceResponse < Aws::EmptyStructure; end
9126
12099
 
12100
+ # @!attribute [rw] policy_arn
12101
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy
12102
+ # whose annotations you want to update.
12103
+ # @return [String]
12104
+ #
12105
+ # @!attribute [rw] build_workflow_id
12106
+ # The unique identifier of the build workflow whose annotations you
12107
+ # want to update.
12108
+ # @return [String]
12109
+ #
12110
+ # @!attribute [rw] annotations
12111
+ # The updated annotations containing modified rules, variables, and
12112
+ # types for the policy.
12113
+ # @return [Array<Types::AutomatedReasoningPolicyAnnotation>]
12114
+ #
12115
+ # @!attribute [rw] last_updated_annotation_set_hash
12116
+ # The hash value of the annotation set that you're updating. This is
12117
+ # used for optimistic concurrency control to prevent conflicting
12118
+ # updates.
12119
+ # @return [String]
12120
+ #
12121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotationsRequest AWS API Documentation
12122
+ #
12123
+ class UpdateAutomatedReasoningPolicyAnnotationsRequest < Struct.new(
12124
+ :policy_arn,
12125
+ :build_workflow_id,
12126
+ :annotations,
12127
+ :last_updated_annotation_set_hash)
12128
+ SENSITIVE = []
12129
+ include Aws::Structure
12130
+ end
12131
+
12132
+ # @!attribute [rw] policy_arn
12133
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy.
12134
+ # @return [String]
12135
+ #
12136
+ # @!attribute [rw] build_workflow_id
12137
+ # The unique identifier of the build workflow.
12138
+ # @return [String]
12139
+ #
12140
+ # @!attribute [rw] annotation_set_hash
12141
+ # The new hash value representing the updated state of the
12142
+ # annotations.
12143
+ # @return [String]
12144
+ #
12145
+ # @!attribute [rw] updated_at
12146
+ # The timestamp when the annotations were updated.
12147
+ # @return [Time]
12148
+ #
12149
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotationsResponse AWS API Documentation
12150
+ #
12151
+ class UpdateAutomatedReasoningPolicyAnnotationsResponse < Struct.new(
12152
+ :policy_arn,
12153
+ :build_workflow_id,
12154
+ :annotation_set_hash,
12155
+ :updated_at)
12156
+ SENSITIVE = []
12157
+ include Aws::Structure
12158
+ end
12159
+
12160
+ # @!attribute [rw] policy_arn
12161
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy to
12162
+ # update. This must be the ARN of a draft policy.
12163
+ # @return [String]
12164
+ #
12165
+ # @!attribute [rw] policy_definition
12166
+ # The updated policy definition containing the formal logic rules,
12167
+ # variables, and types.
12168
+ # @return [Types::AutomatedReasoningPolicyDefinition]
12169
+ #
12170
+ # @!attribute [rw] name
12171
+ # The updated name for the Automated Reasoning policy.
12172
+ # @return [String]
12173
+ #
12174
+ # @!attribute [rw] description
12175
+ # The updated description for the Automated Reasoning policy.
12176
+ # @return [String]
12177
+ #
12178
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyRequest AWS API Documentation
12179
+ #
12180
+ class UpdateAutomatedReasoningPolicyRequest < Struct.new(
12181
+ :policy_arn,
12182
+ :policy_definition,
12183
+ :name,
12184
+ :description)
12185
+ SENSITIVE = [:name, :description]
12186
+ include Aws::Structure
12187
+ end
12188
+
12189
+ # @!attribute [rw] policy_arn
12190
+ # The Amazon Resource Name (ARN) of the updated policy.
12191
+ # @return [String]
12192
+ #
12193
+ # @!attribute [rw] name
12194
+ # The updated name of the policy.
12195
+ # @return [String]
12196
+ #
12197
+ # @!attribute [rw] definition_hash
12198
+ # The hash of the updated policy definition.
12199
+ # @return [String]
12200
+ #
12201
+ # @!attribute [rw] updated_at
12202
+ # The timestamp when the policy was last updated.
12203
+ # @return [Time]
12204
+ #
12205
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyResponse AWS API Documentation
12206
+ #
12207
+ class UpdateAutomatedReasoningPolicyResponse < Struct.new(
12208
+ :policy_arn,
12209
+ :name,
12210
+ :definition_hash,
12211
+ :updated_at)
12212
+ SENSITIVE = [:name]
12213
+ include Aws::Structure
12214
+ end
12215
+
12216
+ # @!attribute [rw] policy_arn
12217
+ # The Amazon Resource Name (ARN) of the Automated Reasoning policy
12218
+ # that contains the test.
12219
+ # @return [String]
12220
+ #
12221
+ # @!attribute [rw] test_case_id
12222
+ # The unique identifier of the test to update.
12223
+ # @return [String]
12224
+ #
12225
+ # @!attribute [rw] guard_content
12226
+ # The updated content to be validated by the Automated Reasoning
12227
+ # policy.
12228
+ # @return [String]
12229
+ #
12230
+ # @!attribute [rw] query_content
12231
+ # The updated input query or prompt that generated the content.
12232
+ # @return [String]
12233
+ #
12234
+ # @!attribute [rw] last_updated_at
12235
+ # The timestamp when the test was last updated. This is used as a
12236
+ # concurrency token to prevent conflicting modifications.
12237
+ # @return [Time]
12238
+ #
12239
+ # @!attribute [rw] expected_aggregated_findings_result
12240
+ # The updated expected result of the Automated Reasoning check.
12241
+ # @return [String]
12242
+ #
12243
+ # @!attribute [rw] confidence_threshold
12244
+ # The updated minimum confidence level for logic validation. If null
12245
+ # is provided, the threshold will be removed.
12246
+ # @return [Float]
12247
+ #
12248
+ # @!attribute [rw] kms_key_arn
12249
+ # The KMS key ARN for encrypting the test at rest. If not provided,
12250
+ # the key will not be updated. Use `DISCARD` to remove the key.
12251
+ # @return [String]
12252
+ #
12253
+ # @!attribute [rw] client_request_token
12254
+ # A unique, case-sensitive identifier to ensure that the operation
12255
+ # completes no more than one time. If this token matches a previous
12256
+ # request, Amazon Bedrock ignores the request, but does not return an
12257
+ # error.
12258
+ #
12259
+ # **A suitable default value is auto-generated.** You should normally
12260
+ # not need to pass this option.
12261
+ # @return [String]
12262
+ #
12263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCaseRequest AWS API Documentation
12264
+ #
12265
+ class UpdateAutomatedReasoningPolicyTestCaseRequest < Struct.new(
12266
+ :policy_arn,
12267
+ :test_case_id,
12268
+ :guard_content,
12269
+ :query_content,
12270
+ :last_updated_at,
12271
+ :expected_aggregated_findings_result,
12272
+ :confidence_threshold,
12273
+ :kms_key_arn,
12274
+ :client_request_token)
12275
+ SENSITIVE = [:guard_content, :query_content]
12276
+ include Aws::Structure
12277
+ end
12278
+
12279
+ # @!attribute [rw] policy_arn
12280
+ # The Amazon Resource Name (ARN) of the policy that contains the
12281
+ # updated test.
12282
+ # @return [String]
12283
+ #
12284
+ # @!attribute [rw] test_case_id
12285
+ # The unique identifier of the updated test.
12286
+ # @return [String]
12287
+ #
12288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCaseResponse AWS API Documentation
12289
+ #
12290
+ class UpdateAutomatedReasoningPolicyTestCaseResponse < Struct.new(
12291
+ :policy_arn,
12292
+ :test_case_id)
12293
+ SENSITIVE = []
12294
+ include Aws::Structure
12295
+ end
12296
+
9127
12297
  # @!attribute [rw] guardrail_identifier
9128
12298
  # The unique identifier of the guardrail. This can be an ID or the
9129
12299
  # ARN.
@@ -9158,6 +12328,11 @@ module Aws::Bedrock
9158
12328
  # guardrail.
9159
12329
  # @return [Types::GuardrailContextualGroundingPolicyConfig]
9160
12330
  #
12331
+ # @!attribute [rw] automated_reasoning_policy_config
12332
+ # Updated configuration for Automated Reasoning policies associated
12333
+ # with the guardrail.
12334
+ # @return [Types::GuardrailAutomatedReasoningPolicyConfig]
12335
+ #
9161
12336
  # @!attribute [rw] cross_region_config
9162
12337
  # The system-defined guardrail profile that you're using with your
9163
12338
  # guardrail. Guardrail profiles define the destination Amazon Web
@@ -9194,6 +12369,7 @@ module Aws::Bedrock
9194
12369
  :word_policy_config,
9195
12370
  :sensitive_information_policy_config,
9196
12371
  :contextual_grounding_policy_config,
12372
+ :automated_reasoning_policy_config,
9197
12373
  :cross_region_config,
9198
12374
  :blocked_input_messaging,
9199
12375
  :blocked_outputs_messaging,