Metni maskele

Verilen metindeki kişisel verileri tespit eder ve seçilen dönüşüme göre maskeler. Varsayılan dönüşüm placeholder (geri-çözülebilir yer-tutucu).

POST/mask

Request body

requiredapplication/json

textstringrequired

Maskelenecek ham metin.

transformstring

`placeholder` (geri-çözülebilir `<KATEGORİ_N>`), `mask` (uzunluk-koruyan `####`, geri-alınamaz).

default: "placeholder"

Allowed:placeholdermask

mask_charstring

transform=mask için dolgu karakteri.

default: "#"

return_vaultboolean

Yer-tutucu → orijinal değer eşlemesini döndürür (hassas! varsayılan kapalı, asla loglanmaz).

default: false

categoriesobject

Kategori filtreleme: `{preset, enable:[...], disable:[...]}`. preset değerleri: ALL, IDENTITY, IDENTIFIERS, KVKK, KVKK_SENSITIVE. (KVKK = tüm kapsam; KVKK_SENSITIVE = yalnız m.6 özel-kategori.)

allow_patternsstring[]

Düzenli ifade (regular expression, Python `re` sözdizimi) listesi; maskelemeden muaf tutma (allowlist). Tespit edilen bir alanın yüzey metni desenlerden biriyle eşleşiyorsa o alan MASKELENMEZ. Kurum adı gibi kamuya açık bir değer yanlışlıkla kişisel veri sanılıyorsa kullanın. Geçersiz desen 422 döndürür.

block_patternsstring | object[]

Düzenli ifade listesi; eşleşen her metin parçası, model tespit etmemiş olsa bile ZORLA maskelenir. Kurum içi sicil/dosya numarası gibi size özgü tanımlayıcıları garantiye almak için kullanın. Düz dize verilirse kategori `custom` olur; `{pattern, category}` nesnesiyle kategori atanır. Mevcut bir tespitle çakışan eşleşme atlanır (tespit kazanır). Geçersiz desen 422 döndürür.

Show properties

Array of string | object

One of:

string

string

object

patternstringrequired

Düzenli ifade (Python `re` sözdizimi).

categorystring

Zorlanan alana atanacak kategori (varsayılan `custom`).

Responses

200Maskeleme sonucu

masked_textstring

Maskelenmiş metin.

transformstring

spansSpan[]

Show properties

Array of Span

categorystring

startinteger

endinteger

scorenumber

timings_msobject

Toplam işlem süresi (ms): yalnız { total }.

vaultobject

return_vault=true ise yer-tutucu → orijinal eşlemesi (hassas).

401Eksik veya geçersiz sanal anahtar

detailstring

413Metin azami uzunluğu aştı (parçalayın veya /mask/batch kullanın)

422Geçersiz istek gövdesi

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstring

typestring

Request

import requests

response = requests.post(
    "https://gw-tr.gurubase.io/mask",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "text": "Ahmet Yılmaz, TC 10000000214.",
  "transform": "placeholder",
  "mask_char": "#",
  "return_vault": False,
  "categories": {},
  "allow_patterns": [
    "\\bDemo Kurum\\b"
  ],
  "block_patterns": [
    "\\bPRJ-\\d{4}\\b",
    {
      "pattern": "\\bSICIL-\\d{6}\\b",
      "category": "custom"
    }
  ]
},
)

curl -X POST "https://gw-tr.gurubase.io/mask" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "Ahmet Yılmaz, TC 10000000214.",
  "transform": "placeholder",
  "mask_char": "#",
  "return_vault": false,
  "categories": {},
  "allow_patterns": [
    "\\bDemo Kurum\\b"
  ],
  "block_patterns": [
    "\\bPRJ-\\d{4}\\b",
    {
      "pattern": "\\bSICIL-\\d{6}\\b",
      "category": "custom"
    }
  ]
}'

const response = await fetch("https://gw-tr.gurubase.io/mask", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "text": "Ahmet Yılmaz, TC 10000000214.",
  "transform": "placeholder",
  "mask_char": "#",
  "return_vault": false,
  "categories": {},
  "allow_patterns": [
    "\\bDemo Kurum\\b"
  ],
  "block_patterns": [
    "\\bPRJ-\\d{4}\\b",
    {
      "pattern": "\\bSICIL-\\d{6}\\b",
      "category": "custom"
    }
  ]
})
});

Response

{
  "masked_text": "string",
  "transform": "string",
  "spans": [
    {
      "category": "person",
      "start": 0,
      "end": 0,
      "score": 0.85
    }
  ],
  "timings_ms": {},
  "vault": {}
}