API v2 JSON การตอบสนองและความมั่นใจ

ทำความเข้าใจกับการตอบสนองของ JSON

การตอบสนองเดี่ยวที่สำเร็จประกอบด้วย data และ meta การตอบสนองของชุดข้อมูลด้านล่างนี้เป็นเพียงตัวอย่าง ไม่ใช่การวัดความถูกต้องของผลิตภัณฑ์หรือคำมั่นสัญญาถึงผลลัพธ์แบบเรียลไทม์ที่เหมือนกัน มันแสดงให้เห็นการเข้าถึง IP ทดลอง คำขอที่รับรองความถูกต้องด้วยรหัสบัญชีส่งคืน access.mode: api_key ฟิลด์ที่ใช้เฉพาะกับการทดลองใช้จะมีค่า null

สนาม	ความหมาย
data.input	ประเภทอินพุต ค่า และประเทศ forceToGenderize จะรวมอยู่ด้วยเมื่อ true
data.name	จับคู่หรือแยกชื่อที่กำหนด; null เมื่อไม่มีให้ใช้งาน
data.gender	male, female หรือ JSON null นี่เป็นการทำนาย ไม่ใช่การพิสูจน์ตัวตนของบุคคล
data.result_status / reason	เมื่อ result_status คือ identified, reason คือ null เมื่อสถานะเป็น unknown สาเหตุคือ not_found, no_name_candidate, ambiguous หรือ insufficient_evidence
data.confidence	0–1 คะแนนหรือ null เพศว่างมีความมั่นใจ null
data.confidence_kind	observed_frequency: จำนวนเพศที่โดดเด่นหารด้วยจำนวนรวมในชุดข้อมูลที่เลือก model_reported: คะแนน AI ไม่ใช่ความน่าจะเป็นที่ปรับเทียบแล้ว ค่าคือ null เมื่อไม่พร้อมใช้งาน
data.sample_count	ขนาดตัวอย่างชุดข้อมูลหรือ null AI ไม่ได้คิดค้นการนับตัวอย่าง
data.source	dataset, ai หรือ none
data.country / country_source	การเชื่อมโยงประเทศจากชุดข้อมูลหรือ ai_association หรือ null ไม่กำหนดสัญชาติ ถิ่นที่อยู่ หรือชาติพันธุ์
data.match	ชื่อที่ตรงกันในชุดข้อมูล วิธีจับคู่ (normalized, token, substring หรือ model_inference) ขอบเขต (country หรือ global) และประเทศที่ตรงกัน ข้อมูลประกอบที่ไม่มีจะเป็น null
meta.request_id / duration_ms	ตัวระบุการดำเนินการและระยะเวลาการประมวลผลในหน่วยมิลลิวินาที
meta.access	วิธีการให้สิทธิ์การเข้าถึงและเหตุผลในการเลือกใช้การทดลองใช้ ถ้ามี
meta.usage	ค่าใช้จ่ายสุทธิ ยอดเวลาที่เสร็จสมบูรณ์ สถานะการเรียกเก็บเงิน และข้อมูลการรีเซ็ตการทดลอง

{
  "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
    }
  }
}

สคีมาการตอบสนองและตัวอย่างแบทช์ที่สมบูรณ์

ความสำเร็จที่ไม่ทราบผลลัพธ์

HTTP 200 หมายถึงการดำเนินการเสร็จสมบูรณ์ มันไม่รับประกันเรื่องเพศ รักษา JSON null ไว้ แทนที่จะแปลงเป็น male, female ซึ่งเป็นสตริงว่างหรือความเชื่อมั่นเป็นศูนย์ ตรวจสอบ data.result_status และ data.reason แยกจากข้อผิดพลาด HTTP

ตัวอย่างเฉพาะชุดข้อมูลนี้ส่งคืน source: none และ reason: not_found และยังคงมีราคา 1 เครดิต หากชุดข้อมูลนับสำหรับสองเพศเท่ากัน ผลลัพธ์อาจมี reason: ambiguous ขณะรักษา sample_count ไว้ ผลลัพธ์ AI ที่ไม่รู้จักใช้ source: ai และ 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": "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
    }
  }
}

ตีความความเชื่อมั่นและหลักฐานที่ตรงกัน

ความเชื่อมั่น 0.9 อยู่ในระดับ 0–1 สำหรับ observed_frequency หมายถึงจำนวนที่โดดเด่นหารด้วยผลรวมชุดข้อมูลที่เลือก ไม่ได้วัดความถูกต้องของผลิตภัณฑ์ตั้งแต่ต้นจนจบ คะแนน model_reported จัดทำโดย AI และไม่ได้ปรับเทียบกับความถี่ชุดข้อมูล

เลือกเกณฑ์การใช้งานใดๆ โดยใช้ข้อมูลการประเมินของคุณเองและ confidence_kind อย่าจัดอันดับชุดข้อมูลและคะแนน AI โดยตรงเหมือนกับว่าวัดสิ่งเดียวกัน AI match.name, match.scope และ match.country คือ null เนื่องจากไม่ได้เลือกแถวชุดข้อมูล match.method คือ model_inference

สำหรับชื่อเต็ม ผลลัพธ์ของชุดข้อมูลอาจมาจากส่วนประกอบแทนที่จะเป็นสตริงแบบเต็ม data.input จะรักษาค่าที่ส่ง data.name อธิบายชื่อที่ส่งคืน และ data.match อธิบายขอบเขตผู้สมัครและการค้นหา

ทำความเข้าใจกับการตอบสนองของ JSON

ความสำเร็จที่ไม่ทราบผลลัพธ์

ตีความความเชื่อมั่นและหลักฐานที่ตรงกัน

คำแนะนำที่เกี่ยวข้อง