Richtlinie für SanitizeModelResponse

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Die Richtlinie „SanitizeModelResponse“ schützt KI-Clients vor schädlichen oder anstößigen Inhalten, indem Antworten von generativen KI-Modellen bereinigt werden. Die Richtlinie verwendet Model Armor, um Modellantworten auf schädliche oder anstößige Inhalte zu prüfen. So wird ein nativer Schutz für KI-Clients und ‑Arbeitslasten mit Apigee ermöglicht. Model Armor ist ein Google Cloud Dienst, der KI-Sicherheitsmaßnahmen bietet, um die Risiken zu minimieren, die mit Large Language Models (LLMs) verbunden sind.

Diese Richtlinie wird in Verbindung mit der SanitizeModelResponse-Richtlinie verwendet.

Diese Richtlinie ist eine erweiterbare Richtlinie, deren Verwendung je nach Apigee-Lizenz Auswirkungen auf die Kosten oder die Nutzung haben kann. Informationen zu Richtlinientypen und Auswirkungen auf die Nutzung finden Sie unter Richtlinientypen.

Hinweise

Bevor Sie die Richtlinie „SanitizeModelResponse“ verwenden können, müssen Sie die folgenden Aufgaben ausführen:

• Erstellen Sie eine Model Armor-Vorlage. Dieser Schritt muss abgeschlossen sein, bevor Sie eine SanitizeModelResponse-Richtlinie erstellen.
• Legen Sie den API-Endpunkt für den Model Armor-Dienst fest.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen für das Dienstkonto zuzuweisen, mit dem Sie Apigee-Proxys bereitstellen, um die Berechtigungen zu erhalten, die Sie zum Anwenden und Verwenden der Richtlinie „SanitizeModelResponse“ benötigen:

• Model Armor User (roles/modelarmor.user)
• Model Armor Viewer (roles/modelarmor.viewer)

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

APIs aktivieren

Enable the Model Armor APIs.

Enable the APIs

Element <SanitizeModelResponse>

Definiert eine SanitizeModelResponse-Richtlinie.

Das Element <SanitizeModelResponse> verwendet die folgende Syntax:

<SanitizeModelResponse async="false" continueOnError="false" enabled="true" name="sanitize-response">
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <DisplayName>sanitize-response-sample</DisplayName>
  <ModelArmor>
    <TemplateName>projects/{project}/locations/{location}/templates/{template-name}</TemplateName>
  </ModelArmor>
  <UserPromptSource>{jsonPath('$.contents[-1].parts[-1].text',request.content,true)}</UserPromptSource>
  <LLMResponseSource>{jsonPath($.candidates[-1].content.parts,response.content,true)}</LLMResponseSource>
</SanitizeModelResponse>

<SanitizeModelResponse async="false" continueOnError="false" enabled="true" name="sanitize-response">
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <DisplayName>sanitize-response-sample</DisplayName>
  <ModelArmor>
    <TemplateName>projects/{project}/locations/{location}/templates/{template-name}</TemplateName>
  </ModelArmor>
  <UserPromptSource>{jsonPath('$.contents[-1].parts[-1].text',request.content,true)}</UserPromptSource>
  <LLMResponseSource>{jsonPath($.candidates[-1].content.parts,response.content,true)}</LLMResponseSource>
</SanitizeModelResponse>

Dieses Element hat folgende Attribute, die allen Richtlinien gemeinsam sind:

Die folgende Tabelle enthält eine allgemeine Beschreibung der untergeordneten Elemente von <SanitizeModelResponse>:

projects/{organization.name}/locations/{system.region.name}/templates/{id}

{jsonpath('$.contents[-1].parts[-1].text',request.content,false)}

{jsonpath('$.input.prompt.text',request.content,false)}

Verweis auf untergeordnetes Element

In diesem Abschnitt werden die untergeordneten Elemente von <SanitizeModelResponse> beschrieben.

<DisplayName>

Wird zusätzlich zum Attribut name verwendet, um die Richtlinie im Proxy-Editor der Verwaltungs-UI mit einem anderen, natürlicher klingenden Namen zu versehen.

Das Element <DisplayName> ist für alle Richtlinien gleich.

Das <DisplayName>-Element verwendet die folgende Syntax:

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

Das <DisplayName>-Element hat keine Attribute oder untergeordneten Elemente.

