Gå til indholdet

Vejledninger

Regler i Redact

Redact finder personoplysninger med sine egne detektorer. Organisationens regler tilføjer det, kun I kender, fx sagsnumre, projektnavne og interne id'er, og undtager tekst, der skal forblive læsbar. Reglerne gælder for alle kørsler med Redact i jeres organisation: i arbejdsrummet Redact i hubben, gennem API'et og i Redact i Word.

Hvor du håndterer reglerne

Reglerne ligger under Organisation › Redact › Regler (/settings/redaction-rules). Siden er åben for administratorer, der har adgang til Redact, fordi reglerne ofte indeholder netop de navne og numre, I vil skjule. komplai gemmer reglerne på sine servere i Tyskland, til I sletter dem, og anvender dem dér.

Listen har visningerne Aktive, Deaktiverede og, hvis jeres organisation bruger Dokumenter, Forslag. Du kan søge i mønstrene, markere flere regler og vælge Aktivér, Deaktivér eller Slet for dem alle på én gang.

Hvad en regel gør

En regel har en af to virkninger:

  • Pseudonymisér: Tekst, der matcher, erstattes med en nummereret betegnelse, fx [SAG-1]. Den samme tekst får den samme betegnelse i hele kørslen.
  • Undtag (pseudonymisér aldrig): Tekst, der matcher, pseudonymiseres aldrig, heller ikke når en detektor eller en anden regel finder den. En undtagelse fjerner alle fund, der overlapper dens match.

Når en undtagelse med præcis tekst overlapper teksten i en pseudonymiseringsregel med præcis tekst, står det ved pseudonymiseringsreglen i listen: En undtagelsesregel har forrang. Denne regel bliver derfor ikke brugt.

Opret en regel

  1. Vælg Opret regel under Regler.
  2. Vælg Virkning.
  3. Vælg Præcis tekst eller Mønster (avanceret) under Type af mønster. Skriv teksten eller mønsteret, højst 256 tegn.
  4. Vælg en Type til en pseudonymiseringsregel. Skriv en Etiket, hvis du vil have dit eget ord i betegnelsen: SAG giver [SAG-1]. Uden etiket bruges typens egen.
  5. Vælg, hvor reglen Anvendes på.
  6. Tilføj en Fast erstatning til en pseudonymiseringsregel, hvis alle match skal stå ens, fx [FORTROLIGT].
  7. Sæt flueben ved Skeln mellem store og små bogstaver, hvis store og små bogstaver skal passe. Det skal de ikke som standard.
  8. Vælg Opret regel. Reglen er aktiv med det samme og gælder fra næste kørsel.

En etiket kan indeholde A til Z, 0 til 9, bindestreg og understregning og gemmes med store bogstaver. En fast erstatning må højst have 128 tegn, og den må ikke have samme form som Redacts nummererede betegnelser, fx [SAG-1], fordi den kan forveksles med en af dem. Gemmer du en regel med samme type af mønster, mønster og virkning som en eksisterende, beholder du den eksisterende, og hubben skriver Reglen fandtes allerede.

Sådan matcher mønstre

  • En regel med Præcis tekst matcher teksten, uanset hvor den står, også inde i et længere ord: Falk matcher også i Falkenberg. Brug et mønster med \b, hvis kun hele ord skal matche.
  • Et Mønster (avanceret) er et regulært udtryk i JavaScript, skrevet uden skråstreger og flag. Det kontrolleres, før reglen gemmes, og et mønster, der kan overbelaste behandlingen, fx med gentagelser inde i andre gentagelser, afvises.
  • Et mønster må aldrig kunne matche tom tekst, som \d* gør. Så længe en aktiv regel for API'et kan det, fejler alle kald til Redact gennem API'et med invalid_organisation_policy.

Eksempel

Sagsnumre på formen 24/01234 og et projektnavn, der altid skal stå ens:

VirkningType af mønsterMønsterEtiketFast erstatning
PseudonymisérMønster (avanceret)\b\d{2}/\d{5}\bSAG
PseudonymisérPræcis tekstProjekt Falcon[FORTROLIGT]

