Odpovědi a spolehlivost API v2 JSON

Pochopte odezvu JSON

Úspěšné jednotlivé odpovědi obsahují data a meta. Níže uvedená odezva datové sady je ilustrativním příkladem, nikoli měřením přesnosti produktu nebo příslibem stejného živého výsledku. Ukazuje IP-zkušební přístup. Požadavky ověřené klíčem účtu vracejí access.mode: api_key; pole, která se týkají pouze zkušební verze, mají hodnotu null.

Field	Meaning
data.input	Typ vstupu, hodnota a země. forceToGenderize je součástí true.
data.name	Shodné nebo extrahované křestní jméno; null, když žádná není k dispozici.
data.gender	male, female nebo JSON null. Toto je předpověď, nikoli důkaz identity osoby.
data.result_status / reason	Když result_status je identified, reason je null. Když je stav unknown, důvod je not_found, no_name_candidate, ambiguous nebo insufficient_evidence.
data.confidence	0–1 skóre nebo null. Nulové pohlaví má důvěru null.
data.confidence_kind	observed_frequency: počet dominantního pohlaví dělený celkovým počtem ve vybraném souboru dat. model_reported: skóre AI, nikoli kalibrovaná pravděpodobnost. Hodnota je null, když není k dispozici.
data.sample_count	Velikost vzorku datové sady nebo null. AI nevymýšlí počet vzorků.
data.source	dataset, ai nebo none.
data.country / country_source	Přidružení země z datové sady nebo ai_association nebo null. Nestanoví národnost, bydliště nebo etnickou příslušnost.
data.match	Odpovídající jméno v datové sadě, metoda (normalized, token, substring nebo model_inference), rozsah (country nebo global) a odpovídající země. Nedostupné údaje mají hodnotu null.
meta.request_id / duration_ms	Identifikátor operace a doba zpracování v milisekundách.
meta.access	Jak byl udělen přístup a důvod zkušebního záložního řešení, pokud existuje.
meta.usage	Čistý poplatek, zůstatek v době dokončení, stav fakturace a informace o resetování zkušební verze.

{
  "data": {
    "input": {
      "type": "name",
      "value": "Onur",
      "country": "TR"
    },
    "name": "onur",
    "gender": "male",
    "country": "TR",
    "confidence": 0.9,
    "confidence_kind": "observed_frequency",
    "sample_count": 100,
    "source": "dataset",
    "result_status": "identified",
    "reason": null,
    "country_source": "dataset",
    "match": {
      "name": "onur",
      "method": "normalized",
      "scope": "country",
      "country": "TR"
    }
  },
  "meta": {
    "request_id": "11111111-1111-4111-8111-111111111111",
    "duration_ms": 12,
    "access": {
      "mode": "ip_trial",
      "reason": "api_key_missing"
    },
    "usage": {
      "charged_credits": 1,
      "remaining_credits": 9,
      "billing_status": "confirmed",
      "resets_at": "2026-09-26T12:00:00.000Z",
      "limit": 10,
      "period_seconds": 86400
    }
  }
}

Kompletní schémata odpovědí a příklady dávek

Úspěšný neznámý výsledek

HTTP 200 znamená, že operace byla dokončena; nezaručuje pohlaví. Zachovejte JSON null spíše než jej převádějte na male, female, prázdný řetězec nebo nulovou spolehlivost. Zkontrolujte data.result_status a data.reason odděleně od chyb HTTP.

Tento příklad pouze datové sady vrací source: none a reason: not_found a stále stojí 1 kredit. Pokud jsou počty datových sad pro dvě pohlaví stejné, výsledek může obsahovat reason: ambiguous při zachování sample_count. Neznámý výsledek AI používá source: ai a reason: insufficient_evidence.

{
  "data": {
    "input": {
      "type": "name",
      "value": "zzzxxyy",
      "country": null
    },
    "name": null,
    "gender": null,
    "country": null,
    "confidence": null,
    "confidence_kind": null,
    "sample_count": null,
    "source": "none",
    "result_status": "unknown",
    "reason": "not_found",
    "country_source": null,
    "match": {
      "name": null,
      "method": null,
      "scope": null,
      "country": null
    }
  },
  "meta": {
    "request_id": "11111111-1111-4111-8111-111111111111",
    "duration_ms": 12,
    "access": {
      "mode": "ip_trial",
      "reason": "api_key_missing"
    },
    "usage": {
      "charged_credits": 1,
      "remaining_credits": 8,
      "billing_status": "confirmed",
      "resets_at": "2026-09-26T12:00:00.000Z",
      "limit": 10,
      "period_seconds": 86400
    }
  }
}

Interpretujte spolehlivost a shodu důkazů

Spolehlivost 0,9 je na stupnici 0–1. Pro observed_frequency to znamená dominantní počet dělený celkovým počtem vybraných datových sad; neměří se přesnost end-to-end produktu. Skóre model_reported poskytuje umělá inteligence a není kalibrováno podle frekvencí datové sady.

Vyberte si libovolnou prahovou hodnotu aplikace pomocí vlastních hodnoticích dat a confidence_kind. Nehodnoťte přímo skóre datové sady a AI, jako by měřily totéž. AI match.name, match.scope a match.country jsou null, protože nebyl vybrán žádný řádek datové sady; match.method je model_inference.

U úplných jmen může výsledek datové sady pocházet z komponenty, nikoli z celého řetězce. data.input zachová odeslanou hodnotu; data.name popisuje vrácený název a data.match popisuje kandidáta a rozsah vyhledávání.

Pochopte odezvu JSON

Úspěšný neznámý výsledek

Interpretujte spolehlivost a shodu důkazů

Související průvodce