Säilytä arabialainen kirjoitusasu ja tarkista löydetty nimi
Lähetä nimi sen alkuperäisessä Unicode-kirjoitusasussa. Alla oleva syötekenttä käyttää oikealta vasemmalle kirjoitettavaa arabiankielistä tekstiä, kun taas tämä opas ja JSON-vastaus luetaan vasemmalta oikealle. API voi vastaanottaa tekstin ilman, että translitteroit sen ensin latinalaisiksi kirjaimiksi; se, että teksti hyväksytään, ei ole lupaus tietoaineiston kattavuudesta.
Tietoaineiston haku käyttää Unicode-normalisointia NFKC ja jakaa tekstin nimen osiin. Siinä ei ole yleistä sääntöä, joka poistaisi arabialaiset tarkkeet tai rinnastaisi eri kirjoitusasut toisiinsa. Vokaalimerkit ja muut kirjoitusasun erot voivat siksi vaikuttaa siihen, mikä tallennettu avain löytyy. Säilytä alkuperäinen arvo sen sijaan, että käsittelisit kaikkia muunnelmia huomaamatta samana henkilönä.
Koko nimestä voi muodostua useita ehdokkaita. Valituksi tulee käytettävissä oleva tietue, jonka tallennettu kokonaismäärä on suurin, joten ensimmäinen sana ei välttämättä ole palautettu etunimi. Tarkista data.name ja data.match.name ennen kuin käytät tulosta tietueen rikastamiseen.
| Esimerkkisyöte | Mitä se kuvaa | Mitä kannattaa tarkistaa |
|---|---|---|
ليلى الخطيب | Esimerkki koko nimestä | Useita nimen osia voidaan arvioida. Tarkista valittu ehdokas; esimerkki ei kuvaa todellisen pyynnön tulosta. |
ليلى / لَيْلَى | Kirjoitusasu ilman vokaalimerkkejä ja niiden kanssa | Lähetä todellinen kirjoitusasu. Ei ole taattua, että molemmat merkkijonot johtavat samaan tallennettuun tietueeseen. |
Layla / Leila | Latinalaisin kirjaimin kirjoitetut muodot | Nämä ovat erillisiä syötearvoja. V2 ei lupaa, että translitteraatiot rinnastetaan automaattisesti. |
country: SA | Esimerkkikonteksti: Saudi-Arabia | Tämä konteksti ei ole oletusarvo kaikille arabiaa puhuville yhteisöille. Jätä country pois, jos maata ei tiedetä. |
Valitse maakonteksti SA harkiten
Reaaliaikainen demo lähettää arvon country: SA (Saudi-Arabia). API ei valitse tätä maata sen perusteella, millä kirjoitusjärjestelmällä nimi on kirjoitettu. Käytä integraatiossasi tunnettua ja asiaankuuluvaa maakontekstia tai jätä country pois; älä tee tästä esimerkkiarvosta oletusarvoa kaikille tietueille.
Tietoaineiston haku suosii kunkin ehdokkaan kohdalla olemassa olevaa maakohtaista tietuetta ja muuten arvioi globaalin tietueen. Sen jälkeen valitaan käytettävissä oleva ehdokas, jonka tallennettu kokonaismäärä on suurin. Osuman todellisen laajuuden näet kentistä data.match.scope ja data.match.country. Monitulkintaista maakohtaista tietuetta ei korvata automaattisesti globaalilla tuloksella; fallback voi sen sijaan käyttää tekoälyä.
data.input.country kuvaa pyynnön kontekstia. data.country ja data.country_source kuvaavat palautettua yhteyttä. Ne ovat eri kenttiä, eivätkä ne määritä kansalaisuutta, etnistä taustaa tai asuinpaikkaa.
Lähetä arabialainen nimi V2:lla
Suorita pyyntö palvelimellasi niin, että GENDERAPI_API_KEY on asetettu nykyiseen avaimeesi. Esimerkki ottaa tavallisen tekoälyn varalla käyttöön erikseen. Se näyttää, miltä pyyntö näyttää, eikä se ole mitattu ennuste tai mitattu kattavuus. Käytä asetusta options.ai_mode: off, jos haluat käyttää vain tietoaineistoa.
Valitse ohjelmointikieli. Määritä API-avain, suorita sitten esimerkki palvelimellasi.
Jokainen ennustepyyntö on uusi laskutettava toiminto, myös uudelleenyritys. Nämä esimerkit eivät yritä uudelleen automaattisesti. Tarkista laskutuksen tila ennen uuden pyynnön lähettämistä.
Ennen suorittamista: käyttöoikeus ja virheiden käsittely
Suorita esimerkit palvelimellasi. Aseta prosessin ympäristömuuttujan GENDERAPI_API_KEY arvoksi nykyinen API-avaimesi. Varmista, että meta.access.mode on api_key: tunnistamaton avain voi siirtää pyynnön IP-kokeiluun.
HTTP 4xx- ja 5xx-JSON-vastauksissa esimerkit säilyttävät virherungon ja palauttavat nollasta poikkeavan poistumiskoodin. Tarkista code, action ja meta.usage.billing_status ennen uutta yritystä.
Virhe- ja uudelleenyritysopas →cURL 7.76+ POSIX-komentotulkissa. Suorita päätteessä. Suoritusympäristön dokumentaatio
Node.js 22+; sisäänrakennettu fetch. Tallenna nimellä example.mjs ja suorita node example.mjs. Suoritusympäristön dokumentaatio
Python 3.10+; standardikirjasto. Tallenna nimellä example.py ja suorita python3 example.py. Suoritusympäristön dokumentaatio
PHP 8+ cURL-laajennuksella. Tallenna nimellä example.php ja suorita php example.php. Suoritusympäristön dokumentaatio
Java 17+; standardikirjaston HTTP-asiakas. Tallenna nimellä GenderApiExample.java ja suorita java GenderApiExample.java. Suoritusympäristön dokumentaatio
.NET 8+ -konsolisovellus. Käytä konsoliprojektissa nimellä Program.cs ja suorita sitten dotnet run. Suoritusympäristön dokumentaatio
Go 1.22+; standardikirjasto. Tallenna nimellä main.go ja suorita go run main.go. Suoritusympäristön dokumentaatio
Säilytä tulos ja sen perusteet yhdessä
Päätelty yhteys ei ole henkilön itse ilmoittama sukupuoli. Säilytä alkuperäinen syöte, palautetut perusteet ja henkilön itse antamat tiedot erillään. Tuntematon tulos on kelvollinen tulos, eikä siitä pidä tehdä sovelluksessasi arvattua luokkaa.
| Kenttä | Miten sitä käytetään |
|---|---|
data.gender / data.result_status | Käytä arvoa male tai female vain, kun tulos on identified. Säilytä alkuperäinen JSON null -arvo, kun tulos on unknown. |
data.name / data.match | Tarkista palautettu nimi ja valittu ehdokas. Osuma merkkijonon osaan ei todista, että syöte kuuluu henkilölle, jolla on kyseinen etunimi. |
data.confidence / data.confidence_kind | Luottamusarvo on väliltä 0–1 tai null. observed_frequency perustuu tallennettuihin määriin; model_reported on tekoälyn pistemäärä. Arvioi kynnysarvot kummallekin tyypille erikseen. |
data.source / data.sample_count | Erota arvot dataset, ai ja none. Tekoälytuloksilla ei ole tallennettua otoskokoa. Otoskoko ei ole mitattu tarkkuus. |
meta.access.mode | Varmista tilin integraatiossa, että arvo on api_key. Puuttuva tai tunnistamaton avain voi sen sijaan käyttää yhteistä IP-kokeilua. |
meta.usage | Lue charged_credits ja billing_status. Onnistunut tuntematon tulos veloitetaan. Kadonnut vastaus ei osoita, että pyyntö oli maksuton. |
Päätä, milloin tekoälyä käytetään
forceToGenderize on valinnainen nimille, sähköpostiosoitteille ja käyttäjänimille. Kun se on käytössä, jätä ai_mode pois tai käytä arvoa fallback; off ja always ovat ristiriidassa sen kanssa ja palauttavat 422-virheen. Positiivinen alkusaldo riittää pyynnön aloittamiseen, vaikka lopullinen veloitus painaisi saldon negatiiviseksi.
Lempinimitila voi palauttaa sukupuolen, vaikka tuloksessa on name: null. Se voi myös palauttaa tuntemattoman tuloksen. Tavallinen tekoäly varalla ja lempinimipäättely eivät takaa oikeaa vastausta eivätkä muuta kuin null-arvoista vastausta.
| Pyynnön asetus | Toiminta | Krediitit onnistuneesta hausta |
|---|---|---|
| options.ai_mode: off | Käyttää vain tietoaineistoa. | 1, myös tuntemattomasta tuloksesta |
| options.ai_mode: fallback | Hakee ensin tietoaineistosta ja käyttää tavallista tekoälyä, jos sukupuolta ei saada. Tämä on yksittäisen pyynnön oletus. | Yhteensä 1, tekoäly varalla mukaan lukien |
| options.ai_mode: always | Käyttää suoraan tekoälyä. | 2 |
| forceToGenderize: true | Hakee ensin tietoaineistosta ja sallii sitten tekoälyn tulkita henkilökohtaisen lempinimen tai aliaksen myös ilman todellista etunimeä. | 1 tietoaineistosta ratkaistusta tuloksesta; yhteensä 2, jos tekoälyä käytetään |
Käsittele nimiluettelo menettämättä kontekstia
Käytä päätepistettä POST /api/v2/gender/batch enintään 50 kohteelle rekisteröidyllä API-avaimella tai 10 kohteelle IP-kokeilussa. Anna jokaiselle kohteelle yksilöllinen id ja säilytä kunkin rivin alkuperäinen arvo. Jokaisella kohteella voi olla oma maansa ja omat tekoälysääntönsä; jätä country pois, jos maata ei tiedetä.
Toisin kuin yksittäisissä pyynnöissä, joissa fallback on oletus, eräpyynnön kohteet käyttävät oletuksena vain tietoaineistoa. Aseta options.ai_mode: fallback jokaiselle kohteelle, joka tarvitsee tekoälyä. Tarkista jokainen tulos myös HTTP 200 -vastauksen jälkeen, säilytä tuntemattomat tulokset ja käy kohdekohtaiset virheet ja veloitukset läpi ennen uutta lähetystä. Jokainen onnistunut tavallinen kohde maksaa 1 krediitin; yksi eräpyynnön HTTP-pyyntö ei ole sama asia kuin yksi krediitti yhdestä ennusteesta.
Tiedä, mitä lähetät
Reaaliaikainen demo lähettää syöttämäsi arvon GenderAPI.io-palveluun vain, kun lähetät sen itse. Jos tekoälyä käytetään, lähetetyt type, value ja maakonteksti välitetään ennusteisiin määritetylle palvelulle. Jos haluat ennusteen pelkästä tietoaineistosta, käytä integraatiossasi asetusta options.ai_mode: off ilman forceToGenderize-asetusta.
Tietosuojakäytäntö, tietojenkäsittelysopimus ja alikäsittelijäluettelo kuvaavat julkaistut käsittelyehdot. Tulos on päätelty yhteys; anna henkilön itse ilmoittamien tietojen mennä sen edelle. Älä käytä tulosta perusteena yksilöä koskeville merkittäville päätöksille.
Usein kysytyt kysymykset
Hyväksyykö V2 arabiankielisen tekstin, jossa on tarkkeita?
V2 hyväksyy Unicode-muotoiset nimet, myös arabiankielisen tekstin. Tietoaineiston normalisointi ei yleensä poista arabialaisia vokaalimerkkejä, joten kirjoitusasut vokaalimerkeillä ja ilman niitä voivat tuottaa eri osumat tai tuntemattoman tuloksen.
Määrittääkö työkalu arabiaa puhuvan henkilön kansalaisuuden?
Ei. SA on tätä esittelyä varten erikseen valittu maakonteksti. Kirjoitusjärjestelmä, nimeen liittyvä yhteys ja palautettu maakenttä eivät kerro kansalaisuudesta tai asuinpaikasta.
Onko tarkkuus mitattu, kun syötteenä on arabialainen nimi?
Tällä sivulla ei julkaista tällaista mittausta. Syötteen hyväksyminen, tallennetut määrät ja luottamusarvo eivät ole riippumaton tarkkuusmittaus. Menetelmäsivulta näet, mitä perusteita on saatavilla ja mitä mittauksia ei ole vielä julkaistu.
Kuluttaako tuntematon tulos krediittejä?
Onnistunut tuntematon tulos veloitetaan. Tavallinen tila tietoaineistolla tai fallback maksaa yhteensä 1 krediitin. Kun forceToGenderize on käytössä, tietoaineistosta ratkaistu tulos maksaa 1 krediitin ja tekoälyn käyttö yhteensä 2 krediittiä, myös silloin, kun tekoäly palauttaa tuntemattoman tuloksen. Virheillä on omat veloitussääntönsä; tarkista meta.usage.