|
805 | 805 | "smithy.api#documentation": "<p>The content details used in the request to apply the guardrail.</p>",
|
806 | 806 | "smithy.api#required": {}
|
807 | 807 | }
|
| 808 | + }, |
| 809 | + "outputScope": { |
| 810 | + "target": "com.amazonaws.bedrockruntime#GuardrailOutputScope", |
| 811 | + "traits": { |
| 812 | + "smithy.api#documentation": "<p>Specifies the scope of the output that you get in the response. Set to <code>FULL</code> to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.</p>\n <p>Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).</p>" |
| 813 | + } |
808 | 814 | }
|
809 | 815 | },
|
810 | 816 | "traits": {
|
|
828 | 834 | "smithy.api#required": {}
|
829 | 835 | }
|
830 | 836 | },
|
| 837 | + "actionReason": { |
| 838 | + "target": "smithy.api#String", |
| 839 | + "traits": { |
| 840 | + "smithy.api#documentation": "<p>The reason for the action taken when harmful content is detected.</p>" |
| 841 | + } |
| 842 | + }, |
831 | 843 | "outputs": {
|
832 | 844 | "target": "com.amazonaws.bedrockruntime#GuardrailOutputContentList",
|
833 | 845 | "traits": {
|
|
2196 | 2208 | "smithy.api#documentation": "<p>The guardrail action.</p>",
|
2197 | 2209 | "smithy.api#required": {}
|
2198 | 2210 | }
|
| 2211 | + }, |
| 2212 | + "detected": { |
| 2213 | + "target": "smithy.api#Boolean", |
| 2214 | + "traits": { |
| 2215 | + "smithy.api#documentation": "<p>Indicates whether content that breaches the guardrail configuration is detected.</p>" |
| 2216 | + } |
2199 | 2217 | }
|
2200 | 2218 | },
|
2201 | 2219 | "traits": {
|
|
2315 | 2333 | "traits": {
|
2316 | 2334 | "smithy.api#enumValue": "BLOCKED"
|
2317 | 2335 | }
|
| 2336 | + }, |
| 2337 | + "NONE": { |
| 2338 | + "target": "smithy.api#Unit", |
| 2339 | + "traits": { |
| 2340 | + "smithy.api#enumValue": "NONE" |
| 2341 | + } |
2318 | 2342 | }
|
2319 | 2343 | }
|
2320 | 2344 | },
|
|
2423 | 2447 | "smithy.api#documentation": "<p>The action performed by the guardrails contextual grounding filter.</p>",
|
2424 | 2448 | "smithy.api#required": {}
|
2425 | 2449 | }
|
| 2450 | + }, |
| 2451 | + "detected": { |
| 2452 | + "target": "smithy.api#Boolean", |
| 2453 | + "traits": { |
| 2454 | + "smithy.api#documentation": "<p>Indicates whether content that fails the contextual grounding evaluation (grounding or relevance score less than the corresponding threshold) was detected.</p>" |
| 2455 | + } |
2426 | 2456 | }
|
2427 | 2457 | },
|
2428 | 2458 | "traits": {
|
|
2650 | 2680 | "smithy.api#documentation": "<p>The action for the custom word.</p>",
|
2651 | 2681 | "smithy.api#required": {}
|
2652 | 2682 | }
|
| 2683 | + }, |
| 2684 | + "detected": { |
| 2685 | + "target": "smithy.api#Boolean", |
| 2686 | + "traits": { |
| 2687 | + "smithy.api#documentation": "<p>Indicates whether custom word content that breaches the guardrail configuration is detected.</p>" |
| 2688 | + } |
2653 | 2689 | }
|
2654 | 2690 | },
|
2655 | 2691 | "traits": {
|
|
2798 | 2834 | "smithy.api#documentation": "<p>The action for the managed word.</p>",
|
2799 | 2835 | "smithy.api#required": {}
|
2800 | 2836 | }
|
| 2837 | + }, |
| 2838 | + "detected": { |
| 2839 | + "target": "smithy.api#Boolean", |
| 2840 | + "traits": { |
| 2841 | + "smithy.api#documentation": "<p>Indicates whether managed word content that breaches the guardrail configuration is detected.</p>" |
| 2842 | + } |
2801 | 2843 | }
|
2802 | 2844 | },
|
2803 | 2845 | "traits": {
|
|
2841 | 2883 | "target": "com.amazonaws.bedrockruntime#GuardrailOutputContent"
|
2842 | 2884 | }
|
2843 | 2885 | },
|
| 2886 | + "com.amazonaws.bedrockruntime#GuardrailOutputScope": { |
| 2887 | + "type": "enum", |
| 2888 | + "members": { |
| 2889 | + "INTERVENTIONS": { |
| 2890 | + "target": "smithy.api#Unit", |
| 2891 | + "traits": { |
| 2892 | + "smithy.api#enumValue": "INTERVENTIONS" |
| 2893 | + } |
| 2894 | + }, |
| 2895 | + "FULL": { |
| 2896 | + "target": "smithy.api#Unit", |
| 2897 | + "traits": { |
| 2898 | + "smithy.api#enumValue": "FULL" |
| 2899 | + } |
| 2900 | + } |
| 2901 | + } |
| 2902 | + }, |
2844 | 2903 | "com.amazonaws.bedrockruntime#GuardrailOutputText": {
|
2845 | 2904 | "type": "string"
|
2846 | 2905 | },
|
|
2867 | 2926 | "smithy.api#documentation": "<p>The PII entity filter action.</p>",
|
2868 | 2927 | "smithy.api#required": {}
|
2869 | 2928 | }
|
| 2929 | + }, |
| 2930 | + "detected": { |
| 2931 | + "target": "smithy.api#Boolean", |
| 2932 | + "traits": { |
| 2933 | + "smithy.api#documentation": "<p>Indicates whether personally identifiable information (PII) that breaches the guardrail configuration is detected.</p>" |
| 2934 | + } |
2870 | 2935 | }
|
2871 | 2936 | },
|
2872 | 2937 | "traits": {
|
|
3100 | 3165 | "smithy.api#documentation": "<p>The region filter action.</p>",
|
3101 | 3166 | "smithy.api#required": {}
|
3102 | 3167 | }
|
| 3168 | + }, |
| 3169 | + "detected": { |
| 3170 | + "target": "smithy.api#Boolean", |
| 3171 | + "traits": { |
| 3172 | + "smithy.api#documentation": "<p>Indicates whether custom regex entities that breach the guardrail configuration are detected.</p>" |
| 3173 | + } |
3103 | 3174 | }
|
3104 | 3175 | },
|
3105 | 3176 | "traits": {
|
|
3134 | 3205 | "traits": {
|
3135 | 3206 | "smithy.api#enumValue": "BLOCKED"
|
3136 | 3207 | }
|
| 3208 | + }, |
| 3209 | + "NONE": { |
| 3210 | + "target": "smithy.api#Unit", |
| 3211 | + "traits": { |
| 3212 | + "smithy.api#enumValue": "NONE" |
| 3213 | + } |
3137 | 3214 | }
|
3138 | 3215 | }
|
3139 | 3216 | },
|
|
3282 | 3359 | "smithy.api#documentation": "<p>The action the guardrail should take when it intervenes on a topic.</p>",
|
3283 | 3360 | "smithy.api#required": {}
|
3284 | 3361 | }
|
| 3362 | + }, |
| 3363 | + "detected": { |
| 3364 | + "target": "smithy.api#Boolean", |
| 3365 | + "traits": { |
| 3366 | + "smithy.api#documentation": "<p>Indicates whether topic content that breaches the guardrail configuration is detected.</p>" |
| 3367 | + } |
3285 | 3368 | }
|
3286 | 3369 | },
|
3287 | 3370 | "traits": {
|
|
3302 | 3385 | "traits": {
|
3303 | 3386 | "smithy.api#enumValue": "BLOCKED"
|
3304 | 3387 | }
|
| 3388 | + }, |
| 3389 | + "NONE": { |
| 3390 | + "target": "smithy.api#Unit", |
| 3391 | + "traits": { |
| 3392 | + "smithy.api#enumValue": "NONE" |
| 3393 | + } |
3305 | 3394 | }
|
3306 | 3395 | }
|
3307 | 3396 | },
|
|
3348 | 3437 | "traits": {
|
3349 | 3438 | "smithy.api#enumValue": "disabled"
|
3350 | 3439 | }
|
| 3440 | + }, |
| 3441 | + "ENABLED_FULL": { |
| 3442 | + "target": "smithy.api#Unit", |
| 3443 | + "traits": { |
| 3444 | + "smithy.api#enumValue": "enabled_full" |
| 3445 | + } |
3351 | 3446 | }
|
3352 | 3447 | }
|
3353 | 3448 | },
|
|
3371 | 3466 | "traits": {
|
3372 | 3467 | "smithy.api#documentation": "<p>the output assessments.</p>"
|
3373 | 3468 | }
|
| 3469 | + }, |
| 3470 | + "actionReason": { |
| 3471 | + "target": "smithy.api#String", |
| 3472 | + "traits": { |
| 3473 | + "smithy.api#documentation": "<p>Provides the reason for the action taken when harmful content is detected.</p>" |
| 3474 | + } |
3374 | 3475 | }
|
3375 | 3476 | },
|
3376 | 3477 | "traits": {
|
|
3447 | 3548 | "traits": {
|
3448 | 3549 | "smithy.api#enumValue": "BLOCKED"
|
3449 | 3550 | }
|
| 3551 | + }, |
| 3552 | + "NONE": { |
| 3553 | + "target": "smithy.api#Unit", |
| 3554 | + "traits": { |
| 3555 | + "smithy.api#enumValue": "NONE" |
| 3556 | + } |
3450 | 3557 | }
|
3451 | 3558 | }
|
3452 | 3559 | },
|
|
5261 | 5368 | "traits": {
|
5262 | 5369 | "smithy.api#enumValue": "DISABLED"
|
5263 | 5370 | }
|
| 5371 | + }, |
| 5372 | + "ENABLED_FULL": { |
| 5373 | + "target": "smithy.api#Unit", |
| 5374 | + "traits": { |
| 5375 | + "smithy.api#enumValue": "ENABLED_FULL" |
| 5376 | + } |
5264 | 5377 | }
|
5265 | 5378 | }
|
5266 | 5379 | },
|
|
0 commit comments