Skip to content

Commit 877ba26

Browse files
aws-sdk-dotnet-automationaws-sdk-dotnet-automation
committed
New options for how to handle harmful content detected by Amazon Bedrock Guardrails.
1 parent ba04f78 commit 877ba26

24 files changed

+474
-21
lines changed

‎generator/ServiceModels/bedrock-runtime/bedrock-runtime-2023-09-30.api.json

Lines changed: 48 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,8 @@
213213
"locationName":"guardrailVersion"
214214
},
215215
"source":{"shape":"GuardrailContentSource"},
216-
"content":{"shape":"GuardrailContentBlockList"}
216+
"content":{"shape":"GuardrailContentBlockList"},
217+
"outputScope":{"shape":"GuardrailOutputScope"}
217218
}
218219
},
219220
"ApplyGuardrailResponse":{
@@ -227,6 +228,7 @@
227228
"members":{
228229
"usage":{"shape":"GuardrailUsage"},
229230
"action":{"shape":"GuardrailAction"},
231+
"actionReason":{"shape":"String"},
230232
"outputs":{"shape":"GuardrailOutputContentList"},
231233
"assessments":{"shape":"GuardrailAssessmentList"},
232234
"guardrailCoverage":{"shape":"GuardrailCoverage"}
@@ -316,6 +318,10 @@
316318
"min":0,
317319
"sensitive":true
318320
},
321+
"Boolean":{
322+
"type":"boolean",
323+
"box":true
324+
},
319325
"CachePointBlock":{
320326
"type":"structure",
321327
"required":["type"],
@@ -721,7 +727,8 @@
721727
"type":{"shape":"GuardrailContentFilterType"},
722728
"confidence":{"shape":"GuardrailContentFilterConfidence"},
723729
"filterStrength":{"shape":"GuardrailContentFilterStrength"},
724-
"action":{"shape":"GuardrailContentPolicyAction"}
730+
"action":{"shape":"GuardrailContentPolicyAction"},
731+
"detected":{"shape":"Boolean"}
725732
}
726733
},
727734
"GuardrailContentFilterConfidence":{
@@ -759,7 +766,10 @@
759766
},
760767
"GuardrailContentPolicyAction":{
761768
"type":"string",
762-
"enum":["BLOCKED"]
769+
"enum":[
770+
"BLOCKED",
771+
"NONE"
772+
]
763773
},
764774
"GuardrailContentPolicyAssessment":{
765775
"type":"structure",
@@ -807,7 +817,8 @@
807817
"type":{"shape":"GuardrailContextualGroundingFilterType"},
808818
"threshold":{"shape":"GuardrailContextualGroundingFilterThresholdDouble"},
809819
"score":{"shape":"GuardrailContextualGroundingFilterScoreDouble"},
810-
"action":{"shape":"GuardrailContextualGroundingPolicyAction"}
820+
"action":{"shape":"GuardrailContextualGroundingPolicyAction"},
821+
"detected":{"shape":"Boolean"}
811822
}
812823
},
813824
"GuardrailContextualGroundingFilterScoreDouble":{
@@ -924,7 +935,8 @@
924935
],
925936
"members":{
926937
"match":{"shape":"String"},
927-
"action":{"shape":"GuardrailWordPolicyAction"}
938+
"action":{"shape":"GuardrailWordPolicyAction"},
939+
"detected":{"shape":"Boolean"}
928940
}
929941
},
930942
"GuardrailCustomWordList":{
@@ -993,7 +1005,8 @@
9931005
"members":{
9941006
"match":{"shape":"String"},
9951007
"type":{"shape":"GuardrailManagedWordType"},
996-
"action":{"shape":"GuardrailWordPolicyAction"}
1008+
"action":{"shape":"GuardrailWordPolicyAction"},
1009+
"detected":{"shape":"Boolean"}
9971010
}
9981011
},
9991012
"GuardrailManagedWordList":{
@@ -1014,6 +1027,13 @@
10141027
"type":"list",
10151028
"member":{"shape":"GuardrailOutputContent"}
10161029
},
1030+
"GuardrailOutputScope":{
1031+
"type":"string",
1032+
"enum":[
1033+
"INTERVENTIONS",
1034+
"FULL"
1035+
]
1036+
},
10171037
"GuardrailOutputText":{"type":"string"},
10181038
"GuardrailPiiEntityFilter":{
10191039
"type":"structure",
@@ -1025,7 +1045,8 @@
10251045
"members":{
10261046
"match":{"shape":"String"},
10271047
"type":{"shape":"GuardrailPiiEntityType"},
1028-
"action":{"shape":"GuardrailSensitiveInformationPolicyAction"}
1048+
"action":{"shape":"GuardrailSensitiveInformationPolicyAction"},
1049+
"detected":{"shape":"Boolean"}
10291050
}
10301051
},
10311052
"GuardrailPiiEntityFilterList":{
@@ -1079,7 +1100,8 @@
10791100
"name":{"shape":"String"},
10801101
"match":{"shape":"String"},
10811102
"regex":{"shape":"String"},
1082-
"action":{"shape":"GuardrailSensitiveInformationPolicyAction"}
1103+
"action":{"shape":"GuardrailSensitiveInformationPolicyAction"},
1104+
"detected":{"shape":"Boolean"}
10831105
}
10841106
},
10851107
"GuardrailRegexFilterList":{
@@ -1090,7 +1112,8 @@
10901112
"type":"string",
10911113
"enum":[
10921114
"ANONYMIZED",
1093-
"BLOCKED"
1115+
"BLOCKED",
1116+
"NONE"
10941117
]
10951118
},
10961119
"GuardrailSensitiveInformationPolicyAssessment":{
@@ -1157,7 +1180,8 @@
11571180
"members":{
11581181
"name":{"shape":"String"},
11591182
"type":{"shape":"GuardrailTopicType"},
1160-
"action":{"shape":"GuardrailTopicPolicyAction"}
1183+
"action":{"shape":"GuardrailTopicPolicyAction"},
1184+
"detected":{"shape":"Boolean"}
11611185
}
11621186
},
11631187
"GuardrailTopicList":{
@@ -1166,7 +1190,10 @@
11661190
},
11671191
"GuardrailTopicPolicyAction":{
11681192
"type":"string",
1169-
"enum":["BLOCKED"]
1193+
"enum":[
1194+
"BLOCKED",
1195+
"NONE"
1196+
]
11701197
},
11711198
"GuardrailTopicPolicyAssessment":{
11721199
"type":"structure",
@@ -1187,15 +1214,17 @@
11871214
"type":"string",
11881215
"enum":[
11891216
"enabled",
1190-
"disabled"
1217+
"disabled",
1218+
"enabled_full"
11911219
]
11921220
},
11931221
"GuardrailTraceAssessment":{
11941222
"type":"structure",
11951223
"members":{
11961224
"modelOutput":{"shape":"ModelOutputs"},
11971225
"inputAssessment":{"shape":"GuardrailAssessmentMap"},
1198-
"outputAssessments":{"shape":"GuardrailAssessmentListMap"}
1226+
"outputAssessments":{"shape":"GuardrailAssessmentListMap"},
1227+
"actionReason":{"shape":"String"}
11991228
}
12001229
},
12011230
"GuardrailUsage":{
@@ -1224,7 +1253,10 @@
12241253
},
12251254
"GuardrailWordPolicyAction":{
12261255
"type":"string",
1227-
"enum":["BLOCKED"]
1256+
"enum":[
1257+
"BLOCKED",
1258+
"NONE"
1259+
]
12281260
},
12291261
"GuardrailWordPolicyAssessment":{
12301262
"type":"structure",
@@ -2088,7 +2120,8 @@
20882120
"type":"string",
20892121
"enum":[
20902122
"ENABLED",
2091-
"DISABLED"
2123+
"DISABLED",
2124+
"ENABLED_FULL"
20922125
]
20932126
},
20942127
"ValidationException":{

‎generator/ServiceModels/bedrock-runtime/bedrock-runtime-2023-09-30.docs.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,18 @@
123123
"InvokeModelWithResponseStreamRequest$body": "<p>The prompt and inference parameters in the format specified in the <code>contentType</code> in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html\">Inference parameters</a>. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html\">Run inference</a> in the Bedrock User Guide.</p>"
124124
}
125125
},
126+
"Boolean": {
127+
"base": null,
128+
"refs": {
129+
"GuardrailContentFilter$detected": "<p>Indicates whether content that breaches the guardrail configuration is detected.</p>",
130+
"GuardrailContextualGroundingFilter$detected": "<p>Indicates whether content that fails the contextual grounding evaluation (grounding or relevance score less than the corresponding threshold) was detected.</p>",
131+
"GuardrailCustomWord$detected": "<p>Indicates whether custom word content that breaches the guardrail configuration is detected.</p>",
132+
"GuardrailManagedWord$detected": "<p>Indicates whether managed word content that breaches the guardrail configuration is detected.</p>",
133+
"GuardrailPiiEntityFilter$detected": "<p>Indicates whether personally identifiable information (PII) that breaches the guardrail configuration is detected.</p>",
134+
"GuardrailRegexFilter$detected": "<p>Indicates whether custom regex entities that breach the guardrail configuration are detected.</p>",
135+
"GuardrailTopic$detected": "<p>Indicates whether topic content that breaches the guardrail configuration is detected.</p>"
136+
}
137+
},
126138
"CachePointBlock": {
127139
"base": "<p>Defines a section of content to be cached for reuse in subsequent API calls.</p>",
128140
"refs": {
@@ -651,6 +663,12 @@
651663
"ApplyGuardrailResponse$outputs": "<p>The output details in the response from the guardrail.</p>"
652664
}
653665
},
666+
"GuardrailOutputScope": {
667+
"base": null,
668+
"refs": {
669+
"ApplyGuardrailRequest$outputScope": "<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> <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>"
670+
}
671+
},
654672
"GuardrailOutputText": {
655673
"base": null,
656674
"refs": {
@@ -1258,6 +1276,7 @@
12581276
"String": {
12591277
"base": null,
12601278
"refs": {
1279+
"ApplyGuardrailResponse$actionReason": "<p>The reason for the action taken when harmful content is detected.</p>",
12611280
"ContentBlock$text": "<p>Text to include in the message.</p>",
12621281
"ContentBlockDelta$text": "<p>The content text.</p>",
12631282
"GuardrailAssessmentListMap$key": null,
@@ -1271,6 +1290,7 @@
12711290
"GuardrailRegexFilter$regex": "<p>The regex query.</p>",
12721291
"GuardrailTextBlock$text": "<p>The input text details to be evaluated by the guardrail.</p>",
12731292
"GuardrailTopic$name": "<p>The name for the guardrail.</p>",
1293+
"GuardrailTraceAssessment$actionReason": "<p>Provides the reason for the action taken when harmful content is detected.</p>",
12741294
"PromptVariableMap$key": null,
12751295
"PromptVariableValues$text": "<p>The text value that the variable maps to.</p>",
12761296
"ReasoningContentBlockDelta$text": "<p>The reasoning that the model used to return the output.</p>",

0 commit comments

Comments
 (0)