Jmenné signály a význam přezdívek jsou dvě různé věci
Pro uživatelské jméno nebo přezdívku použijte type: username. Volitelný znak @ na začátku se při shodě v datové sadě odstraní. Získávání kandidátů zohledňuje oddělovače a číslice a může zkoušet omezený počet podřetězců. Režim přezdívek zachovává shodu celých částí, ale tyto kandidáty z podřetězců nepřidává. Vybraný uložený záznam má mezi dostupnými kandidáty nejvyšší celkový počet; nedokazuje skutečné jméno vlastníka účtu.
Běžná záložní AI hledá rozpoznatelné křestní jméno. forceToGenderize navíc umožní přiřazení podle osobní přezdívky, když nelze získat skutečné jméno. Obě cesty mohou vrátit unknown; značka, postava nebo sdílený účet nemusí představovat jednu osobu.
| Příklad vstupu | Postup | Co zkontrolovat |
|---|---|---|
@alice.smith | Začněte běžným fallback, který nejprve prohledá datovou sadu. | Zkontrolujte vybrané jméno a metodu shody; nepředpokládejte, že byla vybrána první část. |
robert89 | Číslice se mohou při získávání kandidátů odstranit. | Shodující se jméno je přiřazení, nikoli ověřená identita. |
prenses | Zapněte forceToGenderize, abyste povolili pokus AI podle přezdívky, když datová sada nepřinese výsledek. | gender může mít hodnotu jinou než null, zatímco name je null. Skóre AI jsou model_reported. |
team_support | Rolové a sdílené účty považujte za účty, které nemusí patřit jedné osobě. | Ponechte unknown a sdílenému účtu nepřiřazujte identitu jednotlivce. |
Vyzkoušejte analýzu přezdívek ve své integraci
Tento požadavek zapíná analýzu přezdívek. Nejprve se prohledá datová sada. Pokud nevrátí pohlaví, může AI použít význam aliasu. Pro běžné vyhledání forceToGenderize vynechte; jednotlivé požadavky i tak ve výchozím nastavení používají běžnou záložní AI.
V tomto příkladu je uveden kontext země TR. Použijte relevantní kontext ze své aplikace a zkontrolujte data.match.scope; uvedená země nezaručuje záznam pro konkrétní zemi. Neurčuje ani státní příslušnost, ani bydliště.
Vyberte programovací jazyk. Nastavte API klíč, potom spusťte příklad na svém serveru.
Každý požadavek na odhad je nová zpoplatněná operace, včetně opakování. Tyto příklady požadavky automaticky neopakují. Před odesláním dalšího požadavku zkontrolujte stav účtování.
Před spuštěním: přístup a zpracování chyb
Tyto příklady spouštějte na svém serveru. V prostředí procesu nastavte GENDERAPI_API_KEY na svůj stávající API klíč. Ověřte, že meta.access.mode je api_key: nerozpoznaný klíč může přejít na zkušební režim podle IP.
U odpovědí JSON s HTTP 4xx a 5xx příklady zachovají tělo chyby a skončí s nenulovým návratovým kódem. Před opakováním požadavku zkontrolujte code, action a meta.usage.billing_status.
Průvodce chybami a opakováním požadavků →cURL 7.76+ v shellu POSIX. Spusťte v terminálu. Dokumentace běhového prostředí
Node.js 22+; vestavěné fetch. Uložte jako example.mjs a spusťte node example.mjs. Dokumentace běhového prostředí
Python 3.10+; standardní knihovna. Uložte jako example.py a spusťte python3 example.py. Dokumentace běhového prostředí
PHP 8+ s rozšířením cURL. Uložte jako example.php a spusťte php example.php. Dokumentace běhového prostředí
Java 17+; standardní HTTP klient. Uložte jako GenderApiExample.java a spusťte java GenderApiExample.java. Dokumentace běhového prostředí
Konzolová aplikace .NET 8+. Použijte jako Program.cs v konzolovém projektu a potom spusťte dotnet run. Dokumentace běhového prostředí
Go 1.22+; standardní knihovna. Uložte jako main.go a spusťte go run main.go. Dokumentace běhového prostředí
Uchovávejte výsledek spolu s jeho podklady
Odvozené přiřazení není pohlaví, které osoba sama uvedla. Původní vstup, vrácené podklady a údaje, které poskytla sama osoba, uchovávejte odděleně. Neznámý výsledek je platný výsledek a ve vaší aplikaci by se z něj neměla stát odhadnutá kategorie.
| Pole | Jak ho použít |
|---|---|
data.gender / data.result_status | male nebo female používejte jen u výsledku identified. U neznámého výsledku zachovejte původní hodnotu JSON null. |
data.name / data.match | Zkontrolujte vrácené jméno a vybraného kandidáta. Shoda s částí řetězce nedokazuje, že vstup patří osobě s tímto křestním jménem. |
data.confidence / data.confidence_kind | Spolehlivost je hodnota od 0 do 1, nebo null. observed_frequency vychází z uložených četností; model_reported je skóre AI. Prahové hodnoty vyhodnocujte pro každý druh zvlášť. |
data.source / data.sample_count | Rozlišujte dataset, ai a none. Výsledky AI nemají uloženou velikost vzorku. Velikost vzorku není naměřená přesnost. |
meta.access.mode | V integraci s účtem ověřte, že je uvedeno api_key. Chybějící nebo nerozpoznané klíče mohou místo toho použít sdílený zkušební režim podle IP. |
meta.usage | Čtěte charged_credits a billing_status. Úspěšný neznámý výsledek se účtuje. Ztracená odpověď nedokazuje, že požadavek byl zdarma. |
Rozhodněte, kdy použít AI
forceToGenderize je volitelné pro jména, e-mailové adresy i uživatelská jména. Pokud je zapnuté, ai_mode vynechte nebo použijte fallback; off a always jsou s ním v konfliktu a vrátí 422. K zahájení požadavku stačí kladný počáteční zůstatek, i když konečné vyúčtování dostane zůstatek do záporu.
Režim přezdívek může vrátit pohlaví spolu s name: null. Může také vrátit neznámý výsledek. Běžná záložní AI ani analýza přezdívek nezaručuje správnou odpověď ani hodnotu jinou než null.
| Možnost požadavku | Chování | Kredity za úspěšné vyhledání |
|---|---|---|
| options.ai_mode: off | Použije pouze datovou sadu. | 1, včetně neznámého výsledku |
| options.ai_mode: fallback | Nejprve prohledá datovou sadu, a pokud nevrátí pohlaví, použije běžnou AI. Jde o výchozí nastavení jednotlivých požadavků. | Celkem 1, včetně záložní AI |
| options.ai_mode: always | Použije přímo AI. | 2 |
| forceToGenderize: true | Nejprve prohledá datovou sadu a potom umožní AI vyložit osobní přezdívku nebo alias, i bez skutečného křestního jména. | 1 za výsledek z datové sady; celkem 2, pokud se použije AI |
Při zpracování seznamu zachovejte výsledek každého uživatelského jména
Použijte POST /api/v2/gender/batch pro seznamy uživatelských jmen nebo pro kombinované seznamy jmen, e-mailových adres a uživatelských jmen. Maximum je 50 položek s API klíčem nebo 10 ve zkušebním režimu podle IP. Každá položka má vlastní možnosti země a AI; volitelná ID musí být v rámci dávky jedinečná.
Výchozím nastavením dávky je pouze datová sada. Pokud chcete běžnou AI, zapněte fallback u jednotlivých položek, nebo pro analýzu přezdívek nastavte u položky forceToGenderize. U každého výsledku zkontrolujte data nebo error a pomocí id nebo index zachovejte přiřazení k původnímu řádku. Úspěšné neznámé položky se účtují.
Vězte, co odesíláte
Ukázka v reálném čase odešle zadanou hodnotu do GenderAPI.io jen tehdy, když ji sami odešlete. Pokud se použije AI, předá se odeslaný type, value a kontext země službě nakonfigurované pro odhady. Pro odhad pouze z datové sady nastavte ve své integraci options.ai_mode: off bez forceToGenderize.
Zásady ochrany osobních údajů, smlouva o zpracování osobních údajů a seznam dalších zpracovatelů popisují zveřejněné podmínky zpracování. Výsledek je odvozené přiřazení; přednost mají údaje, které poskytla sama osoba. Nepoužívejte ho jako podklad pro rozhodnutí se závažnými důsledky pro jednotlivce.
Časté dotazy
Musí uživatelské jméno obsahovat skutečné křestní jméno?
Běžný odhad pomocí AI vyžaduje použitelné křestní jméno. S forceToGenderize může API navíc zkusit přiřazení podle přezdívky, když vyhledání v datové sadě nepřinese výsledek. Tento režim skutečné křestní jméno nevyžaduje a může vrátit name: null.
Zaručuje forceToGenderize pohlaví?
Ne. Umožňuje analýzu přezdívek, ale konečný výsledek může být stále neznámý. Zachovejte původní hodnotu JSON null a zkontrolujte result_status a reason.
Prohlíží API profil na sociálních sítích?
Tento endpoint analyzuje odeslanou hodnotu. Nenačítá profil, příspěvky ani fotografie účtu, aby ověřil, komu patří.
Mohu forceToGenderize použít i pro jména nebo e-mailové adresy?
Ano. Je volitelné pro vstupy typu name, email i username. Nejprve použije datovou sadu, a pokud nepřinese výsledek, AI s analýzou přezdívek: 1 kredit za výsledek z datové sady, nebo celkem 2 kredity, pokud se použije AI.