Den ursprünglichen Namen verwenden, ohne eine einzige Schrift oder feste Reihenfolge anzunehmen
Diese Demonstration verwendet ein Beispiel in Devanagari und den Länderkontext IN. Es ist ein Eingabebeispiel und keine Definition aller in Indien verwendeten Namen. Die API nimmt Unicode-Zeichenketten an, sodass Sie die im Datensatz Ihrer Anwendung gespeicherte Schreibweise ohne vorherige Umwandlung in lateinische Schrift senden können.
Die Suche verwendet normalisierte Bestandteile. Sie führt keine allgemeine Umwandlung zwischen Schriften durch und garantiert nicht, dass eine lateinische und eine Schreibweise in der ursprünglichen Schrift demselben Eintrag zugeordnet werden. Speichern Sie die ursprüngliche Eingabe zusammen mit dem zurückgegebenen Namen. Dass eine Schrift angenommen wird, bedeutet keine unabhängig gemessene Genauigkeit für jede Sprache oder Gemeinschaft.
Gehen Sie nicht davon aus, dass der erste oder letzte Bestandteil immer dieselbe Rolle hat. V2 wählt den verfügbaren Kandidaten mit der größten gespeicherten Gesamthäufigkeit und garantiert keine bestimmte Position des Vornamens. Initialen, kurze Bestandteile und fehlende gespeicherte Einträge können das Ergebnis aus dem Datensatz offenlassen; der KI-Fallback kann den vollständigen gesendeten Wert auswerten.
| Beispielhafte Eingabe | Was sie zeigt | Was Sie prüfen sollten |
|---|---|---|
प्रिया शर्मा | Vollständiger Name in Devanagari | Mehrere Bestandteile können Kandidaten werden. Prüfen Sie den ausgewählten Namen und den Treffer, statt anzunehmen, dass der erste Bestandteil gewinnt. |
Priya Sharma | Beispiel in lateinischer Schrift | Das ist eine eigene Schreibweise; ein identischer Treffer über Schriften hinweg ist nicht garantiert. |
A. Kumar | Initiale und weiterer Bestandteil | Eine Initiale aus einem Buchstaben wird kein Kandidat im Datensatz. Ein Treffer für den zweiten Bestandteil bestätigt nicht den beabsichtigten Vornamen. |
country: IN | Beispielhafter Kontext: Indien | Verwenden Sie ihn, wenn Ihr Datensatz einen passenden Länderkontext enthält, und nicht nur, weil der Name in dieser Anleitung vorkommt. |
Länderkontext IN bewusst wählen
Die Demo sendet country: IN (Indien). Die API wählt dieses Land nicht anhand der Schrift aus, in der der Name geschrieben ist. Verwenden Sie in Ihrer Integration einen bekannten und passenden Länderkontext oder lassen Sie country weg. Machen Sie dieses Beispiel nicht zum Standardwert für alle Datensätze.
Für jeden Kandidaten wählt die Suche den länderspezifischen Eintrag, sofern vorhanden, und prüft andernfalls den globalen Eintrag. Anschließend wählt sie den verfügbaren Kandidaten mit der größten gespeicherten Gesamthäufigkeit. Den tatsächlichen Umfang des Treffers sehen Sie in data.match.scope und data.match.country. Ein länderspezifischer Eintrag mit gleichen Häufigkeiten wird nicht automatisch durch das globale Ergebnis ersetzt; ist der Fallback aktiviert, kann stattdessen KI eingesetzt werden.
data.input.country beschreibt den in der Anfrage gesendeten Kontext. data.country und data.country_source beschreiben die zurückgegebene Länderzuordnung und ihre Herkunft. Das sind unterschiedliche Felder; sie belegen weder Staatsangehörigkeit noch ethnische Herkunft noch Wohnort.
V2-Namensanfrage aus Ihrer Anwendung senden
Setzen Sie GENDERAPI_API_KEY auf Ihren vorhandenen Schlüssel und führen Sie das Beispiel auf Ihrem Server aus. Die Anfrage aktiviert ausdrücklich den gewöhnlichen KI-Fallback. Sie zeigt das Anfrageformat, keine gemessene Genauigkeit und keine bestätigte Abdeckung. Für eine Vorhersage nur mit dem Datensatz verwenden Sie options.ai_mode: off.
Wählen Sie eine Programmiersprache. Richten Sie Ihren API-Schlüssel ein, und führen Sie dann das Beispiel auf Ihrem Server aus.
Jede Vorhersageanfrage ist ein neuer kostenpflichtiger Vorgang, auch bei Wiederholungen. Diese Beispiele wiederholen Anfragen nicht automatisch. Prüfen Sie den Abrechnungsstatus, bevor Sie eine weitere Anfrage senden.
Vor der Ausführung: Zugang und Fehlerbehandlung
Führen Sie diese Beispiele auf Ihrem Server aus. Setzen Sie GENDERAPI_API_KEY in der Prozessumgebung auf Ihren vorhandenen API-Schlüssel. Prüfen Sie, ob meta.access.mode den Wert api_key hat: Ein nicht erkannter Schlüssel kann in den IP-Testzugang wechseln.
Bei HTTP-4xx- und -5xx-Antworten im JSON-Format bleibt der Fehlerinhalt erhalten, und das Beispiel endet mit einem Exit-Status ungleich null. Prüfen Sie code, action und meta.usage.billing_status, bevor Sie die Anfrage wiederholen.
Anleitung zu Fehlern und Wiederholungen →cURL 7.76+ in einer POSIX-Shell. Im Terminal ausführen. Dokumentation der Laufzeitumgebung
Node.js 22+; integriertes fetch. Als example.mjs speichern und node example.mjs ausführen. Dokumentation der Laufzeitumgebung
Python 3.10+; Standardbibliothek. Als example.py speichern und python3 example.py ausführen. Dokumentation der Laufzeitumgebung
PHP 8+ mit der cURL-Erweiterung. Als example.php speichern und php example.php ausführen. Dokumentation der Laufzeitumgebung
Java 17+; Standard-HTTP-Client. Als GenderApiExample.java speichern und java GenderApiExample.java ausführen. Dokumentation der Laufzeitumgebung
Konsolenanwendung mit .NET 8+. Als Program.cs in einem Konsolenprojekt verwenden und dann dotnet run ausführen. Dokumentation der Laufzeitumgebung
Go 1.22+; Standardbibliothek. Als main.go speichern und go run main.go ausführen. Dokumentation der Laufzeitumgebung
Ergebnis und Belege gemeinsam aufbewahren
Eine abgeleitete Zuordnung ist nicht das Geschlecht, das eine Person selbst angibt. Bewahren Sie die ursprüngliche Eingabe, die zurückgegebenen Belege und alle Angaben der Person selbst getrennt auf. Ein unbekanntes Ergebnis ist ein gültiges Ergebnis; es sollte in Ihrer Anwendung nicht zu einer geratenen Kategorie werden.
| Feld | Verwendung |
|---|---|
data.gender / data.result_status | Verwenden Sie male oder female nur bei identified. Behalten Sie bei einem unbekannten Ergebnis den nativen JSON-Wert null bei. |
data.name / data.match | Prüfen Sie den zurückgegebenen Namen und den ausgewählten Kandidaten. Ein Treffer über einen Teilstring belegt nicht, dass die Eingabe zu einer Person mit diesem Vornamen gehört. |
data.confidence / data.confidence_kind | Die Konfidenz liegt auf einer Skala von 0–1 oder ist null. observed_frequency beruht auf gespeicherten Häufigkeiten; model_reported ist ein KI-Wert. Bewerten Sie Schwellenwerte für jede Art getrennt. |
data.source / data.sample_count | Unterscheiden Sie dataset, ai und none. KI-Ergebnisse haben keine gespeicherte Stichprobengröße. Eine Stichprobengröße ist kein gemessener Genauigkeitswert. |
meta.access.mode | Prüfen Sie bei einer Kontointegration, ob api_key gemeldet wird. Fehlende oder nicht erkannte Schlüssel können stattdessen den gemeinsamen IP-Testzugang nutzen. |
meta.usage | Lesen Sie charged_credits und billing_status. Ein erfolgreiches unbekanntes Ergebnis ist kostenpflichtig. Eine verlorene Antwort belegt nicht, dass die Anfrage kostenlos war. |
Festlegen, wann KI eingesetzt wird
forceToGenderize ist für Namen, E-Mail-Adressen und Benutzernamen optional. Ist es aktiviert, lassen Sie ai_mode weg oder verwenden Sie fallback; off und always sind damit unvereinbar und liefern 422. Ein positives Anfangsguthaben genügt, um eine Anfrage zu starten, auch wenn die endgültige Abbuchung das Guthaben unter null senkt.
Der Spitznamenmodus kann ein Geschlecht zusammen mit name: null zurückgeben. Er kann auch ein unbekanntes Ergebnis liefern. Weder der gewöhnliche KI-Fallback noch die Spitznamen-Auswertung garantieren eine richtige Antwort oder einen Wert ungleich null.
| Anfrageoption | Verhalten | Credits für eine erfolgreiche Abfrage |
|---|---|---|
| options.ai_mode: off | Nur den Datensatz verwenden. | 1, auch bei einem unbekannten Ergebnis |
| options.ai_mode: fallback | Zuerst den Datensatz prüfen, dann gewöhnliche KI, wenn kein Geschlecht zurückgegeben wird. Das ist der Standard für Einzelanfragen. | Insgesamt 1, einschließlich KI-Fallback |
| options.ai_mode: always | Direkt KI verwenden. | 2 |
| forceToGenderize: true | Zuerst den Datensatz prüfen, dann KI einen persönlichen Spitznamen oder Alias auswerten lassen, auch ohne echten Vornamen. | 1 für ein im Datensatz aufgelöstes Ergebnis; insgesamt 2, wenn KI eingesetzt wird |
Eine Namensliste verarbeiten, ohne den Kontext zu verlieren
Senden Sie bis zu 50 Einträge mit API-Schlüssel oder 10 im IP-Testzugang über POST /api/v2/gender/batch. Geben Sie den Einträgen eindeutige IDs und bewahren Sie den ursprünglichen Wert jeder Zeile auf. Jeder Eintrag kann eigene Länder- und KI-Optionen haben; lassen Sie das Land weg, wenn es unbekannt ist.
Anders als Einzelanfragen, die standardmäßig den Fallback verwenden, nutzen Batch-Einträge standardmäßig nur den Datensatz. Setzen Sie options.ai_mode: fallback in jedem Eintrag, der KI benötigt. Prüfen Sie jedes Ergebnis, auch nach HTTP 200, behalten Sie unbekannte Ergebnisse bei und prüfen Sie Fehler sowie die Abrechnung, bevor Sie erneut senden. Jeder erfolgreiche gewöhnliche Eintrag kostet 1 Credit; eine HTTP-Anfrage mit einem Batch ist nicht ein Credit pro Vorhersage.
Wissen, was Sie senden
Die Live-Demo sendet den eingegebenen Wert erst dann an GenderAPI.io, wenn Sie ihn absenden. Wird KI eingesetzt, gehen der übermittelte type, der value und der Länderkontext an den konfigurierten Inferenzdienst. Für eine Vorhersage nur mit dem Datensatz verwenden Sie in Ihrer Integration options.ai_mode: off ohne forceToGenderize.
Die Datenschutzerklärung, der Auftragsverarbeitungsvertrag und das Verzeichnis der Unterauftragsverarbeiter beschreiben die veröffentlichten Verarbeitungsbedingungen. Ein Ergebnis ist eine abgeleitete Zuordnung; Angaben der Person selbst haben Vorrang. Nutzen Sie es nicht als Grundlage für folgenreiche Entscheidungen über eine Person.
Häufig gestellte Fragen
Nimmt die Demo für indische Namen nur Namen auf Hindi an?
Die Demo verwendet ein Beispiel in Devanagari, die API nimmt Namen aber als Unicode-Zeichenketten an. Diese Möglichkeit bedeutet weder eine vollständige Abdeckung des Datensatzes noch eine gemessene Genauigkeit für jede in Indien verwendete Sprache.
Liefert die lateinische Schreibweise dasselbe Ergebnis wie die ursprüngliche Schrift?
Das ist nicht garantiert. Die aktuelle Suche bietet keine allgemeine Gleichwertigkeit von Transliterationen. Speichern Sie jede gesendete Schreibweise zusammen mit den zurückgegebenen Angaben source, match und confidence.
Wurde für diese Namensgruppe eine unabhängige Genauigkeitsbewertung veröffentlicht?
Diese Seite veröffentlicht keine solche Bewertung. Dass eine Eingabe angenommen wird, gespeicherte Häufigkeiten angezeigt werden oder ein Konfidenzwert zurückgegeben wird, ist keine unabhängige Messung der Genauigkeit. Die Methodik zeigt, welche Angaben verfügbar sind und welche Messungen noch nicht veröffentlicht wurden.
Verbraucht ein Ergebnis ohne Vorhersage Credits?
Ein erfolgreiches unbekanntes Ergebnis ist kostenpflichtig. Der gewöhnliche Modus mit dem Datensatz oder mit Fallback kostet insgesamt 1 Credit. Mit forceToGenderize kostet die Anfrage 1 Credit, wenn der Datensatz sie auflöst, oder insgesamt 2, wenn KI eingesetzt wird, auch bei einem unbekannten Ergebnis. Für Fehler gelten eigene Abrechnungsregeln; prüfen Sie meta.usage.