Hvor reglerne gælder

En regel gælder i arbejdsrummet Redact i hubben, i Redacts API og i Redact i Word. Under Anvendes på står det som Redact, API og Word. Redact i Word får sine regler gennem API'et.

Bruger jeres organisation Dokumenter, har Anvendes på i stedet to valg:

Anvendes påBruges af
Redact, API, Word og DokumenterArbejdsrummet Redact, Redacts API, Redact i Word og Dokumenter
Kun DokumenterDokumenter

Ældre regler for Kun Word-tilføjelsen bruges ingen steder, og det står i listen. Opret sådan en regel igen for Redact, API og Word, hvis den skal gælde i Word.

I arbejdsrummet Redact

Reglerne gælder ved alle kørsler, uanset hvilke metoder personen vælger. Fund fra regler står under Egne maskeringer og regler, grupperet som Regel: efterfulgt af etiketten. En fast erstatning kan ikke ændres i arbejdsrummet: Ved fundet står der, at organisationens regel bestemmer ordlyden.

Gennem API'et

POST /v1/redact, tekstjob (POST /v1/redact/jobs) og filoperationerne POST /v1/redact/file og POST /v1/redact/file/jobs Beta anvender alle organisationens aktive regler for Redact, API og Word (eller Redact, API, Word og Dokumenter) ved alle kald, med alle slags nøgler og uanset hvilke detectors du vælger. Det gør POST /v1/redact/detect også, og dermed Redact i Word, der scanner gennem det. I svaret har et fund fra en regel source og type sat til custom.

Med de to regler fra eksemplet:

Shell
curl https://api.komplai.dk/v1/redact \
  -H "Authorization: Bearer $KOMPLAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Sagen 24/01234 om Projekt Falcon er lukket. Se også sag 24/01234 og 25/00077.",
    "detectors": ["regex"],
    "include": ["mapping"]
  }'

Svaret, forkortet til de felter, der er vigtige her:

JSON
{
  "redacted": "Sagen [SAG-1] om [FORTROLIGT] er lukket. Se også sag [SAG-1] og [SAG-2].",
  "mapping": {
    "[SAG-1]": "24/01234",
    "[FORTROLIGT]": "Projekt Falcon",
    "[SAG-2]": "25/00077"
  },
  "entries": [
    { "placeholder": "[SAG-1]", "type": "custom", "value": "24/01234", "confidence": "high", "source": "custom" },
    { "placeholder": "[FORTROLIGT]", "type": "custom", "value": "Projekt Falcon", "confidence": "high", "source": "custom" },
    { "placeholder": "[SAG-2]", "type": "custom", "value": "25/00077", "confidence": "high", "source": "custom" }
  ]
}

En fast erstatning kan stå for flere oprindelige oplysninger, så POST /v1/redact/restore sætter den aldrig tilbage. Den bliver stående i teksten og står i fixedTokens. Redact-referencen har alle felter.

KodeHvornår
processing_policy_changedReglerne blev ændret, mens kaldet kørte. Send det igen.
invalid_organisation_policyMere end 500 aktive regler gælder for API'et, eller en af dem kan ikke bruges.
incoherent_redaction_policyTo regler med hver sin faste erstatning finder tekst, der overlapper.
unsafe_placeholderTeksten indeholder allerede en fast erstatning, eller en fast erstatning falder sammen med en betegnelse.
processing_access_withdrawnDu læser et tekstjob, der blev oprettet, før reglerne blev ændret.

Ændrede regler afslutter eksisterende tekstjob

Et tekstjob hører til de regler, det blev oprettet under. Når de regler, der gælder for API'et, ændres, fx når I opretter, aktiverer, deaktiverer eller sletter en, eller når et forslag fra Dokumenter bliver aktivt, kan et job, der blev oprettet før ændringen, ikke længere læses. Næste gang jobbet læses eller behandles, ugyldiggør komplai det og sletter dets tekst og resultat, og API'et svarer 403 processing_access_withdrawn. Hent de resultater, du skal bruge, før I ændrer reglerne, og send teksten igen som et nyt job bagefter.

