/guardrails/apply_guardrail

Verwenden Sie diesen Endpunkt, um direkt einen auf Ihrer LiteLLM-Instanz konfigurierten Guardrail aufzurufen. Dies ist nützlich, wenn Dienste einen Guardrail direkt aufrufen müssen.

Verwendung

---

In diesem Beispiel ist mask_pii der auf LiteLLM konfigurierte Guardrail-Name.

Beispiel für den Aufruf des Endpunkts

curl -X POST 'https://: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"]
}'

Anforderungsformat

---

Der Request-Body sollte dem Format von ApplyGuardrailRequest folgen.

Beispiel für den Request-Body

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

Erforderliche Felder

• guardrail_name (string)
  Der Bezeichner für den anzuwendenden Guardrail (z. B. "mask_pii").
• text (string)
  Der Eingabetext, der durch den Guardrail verarbeitet werden soll.

Optionale Felder

• language (string)
  Die Sprache des Eingabetextes (z. B. "en" für Englisch).
• entities (Array von Strings)
  Spezifische Entitäten, die verarbeitet oder gefiltert werden sollen (z. B.["NAME", "EMAIL"]).

Antwortformat

---

Die Antwort enthält den verarbeiteten Text nach Anwendung des Guardrails.

Beispielantwort

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

Antwortfelder

• response_text (string)
  Der Text nach Anwendung des Guardrails.