Zachovejte arabský zápis a zkontrolujte nalezené jméno
Odešlete jméno v původním zápisu v Unicode. Vstupní pole níže používá arabský text psaný zprava doleva, zatímco tento průvodce a odpověď JSON se čtou zleva doprava. API může text přijmout bez předchozí transliterace do latinky; přijetí textu však neslibuje pokrytí v datové sadě.
Vyhledávání v datové sadě používá normalizaci Unicode NFKC a dělí text na části jména. Nemá obecné pravidlo, které by odstraňovalo arabská diakritická znaménka nebo považovalo různé zápisy za rovnocenné. Znaménka pro samohlásky a další rozdíly v zápisu proto mohou ovlivnit, který uložený klíč se najde. Zachovejte původní hodnotu, místo abyste všechny varianty mlčky považovali za tutéž osobu.
Celé jméno může vytvořit více kandidátů. Vybere se dostupný záznam s nejvyšším uloženým celkovým počtem, takže první slovo nemusí být vráceným křestním jménem. Než výsledek použijete k obohacení záznamu, zkontrolujte data.name a data.match.name.
| Příklad vstupu | Co představuje | Co zkontrolovat |
|---|---|---|
ليلى الخطيب | Příklad celého jména | Může se zvažovat více částí jména. Zkontrolujte vybranou shodu; příklad neukazuje výsledek skutečného požadavku. |
ليلى / لَيْلَى | Zápis bez znamének a se znaménky pro samohlásky | Odešlete skutečný zápis. Není zaručeno, že oba řetězce povedou ke stejnému uloženému záznamu. |
Layla / Leila | Zápisy v latince | Jde o samostatné vstupní hodnoty. V2 neslibuje, že se transliterace automaticky považují za rovnocenné. |
country: SA | Ukázkový kontext: Saúdská Arábie | Tento kontext není výchozí hodnotou pro všechny arabsky mluvící komunity. Pokud zemi neznáte, country vynechte. |
Kontext země SA volte uváženě
Ukázka v reálném čase odesílá country: SA (Saúdská Arábie). API tuto zemi nevybírá podle písma, kterým je jméno zapsané. Ve své integraci použijte známý a relevantní kontext, nebo country vynechte; z této ukázkové hodnoty nedělejte výchozí hodnotu pro všechny záznamy.
Pro každého kandidáta dává vyhledávání v datové sadě přednost existujícímu záznamu pro konkrétní zemi a jinak zvažuje globální záznam. Potom vybere dostupného kandidáta s nejvyšším uloženým celkovým počtem. Skutečný rozsah shody zjistíte z data.match.scope a data.match.country. Záznam pro konkrétní zemi se stejným počtem pro obě pohlaví se automaticky nenahradí globálním výsledkem; fallback může místo toho použít AI.
data.input.country popisuje kontext požadavku. data.country a data.country_source popisují vrácené přiřazení. Jde o různá pole a neurčují státní občanství, etnickou příslušnost ani bydliště.
Odešlete arabské jméno přes V2
Požadavek spusťte na svém serveru s GENDERAPI_API_KEY nastaveným na váš stávající klíč. Příklad výslovně zapíná běžnou záložní AI. Ukazuje podobu požadavku, nikoli naměřený odhad ani naměřené pokrytí. Pokud chcete použít pouze datovou sadu, nastavte options.ai_mode: off.
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 |
Zpracujte seznam jmen, aniž byste ztratili kontext
Použijte POST /api/v2/gender/batch pro nejvýše 50 položek s registrovaným API klíčem nebo 10 položek ve zkušebním režimu podle IP. Každé položce přidělte jedinečné id a u každého řádku zachovejte původní hodnotu. Každá položka může mít vlastní zemi a vlastní pravidla AI; pokud zemi neznáte, country vynechte.
Na rozdíl od jednotlivých požadavků, u kterých je výchozí fallback, používají položky dávky ve výchozím nastavení pouze datovou sadu. U každé položky, která potřebuje AI, nastavte options.ai_mode: fallback. Kontrolujte každý výsledek i po HTTP 200, zachovejte neznámé výsledky a před dalším odesláním zkontrolujte chyby jednotlivých položek a účtování. Každá úspěšná běžná položka stojí 1 kredit; jeden požadavek HTTP s dávkou neznamená jeden kredit za jeden odhad.
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
Přijímá V2 arabský text s diakritickými znaménky?
V2 přijímá jména v Unicode, včetně arabského textu. Normalizace v datové sadě arabská znaménka pro samohlásky obecně neodstraňuje, takže zápisy se znaménky a bez nich mohou vést k různým shodám nebo k neznámému výsledku.
Určuje tento nástroj státní příslušnost arabsky mluvící osoby?
Ne. SA je kontext země výslovně zvolený pro tuto ukázku. Písmo, přiřazení jména ani vrácené pole země neurčují státní příslušnost ani bydliště.
Je přesnost měřena pro každé arabské jméno?
Tato stránka žádné takové měření nezveřejňuje. Přijetí vstupu, uložené četnosti ani hodnota spolehlivosti nejsou nezávislým měřením přesnosti. Na stránce o metodice najdete dostupné podklady i měření, která zatím zveřejněna nejsou.
Stojí neznámý výsledek kredity?
Úspěšný neznámý výsledek se účtuje. Běžný režim s datovou sadou nebo fallback stojí celkem 1 kredit. S forceToGenderize stojí výsledek z datové sady 1 kredit a použití AI celkem 2 kredity, i když AI vrátí neznámý výsledek. Chyby mají vlastní pravidla účtování; zkontrolujte meta.usage.