Mitä sähköpostiosoite voi kertoa?
Lähetä syntaksiltaan kelvollinen sähköpostiosoite asetuksella type: email. GenderAPI.io etsii nimisignaalia @-merkkiä edeltävästä osasta ja palauttaa sitten jäsennellyn päätelmän. Se ei tarkista postilaatikkoa, tunnista sen omistajaa eikä määritä kyseisen henkilön sukupuoli-identiteettiä.
Tietoaineiston haku muodostaa ehdokkaat osoitteen osista ja voi kokeilla rajattua määrää merkkijonon osia. Lempinimitila säilyttää kokonaisten osien haun mutta ei lisää näitä merkkijonon osista muodostettuja ehdokkaita. Jos useampi tietue vastaa hakua, valituksi tulee ehdokas, jonka tallennettu kokonaismäärä on suurin; se ei välttämättä ole tarkoitettu etunimi. Tarkista data.name ja data.match ennen kuin käytät poimittua nimeä yhteystietueessa.
| Esimerkkisyöte | Miten sitä tulkitaan |
|---|---|
alice.smith@example.com | Paikallinen osa sisältää mahdollisia nimen osia. Osuma on mahdollinen, mutta pelkkä syöte ei ratkaise, mikä ehdokas valitaan. |
alice+news@example.com | Tietoaineiston haku poistaa plus-merkin jälkeisen päätteen ehdokkaistaan. Tekoälyä ohjeistetaan jättämään se huomiotta, mutta se saa lähetetyn arvon. |
support@example.com | Rooliosoite ei anna luotettavaa henkilönnimen signaalia. Älä määritä koko jaetulle postilaatikolle yhden henkilön sukupuolta. |
prenses@example.com | Valinnainen forceToGenderize sallii yrityksen lempinimen merkityksen perusteella, jos tietoaineisto ei tuota tulosta. Tässä tilassa todellista nimeä ei tarvita. |
not-an-email | Virheellinen syntaksi palauttaa validointivirheen, ei onnistunutta tuntematonta tulosta. |
Lähetä sähköpostihaku sovelluksestasi
Esimerkki käyttää nykyistä API-avaintasi Bearer-otsakkeessa ja erikseen valittua fallback-tilaa. Korvaa esimerkkiosoite syötteellä, jota sinulla on lupa käsitellä. Anna country vain, kun sinulla on asiaankuuluva konteksti; sähköpostin verkkotunnus ei kerro, missä henkilö on. Jätä kenttä pois, jos maakontekstia ei ole.
Suorita esimerkki palvelimellasi, kun GENDERAPI_API_KEY on asetettu. POST pitää sähköpostiosoitteen poissa pyynnön URL-osoitteesta. Reaaliaikainen tulos voi poiketa demon havainnollistavasta vastauksesta.
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 sähköpostiluettelo erissä
Käytä reittiä POST /api/v2/gender/batch ja items-taulukkoa, jonka kohteissa on type: email. Rekisteröidyllä API-avaimella erässä voi olla enintään 50 kohdetta, IP-kokeilussa enintään 10. Anna jokaiselle kohteelle yksilöllinen id, jotta tulokset voidaan yhdistää takaisin alkuperäiseen riviin. Vastaus säilyttää myös syötteiden järjestyksen ja ilmoittaa index-arvon.
Eräpyynnön kohteet käyttävät oletuksena vain tietoaineistoa. Aseta options.ai_mode: fallback jokaiseen kohteeseen, jossa tavallista tekoälyä tarvitaan varalla. Kaksi onnistunutta fallback-kohdetta maksaa yhteensä 2 krediittiä, myös tuntemattomien tulosten kanssa; yksi HTTP-pyyntö ei tarkoita yhtä ennustekrediittiä.
Tarkista jokainen kohde, vaikka erä palauttaisi HTTP 200 -vastauksen. Tallenna onnistuneet ja tuntemattomat tulokset ja tarkista sitten virheet ja vahvistettu laskutus ennen kuin lähetät epäonnistuneet kohteet uudelleen. Älä lähetä koko onnistunutta erää uudelleen aikakatkaisun jälkeen tarkistamatta laskutuksen tulosta.
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
Voiko API poimia etunimen sähköpostiosoitteesta?
Se voi palauttaa nimiehdokkaan, kun paikallisessa osassa on käyttökelpoinen signaali. Osuma voi perustua kokonaisiin osiin tai merkkijonon osiin, joten tarkista data.match. Tulos ei todista postilaatikon omistajan etunimeä.
Palauttavatko osoitteet kuten info@ tai support@ sukupuolen?
Jaetut rooliosoitteet eivät yleensä sisällä perusteita henkilönnimelle. Tuntematon tulos on kelvollinen. Tekoälyä tai lempinimitilaa ei pidä pitää jaettua postilaatikkoa käyttävien henkilöiden vahvistuksena.
Kuluttaako tuntematon sähköpostitulos krediittejä?
Kyllä. Onnistunut tavallinen sähköpostihaku maksaa 1 krediitin, myös tekoäly varalla ja tuntemattomat tulokset. Pakotettu lempinimipäättely maksaa 1 krediitin tietoaineistosta ratkaistusta tuloksesta tai yhteensä 2, jos tekoälyä käytetään. Virheiden laskutustulos ilmoitetaan erikseen kentässä meta.usage.
Poistetaanko sähköpostin verkkotunnus ennen tekoälykäsittelyä?
Tällaista poistoa ei luvata. Tietoaineiston ehdokkaat muodostetaan paikallisesta osasta, kun taas tekoäly saa lähetetyn arvon ja ohjeen jättää verkkotunnus ja plus-merkin jälkeinen pääte huomiotta. Käytä pelkän tietoaineiston tilaa, jos työnkulkusi sitä edellyttää.