नाम के संकेत और निकनेम का अर्थ अलग-अलग चीज़ें हैं
हैंडल या निकनेम के लिए type: username इस्तेमाल करें। डेटासेट मिलान के लिए शुरुआत में लगा वैकल्पिक @ हटा दिया जाता है। कैंडिडेट निकालते समय विभाजक चिह्न और अंक संभाले जाते हैं और सीमित सबस्ट्रिंग भी आज़माए जा सकते हैं। निकनेम मोड टोकन मिलान रखता है, लेकिन ये सबस्ट्रिंग कैंडिडेट नहीं जोड़ता। चुने गए संग्रहीत रिकॉर्ड की कुल गिनती उपलब्ध कैंडिडेट में सबसे ज़्यादा होती है; यह अकाउंट के मालिक के असली नाम का प्रमाण नहीं है।
सामान्य AI फ़ॉलबैक पहचाना जा सकने वाला पहला नाम खोजता है। असली नाम न निकाला जा सके, तो forceToGenderize निजी निकनेम के आधार पर संबंध जोड़ने की अनुमति भी देता है। दोनों तरीकों से unknown मिल सकता है; ब्रांड, किरदार या साझा अकाउंट ज़रूरी नहीं कि किसी एक व्यक्ति के हों।
| इनपुट का उदाहरण | तरीका | क्या जाँचें |
|---|---|---|
@alice.smith | सामान्य फ़ॉलबैक से शुरू करें, जो पहले डेटासेट जाँचता है। | चुना गया नाम और मिलान का तरीका जाँचें; यह न मानें कि पहला टोकन ही चुना गया। |
robert89 | कैंडिडेट निकालते समय अंक हटाए जा सकते हैं। | मेल खाने वाला नाम एक संबंध है, सत्यापित पहचान नहीं। |
prenses | परिणाम न मिलने पर निकनेम पर आधारित AI प्रयास की अनुमति के लिए forceToGenderize चालू करें। | gender non-null हो सकता है जबकि name null हो। AI स्कोर model_reported होते हैं। |
team_support | रोल वाले या साझा अकाउंट को संभवतः गैर-निजी मानें। | unknown ही रहने दें और साझा अकाउंट को किसी एक व्यक्ति की पहचान न दें। |
अपने इंटीग्रेशन में निकनेम का अनुमान आज़माएँ
यह अनुरोध निकनेम का अनुमान चालू करता है। पहले डेटासेट जाँचा जाता है। उससे लिंग न मिले, तो AI छद्मनाम के अर्थ का इस्तेमाल कर सकता है। सामान्य अनुरोध के लिए forceToGenderize छोड़ दें; एकल अनुरोध डिफ़ॉल्ट रूप से फिर भी सामान्य AI फ़ॉलबैक इस्तेमाल करते हैं।
इस उदाहरण में देश का संदर्भ TR दिया गया है। अपने ऐप्लिकेशन का प्रासंगिक संदर्भ इस्तेमाल करें और data.match.scope जाँचें; इनपुट में देश देने से उस देश के खास रिकॉर्ड की गारंटी नहीं मिलती। इससे राष्ट्रीयता या निवास भी तय नहीं होता।
अपनी प्रोग्रामिंग भाषा चुनें। अपनी API कुंजी सेट करें, फिर अपने सर्वर पर उदाहरण चलाएँ।
अनुमान का हर अनुरोध, दोबारा प्रयास सहित, शुल्क वाली नई प्रक्रिया है। ये उदाहरण अपने-आप दोबारा प्रयास नहीं करते। दूसरा अनुरोध भेजने से पहले बिलिंग स्टेटस देखें।
चलाने से पहले: एक्सेस और त्रुटियों को संभालना
ये उदाहरण अपने सर्वर पर चलाएँ। प्रोसेस एनवायरनमेंट में GENDERAPI_API_KEY को अपनी मौजूदा API कुंजी पर सेट करें। पक्का करें कि meta.access.mode का मान api_key है: पहचानी न गई कुंजी IP ट्रायल पर जा सकती है।
HTTP 4xx और 5xx वाले JSON रिस्पॉन्स में त्रुटि की बॉडी बनी रहती है और प्रोग्राम शून्य से अलग एग्ज़िट स्टेटस लौटाता है। दोबारा प्रयास से पहले code, action और meta.usage.billing_status देखें।
त्रुटियों और दोबारा प्रयास की गाइड →POSIX शेल में cURL 7.76+। अपने टर्मिनल में चलाएँ। रनटाइम दस्तावेज़ीकरण
Node.js 22+; बिल्ट-इन fetch। example.mjs के रूप में सेव करें और node example.mjs चलाएँ। रनटाइम दस्तावेज़ीकरण
Python 3.10+; स्टैंडर्ड लाइब्रेरी। example.py के रूप में सेव करें और python3 example.py चलाएँ। रनटाइम दस्तावेज़ीकरण
cURL एक्सटेंशन के साथ PHP 8+। example.php के रूप में सेव करें और php example.php चलाएँ। रनटाइम दस्तावेज़ीकरण
Java 17+; स्टैंडर्ड HTTP क्लाइंट। GenderApiExample.java के रूप में सेव करें और java GenderApiExample.java चलाएँ। रनटाइम दस्तावेज़ीकरण
.NET 8+ कंसोल ऐप्लिकेशन। कंसोल प्रोजेक्ट में Program.cs के रूप में इस्तेमाल करें, फिर 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 AI का स्कोर है। हर प्रकार के लिए सीमा का अलग आकलन करें। |
data.source / data.sample_count | dataset, ai और none में अंतर करें। AI परिणामों में संग्रहीत सैंपल गिनती नहीं होती। सैंपल गिनती मापी गई सटीकता नहीं है। |
meta.access.mode | अकाउंट वाले इंटीग्रेशन में पक्का करें कि मान api_key है। कुंजी न होने या पहचानी न जाने पर साझा IP ट्रायल इस्तेमाल हो सकता है। |
meta.usage | charged_credits और billing_status पढ़ें। सफल अज्ञात परिणाम पर शुल्क लगता है। रिस्पॉन्स खो जाने से यह साबित नहीं होता कि अनुरोध मुफ़्त था। |
तय करें कि AI कब इस्तेमाल करना है
नामों, ईमेल पतों और यूज़रनेम के लिए forceToGenderize वैकल्पिक है। इसे चालू करने पर ai_mode छोड़ दें या fallback इस्तेमाल करें; off और always का इससे टकराव होता है और 422 लौटता है। अनुरोध शुरू करने के लिए पॉज़िटिव शुरुआती बैलेंस काफ़ी है, भले ही अंतिम शुल्क के बाद बैलेंस शून्य से नीचे चला जाए।
निकनेम मोड name: null के साथ लिंग लौटा सकता है। यह अज्ञात परिणाम भी लौटा सकता है। न सामान्य AI फ़ॉलबैक और न ही निकनेम का अनुमान सही या non-null जवाब की गारंटी देता है।
| अनुरोध का विकल्प | व्यवहार | हर सफल अनुरोध पर क्रेडिट |
|---|---|---|
| options.ai_mode: off | सिर्फ़ डेटासेट इस्तेमाल करें। | 1, अज्ञात परिणाम पर भी |
| options.ai_mode: fallback | पहले डेटासेट, फिर लिंग न मिलने पर सामान्य AI। एकल अनुरोध का डिफ़ॉल्ट यही है। | कुल 1, AI फ़ॉलबैक सहित |
| options.ai_mode: always | सीधे AI से पूछें। | 2 |
| forceToGenderize: true | पहले डेटासेट, फिर AI को निजी निकनेम या छद्मनाम समझने की अनुमति, असली पहले नाम के बिना भी। | डेटासेट से परिणाम मिलने पर 1; AI इस्तेमाल होने पर कुल 2 |
सूची प्रोसेस करते समय हर हैंडल का परिणाम सुरक्षित रखें
यूज़रनेम की सूचियों, या नामों, ईमेल पतों और यूज़रनेम की मिली-जुली सूची के लिए POST /api/v2/gender/batch इस्तेमाल करें। API कुंजी के साथ अधिकतम 50 आइटम और IP ट्रायल में 10 आइटम भेजे जा सकते हैं। हर आइटम के अपने देश और AI विकल्प होते हैं; वैकल्पिक ID बैच के अंदर यूनिक होने चाहिए।
बैच का डिफ़ॉल्ट सिर्फ़ डेटासेट है। सामान्य AI चाहिए, तो हर आइटम पर fallback चालू करें, या निकनेम के अनुमान के लिए हर आइटम पर forceToGenderize सेट करें। हर परिणाम में data या error जाँचें और मूल पंक्ति से संबंध बनाए रखने के लिए id या index इस्तेमाल करें। सफल अज्ञात आइटम पर शुल्क लगता है।
समझें कि आप क्या भेजते हैं
लाइव डेमो डाला गया मान GenderAPI.io को सिर्फ़ तभी भेजता है जब आप उसे सबमिट करते हैं। AI इस्तेमाल होने पर भेजा गया type, value और देश का संदर्भ कॉन्फ़िगर की गई अनुमान सेवा को भेजा जाता है। सिर्फ़ डेटासेट वाले अनुमान के लिए अपने इंटीग्रेशन में forceToGenderize के बिना options.ai_mode: off इस्तेमाल करें।
प्राइवेसी पॉलिसी, डेटा प्रोसेसिंग समझौता और सबप्रोसेसर सूची प्रकाशित प्रोसेसिंग शर्तों का विवरण देते हैं। परिणाम एक अनुमानित संबंध है; व्यक्ति की दी हुई जानकारी को प्राथमिकता दें। किसी व्यक्ति के बारे में महत्वपूर्ण फ़ैसलों का आधार इसे न बनाएँ।
अक्सर पूछे जाने वाले सवाल
क्या यूज़रनेम में असली पहला नाम होना ज़रूरी है?
सामान्य AI अनुमान के लिए इस्तेमाल करने लायक पहला नाम चाहिए। forceToGenderize के साथ, डेटासेट खोज से परिणाम न मिलने पर API निकनेम के आधार पर संबंध जोड़ने का प्रयास भी कर सकता है। इस मोड में असली पहला नाम ज़रूरी नहीं है और यह name: null लौटा सकता है।
क्या forceToGenderize लिंग मिलने की गारंटी देता है?
नहीं। यह निकनेम के अनुमान की अनुमति देता है, लेकिन अंतिम परिणाम फिर भी अज्ञात हो सकता है। JSON का असली null मान वैसे ही रखें और result_status और reason जाँचें।
क्या API सोशल मीडिया प्रोफ़ाइल देखता है?
यह एंडपॉइंट सिर्फ़ भेजे गए मान का विश्लेषण करता है। यह पुष्टि करने के लिए कि अकाउंट किसका है, अकाउंट की प्रोफ़ाइल, पोस्ट या फ़ोटो नहीं लाता।
क्या नामों या ईमेल के साथ भी forceToGenderize इस्तेमाल किया जा सकता है?
हाँ। यह name, email और username इनपुट के लिए वैकल्पिक है। यह पहले डेटासेट इस्तेमाल करता है, फिर परिणाम न मिलने पर निकनेम समझने वाला AI: डेटासेट से परिणाम मिलने पर 1 क्रेडिट और AI इस्तेमाल होने पर कुल 2 क्रेडिट।