GenderAPI.io V2: JSON-svar og konfidens

Forstå JSON-svaret

Vellykkede enkeltsvar inneholder data og meta. Eksemplet nedenfor fra datasettet er et ekte svar hentet 1. oktober 2026 med en API-nøkkel; bare kontosaldoen er byttet ut. Det viser ikke målt produktnøyaktighet, og en forespørsel i sanntid kan gi et annet resultat. Forespørsler med API-nøkkel rapporterer access.mode: api_key og null i kvotefeltene som bare gjelder IP-prøveperioden; forespørsler via IP-prøveperioden rapporterer ip_trial med prøvegrensen og tidspunktet for tilbakestilling.

{
  "data": {
    "input": {
      "type": "name",
      "value": "Henrik",
      "country": "NO"
    },
    "name": "henrik",
    "gender": "male",
    "country": "NO",
    "confidence": 1,
    "confidence_kind": "observed_frequency",
    "sample_count": 129,
    "source": "dataset",
    "result_status": "identified",
    "reason": null,
    "country_source": "dataset",
    "match": {
      "name": "henrik",
      "method": "normalized",
      "scope": "country",
      "country": "NO"
    }
  },
  "meta": {
    "request_id": "ec48ee76-eaf5-424f-8ed5-b33841429438",
    "duration_ms": 10,
    "access": {
      "mode": "api_key",
      "reason": null
    },
    "usage": {
      "charged_credits": 1,
      "remaining_credits": 49999,
      "billing_status": "confirmed",
      "resets_at": null,
      "limit": null,
      "period_seconds": null
    }
  }
}

• Fullstendige svarskjemaer og eksempler på samleforespørsler

Felt i prediksjonssvaret

Returnerte inndatafelt

Felt for treff i datasettet

Metadata om tilgang, belastning og forespørsel

Et vellykket ukjent resultat

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

Dette ekte eksemplet med bare datasettet, hentet 1. oktober 2026, returnerer source: none og reason: not_found og koster likevel 1 kreditt. En rad i datasettet med likt antall for begge kjønn kan returnere reason: ambiguous, mens sample_count beholdes. Et ukjent KI-resultat bruker source: ai og 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": "54fdcd4e-f8bc-4224-918f-3a5732e08b9c",
    "duration_ms": 10,
    "access": {
      "mode": "api_key",
      "reason": null
    },
    "usage": {
      "charged_credits": 1,
      "remaining_credits": 49999,
      "billing_status": "confirmed",
      "resets_at": null,
      "limit": null,
      "period_seconds": null
    }
  }
}

Tolk konfidens og grunnlaget for treffet

En konfidens på 0,9 er angitt på en skala fra 0 til 1. For observed_frequency betyr det det dominerende antallet delt på totalen i den valgte raden i datasettet; det er ikke målt ende-til-ende-nøyaktighet for produktet. En model_reported-verdi kommer fra KI og er ikke kalibrert mot frekvenser i datasettet.

Velg en eventuell terskel i applikasjonen ut fra dine egne evalueringsdata og confidence_kind. Ikke ranger verdier fra datasettet og KI direkte mot hverandre som om de målte det samme. For KI er match.name, match.scope og match.country null fordi ingen rad i datasettet ble valgt; match.method er model_inference.

For fulle navn kan et resultat fra datasettet komme fra én del av navnet i stedet for hele strengen. data.input bevarer verdien som ble sendt; data.name beskriver det returnerte navnet, og data.match beskriver kandidaten og omfanget av oppslaget.

Bestem hva applikasjonen din skal gjøre

Håndter først feil i forespørselen og i enkeltelementer, og sjekk deretter result_status. For en enkeltprediksjon leser du data; for en samleforespørsel bruker du den samme beslutningen på data for hvert vellykket element. Behold ukjente resultater i applikasjonen i stedet for å tvinge frem etiketten male eller female.

• Skill driftsfeil fra ukjente resultater
• Bruk beslutningene på en samleforespørsel

Velg terskler ut fra din egen evaluering

Det finnes ingen universell konfidensterskel som gjør en prediksjon riktig. Evaluer observed_frequency og model_reported hver for seg, med representative og uavhengig merkede eksempler fra ditt eget bruksområde. En frekvens i datasettet og en verdi rapportert av KI er ulike signaler, også når begge er 0,9. Mål hvor ofte regelen din gir et svar, og hvor ofte disse svarene er riktige; for alt annet beholder du et ukjent resultat eller legger opp til manuell gjennomgang.

Hvis for eksempel result_status er identified, men confidence_kind er model_reported, bruker du regelen du har evaluert for KI, ikke terskelen for datasettet. Hvis forceToGenderize ble brukt, er name: null sammen med et kjønn som ikke er null, gyldig: Et alias kan tolkes uten at et ekte fornavn hentes ut. Sjekk gender og result_status, ikke bare name, for å avgjøre om prediksjonen ga et svar. Resultatet er fortsatt et estimat, ikke en bekreftelse av en persons identitet.

• Evalueringsmål og grenser for konfidens
• Profilen til datasettet og grensene for grunnlaget
• Tolkning av kallenavn og name med verdien null

Relaterte veiledninger

• Svar på samleforespørsler og feil per element
• Belastningsstatus og gjenværende kreditter
• Kompatible svar og nye forsøk