DOCUMENTAZIONE API V2

Risposte e confidenza di API v2 JSON

Comprendere i dati e i metacampi GenderAPI v2: genere, motivi sconosciuti, confidenza, prove del set di dati, punteggi IA, modalità di accesso e metadati di fatturazione.

Comprendere la risposta JSON

Le risposte singole riuscite contengono data e meta. La risposta del set di dati riportata di seguito è un esempio illustrativo, non una misurazione dell'accuratezza del prodotto o una promessa dello stesso risultato in tempo reale. Mostra l'accesso di prova IP. Le richieste autenticate con una chiave account restituiscono access.mode: api_key; i campi validi solo per la prova hanno valore null.

CampoSignificato
data.inputTipo di input, valore e paese. forceToGenderize è incluso quando true.
data.nameNome abbinato o estratto; null quando nessuno è disponibile.
data.gendermale, female o JSON null. Questa è una previsione, non una prova dell'identità di una persona.
data.result_status / reasonQuando result_status è identified, reason è null. Quando lo stato è unknown, il motivo è not_found, no_name_candidate, ambiguous o insufficient_evidence.
data.confidencePunteggio 0–1 o null. Il genere null ha la confidenza null.
data.confidence_kindobserved_frequency: il conteggio del genere dominante diviso per il conteggio totale nel set di dati selezionato. model_reported: un punteggio IA, non una probabilità calibrata. Il valore è null quando non disponibile.
data.sample_countDimensioni del campione del set di dati o null. L'intelligenza artificiale non inventa un conteggio dei campioni.
data.sourcedataset, ai o none.
data.country / country_sourceAssociazione paese dal set di dati o ai_association o null. Non stabilisce nazionalità, residenza o etnia.
data.matchNome corrispondente nel set di dati, metodo (normalized, token, substring o model_inference), ambito (country o global) e paese associato. Le informazioni non disponibili sono null.
meta.request_id / duration_msIdentificatore dell'operazione e durata dell'elaborazione in millisecondi.
meta.accessCome è stato concesso l'accesso e il motivo dell'eventuale fallback del processo.
meta.usageCosto netto, saldo del tempo di completamento, stato di fatturazione e informazioni sul ripristino della prova.
Risposta JSON illustrativa
{
  "data": {
    "input": {
      "type": "name",
      "value": "Onur",
      "country": "TR"
    },
    "name": "onur",
    "gender": "male",
    "country": "TR",
    "confidence": 0.9,
    "confidence_kind": "observed_frequency",
    "sample_count": 100,
    "source": "dataset",
    "result_status": "identified",
    "reason": null,
    "country_source": "dataset",
    "match": {
      "name": "onur",
      "method": "normalized",
      "scope": "country",
      "country": "TR"
    }
  },
  "meta": {
    "request_id": "11111111-1111-4111-8111-111111111111",
    "duration_ms": 12,
    "access": {
      "mode": "ip_trial",
      "reason": "api_key_missing"
    },
    "usage": {
      "charged_credits": 1,
      "remaining_credits": 9,
      "billing_status": "confirmed",
      "resets_at": "2026-09-26T12:00:00.000Z",
      "limit": 10,
      "period_seconds": 86400
    }
  }
}

Un risultato positivo sconosciuto

HTTP 200 significa operazione completata; non garantisce un genere. Conserva JSON null anziché convertirlo in male, female, una stringa vuota o confidenza zero. Controllare data.result_status e data.reason separatamente dagli errori HTTP.

Questo esempio di solo set di dati restituisce source: none e reason: not_found e costa comunque 1 credito. Se i conteggi del set di dati per i due sessi sono uguali, il risultato può contenere reason: ambiguous preservando sample_count. Un risultato IA sconosciuto utilizza source: ai e reason: insufficient_evidence.

Risposta JSON illustrativa
{
  "data": {
    "input": {
      "type": "name",
      "value": "zzzxxyy",
      "country": null
    },
    "name": null,
    "gender": null,
    "country": null,
    "confidence": null,
    "confidence_kind": null,
    "sample_count": null,
    "source": "none",
    "result_status": "unknown",
    "reason": "not_found",
    "country_source": null,
    "match": {
      "name": null,
      "method": null,
      "scope": null,
      "country": null
    }
  },
  "meta": {
    "request_id": "11111111-1111-4111-8111-111111111111",
    "duration_ms": 12,
    "access": {
      "mode": "ip_trial",
      "reason": "api_key_missing"
    },
    "usage": {
      "charged_credits": 1,
      "remaining_credits": 8,
      "billing_status": "confirmed",
      "resets_at": "2026-09-26T12:00:00.000Z",
      "limit": 10,
      "period_seconds": 86400
    }
  }
}

Interpretare la confidenza e la corrispondenza delle prove

Una confidenza di 0,9 è su una scala 0–1. Per observed_frequency significa il conteggio dominante diviso per il totale del set di dati selezionato; non viene misurata l'accuratezza del prodotto end-to-end. Un punteggio model_reported è fornito da IA e non è calibrato rispetto alle frequenze del set di dati.

Scegli qualsiasi soglia di applicazione utilizzando i tuoi dati di valutazione e confidence_kind. Non classificare direttamente il set di dati e i punteggi dell’intelligenza artificiale come se misurassero la stessa cosa. IA match.name, match.scope e match.country sono null perché non è stata selezionata alcuna riga del set di dati; match.method è model_inference.

Per i nomi completi, il risultato di un set di dati può provenire da un componente anziché dalla stringa completa. data.input conserva il valore inviato; data.name descrive il nome restituito e data.match descrive il candidato e l'ambito di ricerca.

Guide correlate