DOCUMENTAÇÃO API V2

API v2 JSON respostas e confiança

Entenda os dados e metacampos do GenderAPI v2: gênero, motivos desconhecidos, confiança, evidências do conjunto de dados, pontuações de IA, modo de acesso e metadados de cobrança.

Entenda a resposta JSON

As respostas únicas bem-sucedidas contêm data e meta. A resposta do conjunto de dados abaixo é um exemplo ilustrativo, não uma medição da precisão do produto ou uma promessa do mesmo resultado ao vivo. Mostra o acesso de teste de IP. Solicitações autenticadas com chave de conta retornam access.mode: api_key; os campos que se aplicam apenas ao teste têm o valor null.

CampoSignificado
data.inputTipo de entrada, valor e país. forceToGenderize é incluído quando true.
data.nameNome próprio correspondente ou extraído; null quando nenhum estiver disponível.
data.gendermale, female ou JSON null. Esta é uma previsão, não uma prova da identidade de uma pessoa.
data.result_status / reasonQuando result_status é identified, reason é null. Quando o status é unknown, o motivo é not_found, no_name_candidate, ambiguous ou insufficient_evidence.
data.confidencepontuação de 0–1 ou null. O gênero nulo tem confiança null.
data.confidence_kindobserved_frequency: a contagem de gênero dominante dividida pela contagem total no conjunto de dados selecionado. model_reported: uma pontuação de IA, não uma probabilidade calibrada. O valor é null quando indisponível.
data.sample_countTamanho da amostra do conjunto de dados ou null. A IA não inventa uma contagem de amostras.
data.sourcedataset, ai ou none.
data.country / country_sourceAssociação de país do conjunto de dados ou ai_association ou null. Não estabelece nacionalidade, residência ou etnia.
data.matchNome correspondente no conjunto de dados, método (normalized, token, substring ou model_inference), escopo (country ou global) e país da correspondência. Informações indisponíveis recebem null.
meta.request_id / duration_msIdentificador da operação e duração do processamento em milissegundos.
meta.accessComo o acesso foi concedido e o motivo do teste alternativo, se houver.
meta.usageCobrança líquida, saldo de tempo de conclusão, status de faturamento e informações de redefinição de teste.
Resposta JSON ilustrativa
{
  "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
    }
  }
}

Um resultado desconhecido bem-sucedido

HTTP 200 significa que a operação foi concluída; não garante um gênero. Preserve JSON null em vez de convertê-lo em male, female, uma sequência vazia ou confiança zero. Verifique data.result_status e data.reason separadamente dos erros HTTP.

Este exemplo somente de conjunto de dados retorna source: none e reason: not_found e ainda custa 1 crédito. Se as contagens do conjunto de dados para os dois sexos forem iguais, o resultado poderá conter reason: ambiguous preservando sample_count. Um resultado de IA desconhecido usa source: ai e reason: insufficient_evidence.

Resposta JSON ilustrativa
{
  "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
    }
  }
}

Interpretar a confiança e as evidências correspondentes

Uma confiança de 0,9 está em uma escala de 0–1. Para observed_frequency significa a contagem dominante dividida pelo total do conjunto de dados selecionado; não é medida a precisão do produto de ponta a ponta. Uma pontuação model_reported é fornecida pela IA e não é calibrada em relação às frequências do conjunto de dados.

Escolha qualquer limite de aplicação usando seus próprios dados de avaliação e confidence_kind. Não classifique diretamente o conjunto de dados e as pontuações de IA como se medissem a mesma coisa. AI match.name, match.scope e match.country são null porque nenhuma linha do conjunto de dados foi selecionada; match.method é model_inference.

Para nomes completos, o resultado do conjunto de dados pode vir de um componente em vez da string completa. data.input preserva o valor enviado; data.name descreve o nome retornado e data.match descreve o candidato e o escopo de pesquisa.

Guias relacionados