API DOCUMENTATIE V2

API v2 JSON reacties en vertrouwen

Begrijp GenderAPI v2-gegevens en metavelden: geslacht, onbekende redenen, vertrouwen, bewijsmateriaal uit de dataset, AI-scores, toegangsmodus en metagegevens voor facturering.

Begrijp het JSON-antwoord

Succesvolle afzonderlijke antwoorden bevatten data en meta. Het onderstaande antwoord op de dataset is een illustratief voorbeeld en geen meting van de productnauwkeurigheid of een belofte van hetzelfde live resultaat. Het toont IP-proeftoegang. Verzoeken geauthenticeerd met een accountsleutelretour access.mode: api_key; velden die alleen van toepassing zijn op de proefversie hebben de waarde null.

VeldBetekenis
data.inputInvoertype, waarde en land. forceToGenderize is inbegrepen bij true.
data.nameOvereenkomende of geëxtraheerde voornaam; null als er geen beschikbaar is.
data.gendermale, female of JSON null. Dit is een voorspelling, geen bewijs van iemands identiteit.
data.result_status / reasonWanneer result_status identified is, is reason null. Wanneer de status unknown is, is de reden not_found, no_name_candidate, ambiguous of insufficient_evidence.
data.confidence0–1 score of null. Het nulgeslacht heeft null-vertrouwen.
data.confidence_kindobserved_frequency: het dominante geslachtsaantal gedeeld door het totale aantal in de geselecteerde dataset. model_reported: een AI-score, geen gekalibreerde waarschijnlijkheid. De waarde is null indien niet beschikbaar.
data.sample_countSteekproefgrootte van gegevensset of null. AI bedenkt geen steekproeftelling.
data.sourcedataset, ai of none.
data.country / country_sourceLandassociatie uit dataset of ai_association, of null. Stelt geen nationaliteit, woonplaats of etniciteit vast.
data.matchOvereenkomende naam in de dataset, methode (normalized, token, substring of model_inference), bereik (country of global) en het gevonden land. Ontbrekende gegevens hebben de waarde null.
meta.request_id / duration_msBewerkings-ID en verwerkingsduur in milliseconden.
meta.accessHoe toegang werd verleend en de reden voor eventuele terugval in de proefperiode.
meta.usageNettokosten, saldo van de voltooiingstijd, factureringsstatus en informatie over het opnieuw instellen van de proefperiode.
Illustratieve JSON-reactie
{
  "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
    }
  }
}

Een succesvol onbekend resultaat

HTTP 200 betekent dat de bewerking is voltooid; het garandeert geen geslacht. Behoud JSON null in plaats van het te converteren naar male, female, een lege tekenreeks of nul vertrouwen. Controleer data.result_status en data.reason afzonderlijk van HTTP-fouten.

Dit voorbeeld met alleen een dataset retourneert source: none en reason: not_found en kost nog steeds 1 credit. Als de datasettellingen voor de twee geslachten gelijk zijn, kan het resultaat reason: ambiguous bevatten, terwijl sample_count behouden blijft. Een onbekend AI-resultaat maakt gebruik van source: ai en reason: insufficient_evidence.

Illustratieve JSON-reactie
{
  "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
    }
  }
}

Interpreteer vertrouwen en bijpassend bewijsmateriaal

Een betrouwbaarheid van 0,9 is op een schaal van 0–1. Voor observed_frequency betekent dit de dominante telling gedeeld door het geselecteerde datasettotaal; er wordt geen end-to-end productnauwkeurigheid gemeten. Een model_reported-score wordt geleverd door AI en is niet gekalibreerd op basis van datasetfrequenties.

Kies een toepassingsdrempel met behulp van uw eigen evaluatiegegevens en confidence_kind. Rangschik de dataset- en AI-scores niet direct alsof ze hetzelfde meten. AI match.name, match.scope en match.country zijn null omdat er geen gegevenssetrij is geselecteerd; match.method is model_inference.

Voor volledige namen kan een datasetresultaat afkomstig zijn van een component in plaats van de volledige string. data.input behoudt de ingediende waarde; data.name beschrijft de geretourneerde naam en data.match beschrijft de kandidaat en het opzoekbereik.

Gerelateerde handleidingen