Un prénom reconnaissable et le sens d’un pseudonyme sont deux signaux distincts
Utilisez type: username pour un nom d’utilisateur ou un pseudonyme. Le @ initial facultatif est supprimé pour la recherche dans le jeu de données. L’extraction des candidats gère les séparateurs et les chiffres, et peut tester des fragments de longueur limitée. Le mode pseudonyme conserve les mots candidats, mais n’ajoute pas ces fragments. L’enregistrement retenu est celui qui a l’effectif le plus élevé parmi les candidats disponibles ; cela ne prouve pas le vrai nom du titulaire du compte.
Le repli IA standard recherche un prénom reconnaissable. forceToGenderize autorise en plus une association fondée sur un pseudonyme personnel lorsqu’aucun prénom réel ne peut être extrait. Les deux modes peuvent renvoyer unknown. Une marque, un personnage ou un compte partagé ne représentent pas forcément une seule personne.
| Exemple d’entrée | Approche | Points à vérifier |
|---|---|---|
@alice.smith | Commencez par le fallback standard, qui interroge d’abord le jeu de données. | Vérifiez le nom retenu et la méthode de correspondance ; ne supposez pas que le premier mot a été choisi. |
robert89 | Les chiffres peuvent être supprimés lors de l’extraction des candidats. | Une correspondance de prénom est une association, pas une identité vérifiée. |
prenses | Activez forceToGenderize pour autoriser une tentative de l’IA fondée sur le pseudonyme si la requête n’est pas résolue. | gender peut avoir une valeur alors que name vaut null. La confiance de l’IA est de type model_reported. |
team_support | Considérez que les comptes d’équipe ou partagés peuvent ne pas être personnels. | Conservez unknown et n’attribuez pas d’identité individuelle à un compte partagé. |
Testez l’analyse des pseudonymes dans votre intégration
Cette requête active l’analyse des pseudonymes. Le jeu de données est interrogé en premier ; s’il ne renvoie aucun genre, l’IA peut interpréter le sens du pseudonyme. Omettez forceToGenderize pour une requête standard : les requêtes individuelles utilisent déjà le fallback standard par défaut.
Le contexte pays TR ne concerne que cet exemple. Utilisez le contexte pertinent de votre application et vérifiez data.match.scope. Envoyer un pays ne garantit pas une correspondance dans un enregistrement propre à ce pays et ne prouve ni la nationalité ni la résidence.
Choisissez un langage de programmation. Configurez votre clé API, puis exécutez l'exemple sur votre serveur.
Chaque requête de prédiction est une nouvelle opération facturable, y compris les nouvelles tentatives. Ces exemples ne réessaient pas automatiquement. Vérifiez le statut de facturation avant d'envoyer une autre requête.
Avant l'exécution : accès et gestion des erreurs
Exécutez ces exemples sur votre serveur. Définissez GENDERAPI_API_KEY dans l'environnement du processus avec votre clé API existante. Vérifiez que meta.access.mode vaut api_key : une clé non reconnue peut basculer vers l'essai par IP.
Pour les réponses JSON HTTP 4xx et 5xx, les exemples conservent le corps de l'erreur et renvoient un code de sortie non nul. Vérifiez code, action et meta.usage.billing_status avant de réessayer.
Guide des erreurs et des nouvelles tentatives →cURL 7.76+ dans un shell POSIX. À exécuter dans votre terminal. Documentation de l'environnement d'exécution
Node.js 22+ ; fetch intégré. Enregistrez sous example.mjs et exécutez node example.mjs. Documentation de l'environnement d'exécution
Python 3.10+ ; bibliothèque standard. Enregistrez sous example.py et exécutez python3 example.py. Documentation de l'environnement d'exécution
PHP 8+ avec l'extension cURL. Enregistrez sous example.php et exécutez php example.php. Documentation de l'environnement d'exécution
Java 17+ ; client HTTP standard. Enregistrez sous GenderApiExample.java et exécutez java GenderApiExample.java. Documentation de l'environnement d'exécution
Application console .NET 8+. Utilisez-le comme Program.cs dans un projet console, puis exécutez dotnet run. Documentation de l'environnement d'exécution
Go 1.22+ ; bibliothèque standard. Enregistrez sous main.go et exécutez go run main.go. Documentation de l'environnement d'exécution
Conservez le résultat avec ses éléments de preuve
Une association déduite n’équivaut pas au genre déclaré par la personne. Conservez séparément la valeur d’origine, les éléments de preuve renvoyés et les informations fournies par la personne elle-même. unknown est un résultat valide : ne le transformez pas en une catégorie devinée dans votre application.
| Champ | Comment l’utiliser |
|---|---|
data.gender / data.result_status | Utilisez male ou female uniquement lorsque le résultat est identified. Conservez la valeur JSON null lorsqu’il est unknown. |
data.name / data.match | Vérifiez le nom renvoyé et le candidat retenu. Une correspondance partielle ne prouve pas que la valeur appartient à une personne portant ce prénom. |
data.confidence / data.confidence_kind | La confiance est exprimée entre 0 et 1, ou vaut null. observed_frequency provient des effectifs enregistrés ; model_reported est un score fourni par l’IA. Évaluez vos seuils séparément pour chaque type. |
data.source / data.sample_count | Distinguez dataset, ai et none. Les résultats de l’IA n’ont pas d’effectif enregistré. La taille de l’échantillon n’est pas une mesure d’exactitude. |
meta.access.mode | Vérifiez la valeur api_key pour une intégration liée à un compte. Si la clé est absente ou non reconnue, l’essai partagé par IP peut être utilisé à la place. |
meta.usage | Lisez charged_credits et billing_status. Un résultat unknown obtenu avec succès est facturé. L’absence de réponse ne prouve pas que la requête était gratuite. |
Choisissez quand utiliser l’IA
forceToGenderize est facultatif pour les noms, les adresses e-mail et les noms d’utilisateur. Lorsqu’il est activé, omettez ai_mode ou utilisez fallback : la combinaison avec off ou always renvoie une erreur 422. Un solde de départ positif suffit pour lancer une requête, même si le débit final fait passer le solde en dessous de zéro.
L’analyse des pseudonymes peut renvoyer un genre avec name: null. Elle peut aussi renvoyer unknown. Ni le repli IA standard ni l’analyse des pseudonymes ne garantissent une réponse correcte ou non nulle.
| Option de la requête | Comportement | Crédits par requête aboutie |
|---|---|---|
| options.ai_mode: off | Interroge uniquement le jeu de données. | 1 crédit, unknown compris |
| options.ai_mode: fallback | Interroge d’abord le jeu de données, puis l’IA standard si aucun genre n’est trouvé. C’est le mode par défaut des requêtes individuelles. | 1 crédit au total, repli IA compris |
| options.ai_mode: always | Interroge directement l’IA. | 2 crédits |
| forceToGenderize: true | Interroge d’abord le jeu de données ; si aucun genre n’est trouvé, autorise l’IA à interpréter le sens d’un surnom ou d’un pseudonyme personnel, même sans prénom réel. | 1 crédit si le jeu de données résout la requête ; 2 au total si l’IA est utilisée |
Conservez le résultat de chaque compte lors du traitement d’une liste
Utilisez POST /api/v2/gender/batch pour des listes de noms d’utilisateur ou des listes mixtes de noms, d’adresses e-mail et de noms d’utilisateur. Le maximum est de 50 éléments avec une clé API et de 10 avec l’essai par IP. Chaque élément a ses propres options de pays et d’IA ; les id facultatifs doivent être uniques au sein du lot.
Par défaut, un lot utilise uniquement le jeu de données. Activez fallback sur les éléments qui nécessitent le repli IA standard, ou forceToGenderize pour analyser des pseudonymes. Examinez data ou error dans chaque résultat et conservez le lien avec la ligne d’origine grâce à id ou index. Les éléments unknown aboutis consomment aussi des crédits.
Comprenez ce que vous envoyez
L’outil n’envoie la valeur saisie à GenderAPI.io que lorsque vous cliquez sur Analyser. Si l’IA intervient, le service d’inférence configuré reçoit type, value et le contexte pays envoyé. Pour une estimation fondée uniquement sur le jeu de données, utilisez options.ai_mode: off sans forceToGenderize dans votre intégration.
La Politique de confidentialité, l’accord de traitement des données et la liste des sous-traitants décrivent les conditions publiées. Le résultat est une association déduite : donnez la priorité aux informations fournies par la personne. Ne l’utilisez pas comme fondement de décisions ayant des conséquences importantes pour quelqu’un.
Questions fréquentes
Un nom d’utilisateur doit-il contenir un vrai prénom ?
L’inférence IA standard nécessite un prénom exploitable. Avec forceToGenderize, l’API peut aussi tenter une association fondée sur le pseudonyme si le jeu de données ne résout pas la requête. Ce mode n’exige pas de prénom réel et peut renvoyer name: null.
forceToGenderize garantit-il un genre ?
Non. Il autorise l’analyse des pseudonymes, mais le résultat final peut rester unknown. Conservez la valeur JSON null et vérifiez result_status et reason.
L’API consulte-t-elle le profil sur les réseaux sociaux ?
Cet endpoint analyse uniquement la valeur envoyée. Il ne récupère ni le profil, ni les publications, ni les photos du compte pour vérifier qui en est le titulaire.
Puis-je aussi utiliser forceToGenderize avec des noms et des adresses e-mail ?
Oui. Il est facultatif pour name, email et username. Le jeu de données est interrogé en premier, puis, si la requête n’est pas résolue, une IA capable d’interpréter les pseudonymes : 1 crédit si le jeu de données résout la requête, ou 2 au total si l’IA est utilisée.