<IgnoreUnresolvedVariables>

Bestimmt, ob die Verarbeitung beendet wird, wenn eine Variable nicht aufgelöst werden kann. Auf true festlegen, um nicht aufgelöste Variablen zu ignorieren und die Verarbeitung fortzusetzen.

<TemplateName>

Die Model Armor-Vorlage.

Das <TemplateName>-Element verwendet die folgende Syntax:

<ModelArmor>
  <TemplateName>projects/{project}/locations/{location}/templates/{template-name}</TemplateName>
</ModelArmor>

<ModelArmor>
  <TemplateName>projects/{organization.name}/locations/{system.region.name}/templates/{id}</TemplateName>
</ModelArmor>

<UserPromptSource>

Der Speicherort der Nutzlast, aus der der Text für die Nutzeraufforderung extrahiert werden soll. Es werden nur String-Textwerte unterstützt.

Dieses Feld unterstützt die Apigee-Nachrichtenvorlagensyntax, einschließlich der Verwendung von Variablen oder JSON-Pfadfunktionen. Beispiel:

{jsonpath('$.input.prompt.text',request.content,false)}

<LLMResponseSource>

Der Speicherort der Nutzlast, die aus der LLM-Antwort extrahiert werden soll. Es werden nur String-Textwerte unterstützt.

Dieses Feld unterstützt die Apigee-Nachrichtenvorlagensyntax, einschließlich der Verwendung von Variablen oder JSON-Pfadfunktionen. Beispiel:

{jsonpath('$.input.prompt.text',request.content,false)}

Ablaufvariablen

Ablaufvariablen können verwendet werden, um das dynamische Laufzeitverhalten für Richtlinien und Abläufe auf der Grundlage von HTTP-Headern oder Nachrichteninhalten oder dem Kontext zu konfigurieren, der im Ablauf verfügbar ist. Weitere Informationen zu Ablaufvariablen finden Sie in der Referenz zu Ablaufvariablen.

Die Richtlinie kann diese schreibgeschützten Variablen während der Ausführung festlegen.

Fehlerreferenz

In diesem Abschnitt werden die Fehlercodes und Fehlermeldungen beschrieben, die zurückgegeben werden, sowie die Fehlervariablen, die von Apigee für die <SanitizeModelResponse>-Richtlinie festgelegt werden. Diese Informationen sind wichtig, wenn Sie Fehlerregeln zur Verarbeitung von Fehlern entwickeln. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen und Fehler beheben.

Laufzeitfehler

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy mit dieser Richtlinie bereitstellen.

Fehlervariablen

Diese Variablen werden festgelegt, wenn diese Richtlinie zur Laufzeit einen Fehler auslöst. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Beispiel für eine Fehlerantwort

{
  "fault": {
    "faultstring": "SanitizeModelResponse[sanitize-response]: unable to resolve variable [variable_name]",
    "detail": {
      "errorcode": "steps.sanitizemodelresponse.UnresolvedVariable"
    }
  }
}

Beispiel für eine Fehlerregel

<FaultRule name="SanitizeModelResponse Faults">
    <Step>
        <Name>SMR-CustomSetVariableErrorResponse</Name>
        <Condition>(fault.name = "SetVariableFailed")</Condition>
    </Step>
    <Condition>(sanitizemodelresponse.failed = true)</Condition>
</FaultRule>

Fehlercode und Fehlermeldungen für Model Armor-Vorlagen

Die Model Armor-Vorlage unterstützt das Überschreiben von Fehlercodes und Fehlermeldungen, die von den API-Anfragen der SanitizeModelResponse-Richtlinie ausgegeben werden. Wenn der Nutzer die Überschreibungen festlegt, werden die Flussvariablen mit den Fehlercodes und Fehlermeldungen von Model Armor gefüllt.

Eine Antwort mit Model Armor-Fehlercodes und ‑Meldungen könnte beispielsweise so aussehen:

{
"sanitizationResult": {
  "filterMatchState": "MATCH_FOUND",
  "filterResults": {...},
  "sanitizationMetadata": {
    "errorCode": "890",
    "errorMessage": "get out"
  },
  "invocationResult": "SUCCESS"
  }
}

Schemas

Jeder Richtlinientyp wird durch ein XML-Schema (.xsd) definiert. Zu Referenzzwecken sind Richtlinienschemas auf GitHub verfügbar.