إشارات الاسم ومعنى الاسم المستعار أمران مختلفان
استخدم type: username لاسم مستخدم أو اسم مستعار. تُزال علامة @ الاختيارية في البداية عند المطابقة مع مجموعة البيانات. يراعي استخراج المرشحين الفواصل والأرقام، وقد يتحقق من أجزاء محدودة من السلسلة. يُبقي وضع الأسماء المستعارة المطابقة على الأجزاء الكاملة، لكنه لا يضيف هؤلاء المرشحين المبنيين على أجزاء السلسلة. يملك السجل المخزَّن المختار أعلى عدد إجمالي بين المرشحين المتاحين؛ ولا يدل ذلك على الاسم الحقيقي للشخص الذي يقف وراء الحساب.
يبحث الرجوع العادي إلى الذكاء الاصطناعي عن اسم أول يمكن التعرف عليه. ويسمح forceToGenderize أيضًا بارتباط عبر اسم مستعار شخصي عندما يتعذّر استخراج اسم حقيقي. قد يعيد كلا المسارين unknown؛ والعلامة التجارية أو الشخصية الخيالية أو الحساب المشترك لا تمثل بالضرورة شخصًا واحدًا.
| مثال على المُدخل | النهج | ما يجب التحقق منه |
|---|---|---|
@alice.smith | ابدأ بالرجوع العادي، الذي يبحث في مجموعة البيانات أولًا. | تحقّق من الاسم المختار وطريقة المطابقة؛ ولا تفترض أن الجزء الأول هو ما اختير. |
robert89 | قد تُزال الأرقام أثناء استخراج المرشحين. | الاسم المطابق ارتباط، وليس هوية مؤكدة. |
prenses | فعّل forceToGenderize للسماح بمحاولة من الذكاء الاصطناعي تعتمد على الاسم المستعار عندما لا توجد نتيجة. | قد تكون قيمة gender غير null بينما name هو null. قيم الذكاء الاصطناعي من نوع model_reported. |
team_support | تعامل مع حسابات الأدوار والحسابات المشتركة على أنها قد لا تخص شخصًا واحدًا. | احتفظ بـ unknown ولا تنسب هوية فردية إلى حساب مشترك. |
جرّب تفسير الأسماء المستعارة في تكاملك
يفعّل هذا الطلب تفسير الأسماء المستعارة. يُبحث في مجموعة البيانات أولًا. وإذا لم تُعِد جنسًا، يمكن للذكاء الاصطناعي استخدام معنى الاسم المستعار. احذف forceToGenderize للبحث العادي؛ إذ تستخدم الطلبات الفردية الرجوع العادي إلى الذكاء الاصطناعي افتراضيًا في كل الأحوال.
في هذا المثال يُرسل سياق الدولة TR. استخدم سياقًا ذا صلة من تطبيقك، وتحقّق من data.match.scope؛ فالدولة المُرسلة لا تضمن وجود سجل خاص بها. ولا تدل على الجنسية ولا على مكان الإقامة.
اختر لغة البرمجة. إعداد مفتاح API، ثم شغّل المثال على خادمك.
كل طلب تقدير عملية جديدة مدفوعة، حتى عند إعادة المحاولة. لا تعيد هذه الأمثلة المحاولة تلقائيًا. تحقّق من حالة الخصم قبل إرسال طلب آخر.
قبل التشغيل: الوصول ومعالجة الأخطاء
شغّل هذه الأمثلة على خادمك. اضبط GENDERAPI_API_KEY في بيئة العملية على مفتاح API الحالي. تأكد من أن قيمة meta.access.mode هي api_key: فالمفتاح غير المعروف قد يؤدي إلى استخدام التجربة حسب عنوان IP.
في استجابات JSON ذات رموز HTTP 4xx و5xx، يُحتفظ بجسم الخطأ وينتهي المثال برمز خروج غير صفري. تحقّق من code وaction وmeta.usage.billing_status قبل إعادة المحاولة.
دليل الأخطاء وإعادة المحاولة ←cURL 7.76+ في واجهة أوامر POSIX. شغّله في الطرفية. وثائق بيئة التشغيل
Node.js 22+ مع fetch المدمج. احفظه باسم example.mjs وشغّل node example.mjs. وثائق بيئة التشغيل
Python 3.10+ مع المكتبة القياسية. احفظه باسم example.py وشغّل python3 example.py. وثائق بيئة التشغيل
PHP 8+ مع امتداد cURL. احفظه باسم example.php وشغّل php example.php. وثائق بيئة التشغيل
Java 17+ مع عميل HTTP القياسي. احفظه باسم GenderApiExample.java وشغّل java GenderApiExample.java. وثائق بيئة التشغيل
تطبيق وحدة تحكم (console) على .NET 8+. استخدمه كملف Program.cs في مشروع console، ثم شغّل dotnet run. وثائق بيئة التشغيل
Go 1.22+ مع المكتبة القياسية. احفظه باسم main.go وشغّل go run main.go. وثائق بيئة التشغيل
احفظ النتيجة مع أدلتها
الارتباط المُستنتج ليس الجنس الذي يصرّح به الشخص. احفظ المُدخل الأصلي والأدلة المُعادة وما صرّح به الشخص كلًّا على حدة. النتيجة غير المعروفة نتيجة صالحة، ولا ينبغي أن تتحول في تطبيقك إلى فئة مُخمَّنة.
| الحقل | طريقة الاستخدام |
|---|---|
data.gender / data.result_status | استخدم male أو female فقط مع identified. في النتيجة غير المعروفة، احتفظ بقيمة JSON null الأصلية. |
data.name / data.match | تحقّق من الاسم المُعاد ومن المرشح المختار. لا تثبت المطابقة على جزء من السلسلة أن المُدخل يخص شخصًا بهذا الاسم. |
data.confidence / data.confidence_kind | درجة الثقة على مقياس من 0 إلى 1 أو null. تستند observed_frequency إلى تكرارات مخزَّنة؛ أما model_reported فقيمة يقدّمها الذكاء الاصطناعي. قيّم العتبات لكل نوع على حدة. |
data.source / data.sample_count | ميّز بين dataset وai وnone. لا تملك نتائج الذكاء الاصطناعي حجم عينة مخزَّنًا. وحجم العينة ليس قيمة دقة مقيسة. |
meta.access.mode | في تكامل مرتبط بحساب، تحقّق من أن القيمة api_key. أما المفاتيح المفقودة أو غير المعروفة فقد تستخدم التجربة المشتركة حسب عنوان IP. |
meta.usage | اقرأ charged_credits وbilling_status. تُخصم أرصدة النتيجة غير المعروفة الناجحة. ولا يثبت فقدان الاستجابة أن الطلب كان مجانيًا. |
متى تستخدم الذكاء الاصطناعي
forceToGenderize اختياري للأسماء وعناوين البريد الإلكتروني وأسماء المستخدمين. عند تفعيله، احذف ai_mode أو استخدم fallback؛ فلا يمكن الجمع بينه وبين off أو always، ويعيد ذلك 422. يكفي رصيد ابتدائي موجب لبدء الطلب، حتى لو جعل الخصم النهائي الرصيد سالبًا.
قد يعيد وضع الأسماء المستعارة جنسًا مع name: null، وقد يعطي أيضًا نتيجة غير معروفة. لا يضمن الرجوع العادي إلى الذكاء الاصطناعي ولا تفسير الأسماء المستعارة إجابة صحيحة أو قيمة غير null.
| خيار الطلب | السلوك | الأرصدة لكل بحث ناجح |
|---|---|---|
| options.ai_mode: off | يستخدم مجموعة البيانات فقط. | 1، حتى للنتيجة غير المعروفة |
| options.ai_mode: fallback | يبحث في مجموعة البيانات أولًا، ثم يستخدم الذكاء الاصطناعي العادي إذا لم يُعَد جنس. وهو الإعداد الافتراضي للطلبات الفردية. | 1 إجمالًا، بما في ذلك الرجوع إلى الذكاء الاصطناعي |
| options.ai_mode: always | يستخدم الذكاء الاصطناعي مباشرة. | 2 |
| forceToGenderize: true | يبحث في مجموعة البيانات أولًا، ثم يترك للذكاء الاصطناعي تفسير اسم مستعار شخصي أو كنية، حتى دون اسم أول حقيقي. | 1 للنتيجة الموجودة في مجموعة البيانات؛ و2 إجمالًا إذا استُخدم الذكاء الاصطناعي |
احتفظ بنتيجة كل اسم مستخدم عند معالجة قائمة
استخدم POST /api/v2/gender/batch لقوائم أسماء المستخدمين أو للقوائم المختلطة من الأسماء وعناوين البريد الإلكتروني وأسماء المستخدمين. الحد 50 عنصرًا مع مفتاح API أو 10 عناصر في التجربة حسب عنوان IP. لكل عنصر خيارات خاصة به للدولة وللذكاء الاصطناعي، ويجب أن تكون المعرّفات الاختيارية فريدة داخل الطلب المجمّع.
افتراضيًا، يستخدم الطلب المجمّع مجموعة البيانات فقط. فعّل fallback لكل عنصر إذا أردت استخدام الذكاء الاصطناعي العادي، أو اضبط forceToGenderize لكل عنصر لتفسير الأسماء المستعارة. افحص data أو error في كل نتيجة، واستخدم id أو index لمطابقة النتيجة مع الصف الأصلي. تُخصم أرصدة العناصر غير المعروفة الناجحة.
اعرف ما الذي ترسله
لا يرسل العرض المباشر القيمة المُدخلة إلى GenderAPI.io إلا عندما ترسلها بنفسك. إذا استُخدم الذكاء الاصطناعي، تُنقل type وvalue وسياق الدولة المُرسل إلى الخدمة المهيأة للتقديرات. للحصول على تقدير يعتمد على مجموعة البيانات فقط، اضبط options.ai_mode: off في تكاملك دون forceToGenderize.
تصف سياسة الخصوصية واتفاقية معالجة البيانات وقائمة المعالجين الفرعيين شروط المعالجة المنشورة. النتيجة ارتباط مُستنتج، وما يصرّح به الشخص هو المقدَّم. لا تستخدمها أساسًا لقرارات ذات عواقب مهمة على أي شخص.
الأسئلة الشائعة
هل يجب أن يحتوي اسم المستخدم على اسم أول حقيقي؟
يتطلب التقدير العادي بالذكاء الاصطناعي اسمًا أول قابلًا للاستخدام. ومع forceToGenderize يمكن لـ API أيضًا محاولة الربط عبر اسم مستعار عندما لا يعطي البحث في مجموعة البيانات نتيجة. لا يتطلب هذا الوضع اسمًا أول حقيقيًا، وقد يعيد name: null.
هل يضمن forceToGenderize الحصول على جنس؟
لا. فهو يتيح تفسير الأسماء المستعارة، لكن النتيجة النهائية قد تظل غير معروفة. احتفظ بقيمة JSON null الأصلية وتحقّق من result_status وreason.
هل تفحص API ملف الحساب على وسائل التواصل الاجتماعي؟
تفسّر نقطة النهاية هذه القيمة المُرسلة فقط. ولا تجلب ملف الحساب أو منشوراته أو صوره لمعرفة صاحبه.
هل يمكنني استخدام forceToGenderize مع الأسماء أو عناوين البريد الإلكتروني أيضًا؟
نعم. وهو اختياري للمُدخلات من نوع name وemail وusername. تُستخدم مجموعة البيانات أولًا، ثم الذكاء الاصطناعي مع تفسير الأسماء المستعارة إذا لم توجد نتيجة: رصيد واحد للنتيجة الموجودة في مجموعة البيانات أو رصيدان إجمالًا إذا استُخدم الذكاء الاصطناعي.