Τα σήματα ονόματος και η σημασία των ψευδωνύμων είναι διαφορετικά πράγματα
Χρησιμοποιήστε type: username για ένα όνομα χρήστη ή ένα ψευδώνυμο. Ένα προαιρετικό @ στην αρχή αφαιρείται κατά την αντιστοίχιση με το σύνολο δεδομένων. Η εξαγωγή υποψηφίων λαμβάνει υπόψη διαχωριστικά και ψηφία και μπορεί να ελέγξει περιορισμένες υποσυμβολοσειρές. Η λειτουργία ψευδωνύμων διατηρεί την αντιστοίχιση σε ολόκληρα μέρη, αλλά δεν προσθέτει αυτούς τους υποψηφίους από υποσυμβολοσειρές. Η αποθηκευμένη εγγραφή που επιλέγεται έχει το υψηλότερο συνολικό πλήθος μεταξύ των διαθέσιμων υποψηφίων. Αυτό δεν δείχνει το πραγματικό όνομα του ατόμου πίσω από τον λογαριασμό.
Η κανονική εφεδρική χρήση AI αναζητά ένα αναγνωρίσιμο μικρό όνομα. Το forceToGenderize επιτρέπει επιπλέον μια συσχέτιση μέσω ενός προσωπικού ψευδωνύμου όταν δεν είναι δυνατό να εξαχθεί πραγματικό όνομα. Και οι δύο δρόμοι μπορεί να επιστρέψουν unknown. Ένα εμπορικό σήμα, ένας φανταστικός χαρακτήρας ή ένας κοινόχρηστος λογαριασμός δεν αντιπροσωπεύουν απαραίτητα ένα μεμονωμένο άτομο.
| Παράδειγμα εισόδου | Προσέγγιση | Τι να ελέγξετε |
|---|---|---|
@alice.smith | Ξεκινήστε με το κανονικό fallback, που ελέγχει πρώτα το σύνολο δεδομένων. | Ελέγξτε το όνομα που επιλέχθηκε και τη μέθοδο αντιστοίχισης. Μη θεωρείτε δεδομένο ότι επιλέχθηκε το πρώτο μέρος. |
robert89 | Τα ψηφία μπορεί να αφαιρεθούν κατά την εξαγωγή υποψηφίων. | Ένα όνομα που αντιστοιχίστηκε είναι συσχέτιση, όχι επιβεβαιωμένη ταυτότητα. |
prenses | Ενεργοποιήστε το forceToGenderize για να επιτρέψετε μια απόπειρα του AI με βάση το ψευδώνυμο όταν δεν βρεθεί αποτέλεσμα. | Το gender μπορεί να έχει τιμή διαφορετική από null ενώ το name είναι null. Οι τιμές του AI είναι model_reported. |
team_support | Χειριστείτε τους λογαριασμούς ρόλων και τους κοινόχρηστους λογαριασμούς ως λογαριασμούς που μπορεί να μην ανήκουν σε ένα μόνο άτομο. | Διατηρήστε το unknown και μην αποδίδετε ατομική ταυτότητα σε έναν κοινόχρηστο λογαριασμό. |
Δοκιμή της ανάλυσης ψευδωνύμων στην ενσωμάτωσή σας
Αυτό το αίτημα ενεργοποιεί την ανάλυση ψευδωνύμων. Ελέγχεται πρώτα το σύνολο δεδομένων. Αν δεν επιστρέψει φύλο, το AI μπορεί να χρησιμοποιήσει τη σημασία του ψευδωνύμου. Παραλείψτε το forceToGenderize για μια κανονική αναζήτηση. Τα μεμονωμένα αιτήματα χρησιμοποιούν έτσι κι αλλιώς από προεπιλογή την κανονική εφεδρική χρήση AI.
Σε αυτό το παράδειγμα δίνεται το πλαίσιο χώρας TR. Χρησιμοποιήστε σχετικό πλαίσιο από την εφαρμογή σας και ελέγξτε το data.match.scope. Μια χώρα που δίνεται δεν εγγυάται εγγραφή για τη συγκεκριμένη χώρα. Δεν δηλώνει ούτε εθνικότητα ούτε τόπο κατοικίας.
Επιλέξτε γλώσσα προγραμματισμού. Ρυθμίστε το κλειδί 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 |
Διατήρηση του αποτελέσματος κάθε ονόματος χρήστη κατά την επεξεργασία μιας λίστας
Χρησιμοποιήστε POST /api/v2/gender/batch για λίστες ονομάτων χρήστη ή για μικτές λίστες με ονόματα, διευθύνσεις email και ονόματα χρήστη. Το όριο είναι 50 στοιχεία με κλειδί API ή 10 με τη δοκιμαστική πρόσβαση IP. Κάθε στοιχείο έχει δικές του επιλογές για χώρα και AI και τα προαιρετικά αναγνωριστικά πρέπει να είναι μοναδικά μέσα στην παρτίδα.
Από προεπιλογή, μια παρτίδα χρησιμοποιεί μόνο το σύνολο δεδομένων. Ενεργοποιήστε το fallback ανά στοιχείο αν θέλετε κανονικό AI ή ορίστε το forceToGenderize ανά στοιχείο για ανάλυση ψευδωνύμων. Ελέγξτε το data ή το error σε κάθε αποτέλεσμα και χρησιμοποιήστε το id ή το index για να αντιστοιχίσετε το αποτέλεσμα στην αρχική γραμμή. Τα επιτυχή άγνωστα στοιχεία χρεώνονται.
Να γνωρίζετε τι στέλνετε
Η ζωντανή επίδειξη στέλνει την τιμή που εισάγετε στο GenderAPI.io μόνο όταν την υποβάλετε εσείς. Αν χρησιμοποιηθεί AI, τα type, value και το πλαίσιο χώρας που στάλθηκαν διαβιβάζονται στη ρυθμισμένη υπηρεσία προβλέψεων. Για πρόβλεψη μόνο με το σύνολο δεδομένων, ορίστε στην ενσωμάτωσή σας options.ai_mode: off χωρίς forceToGenderize.
Η πολιτική απορρήτου, η σύμβαση επεξεργασίας δεδομένων και ο κατάλογος των υπεργολάβων επεξεργασίας περιγράφουν τους δημοσιευμένους όρους επεξεργασίας. Ένα αποτέλεσμα είναι μια συσχέτιση που συνάγεται και ό,τι δηλώνει ένα άτομο έχει προτεραιότητα. Μην το χρησιμοποιείτε ως βάση για αποφάσεις με σημαντικές συνέπειες για ένα άτομο.
Συχνές ερωτήσεις
Πρέπει ένα όνομα χρήστη να περιέχει πραγματικό μικρό όνομα;
Η κανονική πρόβλεψη του AI απαιτεί ένα αξιοποιήσιμο μικρό όνομα. Με το forceToGenderize το API μπορεί επιπλέον να επιχειρήσει μια συσχέτιση μέσω ψευδωνύμου όταν η αναζήτηση στο σύνολο δεδομένων δεν δίνει αποτέλεσμα. Αυτή η λειτουργία δεν απαιτεί πραγματικό μικρό όνομα και μπορεί να επιστρέψει name: null.
Εγγυάται το forceToGenderize ότι θα επιστραφεί φύλο;
Όχι. Επιτρέπει την ανάλυση ψευδωνύμων, αλλά το τελικό αποτέλεσμα μπορεί και πάλι να είναι άγνωστο. Διατηρήστε την εγγενή τιμή JSON null και ελέγξτε τα result_status και reason.
Ελέγχει το API το προφίλ στα μέσα κοινωνικής δικτύωσης;
Αυτό το endpoint ερμηνεύει την τιμή που στάλθηκε. Δεν ανακτά το προφίλ, τις αναρτήσεις ή τις φωτογραφίες του λογαριασμού για να διαπιστώσει ποιος είναι ο κάτοχός του.
Μπορώ να χρησιμοποιήσω το forceToGenderize και για ονόματα ή διευθύνσεις email;
Ναι. Είναι προαιρετικό για εισόδους τύπου name, email και username. Χρησιμοποιείται πρώτα το σύνολο δεδομένων και έπειτα, αν δεν βρεθεί αποτέλεσμα, AI με ανάλυση ψευδωνύμων: 1 πίστωση για αποτέλεσμα από το σύνολο δεδομένων ή 2 συνολικά αν χρησιμοποιηθεί AI.