AI 模式和 forceToGenderize
在 POST 实体中,设置 options:{"ai_mode": "off"}(或 fallback / always)。在 GET URL 中,使用 ai_mode=off。批次项目默认为off;在每个需要它的项目上单独启用 fallback。
当forceToGenderize为true时,省略ai_mode或使用fallback。与off或always组合返回422。普通AI推理需要可用的真实名字;强制推理可以使用别名。这两种模式都不能保证非 null 性别。
数据集或提供程序错误是请求失败,而不是数据集丢失。失败的预测将被退款;无法确认计费结果时,请检查billing_status后再重试。
| 模式 | 行为 | 每个成功项目的总积分 |
|---|---|---|
| off | 仅数据集;没有人工智能通话。 | 1,包括未知结果 |
| fallback | 首先是数据集,如果性别未解决,则再是 AI。单个请求的默认值。 | 1,包括AI后备 |
| always | 跳过数据集,直接询问 AI。 | 2 |
| forceToGenderize: true | 首先是数据集,然后是昵称感知人工智能(如果未解决)。适用于姓名、电子邮件和用户名。 | 1 表示已解析的数据集结果;如果使用 AI,总共 2 个 |
启用昵称感知推理
可选的 forceToGenderize 字段适用于 type 的所有三个值:name、email 和 username。此示例在名称输入中提供昵称。使用您现有的 Bearer API 密钥。未知性别也是有效结果。
选择编程语言。 设置您的 API 密钥, 然后在您的服务器上运行该示例。
每个预测请求都是一个新的计费操作,包括重试。这些示例不会自动重试。在发送另一个请求之前检查计费状态。
运行之前:访问和错误处理
在您的服务器上运行这些示例。将流程环境中的 GENDERAPI_API_KEY 设置为现有的 API 密钥。确认 meta.access.mode 是 api_key:无法识别的密钥可以回退到 IP 试用。
HTTP 4xx 和 5xx JSON 响应保留错误主体并返回非零退出状态。重试前请检查 code、action 和 meta.usage.billing_status。
错误和重试指南 →curl --silent --show-error --fail-with-body --max-time 30 \
--request POST 'https://api.genderapi.io/api/v2/gender' \
--header "Authorization: Bearer ${GENDERAPI_API_KEY:?Set GENDERAPI_API_KEY}" \
--header 'Content-Type: application/json' \
--data '{
"type": "name",
"value": "prenses",
"country": "TR",
"forceToGenderize": true
}'cURL 7.76+ 在 POSIX shell 中. 在终端中运行。 运行时文档
// Server-side Node.js. Save as example.mjs.
const apiKey = process.env.GENDERAPI_API_KEY;
if (!apiKey) throw new Error("Set GENDERAPI_API_KEY");
const body = {
"type": "name",
"value": "prenses",
"country": "TR",
"forceToGenderize": true
};
const response = await fetch("https://api.genderapi.io/api/v2/gender", {
method: "POST",
headers: {
Authorization: `Bearer ${apiKey}`,
"Content-Type": "application/json",
},
body: JSON.stringify(body),
signal: AbortSignal.timeout(30_000),
redirect: "error",
});
const raw = await response.text();
if (!(response.headers.get("content-type") ?? "").includes("json")) {
throw new Error(`HTTP ${response.status}: expected JSON; request ID ${response.headers.get("x-request-id")}`);
}
const result = JSON.parse(raw); // Also accepts application/problem+json.
if (!response.ok) {
console.error(`HTTP ${response.status}`, result);
process.exitCode = 1; // A retry is a new operation; inspect billing first.
} else {
console.log(JSON.stringify(result, null, 2));
// For batches, inspect every item: HTTP 200 may contain item errors.
}Node.js 22+;内置获取. 另存为example.mjs并运行node example.mjs。 运行时文档
import json
import os
import sys
import urllib.error
import urllib.request
api_key = os.environ.get("GENDERAPI_API_KEY")
if not api_key:
raise RuntimeError("Set GENDERAPI_API_KEY")
body = json.loads("{\"type\":\"name\",\"value\":\"prenses\",\"country\":\"TR\",\"forceToGenderize\":true}")
class NoRedirect(urllib.request.HTTPRedirectHandler):
def redirect_request(self, req, fp, code, msg, headers, newurl):
return None
request = urllib.request.Request(
"https://api.genderapi.io/api/v2/gender",
method="POST",
data=json.dumps(body).encode("utf-8"),
headers={
"Authorization": "Bearer " + api_key,
"Content-Type": "application/json",
},
)
opener = urllib.request.build_opener(NoRedirect())
try:
response = opener.open(request, timeout=30)
except urllib.error.HTTPError as error:
response = error # Keep the Problem Details body on non-2xx responses.
with response:
status = response.status
raw = response.read().decode("utf-8")
if "json" not in response.headers.get("Content-Type", ""):
raise RuntimeError(f"HTTP {status}: expected a JSON response")
result = json.loads(raw)
print(json.dumps(result, indent=2), file=sys.stderr if status >= 300 else sys.stdout)
if not 200 <= status < 300:
sys.exit(1) # Inspect code, action and billing before retrying.
# For batches, inspect every item even when HTTP status is 200.Python 3.10+;标准库. 另存为example.py并运行python3 example.py。 运行时文档
<?php
$apiKey = getenv('GENDERAPI_API_KEY');
if (!$apiKey) {
throw new RuntimeException('Set GENDERAPI_API_KEY');
}
$body = json_decode('{"type":"name","value":"prenses","country":"TR","forceToGenderize":true}', true, 512, JSON_THROW_ON_ERROR);
$ch = curl_init('https://api.genderapi.io/api/v2/gender');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $apiKey,
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode($body, JSON_THROW_ON_ERROR),
]);
$raw = curl_exec($ch);
if ($raw === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$contentType = curl_getinfo($ch, CURLINFO_CONTENT_TYPE) ?: '';
curl_close($ch);
if (strpos($contentType, 'json') === false) {
throw new RuntimeException("HTTP $status: expected a JSON response");
}
$result = json_decode($raw, true, 512, JSON_THROW_ON_ERROR);
$output = json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR) . PHP_EOL;
if ($status < 200 || $status >= 300) {
fwrite(STDERR, $output); // Preserve the Problem Details body.
exit(1);
}
echo $output;
// For batches, inspect every item; HTTP 200 can contain item errors.PHP 8+ 带有 cURL 扩展. 另存为example.php并运行php example.php。 运行时文档
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
public class GenderApiExample {
private static String requiredEnv(String name) {
String value = System.getenv(name);
if (value == null || value.isBlank()) throw new IllegalStateException("Set " + name);
return value;
}
public static void main(String[] args) throws Exception {
String apiKey = requiredEnv("GENDERAPI_API_KEY");
String body = "{\"type\":\"name\",\"value\":\"prenses\",\"country\":\"TR\",\"forceToGenderize\":true}";
HttpClient client = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(10))
.followRedirects(HttpClient.Redirect.NEVER)
.build();
HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.genderapi.io/api/v2/gender"))
.timeout(Duration.ofSeconds(30))
.header("Authorization", "Bearer " + apiKey)
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8))
.build();
HttpResponse<String> response = client.send(request,
HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8));
if (!response.headers().firstValue("content-type").orElse("").contains("json")) {
throw new IllegalStateException("HTTP " + response.statusCode() + ": expected JSON");
}
// JSON text; parse with your application's JSON library when integrating.
if (response.statusCode() < 200 || response.statusCode() >= 300) {
System.err.println(response.body()); // Includes Problem Details.
System.exit(1);
}
System.out.println(response.body());
// For batches, inspect each item's data or error, including on HTTP 200.
}
}Java 17+;标准HTTP客户端. 另存为GenderApiExample.java并运行java GenderApiExample.java。 运行时文档
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;
string RequiredEnv(string name) =>
!string.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable(name))
? Environment.GetEnvironmentVariable(name)!
: throw new InvalidOperationException($"Set {name}");
var apiKey = RequiredEnv("GENDERAPI_API_KEY");
using var handler = new HttpClientHandler { AllowAutoRedirect = false };
using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) };
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.genderapi.io/api/v2/gender");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);
request.Content = new StringContent("{\"type\":\"name\",\"value\":\"prenses\",\"country\":\"TR\",\"forceToGenderize\":true}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
var raw = await response.Content.ReadAsStringAsync();
if (!(response.Content.Headers.ContentType?.MediaType?.Contains("json") ?? false))
throw new InvalidOperationException($"HTTP {(int)response.StatusCode}: expected JSON");
using var result = JsonDocument.Parse(raw);
if (!response.IsSuccessStatusCode)
{
Console.Error.WriteLine(result.RootElement); // Preserve Problem Details.
Environment.ExitCode = 1;
}
else
{
Console.WriteLine(result.RootElement);
// For batches, inspect every item even on HTTP 200.
}.NET 8+ 控制台应用程序. 在控制台项目中用作 Program.cs,然后运行 dotnet run。 运行时文档
package main
import (
"encoding/json"
"fmt"
"io"
"net/http"
"os"
"strings"
"time"
)
func requiredEnv(name string) string {
value := os.Getenv(name)
if value == "" { panic("Set " + name) }
return value
}
func run() error {
apiKey := requiredEnv("GENDERAPI_API_KEY")
body := "{\"type\":\"name\",\"value\":\"prenses\",\"country\":\"TR\",\"forceToGenderize\":true}"
request, err := http.NewRequest("POST", "https://api.genderapi.io/api/v2/gender", strings.NewReader(body))
if err != nil { return err }
request.Header.Set("Authorization", "Bearer " + apiKey)
request.Header.Set("Content-Type", "application/json")
client := &http.Client{
Timeout: 30 * time.Second,
CheckRedirect: func(req *http.Request, via []*http.Request) error {
return http.ErrUseLastResponse
},
}
response, err := client.Do(request)
if err != nil { return err }
defer response.Body.Close()
raw, err := io.ReadAll(response.Body)
if err != nil { return err }
if !strings.Contains(response.Header.Get("Content-Type"), "json") || !json.Valid(raw) {
return fmt.Errorf("HTTP %d: expected a JSON response", response.StatusCode)
}
if response.StatusCode < 200 || response.StatusCode >= 300 {
return fmt.Errorf("HTTP %d: %s", response.StatusCode, raw)
}
fmt.Println(string(raw))
// For batches, inspect every item even on HTTP 200.
return nil
}
func main() {
if err := run(); err != nil {
fmt.Fprintln(os.Stderr, err) // Keep Problem Details for error handling.
os.Exit(1)
}
}Go 1.22+;标准库. 另存为main.go并运行go run main.go。 运行时文档