Forslag fra Dokumenter

Bruger jeres organisation Dokumenter, bliver tekst, som folk pseudonymiserer manuelt dér, til et forslag under Forslag. Kun tekst, der ligner et navn, tæller med: mindst tre tegn, stort begyndelsesbogstav og ikke et almindeligt ord.

Hvert forslag viser, hvor mange brugere, sessioner og hændelser det bygger på. Se grundlaget viser, hvem der pseudonymiserede teksten, i hvilket dokument og hvornår, op til de 200 seneste hændelser, med et link, så du kan åbne dokumentet og kontrollere det.

Et forslag bliver af sig selv til en aktiv regel, når to forskellige personer, eller én person i tre forskellige dokumenter, har pseudonymiseret den samme tekst som den samme type. Det gælder så for Redact, API, Word og Dokumenter. Vælg Aktivér regel for at aktivere et forslag før da. Vil du stoppe en regel, der kom fra forslag, så vælg Deaktivér: En deaktiveret regel forbliver deaktiveret, når folk bliver ved med at pseudonymisere teksten, mens en slettet regel oprettes igen, næste gang nogen pseudonymiserer teksten manuelt.

Kilder til opslag

Redact Agentic Alpha er en eksperimentel metode i Redact, der kan slå op i registre undervejs. Den kører på komplais lokale infrastruktur i Danmark. Organisation › Redact › Kilder til opslag (/settings/redact-sources) har to indstillinger for den:

  • Redact Agentic: Når metoden er slået til, kan personer i jeres organisation vælge den og NER-modeller i alpha og beta, både i Redact og med personlige API-nøgler.
  • Kilder: de kilder, metoden må slå op i. Personer vælger kilder for hver kørsel blandt dem, I tillader. En kilde, der ikke er klar, viser hvorfor.
KildeHvad der sendesModtagerModtagerens opbevaring
CVRCVR-nummer eller registreret virksomhedsnavn. Personopslag er ikke tilgængelige.Datafordeleren / Klimadatastyrelsen. Behandlingssted ikke bekræftet.IP-adresse og brugernavn logges i op til 9 måneder.
BBRBygnings-, husnummer- eller ejendoms-id. Opslaget omfatter ikke beboere.Datafordeleren / Klimadatastyrelsen. Behandlingssted ikke bekræftet.IP-adresse og brugernavn logges i op til 9 måneder.
WebsøgningAfgrænsede søgeord, aldrig hele dokumentet.Brave Software Inc., USA, uden for EU/EØS.Søgeord i op til 90 dage.
Danmarks AdresseregisterVejnavn, postnummer og eventuelt husnummer. Opslaget omfatter ikke beboere.Klimadatastyrelsen (Adressevælger). Behandlingssted ikke bekræftet.Ikke bekræftet.
Wikidata, lokaltIntet sendes til Wikidata: søgeord og Wikidata-id slås op i en lokal kopi.Lokal infrastruktur.Søgeord gemmes ikke.

CVR og BBR bruger komplais adgang eller jeres egen nøgle til Datafordeleren. Websøgning kræver jeres egen nøgle til Brave Search API. Danmarks Adresseregister kræver ingen nøgle. Wikidata, lokalt vises, hvor komplais lokale kopi er klar. Nøgler, I gemmer, gemmes krypteret og vises aldrig igen.

Gennem API'et er metoden felterne engine og sources på POST /v1/redact, tekstjob og filoperationerne. De kræver en personlig API-nøgle: Organisationens integrationsnøgle får integration_not_permitted. Uden indstillingen svarer kaldet agentic_preview_not_enabled, og en kilde, I ikke har tilladt, svarer agentic_lookup_not_allowed.

komplaidevelopers
Kontakt os

Søg i dokumentationen

Vælg med piletasterne, og åbn med Enter.