Gender API
Skift sprog22
Log indKom gratis i gang
Menu

API DOKUMENTATION V2

API v2 JSON svar og tillid

Forstå GenderAPI v2-data og metafelter: køn, ukendte årsager, tillid, datasætbevis, AI-score, adgangstilstand og faktureringsmetadata.

Forstå JSON-svaret

Vellykkede enkeltsvar indeholder data og meta. Datasætsvaret nedenfor er et illustrativt eksempel, ikke en måling af produktnøjagtighed eller et løfte om det samme resultat. Det viser IP-prøveadgang. Anmodninger godkendt med en kontonøgle retur access.mode: api_key; felter, der kun gælder for prøven, har værdien null.

FeltBetydning
data.inputIndtastningstype, værdi og land. forceToGenderize er inkluderet, når true.
data.nameMatchet eller ekstraheret fornavn; null, når ingen er tilgængelig.
data.gendermale, female eller JSON null. Dette er en forudsigelse, ikke et bevis på en persons identitet.
data.result_status / reasonNår result_status er identified, er reason null. Når status er unknown, er årsagen not_found, no_name_candidate, ambiguous eller insufficient_evidence.
data.confidence0–1 score eller null. Nul køn har null tillid.
data.confidence_kindobserved_frequency: det dominerende kønstal divideret med det samlede antal i det valgte datasæt. model_reported: en AI-score, ikke en kalibreret sandsynlighed. Værdien er null, når den ikke er tilgængelig.
data.sample_countDatasætprøvestørrelse eller null. AI opfinder ikke en prøvetælling.
data.sourcedataset, ai eller none.
data.country / country_sourceLandetilknytning fra datasæt eller ai_association eller null. Fastlægger ikke nationalitet, bopæl eller etnicitet.
data.matchMatchende navn i datasættet, metode (normalized, token, substring eller model_inference), omfang (country eller global) og det matchende land. Manglende oplysninger har værdien null.
meta.request_id / duration_msOperations-id og behandlingsvarighed i millisekunder.
meta.accessHvordan adgangen blev givet og årsagen til prøvens fallback, hvis nogen.
meta.usageNettoafgift, færdiggørelsestidssaldo, faktureringsstatus og oplysninger om nulstilling af prøveversion.
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
    }
  }
}

Et vellykket ukendt resultat

HTTP 200 betyder operationen afsluttet; det garanterer ikke et køn. Bevar JSON null i stedet for at konvertere den til male, female, en tom streng eller nul konfidens. Kontroller data.result_status og data.reason separat fra HTTP-fejl.

Dette eksempel på datasæt returnerer source: none og reason: not_found og koster stadig 1 kredit. Hvis datasættets tal for de to køn er ens, kan resultatet indeholde reason: ambiguous, mens sample_count bevares. Et ukendt AI-resultat bruger source: ai og 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
    }
  }
}

Fortolk tillid og matchende beviser

En konfidens på 0,9 er på en 0-1 skala. For observed_frequency betyder det det dominerende antal divideret med det valgte datasæt i alt; det er ikke målt end-to-end produkt nøjagtighed. En model_reported-score leveres af AI og er ikke kalibreret mod datasætfrekvenser.

Vælg en applikationstærskel ved hjælp af dine egne evalueringsdata og confidence_kind. Rangord ikke datasæt og AI-scorer direkte, som om de målte det samme. AI match.name, match.scope og match.country er null, fordi der ikke er valgt nogen datasætrække; match.method er model_inference.

For fulde navne kan et datasætresultat komme fra en komponent i stedet for den fulde streng. data.input bevarer den indsendte værdi; data.name beskriver det returnerede navn, og data.match beskriver kandidaten og opslagsomfanget.

Relaterede guider