f
This commit is contained in:
7
content/integrations/_meta.js
Normal file
7
content/integrations/_meta.js
Normal file
@@ -0,0 +1,7 @@
|
||||
export default {
|
||||
overview: "接入概览",
|
||||
cursor: "Cursor",
|
||||
claude_code: "Claude Code",
|
||||
continue: "Continue",
|
||||
cline: "Cline",
|
||||
};
|
||||
56
content/integrations/claude_code.mdx
Normal file
56
content/integrations/claude_code.mdx
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
title: Claude Code 接入
|
||||
sidebarTitle: Claude Code
|
||||
description: 在 Claude Code CLI 中对接自定义 API(OpenAI 兼容)
|
||||
---
|
||||
|
||||
# Claude Code 接入
|
||||
|
||||
**Claude Code** 是面向终端的 AI 编程助手。不同版本对「自定义后端」的支持方式可能不同;海宇数科网关当前对外主要提供 **OpenAI Chat Completions 兼容** 接口(`https://api.haiyushuke.com/v1`),**不提供** Anthropic 海外 Claude 原厂模型。
|
||||
|
||||
若你的 Claude Code 版本支持 **OpenAI 兼容 Base URL** 或可在配置中指定 OpenAI 风格端点,可按下列方式接入;若仅支持 Anthropic 原生 API,则需改用 [Cursor](/docs/integrations/cursor)、[Continue](/docs/integrations/continue) 等工具,或通过业务后端自行调用 [HTTP API](/docs/guides/http_api)。
|
||||
|
||||
## 前置条件
|
||||
|
||||
- 控制台已 **实名认证**,已创建 **API Key**
|
||||
- 已在 **模型广场** 选定国内模型 ID(勿填海外 `claude-*` 名称)
|
||||
|
||||
## 配置思路(OpenAI 兼容)
|
||||
|
||||
在 Claude Code 的环境变量或配置文件中(以官方文档为准),尝试设置与海宇网关等价的 OpenAI 兼容项,例如:
|
||||
|
||||
```bash
|
||||
# 示例:名称以 Claude Code 当前版本文档为准
|
||||
export OPENAI_API_KEY="YOUR_HAIYUSHUKE_API_KEY"
|
||||
export OPENAI_BASE_URL="https://api.haiyushuke.com/v1"
|
||||
```
|
||||
|
||||
将 **模型名** 设为控制台模型 ID,例如:
|
||||
|
||||
```bash
|
||||
# 示例模型 ID,请替换为模型广场实际值
|
||||
export ANTHROPIC_MODEL="deepseek-chat"
|
||||
```
|
||||
|
||||
> 部分 CLI 仍使用 `ANTHROPIC_*` 前缀命名环境变量,但后端实际走的是您配置的 Base URL;请以 Claude Code 官方说明为准,并确认其请求是否落在 `/v1/chat/completions` 兼容路径上。
|
||||
|
||||
## 验证
|
||||
|
||||
1. 在控制台 **体验中心** 用同一模型 ID 发送一条消息
|
||||
2. 在 Claude Code 中发起简单任务(如解释一个本地文件)
|
||||
3. 在 **财务 → 使用记录** 查看是否产生对应调用
|
||||
|
||||
## 故障排查
|
||||
|
||||
| 现象 | 建议 |
|
||||
| --- | --- |
|
||||
| 401 | 检查 API Key、是否误用登录 token |
|
||||
| 403 | Key 未授权该模型 ID,或 IP 白名单限制 |
|
||||
| 402 | 余额不足,前往充值 |
|
||||
| 协议不匹配 | 换用 Cursor / Continue,或直接用 HTTP/SDK 集成 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [工具接入概览](/docs/integrations/overview)
|
||||
- [Cursor 接入](/docs/integrations/cursor)
|
||||
- [常见问题](/docs/faq)
|
||||
33
content/integrations/cline.mdx
Normal file
33
content/integrations/cline.mdx
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
title: Cline 接入
|
||||
sidebarTitle: Cline
|
||||
description: 在 VS Code 的 Cline 扩展中使用海宇 OpenAI 兼容 API
|
||||
---
|
||||
|
||||
# Cline 接入
|
||||
|
||||
[Cline](https://github.com/cline/cline)(原 Claude Dev)是 VS Code 中的自主编程扩展,支持通过 **OpenAI 兼容 API** 使用自定义模型。
|
||||
|
||||
## 前置条件
|
||||
|
||||
- 控制台创建 **API Key**,并确认可用模型包含目标 ID
|
||||
|
||||
## 配置步骤
|
||||
|
||||
1. 打开 VS Code → Cline 侧边栏 → **Settings**(设置)
|
||||
2. 选择 API Provider 为 **OpenAI Compatible** / **OpenAI**(以扩展当前版本为准)
|
||||
3. 填写:
|
||||
- **Base URL**:`https://api.haiyushuke.com/v1`
|
||||
- **API Key**:海宇 API Key
|
||||
- **Model ID**:模型广场中的 ID(如 `glm-5.1`、`deepseek-chat` 等)
|
||||
4. 保存并新建任务测试
|
||||
|
||||
## 注意
|
||||
|
||||
- 扩展界面若默认展示海外模型名称,请 **手动改为** 控制台国内模型 ID。
|
||||
- 复杂 Agent 任务消耗 token 较多,请关注 [计费与财务](/docs/guides/billing) 与余额告警。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Cursor 接入](/docs/integrations/cursor)
|
||||
- [工具接入概览](/docs/integrations/overview)
|
||||
39
content/integrations/continue.mdx
Normal file
39
content/integrations/continue.mdx
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Continue 接入
|
||||
sidebarTitle: Continue
|
||||
description: 在 VS Code / JetBrains 的 Continue 插件中使用海宇 API
|
||||
---
|
||||
|
||||
# Continue 接入
|
||||
|
||||
[Continue](https://continue.dev) 是 VS Code、JetBrains 等 IDE 中的开源 AI 编程插件,支持配置 **OpenAI 兼容** 模型提供商。
|
||||
|
||||
## 前置条件
|
||||
|
||||
- 海宇控制台 **API Key** 与国内模型 ID(见 [模型广场](https://console.haiyushuke.com/models))
|
||||
|
||||
## 配置示例
|
||||
|
||||
在 Continue 配置文件 `config.yaml`(或旧版 `config.json`)中增加自定义 OpenAI 兼容提供商,例如:
|
||||
|
||||
```yaml
|
||||
models:
|
||||
- name: Haiyu DeepSeek
|
||||
provider: openai
|
||||
model: deepseek-chat
|
||||
apiKey: YOUR_HAIYUSHUKE_API_KEY
|
||||
apiBase: https://api.haiyushuke.com/v1
|
||||
```
|
||||
|
||||
请将 `model` 替换为你在模型广场复制的 **准确 ID**;可配置多个条目对应不同模型。
|
||||
|
||||
## 注意
|
||||
|
||||
- `apiBase` 需包含 `/v1` 前缀,与海宇网关一致。
|
||||
- 不要使用未在海宇上线的海外模型 ID。
|
||||
- Key 勿写入公开仓库;本地 config 建议加入 `.gitignore`。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [工具接入概览](/docs/integrations/overview)
|
||||
- [OpenAI 兼容 SDK](/docs/guides/openai_compatible)
|
||||
50
content/integrations/cursor.mdx
Normal file
50
content/integrations/cursor.mdx
Normal file
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Cursor 接入
|
||||
sidebarTitle: Cursor
|
||||
description: 在 Cursor 中配置海宇数科 API 与国内模型
|
||||
---
|
||||
|
||||
# Cursor 接入
|
||||
|
||||
[Cursor](https://cursor.com) 支持使用 **OpenAI 兼容** 自定义接口。将 Base URL 指向海宇数科网关后,可在 Cursor 中选择控制台已上线的 **国内模型 ID** 进行补全与对话。
|
||||
|
||||
## 前置条件
|
||||
|
||||
1. 登录 [控制台](https://console.haiyushuke.com),完成 **实名认证**
|
||||
2. 在 **API Key** 创建密钥,并确认 Key 的 **可用模型** 包含你要用的模型 ID
|
||||
3. 在 **模型广场** 复制目标模型 ID(例如 `deepseek-chat`、`glm-5.1` 等,以实际列表为准)
|
||||
|
||||
## 配置步骤
|
||||
|
||||
1. 打开 Cursor → **Settings**(设置)
|
||||
2. 进入 **Models** 或 **OpenAI API** 相关区域(版本不同菜单名可能略有差异)
|
||||
3. 填写:
|
||||
- **OpenAI API Key**:海宇控制台创建的 API Key
|
||||
- **Override OpenAI Base URL**(或 Custom OpenAI Endpoint):`https://api.haiyushuke.com/v1`
|
||||
4. 在模型列表中添加 **自定义模型名**,名称必须与模型广场 **模型 ID 完全一致**
|
||||
5. 保存后在新对话中选择该模型进行测试
|
||||
|
||||
## 示例(settings.json 片段)
|
||||
|
||||
若你通过 `settings.json` 管理配置,可参考(键名以 Cursor 当前版本为准):
|
||||
|
||||
```json
|
||||
{
|
||||
"openai.apiKey": "YOUR_HAIYUSHUKE_API_KEY",
|
||||
"openai.baseUrl": "https://api.haiyushuke.com/v1"
|
||||
}
|
||||
```
|
||||
|
||||
自定义模型请在 Cursor 的 Models 界面添加,ID 使用控制台复制的字符串。
|
||||
|
||||
## 使用建议
|
||||
|
||||
- **不要** 使用 `gpt-4o`、`claude-sonnet` 等海外模型名;平台未提供这些模型。
|
||||
- 生产环境 Key 不要提交到 Git;可配合 Key 的 **IP 白名单**。
|
||||
- 若补全无响应,先在 **体验中心** 用同一模型 ID 验证,再查 [常见问题](/docs/faq)。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [工具接入概览](/docs/integrations/overview)
|
||||
- [API Key 管理](/docs/guides/api_keys)
|
||||
- [计费与财务](/docs/guides/billing)
|
||||
39
content/integrations/overview.mdx
Normal file
39
content/integrations/overview.mdx
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: 工具接入概览
|
||||
sidebarTitle: 接入概览
|
||||
description: 在 Cursor、Claude Code 等客户端中使用海宇数科 API
|
||||
---
|
||||
|
||||
# 工具接入概览
|
||||
|
||||
海宇数科提供 **OpenAI 兼容** 的 `https://api.haiyushuke.com/v1` 网关。多数支持「自定义 OpenAI Base URL + API Key」的 IDE / 编程助手,均可指向海宇,并在请求中使用控制台 **模型广场** 里的 **国内模型 ID**(如 DeepSeek、智谱 GLM、通义、Kimi、MiniMax 等)。
|
||||
|
||||
> 当前平台 **不提供** OpenAI GPT、Anthropic Claude 等海外原厂模型;请勿在文档或客户端中填写 `gpt-*`、`claude-*` 等海外 ID,一律以 [控制台模型广场](https://console.haiyushuke.com/models) 为准。
|
||||
|
||||
## 接入三要素
|
||||
|
||||
| 项 | 值 |
|
||||
| --- | --- |
|
||||
| API Base URL | `https://api.haiyushuke.com/v1` |
|
||||
| API Key | 控制台 **API Key** 中创建(非登录密码) |
|
||||
| Model | 模型广场复制的 **模型 ID** |
|
||||
|
||||
创建 Key、实名认证与充值说明见 [快速开始](/docs/getting-started)、[API Key 管理](/docs/guides/api_keys)。
|
||||
|
||||
## 按工具查看
|
||||
|
||||
| 工具 | 文档 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| Cursor | [Cursor 接入](/docs/integrations/cursor) | 覆盖 OpenAI Base URL,适合日常编码 |
|
||||
| Claude Code | [Claude Code 接入](/docs/integrations/claude_code) | CLI 助手,需确认客户端协议与网关兼容 |
|
||||
| Continue | [Continue 接入](/docs/integrations/continue) | VS Code / JetBrains 插件 |
|
||||
| Cline | [Cline 接入](/docs/integrations/cline) | VS Code 自主编程扩展 |
|
||||
|
||||
## 通用 HTTP / SDK
|
||||
|
||||
不通过 IDE 而由业务服务调用时,请阅 [HTTP API](/docs/guides/http_api)、[OpenAI 兼容 SDK](/docs/guides/openai_compatible)。
|
||||
|
||||
## 常见问题
|
||||
|
||||
- Key 无效、402 余额不足、403 模型未授权:见 [常见问题](/docs/faq)
|
||||
- Token 与上下文:见 [核心概念](/docs/concepts/overview)
|
||||
Reference in New Issue
Block a user