Skip to content

Commit 415b90d

Browse files
author
AWS
committed
Agents for Amazon Bedrock Runtime Update: This release adds support for using Guardrails with Bedrock Agents.
1 parent afac8f5 commit 415b90d

File tree

2 files changed

+346
-0
lines changed

2 files changed

+346
-0
lines changed

‎.changes/next-release/feature-AgentsforAmazonBedrockRuntime-e05881d.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Agents for Amazon Bedrock Runtime",
4+
"contributor": "",
5+
"description": "This release adds support for using Guardrails with Bedrock Agents."
6+
}

‎services/bedrockagentruntime/src/main/resources/codegen-resources/service-2.json

Lines changed: 340 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -657,6 +657,40 @@
657657
"NONE"
658658
]
659659
},
660+
"GuardrailAction":{
661+
"type":"string",
662+
"enum":[
663+
"INTERVENED",
664+
"NONE"
665+
]
666+
},
667+
"GuardrailAssessment":{
668+
"type":"structure",
669+
"members":{
670+
"contentPolicy":{
671+
"shape":"GuardrailContentPolicyAssessment",
672+
"documentation":"<p>Content policy details of the Guardrail.</p>"
673+
},
674+
"sensitiveInformationPolicy":{
675+
"shape":"GuardrailSensitiveInformationPolicyAssessment",
676+
"documentation":"<p>Sensitive Information policy details of Guardrail.</p>"
677+
},
678+
"topicPolicy":{
679+
"shape":"GuardrailTopicPolicyAssessment",
680+
"documentation":"<p>Topic policy details of the Guardrail.</p>"
681+
},
682+
"wordPolicy":{
683+
"shape":"GuardrailWordPolicyAssessment",
684+
"documentation":"<p>Word policy details of the Guardrail.</p>"
685+
}
686+
},
687+
"documentation":"<p>Assessment details of the content analyzed by Guardrails.</p>",
688+
"sensitive":true
689+
},
690+
"GuardrailAssessmentList":{
691+
"type":"list",
692+
"member":{"shape":"GuardrailAssessment"}
693+
},
660694
"GuardrailConfiguration":{
661695
"type":"structure",
662696
"required":[
@@ -687,6 +721,308 @@
687721
"min":1,
688722
"pattern":"^(([1-9][0-9]{0,7})|(DRAFT))$"
689723
},
724+
"GuardrailContentFilter":{
725+
"type":"structure",
726+
"members":{
727+
"action":{
728+
"shape":"GuardrailContentPolicyAction",
729+
"documentation":"<p>The action placed on the content by the Guardrail filter.</p>"
730+
},
731+
"confidence":{
732+
"shape":"GuardrailContentFilterConfidence",
733+
"documentation":"<p>The confidence level regarding the content detected in the filter by the Guardrail.</p>"
734+
},
735+
"type":{
736+
"shape":"GuardrailContentFilterType",
737+
"documentation":"<p>The type of content detected in the filter by the Guardrail.</p>"
738+
}
739+
},
740+
"documentation":"<p>Details of the content filter used in the Guardrail.</p>",
741+
"sensitive":true
742+
},
743+
"GuardrailContentFilterConfidence":{
744+
"type":"string",
745+
"enum":[
746+
"NONE",
747+
"LOW",
748+
"MEDIUM",
749+
"HIGH"
750+
]
751+
},
752+
"GuardrailContentFilterList":{
753+
"type":"list",
754+
"member":{"shape":"GuardrailContentFilter"},
755+
"sensitive":true
756+
},
757+
"GuardrailContentFilterType":{
758+
"type":"string",
759+
"enum":[
760+
"INSULTS",
761+
"HATE",
762+
"SEXUAL",
763+
"VIOLENCE",
764+
"MISCONDUCT",
765+
"PROMPT_ATTACK"
766+
]
767+
},
768+
"GuardrailContentPolicyAction":{
769+
"type":"string",
770+
"enum":["BLOCKED"]
771+
},
772+
"GuardrailContentPolicyAssessment":{
773+
"type":"structure",
774+
"members":{
775+
"filters":{
776+
"shape":"GuardrailContentFilterList",
777+
"documentation":"<p>The filter details of the policy assessment used in the Guardrails filter.</p>"
778+
}
779+
},
780+
"documentation":"<p>The details of the policy assessment in the Guardrails filter.</p>",
781+
"sensitive":true
782+
},
783+
"GuardrailCustomWord":{
784+
"type":"structure",
785+
"members":{
786+
"action":{
787+
"shape":"GuardrailWordPolicyAction",
788+
"documentation":"<p>The action details for the custom word filter in the Guardrail.</p>"
789+
},
790+
"match":{
791+
"shape":"String",
792+
"documentation":"<p>The match details for the custom word filter in the Guardrail.</p>"
793+
}
794+
},
795+
"documentation":"<p>The custom word details for the filter in the Guardrail.</p>",
796+
"sensitive":true
797+
},
798+
"GuardrailCustomWordList":{
799+
"type":"list",
800+
"member":{"shape":"GuardrailCustomWord"},
801+
"sensitive":true
802+
},
803+
"GuardrailManagedWord":{
804+
"type":"structure",
805+
"members":{
806+
"action":{
807+
"shape":"GuardrailWordPolicyAction",
808+
"documentation":"<p>The action details for the managed word filter in the Guardrail.</p>"
809+
},
810+
"match":{
811+
"shape":"String",
812+
"documentation":"<p>The match details for the managed word filter in the Guardrail.</p>"
813+
},
814+
"type":{
815+
"shape":"GuardrailManagedWordType",
816+
"documentation":"<p>The type details for the managed word filter in the Guardrail.</p>"
817+
}
818+
},
819+
"documentation":"<p>The managed word details for the filter in the Guardrail.</p>",
820+
"sensitive":true
821+
},
822+
"GuardrailManagedWordList":{
823+
"type":"list",
824+
"member":{"shape":"GuardrailManagedWord"},
825+
"sensitive":true
826+
},
827+
"GuardrailManagedWordType":{
828+
"type":"string",
829+
"enum":["PROFANITY"]
830+
},
831+
"GuardrailPiiEntityFilter":{
832+
"type":"structure",
833+
"members":{
834+
"action":{
835+
"shape":"GuardrailSensitiveInformationPolicyAction",
836+
"documentation":"<p>The action of the Guardrail filter to identify and remove PII.</p>"
837+
},
838+
"match":{
839+
"shape":"String",
840+
"documentation":"<p>The match to settings in the Guardrail filter to identify and remove PII.</p>"
841+
},
842+
"type":{
843+
"shape":"GuardrailPiiEntityType",
844+
"documentation":"<p>The type of PII the Guardrail filter has identified and removed.</p>"
845+
}
846+
},
847+
"documentation":"<p>The Guardrail filter to identify and remove personally identifiable information (PII).</p>",
848+
"sensitive":true
849+
},
850+
"GuardrailPiiEntityFilterList":{
851+
"type":"list",
852+
"member":{"shape":"GuardrailPiiEntityFilter"},
853+
"sensitive":true
854+
},
855+
"GuardrailPiiEntityType":{
856+
"type":"string",
857+
"enum":[
858+
"ADDRESS",
859+
"AGE",
860+
"AWS_ACCESS_KEY",
861+
"AWS_SECRET_KEY",
862+
"CA_HEALTH_NUMBER",
863+
"CA_SOCIAL_INSURANCE_NUMBER",
864+
"CREDIT_DEBIT_CARD_CVV",
865+
"CREDIT_DEBIT_CARD_EXPIRY",
866+
"CREDIT_DEBIT_CARD_NUMBER",
867+
"DRIVER_ID",
868+
"EMAIL",
869+
"INTERNATIONAL_BANK_ACCOUNT_NUMBER",
870+
"IP_ADDRESS",
871+
"LICENSE_PLATE",
872+
"MAC_ADDRESS",
873+
"NAME",
874+
"PASSWORD",
875+
"PHONE",
876+
"PIN",
877+
"SWIFT_CODE",
878+
"UK_NATIONAL_HEALTH_SERVICE_NUMBER",
879+
"UK_NATIONAL_INSURANCE_NUMBER",
880+
"UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER",
881+
"URL",
882+
"USERNAME",
883+
"US_BANK_ACCOUNT_NUMBER",
884+
"US_BANK_ROUTING_NUMBER",
885+
"US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER",
886+
"US_PASSPORT_NUMBER",
887+
"US_SOCIAL_SECURITY_NUMBER",
888+
"VEHICLE_IDENTIFICATION_NUMBER"
889+
]
890+
},
891+
"GuardrailRegexFilter":{
892+
"type":"structure",
893+
"members":{
894+
"action":{
895+
"shape":"GuardrailSensitiveInformationPolicyAction",
896+
"documentation":"<p>The action details for the regex filter used in the Guardrail.</p>"
897+
},
898+
"match":{
899+
"shape":"String",
900+
"documentation":"<p>The match details for the regex filter used in the Guardrail.</p>"
901+
},
902+
"name":{
903+
"shape":"String",
904+
"documentation":"<p>The name details for the regex filter used in the Guardrail.</p>"
905+
},
906+
"regex":{
907+
"shape":"String",
908+
"documentation":"<p>The regex details for the regex filter used in the Guardrail.</p>"
909+
}
910+
},
911+
"documentation":"<p>The details for the regex filter used in the Guardrail.</p>",
912+
"sensitive":true
913+
},
914+
"GuardrailRegexFilterList":{
915+
"type":"list",
916+
"member":{"shape":"GuardrailRegexFilter"},
917+
"sensitive":true
918+
},
919+
"GuardrailSensitiveInformationPolicyAction":{
920+
"type":"string",
921+
"enum":[
922+
"BLOCKED",
923+
"ANONYMIZED"
924+
]
925+
},
926+
"GuardrailSensitiveInformationPolicyAssessment":{
927+
"type":"structure",
928+
"members":{
929+
"piiEntities":{
930+
"shape":"GuardrailPiiEntityFilterList",
931+
"documentation":"<p>The details of the PII entities used in the sensitive policy assessment for the Guardrail.</p>"
932+
},
933+
"regexes":{
934+
"shape":"GuardrailRegexFilterList",
935+
"documentation":"<p>The details of the regexes used in the sensitive policy assessment for the Guardrail.</p>"
936+
}
937+
},
938+
"documentation":"<p>The details of the sensitive policy assessment used in the Guardrail.</p>",
939+
"sensitive":true
940+
},
941+
"GuardrailTopic":{
942+
"type":"structure",
943+
"members":{
944+
"action":{
945+
"shape":"GuardrailTopicPolicyAction",
946+
"documentation":"<p>The action details on a specific topic in the Guardrail.</p>"
947+
},
948+
"name":{
949+
"shape":"String",
950+
"documentation":"<p>The name details on a specific topic in the Guardrail.</p>"
951+
},
952+
"type":{
953+
"shape":"GuardrailTopicType",
954+
"documentation":"<p>The type details on a specific topic in the Guardrail.</p>"
955+
}
956+
},
957+
"documentation":"<p>The details for a specific topic defined in the Guardrail.</p>",
958+
"sensitive":true
959+
},
960+
"GuardrailTopicList":{
961+
"type":"list",
962+
"member":{"shape":"GuardrailTopic"},
963+
"sensitive":true
964+
},
965+
"GuardrailTopicPolicyAction":{
966+
"type":"string",
967+
"enum":["BLOCKED"]
968+
},
969+
"GuardrailTopicPolicyAssessment":{
970+
"type":"structure",
971+
"members":{
972+
"topics":{
973+
"shape":"GuardrailTopicList",
974+
"documentation":"<p>The topic details of the policy assessment used in the Guardrail.</p>"
975+
}
976+
},
977+
"documentation":"<p>The details of the policy assessment used in the Guardrail.</p>",
978+
"sensitive":true
979+
},
980+
"GuardrailTopicType":{
981+
"type":"string",
982+
"enum":["DENY"]
983+
},
984+
"GuardrailTrace":{
985+
"type":"structure",
986+
"members":{
987+
"action":{
988+
"shape":"GuardrailAction",
989+
"documentation":"<p>The trace action details used with the Guardrail.</p>"
990+
},
991+
"inputAssessments":{
992+
"shape":"GuardrailAssessmentList",
993+
"documentation":"<p>The details of the input assessments used in the Guardrail Trace.</p>"
994+
},
995+
"outputAssessments":{
996+
"shape":"GuardrailAssessmentList",
997+
"documentation":"<p>The details of the output assessments used in the Guardrail Trace.</p>"
998+
},
999+
"traceId":{
1000+
"shape":"TraceId",
1001+
"documentation":"<p>The details of the trace Id used in the Guardrail Trace.</p>"
1002+
}
1003+
},
1004+
"documentation":"<p>The trace details used in the Guardrail.</p>",
1005+
"sensitive":true
1006+
},
1007+
"GuardrailWordPolicyAction":{
1008+
"type":"string",
1009+
"enum":["BLOCKED"]
1010+
},
1011+
"GuardrailWordPolicyAssessment":{
1012+
"type":"structure",
1013+
"members":{
1014+
"customWords":{
1015+
"shape":"GuardrailCustomWordList",
1016+
"documentation":"<p>The custom word details for words defined in the Guardrail filter.</p>"
1017+
},
1018+
"managedWordLists":{
1019+
"shape":"GuardrailManagedWordList",
1020+
"documentation":"<p>The managed word lists for words defined in the Guardrail filter.</p>"
1021+
}
1022+
},
1023+
"documentation":"<p>The assessment details for words defined in the Guardrail filter.</p>",
1024+
"sensitive":true
1025+
},
6901026
"Identifier":{
6911027
"type":"string",
6921028
"max":1024,
@@ -1973,6 +2309,10 @@
19732309
"shape":"FailureTrace",
19742310
"documentation":"<p>Contains information about the failure of the interaction.</p>"
19752311
},
2312+
"guardrailTrace":{
2313+
"shape":"GuardrailTrace",
2314+
"documentation":"<p>The trace details for a trace defined in the Guardrail filter.</p>"
2315+
},
19762316
"orchestrationTrace":{
19772317
"shape":"OrchestrationTrace",
19782318
"documentation":"<p>Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.</p>"

0 commit comments

Comments
 (0)