Τι λέει μια διεύθυνση email;
Στείλτε μια συντακτικά έγκυρη διεύθυνση email με type: email. Το GenderAPI.io αναζητά ένα σήμα ονόματος στο τμήμα πριν από το @ και έπειτα επιστρέφει μια δομημένη πρόβλεψη. Το γραμματοκιβώτιο δεν επαληθεύεται, δεν συνδέεται με κάτοχο και δεν καθορίζεται η ταυτότητα φύλου του κατόχου.
Η αντιστοίχιση με το σύνολο δεδομένων εξάγει υποψηφίους από τα μέρη της διεύθυνσης και μπορεί να ελέγξει περιορισμένες υποσυμβολοσειρές. Η λειτουργία ψευδωνύμων διατηρεί την αντιστοίχιση σε ολόκληρα μέρη, αλλά δεν προσθέτει αυτούς τους υποψηφίους από υποσυμβολοσειρές. Αν αντιστοιχούν περισσότερες εγγραφές, επιλέγεται ο υποψήφιος με το υψηλότερο αποθηκευμένο συνολικό πλήθος, ο οποίος δεν είναι απαραίτητα το μικρό όνομα που περιμένετε. Ελέγξτε τα data.name και data.match πριν χρησιμοποιήσετε ένα όνομα που εξήχθη σε αρχείο επαφών.
| Παράδειγμα εισόδου | Ερμηνεία |
|---|---|
alice.smith@example.com | Το τοπικό τμήμα περιέχει πιθανά μέρη ενός ονόματος. Μια αντιστοίχιση είναι δυνατή, αλλά η είσοδος από μόνη της δεν καθορίζει ποιος υποψήφιος επιλέγεται. |
alice+news@example.com | Η αναζήτηση στο σύνολο δεδομένων αφαιρεί το επίθημα μετά το σύμβολο συν για τους δικούς της υποψηφίους. Από το AI ζητείται να το αγνοήσει, αλλά λαμβάνει την τιμή που στάλθηκε. |
support@example.com | Μια διεύθυνση ρόλου δεν δίνει αξιόπιστο σήμα προσωπικού ονόματος. Μην αποδίδετε σε ολόκληρο το κοινόχρηστο γραμματοκιβώτιο το φύλο ενός ατόμου. |
prenses@example.com | Η προαιρετική επιλογή forceToGenderize επιτρέπει μια απόπειρα με βάση τη σημασία ενός ψευδωνύμου όταν το σύνολο δεδομένων δεν δίνει αποτέλεσμα. Σε αυτή τη λειτουργία δεν χρειάζεται πραγματικό όνομα. |
not-an-email | Η μη έγκυρη σύνταξη επιστρέφει σφάλμα επικύρωσης αντί για επιτυχές άγνωστο αποτέλεσμα. |
Αποστολή αιτήματος για διεύθυνση email από την εφαρμογή σας
Το παράδειγμα χρησιμοποιεί το υπάρχον κλειδί API σας στην κεφαλίδα Bearer και ορίζει ρητά fallback. Αντικαταστήστε τη διεύθυνση του παραδείγματος με μια είσοδο που έχετε δικαίωμα να επεξεργαστείτε. Δώστε country μόνο όταν διαθέτετε σχετικό πλαίσιο, επειδή ο τομέας του email δεν δείχνει πού βρίσκεται ένα άτομο. Χωρίς πλαίσιο χώρας, παραλείψτε το πεδίο.
Εκτελέστε το παράδειγμα στον διακομιστή σας αφού ορίσετε το GENDERAPI_API_KEY. Με POST η διεύθυνση email μένει εκτός του URL του αιτήματος. Το αποτέλεσμα σε πραγματικό χρόνο μπορεί να διαφέρει από το παράδειγμα απόκρισης της επίδειξης.
Επιλέξτε γλώσσα προγραμματισμού. Ρυθμίστε το κλειδί API σας, και έπειτα εκτελέστε το παράδειγμα στον διακομιστή σας.
Κάθε αίτημα πρόβλεψης είναι μια νέα χρεώσιμη λειτουργία, ακόμη και όταν πρόκειται για νέα προσπάθεια. Αυτά τα παραδείγματα δεν επαναλαμβάνουν αυτόματα το αίτημα. Ελέγξτε την κατάσταση χρέωσης πριν στείλετε άλλο αίτημα.
Πριν από την εκτέλεση: πρόσβαση και χειρισμός σφαλμάτων
Εκτελέστε αυτά τα παραδείγματα στον διακομιστή σας. Ορίστε στο περιβάλλον της διεργασίας το GENDERAPI_API_KEY με το υπάρχον κλειδί API σας. Ελέγξτε ότι το meta.access.mode έχει την τιμή api_key, επειδή ένα κλειδί που δεν αναγνωρίζεται μπορεί να οδηγήσει στη δοκιμαστική πρόσβαση IP.
Στις αποκρίσεις JSON με HTTP 4xx και 5xx διατηρείται το σώμα του σφάλματος και το παράδειγμα τερματίζει με μη μηδενικό κωδικό εξόδου. Ελέγξτε τα code, action και meta.usage.billing_status πριν δοκιμάσετε ξανά.
Οδηγός για σφάλματα και νέες προσπάθειες →cURL 7.76+ σε κέλυφος POSIX. Εκτελέστε το στο τερματικό. Τεκμηρίωση του περιβάλλοντος εκτέλεσης
Node.js 22+ με ενσωματωμένο fetch. Αποθηκεύστε ως example.mjs και εκτελέστε node example.mjs. Τεκμηρίωση του περιβάλλοντος εκτέλεσης
Python 3.10+ με την τυπική βιβλιοθήκη. Αποθηκεύστε ως example.py και εκτελέστε python3 example.py. Τεκμηρίωση του περιβάλλοντος εκτέλεσης
PHP 8+ με την επέκταση cURL. Αποθηκεύστε ως example.php και εκτελέστε php example.php. Τεκμηρίωση του περιβάλλοντος εκτέλεσης
Java 17+ με τον τυπικό πελάτη HTTP. Αποθηκεύστε ως GenderApiExample.java και εκτελέστε java GenderApiExample.java. Τεκμηρίωση του περιβάλλοντος εκτέλεσης
Εφαρμογή κονσόλας .NET 8+. Χρησιμοποιήστε το ως Program.cs σε ένα έργο κονσόλας και έπειτα εκτελέστε dotnet run. Τεκμηρίωση του περιβάλλοντος εκτέλεσης
Go 1.22+ με την τυπική βιβλιοθήκη. Αποθηκεύστε ως main.go και εκτελέστε go run main.go. Τεκμηρίωση του περιβάλλοντος εκτέλεσης
Αποθήκευση του αποτελέσματος μαζί με τα τεκμήρια
Μια συσχέτιση που συνάγεται δεν είναι το φύλο που δηλώνει ένα άτομο. Αποθηκεύστε χωριστά την αρχική είσοδο, τα τεκμήρια που επιστράφηκαν και ό,τι έχει δηλώσει το ίδιο το άτομο. Ένα άγνωστο αποτέλεσμα είναι έγκυρο αποτέλεσμα και δεν πρέπει να γίνει μια μαντεμένη κατηγορία στην εφαρμογή σας.
| Πεδίο | Χρήση |
|---|---|
data.gender / data.result_status | Χρησιμοποιήστε male ή female μόνο μαζί με identified. Σε άγνωστο αποτέλεσμα διατηρήστε την εγγενή τιμή JSON null. |
data.name / data.match | Ελέγξτε το όνομα που επιστράφηκε και τον υποψήφιο που επιλέχθηκε. Μια αντιστοίχιση σε υποσυμβολοσειρά δεν αποδεικνύει ότι η είσοδος ανήκει σε άτομο με αυτό το όνομα. |
data.confidence / data.confidence_kind | Ο βαθμός βεβαιότητας εκφράζεται σε κλίμακα από 0 έως 1 ή είναι null. Το observed_frequency βασίζεται σε αποθηκευμένες συχνότητες, ενώ το model_reported είναι τιμή που αναφέρει το AI. Αξιολογήστε τα όρια χωριστά για κάθε τύπο. |
data.source / data.sample_count | Διακρίνετε τα dataset, ai και none. Τα αποτελέσματα του AI δεν έχουν αποθηκευμένο μέγεθος δείγματος. Ένα μέγεθος δείγματος δεν είναι μετρημένη ακρίβεια. |
meta.access.mode | Σε μια ενσωμάτωση με λογαριασμό ελέγξτε ότι επιστρέφεται api_key. Τα κλειδιά που λείπουν ή δεν αναγνωρίζονται μπορεί αντί γι' αυτό να χρησιμοποιήσουν την κοινόχρηστη δοκιμαστική πρόσβαση IP. |
meta.usage | Διαβάστε τα charged_credits και billing_status. Ένα επιτυχές άγνωστο αποτέλεσμα χρεώνεται. Μια απόκριση που χάθηκε δεν αποδεικνύει ότι το αίτημα ήταν δωρεάν. |
Πότε να χρησιμοποιείται AI
Το forceToGenderize είναι προαιρετικό για ονόματα, διευθύνσεις email και ονόματα χρήστη. Όταν είναι ενεργό, παραλείψτε το ai_mode ή χρησιμοποιήστε fallback. Τα off και always δεν συνδυάζονται με αυτή την επιλογή και επιστρέφουν 422. Ένα θετικό αρχικό υπόλοιπο αρκεί για να ξεκινήσει ένα αίτημα, ακόμη κι αν η τελική χρέωση κάνει το υπόλοιπο αρνητικό.
Η λειτουργία ψευδωνύμων μπορεί να επιστρέψει φύλο μαζί με name: null. Μπορεί επίσης να δώσει άγνωστο αποτέλεσμα. Ούτε η κανονική εφεδρική χρήση AI ούτε η ανάλυση ψευδωνύμων εγγυώνται σωστή απάντηση ή τιμή διαφορετική από null.
| Επιλογή αιτήματος | Συμπεριφορά | Πιστώσεις για επιτυχή αναζήτηση |
|---|---|---|
| options.ai_mode: off | Χρησιμοποιεί μόνο το σύνολο δεδομένων. | 1, και για άγνωστο αποτέλεσμα |
| options.ai_mode: fallback | Ελέγχει πρώτα το σύνολο δεδομένων και έπειτα χρησιμοποιεί κανονικό AI, αν δεν επιστραφεί φύλο. Είναι η προεπιλογή για τα μεμονωμένα αιτήματα. | 1 συνολικά, μαζί με την εφεδρική χρήση AI |
| options.ai_mode: always | Χρησιμοποιεί απευθείας AI. | 2 |
| forceToGenderize: true | Ελέγχει πρώτα το σύνολο δεδομένων και έπειτα αφήνει το AI να ερμηνεύσει ένα προσωπικό ψευδώνυμο ή ένα alias, ακόμη και χωρίς πραγματικό μικρό όνομα. | 1 για αποτέλεσμα από το σύνολο δεδομένων, 2 συνολικά αν χρησιμοποιηθεί AI |
Επεξεργασία μιας λίστας διευθύνσεων email σε παρτίδες
Χρησιμοποιήστε POST /api/v2/gender/batch με έναν πίνακα items που περιέχει στοιχεία με type: email. Η πρόσβαση με κλειδί API ενός εγγεγραμμένου λογαριασμού υποστηρίζει έως 50 στοιχεία, η δοκιμαστική πρόσβαση IP έως 10. Διατηρήστε ένα μοναδικό id για κάθε στοιχείο, ώστε να αντιστοιχίζετε τα αποτελέσματα στην αρχική γραμμή. Επιπλέον, η απόκριση ακολουθεί τη σειρά εισόδου και αναφέρει το index.
Από προεπιλογή, τα στοιχεία μιας παρτίδας χρησιμοποιούν μόνο το σύνολο δεδομένων. Ορίστε options.ai_mode: fallback σε κάθε στοιχείο που χρειάζεται την κανονική εφεδρική χρήση AI. Δύο επιτυχή στοιχεία με fallback κοστίζουν συνολικά 2 πιστώσεις, ακόμη κι όταν τα αποτελέσματα είναι άγνωστα. Ένα αίτημα HTTP δεν αντιστοιχεί σε μία πίστωση ανά πρόβλεψη.
Ελέγξτε κάθε στοιχείο, ακόμη κι όταν η παρτίδα επιστρέφει HTTP 200. Αποθηκεύστε τα επιτυχή και τα άγνωστα αποτελέσματα και έπειτα ελέγξτε τα σφάλματα και την επιβεβαιωμένη χρέωση πριν στείλετε ξανά τα στοιχεία που απέτυχαν. Μετά από λήξη χρονικού ορίου, μη στέλνετε ξανά ολόκληρη μια επιτυχή παρτίδα χωρίς να ελέγξετε πρώτα τη χρέωση.
Να γνωρίζετε τι στέλνετε
Η ζωντανή επίδειξη στέλνει την τιμή που εισάγετε στο GenderAPI.io μόνο όταν την υποβάλετε εσείς. Αν χρησιμοποιηθεί AI, τα type, value και το πλαίσιο χώρας που στάλθηκαν διαβιβάζονται στη ρυθμισμένη υπηρεσία προβλέψεων. Για πρόβλεψη μόνο με το σύνολο δεδομένων, ορίστε στην ενσωμάτωσή σας options.ai_mode: off χωρίς forceToGenderize.
Η πολιτική απορρήτου, η σύμβαση επεξεργασίας δεδομένων και ο κατάλογος των υπεργολάβων επεξεργασίας περιγράφουν τους δημοσιευμένους όρους επεξεργασίας. Ένα αποτέλεσμα είναι μια συσχέτιση που συνάγεται και ό,τι δηλώνει ένα άτομο έχει προτεραιότητα. Μην το χρησιμοποιείτε ως βάση για αποφάσεις με σημαντικές συνέπειες για ένα άτομο.
Συχνές ερωτήσεις
Μπορεί το API να εξαγάγει ένα μικρό όνομα από μια διεύθυνση email;
Μπορεί να επιστρέψει έναν υποψήφιο ονόματος όταν το τοπικό τμήμα περιέχει αξιοποιήσιμο σήμα. Είναι δυνατές αντιστοιχίσεις τόσο σε ολόκληρα μέρη όσο και σε υποσυμβολοσειρές, γι' αυτό ελέγξτε το data.match. Το αποτέλεσμα δεν δείχνει το μικρό όνομα του ατόμου που κατέχει το γραμματοκιβώτιο.
Επιστρέφει φύλο μια διεύθυνση info@ ή support@;
Οι κοινόχρηστες διευθύνσεις ρόλων συνήθως δεν δίνουν τεκμήρια προσωπικού ονόματος. Ένα άγνωστο αποτέλεσμα είναι έγκυρο. Το AI ή η λειτουργία ψευδωνύμων δεν πρέπει να θεωρούνται επιβεβαίωση για τα άτομα που χρησιμοποιούν ένα κοινόχρηστο γραμματοκιβώτιο.
Καταναλώνει πιστώσεις ένα άγνωστο αποτέλεσμα για διεύθυνση email;
Ναι. Ένα κανονικό επιτυχές αίτημα για διεύθυνση email κοστίζει 1 πίστωση, μαζί με την εφεδρική χρήση AI και τα άγνωστα αποτελέσματα. Η αναγκαστική ανάλυση ψευδωνύμων κοστίζει 1 πίστωση για αποτέλεσμα από το σύνολο δεδομένων ή 2 συνολικά αν χρησιμοποιηθεί AI. Σε περίπτωση σφάλματος, η χρέωση αναφέρεται χωριστά στο meta.usage.
Αφαιρείται ο τομέας του email πριν επεξεργαστεί το AI τη διεύθυνση;
Δεν είναι εγγυημένο. Οι υποψήφιοι του συνόλου δεδομένων προέρχονται από το τοπικό τμήμα, ενώ το AI λαμβάνει την τιμή που στάλθηκε με την οδηγία να αγνοήσει τον τομέα και το επίθημα μετά το σύμβολο συν. Χρησιμοποιήστε τη λειτουργία μόνο με το σύνολο δεδομένων αν η ροή εργασίας σας το απαιτεί.