Nimisignaalit ja lempinimien merkitykset ovat eri asioita
Käytä käyttäjänimelle tai lempinimelle asetusta type: username. Valinnainen alussa oleva @-merkki poistetaan tietoaineiston haussa. Ehdokkaiden poiminta ottaa huomioon erotinmerkit ja numerot ja voi kokeilla rajattua määrää merkkijonon osia. Lempinimitila säilyttää kokonaisten osien haun mutta ei lisää näitä merkkijonon osista muodostettuja ehdokkaita. Valitun tallennetun tietueen kokonaismäärä on suurin käytettävissä olevista ehdokkaista; se ei todista tilin omistajan oikeaa nimeä.
Tavallinen tekoäly varalla etsii tunnistettavaa etunimeä. forceToGenderize sallii lisäksi yhteyden henkilökohtaiseen lempinimeen, kun todellista nimeä ei voida poimia. Kumpikin tapa voi palauttaa arvon unknown; brändi, hahmo tai jaettu tili ei välttämättä edusta yhtä henkilöä.
| Esimerkkisyöte | Toimintatapa | Mitä tarkistetaan |
|---|---|---|
@alice.smith | Aloita tavallisella fallback-tilalla, joka hakee ensin tietoaineistosta. | Tarkista valittu nimi ja osumatapa; älä oleta, että ensimmäinen osa valittiin. |
robert89 | Numerot voidaan poistaa ehdokkaiden poiminnassa. | Vastaava nimi on päätelty yhteys, ei vahvistettu henkilöllisyys. |
prenses | Ota forceToGenderize käyttöön, jotta tekoäly voi yrittää lempinimeen perustuvaa päätelmää, kun tietoaineisto ei tuota tulosta. | gender voi olla muu kuin null, vaikka name on null. Tekoälyn pistemäärät ovat tyyppiä model_reported. |
team_support | Käsittele rooli- ja jaettuja tilejä tileinä, jotka eivät välttämättä kuulu yhdelle henkilölle. | Säilytä unknown äläkä liitä jaettuun tiliin yksittäisen henkilön identiteettiä. |
Kokeile lempinimipäättelyä integraatiossasi
Tämä pyyntö ottaa lempinimipäättelyn käyttöön. Ensin tarkistetaan tietoaineisto. Jos se ei palauta sukupuolta, tekoäly voi käyttää aliaksen merkitystä. Jätä forceToGenderize pois tavallisesta hausta; yksittäiset pyynnöt käyttävät silti oletuksena tavallista tekoälyä varalla.
Tässä esimerkissä annetaan maakonteksti TR. Käytä sovelluksesi asiaankuuluvaa kontekstia ja tarkista data.match.scope; annettu maa ei takaa maakohtaista tietuetta. Se ei myöskään osoita kansalaisuutta tai asuinpaikkaa.
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 |
Säilytä jokaisen käyttäjänimen tulos luetteloa käsitellessäsi
Käytä reittiä POST /api/v2/gender/batch käyttäjänimiluetteloille tai sekaluetteloille, joissa on nimiä, sähköpostiosoitteita ja käyttäjänimiä. Enimmäismäärä on 50 kohdetta API-avaimella tai 10 IP-kokeilussa. Jokaisella kohteella on omat maa- ja tekoälyasetuksensa; valinnaisten tunnisteiden on oltava yksilöllisiä erän sisällä.
Eräpyynnön oletus on vain tietoaineisto. Ota fallback käyttöön kohdekohtaisesti, jos haluat tavallisen tekoälyn, tai aseta kohteelle forceToGenderize lempinimipäättelyä varten. Tarkista jokaisen tuloksen data tai error ja säilytä yhteys alkuperäiseen riviin id- tai index-arvon avulla. Onnistuneet tuntemattomat kohteet veloitetaan.
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
Pitääkö käyttäjänimessä olla todellinen etunimi?
Tavallinen tekoälypäätelmä edellyttää käyttökelpoista etunimeä. forceToGenderize-asetuksella API voi lisäksi yrittää lempinimeen perustuvaa yhteyttä, kun tietoaineiston haku ei tuota tulosta. Tämä tila ei edellytä todellista etunimeä, ja se voi palauttaa arvon name: null.
Takaako forceToGenderize sukupuolen?
Ei. Se sallii lempinimipäättelyn, mutta lopullinen tulos voi silti olla tuntematon. Säilytä alkuperäinen JSON null -arvo ja tarkista result_status ja reason.
Tarkistaako API sosiaalisen median profiilin?
Tämä päätepiste analysoi lähetetyn arvon. Se ei hae tilin profiilia, julkaisuja tai kuvia varmistaakseen, kenelle tili kuuluu.
Voinko käyttää forceToGenderize-asetusta myös nimille tai sähköpostiosoitteille?
Kyllä. Se on valinnainen syötetyypeille name, email ja username. Ensin käytetään tietoaineistoa ja sitten tarvittaessa lempinimiä tulkitsevaa tekoälyä: 1 krediitti tietoaineistosta ratkaistusta tuloksesta tai yhteensä 2, jos tekoälyä käytetään.