API DOKUMENTATION V2

API v2 JSON svar och förtroende

Förstå GenderAPI v2-data och metafält: kön, okända orsaker, förtroende, datauppsättningsbevis, AI-poäng, åtkomstläge och faktureringsmetadata.

Förstå JSON-svaret

Framgångsrika enstaka svar innehåller data och meta. Datauppsättningssvaret nedan är ett illustrativt exempel, inte ett mått på produktens noggrannhet eller ett löfte om samma liveresultat. Den visar IP-teståtkomst. Begäran autentiserade med en kontonyckelretur access.mode: api_key; fält som endast gäller testet har värdet null.

FältBetydelse
data.inputIngångstyp, värde och land. forceToGenderize ingår när true.
data.nameMatchat eller extraherat förnamn; null när ingen är tillgänglig.
data.gendermale, female eller JSON null. Detta är en förutsägelse, inte ett bevis på en persons identitet.
data.result_status / reasonNär result_status är identified, är reason null. När statusen är unknown är orsaken not_found, no_name_candidate, ambiguous eller insufficient_evidence.
data.confidence0–1 poäng eller null. Null kön har null förtroende.
data.confidence_kindobserved_frequency: det dominerande antalet kön dividerat med det totala antalet i den valda datamängden. model_reported: en AI-poäng, inte en kalibrerad sannolikhet. Värdet är null när det inte är tillgängligt.
data.sample_countDataset provstorlek eller null. AI uppfinner inte en provräkning.
data.sourcedataset, ai eller none.
data.country / country_sourceLandsassociation från dataset eller ai_association eller null. Fastställer inte nationalitet, bosättning eller etnicitet.
data.matchMatchat namn i datamängden, metod (normalized, token, substring eller model_inference), omfattning (country eller global) och matchat land. Uppgifter som saknas har värdet null.
meta.request_id / duration_msOperationsidentifierare och bearbetningstid i millisekunder.
meta.accessHur tillträde beviljades och anledningen till eventuell reservtest.
meta.usageNettodebitering, saldo för slutförandetid, faktureringsstatus och information om återställning av provperioden.
Illustrativt JSON-svar
{
  "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
    }
  }
}

Ett lyckat okänt resultat

HTTP 200 betyder operationen avslutad; det garanterar inte ett kön. Bevara JSON null istället för att konvertera den till male, female, en tom sträng eller noll konfidens. Kontrollera data.result_status och data.reason separat från HTTP-fel.

Det här exemplet med endast dataset returnerar source: none och reason: not_found och kostar fortfarande 1 kredit. Om datamängden för de två könen är lika, kan resultatet innehålla reason: ambiguous samtidigt som sample_count bevaras. Ett okänt AI-resultat använder source: ai och reason: insufficient_evidence.

Illustrativt JSON-svar
{
  "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
    }
  }
}

Tolka förtroende och matchande bevis

En konfidens på 0,9 är på en 0–1 skala. För observed_frequency betyder det det dominerande antalet dividerat med den valda datamängden; det mäts inte produktnoggrannhet från slut till slut. En model_reported-poäng tillhandahålls av AI och är inte kalibrerad mot datauppsättningsfrekvenser.

Välj valfri applikationströskel med hjälp av dina egna utvärderingsdata och confidence_kind. Rangordna inte dataset och AI-poäng direkt som om de mätte samma sak. AI match.name, match.scope och match.country är null eftersom ingen datauppsättningsrad har valts; match.method är model_inference.

För fullständiga namn kan ett datauppsättningsresultat komma från en komponent snarare än hela strängen. data.input bevarar det inlämnade värdet; data.name beskriver det returnerade namnet och data.match beskriver kandidaten och uppslagsomfånget.

Relaterade guider