跳到主要内容

/guardrails/apply_guardrail

使用此端点直接调用在您的 LiteLLM 实例上配置的防护措施 (guardrail)。当您的服务需要直接调用防护措施时，这非常有用。

用法​

在此示例中，mask_pii 是在 LiteLLM 上配置的防护措施名称。

调用端点示例
curl -X POST 'http://localhost:4000/guardrails/apply_guardrail' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer your-api-key' \
-d '{
    "guardrail_name": "mask_pii",
    "text": "My name is John Doe and my email is john@example.com",
    "language": "en",
    "entities": ["NAME", "EMAIL"]
}'

请求格式​

请求体应遵循 ApplyGuardrailRequest 格式。

请求体示例​

{
    "guardrail_name": "mask_pii",
    "text": "My name is John Doe and my email is john@example.com",
    "language": "en",
    "entities": ["NAME", "EMAIL"]
}

必填字段​

  • guardrail_name (string)
    要应用的防护措施标识符（例如，“mask_pii”）。
  • text (string)
    通过防护措施处理的输入文本。

可选字段​

  • language (string)
    输入文本的语言（例如，“en”代表英语）。
  • entities (字符串数组)
    要处理或过滤的特定实体（例如，["NAME", "EMAIL"]).

响应格式​

响应将包含应用防护措施后处理过的文本。

响应示例​

{
    "response_text": "My name is [REDACTED] and my email is [REDACTED]"
}

响应字段​

  • response_text (string)
    应用防护措施后的文本。