开发文档
欢迎使用 AI 智能路由服务平台开发文档。这里提供了完整的 API 参考、集成指南和最佳实践。
快速开始
1. 获取 API 密钥
首先,您需要在我们的平台上注册账户并获取 API 密钥:
- 访问 控制台
- 注册或登录您的账户
- 在 API 密钥页面生成新的密钥
- 保存您的密钥(请妥善保管,不要泄露)
2. 基础配置
// 配置 API 客户端
const client = new AIAcceleratorClient({
apiKey: 'your-api-key-here',
baseURL: 'https://jp.augmunt.com'
});
3. 发送第一个请求
// Augment 代码补全示例
const response = await client.augment.complete({
code: 'function fibonacci(n) {',
language: 'javascript',
maxTokens: 100
});
console.log(response.completion);
API 参考
Augment API
代码补全
端点: POST /v1/augment/complete
请求参数:
参数 | 类型 | 必需 | 描述 |
---|---|---|---|
code | string | 是 | 需要补全的代码 |
language | string | 是 | 编程语言 |
maxTokens | number | 否 | 最大生成 token 数(默认:100) |
temperature | number | 否 | 生成随机性(0-1,默认:0.3) |
响应示例:
{
"completion": " if (n <= 1) return n;\n return fibonacci(n-1) + fibonacci(n-2);\n}",
"usage": {
"promptTokens": 15,
"completionTokens": 25,
"totalTokens": 40
}
}
代码分析
端点: POST /v1/augment/analyze
请求参数:
参数 | 类型 | 必需 | 描述 |
---|---|---|---|
code | string | 是 | 需要分析的代码 |
language | string | 是 | 编程语言 |
checks | array | 否 | 检查类型(quality, security, performance) |
Claude API
对话
端点: POST /v1/claude/chat
请求参数:
参数 | 类型 | 必需 | 描述 |
---|---|---|---|
messages | array | 是 | 对话消息数组 |
maxTokens | number | 否 | 最大生成 token 数 |
temperature | number | 否 | 生成随机性 |
消息格式:
{
"messages": [
{
"role": "user",
"content": "请解释这段 Python 代码的作用"
}
]
}
CodeX API
代码生成
端点: POST /v1/codex/generate
请求参数:
参数 | 类型 | 必需 | 描述 |
---|---|---|---|
prompt | string | 是 | 生成提示 |
language | string | 是 | 目标编程语言 |
maxTokens | number | 否 | 最大生成 token 数 |
SDK 和工具
JavaScript/Node.js SDK
npm install @ai-accelerator/sdk
import { AIAcceleratorClient } from '@ai-accelerator/sdk';
const client = new AIAcceleratorClient({
apiKey: process.env.AI_ACCELERATOR_API_KEY
});
Python SDK
pip install ai-accelerator-sdk
from ai_accelerator import Client
client = Client(api_key=os.getenv('AI_ACCELERATOR_API_KEY'))
CLI 工具
npm install -g @ai-accelerator/cli
# 配置 API 密钥
ai-accelerator config set-key your-api-key
# 代码补全
ai-accelerator complete --file main.js --line 10
# 代码分析
ai-accelerator analyze --file main.js
IDE 集成
Visual Studio Code
- 在 VS Code 扩展市场搜索 "AI Accelerator"
- 安装扩展
- 在设置中配置您的 API 密钥
- 重启 VS Code 开始使用
IntelliJ IDEA
- 打开 Settings > Plugins
- 搜索 "AI Accelerator" 插件
- 安装并重启 IDE
- 在 Settings > Tools > AI Accelerator 中配置 API 密钥
错误处理
常见错误码
错误码 | 描述 | 解决方案 |
---|---|---|
401 | 未授权 | 检查 API 密钥是否正确 |
429 | 请求过于频繁 | 降低请求频率或升级套餐 |
500 | 服务器错误 | 稍后重试或联系技术支持 |
错误响应格式
{
"error": {
"code": "invalid_api_key",
"message": "The provided API key is invalid",
"type": "authentication_error"
}
}
最佳实践
1. API 密钥安全
- 不要在客户端代码中硬编码 API 密钥
- 使用环境变量存储密钥
- 定期轮换 API 密钥
- 为不同环境使用不同的密钥
2. 请求优化
- 合理设置
maxTokens
参数 - 使用适当的
temperature
值 - 实现请求重试机制
- 缓存常用结果
3. 错误处理
try {
const response = await client.augment.complete({
code: userCode,
language: 'javascript'
});
return response.completion;
} catch (error) {
if (error.status === 429) {
// 处理速率限制
await delay(1000);
return retry();
} else if (error.status === 500) {
// 处理服务器错误
console.error('Service temporarily unavailable');
return null;
}
throw error;
}
支持和反馈
技术支持
- 邮箱: [email protected]
- 在线文档: docs.ai-accelerator.com
- 社区论坛: community.ai-accelerator.com
反馈渠道
- 功能请求: GitHub Issues
- Bug 报告: [email protected]
- 产品建议: [email protected]
更多详细信息请访问我们的 完整 API 文档