Un nombre reconocible y el significado de un alias son señales distintas
Utiliza type: username para un nombre de usuario o alias. En la búsqueda se elimina el símbolo @ inicial opcional. La extracción de candidatos trata separadores y números, y puede probar fragmentos de longitud limitada. El modo de alias mantiene las palabras candidatas, pero no añade esos fragmentos. Se selecciona el registro con el mayor recuento entre los candidatos disponibles; eso no demuestra el nombre real del titular.
El respaldo estándar de IA busca un nombre de pila reconocible. forceToGenderize también permite intentar una asociación a partir de un alias personal cuando no se puede extraer un nombre real. Ambos modos pueden devolver unknown. Una marca, un personaje o una cuenta compartida no tienen por qué representar a una sola persona.
| Ejemplo de entrada | Enfoque | Qué comprobar |
|---|---|---|
@alice.smith | Empieza con fallback estándar, que consulta primero el conjunto de datos. | Revisa el nombre seleccionado y el método de coincidencia; no supongas que se elige la primera palabra. |
robert89 | Los números pueden eliminarse al extraer candidatos. | Una coincidencia de nombre es una asociación, no una identidad verificada. |
prenses | Activa forceToGenderize para permitir un intento con IA basado en el alias si la consulta no se resuelve. | gender puede tener un valor aunque name sea null. La confianza de IA es de tipo model_reported. |
team_support | Considera que las cuentas de equipo o compartidas pueden no ser personales. | Conserva unknown y no atribuyas una identidad individual a una cuenta compartida. |
Prueba el análisis de alias en tu integración
Esta solicitud activa el análisis de alias. Primero se consulta el conjunto de datos; si no devuelve un género, la IA puede interpretar el significado del alias. Omite forceToGenderize para una consulta estándar. Las consultas individuales ya utilizan fallback estándar de forma predeterminada.
El contexto de país TR corresponde únicamente a este ejemplo. Utiliza el contexto relevante de tu aplicación y revisa data.match.scope. Enviar un país no garantiza una coincidencia en un registro específico de ese país, ni demuestra nacionalidad o residencia.
Elige un lenguaje de programación. Configura tu clave API, luego ejecuta el ejemplo en tu servidor.
Cada solicitud de predicción es una nueva operación facturable, incluidos los reintentos. Estos ejemplos no se reintentan automáticamente. Comprueba el estado de facturación antes de enviar otra solicitud.
Antes de ejecutar: acceso y manejo de errores
Ejecuta estos ejemplos en tu servidor. Configura GENDERAPI_API_KEY en el entorno de proceso con tu clave API existente. Confirma que meta.access.mode es api_key: una clave no reconocida puede recurrir a la prueba IP.
Las respuestas HTTP 4xx y 5xx JSON conservan el cuerpo del error y devuelven un estado de salida distinto de cero. Comprueba code, action y meta.usage.billing_status antes de volver a intentarlo.
Guía de errores y reintentos →cURL 7.76+ en un shell POSIX. Ejecuta en tu terminal. Documentación del entorno de ejecución
Node.js 22+; fetch integrado. Guarda como example.mjs y ejecuta node example.mjs. Documentación del entorno de ejecución
Python 3.10+; biblioteca estándar. Guarda como example.py y ejecuta python3 example.py. Documentación del entorno de ejecución
PHP 8+ con la extensión cURL. Guarda como example.php y ejecuta php example.php. Documentación del entorno de ejecución
Java 17+; cliente estándar HTTP. Guarda como GenderApiExample.java y ejecuta java GenderApiExample.java. Documentación del entorno de ejecución
Aplicación de consola .NET 8+. Úsalo como Program.cs en un proyecto de consola, luego ejecuta dotnet run. Documentación del entorno de ejecución
Go 1.22+; biblioteca estándar. Guarda como main.go y ejecuta go run main.go. Documentación del entorno de ejecución
Interpreta el resultado junto con sus evidencias
Una asociación inferida no equivale al género declarado por la persona. Conserva por separado el dato original, las evidencias de la respuesta y la información facilitada por la persona. unknown es un resultado válido; no lo conviertas en una categoría inventada.
| Campo | Cómo utilizarlo |
|---|---|
data.gender / data.result_status | Utiliza male o female solo cuando el resultado sea identified. Conserva el valor JSON null cuando sea unknown. |
data.name / data.match | Revisa el nombre devuelto y el candidato seleccionado. Una coincidencia parcial no demuestra que el dato pertenezca a una persona con ese nombre. |
data.confidence / data.confidence_kind | La confianza se expresa entre 0 y 1, o como null. observed_frequency procede de recuentos almacenados; model_reported es una puntuación de IA. Evalúa los umbrales por separado para cada tipo. |
data.source / data.sample_count | Distingue dataset, ai y none. Los resultados de IA no tienen un recuento de muestras almacenadas. El tamaño de la muestra no es una medida de exactitud. |
meta.access.mode | Comprueba api_key en una integración de cuenta. Si falta la clave o no se reconoce, puede utilizarse la prueba compartida por IP. |
meta.usage | Revisa charged_credits y billing_status. Un resultado unknown completado correctamente consume créditos. No recibir la respuesta no demuestra que la consulta haya sido gratuita. |
Elige cuándo utilizar la IA
forceToGenderize es opcional para nombres, correos electrónicos y nombres de usuario. Si lo activas, omite ai_mode o utiliza fallback; combinarlo con off o always devuelve un error 422. Basta con un saldo inicial positivo para iniciar la consulta, aunque el cargo final deje el saldo por debajo de cero.
El análisis de alias puede devolver un género con name: null. También puede devolver unknown. Ni el respaldo estándar de IA ni el análisis de alias garantizan una respuesta correcta o distinta de null.
| Opción de la solicitud | Comportamiento | Créditos por consulta completada |
|---|---|---|
| options.ai_mode: off | Consulta únicamente el conjunto de datos. | 1 crédito, incluido unknown |
| options.ai_mode: fallback | Consulta primero el conjunto de datos y recurre a la IA estándar si no obtiene un género. Es el modo predeterminado de las consultas individuales. | 1 crédito en total, incluido el respaldo de IA |
| options.ai_mode: always | Consulta directamente a la IA. | 2 créditos |
| forceToGenderize: true | Consulta primero el conjunto de datos; si no encuentra un género, permite interpretar el significado de un alias personal, aunque no contenga un nombre real. | 1 crédito si el conjunto de datos resuelve la consulta; 2 en total si se utiliza IA |
Conserva el resultado de cada usuario al procesar una lista
Utiliza POST /api/v2/gender/batch para listas de usuarios o listas mixtas de nombres, correos y usuarios. El máximo es de 50 elementos con clave API y de 10 en la prueba por IP. Cada elemento tiene sus propias opciones de país e IA; los id opcionales deben ser únicos dentro del lote.
El modo predeterminado del lote utiliza solo el conjunto de datos. Activa fallback en los elementos que requieran respaldo estándar de IA, o forceToGenderize para analizar alias. Revisa data o error en cada resultado y conserva la relación con la fila original mediante id o index. Los elementos unknown completados correctamente también consumen créditos.
Comprende cómo se procesa el dato que envías
La herramienta envía el valor a GenderAPI.io solo cuando pulsas Analizar. Si interviene la IA, el servicio de inferencia configurado recibe type, value y el contexto de país enviado. Para consultar únicamente el conjunto de datos, utiliza options.ai_mode: off sin forceToGenderize en tu integración.
La Política de Privacidad, el acuerdo de tratamiento y la lista de subencargados describen las condiciones publicadas. El resultado es una asociación inferida; da prioridad a la información que facilite la persona. No lo utilices como fundamento de decisiones con consecuencias importantes para alguien.
Preguntas frecuentes
¿El usuario debe contener un nombre de pila real?
La inferencia estándar de IA requiere un nombre de pila utilizable. Con forceToGenderize se puede intentar una asociación a partir del alias si el conjunto de datos no resuelve la consulta. Ese modo no exige un nombre real y puede devolver name: null.
¿forceToGenderize garantiza un género?
No. Permite analizar alias, pero el resultado final puede ser unknown. Conserva el valor JSON null y comprueba result_status y reason.
¿La API consulta el perfil de la red social?
Este endpoint analiza el valor enviado. No descarga el perfil, las publicaciones ni las fotos para verificar quién es el titular.
¿También puedo utilizar forceToGenderize con nombres y correos?
Sí. Es opcional para name, email y username. Consulta primero el conjunto de datos y, si no resuelve la consulta, recurre a IA capaz de interpretar alias: 1 crédito si se resuelve con el conjunto de datos, o 2 en total si se utiliza IA.