API DOKUMENTASJON V2

API v2 JSON svar og selvtillit

Forstå GenderAPI v2-data og metafelt: kjønn, ukjente årsaker, selvtillit, datasettbevis, KI-score, tilgangsmodus og faktureringsmetadata.

Forstå JSON-responsen

Vellykkede enkeltsvar inneholder data og meta. Datasettresponsen nedenfor er et illustrativt eksempel, ikke en måling av produktnøyaktighet eller et løfte om det samme live-resultatet. Den viser IP-prøvetilgang. Forespørsler autentisert med en kontonøkkelretur access.mode: api_key; felt som bare gjelder prøveversjonen har verdien null.

FieldMeaning
data.inputInndatatype, verdi og land. forceToGenderize er inkludert når true.
data.nameMatchet eller ekstrahert fornavn; null når ingen er tilgjengelig.
data.gendermale, female eller JSON null. Dette er en spådom, ikke bevis på en persons identitet.
data.result_status / reasonNår result_status er identified, er reason null. Når statusen er unknown, er årsaken not_found, no_name_candidate, ambiguous eller insufficient_evidence.
data.confidence0–1 poengsum eller null. Null kjønn har null tillit.
data.confidence_kindobserved_frequency: det dominerende kjønnsantallet delt på det totale antallet i det valgte datasettet. model_reported: en KI-poengsum, ikke en kalibrert sannsynlighet. Verdien er null når den ikke er tilgjengelig.
data.sample_countDatasettprøvestørrelse eller null. KI finner ikke opp en prøvetelling.
data.sourcedataset, ai eller none.
data.country / country_sourceLandstilknytning fra datasett eller ai_association, eller null. Fastslår ikke nasjonalitet, bosted eller etnisitet.
data.matchNavnet som samsvarer i datasettet, metoden (normalized, token, substring eller model_inference), omfanget (country eller global) og landet som samsvarer. Manglende informasjon har verdien null.
meta.request_id / duration_msOperasjonsidentifikator og behandlingsvarighet i millisekunder.
meta.accessHvordan tilgang ble gitt og årsaken til tilbakefall av prøveversjonen, hvis noen.
meta.usageNettobelastning, fullføringstidssaldo, faktureringsstatus og informasjon om tilbakestilling av prøveversjon.
Illustrativ JSON-respons
{
  "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 ukjent resultat

HTTP 200 betyr at operasjonen er fullført; det garanterer ikke et kjønn. Bevar JSON null i stedet for å konvertere den til male, female, en tom streng eller null konfidens. Sjekk data.result_status og data.reason separat fra HTTP-feil.

Dette eksemplet med kun datasett returnerer source: none og reason: not_found og koster fortsatt 1 kreditt. Hvis datasettet for de to kjønnene er like, kan resultatet inneholde reason: ambiguous mens sample_count bevares. Et ukjent KI-resultat bruker source: ai og reason: insufficient_evidence.

Illustrativ JSON-respons
{
  "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
    }
  }
}

Tolk tillit og samsvarende bevis

En konfidens på 0,9 er på en 0–1 skala. For observed_frequency betyr det det dominerende antallet delt på den valgte datasettsummen; det er ikke målt ende-til-ende-produktnøyaktighet. En model_reported-poengsum leveres av KI og er ikke kalibrert mot datasettfrekvenser.

Velg hvilken som helst applikasjonsterskel ved å bruke dine egne evalueringsdata og confidence_kind. Ikke ranger datasett og KI-poeng direkte som om de målte det samme. KI match.name, match.scope og match.country er null fordi ingen datasettrad ble valgt; match.method er model_inference.

For fulle navn kan et datasettresultat komme fra en komponent i stedet for hele strengen. data.input bevarer den innsendte verdien; data.name beskriver det returnerte navnet, og data.match beskriver kandidaten og oppslagsomfanget.

Relaterte veiledninger