配置指南

本文档详细介绍 OpenHuman SDK 的所有配置选项。

基本配置

import { OpenHuman } from 'openhuman-sdk';

const client = new OpenHuman({
  // API 密钥（必需）
  apiKey: 'your_api_key',

  // API 基础 URL（可选，默认使用官方 API）
  baseUrl: 'https://api.openhuman.ai',

  // 请求超时时间（毫秒）
  timeout: 60000,

  // 最大重试次数
  maxRetries: 3,
});

完整配置选项

选项	类型	默认值	描述
apiKey	string	必需	您的 API 密钥
baseUrl	string	官方 API	API 基础 URL
timeout	number	60000	请求超时（毫秒）
maxRetries	number	3	最大重试次数
proxy	string	-	代理服务器地址
userAgent	string	-	自定义 User-Agent
language	string	zh-CN	响应语言

环境变量

推荐使用环境变量存储敏感配置：

# .env 文件
OPENHUMAN_API_KEY=your_api_key
OPENHUMAN_BASE_URL=https://api.openhuman.ai

在代码中加载：

import 'dotenv/config';
import { OpenHuman } from 'openhuman-sdk';

const client = new OpenHuman({
  apiKey: process.env.OPENHUMAN_API_KEY,
  baseUrl: process.env.OPENHUMAN_BASE_URL,
});

日志配置

const client = new OpenHuman({
  apiKey: process.env.OPENHUMAN_API_KEY,

  // 日志级别
  logLevel: 'debug', // 'debug' | 'info' | 'warn' | 'error'

  // 自定义日志函数
  logger: (level, message, meta) => {
    console.log(`[${level}] ${message}`, meta);
  },
});

高级配置

自定义 HTTP 客户端

import axios from 'axios';

const httpClient = axios.create({
  timeout: 30000,
  headers: {
    'Custom-Header': 'value',
  },
});

const client = new OpenHuman({
  apiKey: process.env.OPENHUMAN_API_KEY,
  httpClient,
});

缓存配置

const client = new OpenHuman({
  apiKey: process.env.OPENHUMAN_API_KEY,

  // 启用缓存
  cache: {
    enabled: true,
    ttl: 3600, // 缓存时间（秒）
    maxSize: 100, // 最大缓存条数
  },
});

配置验证

验证您的配置是否正确：

const client = new OpenHuman({
  apiKey: process.env.OPENHUMAN_API_KEY,
});

const isValid = await client.validateConfig();
if (!isValid) {
  console.error('配置无效，请检查您的 API 密钥');
}

下一步

• 核心概念 - 了解 OpenHuman 架构
• 功能教程 - 学习更多功能