API DOKUMENTATION V2

API v2 JSON Antworten und Vertrauen

Verstehen Sie die Daten und Metafelder von GenderAPI v2: Geschlecht, unbekannte Gründe, Konfidenz, Datensatznachweise, KI-Scores, Zugriffsmodus und Abrechnungsmetadaten.

Verstehen Sie die JSON-Antwort

Erfolgreiche Einzelantworten enthalten data und meta. Die unten stehende Datensatzantwort ist ein veranschaulichendes Beispiel und kein Maß für die Produktgenauigkeit oder ein Versprechen für das gleiche Live-Ergebnis. Es zeigt den IP-Testzugang. Mit einem Kontoschlüssel authentifizierte Anforderungen geben access.mode: api_key zurück; Felder, die nur für die Testversion gelten, haben den Wert null.

FeldBedeutung
data.inputEingabetyp, Wert und Land. forceToGenderize ist enthalten, wenn true.
data.nameÜbereinstimmender oder extrahierter Vorname; null, wenn keine verfügbar ist.
data.gendermale, female oder JSON null. Dies ist eine Vorhersage, kein Beweis für die Identität einer Person.
data.result_status / reasonWenn result_status identified ist, ist reason null. Wenn der Status unknown ist, ist der Grund not_found, no_name_candidate, ambiguous oder insufficient_evidence.
data.confidence0–1 Punkte oder null. Null-Geschlecht hat null-Konfidenz.
data.confidence_kindobserved_frequency: die Anzahl der dominanten Geschlechter dividiert durch die Gesamtanzahl im ausgewählten Datensatz. model_reported: ein KI-Score, keine kalibrierte Wahrscheinlichkeit. Der Wert ist null, wenn er nicht verfügbar ist.
data.sample_countStichprobengröße des Datensatzes oder null. KI erfindet keine Stichprobenzählung.
data.sourcedataset, ai oder none.
data.country / country_sourceLänderzuordnung aus Datensatz oder ai_association oder null. Legt weder Nationalität, Wohnsitz noch ethnische Zugehörigkeit fest.
data.matchPassender Name im Datensatz, Abgleichsmethode (normalized, token, substring oder model_inference), Geltungsbereich (country oder global) und zugeordnetes Land. Fehlende Angaben sind null.
meta.request_id / duration_msVorgangskennung und Verarbeitungsdauer in Millisekunden.
meta.accessWie der Zugriff gewährt wurde und ggf. der Grund für den Fallback der Testversion.
meta.usageNettogebühr, Abschlusszeitsaldo, Rechnungsstatus und Informationen zum Zurücksetzen der Testversion.
Illustrative JSON-Antwort
{
  "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
    }
  }
}

Ein erfolgreiches unbekanntes Ergebnis

HTTP 200 bedeutet, dass der Vorgang abgeschlossen ist; es garantiert kein Geschlecht. Behalten Sie JSON null bei, anstatt es in male, female, eine leere Zeichenfolge oder Nullkonfidenz umzuwandeln. Überprüfen Sie data.result_status und data.reason getrennt von HTTP-Fehlern.

Dieses reine Datensatzbeispiel gibt source: none und reason: not_found zurück und kostet immer noch 1 Credit. Wenn die Datensatzanzahlen für die beiden Geschlechter gleich sind, kann das Ergebnis reason: ambiguous enthalten, während sample_count erhalten bleibt. Ein unbekanntes KI-Ergebnis verwendet source: ai und reason: insufficient_evidence.

Illustrative JSON-Antwort
{
  "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
    }
  }
}

Interpretieren Sie Konfidenz und übereinstimmende Beweise

Eine Konfidenz von 0,9 liegt auf einer Skala von 0–1. Für observed_frequency bedeutet dies die dominante Anzahl dividiert durch die Gesamtzahl des ausgewählten Datensatzes. Es handelt sich nicht um eine Messung der End-to-End-Produktgenauigkeit. Ein model_reported-Score wird von KI bereitgestellt und ist nicht anhand der Datensatzhäufigkeiten kalibriert.

Wählen Sie einen beliebigen Anwendungsschwellenwert unter Verwendung Ihrer eigenen Bewertungsdaten und confidence_kind. Ordnen Sie Datensätze und KI-Ergebnisse nicht direkt so, als ob sie dasselbe messen würden. KI match.name, match.scope und match.country sind null, da keine Datensatzzeile ausgewählt wurde; match.method ist model_inference.

Bei vollständigen Namen kann ein Datensatzergebnis von einer Komponente und nicht von der vollständigen Zeichenfolge stammen. data.input behält den übermittelten Wert bei; data.name beschreibt den zurückgegebenen Namen und data.match beschreibt den Kandidaten und den Suchbereich.

Verwandte Leitfäden