Co może powiedzieć adres e-mail?
Wyślij poprawny składniowo adres e-mail z type: email. GenderAPI.io szuka sygnału imienia w części przed @, a następnie zwraca ustrukturyzowaną prognozę. Nie weryfikuje skrzynki pocztowej, nie ustala jej właściciela ani jego tożsamości płciowej.
Dopasowanie w zbiorze danych wyodrębnia kandydatów i może sprawdzać fragmenty o ograniczonej długości. Tryb pseudonimów zachowuje dopasowanie całych słów, ale nie dodaje takich fragmentów. Jeśli pasuje kilka rekordów, wybierany jest kandydat o największej zapisanej łącznej liczbie wystąpień; nie musi to być zamierzone imię. Zanim użyjesz wyodrębnionego imienia w rekordzie kontaktu, sprawdź data.name i data.match.
| Przykładowe dane wejściowe | Jak je interpretować |
|---|---|
alice.smith@example.com | Część przed @ zawiera możliwe słowa będące imionami. Dopasowanie jest możliwe, ale same dane wejściowe nie przesądzają, który kandydat zostanie wybrany. |
alice+news@example.com | Wyszukiwanie w zbiorze danych usuwa przyrostek po znaku + przy tworzeniu kandydatów. AI otrzymuje przesłaną wartość z instrukcją, aby ten przyrostek zignorować. |
support@example.com | Adres funkcyjny nie daje wiarygodnego sygnału imienia osoby. Nie przypisuj całej wspólnej skrzynce płci jednej osoby. |
prenses@example.com | Opcjonalne forceToGenderize pozwala na próbę opartą na znaczeniu pseudonimu, jeśli zbiór danych nie rozstrzygnie wyniku. W tym trybie prawdziwe imię nie jest wymagane. |
not-an-email | Niepoprawna składnia zwraca błąd walidacji, a nie udany wynik unknown. |
Wyślij wyszukiwanie adresu e-mail ze swojej aplikacji
Ten przykład używa Twojego istniejącego klucza API w nagłówku Bearer i jawnie ustawia fallback. Zastąp przykładowy adres wartością, którą możesz przetwarzać. Podawaj country tylko wtedy, gdy masz odpowiedni kontekst; domena adresu e-mail nie określa, gdzie przebywa dana osoba. Jeśli nie znasz kraju, pomiń to pole.
Uruchom przykład na swoim serwerze z ustawioną zmienną GENDERAPI_API_KEY. Metoda POST sprawia, że adres e-mail nie trafia do adresu URL zapytania. Wynik na żywo może się różnić od poglądowej odpowiedzi w demo.
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 |
Przetwarzaj listę adresów e-mail w partiach
Użyj POST /api/v2/gender/batch z tablicą items zawierającą wpisy type: email. Dostęp z zarejestrowanym kluczem API obsługuje do 50 elementów, a próba dla adresu IP do 10. Nadaj każdemu elementowi unikalne id, aby móc połączyć wyniki z oryginalnym wierszem. Odpowiedź zachowuje też kolejność danych wejściowych i podaje index.
Elementy partii domyślnie korzystają tylko ze zbioru danych. Ustaw options.ai_mode: fallback w każdym elemencie, który wymaga standardowego przejścia na AI. Dwa udane elementy z fallback kosztują łącznie 2 kredyty, także przy wynikach unknown; jedno zapytanie HTTP to nie jeden kredyt za prognozę.
Sprawdzaj każdy element, nawet jeśli partia zwraca HTTP 200. Zapisz wyniki udane i unknown, a następnie przejrzyj błędy i potwierdzone rozliczenie, zanim ponownie wyślesz nieudane elementy. Po przekroczeniu limitu czasu nie wysyłaj ponownie całej udanej partii bez sprawdzenia wyniku rozliczenia.
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 API może wyodrębnić imię z adresu e-mail?
Może zwrócić kandydata na imię, gdy część przed @ zawiera użyteczny sygnał. Możliwe są dopasowania całych słów i fragmentów, dlatego sprawdzaj data.match. Wynik nie dowodzi imienia właściciela skrzynki.
Czy adres info@ lub support@ zwróci płeć?
Wspólne adresy funkcyjne zazwyczaj nie zawierają informacji o imieniu osoby. Wynik unknown jest prawidłowy. Ani AI, ani tryb pseudonimów nie potwierdzają tożsamości osób korzystających ze wspólnej skrzynki.
Czy wynik unknown dla adresu e-mail zużywa kredyty?
Tak. Udane standardowe wyszukiwanie adresu e-mail kosztuje 1 kredyt, łącznie z przejściem na AI i wynikami unknown. Wymuszona analiza pseudonimów kosztuje 1 kredyt za wynik rozstrzygnięty w zbiorze danych albo łącznie 2, jeśli użyta zostanie AI. Rozliczenie błędów jest podawane osobno w meta.usage.
Czy domena adresu e-mail jest usuwana przed przetworzeniem przez AI?
Takie usuwanie nie jest gwarantowane. Kandydaci ze zbioru danych pochodzą z części przed @, natomiast AI otrzymuje przesłaną wartość z instrukcją, aby zignorować domenę i przyrostek po znaku +. Jeśli Twój proces tego wymaga, użyj trybu tylko ze zbiorem danych.