ff
This commit is contained in:
7
content/_meta.js
Normal file
7
content/_meta.js
Normal file
@@ -0,0 +1,7 @@
|
||||
export default {
|
||||
index: "文档中心",
|
||||
"getting-started": "快速开始",
|
||||
models: "AI 模型接入",
|
||||
guides: "使用指南",
|
||||
faq: "常见问题",
|
||||
};
|
||||
32
content/faq.mdx
Normal file
32
content/faq.mdx
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: 常见问题
|
||||
description: 接入与使用中的常见问题解答
|
||||
---
|
||||
|
||||
# 常见问题
|
||||
|
||||
## 返回 401 Unauthorized
|
||||
|
||||
- 检查 `Authorization: Bearer` 后是否有多余空格
|
||||
- 确认 Key 未被禁用、未过期
|
||||
- 确认请求发往正确的 Base URL
|
||||
|
||||
## 返回 429 Too Many Requests
|
||||
|
||||
表示触发 **限流**。请降低并发、实现指数退避重试,或联系商务提升配额。
|
||||
|
||||
## 模型不存在 / model_not_found
|
||||
|
||||
模型 ID 拼写错误或账号未开通该模型。请在 **模型广场** 复制准确 ID。
|
||||
|
||||
## 如何对账?
|
||||
|
||||
控制台 **账单** 模块可按日查看调用量与费用;企业客户可申请导出明细与发票。
|
||||
|
||||
## 是否支持私有化部署?
|
||||
|
||||
企业方案支持专有云与私有化,请通过官网 [联系我们](/#contact) 获取方案与 POC 安排。
|
||||
|
||||
## 文档有错误怎么办?
|
||||
|
||||
文档随产品迭代更新;若发现过时信息,请通过控制台反馈或邮件联系技术支持。
|
||||
44
content/getting-started.mdx
Normal file
44
content/getting-started.mdx
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: 快速开始
|
||||
description: 五分钟完成 API Key 创建与首次调用
|
||||
---
|
||||
|
||||
# 快速开始
|
||||
|
||||
按以下步骤即可在海宇数科平台完成首次模型调用。
|
||||
|
||||
## 1. 注册并登录控制台
|
||||
|
||||
访问 [控制台](https://console.haiyushuke.com),使用企业邮箱或手机号完成注册。首次登录建议完成实名/企业认证(若你方环境要求)。
|
||||
|
||||
## 2. 创建 API Key
|
||||
|
||||
1. 进入 **设置 → API Key**
|
||||
2. 点击 **创建密钥**,填写名称(如 `prod-backend`)
|
||||
3. 复制密钥并妥善保存(仅展示一次)
|
||||
|
||||
## 3. 选择模型与端点
|
||||
|
||||
在 **模型广场** 或 **接入文档** 中确认:
|
||||
|
||||
- 模型 ID(如 `gpt-4o-mini`、`deepseek-chat`)
|
||||
- 兼容协议(一般为 OpenAI Chat Completions)
|
||||
|
||||
## 4. 发起测试请求
|
||||
|
||||
```bash
|
||||
curl https://api.haiyushuke.com/v1/chat/completions \
|
||||
-H "Authorization: Bearer YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"model": "gpt-4o-mini",
|
||||
"messages": [{"role": "user", "content": "你好,请用一句话介绍海宇数科"}]
|
||||
}'
|
||||
```
|
||||
|
||||
成功时响应 JSON 中包含 `choices[0].message.content`。
|
||||
|
||||
## 下一步
|
||||
|
||||
- 按厂商阅读 [OpenAI 接入](/docs/models/openai)、[Claude 接入](/docs/models/claude)
|
||||
- 了解 [流式调用](/docs/guides/streaming) 与 [API Key 管理](/docs/guides/api_keys)
|
||||
5
content/guides/_meta.js
Normal file
5
content/guides/_meta.js
Normal file
@@ -0,0 +1,5 @@
|
||||
export default {
|
||||
console: "???",
|
||||
api_keys: "API Key",
|
||||
streaming: "????",
|
||||
};
|
||||
26
content/guides/api_keys.mdx
Normal file
26
content/guides/api_keys.mdx
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: API Key 管理
|
||||
sidebarTitle: API Key
|
||||
description: 创建、轮换与权限最佳实践
|
||||
---
|
||||
|
||||
# API Key 管理
|
||||
|
||||
## 创建
|
||||
|
||||
控制台 → **设置 → API Key** → **创建**。建议命名包含环境与用途,例如 `prod-report-agent`。
|
||||
|
||||
## 存储
|
||||
|
||||
- 使用环境变量:`HAIYUSHUKE_API_KEY`
|
||||
- 密钥管理系统(KMS / Vault)中保存,勿提交至 Git
|
||||
|
||||
## 轮换流程
|
||||
|
||||
1. 创建新 Key
|
||||
2. 在应用配置中灰度切换
|
||||
3. 确认流量稳定后禁用旧 Key
|
||||
|
||||
## 泄露应急
|
||||
|
||||
若 Key 已泄露:立即 **禁用** 该 Key → 新建 → 排查仓库与 CI 日志是否残留。
|
||||
30
content/guides/console.mdx
Normal file
30
content/guides/console.mdx
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
title: 控制台使用
|
||||
sidebarTitle: 控制台
|
||||
description: 控制台主要功能与导航说明
|
||||
---
|
||||
|
||||
# 控制台使用指南
|
||||
|
||||
控制台地址:[https://console.haiyushuke.com](https://console.haiyushuke.com)
|
||||
|
||||
## 主要模块
|
||||
|
||||
1. **概览**:用量、余额与近期调用趋势
|
||||
2. **模型广场**:浏览可用模型、定价与能力说明
|
||||
3. **API Key**:创建、轮换、禁用密钥
|
||||
4. **调用日志**(若已开通):按时间筛选请求与错误
|
||||
5. **账单**:充值、发票与明细导出
|
||||
|
||||
## 推荐工作流
|
||||
|
||||
1. 创建 API Key
|
||||
2. 在模型广场选择目标模型
|
||||
3. 使用 SDK 或 cURL 完成联调
|
||||
4. 在概览与调用日志中核对用量
|
||||
|
||||
## 权限与安全
|
||||
|
||||
- 为不同环境(开发 / 预发 / 生产)使用不同 Key
|
||||
- 定期轮换 Key;泄露后立即 **禁用** 并新建
|
||||
- 生产环境勿将 Key 写入前端 bundle
|
||||
38
content/guides/streaming.mdx
Normal file
38
content/guides/streaming.mdx
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
title: 流式调用
|
||||
sidebarTitle: 流式调用
|
||||
description: SSE 流式输出接入说明
|
||||
---
|
||||
|
||||
# 流式调用
|
||||
|
||||
在请求体中设置 `"stream": true`,服务端以 SSE 形式返回增量内容。
|
||||
|
||||
## cURL
|
||||
|
||||
```bash
|
||||
curl https://api.haiyushuke.com/v1/chat/completions \
|
||||
-H "Authorization: Bearer YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"model":"gpt-4o-mini","stream":true,"messages":[{"role":"user","content":"写一首四句诗"}]}'
|
||||
```
|
||||
|
||||
## OpenAI SDK(Node)
|
||||
|
||||
```ts
|
||||
const stream = await client.chat.completions.create({
|
||||
model: "gpt-4o-mini",
|
||||
stream: true,
|
||||
messages: [{ role: "user", content: "你好" }],
|
||||
});
|
||||
|
||||
for await (const chunk of stream) {
|
||||
const text = chunk.choices[0]?.delta?.content;
|
||||
if (text) process.stdout.write(text);
|
||||
}
|
||||
```
|
||||
|
||||
## 注意
|
||||
|
||||
- 客户端需正确处理连接中断与超时重试
|
||||
- 流式场景下计费通常按 **输出 token** 累计,以账单规则为准
|
||||
1126
content/index.mdx
Normal file
1126
content/index.mdx
Normal file
File diff suppressed because it is too large
Load Diff
5
content/models/_meta.js
Normal file
5
content/models/_meta.js
Normal file
@@ -0,0 +1,5 @@
|
||||
export default {
|
||||
openai: "OpenAI",
|
||||
claude: "Claude (Anthropic)",
|
||||
deepseek: "DeepSeek",
|
||||
};
|
||||
42
content/models/claude.mdx
Normal file
42
content/models/claude.mdx
Normal file
@@ -0,0 +1,42 @@
|
||||
---
|
||||
title: Claude 接入
|
||||
sidebarTitle: Claude
|
||||
description: Anthropic Claude 系列模型接入说明
|
||||
---
|
||||
|
||||
# Claude (Anthropic) 接入
|
||||
|
||||
Claude 模型可通过 **OpenAI 兼容接口** 或 **Anthropic Messages API** 接入(以控制台开通能力为准)。
|
||||
|
||||
## OpenAI 兼容方式(推荐迁移)
|
||||
|
||||
```bash
|
||||
curl https://api.haiyushuke.com/v1/chat/completions \
|
||||
-H "Authorization: Bearer YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"model": "claude-sonnet-4-20250514",
|
||||
"messages": [{"role": "user", "content": "总结以下三点:安全、成本、延迟"}]
|
||||
}'
|
||||
```
|
||||
|
||||
将 `model` 替换为控制台提供的 Claude 模型 ID。
|
||||
|
||||
## 系统提示与多轮对话
|
||||
|
||||
与 OpenAI 相同,使用 `messages` 数组:
|
||||
|
||||
```json
|
||||
{
|
||||
"model": "claude-sonnet-4-20250514",
|
||||
"messages": [
|
||||
{ "role": "system", "content": "你是企业知识库助手,回答需简洁。" },
|
||||
{ "role": "user", "content": "什么是 RAG?" }
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## 注意事项
|
||||
|
||||
- 部分 Claude 特性(如扩展思考、工具调用)需使用对应 API 形态,请参考控制台该模型的「能力标签」。
|
||||
- 长上下文模型请留意单次请求的 `max_tokens` 与账单中的输入 token 统计。
|
||||
32
content/models/deepseek.mdx
Normal file
32
content/models/deepseek.mdx
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: DeepSeek 接入
|
||||
sidebarTitle: DeepSeek
|
||||
description: DeepSeek 系列模型接入说明
|
||||
---
|
||||
|
||||
# DeepSeek 接入
|
||||
|
||||
DeepSeek 模型通过统一网关暴露,协议为 **OpenAI Chat Completions 兼容**。
|
||||
|
||||
## 示例
|
||||
|
||||
```bash
|
||||
curl https://api.haiyushuke.com/v1/chat/completions \
|
||||
-H "Authorization: Bearer YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"model": "deepseek-chat",
|
||||
"messages": [{"role": "user", "content": "用列表说明大模型网关的三项优势"}]
|
||||
}'
|
||||
```
|
||||
|
||||
## 模型选择建议
|
||||
|
||||
| 场景 | 建议 |
|
||||
| --- | --- |
|
||||
| 通用对话 / 代码 | `deepseek-chat` |
|
||||
| 复杂推理(若已开通) | 控制台标注的 Reasoner 类模型 ID |
|
||||
|
||||
## 与 OpenAI SDK 共用配置
|
||||
|
||||
仅需修改 `model` 字段,无需更换 SDK;`baseURL` 与 API Key 与 [OpenAI 接入](/docs/models/openai) 相同。
|
||||
62
content/models/openai.mdx
Normal file
62
content/models/openai.mdx
Normal file
@@ -0,0 +1,62 @@
|
||||
---
|
||||
title: OpenAI 接入
|
||||
sidebarTitle: OpenAI
|
||||
description: 通过 OpenAI 兼容协议接入 GPT 系列模型
|
||||
---
|
||||
|
||||
# OpenAI 兼容接入
|
||||
|
||||
海宇数科对 OpenAI 官方 SDK 及 HTTP API 提供兼容层,便于现有应用零改造迁移。
|
||||
|
||||
## 端点
|
||||
|
||||
| 项目 | 值 |
|
||||
| --- | --- |
|
||||
| Base URL | `https://api.haiyushuke.com/v1` |
|
||||
| Chat Completions | `POST /chat/completions` |
|
||||
| 鉴权 | `Authorization: Bearer <API_KEY>` |
|
||||
|
||||
## Node.js(官方 SDK)
|
||||
|
||||
```ts
|
||||
import OpenAI from "openai";
|
||||
|
||||
const client = new OpenAI({
|
||||
apiKey: process.env.HAIYUSHUKE_API_KEY,
|
||||
baseURL: "https://api.haiyushuke.com/v1",
|
||||
});
|
||||
|
||||
const completion = await client.chat.completions.create({
|
||||
model: "gpt-4o-mini",
|
||||
messages: [{ role: "user", content: "Hello" }],
|
||||
});
|
||||
|
||||
console.log(completion.choices[0]?.message?.content);
|
||||
```
|
||||
|
||||
## Python
|
||||
|
||||
```python
|
||||
from openai import OpenAI
|
||||
|
||||
client = OpenAI(
|
||||
api_key="YOUR_API_KEY",
|
||||
base_url="https://api.haiyushuke.com/v1",
|
||||
)
|
||||
|
||||
resp = client.chat.completions.create(
|
||||
model="gpt-4o-mini",
|
||||
messages=[{"role": "user", "content": "Hello"}],
|
||||
)
|
||||
print(resp.choices[0].message.content)
|
||||
```
|
||||
|
||||
## 常用参数
|
||||
|
||||
- `temperature`:0–2,控制随机性
|
||||
- `max_tokens`:最大生成 token
|
||||
- `stream: true`:开启流式,见 [流式调用](/docs/guides/streaming)
|
||||
|
||||
## 模型 ID
|
||||
|
||||
请在控制台 **模型广场** 查看当前可用 ID;名称可能随供应商更新,以控制台为准。
|
||||
Reference in New Issue
Block a user