Namnsignaler och smeknamns betydelse är olika saker
Använd type: username för ett användarnamn eller smeknamn. Ett valfritt inledande @ tas bort vid matchningen mot datamängden. Extraheringen av kandidater tar hänsyn till avgränsare och siffror och kan kontrollera begränsade delsträngar. Smeknamnsläget behåller matchningen av hela delar men lägger inte till sådana delsträngskandidater. Den valda lagrade posten har det största totala antalet bland de tillgängliga kandidaterna; det visar inte det riktiga namnet på personen bakom kontot.
Vanlig AI-reserv letar efter ett igenkännbart förnamn. forceToGenderize tillåter dessutom en koppling via ett personligt smeknamn när inget riktigt namn kan extraheras. Båda vägarna kan returnera unknown; ett varumärke, en fiktiv figur eller ett delat konto representerar inte nödvändigtvis en enskild person.
| Exempel på indata | Tillvägagångssätt | Vad du bör kontrollera |
|---|---|---|
@alice.smith | Börja med vanlig fallback, som kontrollerar datamängden först. | Granska det valda namnet och matchningsmetoden; utgå inte från att den första delen valdes. |
robert89 | Siffrorna kan tas bort när kandidaterna extraheras. | Ett matchande namn är en koppling, ingen bekräftad identitet. |
prenses | Aktivera forceToGenderize för att tillåta ett AI-försök utifrån smeknamnet när inget resultat hittas. | gender kan vara ett annat värde än null medan name är null. AI-värden är model_reported. |
team_support | Behandla funktionskonton och delade konton som konton som kanske inte hör till en enskild person. | Behåll unknown och tilldela inte ett delat konto en individuell identitet. |
Testa tolkning av smeknamn i din integration
Den här förfrågan aktiverar tolkning av smeknamn. Datamängden kontrolleras först. Om den inte ger något kön kan AI använda aliasets betydelse. Utelämna forceToGenderize för en vanlig sökning; enskilda förfrågningar använder ändå vanlig AI-reserv som standard.
Landskontexten TR anges för det här exemplet. Använd relevant kontext från din applikation och kontrollera data.match.scope; ett angivet land garanterar ingen landsspecifik post. Det visar varken nationalitet eller bosättning.
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 |
Behåll resultatet för varje användarnamn när du bearbetar en lista
Använd POST /api/v2/gender/batch för listor med användarnamn eller för blandade listor med namn, e-postadresser och användarnamn. Gränsen är 50 poster med API-nyckel eller 10 i IP-provperioden. Varje post har egna alternativ för land och AI, och valfria ID:n måste vara unika inom batchen.
Som standard använder en batch bara datamängden. Aktivera fallback per post om du vill använda vanlig AI, eller ange forceToGenderize per post för tolkning av smeknamn. Kontrollera data eller error i varje resultat och använd id eller index för att koppla resultatet till den ursprungliga raden. Lyckade okända poster debiteras.
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
Måste ett användarnamn innehålla ett riktigt förnamn?
Vanlig AI-prediktion kräver ett användbart förnamn. Med forceToGenderize kan API:et dessutom försöka göra en koppling via ett smeknamn när sökningen i datamängden inte ger något resultat. Det läget kräver inget riktigt förnamn och kan returnera name: null.
Garanterar forceToGenderize ett kön?
Nej. Det tillåter tolkning av smeknamn, men det slutliga resultatet kan ändå vara okänt. Behåll det inbyggda JSON-värdet null och kontrollera result_status och reason.
Kontrollerar API:et profilen i sociala medier?
Den här endpointen tolkar det skickade värdet. Den hämtar varken kontots profil, inlägg eller foton för att ta reda på vem som äger det.
Kan jag använda forceToGenderize även för namn eller e-postadresser?
Ja. Det är valfritt för indata av typen name, email och username. Datamängden används först och därefter AI med tolkning av smeknamn om inget resultat hittas: 1 kredit för ett resultat som fastställs i datamängden eller totalt 2 om AI används.