Naamsignalen en de betekenis van bijnamen zijn verschillende dingen
Gebruik type: username voor een gebruikersnaam of bijnaam. Een optionele @ aan het begin wordt bij de match met de dataset verwijderd. Bij het zoeken naar kandidaten wordt rekening gehouden met scheidingstekens en cijfers en kunnen beperkte delen van tekenreeksen worden gecontroleerd. De bijnaammodus behoudt de match op hele delen, maar voegt deze kandidaten op basis van delen van tekenreeksen niet toe. Het geselecteerde opgeslagen item heeft de hoogste totale telling van de beschikbare kandidaten; dat zegt niets over de echte naam van de persoon achter het account.
De normale AI-fallback zoekt naar een herkenbare voornaam. forceToGenderize maakt daarnaast een koppeling via een persoonlijke bijnaam mogelijk als er geen echte naam kan worden gevonden. Beide wegen kunnen unknown teruggeven; een merk, een fictief personage of een gedeeld account staat niet per se voor één persoon.
| Voorbeeldinvoer | Aanpak | Wat u controleert |
|---|---|---|
@alice.smith | Begin met de normale fallback, die eerst de dataset raadpleegt. | Controleer de geselecteerde naam en de matchmethode; ga er niet van uit dat het eerste deel is gekozen. |
robert89 | Cijfers kunnen bij het zoeken naar kandidaten worden verwijderd. | Een overeenkomende naam is een koppeling, geen bevestigde identiteit. |
prenses | Schakel forceToGenderize in om een AI-poging op basis van de bijnaam toe te staan als er geen resultaat wordt gevonden. | gender kan een waarde anders dan null hebben terwijl name null is. AI-waarden zijn model_reported. |
team_support | Behandel functieaccounts en gedeelde accounts als accounts die mogelijk niet bij één persoon horen. | Bewaar unknown en ken aan een gedeeld account geen individuele identiteit toe. |
Bijnaaminterpretatie in uw integratie uitproberen
Dit verzoek schakelt de bijnaaminterpretatie in. Eerst wordt de dataset geraadpleegd. Geeft die geen geslacht terug, dan kan AI de betekenis van de alias gebruiken. Laat forceToGenderize weg voor een normale zoekopdracht; losse verzoeken gebruiken standaard toch de normale AI-fallback.
Voor dit voorbeeld wordt de landcontext TR opgegeven. Gebruik relevante context uit uw eigen applicatie en controleer data.match.scope; een opgegeven land garandeert geen landspecifiek item. Het zegt niets over nationaliteit of woonplaats.
Kies een programmeertaal. Stel uw API-sleutel in, voer daarna het voorbeeld uit op uw server.
Elk voorspellingsverzoek is een nieuwe betaalde bewerking, ook als het een nieuwe poging is. Deze voorbeelden proberen het niet automatisch opnieuw. Controleer de afschrijvingsstatus voordat u een nieuw verzoek verstuurt.
Voordat u het uitvoert: toegang en foutafhandeling
Voer deze voorbeelden uit op uw server. Stel in de procesomgeving GENDERAPI_API_KEY in op uw bestaande API-sleutel. Controleer of meta.access.mode api_key is: een niet-herkende sleutel kan terugvallen op de IP-proefperiode.
Bij JSON-antwoorden met HTTP 4xx en 5xx blijft de body van de fout behouden en eindigt het voorbeeld met een afsluitcode die niet nul is. Controleer code, action en meta.usage.billing_status voordat u het opnieuw probeert.
Handleiding voor fouten en nieuwe pogingen →cURL 7.76+ in een POSIX-shell. Voer uit in uw terminal. Documentatie van de runtime
Node.js 22+; ingebouwde fetch. Sla op als example.mjs en voer node example.mjs uit. Documentatie van de runtime
Python 3.10+; standaardbibliotheek. Sla op als example.py en voer python3 example.py uit. Documentatie van de runtime
PHP 8+ met de cURL-extensie. Sla op als example.php en voer php example.php uit. Documentatie van de runtime
Java 17+; standaard HTTP-client. Sla op als GenderApiExample.java en voer java GenderApiExample.java uit. Documentatie van de runtime
.NET 8+-consoleapplicatie. Gebruik als Program.cs in een consoleproject en voer daarna dotnet run uit. Documentatie van de runtime
Go 1.22+; standaardbibliotheek. Sla op als main.go en voer go run main.go uit. Documentatie van de runtime
Het resultaat samen met het bewijs opslaan
Een afgeleide koppeling is niet het geslacht dat iemand zelf opgeeft. Sla de oorspronkelijke invoer, het teruggegeven bewijs en wat de persoon zelf heeft opgegeven apart op. Een onbekend resultaat is een geldig resultaat en mag in uw applicatie geen geraden categorie worden.
| Veld | Gebruik |
|---|---|
data.gender / data.result_status | Gebruik male of female alleen bij identified. Bewaar bij een onbekend resultaat de oorspronkelijke JSON-waarde null. |
data.name / data.match | Controleer de teruggegeven naam en de geselecteerde kandidaat. Een match op een deel van de tekenreeks bewijst niet dat de invoer bij een persoon met die naam hoort. |
data.confidence / data.confidence_kind | De betrouwbaarheidsscore staat op een schaal van 0 tot 1 of is null. observed_frequency is gebaseerd op opgeslagen frequenties; model_reported is een waarde die AI opgeeft. Evalueer drempels per soort afzonderlijk. |
data.source / data.sample_count | Maak onderscheid tussen dataset, ai en none. AI-resultaten hebben geen opgeslagen steekproefgrootte. Een steekproefgrootte is geen gemeten nauwkeurigheid. |
meta.access.mode | Controleer bij een integratie met een account of api_key wordt vermeld. Ontbrekende of niet-herkende sleutels kunnen anders de gedeelde IP-proefperiode gebruiken. |
meta.usage | Lees charged_credits en billing_status. Een geslaagd onbekend resultaat wordt afgeschreven. Een verloren antwoord bewijst niet dat het verzoek gratis was. |
Bepalen wanneer u AI gebruikt
forceToGenderize is optioneel voor namen, e-mailadressen en gebruikersnamen. Als het is ingeschakeld, laat ai_mode dan weg of gebruik fallback; off en always kunnen niet met deze optie worden gecombineerd en geven 422 terug. Een positief beginsaldo is genoeg om een verzoek te starten, ook als de uiteindelijke afschrijving het saldo negatief maakt.
De bijnaammodus kan een geslacht teruggeven samen met name: null. Ook een onbekend resultaat is mogelijk. Noch de normale AI-fallback noch de bijnaaminterpretatie garandeert een juist antwoord of een waarde anders dan null.
| Optie in het verzoek | Werking | Credits per geslaagde zoekopdracht |
|---|---|---|
| options.ai_mode: off | Gebruikt alleen de dataset. | 1, ook bij een onbekend resultaat |
| options.ai_mode: fallback | Raadpleegt eerst de dataset en gebruikt daarna de normale AI als er geen geslacht wordt teruggegeven. Dit is de standaardwaarde voor losse verzoeken. | In totaal 1, inclusief AI-fallback |
| options.ai_mode: always | Gebruikt direct AI. | 2 |
| forceToGenderize: true | Raadpleegt eerst de dataset en laat daarna AI een persoonlijke bijnaam of alias interpreteren, ook zonder echte voornaam. | 1 voor een resultaat uit de dataset; in totaal 2 als AI wordt gebruikt |
Het resultaat van elke gebruikersnaam bewaren wanneer u een lijst verwerkt
Gebruik POST /api/v2/gender/batch voor lijsten met gebruikersnamen of voor gemengde lijsten met namen, e-mailadressen en gebruikersnamen. De limiet is 50 items met een API-sleutel of 10 met de IP-proefperiode. Elk item heeft eigen opties voor land en AI, en optionele id's moeten uniek zijn binnen de batch.
Standaard gebruikt een batch alleen de dataset. Schakel fallback per item in als u de normale AI wilt gebruiken, of stel forceToGenderize per item in om bijnamen te interpreteren. Controleer data of error in elk resultaat en gebruik id of index om het resultaat aan de oorspronkelijke rij te koppelen. Geslaagde onbekende items worden afgeschreven.
Weten wat u verstuurt
De live demo verstuurt de ingevoerde waarde pas naar GenderAPI.io wanneer u die zelf verstuurt. Als AI wordt gebruikt, worden type, value en de verstuurde landcontext doorgegeven aan de dienst die voor voorspellingen is geconfigureerd. Stel voor een voorspelling die alleen de dataset gebruikt in uw integratie options.ai_mode: off in zonder forceToGenderize.
Het privacybeleid, de verwerkersovereenkomst en de lijst met subverwerkers beschrijven de gepubliceerde voorwaarden voor de verwerking. Een resultaat is een afgeleide koppeling en wat iemand zelf opgeeft, gaat altijd voor. Gebruik het niet als basis voor beslissingen met belangrijke gevolgen voor een persoon.
Veelgestelde vragen
Moet een gebruikersnaam een echte voornaam bevatten?
De normale AI-voorspelling vereist een bruikbare voornaam. Met forceToGenderize kan de API daarnaast een koppeling via een bijnaam proberen als de zoekopdracht in de dataset geen resultaat oplevert. Deze modus vereist geen echte voornaam en kan name: null teruggeven.
Garandeert forceToGenderize een geslacht?
Nee. Het maakt bijnaaminterpretatie mogelijk, maar het uiteindelijke resultaat kan toch onbekend zijn. Bewaar de oorspronkelijke JSON-waarde null en controleer result_status en reason.
Controleert de API het profiel op sociale media?
Dit endpoint interpreteert de verstuurde waarde. Het haalt geen profiel, berichten of foto's van het account op om te achterhalen wie de eigenaar is.
Kan ik forceToGenderize ook gebruiken voor namen of e-mailadressen?
Ja. Het is optioneel voor invoer van het type name, email en username. Eerst wordt de dataset gebruikt en daarna, als er geen resultaat wordt gevonden, AI met bijnaaminterpretatie: 1 credit voor een resultaat uit de dataset of in totaal 2 als AI wordt gebruikt.