Behåll den arabiska stavningen och granska det matchade namnet
Skicka namnet i sin ursprungliga Unicode-stavning. Verktygets indatafält visar arabisk text från höger till vänster, medan den här svenska guiden och JSON-svaret läses från vänster till höger. Du behöver inte först translitterera namnet till latinsk skrift. Att API:et tar emot stavningen är inget löfte om att datamängden innehåller en matchande post.
Sökningen i datamängden tillämpar Unicode-normaliseringen NFKC och delar upp texten i delar. Den innehåller ingen allmän regel som tar bort arabiska diakritiska tecken eller likställer olika stavningar. Vokaltecken och andra skillnader i stavningen kan därför påverka vilken lagrad post som hittas. Behåll det ursprungliga värdet i stället för att tyst behandla alla varianter som identiska.
Ett fullständigt namn kan ge flera kandidater. Den tillgängliga posten med det största lagrade totala antalet väljs, så det första ordet behöver inte vara det förnamn som returneras. Granska data.name och data.match.name innan du använder ett resultat för att berika en post.
| Exempel på indata | Vad det visar | Vad du bör kontrollera |
|---|---|---|
ليلى الخطيب | Exempel på ett fullständigt namn | Flera delar kan tas med i sökningen. Granska den valda träffen; exemplet förutsäger inget liveresultat. |
ليلى / لَيْلَى | Stavning utan och med vokaltecken | Skicka den faktiska stavningen. Det är inte garanterat att båda strängarna kopplas till samma lagrade post. |
Layla / Leila | Stavningar med latinsk skrift | Det är separata indatavärden. V2 garanterar ingen automatisk likvärdighet mellan translittereringar. |
country: SA | Exempel på kontext: Saudiarabien | Kontexten är inget standardvärde för alla arabisktalande grupper. Utelämna country när landet är okänt. |
Välj landskontexten SA medvetet
Demon skickar country: SA (Saudiarabien). API:et väljer inte landet utifrån den skrift som namnet är skrivet med. Använd en känd och passande landskontext i din integration eller utelämna country. Gör inte det här exemplet till standardvärde för alla poster.
För varje kandidat väljer sökningen den landsspecifika posten om den finns och kontrollerar annars den globala posten. Därefter väljs den tillgängliga kandidaten med det största lagrade totala antalet. Träffens faktiska omfattning ser du i data.match.scope och data.match.country. En landsspecifik post med lika frekvenser ersätts inte automatiskt av det globala resultatet; om reserven är aktiverad kan AI användas i stället.
data.input.country beskriver den kontext som skickades i förfrågan. data.country och data.country_source beskriver den returnerade landskopplingen och dess ursprung. Det är olika fält; de visar varken medborgarskap, etniskt ursprung eller bostadsort.
Skicka en V2-förfrågan för namn från din applikation
Sätt GENDERAPI_API_KEY till din befintliga nyckel och kör exemplet på din server. Förfrågan aktiverar uttryckligen den vanliga AI-reserven. Den visar förfrågans format, inte någon uppmätt noggrannhet eller bekräftad täckning. För en prediktion som bara använder datamängden anger du options.ai_mode: off.
Välj ett programmeringsspråk. Konfigurera din API-nyckel, kör sedan exemplet på din server.
Varje prediktionsförfrågan är en ny debiterbar åtgärd, även vid nya försök. Exemplen gör inga automatiska nya försök. Kontrollera debiteringsstatus innan du skickar en ny förfrågan.
Innan du kör: åtkomst och felhantering
Kör exemplen på din server. Sätt GENDERAPI_API_KEY i processmiljön till din befintliga API-nyckel. Kontrollera att meta.access.mode är api_key: en nyckel som inte känns igen kan leda till IP-provperioden.
Vid JSON-svar med HTTP 4xx och 5xx behålls felinnehållet och exemplet avslutas med en slutstatus som inte är noll. Kontrollera code, action och meta.usage.billing_status innan du försöker igen.
Guide om fel och nya försök →cURL 7.76+ i ett POSIX-skal. Kör i terminalen. Dokumentation för körmiljön
Node.js 22+; inbyggd fetch. Spara som example.mjs och kör node example.mjs. Dokumentation för körmiljön
Python 3.10+; standardbiblioteket. Spara som example.py och kör python3 example.py. Dokumentation för körmiljön
PHP 8+ med tillägget cURL. Spara som example.php och kör php example.php. Dokumentation för körmiljön
Java 17+; inbyggd HTTP-klient. Spara som GenderApiExample.java och kör java GenderApiExample.java. Dokumentation för körmiljön
Konsolapplikation med .NET 8+. Använd som Program.cs i ett konsolprojekt och kör sedan dotnet run. Dokumentation för körmiljön
Go 1.22+; standardbiblioteket. Spara som main.go och kör go run main.go. Dokumentation för körmiljön
Spara resultatet tillsammans med underlaget
En härledd koppling är inte det kön som en person själv uppger. Spara ursprungliga indata, det returnerade underlaget och det personen själv har angett separat. Ett okänt resultat är ett giltigt resultat och bör inte bli en gissad kategori i din applikation.
| Fält | Användning |
|---|---|
data.gender / data.result_status | Använd male eller female bara vid identified. Behåll det inbyggda JSON-värdet null vid ett okänt resultat. |
data.name / data.match | Granska det returnerade namnet och den valda kandidaten. En träff på en delsträng visar inte att indata tillhör en person med det förnamnet. |
data.confidence / data.confidence_kind | Konfidensen ligger på en skala från 0 till 1 eller är null. observed_frequency bygger på lagrade frekvenser; model_reported är ett AI-värde. Utvärdera tröskelvärden separat för varje typ. |
data.source / data.sample_count | Skilj mellan dataset, ai och none. AI-resultat har ingen lagrad urvalsstorlek. En urvalsstorlek är inget uppmätt noggrannhetsvärde. |
meta.access.mode | Kontrollera att api_key rapporteras i en kontointegration. Nycklar som saknas eller inte känns igen kan i stället använda den delade IP-provperioden. |
meta.usage | Läs charged_credits och billing_status. Ett lyckat okänt resultat debiteras. Ett förlorat svar visar inte att förfrågan var kostnadsfri. |
Bestäm när AI ska användas
forceToGenderize är valfritt för namn, e-postadresser och användarnamn. När det är aktiverat utelämnar du ai_mode eller använder fallback; off och always kan inte kombineras med det och ger 422. Ett positivt startsaldo räcker för att starta en förfrågan, även om den slutliga debiteringen gör saldot negativt.
Smeknamnsläget kan returnera ett kön tillsammans med name: null. Det kan också ge ett okänt resultat. Varken vanlig AI-reserv eller tolkning av smeknamn garanterar ett korrekt svar eller ett värde som inte är null.
| Alternativ i förfrågan | Beteende | Krediter för en lyckad sökning |
|---|---|---|
| options.ai_mode: off | Använd bara datamängden. | 1, även för ett okänt resultat |
| options.ai_mode: fallback | Kontrollera datamängden först och använd sedan vanlig AI om inget kön returneras. Detta är standard för enskilda förfrågningar. | Totalt 1, inklusive AI-reserv |
| options.ai_mode: always | Använd AI direkt. | 2 |
| forceToGenderize: true | Kontrollera datamängden först och låt sedan AI tolka ett personligt smeknamn eller alias, även utan ett riktigt förnamn. | 1 för ett resultat som fastställs i datamängden; totalt 2 om AI används |
Bearbeta en namnlista utan att tappa kontexten
Skicka upp till 50 poster med en API-nyckel eller 10 med IP-provperioden via POST /api/v2/gender/batch. Ge posterna unika id och behåll det ursprungliga värdet för varje rad. Varje post kan ha egna alternativ för land och AI; utelämna landet när det är okänt.
Till skillnad från enskilda förfrågningar, som använder reserven som standard, använder poster i en batch som standard bara datamängden. Ange options.ai_mode: fallback i varje post som behöver AI. Kontrollera varje resultat, även efter HTTP 200, behåll okända resultat och granska fel och debitering innan du skickar igen. Varje lyckad vanlig post kostar 1 kredit; en HTTP-förfrågan med en batch motsvarar inte en kredit per prediktion.
Veta vad du skickar
Livedemon skickar det inmatade värdet till GenderAPI.io först när du skickar in det. Om AI används skickas den inskickade type, value och landskontexten till den konfigurerade tjänsten för prediktioner. För en prediktion som bara använder datamängden anger du options.ai_mode: off utan forceToGenderize i din integration.
Integritetspolicyn, personuppgiftsbiträdesavtalet och förteckningen över underbiträden beskriver de publicerade villkoren för behandlingen. Ett resultat är en härledd koppling, och det en person själv uppger har företräde. Använd det inte som grund för beslut med stora konsekvenser för en person.
Vanliga frågor
Tar V2 emot arabiska namn med diakritiska tecken?
V2 tar emot namn i Unicode, även text med arabisk skrift. Normaliseringen i datamängden tar i regel inte bort arabiska vokaltecken. Stavningar med och utan vokaltecken kan därför ge olika träffar eller ett okänt resultat.
Avgör verktyget nationaliteten hos en arabisktalande person?
Nej. SA är den landskontext som uttryckligen har valts för den här demonstrationen. Skriften, en namnkoppling eller ett returnerat landsfält visar varken nationalitet eller bostadsort.
Har en oberoende utvärdering av noggrannheten publicerats för den här namngruppen?
Den här sidan publicerar ingen sådan utvärdering. Att indata tas emot, att lagrade frekvenser visas eller att ett konfidensvärde returneras är ingen oberoende mätning av noggrannheten. Metodiken visar vilka uppgifter som finns och vilka mätningar som ännu inte har publicerats.
Förbrukar ett resultat utan prediktion krediter?
Ett lyckat okänt resultat debiteras. Vanligt läge med datamängden eller med reserv kostar totalt 1 kredit. Med forceToGenderize kostar förfrågan 1 kredit om datamängden ger resultatet, eller totalt 2 om AI används, även vid ett okänt resultat. För fel gäller egna debiteringsregler; kontrollera meta.usage.