o ưi @s~dZddlZddlZddlZddlmZmZddlmZm Z m Z m Z m Z m Z mZmZddlmZddlmZmZmZddlmZddlmZdd lmZdd lmZdd lmZdd l m!Z!m"Z"dd l#m$Z$ddl%m&Z&m'Z'ddl(m)Z)ddl*m+Z+ddl,m-Z.ddl/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8m9Z9m:Z:m;Z;mZ>m?Z?m@Z@mAZAeZ-e+ZBde e de:fddZCe-jDddgee$ge:dddZEe-jDddgee$ge:dddZFGdd d eZGe-jHd!dgd"ee$fd#eGd$e"fd%d&ZIGd'd(d(eZJe-jKd)dgd"ee$fd*eLd#eJd$e"fd+d,ZMe-jNd)dgd"ee$fd*eLd$e"fd-d.ZOd/ZPGd0d1d1eZQGd2d3d3eZRGd4d5d5eZSGd6d7d7eZTGd8d9d9eZUe-jHd:dgeRd;ee$fd#eQd$e"fdede e eLeffd?d@ZWdAedeTfdBdCZXe-jDdDdgeUd;dddee$fdEe eLdFe eLdGe eLd$e"fdHdIZYe-jDdJdgeTd;ee$fd*eLd$e"fdKdLZZe-jHdMdgd"ee$fd*eLd$e"fdNdOZ[e-jHdPdgd"ee$fd*eLd$e"fdQdRZ\e-j]d)dgd"ee$fd*eLd#eg}|D]}|t|d|d|ddqt|dS)z= Helper function to get the guardrails list response guardrail_namelitellm_paramsguardrail_info)r1r2r3 guardrails)appendr$getr')r/guardrail_configs guardrailr:c/home/app/Keep/.python/lib/python3.10/site-packages/litellm/proxy/guardrails/guardrail_endpoints.py_get_guardrails_list_response9s r<z/guardrails/listZ Guardrails)tags dependenciesresponse_modelcsDddlm}|j}tttt|d}|durtgSt|S)ur List the guardrails that are available on the proxy server 👉 [Guardrail docs](https://docs.litellm.ai/docs/proxy/guardrails/quick_start) Example Request: ```bash curl -X GET "http://localhost:4000/guardrails/list" -H "Authorization: Bearer " ``` Example Response: ```json { "guardrails": [ { "guardrail_name": "bedrock-pre-guard", "guardrail_info": { "params": [ { "name": "toxicity_score", "type": "float", "description": "Score between 0-1 indicating content toxicity level" }, { "name": "pii_detection", "type": "boolean" } ] } } ] } ``` r) proxy_configr5N) litellm.proxy.proxy_serverr@configr rlistdictr7r<)r@rBZ_guardrails_configr:r:r;list_guardrailsKs )rEz/v2/guardrails/listc sddlm}ddlm}ddlm}|durtdddztj|dIdH}g}t }|D]M}| d }t |t r@|j d d n|pCi}||d d d } | rTtdi| nd} |t| d| d| | d| d| ddd|| dq.|} | D]P}| d|vr| d } t | t r| j d d n| pi} || d d d }|rtdi|nd}|t| d| d|t| dpidd|| dqt|dWSty}ztd|tdt|dd}~ww)u List the guardrails that are available in the database using GuardrailRegistry 👉 [Guardrail docs](https://docs.litellm.ai/docs/proxy/guardrails/quick_start) Example Request: ```bash curl -X GET "http://localhost:4000/v2/guardrails/list" -H "Authorization: Bearer " ``` Example Response: ```json { "guardrails": [ { "guardrail_id": "123e4567-e89b-12d3-a456-426614174000", "guardrail_name": "my-bedrock-guard", "litellm_params": { "guardrail": "bedrock", "mode": "pre_call", "guardrailIdentifier": "ff6ujrregl1q", "guardrailVersion": "DRAFT", "default_on": true }, "guardrail_info": { "description": "Bedrock content moderation guardrail" } } ] } ``` r_get_masked_valuesIN_MEMORY_GUARDRAIL_HANDLER prisma_clientNPrisma client not initialized status_codedetailr2TZ exclude_noneZunmasked_lengthZnumber_of_asterisks guardrail_idr1r3 created_at updated_atdbrTr1r2r3rUrVguardrail_definition_locationrB)rTr1r2r3rYr4z"Error getting guardrails from db: r:)*litellm.litellm_core_utils.litellm_loggingrG+litellm.proxy.guardrails.guardrail_registryrIrArKrGUARDRAIL_REGISTRYZget_all_guardrails_from_dbsetr7 isinstancer( model_dumpr r6r$addZlist_in_memory_guardrailsrDr' Exceptionr exceptionstr)rGrIrKr5r8Zseen_guardrail_idsr9r2litellm_params_dictmasked_litellm_params_dictmasked_litellm_paramsZin_memory_guardrailsZin_memory_litellm_params_rawZin_memory_litellm_params_dictZmasked_in_memory_litellm_paramsZ%masked_in_memory_litellm_params_typeder:r:r;list_guardrails_v2s '        rhc@eZdZUeed<dS)CreateGuardrailRequestr9N__name__ __module__ __qualname__r"__annotations__r:r:r:r;rj rjz /guardrails)r=requestuser_api_key_dictc s&ddlm}ddlm}|jtjkrtddd|dur#tdd dzStj |j |d IdH}| d d }| d d }z|j t t|dtd|d|dW|WStyv}ztd|d|d|WYd}~|WSd}~wwty}ztd|tdt|dd}~ww)u Create a new guardrail 👉 [Guardrail docs](https://docs.litellm.ai/docs/proxy/guardrails/quick_start) Example Request: ```bash curl -X POST "http://localhost:4000/guardrails" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "guardrail": { "guardrail_name": "my-bedrock-guard", "litellm_params": { "guardrail": "bedrock", "mode": "pre_call", "guardrailIdentifier": "ff6ujrregl1q", "guardrailVersion": "DRAFT", "default_on": true }, "guardrail_info": { "description": "Bedrock content moderation guardrail" } } }' ``` Example Response: ```json { "guardrail_id": "123e4567-e89b-12d3-a456-426614174000", "guardrail_name": "my-bedrock-guard", "litellm_params": { "guardrail": "bedrock", "mode": "pre_call", "guardrailIdentifier": "ff6ujrregl1q", "guardrailVersion": "DRAFT", "default_on": true }, "guardrail_info": { "description": "Bedrock content moderation guardrail" }, "created_at": "2023-11-09T12:34:56.789Z", "updated_at": "2023-11-09T12:34:56.789Z" } ``` rrHrJ*Admin access required to manage guardrailsrNNrLrM)r9rKr1UnknownrTr9z4Immediate sync: Successfully initialized guardrail '' (ID: )z0Immediate sync: Failed to initialize guardrail ' ) in memory: zError adding guardrail to db: )r[rIrArK user_roler PROXY_ADMINrr\Zadd_guardrail_to_dbr9r7initialize_guardrailr r"rinforawarningrbrc) rqrrrIrKresultr1rTZ init_errorrgr:r:r;create_guardrailsH 7     rc@ri)UpdateGuardrailRequestr9Nrkr:r:r:r;r\rprz/guardrails/{guardrail_id}rTc sXddlm}ddlm}|jtjkrtddd|dur#tdd dzgtj ||d IdH}|dur" \ -H "Content-Type: application/json" \ -d '{ "guardrail": { "guardrail_name": "updated-bedrock-guard", "litellm_params": { "guardrail": "bedrock", "mode": "pre_call", "guardrailIdentifier": "ff6ujrregl1q", "guardrailVersion": "1.0", "default_on": true }, "guardrail_info": { "description": "Updated Bedrock content moderation guardrail" } } }' ``` Example Response: ```json { "guardrail_id": "123e4567-e89b-12d3-a456-426614174000", "guardrail_name": "updated-bedrock-guard", "litellm_params": { "guardrail": "bedrock", "mode": "pre_call", "guardrailIdentifier": "ff6ujrregl1q", "guardrailVersion": "1.0", "default_on": true }, "guardrail_info": { "description": "Updated Bedrock content moderation guardrail" }, "created_at": "2023-11-09T12:34:56.789Z", "updated_at": "2023-11-09T13:45:12.345Z" } ``` rrHrJrsrtrNNrLrMrTrKGuardrail with ID not foundrTr9rKr1ru)rTr90Immediate sync: Successfully updated guardrail 'rwrx"Immediate sync: Failed to update 'ry)r[rIrArKrzrr{rr\get_guardrail_by_id_from_dbupdate_guardrail_in_dbr9r7Zupdate_in_memory_guardrailr r"rr}rar~rc) rTrqrrrIrKexisting_guardrailrr1 update_errorrgr:r:r;update_guardrail`s\ 8       rc sLddlm}ddlm}|jtjkrtddd|dur#tdd dzatj ||d IdH}|dur" ``` Example Response: ```json { "message": "Guardrail 123e4567-e89b-12d3-a456-426614174000 deleted successfully" } ``` rrHrJrsrtrNNrLrMrrrrr1rurTz0Immediate sync: Successfully removed guardrail 'rwz ) from memoryz,Immediate sync: Failed to remove guardrail 'z) from memory: )r[rIrArKrzrr{rr\rZdelete_guardrail_from_dbr7Zdelete_in_memory_guardrailrr}rar~rc) rTrrrIrKrrr1Z delete_errorrgr:r:r;delete_guardrailsX       rZgeneric_guardrail_apic@sXeZdZUdZeed<eeefed<dZe eeefed<deeeffddZ dS) RegisterGuardrailRequestzQRequest body for POST /guardrails/register. Follows Generic Guardrail API config.r1r2Nr3r0cCs t|jSN)rDr2)selfr:r:r;get_litellm_params_dict"s z0RegisterGuardrailRequest.get_litellm_params_dict) rlrmrn__doc__rcrorrr3rrr:r:r:r;rs rc@s6eZdZUeed<eed<eed<dZeeed<dS)RegisterGuardrailResponserTr1statusN submitted_at)rlrmrnrcrorrrr:r:r:r;r&s rc@s.eZdZUeed<eed<eed<eed<dS)GuardrailSubmissionSummarytotalpending_reviewactiverejectedN)rlrmrnintror:r:r:r;r-s  rc@seZdZUeed<eed<eed<dZeeed<dZeed<dZ ee ee fed<dZ ee ee fed <dZ eeed <dZeeed <dZeeed <dZeeed <dZeeed<dZeeed<dS)GuardrailSubmissionItemrTr1rNteam_idFteam_guardrailr2r3submitted_by_user_idsubmitted_by_emailr reviewed_atrUrV)rlrmrnrcrorrrboolr2rrr3rrrrrrUrVr:r:r:r;r4s  rc@s"eZdZUeeed<eed<dS) ListGuardrailSubmissionsResponse submissionssummaryN)rlrmrnrrrorr:r:r:r;rFs  rz/guardrails/register)r=r?c s ddlm}|durtddd|jstddd|}|d tkr/tdd td d|d }|sz-list_guardrail_submissions..css"|] }|jpddkrdVqdS)rrNrrr:r:r;rrcsr)rrrNrrr:r:r;rrcg|] }|jkr|qSr:rrrr:r; z.list_guardrail_submissions..crr:rrrr:r;r rcsfg|]/}|jp dvs/t|jtr"t|jpiddvs/t|jtr1|jvr|qS) description)r1lowerr^r3rDrcr7r) search_lowerr:r;rs   cSsg|]}t|qSr:)rrr:r:r;rs)rrrr)rrz'Error listing guardrail submissions: %s)rArKrzrr{rrWrZ find_manylensumrrrrarrbrc) rrrrrrKZ all_team_rowsrr active_countrrowsitemsrgr:)rrrr;list_guardrail_submissionss\        rz&/guardrails/submissions/{guardrail_id}c sddlm}|jtjkrtddd|durtdddz|jjjd |id IdH}|dur5td d dt |WStyAt yZ}zt d |tdt |dd}~ww)z5Get a single guardrail submission by id (admin only).rrJrsrrNNrLrMrTrrGuardrail submission not foundz&Error getting guardrail submission: %s)rArKrzrr{rrWrrrrarrbrc)rTrrrKrrgr:r:r;get_guardrail_submission.s,       rz./guardrails/submissions/{guardrail_id}/approvec sddlm}ddlm}|jtjkrtddd|dur#tdd dz|jj j d |id IdH}|dur;td d d|j dkrKtdd|j ddt tj}|jj jd |id||ddIdHt|j}t|j}|sutddd|j|j||p}id}z|jtt|dtd|j|Wn%ty} ztd|| |ddd| ddWYd} ~ WSd} ~ ww|dddWStyty} ztd| tdt| dd} ~ ww) zcApprove a pending guardrail submission: set status to active and initialize in memory (admin only).rrHrJrsrrNNrLrMrTrrrrr(Guardrail is not pending review (status=rxrrrrVrrz.Guardrail litellm_params is missing or invalidrTr1r2r3rvz8Approved guardrail %s (ID: %s) and initialized in memoryz8Failed to initialize approved guardrail %s in memory: %szGuardrail approvedz@Guardrail was marked active but failed to initialize in memory: z.. It will be picked up on the next sync cycle.)rTrmessager~rTrrz(Error approving guardrail submission: %s)r[rIrArKrzrr{rrWrrrrrrrupdaterr2r3rTr1r|r r"rr}rar~rbrc) rTrrrIrKrrr2r3Zguardrail_dictZinit_errrgr:r:r;approve_guardrail_submissionPs              rz-/guardrails/submissions/{guardrail_id}/rejectc s ddlm}|jtjkrtddd|durtdddzF|jjjd |id IdH}|dur5td d d|j d krEtdd|j ddt t j }|jjjd |id||ddIdH|dddWStykty}ztd|tdt|dd}~ww)z+Reject a guardrail submission (admin only).rrJrsrrNNrLrMrTrrrrrrrxrrrzGuardrail rejectedrz(Error rejecting guardrail submission: %s)rArKrzrr{rrWrrrrrrrrrarrbrc)rTrrrKrrrgr:r:r;reject_guardrail_submissionsF           rc sddlm}ddlm}|jtjkrtddd|dur#tdd dztj ||d IdH}|dur" \ -H "Content-Type: application/json" \ -d '{ "guardrail_name": "updated-name", "default_on": true, "guardrail_info": { "description": "Updated description" } }' ``` Example Response: ```json { "guardrail_id": "123e4567-e89b-12d3-a456-426614174000", "guardrail_name": "updated-name", "litellm_params": { "guardrail": "bedrock", "mode": "pre_call", "guardrailIdentifier": "ff6ujrregl1q", "guardrailVersion": "DRAFT", "default_on": true }, "guardrail_info": { "description": "Updated description" }, "created_at": "2023-11-09T12:34:56.789Z", "updated_at": "2023-11-09T14:22:33.456Z" } ``` rrHrJrsrtrNNrLrMrrrrr1r2T)Z exclude_unsetr3rrrrurvrrwrxrryzError updating guardrail: r:)r[rIrArKrzrr{rr\rr1r7r(rDr2r_rr3r"rZsync_guardrail_from_dbrr}rar~rbrc)rTrqrrrIrKrr1r2Zrequested_litellm_paramsrdr3r9rrrgr:r:r;patch_guardrails 6            r)r=r>z/guardrails/{guardrail_id}/infoc sdddlm}ddlm}ddlm}ddlm}|dur#tddd zm|j }t j ||d IdH}|dur>|j |d }|j }|durLtd d |dd |d}t|tr\|jddn|p_i}||ddd} | rptdi| nd} t|d|d| t|dpi|d|d|dWSty} z| d} ~ wty} ztdt| d d} ~ ww)u Get detailed information about a specific guardrail by ID 👉 [Guardrail docs](https://docs.litellm.ai/docs/proxy/guardrails/quick_start) Example Request: ```bash curl -X GET "http://localhost:4000/guardrails/123e4567-e89b-12d3-a456-426614174000/info" \ -H "Authorization: Bearer " ``` Example Response: ```json { "guardrail_id": "123e4567-e89b-12d3-a456-426614174000", "guardrail_name": "my-bedrock-guard", "litellm_params": { "guardrail": "bedrock", "mode": "pre_call", "guardrailIdentifier": "ff6ujrregl1q", "guardrailVersion": "DRAFT", "default_on": true }, "guardrail_info": { "description": "Bedrock content moderation guardrail" }, "created_at": "2023-11-09T12:34:56.789Z", "updated_at": "2023-11-09T12:34:56.789Z" } ``` rrFrHrJ)GUARDRAIL_DEFINITION_LOCATIONNrLrMrNrrrrrr2TrQrRrSrTr1r3rUrVrXr:)rZrGr[rIrArKlitellm.types.guardrailsrrZDBr\rZget_guardrail_by_idZCONFIGr7r^r(r_r r$rDrarc) rTrGrIrKrrYrr2Zresult_litellm_params_dictrerfrgr:r:r;get_guardrail_info`sp +       rz%/guardrails/ui/add_guardrail_settingsc sddlm}m}m}g}tD]\}}||jdd|Ddqtddt Dddt Dddt D||t | d d g|d d S) z Get the UI settings for the guardrails Returns: - Supported entities for guardrails - Supported modes for guardrails - PII entity categories for UI organization - Content filter settings (patterns and categories) r)PATTERN_CATEGORIES get_available_content_categoriesget_pattern_metadatacSg|]}|jqSr:rrentityr:r:r;rz-get_guardrail_ui_settings..)categoryentitiescSrr:rrr:r:r;rrcSrr:r)ractionr:r:r;rrcSrr:r)rrr:r:r;rrBLOCKMASK)Zprebuilt_patternsZpattern_categoriessupported_actionsZcontent_categories)Zsupported_entitiesrZsupported_modesZpii_entity_categoriesZcontent_filter_settings)ZHlitellm.proxy.guardrails.guardrail_hooks.litellm_content_filter.patternsrrrrrr6rr%r+r*r#rCkeys)rrrZ category_mapsrrr:r:r;get_guardrail_ui_settingss(     rz,/guardrails/ui/category_yaml/{category_name} category_namec sddl}|j|jtddd}|j||d}|j||d}d}d}|j|r5|}d}n|j|r@|}d }n td d |d d z t|d }|}Wdn1s_wY|||dWSt y} z tddt | d d} ~ ww)a Get the YAML or JSON content for a specific content filter category. Args: category_name: The name of the category (e.g., "bias_gender", "harmful_self_harm") Returns: The raw YAML or JSON content of the category file with file type indicator rNguardrail_hookslitellm_content_filter categoriesz.yamlz.jsonyamlrrzCategory file not found: z (tried .yaml and .json)rNr)rZ yaml_content file_typerLzError reading category file: ) ospathjoindirname__file__existsropenreadrarc) rrZcategories_dirZ yaml_pathZ json_pathZcategory_file_pathrfcontentrgr:r:r;get_category_yamlsH      rz/guardrails/ui/major_airlinesc sddl}|j|jtdddd}|j|stddd z%t|d d d }ddl}| |}Wdn1s;wYd |iWSt y\}z tddt |d |d}~ww)z Get the major airlines list from IATA (competitor intent, airline type). Returns airline id, match variants (pipe-separated), and tags. rNrrZcompetitor_intentzmajor_airlines.jsonrzmajor_airlines.json not foundrNrzutf-8)encodingairlinesrLz#Error reading major_airlines.json: ) rrrrrr rr rloadrarc)rZ airlines_pathr rrrgr:r:r;get_major_airlines0s8     rz'/guardrails/validate_blocked_words_filec sddl}z|dd}|sdddWS||}t|tr"d|vr(dd dWS|d}t|ts7dd dWSg}t|D]g\}}t|tsP|d |d q=d |vr^|d |dnt|d tsn|d |dd|vr||d |dn|ddvr|d |d|ddd|vrt|dts|d |dq=|rd|dWSddt |ddWS|j y}zddt|dWYd}~Sd}~wt y}zt dddt|dWYd}~Sd}~ww)a Validate a blocked_words YAML file content. Args: request: Dictionary with 'file_content' key containing the YAML string Returns: Dictionary with 'valid' boolean and either 'message'/'errors' depending on result Example Request: ```json { "file_content": "blocked_words:\n - keyword: \"test\"\n action: \"BLOCK\"" } ``` Example Success Response: ```json { "valid": true, "message": "Valid YAML file with 2 blocked words" } ``` Example Error Response: ```json { "valid": false, "errors": ["Entry 0: missing 'action' field"] } ``` rN file_contentrFzNo file content provided)validerrorZ blocked_wordszAInvalid format: file must contain 'blocked_words' key with a listz'blocked_words' must be a listzEntry z: must be an objectkeywordz: missing 'keyword' fieldz: 'keyword' must be a stringrz: missing 'action' field)rrz): action must be 'BLOCK' or 'MASK', got ''rz : 'description' must be a string)rerrorsTzValid YAML file with z blocked word(s))rrzInvalid YAML syntax: z#Error validating blocked words filezValidation error: )rr7Z safe_loadr^rDrC enumerater6rcrZ YAMLErrorrarrb) rqrrrZblocked_words_listridxZ word_datargr:r:r;validate_blocked_words_fileTs^&            rfield_annotationcCst|dr|jturt|dr|j}dd|D}|r|d}t|dr+|jtur+dSt|dr7|jtur7dSt|drPt|drP|j}t|drP|jd krPd S|turVd S|tur\d S|t urbd S|t urhd S|turndS|turtdSd S)zG Convert a Python type annotation to a UI-friendly type string __origin____args__cSg|] }|tdur|qSrtyperargr:r:r;rz3_get_field_type_from_annotation..rarrayrDrlLiteralselectstringnumberbooleanobject) hasattrrr rrCrDrlrcrfloatr)rargs non_none_argsoriginr:r:r;_get_field_type_from_annotations@  r1 annotationcCs<t|drt|dr|j}t|dr|jdkrt|jSgS)z? Extract literal values from a Literal type annotation rrrlr&)r,rrlrCr)r2r0r:r:r;_extract_literal_valuess  r3cCDt|dr |jtur t|dr |j}t|dkr |d}t|SdS)z> Extract key options from Dict[Literal[...], T] types rrrN)r,rrDrrr3)rr.Zkey_typer:r:r;_get_dict_key_options  r6cCr4)z2 Get the value type from Dict[K, V] types rrr5rr()r,rrDrrr1)rr. value_typer:r:r;_get_dict_value_typer7r9cCr4)z? Extract element options from List[Literal[...]] types rrrrN)r,rrCrrr3)rr.Z element_typer:r:r;_get_list_element_optionsr7r: field_namecCs|dkrdS|dur dSt|tst|dr|jturdSt|dr)|jdvr)dSt|drAd d |jD}|rAt|d trAdSdS) zOCheck if optional_params field should be skipped (not meaningfully overridden).Zoptional_paramsFNTrrl)Tr rcSrrr r"r:r:r;r9sz0_should_skip_optional_params..r)r^r r,rrlr)r;rr/r:r:r;_should_skip_optional_params!s$   r=cCsBt|dr|jturt|dr|j}dd|D}|r|dS|S)z-Unwrap Optional types to get the actual type.rrcSrrr r"r:r:r;rKr$z)_unwrap_optional_type..r)r,rr r)rr.r/r:r:r;_unwrap_optional_typeBs r>fieldrrequiredc Cs*t|}t|di}|rd|vr|d}t|dr|jn|}n |r)d|vr)|d}|||d}|dkrFt|}|r=||d<t|} | |d<n|d krXt|} | rX| |d <d |d<|red |vre|d |d <n|d krst|} | rs| |d <|jd ur|jdur|j|d<|rdD] } | |vr|| || <q|S)z-Build field dictionary for non-nested fields.Zjson_schema_extraui_typerr!)rr@r!rDdict_key_optionsdict_value_typer%optionsZ multiselectr'N. default_value)minmaxsteprE) r1rr,rr6r9r:r3default) r?rrr@Z field_typeZfield_json_schema_extrarAZ field_dictrBrCZlist_element_optionsZliteral_optionskeyr:r:r;_build_field_dictQsH       rKmodeldepthc Cs|tkrtddtddi}|jD]Q\}}|j}t||dr#q|dur(qt|d}|jp1|}|}t |oCt |t oC|t u}|r\t ttt ||d} ||d| d ||<qt||||d ||<q|S) Nrz Max depth of z` exceeded while processing model fields. Please check the model structure for excessive nesting.rN)r;r)rrnested)rr@r!fields)r?rrr@)rrZ model_fieldsrr2r=r>rZ is_requiredinspectisclass issubclassr_extract_fields_recursiver rrK) rLrMrOr;r?rrr@Zis_basemodel_subclassZ nested_fieldsr:r:r;rSsL      rS model_classcCs t|ddS)zO Get the fields from a Pydantic model as a nested dictionary structure r)rM)rS)rTr:r:r;_get_fields_from_models rUz'/guardrails/ui/provider_specific_paramsc stt}tt}tt}tt}t|d<tjj|tj j|tj j|tj j|i}ddl m }|D]\}}|}|rMt|} |} | | d<| ||<q3|S)a Get provider-specific parameters for different guardrail types. Returns a dictionary mapping guardrail providers to their specific parameters, including parameter names, descriptions, and whether they are required. Example Response: ```json { "bedrock": { "guardrailIdentifier": { "description": "The ID of your guardrail on Bedrock", "required": true, "type": null }, "guardrailVersion": { "description": "The version of your Bedrock guardrail (e.g., DRAFT or version number)", "required": true, "type": null } }, "azure_content_safety_text_moderation": { "api_key": { "description": "API key for the Azure Content Safety Text Moderation guardrail", "required": false, "type": null }, "optional_params": { "description": "Optional parameters for the Azure Content Safety Text Moderation guardrail", "required": true, "type": "nested", "fields": { "severity_threshold": { "description": "Severity threshold for the Azure Content Safety Text Moderation guardrail across all categories", "required": false, "type": null }, "categories": { "description": "Categories to scan for the Azure Content Safety Text Moderation guardrail", "required": false, "type": "multiselect", "options": ["Hate", "SelfHarm", "Sexual", "Violence"], "default_value": None } } } } } ``` ui_friendly_namer)guardrail_class_registry)rUr!r,r&r.rVr-ZBEDROCKrZPRESIDIOZ LAKERA_V2ZTOOL_PERMISSIONr[rWrZget_config_model) Zbedrock_fieldsZpresidio_fieldsZlakera_v2_fieldsZtool_permission_fieldsZprovider_paramsrWr1Zguardrail_classZguardrail_config_modelrOrVr:r:r;get_provider_specific_paramss,9 rXc@sTeZdZUdZeed< eeefed< dZeed< dZ e eeefed<dS)TestCustomCodeGuardrailRequestz1Request model for testing custom code guardrails. custom_code test_inputrq input_typeN request_data) rlrmrnrrcrorrr\r]rr:r:r:r;rY0s  rYc@sXeZdZUdZeed< dZeee e fed< dZ ee ed< dZ ee ed<dS)TestCustomCodeGuardrailResponsez2Response model for testing custom code guardrails.successNrr error_type) rlrmrnrrrorrrrcrrr`r:r:r:r;r^@s r^z/guardrails/test_custom_codec s|jtjkr tdddd}zFztjWnty4}ztdt|ddWYd}~WSd}~wwt }i|d <z t t jd d |Wn9t yg}ztdd |ddWYd}~WSd}~wty}ztdd |ddWYd}~WSd}~wwd|vrtddddWS|dtstddddWSjdvrgd<jpi}|dd|d|d|d|didfdd}zHtjjdd6}||}z|j|d} Wn tjjytdd|dd dYWdWWSwWdn 1swYWnty8}ztdd!|d dWYd}~WSd}~wwt| tsPtd"d#d$t| jd%d&d'WStd"| d'WSty{}ztd(|tdd)|d dWYd}~Sd}~ww)*u Test custom code guardrail logic without creating a guardrail. This endpoint allows admins to experiment with custom code guardrails by: 1. Compiling the provided code in a sandbox 2. Executing the apply_guardrail function with test input 3. Returning the result (allow/block/modify) 👉 [Custom Code Guardrail docs](https://docs.litellm.ai/docs/proxy/guardrails/custom_code_guardrail) Example Request: ```bash curl -X POST "http://localhost:4000/guardrails/test_custom_code" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "custom_code": "def apply_guardrail(inputs, request_data, input_type):\n for text in inputs[\"texts\"]:\n if regex_match(text, r\"\\d{3}-\\d{2}-\\d{4}\"):\n return block(\"SSN detected\")\n return allow()", "test_input": { "texts": ["My SSN is 123-45-6789"] }, "input_type": "request" }' ``` Example Success Response (blocked): ```json { "success": true, "result": { "action": "block", "reason": "SSN detected" }, "error": null, "error_type": null } ``` Example Success Response (allowed): ```json { "success": true, "result": { "action": "allow" }, "error": null, "error_type": null } ``` Example Success Response (modified): ```json { "success": true, "result": { "action": "modify", "texts": ["My SSN is [REDACTED]"] }, "error": null, "error_type": null } ``` Example Error Response (compilation error): ```json { "success": false, "result": null, "error": "Syntax error in custom code: invalid syntax (, line 1)", "error_type": "compilation" } ``` rsz4Admin access required to test custom code guardrailsrNFZ compilation)r_rr`N __builtins__z execzSyntax error in custom code: zFailed to compile custom code: apply_guardrailz|Custom code must define an 'apply_guardrail' function. Expected signature: apply_guardrail(inputs, request_data, input_type)z-'apply_guardrail' must be a callable functiontextsrLz test-modelrr end_user_idmetadata)rLrrrfrgcsjSr)r\r:Zapply_fnrqZsafe_request_dataZ test_inputsr:r;execute_guardrailsz5test_custom_code_guardrail..execute_guardrailr) max_workers)timeoutz)Execution timeout: code took longer than z secondsZ executionzExecution error: TZallowzExpected dict result, got z. Treating as allow.)rr~)r_rz%Error testing custom code guardrail: zUnexpected error: )rzrr{rrrZrr^rcrcopyrccompile SyntaxErrorracallabler[r]r7 concurrentfuturesThreadPoolExecutorsubmitr TimeoutErrorr^rDr!rlrrb) rqrrZEXECUTION_TIMEOUT_SECONDSrgZ exec_globalsZmock_request_datariexecutorfuturerr:rhr;test_custom_code_guardrailPs R         rwz/guardrails/apply_guardrail)r?z/apply_guardrailc sddlm}z;tj|jd}|durtdd|jdd|jd |jgiid d IdH}|d g}t |r=|dd WS|jd WSt yR}z||d}~ww) z Apply a guardrail to text input and return the processed result. This endpoint allows testing guardrails by applying them to custom text inputs. r)handle_exception_on_proxy)r1Nrz Guardrail 'zM' not found. Please ensure the guardrail is configured in your LiteLLM proxy.rNrerq)Zinputsr]r\) response_text) Zlitellm.proxy.utilsrxr\Z"get_initialized_guardrail_callbackr1rrdtextr7rra)rqrrrxZactive_guardrailZguardrailed_inputsryrgr:r:r;rds6     rd)r)vrconcurrent.futuresrprPrrrtypingrrrrrr r r urllib.parser Zfastapir rrZpydanticrZlitellm._loggingrZlitellm.constantsrZ%litellm.integrations.custom_guardrailrZ*litellm.litellm_core_utils.safe_json_dumpsrZlitellm.proxy._typesrrZ$litellm.proxy.auth.user_api_key_authrZClitellm.proxy.guardrails.guardrail_hooks.custom_code.code_validatorrrZ?litellm.proxy.guardrails.guardrail_hooks.custom_code.primitivesrr[rZ(litellm.proxy.guardrails.usage_endpointsrZguardrails_usage_routerrrrrr r!r"r#r$r%r&r'r(r)r*r+r,r-r.r\r<r7rErhrjpostrrputrcrdeleterrrrrrrrrrrrrrpatchrrrrrrr1r3r6r9r:rr=r>rKrrSrUrXrYr^rwrdZinclude_routerr:r:r:r;s(          P  / u Y f H  g  Q  R , ] (7 Z3 !  C  = T  F &