Maskierung einschalten

Das Gateway maskiert personenbezogene Daten auf den Endpunkten /v1/chat/completions, /v1/responses und /v1/messages. Ob es eine Anfrage maskiert, entscheiden zwei Dinge: die Maskierungsrichtlinie Ihrer Organisation und der Header X-Noirdoc-Mask der Anfrage. Wie die Maskierung arbeitet, beschreibt Maskierung.

1. Richtlinie prüfen

   Die Maskierungsrichtlinie steht unter Models → Datenschutz im Abschnitt Maskierungsrichtlinie. Admins Ihrer Organisation können sie dort ändern. Neue Organisationen starten mit default_off.

   Richtlinie	Im Portal	ohne Header	X-Noirdoc-Mask: on	X-Noirdoc-Mask: off
   default_off	Standard aus	nicht maskiert	maskiert	nicht maskiert
   default_on	Standard an	maskiert	maskiert	nicht maskiert
   enforced	Erzwungen	maskiert	maskiert	maskiert

   Groß- und Kleinschreibung des Header-Werts spielt keine Rolle. Andere Werte als on und off ignoriert das Gateway.

   Ergebnis: Sie wissen, ob Ihre Anfragen ohne Header maskiert werden.

2. Erkennung testen

   Senden Sie einen Beispieltext an POST /v1/detect. Der Endpunkt nutzt dieselbe Erkennung wie die Maskierung und leitet nichts an einen Anbieter weiter. Ohne Feld language prüft er auf Deutsch.

   Die Antwort enthält entity_count und die Liste entities. Jeder Eintrag nennt entity_type, den erkannten text und dessen Position (start, end).

   Ergebnis: Sie sehen, welche Stellen das Gateway durch Platzhalter wie <<PERSON_1>> ersetzen würde. Die Felder im Detail stehen unter Erkennen & Pseudonymisieren.

   Shell

   curl https://api.noirdoc.de/v1/detect \
     -H "Authorization: Bearer $NOIRDOC_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "text": "Herr Müller zahlt auf DE89 3704 0044 0532 0130 00."
     }' \
     | jq '.entities[] | {entity_type, text}'

3. Header senden

   Setzen Sie X-Noirdoc-Mask: on an der Anfrage, die maskiert werden soll. Das Gateway entfernt den Header, bevor es die Anfrage weiterleitet. Der Anbieter sieht ihn nicht.

   Ergebnis: Das Modell erhält Platzhalter statt der Originalwerte. In der Antwort an Ihre Anwendung stehen wieder die Originalwerte. Der Antwort-Header X-Noirdoc-Masked: true bestätigt, dass die Maskierung für die Anfrage aktiv war.

   curl Python TypeScript

   Shell

   curl https://api.noirdoc.de/v1/chat/completions \
     -H "Authorization: Bearer $NOIRDOC_API_KEY" \
     -H "Content-Type: application/json" \
     -H "X-Noirdoc-Mask: on" \
     -d '{
       "model": "qwen3.8-27b",
       "messages": [{
         "role": "user",
         "content": "Was schreibt Herr Müller der Kanzlei?"
       }]
     }'

   Python

   import os
   from openai import OpenAI
   
   client = OpenAI(
       base_url="https://api.noirdoc.de/v1",
       api_key=os.environ["NOIRDOC_API_KEY"],
   )
   
   response = client.chat.completions.create(
       model="qwen3.8-27b",
       messages=[
           {
               "role": "user",
               "content": "Was schreibt Herr Müller der Kanzlei?",
           }
       ],
       # Maskierung für diese Anfrage einschalten
       extra_headers={"X-Noirdoc-Mask": "on"},
   )

   TypeScript

   import OpenAI from "openai";
   
   const client = new OpenAI({
     baseURL: "https://api.noirdoc.de/v1",
     apiKey: process.env.NOIRDOC_API_KEY,
   });
   
   const response = await client.chat.completions.create(
     {
       model: "qwen3.8-27b",
       messages: [
         {
           role: "user",
           content: "Was schreibt Herr Müller der Kanzlei?",
         },
       ],
     },
     // Maskierung für diese Anfrage einschalten
     { headers: { "X-Noirdoc-Mask": "on" } },
   );

Header für alle Anfragen eines Clients setzen

chat_client = OpenAI(
    base_url="https://api.noirdoc.de/v1",
    api_key=os.environ["NOIRDOC_API_KEY"],
    default_headers={"X-Noirdoc-Mask": "on"},
)

Endpunkte ohne Maskierung

Diese Endpunkte leiten Inhalte unmaskiert weiter:

Welche Felder einer Anfrage das Gateway maskiert, listet Maskierte Felder.

Fehler