API DOKÜMANTASYONU V2

API V2 JSON yanıtları ve güven puanı

GenderAPI V2 data ve meta alanlarını anlayın: cinsiyet, belirsizlik nedenleri, güven puanı, veri kümesi kanıtı, yapay zekâ puanı, erişim ve ücretlendirme.

JSON yanıtını anlayın

Başarılı tekli yanıt data ve meta içerir. Aşağıdaki veri kümesi örneği temsilidir; ölçülmüş ürün doğruluğu veya canlı istekte aynı sonuç sözü değildir. IP denemesini gösterir. Hesap anahtarlı isteklerde access.mode: api_key, yalnızca denemeye ait kota alanlarında null döner.

AlanAnlam
data.inputGirdi türü, değeri ve ülkesi. forceToGenderize, true olduğunda eklenir.
data.nameEşleşen veya çıkarılan ad; bulunamıyorsa null.
data.gendermale, female veya JSON null. Doğrulanmış kişisel kimlik değil, tahmindir.
data.result_status / reasonidentified durumunda reason null; unknown durumunda not_found, no_name_candidate, ambiguous veya insufficient_evidence olur.
data.confidence0–1 arası puan veya null. Cinsiyet null ise güven puanı da null’dır.
data.confidence_kindobserved_frequency: baskın veri kümesi sayısı / toplam. model_reported: yapay zekâ puanı; kalibre edilmiş olasılık değildir. Bilgi yoksa null.
data.sample_countVeri kümesindeki örnek sayısı veya null. Yapay zekâ örnek sayısı üretmez.
data.sourcedataset, ai veya none.
data.country / country_sourceVeri kümesi veya ai_association kaynaklı ülke ilişkisi; bilgi yoksa null. Vatandaşlık, ikamet veya etnik köken kanıtı değildir.
data.matchEşleşen isim, yöntem (normalized, token, substring veya model_inference), ülke/genel kapsam ve eşleşen ülke. Olmayan kanıt null’dır.
meta.request_id / duration_msİşlem kimliği ve milisaniye cinsinden işlem süresi.
meta.accessErişimin nasıl sağlandığı ve varsa IP denemesine geçiş nedeni.
meta.usageNet kredi tutarı, tamamlanma anındaki bakiye, ücretlendirme durumu ve deneme yenileme bilgileri.
Temsili JSON yanıtı
{
  "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
    }
  }
}

Başarıyla tamamlanan belirsiz sonuç

HTTP 200, işlemin tamamlandığını gösterir; cinsiyet bulunmasını garanti etmez. JSON null değerini male, female, boş metin veya sıfır güven puanına çevirmeyin. data.result_status ve data.reason alanlarını HTTP hatalarından ayrı değerlendirin.

Bu temsili veri kümesi örneği source: none ve reason: not_found döndürür; yine de 1 kredidir. Eşit dağılımlı kayıtta reason: ambiguous dönebilir ve sample_count korunur. Belirsiz yapay zekâ sonucunda source: ai ve reason: insufficient_evidence kullanılır.

Temsili JSON yanıtı
{
  "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
    }
  }
}

Güven puanı ve eşleşme kanıtını yorumlama

0.9 güven puanı, 0–1 ölçeğindedir. observed_frequency için baskın sayının seçilen veri kümesi toplamına oranıdır; uçtan uca ölçülmüş ürün doğruluğu değildir. model_reported, yapay zekânın verdiği ve veri kümesi frekanslarına göre kalibre edilmemiş puandır.

Uygulama eşiğinizi kendi değerlendirme verileriniz ve confidence_kind ile belirleyin. Veri kümesi ve yapay zekâ puanlarını aynı şeyi ölçüyormuş gibi sıralamayın. Yapay zekâda veri kümesi kaydı seçilmediğinden match.name, match.scope ve match.country null; match.method ise model_inference olur.

Tam ad sorgusunda sonuç, bütün metin yerine bir bileşenden gelebilir. data.input gönderilen değeri, data.name dönen adı, data.match ise adayı ve sorgu kapsamını gösterir.

İlgili rehberler