Sygnał imienia i znaczenie pseudonimu to dwie różne rzeczy
Użyj type: username dla nazwy użytkownika lub pseudonimu. Opcjonalny początkowy znak @ jest usuwany przy dopasowaniu w zbiorze danych. Wyodrębnianie kandydatów uwzględnia separatory i cyfry oraz może sprawdzać fragmenty o ograniczonej długości. Tryb pseudonimów zachowuje dopasowanie całych słów, ale nie dodaje takich fragmentów. Wybrany zapisany rekord ma największą łączną liczbę wystąpień spośród dostępnych kandydatów; nie dowodzi to prawdziwego imienia właściciela konta.
Standardowe przejście na AI szuka rozpoznawalnego imienia. forceToGenderize pozwala dodatkowo na powiązanie oparte na osobistym pseudonimie, gdy nie da się wyodrębnić prawdziwego imienia. Obie ścieżki mogą zwrócić unknown; marka, postać lub konto współdzielone nie muszą oznaczać jednej osoby.
| Przykładowe dane wejściowe | Podejście | Co sprawdzić |
|---|---|---|
@alice.smith | Zacznij od standardowego trybu fallback, który najpierw sprawdza zbiór danych. | Sprawdź wybrane imię i metodę dopasowania; nie zakładaj, że wybrano pierwsze słowo. |
robert89 | Cyfry mogą zostać usunięte podczas wyodrębniania kandydatów. | Dopasowane imię to powiązanie, a nie potwierdzona tożsamość. |
prenses | Włącz forceToGenderize, aby w przypadku nierozstrzygniętego wyniku pozwolić AI na próbę opartą na pseudonimie. | gender może mieć wartość inną niż null, gdy name ma wartość null. Wyniki AI mają rodzaj model_reported. |
team_support | Traktuj konta funkcyjne i współdzielone jako potencjalnie nieosobowe. | Zachowaj unknown i nie przypisuj kontu współdzielonemu tożsamości jednej osoby. |
Wypróbuj analizę pseudonimów w swojej integracji
To zapytanie włącza analizę pseudonimów. Najpierw sprawdzany jest zbiór danych. Jeśli nie zwróci płci, AI może wykorzystać znaczenie aliasu. Pomiń forceToGenderize w przypadku standardowego wyszukiwania; pojedyncze zapytania i tak domyślnie korzystają ze standardowego przejścia na AI.
Kontekst kraju TR jest podany na potrzeby tego przykładu. Używaj odpowiedniego kontekstu z własnej aplikacji i sprawdzaj data.match.scope; podany kraj nie gwarantuje rekordu dla tego konkretnego kraju. Nie określa też narodowości ani miejsca zamieszkania.
Wybierz język programowania. Skonfiguruj klucz API, następnie uruchom przykład na swoim serwerze.
Każde zapytanie o prognozę, łącznie z ponownymi próbami, jest nową płatną operacją. Te przykłady nie ponawiają zapytań automatycznie. Przed wysłaniem kolejnego zapytania sprawdź status rozliczenia.
Zanim uruchomisz: dostęp i obsługa błędów
Uruchamiaj te przykłady na swoim serwerze. Ustaw w środowisku procesu zmienną GENDERAPI_API_KEY na swój istniejący klucz API. Upewnij się, że meta.access.mode ma wartość api_key: nierozpoznany klucz może spowodować przejście na próbę dla adresu IP.
W przypadku odpowiedzi JSON z kodem HTTP 4xx i 5xx przykłady zachowują treść błędu i zwracają niezerowy kod wyjścia. Przed ponowną próbą sprawdź code, action i meta.usage.billing_status.
Przewodnik po błędach i ponawianiu zapytań →cURL 7.76+ w powłoce POSIX. Uruchom w terminalu. Dokumentacja środowiska uruchomieniowego
Node.js 22+; wbudowany fetch. Zapisz jako example.mjs i uruchom node example.mjs. Dokumentacja środowiska uruchomieniowego
Python 3.10+; biblioteka standardowa. Zapisz jako example.py i uruchom python3 example.py. Dokumentacja środowiska uruchomieniowego
PHP 8+ z rozszerzeniem cURL. Zapisz jako example.php i uruchom php example.php. Dokumentacja środowiska uruchomieniowego
Java 17+; standardowy klient HTTP. Zapisz jako GenderApiExample.java i uruchom java GenderApiExample.java. Dokumentacja środowiska uruchomieniowego
Aplikacja konsolowa .NET 8+. Użyj jako Program.cs w projekcie konsolowym, a następnie uruchom dotnet run. Dokumentacja środowiska uruchomieniowego
Go 1.22+; biblioteka standardowa. Zapisz jako main.go i uruchom go run main.go. Dokumentacja środowiska uruchomieniowego
Przechowuj wynik razem z informacjami, na których się opiera
Wywnioskowane powiązanie nie jest płcią zadeklarowaną przez daną osobę. Przechowuj osobno oryginalne dane wejściowe, zwrócone informacje o dopasowaniu i dane przekazane przez samą osobę. Wynik unknown jest prawidłowym wynikiem; nie zamieniaj go w swojej aplikacji na zgadywaną kategorię.
| Pole | Jak z niego korzystać |
|---|---|
data.gender / data.result_status | Używaj male lub female tylko wtedy, gdy wynik ma status identified. Gdy wynik jest unknown, zachowaj natywną wartość null z JSON. |
data.name / data.match | Sprawdź zwrócone imię i wybranego kandydata. Dopasowanie fragmentu nie dowodzi, że dane wejściowe należą do osoby o tym imieniu. |
data.confidence / data.confidence_kind | Pewność jest wyrażona w skali 0–1 albo ma wartość null. observed_frequency wynika z zapisanych liczb wystąpień; model_reported to wynik podany przez AI. Progi oceniaj osobno dla każdego rodzaju. |
data.source / data.sample_count | Rozróżniaj dataset, ai i none. Wyniki AI nie mają zapisanej liczby próbek. Liczba próbek nie jest zmierzoną dokładnością. |
meta.access.mode | W integracji z kontem sprawdź, czy wartość to api_key. Brakujący lub nierozpoznany klucz może zamiast tego korzystać ze wspólnej próby dla adresu IP. |
meta.usage | Odczytaj charged_credits i billing_status. Udany wynik unknown jest płatny. Utrata odpowiedzi nie oznacza, że zapytanie było bezpłatne. |
Zdecyduj, kiedy korzystać z AI
forceToGenderize jest opcjonalne dla imion, adresów e-mail i nazw użytkowników. Gdy jest włączone, pomiń ai_mode lub użyj fallback; off i always są z nim sprzeczne i zwracają 422. Dodatnie saldo początkowe wystarcza do rozpoczęcia zapytania, nawet jeśli ostateczne obciążenie obniży saldo poniżej zera.
Tryb pseudonimów może zwrócić płeć razem z name: null. Może też zwrócić wynik unknown. Ani standardowe przejście na AI, ani analiza pseudonimów nie gwarantują poprawnej odpowiedzi ani wartości innej niż null.
| Opcja zapytania | Działanie | Kredyty za udane wyszukiwanie |
|---|---|---|
| options.ai_mode: off | Korzysta tylko ze zbioru danych. | 1, także przy wyniku unknown |
| options.ai_mode: fallback | Najpierw sprawdza zbiór danych, a gdy nie zwróci on płci, korzysta ze standardowej AI. To ustawienie domyślne dla pojedynczych zapytań. | Łącznie 1, łącznie z przejściem na AI |
| options.ai_mode: always | Od razu korzysta z AI. | 2 |
| forceToGenderize: true | Najpierw sprawdza zbiór danych, a potem pozwala AI zinterpretować osobisty pseudonim lub alias, nawet bez prawdziwego imienia. | 1 za wynik rozstrzygnięty w zbiorze danych; łącznie 2, jeśli użyta zostanie AI |
Zachowaj wynik każdej nazwy użytkownika podczas przetwarzania listy
Użyj POST /api/v2/gender/batch dla list nazw użytkowników albo list mieszanych z imionami, adresami e-mail i nazwami użytkowników. Maksimum to 50 elementów z kluczem API lub 10 w próbie dla adresu IP. Każdy element ma własne opcje kraju i AI; opcjonalne identyfikatory muszą być unikalne w obrębie partii.
Domyślnie partia korzysta tylko ze zbioru danych. Włącz fallback w elementach, dla których chcesz standardowej AI, albo ustaw forceToGenderize w elemencie, aby analizować pseudonimy. Sprawdzaj data lub error w każdym wyniku i używaj id lub index, aby zachować powiązanie z oryginalnym wierszem. Udane elementy unknown są płatne.
Wiedz, co wysyłasz
Demo wysyła wpisaną wartość do GenderAPI.io dopiero po kliknięciu Analizuj. Jeśli zostanie użyta AI, przesłane type, value i kontekst kraju trafiają do skonfigurowanej usługi inferencji. Aby uzyskać prognozę wyłącznie ze zbioru danych, użyj w swojej integracji options.ai_mode: off bez forceToGenderize.
Polityka prywatności, umowa powierzenia przetwarzania danych i rejestr podmiotów przetwarzających opisują opublikowane zasady przetwarzania. Wynik jest wywnioskowanym powiązaniem; pierwszeństwo mają informacje przekazane przez samą osobę. Nie opieraj na nim decyzji, które mają istotne skutki dla danej osoby.
Najczęściej zadawane pytania
Czy nazwa użytkownika musi zawierać prawdziwe imię?
Standardowa inferencja AI wymaga użytecznego imienia. Z forceToGenderize API może też spróbować powiązania opartego na pseudonimie, gdy wyszukiwanie w zbiorze danych nie da wyniku. Ten tryb nie wymaga prawdziwego imienia i może zwrócić name: null.
Czy forceToGenderize gwarantuje określenie płci?
Nie. Pozwala na analizę pseudonimów, ale ostateczny wynik nadal może być unknown. Zachowaj natywną wartość null z JSON i sprawdź result_status oraz reason.
Czy API sprawdza profil w mediach społecznościowych?
Ten endpoint analizuje tylko przesłaną wartość. Nie pobiera profilu, postów ani zdjęć konta, aby sprawdzić, kto jest jego właścicielem.
Czy mogę używać forceToGenderize także z imionami i adresami e-mail?
Tak. Jest opcjonalne dla danych wejściowych name, email i username. Najpierw korzysta ze zbioru danych, a gdy wynik jest nierozstrzygnięty, z AI uwzględniającej pseudonimy: 1 kredyt za wynik rozstrzygnięty w zbiorze danych lub łącznie 2, gdy użyta zostanie AI.