# PPIO Docs > This file is very large and may be truncated. For an index of this content, please refer to https://ppio.com/docs/llms.txt instead. > PPIO 派欧云开发者文档:模型 API、Agent 沙箱和 GPU 容器的接入、调用与计费说明。 # PPIO 平台文档与集成参考 Skill Source: https://ppio.com/docs/ai/docs-skill 了解 PPIO 平台文档与集成参考 Skill 的覆盖内容和使用方式,查阅模型 API、GPU 算力、Agent 沙箱及第三方工具集成相关知识,辅助开发与问题排查。 `ppio-docs` 是一个为 AI Agent 量身打造的 PPIO 平台文档知识技能。它覆盖 LLM API、Agent 沙箱、GPU 实例与无服务器 GPU、第三方集成、鉴权、定价、限流与故障排查,让 Claude Code、Gemini CLI 等 Agent 直接具备 PPIO 平台文档的完整上下文知识,无需反复查文档。 *** ## 安装 运行以下命令安装: ```bash theme={null} npx skills add PPIO/ppio-skills --skill ppio-docs ``` ## 功能介绍 `ppio-docs` 是一个 **Tool Wrapper 模式**的 Skill,核心职责是在用户提问时,自动定位并加载最相关的参考文档,根据文档回答用户提问,同时确保动态数据(定价、模型列表)始终取自最新来源。 ### 覆盖范围 | 方向 | 内容 | | - | - | | **LLM API** | 聊天补全、工具调用(Function Calling)、视觉输入、JSON 模式、批量任务 | | **Agent 沙箱** | SDK/CLI 使用、沙箱生命周期、模板管理、文件操作 | | **GPU 容器** | 实例型 vs 无服务器 GPU 选型、定价对比、硬件可用性 | | **第三方集成** | OpenAI 兼容客户端、主流框架(LangChain、LlamaIndex 等)、可观测性工具 | | **故障排查** | 常见错误码、鉴权失败、限流、超时、模型不可用等 | ### 工作方式 1. Agent 识别问题属于哪个产品方向 2. 从文档映射表中选取**最少**所需的参考文件,通过 WebFetch 即时拉取 3. 对模型目录、定价、限流等动态数据,自动访问实时来源并在响应中标注验证时间 4. 优先返回**可直接复制粘贴**的命令或代码片段 ### 动态数据策略 模型数量、定价、延迟等信息随时可能变动。`ppio-docs` 要求 Agent 在回答此类问题前先获取最新值,并以 `Verified on: YYYY-MM-DD` 格式注明,避免给出过期信息。 *** ## 实用案例 ### 案例一:快速接入 LLM API > **用户:** PPIO 的 LLM API 怎么用?给我一个 Python 示例。 Agent 触发 `ppio-docs`,加载 `llm-guide.md`,返回: ```python theme={null} from openai import OpenAI client = OpenAI( api_key="your-ppio-api-key", base_url="https://api.ppio.com/openai" ) response = client.chat.completions.create( model="deepseek/deepseek-v4.1-flash", messages=[{"role": "user", "content": "你好!"}] ) print(response.choices[0].message.content) ``` *** ### 案例二:选择 GPU 方案 > **用户:** 我要跑一个长期推理任务,用 GPU 实例还是无服务器 GPU? Agent 加载 `gpu-guide.md`,结合定价页最新数据,给出选型建议: * **GPU 实例**:适合长时间运行、需要稳定资源预留的任务,按小时计费 * **无服务器 GPU**:适合短时、突发任务,按实际使用时长计费,无空闲费用 * 如果任务跑满 4 小时以上,实例型通常更经济 *** ### 案例三:集成 LangChain > **用户:** 怎么在 LangChain 里用 PPIO? Agent 加载 `integrations.md` → 进一步拉取 `integrations-frameworks.md`,返回: ```python theme={null} from langchain_openai import ChatOpenAI llm = ChatOpenAI( model="deepseek/deepseek-v4.1-flash", openai_api_key="your-ppio-api-key", openai_api_base="https://api.ppio.com/openai" ) result = llm.invoke("用三句话解释量子纠缠") print(result.content) ``` *** ### 案例四:排查 401 鉴权失败 > **用户:** 我的请求一直返回 401,怎么回事? Agent 加载 `faq-and-issues.md`,快速定位: 常见原因: 1. `Authorization` Header 格式错误,应为 `Bearer `(注意空格) 2. API Key 已过期或被吊销,前往 [https://ppio.com/settings/key-management](https://ppio.com/settings/key-management) 重新生成 3. 账户余额不足导致 Key 被暂停 *** ### 案例五:查询当前可用模型 > **用户:** PPIO 现在有哪些模型可以用?**(动态数据)** Agent 实时调用: ```bash theme={null} curl https://api.ppio.com/openai/v1/models \ -H "Authorization: Bearer $PPIO_API_KEY" ``` 返回最新模型列表,并注明 `Verified on: 2026-04-03`,确保信息不过期。 *** ## 相关链接 * [PPIO 控制台](https://ppio.com/console) * [API Key 管理](https://ppio.com/settings/key-management) * [模型目录](https://ppio.com/ai-computing/llm-api) * [定价](https://ppio.com/pricing) * [Github 仓库](https://github.com/PPIO/ppio-skills) # PPIO MCP Server Source: https://ppio.com/docs/ai/mcp-server 了解 PPIO MCP Server 的定位与接入方式,通过 Model Context Protocol 将平台服务连接到 AI 工具,查阅资源操作与集成使用说明。 PPIO MCP Server 通过 Model Context Protocol 将 PPIO 平台 OpenAPI 暴露给 AI Agent 工具,让 Claude、Cursor 等 AI Agent 能够直接查询和操作你的 PPIO 资源。目前可查询和操作 GPU 实例、存储、镜像、账单等资源。 服务采用 OAuth 2.1 认证,托管端点: ``` https://mcp.ppio.com/mcp ``` 首次连接时会自动打开 PPIO OAuth 授权页面,使用您的 PPIO 账号登录即可。授权完成后,Agent 发起的所有 API 调用均使用您本人的身份,只能访问您账号下的数据。授权后您可以尝试给 Agent 发送这样的信息测试效果。比如: > "列出我在 PPIO 所有运行中的 GPU 实例" 常见 Agent 的安装方法如下: *** ## Claude Code ```bash theme={null} claude mcp add --transport http ppio https://mcp.ppio.com/mcp ``` 添加后在 Claude Code 中运行 `/mcp`,选择 `ppio`, 选择 `Authenticate`,会打开授权页面,完成授权即可使用。 *** ## Claude Desktop 客户端 前往 Settings > Connectors > 点击顶部的「Go to Customize」> 点击标题「Connectors」右边的 ➕ > Add custom connector 填写: Name: PPIO, Remote MCP server URL: [https://mcp.ppio.com/mcp](https://mcp.ppio.com/mcp) 点击 Add,添加后下方 Not connected 下方会出现 PPIO,选择后点击右侧 Connect,在打开的授权页面中完成授权即可使用。 *** ## Cursor 打开 **Settings → Cursor Settings → Tools & MCP → New MCP Server**,添加: ```json theme={null} { "mcpServers": { "ppio": { "url": "https://mcp.ppio.com/mcp" } } } ``` 保存后回到 Tools & MCP 页,点击新增的 ppio 右侧的 Connect 按钮,完成授权即可使用。 *** ## VS Code 按 `Ctrl/Cmd + P`,搜索 **MCP: Add Server**,选择 **HTTP (HTTP or Server-Sent Events)**,输入: ``` https://mcp.ppio.com/mcp ``` 然后命名为 `ppio` 后确认。允许在浏览器打开授权页面,完成授权后即可使用。 *** ## Codex ```bash theme={null} codex mcp add ppio --url https://mcp.ppio.com/mcp codex mcp login ppio ``` 注意:首次在 Codex 中使用 MCP,需在 `~/.codex/config.toml` 中启用 `rmcp` 功能: ```toml theme={null} [features] experimental_use_rmcp_client = true ``` 或者可以直接在 `~/.codex/config.toml` 配置文件中完整添加: ```toml theme={null} [features] experimental_use_rmcp_client = true [mcp_servers.ppio] url = "https://mcp.ppio.com/mcp" ``` *** ## Zed 按 `Cmd + ,` 打开设置,添加: ```json theme={null} { "context_servers": { "ppio": { "url": "https://mcp.ppio.com/mcp" } } } ``` 添加后 Zed 会自动开始授权流程,完成后即可使用 *** ## 可用工具 连接成功后,AI 可使用两个工具: * **`search`** — 查询 PPIO OpenAPI 规范,发现可用接口 * **`execute`** — 调用 PPIO API,操作你账号下的资源 示例提问: * "我在 PPIO 有哪些运行中的 GPU 实例?" * "帮我在 PPIO 创建一个 RTX 4090 实例" * "列出我的所有镜像" *** # PPIO Skills Source: https://ppio.com/docs/ai/ppio-skills 查看 PPIO 官方 Skills 的分类和使用入口,了解平台文档参考与 Agent 沙箱相关技能,选择适合开发、集成和云端操作任务的工具。 PPIO 官方 Skills。包含以下技能: * ppio-docs:[PPIO 平台文档与集成参考技能](/docs/ai/docs-skill) * ppio-sandbox:[PPIO Agent 沙箱技能](/docs/ai/sandbox-skill) ## 安装技能 使用以下命令安装: ```bash theme={null} npx skills add PPIO/ppio-skills --skill {skill} ``` 安装完成后,如有需要请重启你的 Agent。 ## 相关链接 * [Github 仓库](https://github.com/PPIO/ppio-skills) # PPIO Agent 沙箱 Skill Source: https://ppio.com/docs/ai/sandbox-skill 了解 PPIO Agent 沙箱 Skill 的功能定位与使用方式,查阅沙箱平台操作相关说明,为通过 AI Agent 使用云端执行环境提供参考。 使用 AI Agent 直接操作 PPIO Agent 沙箱平台 — 构建模板、管理沙箱、部署 Agent,无需离开你的对话界面。 *** ## 安装 向任意支持 Skill 的 AI Agent 发送以下消息,Agent 会自动完成安装: ``` Read https://raw.githubusercontent.com/PPIO/ppio-skills/main/skills/ppio-sandbox/SKILL.md and follow the instructions to install ``` 支持的平台:Claude Code、Gemini CLI、OpenClaw 及其他兼容 SKILL.md 标准的 Agent。 ## 功能介绍 ppio-sandbox Skill 封装了 `ppio-sandbox-cli`,让 Agent 能够以自然语言驱动 PPIO Sandbox 平台的全部操作。该 Skill 包含所有 Beta 版 `ppio-sandbox-cli` 的功能。 ### 模板管理 从 Dockerfile 构建可复用的沙箱模板。模板是创建沙箱的基础。 * 从 Dockerfile 构建模板 * 查看、发布、删除模板 * 版本管理与回滚 ### 沙箱管理 按需启动隔离的沙箱环境,执行任务后销毁。 * 创建、列出、连接沙箱 * 查看实时日志与资源指标 * 上传、下载文件 * 执行命令或代码 * 克隆沙箱(并行创建多个副本) * 提交沙箱状态为快照模板 ### Agent Runtime 将 Python/其他语言的 Agent 打包部署到 PPIO Sandbox,通过 HTTP 调用。 * 配置 Agent 项目(自动生成 Dockerfile) * 一键构建并部署 * 流式调用已部署的 Agent ## 使用示例 ### 创建沙箱 > 用户:帮我从模板 base 创建一个沙箱 Agent 会自动执行: ```bash theme={null} ppio-sandbox-cli sandbox create base --detach # 输出:Sandbox xxx created from template base ``` ### 查看沙箱日志 > 用户:查看沙箱 abc123 的日志 Agent 执行: ```bash theme={null} ppio-sandbox-cli sandbox logs abc123 -f ``` ### 在沙箱中执行命令 > 用户:在沙箱 abc123 中执行 python run.py Agent 执行: ```bash theme={null} ppio-sandbox-cli sandbox connect abc123 # 连接后在沙箱终端中执行命令 ``` ### 克隆沙箱 > 用户:把沙箱 abc123 克隆 3 份 Agent 执行: ```bash theme={null} ppio-sandbox-cli sandbox clone abc123 --count 3 # 输出:3 个新沙箱 ID,状态均为 Running ``` ### 构建模板 > 用户:帮我用当前目录的 ppio.Dockerfile 构建一个叫 my-app 的模板 Agent 执行: ```bash theme={null} ppio-sandbox-cli template build -d ppio.Dockerfile -n my-app ``` ### 部署 Agent > 用户:把这个 Python agent 部署到 PPIO Sandbox Agent 执行: ```bash theme={null} # Agent 会依次执行: ppio-sandbox-cli agent configure -n my-agent -e app.py ppio-sandbox-cli agent launch ``` ## 触发词 以下关键词会触发此 Skill: * 创建沙箱、启动沙箱、列出沙箱 * 构建模板、模板构建、查看模板 * 部署 agent、调用 agent、发布 agent * 沙箱日志、沙箱指标、克隆沙箱 * ppio-sandbox-cli、ppio sandbox ## 前置要求 * Node.js 18+ * PPIO 账号(用于 `ppio-sandbox-cli auth login`) ## 相关链接 * [PPIO Agent 沙箱](/docs/sandbox/overview) * [PPIO Agent Runtime](/docs/sandbox/archive/agent-runtime-introduction) * [PPIO Skills GitHub](https://github.com/PPIO/ppio-skills) # 官方公告📢 Source: https://ppio.com/docs/announcement/announcement 查阅 PPIO 产品公告,了解模型服务与平台功能的调整通知、服务变更及相关安排,按照公告日期核对应用接入和运维计划。 ## 关于部分 LLM 模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分 LLM 模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `minimax/minimax-m2.7` | 2026-12-10 | `minimax/minimax-m3.1-flash` | | `minimax/minimax-m2.7-highspeed` | 2026-12-10 | `minimax/minimax-m3.1-flash` | | `minimax/minimax-m2.5` | 2026-12-10 | `minimax/minimax-m3.1-flash` | 请尽快停止使用上述模型,并将调用请求迁移至替换模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理相关事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-11-19 *** ## 关于部分 LLM 模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分 LLM 模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `deepseek/deepseek-v4-flash-vision-exp` | 2026-11-29 | `deepseek/deepseek-v4.1-flash` | | `tencent/hy4-preview` | 2026-12-06 | `tencent/hy4` | 请尽快停止使用上述模型,并将调用请求迁移至替换模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理相关事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-11-12 *** ## 关于部分 LLM 模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分 LLM 模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `deepseek/deepseek-ocr-2` | 2026-11-27 | — | | `zai-org/autoglm-phone-9b-multilingual` | 2026-11-27 | — | | `minimaxai/minimax-m1-80k` | 2026-11-27 | — | 请尽快停止使用上述模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理相关事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-11-05 *** ## 重要安全通知:定期轮换 API Key,并配置访问限制 尊敬的用户: 为保障您的账户与服务使用安全,降低 API Key 在存储、配置和使用过程中意外暴露或被盗用的风险,建议您定期检查密钥使用情况,并采取以下安全措施: * 妥善保管 API Key,避免将 API Key 直接写入启动命令、提交至代码仓库或输出至日志,也请勿在公开文档、截图等内容中展示完整密钥。 * 为不同环境和服务使用独立的 API Key,避免共用,便于单独轮换和停用。 * 为 API Key 配置「网络访问安全策略」,仅允许可信来源访问。具体操作请参阅 [API Key 网络访问](/docs/support/api-key-network-access)。 * 定期更换正在使用的 API Key,并及时删除不再使用的密钥。 您可按以下步骤完成日常轮换: 1. 前往控制台「[API 密钥管理](https://ppio.com/settings/key-management)」,创建新的 API Key。 2. 将相关应用和服务中的旧密钥替换为新密钥,并验证调用正常。 3. 确认所有使用旧密钥的应用和服务均已完成替换后,删除旧密钥。 **如怀疑 API Key 已泄露,请立即删除相关密钥,再创建并配置新密钥。删除密钥后,仍使用该密钥的应用和服务将无法正常调用,请同步更新相关配置。** 如需协助,请随时联系我们。感谢您的理解与配合。 **PPIO 派欧云** 发布时间:2026-11-03 *** ## 关于部分 LLM 模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分 LLM 模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `xiaomimimo/mimo-v2.5` | 2026-10-23 | `xiaomimimo/mimo-v2.6-flash` | | `xiaomimimo/mimo-v2.5-pro` | 2026-10-23 | `xiaomimimo/mimo-v2.6-pro` | 请尽快停止使用上述模型,并将调用请求迁移至替换模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理相关事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-10-22 *** ## 关于部分 LLM 模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分 LLM 模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `baidu/ernie-5.0-thinking-exp` | 2026-10-29 | `deepseek/deepseek-v4.1-flash` | | `baidu/ernie-5.0-thinking-preview` | 2026-10-29 | `deepseek/deepseek-v4.1-flash` | 请尽快停止使用上述模型,并将调用请求迁移至替换模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理相关事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-10-16 *** ## 关于部分 LLM 模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分 LLM 模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `deepseek/deepseek-v4-flash` | 2026-10-10 | `deepseek/deepseek-v4.1-flash` | 请尽快停止使用上述模型,并将调用请求迁移至替换模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理相关事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-09-28 *** ## 关于 PPIO GPUs 产品线访问认证安全策略调整的公告 尊敬的 PPIO 用户: 为保障平台与用户业务安全,PPIO 将对 GPUs 产品线(Serverless、GPU Instance)的对外访问链路进行安全策略升级。 自 **2026 年 10 月 15 日** 起,所有通过 PPIO 默认域名访问相关服务的请求,必须完成 API Key 认证或配置访问源 IP 白名单,不再支持无认证直接对外开放。 ### 一、调整内容 * **Serverless**:Endpoint 调用必须携带有效 API Key,未认证请求将返回 HTTP 401。 * **GPU Instance HTTP 端口映射**:通过 `*.gpu-instance.ppinfra.com` 访问实例 HTTP 服务时,必须携带有效 API Key。 * **GPU Instance TCP 端口映射**:SSH、数据库端口及其他 TCP 服务必须提交访问源 IP 白名单,不再支持全网开放。已开通 TCP 映射的用户,请在 **2026 年 10 月 15 日前** 完成白名单配置。 ### 二、如何适配 HTTP 请求使用标准 Bearer Token,并统一使用 PPIO API Key: ```bash theme={null} curl https://{endpoint}.runsync.serverless.ppinfra.com \ -H "Authorization: Bearer {api-key}" curl https://{instance}-{port}.{region}.gpu-instance.ppinfra.com \ -H "Authorization: Bearer {api-key}" ``` 调用方只需增加认证 Header,服务本身无需改造。 * 获取 / 管理 API Key:[前往密钥管理](https://ppio.com/settings/key-management) * API Key 使用文档:[查看使用文档](/docs/support/api-key) 使用 TCP 端口映射的用户,请通过工单或联系专属客户经理提交访问源 IP 白名单。 ### 三、过渡期 **2026 年 9 月 24 日至 2026 年 10 月 15 日** 为过渡期。过渡期内,现有访问方式仍可使用,请尽早完成适配,避免业务中断。 感谢您的理解与配合。 PPIO 派欧云\ 2026 年 9 月 24 日 *** ## 关于部分 LLM 模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分 LLM 模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `qwen/qwen3-vl-235b-a22b-instruct` | 2026-10-09 | `qwen/qwen3.8-max` | | `qwen/qwen3.5-plus` | 2026-10-09 | `qwen/qwen3.8-max` | | `qwen/qwen3.6-plus` | 2026-10-09 | `qwen/qwen3.8-max` | | `qwen/qwen3-embedding-0.6b` | 2026-10-09 | — | | `zai-org/glm-5-turbo` | 2026-10-09 | `zai-org/glm-5.3-flash` | | `minimax/minimax-m2.5-highspeed` | 2026-10-09 | `minimax/minimax-m3` | | `minimax/minimax-m2` | 2026-10-09 | `minimax/minimax-m3` | | `zai-org/glm-5v-turbo` | 2026-10-09 | `zai-org/glm-5.3-flash` | | `qwen/qwen3-coder-next` | 2026-10-09 | `qwen/qwen3.8-max` | | `qwen/qwen3-max` | 2026-10-09 | `qwen/qwen3.8-max` | | `baidu/ernie-4.5-vl-424b-a47b` | 2026-10-09 | — | | `qwen/qwen-2.5-72b-instruct` | 2026-10-09 | `qwen/qwen3.8-max` | | `qwen/qwen3-235b-a22b-thinking-2507` | 2026-10-09 | `qwen/qwen3.8-max` | | `minimax/minimax-m2.1` | 2026-10-09 | `minimax/minimax-m3` | | `qwen/qwen3-omni-30b-a3b-instruct` | 2026-10-09 | `qwen/qwen3.8-flash` | | `qwen/qwen3-235b-a22b-fp8` | 2026-10-09 | `qwen/qwen3.8-max` | | `qwen/qwen3-omni-30b-a3b-thinking` | 2026-10-09 | `qwen/qwen3.8-flash` | | `qwen/qwen3-vl-30b-a3b-instruct` | 2026-10-09 | `qwen/qwen3.8-max` | 请尽快将业务迁移至替换模型。对于没有替换模型的服务,请及时调整相关业务。停服后原 API 调用将返回错误代码。为避免业务中断,请立即联系专属客户经理或提交工单处理技术迁移事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-09-20 *** ## 关于部分 LLM 模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分 LLM 模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `deepseek/deepseek-v3.2` | 2026-09-29 | `deepseek/deepseek-v4.1-flash` | | `deepseek/deepseek-v3/community` | 2026-09-29 | `deepseek/deepseek-v4.1-flash` | | `deepseek/deepseek-v3-0324` | 2026-09-29 | `deepseek/deepseek-v4.1-flash` | | `deepseek/deepseek-v3.2-exp` | 2026-09-29 | `deepseek/deepseek-v4.1-flash` | | `deepseek/deepseek-v3` | 2026-09-29 | `deepseek/deepseek-v4.1-flash` | | `deepseek/deepseek-v3-turbo` | 2026-09-29 | `deepseek/deepseek-v4.1-flash` | | `deepseek/deepseek-r1-distill-llama-70b` | 2026-09-29 | — | 请尽快将业务迁移至替换模型。对于没有替换模型的服务,请及时调整相关业务。停服后原 API 调用将返回错误代码。为避免业务中断,请立即联系专属客户经理或提交工单处理技术迁移事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-09-20 *** ## 关于部分多模态模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分多模态模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | Qwen-Image 文生图 | 2026-09-30 | — | | Qwen-Image 图像编辑 | 2026-09-30 | — | | Wan 2.5 Preview 文生视频 | 2026-09-30 | Kling 3.0 | | Wan 2.5 Preview 图生视频 | 2026-09-30 | Kling 3.0 | | Wan 2.6 参考生视频 | 2026-09-30 | Kling 3.0 | | Wan 2.6 图生视频 | 2026-09-30 | Kling 3.0 | | Wan 2.6 文生视频 | 2026-09-30 | Kling 3.0 | | Minimax Hailuo 2.3 文生视频 | 2026-09-30 | Kling 3.0 | | Minimax Hailuo 2.3 图生视频 | 2026-09-30 | Kling 3.0 | | Minimax Hailuo 2.3 Fast 图生视频 | 2026-09-30 | Kling 3.0 | | 万相 Wan 2.7 视频编辑 | 2026-09-30 | Kling 3.0 | | 万相 Wan 2.7 参考生视频 | 2026-09-30 | Kling 3.0 | | 万相 Wan 2.7 文生视频 | 2026-09-30 | Kling 3.0 | | 万相 Wan 2.7 图生视频 | 2026-09-30 | Kling 3.0 | | MiniMax Music | 2026-09-30 | — | | MiniMax Lyrics | 2026-09-30 | — | 请尽快将业务迁移至替代模型。对于没有替代模型的服务,请及时调整相关业务。停服后原 API 调用将返回错误代码。为避免业务中断,请立即联系专属客户经理或提交工单处理技术迁移事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-09-01 *** ## 关于部分 LLM 模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分 LLM 模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `kat-coder` | 2026-08-31 | — | 请尽快停止使用上述模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理相关事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-08-14 *** ## 关于部分多模态模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分多模态模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | Z Image 文生图 Turbo | 2026-08-19 | Qwen-Image 文生图 | | Z Image 文生图 Turbo LoRA | 2026-08-19 | Qwen-Image 文生图 | | Wan 2.1 文生视频 | 2026-08-19 | Wan 2.7 文生视频 | | Wan 2.1 图生视频 | 2026-08-19 | Wan 2.7 图生视频 | | Wan 2.2 文生视频 | 2026-08-19 | Wan 2.7 文生视频 | | Wan 2.2 图生视频 | 2026-08-19 | Wan 2.7 图生视频 | | Seedance 1.5 Pro 文生视频 | 2026-08-19 | Wan 2.7 文生视频 | | Seedance 1.5 Pro 图生视频 | 2026-08-19 | Wan 2.7 图生视频 | | MiniMax Speech-2.6-hd 同步语音合成 | 2026-08-19 | MiniMax Speech 2.8 HD 同步语音合成 | | MiniMax Speech-2.6-hd 异步语音合成 | 2026-08-19 | MiniMax Speech 2.8 HD 异步语音合成 | | MiniMax Speech-2.6-turbo 同步语音合成 | 2026-08-19 | MiniMax Speech 2.8 Turbo 同步语音合成 | | MiniMax Speech-2.6-turbo 异步语音合成 | 2026-08-19 | MiniMax Speech 2.8 Turbo 异步语音合成 | 请尽快将业务迁移至替代模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理技术迁移事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-08-03 *** ## 关于部分多模态模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分多模态模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | PixVerse V4.5 | 2026-07-22 | Kling v3.0 | | VIDU Q2 | 2026-07-22 | Kling v3.0 | | VIDU Q2 Turbo | 2026-07-22 | Kling v3.0 | | VIDU Q2 Pro | 2026-07-22 | Kling v3.0 | | Vidu Q3 Pro | 2026-07-22 | Kling v3.0 | | Vidu Q3 Turbo | 2026-07-22 | Kling v3.0 | | Kling V2.5 Turbo | 2026-07-22 | Kling v3.0 | | Kling V2.6 Pro | 2026-07-22 | Kling v3.0 | | Kling-o1 | 2026-07-22 | Kling v3.0 | | 天幕 | 2026-07-22 | Kling v3.0 | 请尽快将业务迁移至替代模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理技术迁移事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-07-07 *** ## 关于部分多模态模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分多模态模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | MiniMax Speech-02-hd | 2026-07-15 | MiniMax Speech 2.8 HD | | MiniMax Speech-02-turbo | 2026-07-15 | MiniMax Speech 2.8 Turbo | | MiniMax Speech-2.5-hd | 2026-07-15 | MiniMax Speech 2.8 HD | | MiniMax Speech-2.5-turbo | 2026-07-15 | MiniMax Speech 2.8 Turbo | | Seedance V1 Lite | 2026-07-15 | Seedance 1.5 Pro | | Seedance V1 Pro | 2026-07-15 | Seedance 1.5 Pro | | Kling V1.6 | 2026-07-15 | Kling v3.0 | | Minimax Hailuo-02 | 2026-07-15 | Minimax Hailuo 2.3 | | Vidu 2.0 | 2026-07-15 | Vidu Q3 | | Vidu Q1 | 2026-07-15 | Vidu Q3 | 请尽快将业务迁移至替代模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理技术迁移事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-06-30 *** ## 关于部分 Serverless LLM 模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分 **Serverless LLM** 模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `deepseek/deepseek-v3.1` | 2026-06-30 | `deepseek/deepseek-v3.2`、`deepseek/deepseek-v4-pro` | | `deepseek/deepseek-v3.1-terminus` | 2026-06-30 | `deepseek/deepseek-v3.2`、`deepseek/deepseek-v4-pro` | | `deepseek/deepseek-r1` | 2026-06-30 | `deepseek/deepseek-v3.2`、`deepseek/deepseek-v4-pro` | | `deepseek/deepseek-r1-0528` | 2026-06-30 | `deepseek/deepseek-v3.2`、`deepseek/deepseek-v4-pro` | | `deepseek/deepseek-r1-turbo` | 2026-06-30 | `deepseek/deepseek-v3.2`、`deepseek/deepseek-v4-pro` | | `deepseek/deepseek-r1/community` | 2026-06-30 | `deepseek/deepseek-v3.2`、`deepseek/deepseek-v4-pro` | | `deepseek/deepseek-r1-distill-qwen-14b` | 2026-07-01 | `deepseek/deepseek-v4-flash` | | `deepseek/deepseek-r1-distill-qwen-32b` | 2026-07-01 | `deepseek/deepseek-v4-flash` | | `qwen/qwen3-14b` | 2026-07-01 | `qwen/qwen3.6-27b` | | `qwen/qwen3-30b-a3b` | 2026-07-01 | `qwen/qwen3.6-35b-a3b` | | `qwen/qwen3-30b-a3b-instruct-2507` | 2026-07-01 | `qwen/qwen3.6-35b-a3b` | | `qwen/qwen3-30b-a3b-thinking-2507` | 2026-07-01 | `qwen/qwen3.6-35b-a3b` | | `qwen/qwen3-32b` | 2026-07-01 | `qwen/qwen3.6-27b` | | `qwen/qwen3-8b` | 2026-07-01 | `qwen/qwen3.6-27b` | | `qwen/qwen3-coder-30b-a3b-instruct` | 2026-07-01 | `qwen/qwen3.6-35b-a3b` | | `qwen/qwen3-next-80b-a3b-instruct` | 2026-07-01 | `qwen/qwen3.6-35b-a3b` | | `qwen/qwen3-next-80b-a3b-thinking` | 2026-07-01 | `qwen/qwen3.6-35b-a3b` | | `qwen/qwen3-vl-235b-a22b-thinking` | 2026-07-01 | `qwen/qwen3.7-max` | | `qwen/qwen3-vl-30b-a3b-instruct` | 2026-07-01 | `qwen/qwen3.6-35b-a3b` | | `qwen/qwen3-vl-30b-a3b-thinking` | 2026-07-01 | `qwen/qwen3.6-35b-a3b` | | `qwen/qwen3-vl-32b-instruct` | 2026-07-01 | `qwen/qwen3.6-27b` | | `qwen/qwen3-vl-32b-thinking` | 2026-07-01 | `qwen/qwen3.6-27b` | | `qwen/qwen3-vl-8b-instruct` | 2026-07-01 | `qwen/qwen3.6-27b` | | `qwen/qwen3-vl-8b-thinking` | 2026-07-01 | `qwen/qwen3.6-27b` | | `qwen/qwen3-235b-a22b-instruct-2507` | 2026-07-01 | `qwen/qwen3.7-max` | | `qwen/qwen3-235b-a22b-thinking-2507` | 2026-07-01 | `qwen/qwen3.7-max` | | `qwen/qwen3-coder-480b-a35b-instruct` | 2026-07-01 | `qwen/qwen3.7-max` | 请尽快将业务迁移至替代模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理技术迁移事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-06-25 *** ## 关于部分多模态模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分多模态模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | GLM 语音合成 | 2026-07-07 | MiniMax Speech 2.8 Turbo 语音合成 | | GLM 音频转文字 | 2026-07-07 | — | | GLM 音频复刻 | 2026-07-07 | MiniMax 音频快速复刻 | | GLM 图像生成 | 2026-07-07 | Seedream 图片生成 5.0 lite | | Hunyuan Image 3 | 2026-07-07 | Seedream 图片生成 5.0 lite | | 即梦文生图 3.0 | 2026-07-07 | Seedream 图片生成 5.0 lite | | 即梦文生图 3.1 | 2026-07-07 | Seedream 图片生成 5.0 lite | 请尽快将业务迁移至替代模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理技术迁移事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-06-22 *** ## 关于部分 Serverless LLM 模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分 **Serverless LLM** 模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `deepseek/deepseek-prover-v2-671b` | 2026-06-19 | `deepseek/deepseek-v4-pro` | | `zai-org/glm-4.5` | 2026-06-19 | `zai-org/glm-5.1` | 请尽快将业务迁移至替代模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理技术迁移事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-06-04 *** ## 关于部分 Serverless LLM 模型计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分 **Serverless LLM** 模型进行计划下线处理。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `xiaomimimo/mimo-v2-pro` | 2026-05-31 | `xiaomimimo/mimo-v2.5-pro` | | `xiaomimimo/mimo-v2-flash` | 2026-06-05 | `xiaomimimo/mimo-v2.5` | 请尽快将业务迁移至替代模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理技术迁移事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-05-29 *** ## 关于部分 Serverless LLM 模型紧急下线及计划下线的通知 尊敬的开发者: 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO 派欧云将对部分 **Serverless LLM** 模型进行下线处理。本次下架包含**紧急下线**及**计划下线**两批,**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `baidu/ernie-4.5-21B-a3b` | 2026-05-22 | `qwen/qwen3.5-35b-a3b`、`qwen/qwen3.6-35b-a3b` | | `baidu/ernie-4.5-vl-28b-a3b` | 2026-05-22 | `qwen/qwen3.5-35b-a3b`、`qwen/qwen3.6-35b-a3b` | | `baidu/ernie-4.5-300b-a47b-paddle` | 2026-05-22 | `deepseek/deepseek-v3.2` | | `baidu/ernie-4.5-21B-a3b-thinking` | 2026-05-22 | `qwen/qwen3.5-35b-a3b`、`qwen/qwen3.6-35b-a3b` | | `qwen/qwen2.5-7b-instruct` | 2026-05-22 | `qwen/qwen3.5-27b`、`qwen/qwen3.6-27b` | | `qwen/qwen2.5-vl-72b-instruct` | 2026-05-22 | `qwen/qwen3.5-27b`、`qwen/qwen3.6-27b` | | `qwen/qwen2.5-32b-instruct` | 2026-05-22 | `qwen/qwen3.5-27b`、`qwen/qwen3.6-27b` | | `qwen/qwen3-4b` | 2026-05-22 | `qwen/qwen3.5-27b`、`qwen/qwen3.6-27b` | | `qwen/qwen3-30b-a3b` | 2026-06-05 | `qwen/qwen3.5-35b-a3b`、`qwen/qwen3.6-35b-a3b` | | `qwen/qwen3-32b` | 2026-06-05 | `qwen/qwen3.5-27b`、`qwen/qwen3.6-27b` | | `deepseek/deepseek-ocr` | 2026-06-05 | `deepseek/deepseek-ocr-2` | 其中标注 **2026-05-22** 的模型为**紧急下线**,自本公告发布之日起立即停止服务;标注 **2026-06-05** 的模型将于该日期下线,请尽快将业务迁移至替代模型。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理技术迁移事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2026-05-22 *** ## LLM API 计费规则说明 近期我们收到部分用户关于 API 计费规则的咨询,特此对 LLM API 的计费规则做统一说明,帮助您更好地理解和管理 API 用量。 **核心原则:请求到达模型并开始推理即计费,未到达模型的请求不计费。** | 场景 | 是否计费 | | :- | :- | | 请求成功(200) | **计费** | | 客户端断开连接(499) | **计费** | | 参数错误、认证失败、限流等(400/401/403/429) | 不计费 | | 平台原因返回报错(500/503/504) | 不计费 | 当您发起 API 请求后,模型会在服务端开始推理。即使您在推理过程中断开了连接,模型侧的计算资源消耗已经产生,因此按**全额计费**。 详细计费规则请参阅 [LLM API 计费说明](/docs/model/llm-billing)。 发布时间:2026-03-27 *** ## 关于 GPU 容器实例及 Serverless GPUs 服务价格调整的通知 尊敬的 PPIO 派欧云用户: 感谢您对 PPIO GPU 容器实例和 Serverless GPUs 服务的支持。为了更好地服务广大用户,PPIO 计划于 **2026 年 3 月 16 日** 对上述服务的价格进行调整。 如您有任何疑问,请联系技术支持团队或提交工单。 感谢您对派欧云的理解与支持。 发布时间:2026-03-02 *** ## GPU 实例自动迁移入口修改 GPU `自动迁移`入口已迁移至实例管理页面,支持按实例维度配置迁移策略。 为保障业务连续性,新创建的 GPU 资源将默认开启`自动迁移`,您可通过操作实例的`更多操作`→`自动迁移`或 OpenAPI 配置迁移属性。 ## 关于部分 Image-API 调整及下线通知 为提升平台服务结构与资源使用效率,我们计划下线部分使用率较低的 API,安排如下: | **API 名称** | **API Code** | | :- | :- | | 文生图 | `txt2img` | | 图生图 | `img2img` | | 背景移除 | `remove-background` | | 背景替换 | `replace-background` | | 局部重绘 | `inpainting` | | 文字擦除 | `remove-text` | | 对象擦除 | `cleanup` | | 脸部融合 | `merge-face` | 下线时间: **2026 年 1 月 31 日 23:59:59** *** 自上述时间起,这些 API 将停止服务,请您提前完成相关业务调整。我们充分考虑到本次变更可能对您的业务造成影响,已尽可能预留迁移窗口。如需帮助或有任何疑问,请联系技术支持团队。 感谢您对派欧云的理解与支持。 发布时间:2025-12-31 *** ## 关于 Serverless LLM 部分模型库调整及下架通知 尊敬的开发者:根据产品生命周期管理规划,为提升平台服务竞争力,PPIO 派欧云将对 **Serverless Endpoints** 的模型库进行调整,并将于 **2026年1月8日** 正式停止支持部分 **LLM Serverless** 模型。 请参阅下表,核实您的应用是否正在使用受影响的模型,并查看相应的推荐替代方案: | **拟下架模型 (停止支持)** | **推荐替代模型** | | :- | :- | | `baichuan/baichuan-m2-32b` | `qwen/qwen3-32b-fp8` | | `paddlepaddle/paddleocr-vl` | `qwen/qwen3-vl-8b-instruct` | | `qwen/qwen3-reranker-8b` | `baai/bge-reranker-v2-m3` | | `deepseek/deepseek-ocr` | `qwen/qwen3-vl-235b-a22b-instruct` | | `thudm/glm-4.1v-9b-thinking` | `zai-org/glm-4.6v` | | `deepseek/deepseek-r1-distill-qwen-14b` | `deepseek/deepseek-r1-0528` | | `deepseek/deepseek-r1-0528-qwen3-8b` | `deepseek/deepseek-r1-0528` | | `deepseek/deepseek-r1-distill-qwen-32b` | `deepseek/deepseek-r1-0528` | | `qwen/qwen3-8b-fp8` | `qwen/qwen3-next-80b-a3b-instruct` | 请您务必在 **2025年12月26日公告发布后至停服日前** 将业务迁移至推荐替代模型,新模型在推理能力、上下文理解及稳定性上均有显著优化。停服后原 API 调用将返回错误代码,为避免业务中断,请立即联系专属客户经理或提交工单处理技术迁移事宜。感谢您的理解与支持。 **PPIO 派欧云 AI 产品团队** 发布时间:2025-12-26 *** ## 【邀请奖励】活动下线通知 亲爱的用户: 您好! 我们怀着万分不舍的心情向您宣布,**PPIO 官网"邀请奖励"活动将于 2025 年 11 月 30 日 00:00** 正式落下帷幕。届时,活动页面将关闭,奖励申请通道同步停止服务。 请您务必在 **11 月 29 日 23:59** 之前完成活动邀请并且领取奖励,避免错过最后福利。活动下线后,历史邀请数据将自动归档,不再支持补领或申诉。 感谢您一路以来的热情参与与支持!未来,PPIO 仍将推出更多惊喜活动,敬请关注官网公告与官方社群,第一时间获取最新动态。 如有任何疑问,欢迎随时联系客服([support@ppio.com](mailto:support@ppio.com)),我们将竭诚为您服务。 再次感谢,期待我们的新一期活动! 发布时间:2025-11-20 *** ## Agent沙箱 存储计费功能上线公告 为更合理地分配资源并优化平台成本,Agent **沙箱 存储计费功能自 2025 年 10 月 31 日起正式上线**。 本次计费将覆盖以下内容: * **沙箱模板(Template)** 所占用的存储空间 * **沙箱暂停(Paused)** 后所保留的文件与数据 为确保平稳过渡,我们将在上线初期提供 **为期半个月的免费期(截止至2025.11.17)**。在此期间,沙箱存储仍可正常使用且**不计费**,但您可随时在 [https://ppio.com/sandbox/console/usage](https://ppio.com/sandbox/console/usage) 查看具体存储用量。 免费期结束后,系统将正式启用存储计费。 发布时间:2025-10-31 *** ## 大语言模型下线公告 ## 视频 API 服务下线公告 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO派欧云将于 **2025年7月31日** **24:00** 下线文生视频、图生视频API服务。 | **下架模型** | **接口** | **下架时间** | | :- | :- | :- | | 文生视频 | `/v3/async/txt2video` | 2025-07-31 | | 图生视频 | `/v3/async/img2video` | 2025-07-31 | 发布时间:2025-07-23 *** ## 大语言模型下线公告 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO派欧云将于 **2025年7月5日** 下架部分大语言模型(LLM)。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `thudm/glm-z1-9b-0414` | 2025-07-05 | `qwen/qwen3-4b-fp8` | | `thudm/glm-4-9b-0414` | 2025-07-05 | `qwen/qwen3-4b-fp8` | | `thudm/glm-z1-rumination-32b-0414` | 2025-07-05 | `qwen/qwen3-32b-fp8` | | `thudm/glm-z1-32b-0414` | 2025-07-05 | `qwen/qwen3-30b-a3b-fp8` | 发布时间:2025-07-03 *** ## 关于未实名认证用户请求频率限制公告 为保障整体用户体验,平台将对未完成实名认证的账户实行严格的访问频率限制。 调整内容如下: * 自 **2025年6月27日** 起,未实名认证账户的速率限制(RPM)调整至 **1 次/分钟**。 * 已完成实名认证的账户,仍遵循原有请求频率规则。 为了确保您能正常、高效地使用平台服务,建议您尽快前往[实名认证](https://ppio.com/settings/verify)。 感谢您的理解与支持。如有疑问,欢迎通过官方渠道与我们联系。 发布时间:2025-06-24 *** ## 大语言模型下线公告 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,PPIO派欧云将于 **2025年5月28日** 下架部分大语言模型(LLM)。**下架模型及相应替换模型列表**如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | `qwen/qwen3-14b-fp8` | 2025-05-28 | `qwen/qwen3-32b-fp8` | | `qwen/qwen3-0.6b-fp8` | 2025-05-28 | `qwen/qwen3-32b-fp8` | | `qwen/qwen3-1.7b-fp8` | 2025-05-28 | `qwen/qwen3-32b-fp8` | | `qwen/qwq-32b` | 2025-05-28 | `qwen/qwen-2.5-72b-instruct` | 发布时间:2025-05-14 *** ## 派欧算力云正式升级至 PPIO派欧云 为提供更智能、高效、弹性的 AI 云服务体验,原 **派欧算力云(ppinfra.com)** 已于 **2025年5月10日** 正式升级并统一迁移至 **PPIO 派欧云官方平台**:👉 [www.ppio.cn](http://www.ppio.cn) 网站升级后,您可通过官方平台获取所有服务,并享受**更完善的产品体系与支持能力**。 发布时间:2025-05-09 *** ## 大语言模型下线公告 为持续优化平台服务效率,聚焦核心产品能力提升,提供更先进、优质、规范的服务,(ppinfra)平台将于 **2025年4月3日** 对部分大语言模型(LLM)进行下线处理。具体涉及下线的模型列表如下: * **qwen/qwen-2-7b-instruct** * **qwen/qwen-2-vl-72b-instruct** 发布时间:2025-03-26 *** ## PPIO 派欧云平台正式发布! PPIO 派欧云平台是 派欧云计算(上海)有限公司 旗下的一站式 AI 云服务平台,提供**大模型 API 服务**、**Serverless** 和 **GPU 容器实例**等云产品。 发布时间:2024-08-21 # 沙箱发版记录📝 Source: https://ppio.com/docs/announcement/changelog-agent-sx 查看 PPIO Agent 沙箱的版本发布记录,了解新增功能、优化与调整事项,按发布记录跟踪运行环境的变化并安排接入验证。 ## 2026年11月18日 **新增功能**💡 * **Sandbox 支持创建时配置资源与运行中扩容** 使用 2.1.4 及以上版本的 SDK 或 CLI,可以在创建 Sandbox 时指定 CPU、内存和磁盘总量,也可以对运行中的 Sandbox 增加资源。扩容目标为绝对总量,需满足资源取值要求和配额限制。 每项资源独立返回 `applied`、`skipped`、`failed` 或 `unknown` 结果。扩容可能部分成功,必须逐项检查 `status` 和 `current`,失败项不会回滚已成功的资源。 扩容生效后,CPU 和内存按新规格计费;Sandbox 暂停后,磁盘按容量计收存储费用。 更新时间:2026-11-18。详见 [Sandbox 资源配置与扩容指南](/docs/sandbox/sandbox-resize)。 *** ## 2026年11月9日-11月13日 **新增功能**💡 * **Sandbox 支持 OpenTelemetry 遥测导出** Sandbox 支持通过 OTLP/HTTPS 将遥测数据导出到 OpenTelemetry Collector 或兼容 OTLP 的可观测性平台,便于在现有监控系统中查看资源使用情况、组织配额与用量,以及生命周期事件。 * **资源指标(Metrics)**:包括 CPU 核数与利用率、内存和磁盘的分配量与使用量,支持按 Sandbox、模板和区域等维度查看。 * **组织配额与用量(Metrics)**:包括并发 Sandbox 数、CPU 与内存用量,以及组织和单个 Sandbox 的配额限制,便于评估剩余容量。 * **生命周期事件(Logs)**:包括创建、暂停、恢复、删除等操作的状态、请求耗时和错误信息,用于排查生命周期操作中的问题。 在 [Sandbox 控制台设置](https://ppio.com/sandbox/console/settings)的 OpenTelemetry 区域配置 OTLP Endpoint,按需添加 Headers,开启 Enable export 并保存即可。详细配置和数据字段请参阅 [OpenTelemetry 接入指南](/docs/sandbox/guides/opentelemetry)。 更新时间:2026-11-11 * **Sandbox 控制台支持默认区域设置** 现在可以在 [Sandbox 控制台设置](https://ppio.com/sandbox/console/settings)中配置**默认区域**。有关可用[区域(Region)](/docs/sandbox/overview#区域)的详细信息,请参阅 Sandbox Overview 文档。 更新时间:2026-11-11 *** ## 2026年10月26日-10月30日 **新增功能**💡 * **Sandbox 新版控制台上线** [Sandbox 新版控制台](https://ppio.com/sandbox/console)正式上线,支持多个区域的资源展示,用户可以在控制台完成以下操作。 **查看沙箱** * 沙箱列表显示每个沙箱的状态、启动时刻、来源和剩余时长。 * 列表支持按状态筛选和分页。 **查看沙箱详情** * 详情页有五个页签:概览、指标、日志、终端、事件。 * 终端页签在浏览器内直接连接沙箱。 * 事件页签显示原始错误消息和状态码。 **管理沙箱状态** * 可以休眠、唤醒或终止单个沙箱,也可以选择多个沙箱批量执行操作。批量选择只作用于当前页。 * 休眠后的沙箱保留内存和磁盘状态,唤醒不会重新启动进程。 **创建沙箱** * 配置沙箱参数后,页面会生成对应的代码。 * 可以直接在控制台创建沙箱,也可以把代码复制到自己的项目中。 **管理 Snapshot 和 Template** * Snapshot 有独立的列表,支持从 Snapshot 创建沙箱。 * Template 显示规格和可用区域,支持从 Template 创建沙箱。 更新时间:2026-10-29 *** ## 2026年9月28日-9月30日 **新增功能**💡 * **新增 PPIO Sandbox Skill** PPIO Sandbox Skill 包含了 SDK 和 CLI 的使用手册,安装后 AI Agent 即可参照手册使用 PPIO Sandbox。安装方式详见[安装 Skills](/docs/sandbox/sandbox-sdk-and-cli#安装-skills)。 更新时间:2026-09-28 *** ## 2026年9月7日-9月15日 **新增功能**💡 * **新增 v2 区域 cn-beijing-1** 新增 `cn-beijing-1.sandbox.ppio.com` v2 区域集群。v2 区域在 v1 的基础上新增了 [Secret 密钥](/docs/sandbox/secret-overview)、[Snapshot 快照](/docs/sandbox/snapshot-overview)等能力。详见[区域说明](/docs/sandbox/overview#区域)。 * **SDK 版本升级至 2.1.0** Python SDK 与 JavaScript & TypeScript SDK 均升级到 2.1.0 版本: * 新增统一的 `PPIO` 高层客户端,便于集中管理 Sandbox、Template 等资源;原有调用方式继续可用。 * 同时支持访问 v1 和 v2 版本的集群。 * 完善 Template 查询、镜像配置继承、私有镜像和批量构建能力。 * 补充 Snapshot、Volume 和 Secret 等资源接口。 * **CLI 版本升级至 2.1.0** CLI 更新到 2.1.0 版本,补充并完善了 Sandbox、Template、Snapshot、Volume、Secret 等资源的管理能力,同时新增或完善了 Sandbox 文件操作、配额查询、网络配置以及生命周期管理等命令。 更新时间:2026-09-07 *** ## 2025年9月15日-9月19日 **新增功能**💡 * **Pause 状态的 Sandbox 支持回溯 Metrics 数据** 当 Sandbox 处于 Pause 状态 时,现可查看该实例在 最后一次暂停时间点前 72 小时内的指标数据。 此更新有助于开发者在 Sandbox 暂停后,仍能回溯分析近期的运行情况。 更新时间:2025-09-18 ## 2025年9月8日-9月12日 **新增功能**💡 * **用量统计新增模版维度筛选** 控制台的 **用量统计** 功能现已支持按照 **模版维度** 进行筛选和展示。 用户可以基于不同模版查看对应的资源使用情况,更加直观地对比与分析不同模版下的调用数据,便于进行成本优化与使用决策。 更新时间:2025-09-11 *** ## 2025年8月18日-8月22日 **新增功能**💡 * **Agent 沙箱上线 Browse Use Playground** 派欧云平台正式上线 Browser Use Playground。用户可在此体验强大的 Browser Use Agent,它运行于一个具备毫秒级启动、虚拟机级隔离的云端安全沙箱中,无需预部署,即启即用。 Browser Use Agent 核心应用场景: **高效自动化测试**: 轻松执行自动化测试流程,显著提升测试效率,保障产品质量。 **深度研究与分析**: 模拟领域专家,自主执行数十次搜索、整合数百个信息源,并最终为您生成一份全面的深度分析报告。 欢迎在本平台探索 [Browser Use Agent](https://browser-use-showcase.ppio.com/) 的强大功能。 更新时间:2025-08-22 *** ## 2025年8月11日-8月15日 **新增功能**💡 * **Agent 沙箱新增沙箱运行时资源监控** “沙箱管理”列表现已支持查看实时运行指标。用户可点击展开正在运行的沙箱,查看 **CPU 使用率** 和 **内存占用情况**,便于监控和优化资源使用。 更新时间:2025-08-11 *** ## 2025年6月23日-6月27日 **新增功能**💡 * **Agent 沙箱正式发布!** Agent沙箱是一款专为 AI Agent 场景设计的高性能云端运行时。它具备: * 秒级启动,适配高并发调用 * 多语言支持,兼容 Python、JS、C++ 等主流执行环境 * 支持代码执行、网页访问、系统交互等 AI Agent 行为 * vCPU 与内存资源按秒计费,成本可控,性价比高 作为 **AI Agent 运行时代的基础设施底座**,Agent 沙箱将为生成式智能体提供强大执行力与运行效率。查看[使用指南](/docs/sandbox/overview) 发布时间:2025-06-23 # GPU 容器服务 发版记录📝 Source: https://ppio.com/docs/announcement/changelog-gpu 查看 PPIO GPU 容器服务的版本更新与功能调整,了解实例相关服务的演进,按照发版记录核对部署和运维流程。 ## 2025年9月22日-9月28日 **新增功能**➕ * **包月实例自动续费功能** 支持[包年包月](https://ppio.com/docs/gpu/gpu-instance-pricing#%E8%87%AA%E5%8A%A8%E7%BB%AD%E8%B4%B9)实例设置自动续费。 更新时间:2025-09-22 **功能优化**♻️ * **创建实例和模板支持指定最小cuda版本** 能够根据镜像支持的最小cuda版本筛选GPU的cuda版本,并支持在模板中配置最小cuda版本。 更新时间:2025-09-25 *** ## 2025年9月1日-9月5日 **新增功能**➕ * **镜像预热功能** 预热镜像,能够缩短实例拉取镜像时间,节省费用。 更新时间:2025-09-01 *** ## 2025年8月25日-8月29日 **新增功能**➕ * **故障自迁移功能** 用户开启自动迁移,当设备故障时,系统会将实例**自动迁移至同集群的健康节点**上,实例id、端口映射地址等均不会发生变化; 需要注意的是: 1. 迁移过程中,用户的实例仍会有**短时中断**,中断时间取决于系统盘大小; 2. 因此该功能非常适用于**无状态的任务**,针对有状态的任务,建议暂不开启该功能,在收到故障通知后,用户可选择在业务低峰期执行迁移,后续我们也会针对该场景升级功能; 更新时间:2025-08-25 *** ## 2025年8月4日-8月8日 **新增功能**➕ * **Serverless 创建 Endpoint 时增加区域选择** PPIO 现支持选择区域创建 Endpoint。 更新时间:2025-08-04 *** ## 2025年7月14日-7月18日 **新增功能**➕ * **GPU Instance Spot 计费(抢占式计费实例)** 功能特性的优势: 1. 最大优势:**便宜!!价格一般是按需价格的5折**,在市场上极具价格竞争力,比如4090目前是¥2.37,spot 4090 价格低至 ¥1.18,用量大可能会有更大折扣 2. 为什么这么便宜?spot计费实例本质是为了处理闲置库存,因此**随时可能因为资源紧缺而被回收**(实例释放) 3. 我们怎么在便宜的前提下尽量保证客户业务稳定?我们的spot计费实例将采用以下策略: * 创建后享有**1小时的保护期**,这1小时内会保证实例不被回收 * 资源回收前,会**提前1小时通知,实例回收前5分钟会再次通知**,客户在接到通知时,可以进行数据备份,给客户留了更多备份数据的时间! 更新时间:2025-07-18 *** ## 2025年7月7日-7月11日 **新增功能**➕ * **实例迁移支持迁移系统盘** 支持实例迁移,并支持迁移系统盘,迁移后实例信息均不会发生变化(实例ID、出口IP等),迁移后镜像会存放到PPIO官方镜像仓库,如迁移系统盘,则系统盘数据将打包成镜像,一同迁移到新资源上,新镜像中包含系统盘数据,即开即用。 更新时间:2025-07-07 * **GPU Instance metrics** 支持以下数据的实时监控: * CPU利用率 * 内存利用率 * GPU利用率 * 显存利用率 * 系统盘利用率 更新时间:2025-07-09 *** ## 2025年6月16日-6月20日 **新增功能**➕ * **账户欠费后清理云存储并告警** 如果用户账户欠费,且无运行中实例,云存储空间将在3日后释放。另外,云存储是在使用 GPU 执行任务时提供的,不作为一个长期的备份解决方案。强烈建议用户及时在本地或云服务商处备份数据。 更新时间:2025-06-20 * **实例任何状态都允许【实例升级】** 更新时间:2025-06-17 *** ## 2025年6月2日-6月6日 **新增功能**➕ * **算力市场根据模型推荐卡型** 根据模型模板推荐卡型,帮开发者快速决策 GPU 选型 更新时间:2025-06-06 *** ## 2025年5月26日-5月30日 **新增功能**➕ * **新增裸金属预定页面** PPIO 官网上线 **裸金属服务器预定界面**,用户可查看支持裸金属服务的 GPU 卡型及其详细配置信息。裸金属作为一种不经过虚拟化层的计算服务形式,用户可直接访问底层物理服务器,拥有更高的性能、更强的控制力和更低的延迟,适用于对资源隔离性和计算性能要求极高的场景。若您有需求,可自主选择所需卡型并在线完成预定,即可专属独享物理服务器资源。 更新时间:2025-05-30 **功能优化**♻️ * **算力市场界面调整优化** 1. 整体版面改为**从上至下**的排布方式,筛选项重新排布 2. 地区选项将 **中国和海外分离**,增加 中国-不限 与 海外-不限 选项 3. **模版整合**到新界面,并优化了模版详情信息的展示,增加了模版详细配置的展示 立即体验👉 [https://ppio.com/gpu-instance/console/explore](https://ppio.com/gpu-instance/console/explore) 更新时间:2025-05-26 *** ## 2025年5月19日-5月23日 **新增功能**🖥️ * **上架新卡型 L40S** L40S 是 NVIDIA 基于 Ada Lovelace 架构推出的高性能数据中心级 GPU,专为 AI 推理、大模型训练、图形渲染及虚拟化等多任务场景优化。适用于 GPT、BERT 等中大型语言模型的推理与训练,以及 Stable Diffusion 和图像/视频生成。其支持多种硬件引擎并发工作,具备出色的多用户虚拟机部署与 GPU 虚拟化能力。立即使用:[算力市场 - 云 GPU 服务器租赁 - 稳定、弹性、性价比超强 | PPIO派欧云](https://ppio.com/gpu-instance/console/explore)。 更新时间:2025-05-23 **扩展及 Open API**📦 * **GPU 实例 API 更新** 新增 GPU instance 包年包月实例创建,详情请看:[API 使用说明 - PPIO 派欧云文档中心](/docs/gpus/reference-start)。 更新时间:2025-05-22 * **Serverless Endpoint API 更新** 新增 Serverless GPUs 管理,详情请看:[获取 Endpoint 参数限制范围 - PPIO 派欧云文档中心](/docs/gpus/endpoint/reference-query-endpoint-limit)。 更新时间:2025-05-22 *** ## 2025年5月12日-5月16日 **新增功能**🌐 * **算力扩张至覆盖全球主要大洲** 全球算力版图再扩张,基于分布式资源池,提供覆盖全球主要大洲的 GPU 服务,服务全球客户。 **新增区域**: 1. **中东**:阿联酋(AS-AE-01) 2. **欧洲**:英国(EU-GB-01) 3. **南亚**:印度(AS-IN-01) 4. **南美**:巴西(SA-BR-01) 更新时间:2025-05-13 **功能优化**✨ * **算力市场及实例管理界面优化** 对算力市场以及实例管理部分进行优化,增加信息展示并优化交互: 1. H100、A100 卡型增加卡型架构名称展示 2. 算力市场卡型选择部分增加一台服务器最多支持的 GPU 数量信息,表述为“1 机 x 卡”,并且进行了每实例 GPU 数量选择的交互优化 3. 实例管理部分增加实例配置 GPU 数量展示 更新时间:2025-05-15 *** ## 2025年4月21日-4月25日 **功能优化** 😉 * **GPU 容器实例存储结构优化** 由于系统盘、本地盘的定位重复,我们进行了实例存储策略的调整。即日起**取消配置本地盘**(已创建的实例/模版仍保持本地盘设置),**系统盘免费容量同步从 100GB 提升至 130 GB**。存储策略调整后,实例现已支持系统盘扩容,已设置本地存储的实例支持取消挂载和修改本地盘空间,取消挂载的本地存储数据将自动转移至系统盘。点击前往:[实例管理](https://ppio.com/gpu-instance/console/instances) 更新时间:2025-04-24 *** ## 2025年4月7日-4月11日 **新增功能** 📤 * **新增区域:浙江-云存储-01** 该集群配备 RTX 4090 GPU,并支持云存储服务,适用于高性能计算与数据密集型任务。 更新时间:2025-04-09 **功能优化**🗂️ * **实例增加“待停止”和“待启动”状态** 实例新增“待停止”/“待启动”状态,在实例停止/启动时会触发该状态,让用户可以更清晰把握实例状态。 更新时间:2025-04-10 *** ## 2025年3月24日-3月28日 **功能优化**👾 * **GPU 容器实例包年包月状态短信提醒优化** GPU 容器实例包年包状态短信提醒新增通知对象“创建人”,确保实际创建人及时获取最新状态更新。 更新时间:2025-03-26 * **算力市场-选择 GPU 部分展示专属折扣** 对于申请专属折扣的客户,在算力市场-选择模板和 GPU 部分直接展示专属折扣价格,改变了原先只在账单部分展示折扣的方式,帮助客户更直观地了解折扣价格,辅助决策。 更新时间:2025-03-25 *** ## 2025年3月17日-3月21日 **新增功能** 🎉 * **GPU 控制台新增团队成员昵称显示** 账号在团队状态下,GPU 容器实例、Serverless GPU 弹性容器服务等任务列表中增加团队成员的昵称显示。 更新时间:2025-03-18 *** ## 2024年9月2日-9月6日 **新增功能** 💐 * **PPIO 派欧云发布发布 Serverless 产品** Serverless 产品:专为 AI 推理场景设计的**GPU 容器实例**。您只需指定容器镜像地址并根据您的业务场景稍作配置,即可快速部署一个 AI 推理服务。 详情请参考 [Serverless 产品介绍](/docs/gpu/serverless-overview)。 更新时间:2024-09-03 # 模型 API 服务 发版记录📝 Source: https://ppio.com/docs/announcement/changelog-llm 查看 PPIO 模型 API 服务的模型更新、功能调整与版本发布记录,帮助开发者跟踪接口服务变化并安排应用兼容性验证。 ## 2026年9月1日-9月4日 **模型调整** 🔧 * **部分多模态模型计划下线** Qwen-Image、Wan 2.5 Preview、Wan 2.6、Minimax Hailuo 2.3、万相 Wan 2.7、MiniMax Music 和 MiniMax Lyrics 的部分模型将于 2026 年 9 月 30 日下线。请在下线前完成业务迁移或调整。 其中视频生成模型可迁移至 Kling 3.0。具体模型清单与替代方案请查看[官方公告](/docs/announcement/announcement)。 更新时间:2026-09-01 *** ## 2025年9月22日-9月28日 **新增功能** ➕ * **qwen/qwen3-vl-235b-a22b-thinking 模型发布** Qwen3-VL——迄今为止Qwen系列中最强大的视觉-语言模型。PPIO国内首发支持! 更新时间:2025-09-24 * **qwen/qwen3-vl-235b-a22b-instruct 模型发布** Qwen3-VL——迄今为止Qwen系列中最强大的视觉-语言模型。PPIO国内首发支持! 更新时间:2025-09-24 * **minimax-hailuo-02支持首尾帧** 首尾帧是海螺AI推出的视频生成技术,通过指定起始和结束画面(首帧和尾帧),自动生成中间动态过渡视频,支持复杂指令执行和电影级效果,适用于电商广告、一键换装等场景。 更新时间:2025-09-26 * **Seedance V1 Lite/Pro上线与调整** seedance 1.0 是字节跳动豆包大模型团队最新推出的视频生成基础模型,包含lite和pro两个版本,支持的能力和价格与官网完全对齐。 **Seedance V1 Lite 文生视频** **Seedance V1 Lite 图生视频** **Seedance V1 Pro 文生视频** **Seedance V1 Pro 图生视频** 更新时间:2025-09-26 *** ## 2025年9月15日-9月19日 **新增功能** ➕ * **上线 seedream-4.0模型** Seedream是基于领先架构的SOTA级多模态图像创作模型。其打破传统文生图模型的创作边界,原生支持文本、单图和多图输入,用户可自由融合文本与图像,在同一模型下实现基于主体一致性的多图融合创作、图像编辑、组图生成等多样玩法,让图像创作更加自由可控。 按实际生成的图片张数计费,生成失败不收费。 更新时间:2025-09-19 *** ## 2025年8月18日-8月22日 **新增功能** ➕ * **上线音频生成模型 MiniMax Speech-2.5** 派欧云平台上线现已上线 MiniMax 新一代语音合成(TTS)模型:**MiniMax Speech-2.5-hd-preview 和 MiniMax Speech-2.5-trubo-preview**。 Speech 2.5 是 MiniMax 推出的新一代语音生成模型,在多语种表现力、音色复刻和语言覆盖范围上实现重大突破。 * Speech-2.5-HD (高保真版):最新的HD模型,韵律表现出色,复刻相似度极佳,专为高品质音频场景设计,提供录音棚级别的高保真音质。 * Speech-2.5-Turbo (极速版):最新的Turbo模型,追求极致的响应速度和超低延迟,满足高并发、实时性要求高的场景。支持40个语种。 欢迎在本平台体验 **MiniMax Speech-2.5-hd-preview** 和 **MiniMax Speech-2.5-trubo-preview**,感受高质量语音生成新体验。 更新时间:2025-08-21 * **上线图像编辑 Qwen-Image-Edit 模型** **Qwen-Image-Edit** 基于 Qwen-Image 模型进⼀步训练,将其独特的文本渲染能力延展至图像编辑领域,实现了对图片中文字的精准编辑。 核心亮点: 语义与外观双重编辑:不仅支持像素级的局部修改(如增删元素,背景丝毫不变),还支持涉及全局的创意编辑(如IP重绘、物体旋转、风格迁移)。 精准文字编辑:可直接修改图片中的中英文文字,并完美保留原始字体、大小和风格。 顶尖性能:在多项公开基准测试中达到业界顶尖(SOTA)水平。 欢迎在本平台体验 **Qwen-Image 图像编辑** 模型。 更新时间:2025-08-21 * **上线文生视频模型 Pixverse V4.5 Text to Video 和图生视频模型 Pixverse V4.5 Image to Video** Pixverse 4.5 是爱诗科技 Pixverse AI 最新发布的AI视频模型。 核心亮点: 20+电影级镜头控制: 新增动态平移、变焦、推拉镜头等多种镜头运动选项,支持通过提示词精确调整视角与运镜,打造专业级视频效果. 多图参考与融合: 支持同时输入多张图像作为参考,通过Fusion模式无缝融合多个元素,生成风格一致、内容丰富的场景。 复杂动作优化: 模型对高速运动、群体交互等复杂动作的处理能力显著提升,生成的视频动作更自然、破绽更少。 欢迎在本平台体验 **Pixverse V4.5 文生视频** 和 **Pixverse V4.5 图生视频**,探索其卓越的视频生成能力。 *** ## 2025年8月11日-8月15日 **新增功能** ➕ * **大语言模型批量推理 API 发布** 大语言模型批量推理 API 支持异步处理大量推理请求,完全兼容 OpenAI API 标准。批量推理 API 是在不需要立即获得推理结果时的经济高效解决方案。它提供比在线调用更高的速率限制,确保在 48 小时的合理时间范围内交付结果。 此 API 非常适用于: * 进行评估和数据分析 * 对大量数据集进行分类 * 以离线模式生成文档摘要 定价为:模型推理API目录价的5折。 更新时间:2025-08-13 * **上线视频生成模型 Vidu Q1** Vidu Q1 是生数科技于2025年4月全球上线的多模态视频生成模型,具备1080P分辨率直出能力与AI音效同步生成功能。该模型在VBench-1.0的视频质量、语义一致性指标及VBench-2.0的常识推理、物理理解维度达到SOTA水平,同时在国内SuperCLUE图生视频榜单的动漫与写实风格类别中均位列第一。 欢迎在本平台体验 Vidu Q1 模型的文生视频、图生视频、首尾帧和参考生视频能力,让创意变为现实。 更新时间:2025-08-14 * **上线视频生成模型 Vidu 2.0** Vidu 2.0 是生数科技于2025年1月全球上线的多模态视频生成模型,能在10秒内生成长度为4秒、分辨率为512P的单片段视频,风格、主题更一致,首尾帧更自然,一次性生成四条素材,让效率在翻倍。 欢迎在本平台体验 Vidu 2.0 的图生视频、首尾帧和参考生视频能力,感受高效的视频生成技术。 更新时间:2025-08-14 *** ## 2025年8月4日-8月8日 **新增功能** ➕ * **上线文生图模型 Qwen-Image** **Qwen-Image** 是一款基于 200 亿参数 MMDIT 架构的新一代文本到图像生成模型。该模型在原生文本渲染方面表现卓越,尤为擅长生成包含高集成度文字的复杂视觉内容。 核心亮点: * SOTA 级文本渲染能力 — 英文效果媲美 GPT-4o,中文效果为同类最佳。 * 像素级文本生成技术 — 无覆盖层,完全集成。 * 精通通用图像生成 — 能够创作从写实、动漫、印象派、科幻、水墨等多种艺术风格的作品。 * 支持多样化字体选择及复杂的图文布局设计。 欢迎在本平台体验 Qwen-Image,让创意变为现实。 更新时间:2025-08-06 * **上线文生视频模型 Wan 2.2 Text to Video 和图生视频模型 Wan 2.2 Image to Video** Wan2.2 是全球首个开源的、具有电影级控制能力的 MoE 架构视频生成模型,有效解决视频生成处理 Token 过长导致的计算资源消耗大问题。 Wan2.2-T2V、Wan2.2-I2V 两款模型均由高噪声专家模型和低噪专家模型组成,分别负责视频的整体布局和细节完善,在同参数规模下,可节省约 50% 的计算资源消耗,在模型能力上,Wan2.2 在复杂运动生成、人物交互、美学表达、复杂运动等维度上也取得了显著提升。 欢迎在本平台体验 Wan 2.2 Text to Video 和 Wan 2.2 Image to Video,探索其卓越的视频生成能力。 更新时间:2025-08-08 *** ## 2025年7月28日-8月1日 **新增功能** ➕ * **上线文生图模型 Seedream3.0** **Seedream3.0** 文生图模型是基于字节跳动视觉大模型打造的新一代文生图模型,提供精准理解文本输入,生成高图文匹配、高美感的图像的能力,支持 2048 以下分辨率直出,各类场景下的效果均大幅提升。 更新时间:2025-08-01 *** ## 2025年7月21日-7月25日 **新增功能** ➕ * **上线编程模型 Qwen3 Coder 480B A35B Instruct** 由 Qwen 团队推出的尖端开源编程模型 Qwen3-Coder-480B-A35B-Instruct 已正式上线派欧云平台。该模型在智能体编程(Agentic Coding)、浏览器自动化以及核心开发任务中,展现出与 Claude Sonnet 同级的卓越性能,能够助力高效的代码生成与复杂任务处理。 欢迎在本平台体验 [**Qwen3 Coder 480B A35B Instruct**](https://ppio.com/llm/qwen-qwen3-coder-480b-a35b-instruct) ,享受其顶尖性能表现。 更新时间:2025-07-23 * **上线大语言模型 Qwen3-235B-A22B-Instruct-2507** 派欧云平台上线基于 Qwen3-235B 架构的多语言指令微调混合专家语言模型 **Qwen3-235B-A22B-Instruct-2507**。该模型采用高效混合专家(MoE)架构,每次前向推理仅激活 220 亿参数,实现了性能与效率的完美平衡。通过动态调用最优专家子网络,能够灵活处理不同类型任务。 Qwen3-235B-A22B-Instruct-2507 原生支持 26.2 万 token 的超长上下文窗口(约 200 万单词),特别适合长文档分析、完整代码库理解及跨段落推理等复杂场景。 欢迎在本平台体验 [**Qwen3-235B-A22B-Instruct-2507**](https://ppio.com/llm/qwen-qwen3-235b-a22b-thinking-2507),体验其高效智能的多语言理解能力。 更新时间:2025-07-23 *** ## 2025年7月14日-7月18日 **新增功能** 💡 * **Playground 支持 Function Call** 为了更好地满足用户对智能查询功能的需求,我们在模型交互 Playground 中正式推出 **Function Call** 功能! **功能亮点:** * **自定义查询**:用户可通过 JSON 格式输入查询需求,并为其设置主题标签 * **智能交互**:在对话页面输入与主题相关的问题,模型将自动调用相关资料进行精准回答 * **三大优势**: * ⚡ **更强时效性** - 实时获取最新信息 * 🎯 **更低幻觉率** - 基于真实数据源,减少错误信息 * 📈 **更高准确率** - 正本清源,确保回答质量 此外,我们特别为用户准备了**三个完整的 Function Call 示例**,即使是初次接触的用户也能快速上手。 更新时间:2025-07-18 *** ## 2025年7月7日-7月11日 **新增功能**➕ * **上线音频生成模型 MiniMax Speech-02 和音频克隆模型 MiniMax Voice Cloning** 派欧云平台上线音频生成模型 **MiniMax Speech-02-HD**、**MiniMax Speech-02-Turbo** 以及音频克隆模型 **MiniMax Voice Cloning。** MiniMax Speech 02 具备强大的泛化能力,能够轻松驾驭32语种、不同口音、不同情绪的人声。该模型自5月发布以来,在Artificial Analysis榜单中持续位列全球第一名。 MiniMax Voice Cloning 适用于IP复刻、音色克隆等需要快速复刻某一音色的相关场景,支持单、双声道复刻声音,支持指定音频文件快速复刻相同音色的语音。 欢迎在本平台体验 **MiniMax Speech-02** 和 **MiniMax Voice Cloning**,感受高质量语音生成与自然拟真声音克隆带来的智能语音新体验。 更新时间:2025-07-10 * **上线多模态大模型 GLM 4.1V 9B Thinking** 派欧云平台上线多模态大模型 **GLM-4.1V-9B-Thinking**,该模型是由智谱 AI 与清华大学 KEG 实验室联合发布的开源视觉语言模型(VLM),专为处理复杂的多模态认知任务设计。其作为一个 9B 参数规模的轻量级模型,在 28 项权威评测基准中,有 18 项的表现持平甚至超越了 72B 参数规模的 Qwen-2.5-VL-72B。该模型不仅在图文理解、数学科学推理、视频理解等任务上表现卓越,还支持高达 4K 分辨率的图像和任意宽高比输入。 欢迎在本平台体验 [GLM 4.1V 9B Thinking](https://ppio.com/llm/thudm-glm-4.1v-9b-thinking),体验高效智能的多模态交互。 更新时间:2025-07-10 * **上线MoE大模型 Kimi K2 Instruct** PPIO上线MoE大模型 **Kimi K2 Instruct**,Kimi K2 是一种最先进的专家混合 (MoE) 语言模型,具有 320 亿个激活参数和 1 万亿个总参数。使用 Muon 优化器进行训练,Kimi K2 在前沿知识、推理和编码任务方面实现了卓越的性能,同时针对代理功能进行了精心优化,专为工具使用、推理和自主解决问题而设计。 欢迎在本平台体验 [**Kimi K2 Instruct**](https://ppio.com/llm/moonshotai-kimi-k2-instruct),畅享其强大的推理解决能力。 更新时间:2025-07-11 *** ## 2025年6月16日-6月20日 **新增功能**➕ * **首发上线 MiniMax 最新发布的视频生成模型 Hailuo 02** 派欧云平台首发上线 MiniMax 最新发布的视频生成模型 Hailuo 02。Hailuo 02 拥有顶尖的指令遵循能力,能够处理极端物理场景,比如做特技表演,可生成 6 秒的 768P 或 1080P 分辨率超清视频,以及 10秒的 768P 分辨率视频。 欢迎在本平台体验 MiniMax-Hailuo-02,探索其卓越的视频生成能力! 更新时间:2025-06-18 * **PPIO上线推理模型 MiniMax-M1-80k** 派欧云平台上线 MiniMax-M1 模型,该模型是世界上第一个开放权重、大规模混合注意力推理模型。MiniMax-M1 采用混合专家 (MoE)架构 ,支持 100 万个令牌的上下文长度,是 DeepSeek R1 上下文大小的 8 倍,在长输入推理与真实软件工程场景中实现了业界领先的性能,欢迎体验。 更新时间:2025-06-17 *** ## 2025年5月26日-5月30日 **新增功能**➕ * **新增 DeepSeek-R1-0528 模型** 派欧云平台现已提供的最新高性能DeepSeek R1 模型——DeepSeek-R1-0528 。DeepSeek-R1-0528 作为DeepSeek团队发布的最新开源模型,具备非常强悍的推理性能,尤其在编程、数学、推理任务上达到了开源模型最先进的水平。 欢迎在本平台体验 [DeepSeek-R1-0528](https://ppio.com/llm/deepseek-deepseek-r1-0528),探索其卓越的推理能力! 更新时间:2025-05-28 **服务下线**🧩 * **部分大语言模型已正式下线** 为持续提升模型性能与用户体验,部分大语言模型(LLM)现已正式停止服务,下架模型及相应替换模型列表如下: | **下架模型** | **下架时间** | **替换模型** | | :- | :- | :- | | qwen/qwen3-14b-fp8 | 2025-5-28 | qwen/qwen3-32b-fp8 | | qwen/qwen3-0.6b-fp8 | 2025-5-28 | qwen/qwen3-32b-fp8 | | qwen/qwen3-1.7b-fp8 | 2025-5-28 | qwen/qwen3-32b-fp8 | | qwen/qwq-32b | 2025-5-28 | qwen/qwen-2.5-72b-instruct | 如您在使用过程中遇到任何问题,欢迎随时联系我们的技术支持团队。感谢您的理解与支持! 更新时间:2025-05-28 *** ## 2025年5月12日-5月16日 **新增功能**🌐 * **大语言模型API上线企业私有化部署服务** 大语言模型 API 产品推出全新企业私有化部署方案,具备企业级性能与弹性扩展能力,零运维压力,按需计费、费用透明,满足高安全性与定制化需求。欢迎您提交需求,获取专属优化方案[https://ppio.com/consultation。](https://ppio.com/consultation。) 更新时间:2025-05-16 *** ## 2025年5月6日-5月9日 **新增功能**🤗 * **模型广场增加分类筛选器功能** 大语言模型 API 产品中正式上线**分类筛选器功能**。用户可在模型广场中按**厂商、价格、上下文长度、模型规格等维度**快速筛选,精准定位所需模型,大幅提升选择效率与使用体验。 更新时间:2025-05-09 *** ## 2025年4月28日-4月30日 **新增功能**☁️ * **图像/视频 API 新增速率限制机制** 图像、视频类 API 产品现已支持 **Rate Limit(速率限制)机制**,用于控制调用频率,提升接口稳定性与服务公平性: 1. **IPM(Image Per Minute)**:限制每分钟可生成的图像数量; 2. **RPM(Requests Per Minute)**:限制每分钟的 API 请求次数。 当调用频率超过限制时,将返回速率限制提示。建议合理安排调用计划,避免请求被限制。如需更高调用频率,可提交申请。 更新时间:2025-04-30 * **上线 Qwen3 系列模型** 上线 Qwen3 系列模型: [Qwen3 0.6B ](https://ppio.com/llm/qwen-qwen3-0.6b-fp8)、[Qwen3 1.7B](https://ppio.com/model-api/console) 、 [Qwen3 4B](https://ppio.com/llm/qwen-qwen3-4b-fp8) 、 [Qwen3 8B](https://ppio.com/llm/qwen-qwen3-8b-fp8) 以及 [Qwen3 14B](https://ppio.com/llm/qwen-qwen3-14b-fp8) ,其中 [Qwen3 0.6B](https://ppio.com/llm/qwen-qwen3-0.6b-fp8) 、 [Qwen3 1.7B](https://ppio.com/model-api/console) 与 [Qwen3 4B](https://ppio.com/llm/qwen-qwen3-4b-fp8) 为**限时免费**模型。 更新时间:2025-04-30 * **大语言模型 API 速率限制(Rate Limits)规则更新** 根据用户 **最近充值金额**,系统自动划分为 **L1-L5** 五个服务级别,不同级别对应不同的 **RPM(每分钟请求数)** 和 **TPM(每分钟 Token 数)** 限制。详情请查看文档:[调用频率控制(Rate Limits)](/docs/model/llm-rate-limits)。 更新时间:2025-04-30 * **上线 Deepseek 新模型** 上线 Deepseek 新模型 [**Deepseek Prover V2 671B**](https://ppio.com/llm/deepseek-deepseek-prover-v2-671b) 。 更新时间:2025-04-30 * **首批大参数 Qwen3 模型上线** 上线大参数 Qwen3 模型 [Qwen3-235B-A22B](https://ppio.com/llm/qwen-qwen3-235b-a22b-fp8) 、[Qwen3-30B-A3B](https://ppio.com/llm/qwen-qwen3-30b-a3b-fp8) 以及 [Qwen3-32B ](https://ppio.com/llm/qwen-qwen3-32b-fp8)。 更新时间:2025-04-29 *** ## 2025年4月21日-4月25日 **新增功能** 👏 * **GLM-4-0414 系列及 Qwen2.5-7B-Instruct 模型上新** 今年3月,智谱曾预告会在 4 月中旬开源新的GLM模型,现在,GLM-4-0414 系列准时登场。此次开源的新模型覆盖**基座、推理、沉思**三大类型,根据官方公布数据显示,部分模型可在性能上比肩 OpenAI 的 GPT-4o 和 DeepSeek 的 V3/R1 系列模型。 作为一站式 AIGC 云服务平台,PPIO 派欧云随即上线了上述模型及 Qwen2.5-7B-Instruct 限时免费版,并对模型进行了全链路优化,在保持原始模型精度的前提下大幅降低推理延迟,开发者通过 API 接口即可高效调用模型。 1. [thudm/glm-4-9b-0414](https://ppio.com/llm/thudm-glm-4-9b-0414) 2. [thudm/glm-z1-9b-0414](https://ppio.com/llm/thudm-glm-z1-9b-0414) 3. [thudm/glm-z1-32b-0414](https://ppio.com/llm/thudm-glm-z1-32b-0414) 4. [thudm/glm-4-32b-0414](https://ppio.com/llm/thudm-glm-4-32b-0414) 5. [thudm/glm-z1-rumination-32b-0414](https://ppio.com/llm/thudm-glm-z1-rumination-32b-0414) 更新时间:2025-04-25 *** ## 2025年4月14日-4月18日 **新增功能** 🤩 * **邀请活动更新** 1. 在本次规则调整中,对邀请所得代金券的使用范围进行了扩大:代金券支持用于 PPIO 派欧云**所有大语言模型** 2. 针对部分模型开放了**限时免费**。以下是开放免费使用的模型列表: baai/bge-m3 thudm/glm-4-9b-chat qwen/qwen2.5-7b-instruct 3. RPM 限制调整:对于账户有余额的付费用户,**RPM 限制进行了放宽**。详情见 [RPM 限制文档页](/docs/model/llm-rate-limits) 更新时间:2025-04-17 * **控制台支持大语言模型 rate limit 展示** 控制台现已支持 **大语言模型的速率限制信息展示**,用户可直观查看各模型的默认请求速率,便于合理规划调用频率。 同时,新增速率限制变更申请入口,支持根据业务需求提交速率提升申请。 更新时间:2025-04-17 **已知问题修复**🚩 * **模型广场切换模型时,网页 URL 同步更新** 使用模型广场切换模型,网页 URL 会根据模型名称同步更新。 更新时间:2025-04-17 *** ## 2025年3月31日-4月3日 **新增功能** 🤖 * **新增模型 Qwen2.5 VL 72B Instruct** Qwen2.5 VL 72B Instruct 是PPIO 派欧云平台推出的最新高性能多模态大语言模型,具备更强的视觉理解能力,在复杂推理和决策能力等方面也具有较好表现。 更新时间:2025-03-31 *** ## 2025年3月24日-3月28日 **新增功能** 💡 * **新增模型 deepseek-v3-0324** deepseek-v3-0324 是PPIO 派欧云平台推出的最新高性能大语言模型,是深度求索(DeepSeek)团队旗舰级对话模型系列的最新版本,采用混合专家(Mixture-of-Experts, MoE)架构,参数量达685B参数。 更新时间:2025-03-26 * **大语言模型服务支持文本检索** 大语言模型体验中心支持文件检索。 更新时间:2025-03-24 *** ## 2025年3月17日-3月21日 **新增功能** 🎉 * **大语言模型 Playground 支持联网搜索功能** 大语言模型在线体验中心支持限时免费联网搜索功能。 更新时间:2025-03-21 *** ## 2025年3月3日-3月7日 **新增功能** ✨ * **PPIO 派欧云发布 Qwen 系列推理模型:Qwen: QwQ 32B** QwQ 是 Qwen 系列的推理模型。与传统的指令调优模型相比,QwQ 具备思考和推理能力,能够在下游任务中实现显著增强的性能,尤其是在解决困难问题方面。QwQ-32B 是中型推理模型,能够在与最先进的推理模型(如 DeepSeek-R1、o1-mini)的对比中取得有竞争力的性能,快速体验入口:[https://ppio.com/llm/qwen-qwq-32b。](https://ppio.com/llm/qwen-qwq-32b。) 更新时间:2025-03-07 * **Deepseek-V3 支持 function calling 功能** Deepseek/deepseek-v3 模型支持 function call 功能。使用方法见[接口文档](/docs/model/llm-function-calling)。 更新时间:2025-03-06 * **PPIO 派欧云发布 Deepseek R1/V3 Turbo 性能加速版!** DeepSeek V3 (Turbo) 、DeepSeek R1 (Turbo) 模型是PPIO 派欧云平台提供的最新高性能 DeepSeek V3/R1 模型,全参数,满血版,与官方效果一致,性能更强更稳定。 更新时间:2025-03-05 * **为保障平台资源与服务稳定,调整以下模型 RPM 为 10,详情请参考**[**调用频率控制**](/docs/model/llm-rate-limits)**。** deepseek/deepseek-r1/community deepseek/deepseek-v3/community 更新时间:2025-03-04 # 云平台基础服务 发版记录📝 Source: https://ppio.com/docs/announcement/changelog-pt 查阅 PPIO 云平台基础服务的版本发布与调整记录,了解平台功能变化,为账户使用、服务接入与日常运维提供更新参考。 ## 2025年8月18日-8月22日 **新增功能** 💡 * **团队预算管理功能上线** 为了帮助团队更好地管理和控制API的费用支出,我们正式推出预算管理功能,助力团队高效、灵活地管理成员消费额度。 核心功能: * **成员维度预算控制**: * **智能预算执行与提醒**: * **灵活的预算类型** * **实时预算调整** 您可前往”[费用-预算管理](https://ppio.com/billing/budget)”进行预算设置。欢迎随时查阅我们的[帮助文档](https://ppio.com/docs/support/budgets),了解更多功能详情。 更新时间:2025-08-20 * **Sandbox 实时监控上线** 平台现已支持对运行中的 Sandbox 进行实时性能监控,支持实时追踪 Sandbox 的 **vCPU 利用率**及**内存使用情况**。 您可前往[沙箱管理](https://ppio.com/sandbox/console),点击“运行中”的实例即可查看监控面板。 更新时间:2025-08-21 *** ## 2025年7月21日-7月25日 **功能优化** 🔧 * **定价页面优化** 为优化用户浏览体验,我们将PPIO定价页面进行了重大优化升级: 1. 按照除混合专家(MoE)模型外不同厂商进行系统化排序,清晰区分各品牌模型 2. 新增混合专家(MoE)模型专属分类,单独陈列于页面末尾,便于快速定位 更新时间:2025-07-22 *** ## 2025年6月30日-7月4日 **新增功能** 💡 * **站内信功能上线** 平台现已上线 **站内信功能**,支持统一接收并查看各类重要消息,包括但不限于: * **GPU 故障、服务中断等系统运行通知** * **账户信息提醒**(如代金券到账、登录异常等) * **平台运营活动信息** 请前往控制台站内信中心,及时查看与您相关的重要通知。 更新时间:2025-07-01 *** ## 2025年6月9日-6月13日 **新增功能** 💡 * **账号管理支持微信解绑功能** 为提升账号管理灵活性,平台现已支持微信解绑操作。您可在”[账号管理](https://ppio.com/settings)“中自主解除与当前账号绑定的微信。 更新时间:2025-06-13 *** ## 2025年6月2日-6月6日 **功能优化** 🔧 * **文档中心新增模型服务 API 错误码说明** 为提升开发者调试体验,文档中心现已新增「图片 / 视频 / 音频/大语言」模型服务 API 错误码列表,涵盖常见请求校验、格式限制、内容合规等问题,助您更高效定位并解决调用异常。 欢迎访问[文档中心](/docs/models/reference-error-code)查看详细说明。 更新时间:2025-06-06 *** ## 2025年5月19日-5月23日 **功能优化** 🔧 * **平台合规性增强** 为加强平台合规性建设、保障用户隐私权益,我们近期完成了以下优化: 1. **用户协议与隐私政策更新提醒**:当协议发生变更,系统将提示用户重新阅读并确认。 2. **信息透明清单上线**:新增[个人信息收集清单](https://ppio.com/legal/personal-info-list)及[第三方信息共享清单](https://ppio.com/legal/thirdparty-info-list),用户可随时查阅。 3. **Playground 增加水印标识**:所有生成内容将默认添加水印,用于内容溯源和风险防控。 我们将持续以更透明、可控的方式处理您的数据,提升合规标准,保障您的使用安全。 更新时间:2025-05-23 *** ## 2025年4月21日-4月25日 **功能优化** 😉 * **注册登录流程合规性策略调整** 为加强用户隐私保护并提升平台合规性,注册与登录流程中的协议勾选策略已进行优化: 1. 当《用户协议》或《隐私政策》更新时,系统将提示用户在登录前重新勾选并确认两份协议内容; 2. 使用微信授权登录的用户,需先同意上述协议,才会展示登录二维码。 此次调整旨在确保用户充分知情并明确授权后使用平台服务。 更新时间:2025-04-23 *** ## 2025年4月14日-4月18日 **新增功能** 🤩 * **注册流程新增风险手机号校验机制** 为提升平台账号安全性,现已上线注册环节的风险手机号识别与拦截机制。 系统将自动识别并阻止部分存在异常行为记录的手机号注册,防止批量恶意注册等违规行为,保障正常用户权益。 更新时间:2025-04-16 *** ## 2025年4月7日-4月11日 **功能优化**🗂️ * **实名认证支持从个人认证变更为企业认证(入口已开放)** 为满足用户业务发展过程中从个人使用向企业管理转变的需求,平台现已在实名认证页面新增“变更为企业认证”申请入口。 更新时间:2025-04-09 * **隐私增强:手机号信息默认模糊化展示** 为提升平台内用户隐私信息的安全性,我们已对系统中涉及 **手机号展示** 的场景进行统一模糊处理。 自本次更新起,平台将在以下位置对用户手机号进行部分隐藏,仅保留部分位数以供识别。例如:`138****5678` 适用范围包括但不限于: 1. 账号管理页 2. 消息通知内容 3. 团队成员管理页 4. 账单等相关页面 更新时间:2025-04-07 *** ## 2025年3月31日-4月3日 **功能优化**🛠️ * **控制台首页界面优化** 为提升使用体验,对控制台首页进行了多项优化更新: 1. **「最近访问」提升至顶部**:快速跳转至常用功能,提高操作效率。 2. **新增「为您推荐」模块** :第一时间了解平台最新活动与产品动态。 3. **「费用中心」优化**:位置调整更便捷,新增月度成本分析,助力成本管控。 4. **「帮助文档」引导升级**:提供各业务线主要功能指引,便于快速上手与查阅。 更新时间:2025-04-01 *** ## 2025年3月24日-3月28日 **新增功能** 💡 * **主控制台内“月度账单”补全产品线消耗数据** 主控制台内“费用信息”内的“月度账单”补充了产品线数据,使每月消耗数据的分类更加清晰,提升成本分析的全面性和精细度。 更新时间:2025-03-25 # GPU 容器实例 Source: https://ppio.com/docs/gpu/gpu-instance-overview 了解 PPIO GPU 容器实例的产品定位与使用方式,认识云端 GPU 算力和容器运行环境,为 AI 开发、模型部署与推理选择计算资源。 **GPU 容器实例**在标准容器云平台上集成了 GPU 加速卡,提供超强计算能力的同时,保持灵活启动和按需使用的特性。适合 AI 训练、AI 推理、科学计算、视频渲染等场景。 ## 功能特性 * **按需付费** 提供灵活的计费方式,支持随用随停,只需为使用的算力付费。 * **多框架 AI 开发支持** 提供丰富的一键部署镜像,包括当前主流的机器学习框架镜像,如 TensorFlow 和 PyTorch,以及底层镜像,如 cuDNN 和 CUDA 等。 * **资源下载加速** 针对 Hugging Face、GitHub、Docker Hub 等站点提供加速服务,能够极大提升您的资源下载速度。 * **全方位存储方案** 提供一定免费额度的系统盘容量,支持极速、大容量、经济、安全的云存储,在保证高性能的同时有效降低您的成本。 ## 产品计费 支持包年包月和按量计费两种方式,对实际使用的计算资源、系统盘、云存储等进行计费。详情请参见[ GPU 容器实例计费说明](/docs/gpu/gpu-instance-pricing)。 ## 产品使用 您可以通过[控制台](https://ppio.com/gpu-instance/console/instances)或者 [API](/docs/gpus/instance/reference-create-gpu-instance) 创建和管理 GPU 容器实例。 # 使用 PPIO 构建 Source: https://ppio.com/docs/home 通过 PPIO 调用模型 API,或在 Agent 沙箱中运行代码。选择下方任务,快速跑通第一个结果。 > [card] [调用模型 API](/docs/model/get-start) > > OpenAI 兼容,跟着教程从注册到完成第一次调用。 > [card] [运行沙箱](/docs/sandbox/get-start) > > 给 Agent 一个隔离环境,创建 Sandbox 并运行代码。 ## 开始前 * [注册](https://ppio.com/user/register)并[登录](https://ppio.com/user/login)账号。 * [创建 API 密钥](https://ppio.com/settings/key-management)。 * [确认账户余额足够](https://ppio.com/billing)。 > [accordion] 用 Agent 接入 > > **把这句话粘贴到 Agent 对话中,Agent 会按说明完成接入:** > > ```text theme={null} > Read https://ppio.com/docs/ai/ppio-skills.md and follow the instructions. > ``` > > **可选:Agent 支持 Skills 时,安装一次即可:** > > ```bash theme={null} > npx skills add PPIO/ppio-skills --skill ppio-docs > ``` > > 了解 [PPIO MCP Server](/docs/ai/mcp-server) 和 [PPIO Skills](/docs/ai/ppio-skills)。 ## 浏览 > [card] [模型服务](/docs/model/overview) > > 了解大语言与多模态模型的接入方式。 > [card] [Agent 沙箱](/docs/sandbox/overview) > > 为 AI Agent 提供隔离、有状态的云端执行环境。 > [card] [模型 API 手册](/docs/models/reference-authentication) > > 查阅鉴权方式、接口参数与返回结果。 > [card] [API 错误码](/docs/models/reference-error-code) > > 根据返回的错误码排查调用问题。 > [card] [API 密钥管理](/docs/support/api-key) > > 创建和管理接入服务所需的 API 密钥。 > [card] [账单](/docs/support/bill) > > 查看账单,核对费用与消费记录。 # 常见问题 Source: https://ppio.com/docs/model/FAQs 查阅 PPIO 模型 API 常见问题,了解模型调用、使用限制与客户端接入相关问题的处理思路,为 AI 应用开发和服务排查提供参考。 > [!TIP] > > 在使用过程中遇到任何问题,欢迎随时[联系我们](https://ppio.com/contact)。 ## 代金券使用指南 ### PPIO 提供哪些类型的代金券? PPIO 目前提供以下类型的代金券,帮助用户体验平台服务: * **新用户代金券**:首次注册的用户可领取,用于试用各类模型服务。 * **邀请奖励代金券**:邀请他人注册并完成任务后获得。 ## 模型速率限制(Rate Limits) ### 不同用户的 RPM 限制是多少? RPM(每分钟请求数)限制根据用户的认证级别和账号状态有所不同。详细限制请参见[速率限制说明](/docs/model/llm-rate-limits)。 > [!TIP] > > 如需进一步协助,欢迎[联系我们](https://ppio.com/contact)。 ## RPM 限速调整与升级规则 ### 用户可以申请提高 RPM 限制吗? 可以。PPIO 支持根据使用需求灵活调整 RPM。规则如下: * **DeepSeek 系列模型**:平台将尽力满足合理的扩容需求。 * **其他模型**:根据模型成本和用户实际使用情况综合评估,受资源可用性限制。 **申请流程:** 用户 → 客服 / 技术支持 → 产品团队审核与审批 ### 实际用量低于承诺 RPM,会怎样处理? 如果用户实际 RPM 连续一周低于承诺值,平台将按以下规则调整: * 将限制降至过去一周内的峰值 RPM,或 * 恢复到模型默认速率限制(取较低值)。 ### 支持自助升级 RPM 吗? 支持。PPIO 计划推出 **RPM 升级包**,用户可自主管理和提升 RPM 限制,无需人工审批。 ## API 调用相关问题 ### 如何关闭思考模式? 部分支持思考模式的模型(如 `deepseek/deepseek-v4-flash-0731`)可通过 `thinking` 参数控制是否开启思考。如不需要思考模式,可在请求体中添加以下参数: ```python theme={null} "thinking": {"type": "disabled"} ``` 完整示例: ```python theme={null} { "model": "deepseek/deepseek-v4-flash-0731", "messages": [ { "role": "user", "content": "北京今天天气怎么样?" } ], "temperature": 0.7, "stream": false, "max_tokens": 500, "thinking": {"type": "disabled"} } ``` 不同模型的开关方式见[思考模式](/docs/model/llm-thinking-mode)。 ### 如何查看 DeepSeek 缓存命中情况? 调用 DeepSeek 模型时,响应体的 `usage` 字段会包含缓存命中信息: ```json theme={null} { "usage": { "prompt_tokens": 1000, "completion_tokens": 200, "total_tokens": 1200, "prompt_cache_hit_tokens": 800, "prompt_cache_miss_tokens": 200 } } ``` * `prompt_cache_hit_tokens`:命中缓存的 token 数(按缓存读取价格计费,约为标准输入价格的 1/10) * `prompt_cache_miss_tokens`:未命中缓存的 token 数(按标准输入价格计费) ### 如何查看 API 调用记录? PPIO LLM API 属于**无状态接口**,平台本身**不会保存每次请求的完整对话内容**。控制台主要提供: * 账单与 Token 用量统计 * API Key 的调用次数等聚合数据 如需查看完整对话历史,建议在**应用层自行记录**每次 API 响应中的 `usage` 字段。 **代码示例(Python):** ```python theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai", api_key="", ) response = client.chat.completions.create( model="", messages=[{"role": "user", "content": "你好"}], ) # 获取本次调用的 token 用量 usage = response.usage print(f"输入 tokens: {usage.prompt_tokens}") print(f"输出 tokens: {usage.completion_tokens}") ``` 详细的监控指标查询请参见[模型 API 监控](/docs/model/llm-api-metrics)。 ### 调用返回 429 错误,如何处理? `429 Too Many Requests` 表示请求频率超出当前 RPM 限制。处理方式: 1. **降低请求频率**:在客户端实现指数退避重试逻辑 2. **申请提高 RPM**:联系我们申请 RPM 升级,参见[RPM 升级规则](#rpm-限速调整与升级规则) 3. **使用批量推理**:对延迟不敏感的场景,使用[批量推理 API](/docs/model/llm-batch-api) 规避限速 ```python theme={null} import time, random def call_with_retry(fn, max_retries=5): for attempt in range(max_retries): try: return fn() except Exception as e: if "429" in str(e) and attempt < max_retries - 1: wait = (2 ** attempt) + random.uniform(0, 1) time.sleep(wait) else: raise ``` ### 调用返回 400 错误,如何处理? 常见原因: * 输入长度超出模型上下文窗口限制 * 参数类型或格式错误 * 请求体缺少必填字段 请检查以下项目: | 检查项 | 说明 | | - | - | | `model` 字段 | 确认模型 ID 正确,可在[模型列表](/docs/model/llm)查询 | | `messages` 格式 | 必须为数组,每条消息包含 `role` 和 `content` | | 输入长度 | 不超过对应模型的 context window 限制 | | 参数类型 | `temperature` 为 float,`max_tokens` 为 int | ### 调用返回 403 错误,如何处理? `403 Forbidden` 常见原因及解决方案: | 错误码 / 原因 | 触发条件 | 解决方案 | | - | - | - | | `NOT_ENOUGH_KEY_BUDGET` | API Key 设置了消费上限(Budget Limit),且额度已用尽 | 在[密钥管理页面](https://ppio.com/settings/key-management)调整或取消 Budget Limit | | 账号余额不足 | 账户余额耗尽 | 前往[充值页面](https://ppio.com/billing/recharge)充值 | | 模型需要加白 | 部分模型需申请访问权限 | [联系我们](https://ppio.com/contact)提交申请 | | 套餐限制 | 所使用的模型不在当前套餐内 | 切换模型或升级套餐 | ### 模型响应很慢或内容被截断,怎么排查? **响应慢:** * 检查 `stream` 参数:设置 `"stream": true` 可立即获得首个 token,改善感知延迟 * 检查网络连通性:国内访问建议使用 `api.ppinfra.com` 端点 * 思考模型(如 DeepSeek V4 Pro)推理阶段耗时较长,属正常行为 **内容被截断:** * 检查 `max_tokens` 设置:默认值可能较小,根据任务需要适当调大 * 检查响应的 `finish_reason`: * `stop`:正常结束 * `length`:触发 `max_tokens` 上限,需调大该值 ## 错误排查 ### 常用错误码速查 | 错误码 | 含义 | 常见原因 | 解决方案 | | - | - | - | - | | `400` | 请求格式错误 | 参数类型/格式有误、输入超长 | 检查参数格式和输入长度 | | `401` | 认证失败 | API Key 无效或已过期 | 检查 API Key 是否正确 | | `403` | 访问被拒绝 | 余额不足、Key 预算用尽、模型未加白、套餐限制 | 充值或申请模型权限 | | `404` | 资源不存在 | 模型 ID 错误 | 检查模型 ID,参见[模型列表](/docs/model/llm) | | `429` | 请求过频 | 超出 RPM 限制 | 降低频率或申请升级 RPM | | `500` | 服务端错误 | 平台内部异常 | 重试,持续问题请[联系我们](https://ppio.com/contact) | | `503` | 服务不可用 | 模型过载或维护中 | 稍后重试,建议指数退避 | ## 第三方客户端集成 ### 如何在 Cursor 等第三方工具中使用 PPIO? PPIO API 完全兼容 OpenAI 接口规范,可在支持自定义 Base URL 的第三方客户端中使用,配合 PPIO 提供的开源模型(如 DeepSeek、Qwen、GLM 等)。 **通用配置:** ```text theme={null} Base URL: https://api.ppio.com/openai API Key: 您的 PPIO API Key 模型名称: 如 deepseek/deepseek-v4.1-flash、qwen/qwen3.8-max 等 ``` **Cursor 配置注意事项:** 1. 模型名称必须与[模型列表](/docs/model/llm)完全一致(区分大小写) 2. 添加自定义模型后,请**取消勾选其他默认模型** 3. Base URL 末尾**不要多加斜杠** 4. 点击 SAVE 后点击 Verify 验证连通性 **已知支持自定义 Base URL 的客户端:** * Chatbox(桌面客户端,适合新手) * Open WebUI(功能丰富,支持多模型) * LobeChat(界面美观,功能全面) 详细的集成指南请参见对应工具的专题文档(如 [Cursor 集成指南](/docs/third-party/cursor-use))。 ### 能否在 ChatGPT(chatgpt.com)中使用 PPIO API Key? 不可以。**官方 ChatGPT 网页版(chatgpt.com)不支持自定义 API Key**,只能使用 OpenAI 自有服务。 如需类 ChatGPT 体验配合 PPIO 模型,请使用上一节列出的第三方客户端,效果一致。 ## 图像与视频生成常见问题 ### 视频生成任务失败,如何排查? 常见失败原因及解决方案: | 失败类型 | 可能原因 | 解决方案 | | - | - | - | | 任务排队超时 | 高峰期队列拥塞 | 稍后重试,或在非高峰时段提交 | | 提示词违规 | 含违禁内容 | 修改提示词,避免暴力、色情等违规内容 | | 图片格式不支持 | 不支持的图片格式或尺寸 | 转换为 JPEG/PNG,分辨率建议 512px 以上 | | 参数超出范围 | duration/fps 等参数超限 | 参考对应模型的 API 文档调整参数 | | 账户余额不足 | 余额耗尽任务被终止 | 充值后重新提交 | ### 视频生成 API 如何配置超时时间? 视频生成为异步任务,建议使用轮询方式查询任务状态,并设置合理的超时时间: ```python theme={null} import time def poll_task(task_id, client, max_wait=600, interval=10): """轮询视频任务结果,最长等待 600 秒""" elapsed = 0 while elapsed < max_wait: result = client.get_task(task_id) status = result.get("status") if status == "succeeded": return result elif status == "failed": raise Exception(f"任务失败: {result.get('error')}") time.sleep(interval) elapsed += interval raise TimeoutError(f"任务 {task_id} 超时({max_wait}s)") ``` > [!NOTE] > > 不同模型的生成时长差异较大(30 秒到 10 分钟不等),建议根据模型文档设置合理的 `max_wait`。 ### 图像 URL 有哪些要求? 使用图像 URL 作为输入时,需满足以下要求: * **可公开访问**:URL 必须可被平台服务器直接访问,不支持需要登录或 Cookie 的地址 * **格式支持**:JPEG、PNG、WebP * **大小限制**:建议单张图片不超过 10 MB * **分辨率**:建议 512px × 512px 及以上,过小可能影响生成质量 * **有效期**:确保 URL 在任务处理期间持续有效(建议使用永久链接或有效期 ≥ 1 小时的预签名 URL) > [!WARNING] > > 如果图片存储在私有存储桶,请生成带有足够有效期的预签名 URL,或将图片上传至公开可访问的 CDN。 # 私有化部署 Source: https://ppio.com/docs/model/dedicate-endpoint 了解 PPIO 大模型私有化部署的服务方式与使用流程,结合企业的模型和算力需求选择部署路径,为构建专属模型服务提供参考。 ## 全托管式大模型部署,助力企业AI规模化落地 在全球 AI 应用场景爆发、企业级定制需求激增的背景下,**PPIO 派欧云**正式推出面向大语言模型的**企业私有化部署解决方案**。该产品以**高性能、全托管、安全合规、弹性扩展**为核心,为希望大规模应用生成式 AI 的企业提供一站式私有部署服务。 该方案专为对基础设施、成本控制、安全合规与稳定性要求极高的企业场景设计,致力于帮助企业以**更低成本、更高效率、更强保障**实现大模型应用的自主部署与敏捷运营。 ## 传统企业自建部署面临的核心挑战 尽管大模型在教育、医疗、零售、车联网、金融等领域的渗透持续加速,企业在自建部署过程中仍面临多重挑战: * **资源投入高**:自建 GPU 集群成本巨大,资源闲置率高; * **运维负担重**:需投入大量工程力量进行基础设施维护与调优; * **性能波动大**:共享环境下资源争抢严重,影响推理响应; * **安全风险高**:数据与模型缺乏隔离机制,敏感信息易泄露。 ## PPIO 私有化部署解决方案:专为企业打造 为解决上述难题,PPIO 推出的企业私有化部署产品具备以下优势与能力: ### 完全托管,解放技术生产力 无需自建基础设施,由 PPIO 提供端到端托管服务,覆盖模型部署、资源调度、运维监控等全流程。企业专注业务开发,无需关心底层架构。 > [!TIP] > > 提供 24/7 全天候技术支持,专家团队全程陪伴业务成长。 ### 独享 GPU 集群,保障性能与数据安全 部署于专属高性能 GPU 集群,无资源共享风险,实现毫秒级推理响应。\ 物理隔离架构满足金融、医疗、政务等行业对**数据安全与合规**的高标准要求。 ### 弹性扩展,无惧流量峰值 支持自动水平扩缩容,毫秒级响应业务波动,适配从冷启动到百万 QPS 的各阶段规模。 > [!TIP] > > 无速率限制,彻底摆脱公共 API 的频控与限流困境。 ### 成本优化,按需计费 灵活设计定价方案,按企业真实使用量和性能目标定制化收费。 > [!TIP] > > 实现“以需定价”,显著降低资源冗余与支出压力。 ### 企业级 SLA 保障 承诺 99.9%+ 正常运行时间,支持自定义服务等级协议(SLA),包括推理时延、吞吐量、可用性等指标。\ 可视化监控系统提供全链路模型运行状态追踪与异常告警。 ## 典型应用场景 | 应用类型 | 具体说明 | | :- | :- | | 高并发 AI 服务 | 智能客服、虚拟助手、代码生成、实时内容生成、文本摘要、舆情分析等 | | 快速业务扩展 | 初创公司或高速成长型企业需低门槛试错与灵活扩张 | | 敏感数据处理场景 | 医疗诊断、金融风控、法律文书撰写、政务办公等合规要求高的行业 | ## 立即接入,专属部署,可信赖的 AI 战略合作伙伴 PPIO 企业私有化部署解决方案,帮助企业从容应对 AI 浪潮下的落地难题,成为业务持续演进与技术迭代的坚实底座。 > [!TIP] > > 联系我们,获取专属部署建议与定制报价方案。[预约咨询 - PPIO派欧云](https://ppio.com/consultation) # 常见错误码说明 Source: https://ppio.com/docs/model/error 查阅 PPIO 模型服务常见错误码的含义与处理说明,根据请求返回信息定位调用问题,为模型 API 接入与故障排查提供参考。 为了帮助用户更高效地排查和解决调用过程中遇到的问题,本文档整理了 PPIO API 平台常见错误码的定义、原因分析及处理建议。 ## 错误码 400 **描述**:请求参数不正确。\ **解决方法**:\ 请根据返回的错误信息提示,检查并调整请求参数格式、字段名称或取值范围,确保请求体符合 API 接口文档规范。 ## 错误码 401 **描述**:API Key 鉴权失败,通常是密钥未设置、格式错误或已失效。\ **常见子类**: * **未传入 API Key**:请求头缺少 `Authorization`,或未按 `Authorization: Bearer {API 密钥}` 的格式传入。 * **API Key 格式错误**:密钥应以 `sk_` 开头,检查是否被截断、混入空格或换行。 * **API Key 已删除或失效**:密钥在控制台被删除后立即失效,使用它的调用都会返回 401。请改用有效的密钥。 * **环境变量未正确读取**:如通过环境变量或配置文件传入,确认变量已设置且被正确加载。密钥的设置与排查参见[管理 API 密钥](/docs/support/api-key#环境变量配置)。 **解决方法**: * 检查是否传入了正确的 API Key; * 确保 API Key 是最新有效的; * 如使用环境变量或配置文件,请确认调用时已正确读取,排查方法参见[管理 API 密钥](/docs/support/api-key#设置了变量但代码仍找不到)。 ## 错误码 403 **描述**:权限不足。可能是账户没有调用该模型的权限,也可能是该 API Key 的模型访问范围不包含目标模型。\ **常见子类**: * **账户权限不足**:当前 API Key 所绑定账户不具备调用该模型的权限。 * **未完成实名认证**:某些模型要求实名认证后才能使用。 * **密钥模型访问被限制**(错误码 `model_access_denied`):该 API Key 配置了「模型访问」,目标模型不在其可访问范围内。此时请联系团队管理员调整该密钥的模型访问设置,详见[管理 API 密钥 — 模型访问](/docs/support/api-key#模型访问)。 **解决方法**: * 请确认当前 API Key 所绑定账户是否具备调用该模型的权限; * 如返回错误码 `model_access_denied`,说明该密钥的模型访问范围不包含目标模型,请联系团队管理员在[模型访问](/docs/support/api-key#模型访问)设置中放开该模型; * 某些模型可能要求通过实名认证后才能使用: * 登录控制台查看账户的实名认证状态; * 若当前账户未实名,请先完成实名认证; * 如有其他已实名账户,请使用其下 API Key 发起请求。 ## 错误码 429 **描述**:触发了 Rate Limit(调用频率限制)。\ **解决方法**: * 根据错误信息,区分是 TPM(每分钟 Token 限制)还是 RPM(每分钟请求次数)被触发; * 可参考平台的 Rate Limits 文档; * 如需提升速率限制,请联系支持申请调整或使用认证账户发起请求。 ## 错误码 503 / 504 **描述**:服务端超时或不可用,通常与系统负载或流控有关。 ### 原因归因: * 模型服务所在节点负载过高(GPU / CPU); * 非流式请求生成时间过长,超过网关(Nginx / API Gateway)的 timeout 配置; * 下游依赖服务(如 Redis、模型引擎)不可用; * 限流组件触发高峰保护策略,返回 503。 ### 解决方法: **用户侧建议:** * **增加重试机制**:建议使用指数退避策略,避免短时间内重复压测; * **改为流式请求**:Streaming 模式可边生成边返回 token,减少整体延迟,有效降低长文本生成失败率; * **优化调用配置**:如通过自建代理调用,请确保 `client_timeout` 与 `proxy_timeout` 不低于 60 秒; * **错峰调用**:如遇高并发场景,可稍后再尝试或避开高峰时段。 **服务端优化建议(供平台运营参考):** * 加强模型服务的负载监控与自动扩容机制; * 网关层设置更合理的 `proxy_read_timeout`; * 设计更精细的限流规则(如优先级队列、核心业务优先保活); * 搭配 Prometheus + Alertmanager 配置 503/504 异常告警。 ## 错误码 500 **描述**:服务器内部错误,通常为后端服务异常或模型引擎崩溃。\ **解决方法**: * 该类问题通常无法由用户自行解决,建议联系平台支持团队排查后端日志与资源状态; * 同时可尝试更换请求模型或降级服务重试。 如遇其他未列明错误,建议: * 首先参考 API 返回中的 `message` 字段; * 然后查看控制台或日志的调用轨迹; * 最终,如问题持续存在,请提交工单或联系技术支持获取帮助。 # Fusion 融合模型 Source: https://ppio.com/docs/model/fusion 了解 PPIO Fusion 融合模型的工作方式与使用说明,查阅多模型并行作答、结果融合及接入配置,为复杂任务的模型选择提供参考。 ## 特性介绍 Fusion 模型(融合模型)是 PPIO 智能模型网关提供的多模型融合推理能力。调用 Fusion 模型时,网关不会只询问一个模型,而是将您的请求同时分发给多个各有所长的“专家模型”并行作答,再通过思考编排与交叉验证,由主模型融合生成最终答案——相当于让每一次模型调用都变成一场“专家会诊”。 与仅做简单请求转发的传统 API 网关不同,Fusion 模型以智能优先、兼顾性价比:通过工程化的融合手段,把回答质量稳定在头部旗舰模型梯队,同时把成本控制在中低梯队。 > [!TIP] > > **实测数据**:在 DRACO 深度研究基准测试中,PPIO Fusion 模型以 Kimi K3、GLM 5.2、MiniMax M3 为参考模型(Advisors)、DeepSeek V4 Flash 为融合主模型(Aggregator)进行融合推理,取得 **57.34 分**,超越 Claude Fable 5 的 55.14 分,而总成本仅为其约 **1/10**。 **核心特性一览**: * **多模型并行推理**:一次请求,多个专家模型同时作答 * **交叉验证与融合**:多模型思考编排,避免单模型“偏科”导致的错误 * **OpenAI 兼容接口**:仅需修改 `model` 参数即可接入,无需改造现有代码 * **按请求自定义模型**:可为单次请求指定参考模型和融合主模型 * **支持流式输出、工具调用(Function Calling)、结构化输出与多模态输入** ## 应用场景 Fusion 模型专为**高价值、高风险或结果不确定**的关键任务设计。单模型可能在推理时不够深刻、在检索时记忆不足、在生成时文采平平,而 Fusion 模型通过多专家协同显著提升这类任务的一次性成功率,减少返工。 典型场景包括: | 场景 | 说明 | | - | - | | **深度研究与分析** | 复杂调研、深度报告生成等需要多角度知识覆盖的任务 | | **法律合同审查** | 条款风险识别容错率低,多模型交叉验证降低遗漏风险 | | **医疗初步分析** | 高风险领域,多专家会诊式推理提升结论可靠性 | | **Agent 关键决策步骤** | AI Agent 工作流中结果不确定、影响后续链路的关键节点 | | **复杂推理与代码分析** | 数学推理、架构设计评审等对准确性要求高的任务 | ## 工作原理 Fusion 模型的一次完整调用包含以下阶段: ![Fusion 模型工作原理](https://mintcdn.com/ppinfra/88JgeE1EDpRxnCfr/model/image/fusion-architecture.svg?fit=max\&auto=format\&n=88JgeE1EDpRxnCfr\&q=85\&s=0faea5a88ce37cf88a90cdb84c992f8a) 1. **请求分发**:您以 `pprouter/fusion` 为模型发起请求,网关将问题同时分发给参考模型面板。未指定自定义模型时,使用 PPIO 官方选定并持续调优的专家模型组合。 2. **并行作答**:各参考模型独立、并行地处理您的请求,互不干扰。 3. **思考编排与上下文压缩**:网关对多个模型的思考过程和答案进行编排与压缩,提炼共识、识别分歧、发现各自的盲区,同时控制传递给主模型的上下文规模。 4. **主模型融合作答**:主模型基于编排后的多方结果生成最终回复;如请求中携带工具定义,工具调用也由主模型在此阶段发起。 整个过程对开发者完全透明——您发出一次标准的 Chat Completions 请求,收到一次标准的响应,融合过程在网关内部完成。 ## 使用说明 Fusion 模型提供 OpenAI 兼容接口。您只需将 `base_url` 指向 PPIO 网关,并将 `model` 设置为 `pprouter/fusion`。 * **Base URL**:`https://api.ppio.com/openai` * **模型名称**:`pprouter/fusion` * **鉴权方式**:`Authorization: Bearer <您的 API Key>`(API Key 可在 PPIO 控制台创建) ### cURL ```bash theme={null} base_url="https://api.ppio.com/openai" api_key="<您的 API Key>" curl "$base_url/v1/chat/completions" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $api_key" \ -d @- << 'EOF' { "model": "pprouter/fusion", "messages": [ { "role": "user", "content": "Hi there!" } ], "response_format": { "type": "text" } } EOF ``` ### Python(OpenAI SDK) ```python theme={null} from openai import OpenAI base_url = "https://api.ppio.com/openai" api_key = "<您的 API Key>" model = "pprouter/fusion" client = OpenAI( base_url=base_url, api_key=api_key, ) stream = True # or False chat_completion_res = client.chat.completions.create( model=model, messages=[ { "role": "user", "content": "Hi there!", } ], stream=stream, ) if stream: for chunk in chat_completion_res: print(chunk.choices[0].delta.content or "", end="") else: print(chat_completion_res.choices[0].message.content) ``` ### JavaScript / Node.js(OpenAI SDK) ```javascript theme={null} const OpenAI = require("openai"); const baseURL = "https://api.ppio.com/openai"; const apiKey = "<您的 API Key>"; const model = "pprouter/fusion"; const openai = new OpenAI({ baseURL: baseURL, apiKey: apiKey, }); const stream = true; // or false async function run() { const completion = await openai.chat.completions.create({ messages: [ { role: "user", content: "Hi there!", }, ], model: model, stream, response_format: { type: "text" }, }); if (stream) { for await (const chunk of completion) { if (chunk.choices[0].finish_reason) { console.log(chunk.choices[0].finish_reason); } else { console.log(chunk.choices[0].delta.content); } } } else { console.log(JSON.stringify(completion)); } } run(); ``` ### 自定义模型 默认情况下,Fusion 使用 PPIO 配置的参考模型和融合主模型。您也可以在单次 Chat Completions 请求中,通过 `fusion` 字段指定本次请求使用的模型,无需修改服务端配置: ```json theme={null} { "model": "pprouter/fusion", "messages": [ { "role": "user", "content": "请从多个角度分析这份技术方案。" } ], "fusion": { "advisors": ["zai-org/glm-5.3-flash", "qwen/qwen3.8-flash"], "aggregator": "zai-org/glm-5.3" } } ``` 字段说明: | 字段 | 说明 | | - | - | | `fusion.advisors` | 参考模型列表,1–5 个非空模型名称。网关会并行调用这些模型。 | | `fusion.aggregator` | 融合主模型名称,负责基于参考模型结果生成最终回复。必须同时提供。 | 模型名称应填写 PPIO 模型服务支持的模型 ID,API Key 也必须有权限访问所选模型。 #### cURL ```bash theme={null} base_url="https://api.ppio.com/openai" api_key="<您的 API Key>" curl "$base_url/v1/chat/completions" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $api_key" \ -d @- << 'EOF' { "model": "pprouter/fusion", "messages": [ { "role": "user", "content": "请比较这两种实现方案的优缺点。" } ], "fusion": { "advisors": ["zai-org/glm-5.3-flash", "qwen/qwen3.8-flash"], "aggregator": "zai-org/glm-5.3" } } EOF ``` #### Python(OpenAI SDK) ```python theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai", api_key="<您的 API Key>", ) completion = client.chat.completions.create( model="pprouter/fusion", messages=[ { "role": "user", "content": "请比较这两种实现方案的优缺点。", } ], extra_body={ "fusion": { "advisors": ["zai-org/glm-5.3-flash", "qwen/qwen3.8-flash"], "aggregator": "zai-org/glm-5.3", } }, ) print(completion.choices[0].message.content) ``` `fusion` 是 PPIO Fusion 的请求级扩展字段,其他 OpenAI 请求参数(包括 `stream`、`tools`、`response_format` 等)仍按原有方式传递。省略 `fusion` 或将其设为 `null` 时,请求使用服务端默认模型配置。 > [!WARNING] > > `fusion.advisors` 和 `fusion.aggregator` 必须同时提供;advisor 数量必须为 1–5 个,且模型名称不能为空。否则请求返回 HTTP 400(`invalid_request_error`)。 ### 支持的能力 | 能力 | 支持情况 | | - | - | | 流式输出(`stream`) | ✅ 支持 | | 工具调用(`tools` / Function Calling) | ✅ 支持 | | 结构化输出(`response_format`) | ✅ 支持 | | 自定义参考模型与融合主模型 | ✅ 通过请求体顶层 `fusion` 字段指定 | ## 费用说明 Fusion 模型按**实际消耗汇总计费**: * 一次 Fusion 模型请求在网关内部会产生多次模型调用(多个参考模型的并行调用 + 主模型的融合作答)。 * 每次内部调用按对应模型自身的 token 单价计费,最终汇总为本次请求的总费用。 * 各模型的具体单价请以 [价格页面](https://ppio.com/model-api/pricing) 为准。 **成本预期**:由于涉及多个模型协同,单次 Fusion 模型请求的费用高于调用单个模型。但在复杂任务上,Fusion 模型以中低梯队的模型成本达到甚至超越头部旗舰模型的效果——以 DRACO 基准为例,Fusion 模型总成本仅为 Claude Fable 5 的约 1/10。同时,网关内置的上下文压缩机制会控制内部调用的 token 消耗,避免成本随模型数量线性膨胀。 **成本建议**: * 将 Fusion 模型用于高价值、高风险的关键步骤,而非全部请求; * 简单、高频的任务使用模型调度功能或直接调用轻量模型; * 通过 PPIO 控制台查看用量明细,持续监控实际消耗。 ## 常见问题 **Q1:每次调用 `pprouter/fusion` 都会触发多模型融合吗?** 是的。当前版本中,每次请求都会执行完整的多模型并行推理与融合流程,确保输出质量稳定。 **Q2:我可以指定参考模型面板中包含哪些模型吗?** 可以。在请求体顶层添加 `fusion` 字段,同时设置 `advisors` 和 `aggregator` 即可按请求覆盖模型名称。`advisors` 支持 1–5 个模型;两部分必须同时提供。未添加该字段时,使用 PPIO 官方配置的默认模型组合。 **Q3:Fusion 模型的响应延迟会比单模型高吗?** 会有一定增加。虽然参考模型是并行调用的,但融合流程包含“参考模型作答 → 思考编排 → 主模型作答”多个阶段,整体延迟高于单模型直接调用。因此 Fusion 模型更适合对结果质量敏感、对延迟相对宽容的场景;延迟敏感的高频任务建议使用模型调度功能。 **Q4:Fusion 模型既然内部调用多个模型,为什么说它性价比高?** Fusion 模型的对标对象是头部旗舰模型。在复杂任务上,直接使用旗舰模型价格昂贵;Fusion 模型用多个中低价位模型协同,达到甚至超越旗舰模型的效果,而总成本显著更低(DRACO 基准中约为 Claude Fable 5 的 1/10)。此外,上下文压缩与思考编排机制也在持续控制内部 token 消耗。 **Q5:现有基于 OpenAI SDK 的代码需要改造吗?** 不需要。Fusion 模型完全兼容 OpenAI Chat Completions 接口,只需将 `base_url` 改为 `https://api.ppio.com/openai`、`model` 改为 `pprouter/fusion` 即可。 **Q6:如何查看每次 Fusion 模型请求的实际费用?** 请登录 PPIO 控制台查看用量与账单明细。 # 快速上手使用模型 API 服务 Source: https://ppio.com/docs/model/get-start 按照 PPIO 模型 API 快速上手指南准备账户和调用配置,了解获取 API 密钥、选择模型与体验服务的流程,开始构建 AI 应用。 本教程带您从注册账号开始,完成第一次模型 API 调用。全程使用 curl 和 `deepseek/deepseek-v4-pro` 模型,在终端中完成。 **1. 注册账号并登录** 访问[注册页面](https://ppio.com/user/register),通过手机号或者账号的方式注册新账号,然后访问[登录页面](https://ppio.com/user/login)登录控制台。 **2. 完成实名认证** 访问[实名认证页面](https://ppio.com/account/verify),完成个人或者企业认证。部分模型要求实名认证后才能使用,详情请参见[实名认证](/docs/support/identity-verification)。 **3. 充值账户** 访问[账户概览页面](https://ppio.com/billing),完成账户充值。付款方式详情请参见[账户充值](/docs/support/payment-methods)。 **4. 创建 API 密钥** 访问[API 密钥管理页面](https://ppio.com/settings/key-management),单击「+创建」,输入密钥名称并选择有效期,然后单击「确认」。 > [!WARNING] > > API 密钥创建后无法再次查看,请立即保存。 **5. 把 API 密钥配置到环境变量** 在终端中执行以下命令,把 `sk_你的密钥` 替换为上一步保存的密钥: ```bash theme={null} export PPIO_API_KEY="sk_你的密钥" ``` 该命令只在当前终端会话生效。永久配置和 Windows 的设置方法参见[管理 API 密钥 — 环境变量配置](/docs/support/api-key#环境变量配置)。 到这一步,您已经拥有可用的 API 密钥,并且没有把它写进代码。 **6. 发送第一个请求** 在同一个终端中执行: ```bash theme={null} curl "https://api.ppio.com/openai/v1/chat/completions" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${PPIO_API_KEY}" \ -d '{ "model": "deepseek/deepseek-v4-pro", "messages": [ { "role": "system", "content": "您是一个专业的 AI 文档助手。" }, { "role": "user", "content": "PPIO 派欧云提供的 GPU 容器实例能用于哪些场景?" } ], "max_tokens": 512 }' ``` **7. 查看返回结果** 请求成功时,终端会输出一段 JSON。模型的回复在 `choices[0].message.content` 中,本次请求消耗的 Token 数在 `usage` 中。完整的响应字段说明参见[创建聊天对话请求](/docs/models/reference-llm-create-chat-completion)。 到这一步,您已经完成了第一次模型 API 调用。 ## 下一步 * 了解大语言模型的能力和选型方法,查看 Python 等更多调用示例:[大语言模型](/docs/model/llm) * 查看平台支持的模型列表:[大语言模型服务页面](https://ppio.com/model-api/product/llm-api) * 查看全部请求参数,或在页面上单击「Try it」在线调用:[模型服务 API 手册](/docs/models/reference-authentication) # 推理模型 Source: https://ppio.com/docs/model/inference 了解通过 PPIO 接入推理模型的使用方式与应用方向,查阅模型接入相关说明,为复杂问题处理与智能体工作流选择适合的推理服务。 ## 功能介绍 推理模型是针对复杂问题解决和推理任务优化的高级语言模型,通过输出详细的推理步骤(思维链)提升问题求解的准确性。 ### 典型应用场景 * **复杂问题解决**:适用于需要逐步推导、明确逻辑步骤的场景,例如数学、科学推理。 * **决策支持系统**:提供详细推理过程支持决策分析,帮助理解决策背后的逻辑。 * **教育和培训**:帮助用户学习和理解复杂知识,提供详细的推导过程。 ## 安装与准备 在使用推理模型前,请确保已安装最新版本的 OpenAI SDK: ```bash theme={null} pip install -U openai ``` ## API 调用方法 通过调用 `/chat/completions` 接口使用推理模型。 ### 请求参数说明 * `max_tokens`:设置模型输出的最大 token 数。 * `temperature`:建议设置为 0.5 至 0.7(推荐 0.6),以平衡输出的创造性与逻辑性。 * `top_p`:建议设置为 0.95。 ### 示例请求代码 #### 流式输出请求 ```python theme={null} from openai import OpenAI client = OpenAI(api_key="YOUR_API_KEY", base_url="https://api.ppio.com/openai") messages = [ {"role": "user", "content": "解释一下牛顿第二定律。"} ] response = client.chat.completions.create( model="deepseek/deepseek-v4-pro", messages=messages, stream=True, max_tokens=4096 ) content = "" reasoning_content = "" for chunk in response: if chunk.choices[0].delta.content: content += chunk.choices[0].delta.content if chunk.choices[0].delta.reasoning_content: reasoning_content += chunk.choices[0].delta.reasoning_content print("最终回答:", content) print("推理过程:", reasoning_content) ``` #### 非流式输出请求 ```python theme={null} response = client.chat.completions.create( model="deepseek/deepseek-v4-pro", messages=[ {"role": "user", "content": "什么是温室效应?如何减缓?"} ], stream=False, max_tokens=4096 ) content = response.choices[0].message.content reasoning_content = response.choices[0].message.reasoning_content print("最终回答:", content) print("推理过程:", reasoning_content) ``` ## 上下文管理 模型返回的推理内容不会自动拼接到下一轮对话中,需手动管理对话历史: ```python theme={null} messages.append({"role": "assistant", "content": content}) messages.append({"role": "user", "content": "继续解释一下解决方案。"}) ``` ## 支持模型列表 PPIO 平台当前支持以下推理模型: ## 计费方式 * 根据输入和输出的 token 数进行计费。 * 具体计费标准及转换规则,请在模型详情页查询。 ## 注意事项与最佳实践 * 不要在 `system` 消息中添加推理指令,应在 `user` 消息中直接明确指令。 * 在数学问题中明确指出要求,例如:「请逐步推理并明确最终答案。」 * 为避免模型跳过推理环节,建议强制模型在输出前添加换行符。 # 大语言模型 Source: https://ppio.com/docs/model/llm 了解 PPIO 大语言模型服务的能力与使用方向,查阅文本生成、语言理解和代码相关应用的说明,为构建 AI 原生应用选择模型能力。 ## 模型能力 大语言模型(LLM)是一种基于深度学习和自然语言处理技术的人工智能模型。经过大量文本数据训练,它能够理解、生成和处理人类语言。主要具备以下能力: * **文本生成** 能够基于上下文生成逻辑连贯的文本内容,并根据需要调整输出风格。 * **语言理解** 能够准确理解输入文本的含义,并支持结合上下文进行对话。 * **文本翻译** 具备跨语言生成和理解的能力,可以实现不同语言之间的文本翻译。 * **知识问答** 具有丰富的知识储备,能够回答文化、科学、历史等各个领域的问题。 * **代码理解和生成** 能够理解并生成代码(如 Python、Java、C++ 等),支持识别代码错误,提供代码建议等。 * **文本分类和摘要** 能够理解复杂语句,进行信息分类和抽取,可以提取文本的关键点进行自动摘要。 ## 模型选型 在[大语言模型服务](https://ppio.com/model-api/product/llm-api)页面,您可以查看平台支持的大语言模型列表,了解模型的基本介绍、价格等信息。单击具体的某一个模型,可以打开详情页面,查看模型介绍、参数说明与调用方式。在了解各模型的能力差异后,您可以对比模型表现,选择适合的模型。 ## 接口调用 PPIO 派欧云提供了与 OpenAI API 标准兼容的 API 服务,方便您集成到现有应用程序中。 * [ChatCompletion](https://platform.openai.com/docs/api-reference/chat),支持 streaming 模式和常规模式。 * [Completion](https://platform.openai.com/docs/api-reference/completions),支持 streaming 模式和常规模式。 如果您已经在使用 OpenAI 的 ChatCompletion 或 Completion API,您只需将基础 URL 设置为`https://api.ppio.com/openai`,获取并设置您的 API 密钥,并按需更新模型名称,即可接入大语言模型 API 服务。 > [!TIP] > > 关于如何获取 API 密钥,请参见[管理 API 密钥](/docs/support/api-key)。 ### 代码示例 #### Python ```python ChatCompletion theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai", api_key="", ) model = "deepseek/deepseek-v4-pro" stream = True # 或 False max_tokens = 512 chat_completion_res = client.chat.completions.create( model=model, messages=[ { "role": "system", "content": "您是一个专业的 AI 文档助手。", }, { "role": "user", "content": "PPIO 派欧云提供的 GPU 容器实例能用于哪些场景?", } ], stream=stream, max_tokens=max_tokens, ) if stream: for chunk in chat_completion_res: print(chunk.choices[0].delta.content or "", end="") else: print(chat_completion_res.choices[0].message.content) ``` ```python Completion theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai", api_key="", ) model = "deepseek/deepseek-v4-pro" stream = True # 或 False max_tokens = 512 completion_res = client.completions.create( model=model, prompt="PPIO 派欧云提供的 GPU 容器实例能用于哪些场景?", stream=stream, max_tokens=max_tokens, ) if stream: for chunk in completion_res: print(chunk.choices[0].text or "", end="") else: print(completion_res.choices[0].text) ``` #### Curl ```bash ChatCompletion theme={null} export API_KEY="" curl "https://api.ppio.com/openai/v1/chat/completions" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${API_KEY}" \ -d '{ "model": "deepseek/deepseek-v4-pro", "messages": [ { "role": "system", "content": "您是一个专业的 AI 文档助手。" }, { "role": "user", "content": "PPIO 派欧云提供的 GPU 容器实例能用于哪些场景?" } ], "max_tokens": 512 }' ``` ```bash Completion theme={null} export API_KEY="" curl "https://api.ppio.com/openai/v1/completions" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${API_KEY}" \ -d '{ "model": "deepseek/deepseek-v4-pro", "prompt": "PPIO 派欧云提供的 GPU 容器实例能用于哪些场景?", "max_tokens": 512 }' ``` ### 请求参数 全部请求参数参见 API 手册:[创建聊天对话请求](/docs/models/reference-llm-create-chat-completion)(ChatCompletion)、[创建对话请求](/docs/models/reference-llm-create-completion)(Completion)。以下是 API 手册之外的使用建议: * `messages` 中 `system` 角色的消息用于设定模型的角色和行为,`user` 角色的消息是用户的输入。 * `messages` 中 `assistant` 角色的消息除了表示模型生成的回复,也可以由用户预先填写示例,告知模型应该如何回应当前请求。 * `max_tokens`:如果模型生成的 Token 数超过 `max_tokens` 的值,会返回截断后的内容。 * `stream`:对于一些输出内容比较多的模型,建议设置为流式输出,防止输出过长,导致输出超时。 # 兼容 Anthropic SDK Source: https://ppio.com/docs/model/llm-anthropic-compatibility 查阅 PPIO 模型服务兼容 Anthropic SDK 的接入说明,了解客户端配置与调用方式,为现有应用连接模型服务提供集成参考。 PPIO 派欧云提供与 Anthropic SDK 兼容的 API 服务,方便您集成到现有应用程序中。如果您已经使用 Anthropic SDK 开发了应用程序,只需要将 base URL 和 API Key 替换为 PPIO 派欧云的 API 地址和 API Key 即可。请参考下面的接入指南。 ## 支持的模型 目前只有以下模型提供 Anthropic SDK 兼容性支持: ## 快速开始 **1. 安装 Anthropic SDK** ```bash Python icon="python" theme={null} pip install anthropic ``` ```bash TypeScript icon="js" theme={null} npm install @anthropic-ai/sdk ``` **2. 初始化客户端** Anthropic SDK 会尝试从环境变量 `ANTHROPIC_API_KEY` 和 `ANTHROPIC_BASE_URL` 中分别获取 API Key 和 base URL。您也可以在初始化客户端时通过参数指定。 > [!TIP] * 基于环境变量设置 ```bash Bash icon="terminal" theme={null} export ANTHROPIC_BASE_URL="https://api.ppio.com/anthropic" export ANTHROPIC_API_KEY="" ``` * 通过在初始化 Anthropic 客户端时设置参数 ```python Python icon="python" theme={null} import anthropic client = anthropic.Anthropic( base_url="https://api.ppio.com/anthropic", api_key="", # 重写 header default_headers={ "Content-Type": "application/json", "Authorization": "Bearer ", } ) ``` ```typescript TypeScript icon="js" theme={null} import Anthropic from "@anthropic-ai/sdk"; const anthropic = new Anthropic({ baseURL: "https://api.ppio.com/anthropic", apiKey: "", // 重写 header defaultHeaders: { "Content-Type": "application/json", Authorization: `Bearer `, } }); ``` **3. 调用 API** ```python Python icon="python" theme={null} import anthropic # 初始化客户端,如果您已经通过环境变量 `ANTHROPIC_BASE_URL` 和 `ANTHROPIC_API_KEY` # 设置了 API Key 和 base URL,可以省略 `api_key` 和 `base_url` 参数。 client = anthropic.Anthropic( base_url="https://api.ppio.com/anthropic", api_key="", # 重写 header default_headers={ "Content-Type": "application/json", "Authorization": "Bearer ", } ) message = client.messages.create( model="moonshotai/kimi-k3.1-pro", max_tokens=1000, temperature=1, system=[ { "type": "text", "text": "你是 PPIO派欧云 AI 助手,你会以诚实专业的态度帮助用户,用中文回答问题。" } ], messages=[ { "role": "user", "content": [ { "type": "text", "text": "你是谁?" } ] } ] ) print(message.content) ``` ```typescript TypeScript icon="js" theme={null} import Anthropic from "@anthropic-ai/sdk"; // 初始化客户端,如果您已经通过环境变量 `ANTHROPIC_BASE_URL` 和 `ANTHROPIC_API_KEY` // 设置了 API Key 和 base URL,可以省略 `baseURL` 和 `apiKey` 参数。 const anthropic = new Anthropic({ baseURL: "https://api.ppio.com/anthropic", apiKey: "", // 重写 header defaultHeaders: { "Content-Type": "application/json", Authorization: `Bearer `, }, }); const msg = await anthropic.messages.create({ model: "moonshotai/kimi-k3.1-pro", max_tokens: 1000, temperature: 1, system: "你是 PPIO派欧云 AI 助手,你会以诚实专业的态度帮助用户,用中文回答问题。", messages: [ { role: "user", content: [ { type: "text", text: "你是谁?" } ] } ] }); console.log(msg); ``` # 大语言模型监控 Source: https://ppio.com/docs/model/llm-api-metrics 了解 PPIO LLM API 的监控指标及其含义,查看请求、Token 使用和响应表现等数据,为模型服务运行观察与调用排查提供参考。 PPIO 派欧云为大语言模型 API 使用提供了全面的监控指标。这些指标让您能够深入了解 LLM API 请求的可用性和性能。 您可以通过 [大语言模型(LLM)监控页面](https://ppio.com/model-api/console/llm-metrics) 查看监控指标。 ## 指标说明 > [!NOTE] > > 以下所有指标均按**模型划分维度**,并以**分钟级别**进行采样,但根据您选择的时间间隔,采样点可能不会每分钟都显示。在这种情况下,该时间间隔内的采样点将被平均后显示。 * **每分钟请求数 (RPM)** 显示每分钟发出的 API 请求数量,帮助您了解使用模式和 API 并发级别。 * **请求成功率** 显示每分钟成功 API 响应(非 5xx 状态码)的百分比,反映 API 的可用性。 * **每个请求的平均 Token 数量** 显示每分钟每个请求的平均输入和输出 Token 数量,有助于了解 Token 消耗模式。 * **端到端(E2E)延迟** 显示模型在每分钟请求中生成完整响应所需的总时间。包括 99 分位、95 分位和平均的延迟指标。 * **生成第一个 Token 的时间 (TTFT)** > [!NOTE] > > 该指标仅在启用 `stream=true` 参数的流式请求中进行跟踪。 显示每分钟请求中处理 Prompt 并生成第一个输出 Token 所需的时间。包括 99 分位、95 分位和平均的延迟指标。 * **每个输出 Token 的时间 (TPOT)** > [!NOTE] > > 该指标仅在启用 `stream=true` 参数的流式请求中进行跟踪。 显示每分钟请求中连续输出 token 之间的平均时间。包括 99 分位、95 分位和平均的延迟指标。 # 批量推理 Source: https://ppio.com/docs/model/llm-batch-api 查阅 PPIO 大语言模型批量推理的使用方式,了解异步处理推理请求的流程,为组织批量任务与管理调用结果提供参考。 大语言模型批量推理 API 支持异步处理大量推理请求,完全兼容 OpenAI API 标准。 批量推理 API 是在不需要立即获得推理结果时的经济高效解决方案。它提供比在线调用更高的速率限制,确保在 48 小时的合理时间范围内交付结果。 此 API 非常适用于: * 进行评估和数据分析 * 对大量数据集进行分类 * 以离线模式生成文档摘要 支持的模型: ## 快速开始 **1. 准备批量文件** 批量推理 API 使用 .jsonl 格式文件作为输入,每行代表一个 API 推理请求的详细信息。可用的 endpoint 包括 `/v1/chat/completions` 和 `/v1/completions`。 > [!WARNING] > > 为了与 OpenAI API 兼容,请将 `endpoint` 参数设置为 `/v1/chat/completions` 或 `/v1/completions`。 每个请求都必须包含一个唯一的 `custom_id`,以便在批量完成后在输出文件中定位推理结果。每行的 `body` 字段中的参数将作为实际推理请求参数发送到 endpoint。 > [!WARNING] > > 单个 JSONL 文件中的所有请求必须使用同一个模型,请不要在一个批次中混合不同模型的请求。 以下是包含 2 个请求的示例输入文件: ```JSON theme={null} {"custom_id": "request-1", "body": {"model": "deepseek/deepseek-v3-0324", "messages": [{"role": "user", "content": "Hello, world!"}], "max_tokens": 400}} {"custom_id": "request-2", "body": {"model": "deepseek/deepseek-v3-0324", "messages": [{"role": "system", "content": "You are a helpful assistant."},{"role": "user", "content": "Hello world!"}],"max_tokens": 1000}} ``` **2. 上传批量输入文件** 上传批量输入文件,以便在创建批量任务时能够正确引用它。使用文件 API 上传您的 .jsonl 文件,并将 purpose 设置为 `batch`。请注意,该文件将保留 15 天。 > [!TIP] > > 关于如何获取 API 密钥,请参见[管理 API 密钥](/docs/support/api-key)。 代码示例 **Python** ```python theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai/v1", api_key="", ) batch_input_file = client.files.create( file=open("batch_input.jsonl", "rb"), purpose="batch", ) print(batch_input_file) ``` **Curl** ```bash theme={null} export API_KEY="" curl --request POST \ --url https://api.ppio.com/openai/v1/files \ --header 'Authorization: Bearer ${API_KEY}' \ --form 'file=@"/your/batch_input.jsonl"' \ --form 'purpose="batch"' ``` 成功上传文件后的示例响应: ``` { "id": "file_d2co***as73c0cjd0", "object": "file", "bytes": 238, "filename": "batch_input.jsonl", "created_at": 1754894162, "purpose": "batch", "metadata": { "total_requests": 2 } } ``` **3. 创建批量任务** 成功上传输入文件后,您可以使用上传的文件对象的 ID 启动批量任务。完成时间窗口固定为 `48h`,目前不可调整。 代码示例 **Python** ```python theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai/v1", api_key="", ) batch = client.batches.create( input_file_id="file_d2cor0es1cas73c0cj60", endpoint="/v1/chat/completions", completion_window="48h" ) print(batch) ``` **Curl** ```bash theme={null} export API_KEY="" curl --request POST \ --url https://api.ppio.com/openai/v1/batches \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ${API_KEY}' \ --data '{ "input_file_id": "file_d2co***as73c0cjd0", "endpoint": "/v1/chat/completions", "completion_window": "48h" }' ``` 此请求将返回一个包含您的批量任务元数据的 Batch 对象,如下面的示例所示: ```JSON theme={null} { "id": "batch_d2cq***73a68lu0", "object": "batch", "endpoint": "/v1/chat/completions", "input_file_id": "file_d2co***as73c0cjd0", "output_file_id": "", "error_file_id": "", "completion_window": "48h", "in_progress_at": null, "expires_at": null, "finalizing_at": null, "completed_at": null, "failed_at": null, "expired_at": null, "cancelling_at": null, "cancelled_at": null, "status": "validating", "errors": "", "version": 0, "created_at": "2025-08-11T16:31:52.949816948+08:00", "updated_at": null, "created_by": "8f242aa1-f725-4a67-8***9-cb68025e0976", "created_by_key_id": "key_cc19f96c***e7390644a37da21", "remark": "", "total": 0, "completed": 0, "failed": 0, "metadata": null, "request_counts": { "total": 0, "completed": 0, "failed": 0 } } ``` **4. 检查批量任务状态** 您可以随时检查批量任务的状态以获取最新的批量信息。 Batch 对象的状态枚举值如下:
状态 描述
VALIDATING 批量任务开始前正在验证输入文件
PROGRESS 批量任务正在进行中
COMPLETED 批量处理成功完成
FAILED 批量处理失败
EXPIRED 批量任务超过截止时间
CANCELLING 批量任务正在取消中
CANCELLED 批量任务已取消
代码示例 **Python** ```python theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai/v1", api_key="", ) batch = client.batches.retrieve("batch_d2cq***73a68lu0") print(batch) ``` **Curl** ```bash theme={null} export API_KEY="" curl --request GET \ --url https://api.ppio.com/openai/v1/batches/{batch_id} \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ${API_KEY}' ``` **5. 获取结果** 批量推理完成后,您可以使用 Batch 对象中的 `output_file_id` 字段下载结果输出文件。 结果输出文件将在批量推理结束后 30 天删除,请及时通过接口获取。 代码示例 **Python** ```python theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai/v1", api_key="", ) content = client.files.content("example-250811-1") print(content.read()) ``` **Curl** ```bash theme={null} export API_KEY="" curl --request GET \ --url https://api.ppio.com/openai/v1/files/{file_id}/content \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ${API_KEY}' ``` 响应返回原始文件内容。对于批量输出文件,每行包含如下响应: ```json theme={null} { "custom_id": "request-2589", "error": null, "id": "batch_req_task_d2c", "response": { "body": { "id": "29e1432c-edfb-44a4-b531-c23c600abfae", "object": "chat.completion", "created": 1754902266, "model": "deepseek-test", "choices": [ { "index": 0, "message": { "role": "assistant", "content": "Hello! 👋 How can I assist you today? 😊" }, "finish_reason": "stop" } ], "usage": { "prompt_tokens": 5, "completion_tokens": 13, "total_tokens": 18 } }, "request_id": "request-2589", "status_code": 200 } } ``` ## 使用说明 ### 限制 1. 每个批量任务最多可包含 50,000 个请求。\ 2. 每个批量任务的最大输入文件大小为 100MB。 ### 错误处理 批量处理过程中遇到的错误记录在单独的错误文件中,可通过 error_file_id 字段访问。常见的错误代码包括:
错误代码 描述 解决方案
400 请求格式无效 检查 JSONL 语法和必需字段
401 身份验证失败 验证 API 密钥
404 未找到批量任务 检查批量任务 ID
429 超过速率限制 降低请求频率
500 服务器错误 联系我们
### 批量任务过期 未在 48 小时内完成的批量任务将转换为 EXPIRED 状态。未完成的请求将被取消,而已完成的请求将通过输出文件提供。您只需为已完成请求消耗的令牌付费。批量任务会尽力在 48 小时内完成。 ## 所有批量推理 API 1. [创建批处理任务](/docs/models/reference-llm-create-batch) 2. [查询批处理任务](/docs/models/reference-llm-retrieve-batch) 3. [取消批处理任务](/docs/models/reference-llm-cancel-batch) 4. [查询批处理任务列表](/docs/models/reference-llm-list-batches) 5. [上传文件](/docs/models/reference-llm-upload-batch-input-file) 6. [查询文件列表](/docs/models/reference-llm-list-files) 7. [查询文件](/docs/models/reference-llm-query-file) 8. [删除文件](/docs/models/reference-llm-delete-file) 9. [查询文件内容](/docs/models/reference-llm-retrieve-file-content) # LLM API 计费说明 Source: https://ppio.com/docs/model/llm-billing 了解 PPIO LLM API 的计费方式和请求状态对应的费用规则,查阅断连等场景的计费说明,为模型调用成本核对与预算管理提供参考。 ## 计费方式 PPIO LLM API 采用 **按 Token 用量计费** 的方式。每次 API 调用的费用由以下两部分组成: * **输入 Token(Input Tokens)**:您发送给模型的 prompt 内容所消耗的 token 数 * **输出 Token(Output Tokens)**:模型生成的响应内容所消耗的 token 数 最终费用 = 输入 Token 数 × 输入单价 + 输出 Token 数 × 输出单价 > [!NOTE] > > 不同模型的 Token 单价不同,请参阅 [模型定价页面](https://ppio.com/pricing) 查看各模型的具体价格。 ## HTTP 状态码 以下为 API 请求可能返回的 HTTP 状态码及对应说明: | HTTP 状态码 | 名称 | 说明 | 是否计费 | | :- | :- | :- | :- | | 200 | 请求成功 | 请求正常处理并返回结果 | **计费** | | 400 | Bad Request | 请求参数不正确,请检查请求格式、字段名称或取值范围 | 不计费 | | 401 | Unauthorized | API Key 设置不正确或未设置 | 不计费 | | 403 | Forbidden | 权限不足,账户可能无权访问特定模型或需完成身份认证 | 不计费 | | 429 | Rate Limited | 触发了速率限制(TPM 或 RPM 超限) | 不计费 | | 499 | Client Disconnected | 用户主动断开连接 | [**计费**](#499-断连计费规则) | | 500 | Internal Server Error | 服务器内部错误 | 不计费 | | 503 | Service Unavailable | 服务不可用,服务端过载或下游服务故障 | 不计费 | | 504 | Gateway Timeout | 网关超时 | 不计费 | **计费原则:** * 请求未到达模型(如参数错误、认证失败、限流等):**不计费** * 平台原因返回报错(500/503/504):**不计费**,平台承担 * 请求成功到达模型并开始推理(200/499):**全额计费** ## 499 断连计费规则 当用户主动断开连接(HTTP 499)时,模型可能已在服务端执行推理并产生了资源消耗。计费规则如下: | 请求模式 | 计费规则 | | :- | :- | | Non-Stream(非流式) | 全额计费,不论何时断开 | | Stream(流式) | 全额计费,不论何时断开 | 当请求已发送至模型并开始推理后,无论用户在何时断开连接,均按**全额计费**。 > [!TIP] > > **最佳实践** > > * 合理设置 `max_tokens` 参数控制最大生成长度,避免不必要的 token 消耗 > * 如需中途停止生成,建议使用 `max_tokens` 做预先控制,而非直接断开连接 > * 合理设置客户端超时时间(建议 ≥ 60 秒),避免因超时导致的意外断连 ## 常见问题 > [accordion] 为什么断开连接后还会被收费? > > 当请求到达模型后,模型在服务端执行推理会消耗计算资源。即使客户端断开连接,已经产生的计算消耗仍然存在,因此按全额计费。 > [accordion] 如何避免产生 499 费用? > > 建议通过 `max_tokens` 参数预先限制生成长度,而不是中途断开连接。如果您的业务场景需要灵活控制输出长度,这是最有效的方式。 > [accordion] 账单中如何查看 499 请求的费用? > > 499 请求会和正常请求一样出现在您的用量明细中,标记为消耗的 token 数量。 # DeepSeek-OCR 使用 Source: https://ppio.com/docs/model/llm-deepseek-ocr 查阅在 PPIO 使用 DeepSeek-OCR 的指南,了解文档识别相关模型的调用方式与操作示例,为构建文档处理流程提供参考。 ## 功能介绍 DeepSeek-OCR 聚焦于文档识别及图像转文本场景,探索视觉与文本压缩的极限。该模型可将长文本渲染为高压缩比图像,在 10 倍无损压缩下能实现 97% 的 OCR 准确率,即使压缩到 20 倍也能保持约 60% 的准确率。**需要注意的是,该模型仅支持单轮独立识别任务,暂不支持多轮对话,每次仅能上传一张图像,需使用预设提示词调用以获得最佳效果**。 ## 推荐的预设提示词 ```bash theme={null} # 将文档内容转换为 markdown 格式 <|grounding|>Convert the document to markdown. # 对该图像进行文本识别 <|grounding|>OCR this image. # 不考虑版式,直接提取所有文本 Free OCR. # 解析文档中的图形或表格内容 Parse the figure. # 详细描述图片内容 Describe this image in detail. # 在图像中定位 <|ref|>xxxx<|/ref|> 的位置 Locate <|ref|>xxxx<|/ref|> in the image. ``` ## 调用示例 以使用 `<|grounding|>OCR this image.` 预设提示词完成图像文本识别为例 ```python theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai", api_key="", ) response = client.chat.completions.create( model="deepseek/deepseek-ocr", messages=[ { "role": "user", "content": [ { "type": "image_url", "image_url": { "url": "https://example.com/image.png" } }, { "type": "text", "text": "<|grounding|>OCR this image." } ] } ], stream=False, max_tokens=4096 ) content = response.choices[0].message.content print(content) ``` 示例图片 ![OCR 图片](https://mintcdn.com/ppinfra/pHYssb3U2Vr4mh_4/images/guide/ocr_input.jpg?fit=max\&auto=format\&n=pHYssb3U2Vr4mh_4\&q=85\&s=19df7eda9040e50fb22fe8c0d15ff6c9) 示例输出 ``` <|/ref|><|det|>[[33, 116, 228, 212]]<|/det|> <|ref|>BaseURL:<|/ref|><|det|>[[34, 105, 227, 209]]<|/det|> <|ref|>https://api.ppio.com/openai<|/ref|><|det|>[[335, 103, 888, 215]]<|/det|> <|ref|>API Endpoints:<|/ref|><|det|>[[34, 336, 302, 449]]<|/det|> <|ref|>/v1/chat/completions<|/ref|><|det|>[[353, 347, 682, 427]]<|/det|> <|ref|>Model ID:<|/ref|><|det|>[[37, 563, 208, 661]]<|/det|> <|ref|>deepseek/deepseek-ocr<|/ref|><|det|>[[331, 575, 781, 665]]<|/det|> <|ref|>API Key:<|/ref|><|det|>[[32, 779, 190, 899]]<|/det|> <|ref|>创建&查询您的APIEy<|/ref|><|det|>[[334, 780, 771, 896]]<|/det|> ``` # 工具调用(Function Calling) Source: https://ppio.com/docs/model/llm-function-calling 了解 PPIO 模型工具调用的使用方式,查阅 Function Calling 的接入流程,为连接外部工具、处理工具结果与组织 Agent 任务提供参考。 ## 使用场景 Function Calling 功能让模型可以与外部工具进行交互,获取实时信息或执行特定操作。这一功能提升了数据准确性,同时扩展了模型能力,使模型不仅能生成文本,还能支持更具动态性和实用性的应用场景。 Function Calling 的使用场景示例如下: * **动态信息查询**:通过调用 API 从外部系统实时获取天气、新闻资讯、股票行情等动态数据。例如,调用天气 API 获取实时天气信息,当用户询问当前天气时,模型可以告诉用户此时此刻的天气状况,而不是提供过时的天气预报。 * **任务操作自动化**:通过函数调用执行特定操作,用户可以通过对话触发后台进行自动化操作。例如,调用订票网站 API 预定门票,当用户咨询如何购买某一景点的门票时,模型不再只是告诉用户如何订票,而是可以帮助用户直接完成订票操作。 ## 支持的模型 以下模型支持 Function Calling: ## 使用方法 1. 定义模型要调用的工具函数。 2. 在请求中添加 `tools` 参数,定义模型要使用的函数。 ## 使用示例 下文提供了完整的 Python 代码示例,以查询某一地点的当前天气为例,演示如何使用 Function Calling。 对于 Function Calling 的具体 API 格式,请参考[创建聊天对话请求 API ](/docs/models/reference-llm-create-chat-completion)。 **1. 初始化客户端** 您需要使用您的 PPIO 派欧云 API 密钥初始化客户端。 ```python theme={null} from openai import OpenAI import json client = OpenAI( base_url="https://api.ppio.com/openai", api_key="", ) model = "deepseek/deepseek-v4.1-flash" ``` **2. 定义要调用的函数** 定义模型要调用的函数。以下 Python 示例演示了获取天气信息的功能。 ```python theme={null} # 示例函数,用于模拟获取天气数据。 def get_weather(location): """获取指定地点的当前天气""" print("调用 get_weather 函数,位置: ", location) # 在实际应用中,您需要在这里调用外部天气 API。 # 这是一个简化示例,返回硬编码数据。 return json.dumps({"位置": location, "温度": "20 摄氏度"}) ``` **3. 构造包含工具和用户消息的 API 请求** 创建 API 调用请求。此请求包括 `tools` 参数,定义模型要使用的函数,以及用户的消息。 ```python theme={null} tools = [ { "type": "function", "function": { "name": "get_weather", "description": "获取一个地点的天气,用户需要首先提供地点", "parameters": { "type": "object", "properties": { "location": { "type": "string", "description": "城市信息, 例如:上海", } }, "required": ["location"] }, } }, ] messages = [ { "role": "user", "content": "上海的天气怎么样?" } ] # 发送请求并打印响应 response = client.chat.completions.create( model=model, messages=messages, tools=tools, ) # 请在生产环境中检查响应是否包含工具调用 tool_call = response.choices[0].message.tool_calls[0] print(tool_call.model_dump()) ``` **输出**: ```js theme={null} {'id': '0', 'function': {'arguments': '{"location": "上海"}', 'name': 'get_weather'}, 'type': 'function'} ``` **4. 根据函数调用结果进行响应并获取最终答案** 接下来处理函数调用,执行 `get_weather` 函数,并将结果发送回模型以生成最终响应给用户。 ```python theme={null} # 确保工具调用已从上一步定义 if tool_call: # 扩展对话历史记录,添加助手工具调用消息 messages.append(response.choices[0].message) function_name = tool_call.function.name if function_name == "get_weather": function_args = json.loads(tool_call.function.arguments) # 执行函数并获取响应 function_response = get_weather( location=function_args.get("location")) # 将函数响应添加到消息中 messages.append( { "tool_call_id": tool_call.id, "role": "tool", "content": function_response, } ) # 从模型获取最终响应,包含函数结果 answer_response = client.chat.completions.create( model=model, messages=messages, # 注意:不要在此处包含 tools 参数 ) print(answer_response.choices[0].message) ``` **输出**: ``` ChatCompletionMessage(content="上海目前的温度是 20 摄氏度。请注意,天气情况可能会随时变化,建议您查看最新的天气预报以获取更准确的信息。", refusal=None, role='assistant', function_call=None, tool_calls=None) ``` ## 完整代码 ```python theme={null} from openai import OpenAI import json client = OpenAI( base_url="https://api.ppio.com/openai", api_key="", ) model = "deepseek/deepseek-v4.1-flash" # 示例函数,用于模拟获取天气数据。 def get_weather(location): """获取指定地点的当前天气""" print("调用 get_weather 函数,位置: ", location) # 在实际应用中,您需要在这里调用外部天气 API。 # 这是一个简化示例,返回硬编码数据。 return json.dumps({"位置": location, "温度": "20 摄氏度"}) tools = [ { "type": "function", "function": { "name": "get_weather", "description": "获取一个地点的天气,用户需要首先提供地点", "parameters": { "type": "object", "properties": { "location": { "type": "string", "description": "城市信息, 例如:上海", } }, "required": ["location"] }, } }, ] messages = [ { "role": "user", "content": "上海的天气怎么样?" } ] # 发送请求并打印响应 response = client.chat.completions.create( model=model, messages=messages, tools=tools, ) # 请在生产环境中检查响应是否包含工具调用 tool_call = response.choices[0].message.tool_calls[0] print(tool_call.model_dump()) # 确保工具调用已从上一步定义 if tool_call: # 扩展对话历史记录,添加助手工具调用消息 messages.append(response.choices[0].message) function_name = tool_call.function.name if function_name == "get_weather": function_args = json.loads(tool_call.function.arguments) # 执行函数并获取响应 function_response = get_weather( location=function_args.get("location")) # 将函数响应添加到消息中 messages.append( { "tool_call_id": tool_call.id, "role": "tool", "content": function_response, } ) # 从模型获取最终响应,包含函数结果 answer_response = client.chat.completions.create( model=model, messages=messages, # 注意:不要在此处包含 tools 参数 ) print(answer_response.choices[0].message) ``` # Interleaved Thinking 支持 Source: https://ppio.com/docs/model/llm-interleaved-thinking 查阅 PPIO 对 Interleaved Thinking 的支持与使用说明,了解工具调用和模型思考之间的配合方式,为多步骤智能体工作流提供参考。 > 更新时间:2025-12-03 \ > 状态:已支持(兼容 OpenAI) ## 介绍 Interleaved Thinking 是一种推理框架,使模型能够在每次调用工具前后进行显式思考和决策。具备 Interleaved Thinking 能力的模型可以: * 针对当前环境和工具的输出进行反思 * 基于最新的推理结果决定下一步行动 * 在多次工具调用过程中持续保持连贯的推理链路 * 通过 `reasoning_details` 或 `reasoning_content` 字段透明展示多步推理过程,便于跟踪和审查 这种能力将传统的函数调用模式提升为具备智能代理特征的工具使用方式,使复杂工作流程更加精准、可靠,并具备更强的上下文感知能力。 > [!NOTE] > > 本页讲的是如何在多次工具调用之间保持推理连贯;如果您需要的是开关思考模式本身或调整思考强度,请参考[思考模式(Thinking Mode)](/docs/model/llm-thinking-mode)。 ## 重要概念 ### 交替推理 传统方法先进行一次推理再调用工具,而交替推理则采用如下流程: ```BASH theme={null} 推理 → 工具调用 → 观察 → 推理 → 工具调用 → ... ``` 这种方式使模型可以根据前一步工具返回的结果,动态调整后续策略。 ### 推理详情(`reasoning_details`) 对于部分模型,模型思考内容会以单独结构体的形式返回: ```JSON theme={null} "reasoning_details": [ { "type": "reasoning.text", "format": "openai-responses-v1", "text": "Model’s step-by-step reasoning..." } ] ``` 对于此类模型,支持在流式和非流式模式下返回该字段。 ### 对话记忆 为保持推理链路的一致性,必须在后续请求中完整携带模型的全部响应,包括 `reasoning_details`、`tool_calls` 以及 `content` 字段。如果未能持续传递这些信息,可能会导致: * 工具调用不正确 * 推理上下文丢失 * 工具调用递归或重复 * 可靠性下降 这一要求与 OpenAI 推理型接口的行为规范一致。 ## API 行为 ### 请求格式 用户侧无需做任何更改。Interleaved Thinking 支持标准的 OpenAI 兼容 Chat Completions API。 ### 响应格式 模型响应中可能包含以下字段: * `reasoning_content`:原始思考内容 * `reasoning_details`:结构化推理片段,该字段为可选项 * `tool_calls`:工具调用计划 * `content`:自然语言输出 这些字段扩展了标准的 OpenAI 格式。 ## 示例请求(MiniMax-M3) ```JSON theme={null} { "model": "minimax/minimax-m3", "messages": [ { "role": "user", "content": "How's the weather in San Francisco?" }, { "role": "assistant", "name": "MiniMax AI", "content": "", "tool_calls": [ { "id": "call_function_asqvfevfc8af_1", "type": "function", "function": { "name": "get_weather", "arguments": "{\"location\": \"San Francisco, US\"}" } } ], "reasoning_details": [ { "type": "reasoning.text", "id": "reasoning-text-1", "format": "openai-responses-v1", "index": 0, "text": "The user is asking about the weather in San Francisco..." } ] }, { "role": "tool", "tool_call_id": "call_function_asqvfevfc8af_1", "content": "24℃, sunny" } ], "stream": true, "reasoning_split": true, "max_tokens": 1024, "temperature": 0.7, "tools": [ { "type": "function", "function": { "name": "get_weather", "description": "Get weather for a specific location", "parameters": { "type": "object", "properties": { "location": { "type": "string" } }, "required": ["location"] } } } ] } ``` ## 非流式响应示例 ```JSON theme={null} { "id": "07a4dedfdb1498b045498dfd42497639", "object": "chat.completion", "created": 1764303147, "model": "MiniMax", "choices": [ { "index": 0, "message": { "role": "assistant", "content": "", "name": "MiniMax", "tool_calls": [ { "index": 0, "id": "call_function_9w7wq1j9zmpl_1", "type": "function", "function": { "name": "get_weather", "arguments": "{\"location\": \"ShangHai\"}" } } ], "reasoning_content": "The user asked for Shanghai weather...", "reasoning_details": [ { "type": "reasoning.text", "text": "The user is asking about the weather in Shanghai...", "id": "reasoning-text-1", "format": "openai-responses-v1", "index": 0 } ] }, "finish_reason": "tool_calls" } ] } ``` ## 流式响应示例 ```JSON theme={null} { "id": "664c5ad870c1888fbcbd267d9829e354", "object": "chat.completion.chunk", "created": 1764303504, "model": "minimax-m3", "choices": [ { "index": 0, "delta": { "role": "assistant", "reasoning_content": "...\n\nThe user has specifically asked...", "reasoning_details": [ { "type": "reasoning.text", "text": ".\n\nThe user has specifically asked...", "id": "reasoning-text-1", "format": "openai-responses-v1", "index": 0 } ] }, "finish_reason": null } ] } ``` ## 接入说明 ### 支持 Interleaved Thinking 的模型 所有通过 OpenAI 兼容 API 暴露 reasoning_details 的模型,包括: * MiniMax-M3 * (即将上线)Reasoning 系列 * 其他支持推理功能的合作模型 ### 计费规则 按照模型的计费规定,reasoning token 会计入费用。 启用 reasoning_details 会增加 token 消耗。 ### 错误处理 可能遇到的问题包括: * 工具参数缺失 * 工具调用递归或重复 * 推理阶段假设错误 请确保应用验证工具参数,并妥善处理模型返回的错误。 ### 最佳实践 **始终在下一个请求中包含完整的模型消息** 请携带: * `content` * `tool_calls` * `reasoning_details` **对于长链路推理推荐开启流式传输** 开启流式传输可以让客户端: * 实时监控推理过程 * 及早发现工具规划错误 * 更快地给用户反馈 **结合服务端状态机保障稳定性** 对于生产系统,建议将 Interleaved Thinking 与确定性的防护机制结合使用,例如: * 参数校验器 * 执行沙箱 * 最大递归深度保护 ## 总结 Interleaved Thinking 提升了多步推理与工具调用的可靠性: * 透明且可检查的逐步推理 * 在工具调用之间进行自适应规划 * 在长工作流中更强的上下文保持能力 * 完全兼容 OpenAI 风格的对话补全 API # Prompt Cache(推理缓存) Source: https://ppio.com/docs/model/llm-prompt-cache 了解 PPIO Prompt Cache 的使用方式与适用规则,查阅推理缓存相关说明,为评估模型请求中的缓存效果与调用成本提供参考。 Prompt Cache(推理缓存)是 PPIO 推理引擎提供的一项降本增效功能。 当请求与历史 Prompt 完全一致时,系统会直接返回缓存结果,仅收取极少的缓存 token 费用——大幅降低成本并提升响应速度。 ## 主要优势 启用 Prompt Cache 后,您将获得以下收益: * **成本更低** 对于重复的 Prompt,无需再次推理,仅收取极少的缓存 token 费用。 * **延迟更低** 缓存命中时,直接返回结果,无需等待模型推理。 * **更高吞吐** 在高 QPS 场景下,Prompt Cache 能有效降低推理负载,提升整体系统服务能力。 * **对应用透明** 无需在您的业务系统中增加额外逻辑或进行系统改造。 ## 支持的模型 目前多个无服务器开源模型已支持 Prompt Cache 计费,包括: 关于各模型 Prompt Cache 功能的计费详情,请访问:[https://ppio.com/pricing](https://ppio.com/pricing)(请查阅 “缓存” 部分) ## 适用场景 Prompt Cache 在**重复 Prompt 频繁**的业务场景下效果显著,包括但不限于: * **模板生成类** * 固定格式摘要 * 基于模板的改写 * 跨任务重用的 Prompt * **文本分类与字段抽取** * 内容类型分类 * 标签或关键信息提取 * **内容审核** * 评论、广告、标题等内容的复审 * 审核类 Prompt 在不同用户或时间段重复率高 * **聊天应用中重复系统提示** * 聊天机器人身份设定 * 全局会话规则 * 多轮对话复用背景信息 * **流程/助手类 Prompt** * SQL 生成助手 * 代码修复助手 * 输出格式固定的总结助手 上述场景天然有助于提升缓存命中率,从而显著降低推理成本。 ## 响应示例 > [!NOTE] > > 缓存命中时不消耗推理,成本更低、响应更快。 若模型支持 Prompt Cache,API 调用方式无需任何修改。缓存命中时的返回样例如下: ```JSON theme={null} { "prompt_tokens": 3295, "completion_tokens": 137, "total_tokens": 3432, "prompt_tokens_details": { "audio_tokens": 0, "cached_tokens": 448, "cache_creation_Prompt_tokens": 0, "cache_read_Prompt_tokens": 0 } } ``` # 调用频率控制(Rate Limits) Source: https://ppio.com/docs/model/llm-rate-limits 查阅 PPIO 模型 API 的调用频率控制规则,了解 Rate Limits 与请求组织的关系,为安排并发调用、处理限流和规划用量提供参考。 ## 理解调用频率控制 调用频率控制规定了在特定时间内可发起的 API 请求的数量,可以帮助优化 API 使用。 * 防止 API 滥用和误用 * 确保公平的资源分配 * 保持 API 性能和可靠性 * 保护服务的稳定性 ## 默认调用频率控制 每个账户在调用模型时都有默认的速率限制,分别以 RPM(每分钟每个模型的请求数)和 TPM(每分钟每个模型的 token 数)为单位进行衡量。速率限制会因账户等级不同而有所差异,具体标准见下方表格。
Quota 等级 资质(单位:人民币元)
T1 最近 3 个自然月中,单月最高充值总金额\< ¥50
T2 ¥50 ≤ 最近 3 个自然月中,单月最高充值总金额\< ¥500
T3 ¥500 ≤ 最近 3 个自然月中,单月最高充值总金额\< ¥3000
T4 ¥3000 ≤ 最近 3 个自然月中,单月最高充值总金额\< ¥10000
T5 ¥10000 ≤ 最近 3 个自然月中,单月最高充值总金额
各等级的默认速率限制(RPM / TPM): ## 避免触发调用频率控制 如果您的 API 请求数量超过了调用频率控制,API 将返回: * HTTP 状态码:429(请求过多)。 * 响应体中返回调用频率超出的信息。 为避免触发调用频率控制,您可以采取以下措施: * 在您的应用中实现请求限制。 * 在重试时使用指数退避机制。 * 监控您的 API 使用情况。 ## 处理429错误 如果您收到 429 错误,您可以尝试以下操作: * **稍后再试**:等待一段时间后再重试您的请求。 * **优化请求**:减少请求频率。 * **提高调用频率控制**:如果需要更高的调用频率控制,可以联系我们。 # 结构化输出(Structured Outputs) Source: https://ppio.com/docs/model/llm-structured-outputs 了解 PPIO 模型结构化输出的使用方式,查阅响应格式与 JSON Schema 相关配置,为应用解析模型结果和集成业务流程提供参考。 ## 使用场景 Structured Outputs 功能使模型能够生成符合您提供的 [JSON Schema](https://json-schema.org/specification) 的响应,让生成结果更加可控、易于解析。该功能既方便后续逻辑的解析和处理,也有利于将结果集成到业务系统中,适用于各种自动化和数据处理场景。 ## 支持的模型 以下模型支持结构化输出: ## 使用方法 在请求中添加以下信息: * **设置参数**:通过 `response_format` 参数指定您定义的 JSON Schema。 * **提示词指引**:在提示词中指引模型进行结构化输出。 ## 使用示例 下文提供完整的 Python 代码示例,演示如何使用 Structured Outputs 功能生成符合您提供的 JSON Schema 的 JSON 响应。 **1. 初始化客户端** 您需要使用您的 PPIO 派欧云 API 密钥初始化客户端。 ```python theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai", api_key="", ) model = "qwen/qwen3.8-flash" ``` **2. 定义 JSON Schema** 您需要定义 JSON Schema。以下示例创建了一个从用户输入中提取费用信息的 JSON Schema。 ```python theme={null} # 定义用于费用跟踪的系统提示。 system_prompt = """You are an expense tracking assistant. Extract expense information from the user's input and format it according to the provided schema.""" # 定义用于结构化响应的 JSON Schema。 response_format = { "type": "json_schema", "json_schema": { "name": "expense_tracking_schema", "schema": { "type": "object", "properties": { "expenses": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the expense" }, "amount": { "type": "number", "description": "Amount spent in dollars" }, "date": { "type": "string", "description": "When the expense occurred" }, "category": { "type": "string", "description": "Category of expense (e.g., food, office, travel)" } }, "required": [ "description", "amount" ] } }, "total": { "type": "number", "description": "Total amount of all expenses" } }, "required": [ "expenses", "total" ], }, }, } ``` **3. 发起 API 请求** 创建 API 请求。此请求包括 `response_format` 参数,指定了上一步中定义的 JSON Schema。 ```python theme={null} chat_completion = client.chat.completions.create( model=model, messages=[ { "role": "system", "content": system_prompt, }, { "role": "user", "content": """I spent $120 on dinner at an Italian restaurant last Friday with my colleagues. Also bought office supplies for $45 on Monday.""", }, ], max_tokens=1024, temperature=0.8, stream=False, response_format=response_format, ) response_content = chat_completion.choices[0].message.content # 解析并美化 JSON try: json_response = json.loads(response_content) prettified_json = json.dumps(json_response, indent=2) print(prettified_json) except json.JSONDecodeError: print("Could not parse response as JSON. Raw response:") print(response_content) ``` **输出**: ```json theme={null} { "expenses": [ { "date": "2023-03-17", "description": "Dinner at Italian restaurant", "amount": 120, "category": "Food & Dining" }, { "date": "2023-03-13", "description": "Office supplies", "amount": 45, "category": "Office Supplies" } ], "total": 165 } ``` ## 完整代码 ```python theme={null} from openai import OpenAI import json client = OpenAI( base_url="https://api.ppio.com/openai", api_key="", ) model = "qwen/qwen3.8-flash" # 使用 JSON Schema 进行结构化输出的示例 # 此示例创建了一个用于提取费用信息的 schema # 定义用于费用跟踪的系统提示 system_prompt = """You are an expense tracking assistant. Extract expense information from the user's input and format it according to the provided schema.""" # 定义用于结构化响应的 JSON schema response_format = { "type": "json_schema", "json_schema": { "name": "expense_tracking_schema", "schema": { "type": "object", "properties": { "expenses": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the expense" }, "amount": { "type": "number", "description": "Amount spent in dollars" }, "date": { "type": "string", "description": "When the expense occurred" }, "category": { "type": "string", "description": "Category of expense (e.g., food, office, travel)" } }, "required": [ "description", "amount" ] } }, "total": { "type": "number", "description": "Total amount of all expenses" } }, "required": [ "expenses", "total" ], }, }, } chat_completion = client.chat.completions.create( model=model, messages=[ { "role": "system", "content": system_prompt, }, { "role": "user", "content": """I spent $120 on dinner at an Italian restaurant last Friday with my colleagues. Also bought office supplies for $45 on Monday.""", }, ], max_tokens=1024, temperature=0.8, stream=False, response_format=response_format, ) response_content = chat_completion.choices[0].message.content # 解析并美化 JSON try: json_response = json.loads(response_content) prettified_json = json.dumps(json_response, indent=2) print(prettified_json) except json.JSONDecodeError: print("Could not parse response as JSON. Raw response:") print(response_content) ``` # 思考模式(Thinking Mode) Source: https://ppio.com/docs/model/llm-thinking-mode 查阅 PPIO 模型思考模式的配置与使用说明,了解推理过程、响应时间和用量之间的取舍,为不同任务选择合适的调用方式。 ## 概述 思考模式(Thinking Mode,也称推理 / Reasoning)让模型在给出最终回答前先输出一段推理过程,通常能提升复杂任务(如数学、代码、多步工具调用)的准确率,但会增加延迟和 token 消耗。不同模型厂商对思考模式的默认状态、开关参数和字段命名并不统一,本页按模型厂商汇总当前已在 PPIO 平台上线、且明确支持思考模式配置的开源模型,说明如何在 OpenAI Chat Completions、OpenAI Responses、Anthropic Messages 三种协议下开启、关闭或调整思考强度。 > [!TIP] > > 如果您调用的模型不在下表中,可参考[创建聊天对话请求](/docs/models/reference-llm-create-chat-completion)中的 `enable_thinking` 参数说明,该参数适用于早期一批模型的思考开关。 > > 本页讲的是如何开关思考、调整思考强度;如果您需要的是在多次工具调用之间保持推理连贯、透明展示多步推理过程,请参考 [Interleaved Thinking 支持](/docs/model/llm-interleaved-thinking)。 ## 模型选择总览 > [!NOTE] > > 下表按每个厂商在 PPIO 的上线时间排序("最新/次新"指发布时间先后),**不代表模型能力强弱或推荐优先级**。本页只覆盖各厂商主力文本对话模型;名称带 `-exp`(实验版,如 `deepseek-v4-flash-vision-exp`)以及专门的视觉/多模态模型(如智谱 GLM-5v-turbo、GLM-4.6v 系列)不在本页范围内,即使它们同样带 `reasoning` 能力。表中 GLM-5.3-Flash 虽然输入支持图像/视频,但它是主力对话模型的多模态能力扩展,不是专门的视觉模型,故仍纳入。 | 厂商 | 最新模型 | model ID | 次新模型 | model ID | | :- | :- | :- | :- | :- | | Zhipu / 智谱 | GLM-5.3-Flash | `zai-org/glm-5.3-flash` | GLM-5.3 | `zai-org/glm-5.3` | | MiniMax | MiniMax-M3 | `minimax/minimax-m3` | MiniMax-M2.7-highspeed / M2.7 | `minimax/minimax-m2.7-highspeed` / `minimax/minimax-m2.7` | | DeepSeek / 深度求索 | DeepSeek V4 Pro | `deepseek/deepseek-v4-pro-0813` | DeepSeek V4 Flash | `deepseek/deepseek-v4-flash-0731` | | Moonshot / Kimi | Kimi K3 | `moonshotai/kimi-k3` | — | — | *** ## Zhipu / 智谱 ### GLM-5.3 / GLM-5.3-Flash #### 协议与 endpoint | 协议 | endpoint | | :- | :- | | OpenAI Chat Completions | `https://api.ppio.com/openai/v1/chat/completions` | | OpenAI Responses | `https://api.ppio.com/openai/v1/responses` | | Anthropic Messages | `https://api.ppio.com/anthropic/v1/messages` | > [!NOTE] > > 本页示例仅覆盖 OpenAI Chat Completions 下已核实的思考参数行为。OpenAI Responses / Anthropic Messages 下控制该模型思考强度的具体字段尚未逐一核实,暂不提供对应示例。 #### 思考模式说明 * **默认状态**:思考始终开启。在 OpenAI Chat Completions 下,官方文档证实两个模型均**不支持关闭思考**——传入 `thinking.type: "disabled"` 会导致请求报错。Anthropic Messages / OpenAI Responses 下官方未提供该模型的参数文档,是否同样不可关闭未核实,不代表这两个协议下可以关闭。 * **推理强度(OpenAI Chat Completions)**:`reasoning_effort` 支持 `low`、`high`、`max`,**默认 `max`**;复杂任务(如编程)官方同样推荐使用 `max`。Anthropic Messages endpoint 是否接受同名字段尚未核实,暂不提供该协议下的示例。 > [!WARNING] > > GLM-5.3 与 GLM-5.3-Flash 通过 OpenAI Chat Completions 调用时强制开启思考,迁移时按旧代码实际传的字段分两种处理: > > * 若旧代码传的是 GLM-4.5 的 `enable_thinking: false`:该字段在 GLM-5.3 系列上不存在,直接删除即可,不需要替换成别的参数。 > * 若旧代码传的是 `thinking.type: "disabled"`:GLM-5.3 系列会**拒绝**这个值并报错,必须改成 `thinking.type: "enabled"` 且设置 `reasoning_effort: "low"` 来降低思考强度(而非关闭思考)。 #### 示例:OpenAI Chat Completions ```python Python theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai", api_key="", ) response = client.chat.completions.create( model="zai-org/glm-5.3", messages=[{"role": "user", "content": "请设计一个模型 API 回归测试清单。"}], extra_body={ "thinking": {"type": "enabled"}, "reasoning_effort": "high", }, ) print(response.choices[0].message.content) ``` ```bash cURL theme={null} curl "https://api.ppio.com/openai/v1/chat/completions" \ -H "Authorization: Bearer $API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "zai-org/glm-5.3", "messages": [{"role": "user", "content": "请设计一个模型 API 回归测试清单。"}], "thinking": {"type": "enabled"}, "reasoning_effort": "high" }' ``` *** ## MiniMax ### MiniMax-M3 #### 协议与 endpoint | 协议 | endpoint | | :- | :- | | OpenAI Chat Completions | `https://api.ppio.com/openai/v1/chat/completions` | | Anthropic Messages | `https://api.ppio.com/anthropic/v1/messages` | #### 思考模式说明 * **默认状态因协议而异**:省略 `thinking` 参数时,OpenAI 兼容接口默认**开启**思考;Anthropic 兼容接口默认**关闭**思考。M3 没有 `reasoning_effort` 一类的强度分档,`thinking.type` 只有开 / 关两态,不存在"默认强度"的概念。建议调用时显式指定 `thinking`,不要依赖默认值。 * **开启方式**:`thinking: {"type": "adaptive"}`(`adaptive` 对 M3 等价于开启思考)。 * **关闭方式**:`thinking: {"type": "disabled"}`。 * **`reasoning_split`(仅 OpenAI Chat Completions 支持,Anthropic Messages 无此字段;仅影响返回格式,不控制思考开关)**:设为 `true` 时思考内容拆分到 `reasoning_content` 与 `reasoning_details` 两个字段;省略或设为 `false` 时思考内容以 `...` 标签内嵌在 `content` 字段中。 #### 示例:OpenAI Chat Completions ```python Python theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai", api_key="", ) response = client.chat.completions.create( model="minimax/minimax-m3", messages=[{"role": "user", "content": "请分析这个工具调用方案的风险。"}], extra_body={ "thinking": {"type": "adaptive"}, "reasoning_split": True, }, ) print(response.choices[0].message.content) ``` ```bash cURL theme={null} curl "https://api.ppio.com/openai/v1/chat/completions" \ -H "Authorization: Bearer $API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "minimax/minimax-m3", "messages": [{"role": "user", "content": "请分析这个工具调用方案的风险。"}], "thinking": {"type": "adaptive"}, "reasoning_split": true }' ``` #### 示例:关闭思考(Chat Completions) ```bash cURL theme={null} curl "https://api.ppio.com/openai/v1/chat/completions" \ -H "Authorization: Bearer $API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "minimax/minimax-m3", "messages": [{"role": "user", "content": "只输出一句话总结。"}], "thinking": {"type": "disabled"} }' ``` ### MiniMax-M2.7 / MiniMax-M2.7-highspeed #### 协议与 endpoint | 协议 | endpoint | | :- | :- | | OpenAI Chat Completions | `https://api.ppio.com/openai/v1/chat/completions` | | Anthropic Messages | `https://api.ppio.com/anthropic/v1/messages` | #### 思考模式说明 * **默认状态**:思考始终开启,**不支持关闭**。即使传入 `thinking: {"type": "disabled"}`,请求仍会成功,但思考仍保持开启。 * **MiniMax-M2.7-highspeed** 是 MiniMax-M2.7 的高速版本,模型能力与 M2.7 一致,推理速度更快;调用时把 `model` 换成 `minimax/minimax-m2.7-highspeed` 即可,**代码逻辑无需其他改动**。 > [!WARNING] > > MiniMax-M2.7-highspeed 在 PPIO 的输入、输出单价均为 MiniMax-M2.7 的 **2 倍**(截至本文撰写时)。换成 highspeed 版本只是把 `model` 字段的值改掉,不涉及请求体结构或参数改动,但会直接影响调用成本,请按实际吞吐 / 延迟需求权衡,不要在未评估成本的情况下默认切换。 > [!NOTE] > > M2.7 系列没有可用于关闭思考的参数,如需降低延迟或成本,请考虑改用支持关闭思考的模型,或缩短输入 / 输出长度。 #### 示例:调用并拆分 reasoning ```python Python theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai", api_key="", ) response = client.chat.completions.create( model="minimax/minimax-m2.7", messages=[{"role": "user", "content": "请用 Python 实现一个 LRU Cache。"}], extra_body={"reasoning_split": True}, ) print(response.choices[0].message.content) ``` ```bash cURL theme={null} curl "https://api.ppio.com/openai/v1/chat/completions" \ -H "Authorization: Bearer $API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "minimax/minimax-m2.7", "messages": [{"role": "user", "content": "请用 Python 实现一个 LRU Cache。"}], "reasoning_split": true }' ``` *** ## DeepSeek / 深度求索 ### DeepSeek V4 Pro / V4 Flash #### 协议与 endpoint | 协议 | endpoint | | :- | :- | | OpenAI Chat Completions | `https://api.ppio.com/openai/v1/chat/completions` | | OpenAI Responses | `https://api.ppio.com/openai/v1/responses` | | Anthropic Messages | `https://api.ppio.com/anthropic/v1/messages` | > [!NOTE] > > 三种协议均已验证支持思考模式配置的模型 ID 为 `deepseek/deepseek-v4-pro-0813` 与 `deepseek/deepseek-v4-flash-0731`。以下示例均使用这两个 ID。 #### 思考模式说明 * **默认状态**:思考默认开启,默认推理强度为 `high`。 * **OpenAI Chat Completions**:开关用 `thinking: {"type": "enabled"/"disabled"}`(需通过 `extra_body` 传递);强度用顶层字段 `reasoning_effort`,支持 `low`、`high`、`max`。 * **Anthropic Messages**:`thinking` 字段控制开关(`budget_tokens` 子字段会被忽略);强度用 `output_config: {"effort": "low"/"high"/"max"}`。 * **OpenAI Responses**:开关与强度合并为一个字段 `reasoning: {"effort": "none"/"low"/"high"/"max"}`,其中 `none` 表示关闭思考。 * **强度档位映射**(用户设置的 effort → 模型实际生效的 effort,对 V4 Pro 与 V4 Flash 一致): | 请求 effort | 实际生效 effort | | :- | :- | | low | low | | medium | high | | high | high | | xhigh | high | | max | max | > [!NOTE] > > `medium`、`xhigh` 也是被接受的输入值,会按上表静默归一化为 `high`,不会单独产生介于 `high` 与 `max` 之间的效果。 > [!WARNING] > > 思考模式开启时,`temperature`、`top_p`、`presence_penalty`、`frequency_penalty` 参数不生效。为兼容现有代码,传入这些参数不会报错,但不会产生任何效果。 #### 示例:OpenAI Chat Completions ```python Python theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai", api_key="", ) response = client.chat.completions.create( model="deepseek/deepseek-v4-pro-0813", messages=[{"role": "user", "content": "请审查这个 API 设计。"}], extra_body={ "thinking": {"type": "enabled"}, "reasoning_effort": "high", }, ) print(response.choices[0].message.content) ``` ```bash cURL theme={null} curl "https://api.ppio.com/openai/v1/chat/completions" \ -H "Authorization: Bearer $API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "deepseek/deepseek-v4-pro-0813", "messages": [{"role": "user", "content": "请审查这个 API 设计。"}], "thinking": {"type": "enabled"}, "reasoning_effort": "high" }' ``` #### 示例:关闭思考(Chat Completions) ```bash cURL theme={null} curl "https://api.ppio.com/openai/v1/chat/completions" \ -H "Authorization: Bearer $API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "deepseek/deepseek-v4-pro-0813", "messages": [{"role": "user", "content": "把这句话翻译成英文:今天天气很好。"}], "thinking": {"type": "disabled"} }' ``` #### 示例:Anthropic Messages(调整强度) ```python Python theme={null} import anthropic client = anthropic.Anthropic( base_url="https://api.ppio.com/anthropic", api_key="", ) message = client.messages.create( model="deepseek/deepseek-v4-pro-0813", max_tokens=1000, system="You are a concise API reviewer.", messages=[{"role": "user", "content": [{"type": "text", "text": "列出这个接口迁移的三个风险。"}]}], extra_body={ "thinking": {"type": "enabled"}, "output_config": {"effort": "max"}, }, ) print(message.content) ``` ```bash cURL theme={null} curl "https://api.ppio.com/anthropic/v1/messages" \ -H "Authorization: Bearer $API_KEY" \ -H "Content-Type: application/json" \ -H "anthropic-version: 2023-06-01" \ -d '{ "model": "deepseek/deepseek-v4-pro-0813", "max_tokens": 1000, "system": "You are a concise API reviewer.", "messages": [{"role": "user", "content": [{"type": "text", "text": "列出这个接口迁移的三个风险。"}]}], "thinking": {"type": "enabled"}, "output_config": {"effort": "max"} }' ``` #### 示例:OpenAI Responses(关闭思考) ```bash cURL theme={null} curl "https://api.ppio.com/openai/v1/responses" \ -H "Authorization: Bearer $API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "deepseek/deepseek-v4-pro-0813", "input": "只输出一句话。", "reasoning": {"effort": "none"} }' ``` *** ## Moonshot / Kimi ### Kimi K3 #### 协议与 endpoint | 协议 | endpoint | | :- | :- | | OpenAI Chat Completions | `https://api.ppio.com/openai/v1/chat/completions` | | OpenAI Responses | `https://api.ppio.com/openai/v1/responses` | | Anthropic Messages | `https://api.ppio.com/anthropic/v1/messages` | #### 思考模式说明 * **默认状态**:始终开启思考,**不支持关闭**,也不支持 `thinking` 参数——如果您之前调用 Kimi K2.x 系列传入过 `thinking` 配置,迁移到 K3 时需要移除该参数,改用下面的顶层 `reasoning_effort`(或对应协议下的等价字段)控制推理强度。 * **推理强度**:不嵌套在 `thinking` 内,但三种协议下字段名不同: * **OpenAI Chat Completions**:顶层字段 `reasoning_effort`,支持 `low`、`high`、`max`,默认 `max`。官方专门写了使用指南并配有真实调用示例。 * **Anthropic Messages**:`output_config: {"effort": "low"/"high"/"max"}`,默认 `max`。字段来自 Kimi 官方 API 参考页的请求 schema;该页说明切换档位会导致 prefix-cache 命中失效,建议在会话开始前就定好档位,不要在同一会话中切换。 * **OpenAI Responses**:`reasoning: {"effort": "low"/"high"/"max"}`,默认 `max`。字段同样来自官方 API 参考页的请求 schema。 > [!WARNING] > > 多轮对话与工具调用场景下,必须把 API 返回的完整 assistant 消息(包括 `reasoning_content` 和 `tool_calls`)原样加入下一次请求的 `messages`,否则可能导致工具调用递归或重复、推理上下文丢失。 #### 示例:调整推理强度 ```python Python theme={null} from openai import OpenAI client = OpenAI( base_url="https://api.ppio.com/openai", api_key="", ) response = client.chat.completions.create( model="moonshotai/kimi-k3", messages=[{"role": "user", "content": "证明根号 2 是无理数。"}], extra_body={"reasoning_effort": "max"}, ) print(response.choices[0].message.content) ``` ```bash cURL theme={null} curl "https://api.ppio.com/openai/v1/chat/completions" \ -H "Authorization: Bearer $API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "moonshotai/kimi-k3", "messages": [{"role": "user", "content": "证明根号 2 是无理数。"}], "reasoning_effort": "max" }' ``` #### 示例:Anthropic Messages(调整推理强度) ```bash cURL theme={null} curl "https://api.ppio.com/anthropic/v1/messages" \ -H "Authorization: Bearer $API_KEY" \ -H "Content-Type: application/json" \ -H "anthropic-version: 2023-06-01" \ -d '{ "model": "moonshotai/kimi-k3", "max_tokens": 1000, "messages": [{"role": "user", "content": [{"type": "text", "text": "证明根号 2 是无理数。"}]}], "output_config": {"effort": "max"} }' ``` #### 示例:OpenAI Responses(调整推理强度) ```bash cURL theme={null} curl "https://api.ppio.com/openai/v1/responses" \ -H "Authorization: Bearer $API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "moonshotai/kimi-k3", "input": "证明根号 2 是无理数。", "reasoning": {"effort": "max"} }' ``` # 产品简介 Source: https://ppio.com/docs/model/overview PPIO 模型 API 为 AI 原生应用、智能体开发和 AI 编程提供模型调用服务。了解大语言与多模态模型接入方式,以及模型服务在 Agentic Cloud 中的作用。 PPIO派欧云模型 API 服务是面向企业客户与开发者推出的高性能推理服务平台,基于下一代分布式 AI 基础设施架构(AI Infra),提供稳定、低延迟、高性价比的大语言模型(LLM)与多模态模型调用能力。 该服务通过整合全球异构 GPU 算力资源,结合多层级调度与智能资源编排机制,帮助客户在确保响应效率和成本可控的前提下,快速落地多样化 AI 应用。 PPIO 模型 API 支持主流开源与商用模型,支持企业级模型托管、精细化参数配置以及私有化定制部署,广泛适用于智能体(Agent)、虚拟助手、内容生成、智能问答、文档摘要等典型场景。 ## 核心能力优势 ### 可精确定制 * **全球多区域部署**:提供覆盖国内外的多个接入节点,支持多地模型调用与就近分发。 * **负载隔离调度机制**:保障高并发情况下模型推理稳定响应,提升调用成功率与可用性。 ### 超高性价比 * **灵活按需计费**:支持基于 Token 量或调用次数的计费方式,满足不同业务阶段的成本优化需求。 * **高性价比 GPU 支持**:平台统一调度多类型 GPU 资源,实现更优的算力成本效率。 ### 快速交付体验 * **开箱即用的推理平台**:集成主流模型与工具链(如 tokenizer、embedding等),即开即用。 * **标准化 API 接口兼容**:兼容 OpenAI、LangChain、HuggingFace 等标准调用协议,方便系统对接与替换。 ## 私有化部署服务 PPIO 支持面向企业客户的全栈式私有化部署解决方案,适用于对数据安全、模型定制和服务稳定性有高要求的企业级场景。 ### 服务能力 * 提供服务等级协议(SLA)保障,明确性能与可用性指标; * 支持模型微调、推理加速、API 限速、版本管理等高级配置; * 可部署至企业内网、混合云、专属云或边缘计算节点; * 提供模型、推理框架、监控系统、数据接入组件的一体化集成支持。 > [!TIP] > > 私有化部署详情请联系商务顾问,或访问[官方网站。](https://ppio.com/ai-computing/llm-api) # 模型广场 Source: https://ppio.com/docs/model/serverless 查阅 PPIO 模型广场的使用说明,了解模型浏览与选择入口,为比较可用服务、确认接入信息和开展应用开发提供参考。 ## 一站式高性能大模型服务平台 **PPIO 派欧云**聚合开源与闭源、多模态大模型资源,打造覆盖语言、语音、图像、视频等场景的一站式云服务平台。平台致力于为开发者和企业提供更快、更强、更稳定的大模型 API 接入服务,全面赋能多领域 AI 应用的高效构建与规模化落地。 ## 全模态模型广场,轻松实现AI能力接入 PPIO 模型广场已上线众多主流大模型,涵盖语言模型、视觉语言模型、推理模型等多种类型,满足文本生成、多模态理解、复杂推理等多样化需求。 * **主流模型集成**\ 已支持包括 DeepSeek-V3、Qwen3 系列等高性能大模型,覆盖语言、语音、图片、视频等典型应用场景。 * **免费模型助力研发与冷启动**\ 提供多个高性能模型的永久免费版本(如 Qwen 2.5(7B)等),帮助开发者与产品经理实现“Token 自由”,在研发阶段与初期推广阶段无惧算力成本。 * **按量计费,开箱即用**\ 所有模型 API 均支持按需调用、灵活计费,助力应用快速集成,无需部署服务器,降低接入门槛。 ## 丰富配套能力,保障 AI 应用性能与稳定性 为了让大模型应用更加稳定高效,PPIO 还提供如下配套服务: 1. **高效能推理加速**\ 基于异构计算资源与智能调度算法,为大模型应用提供高吞吐、低延迟的推理服务,全面提升用户体验。 2. **模型微调与托管部署**\ 用户可直接托管微调后的专属大语言模型,由平台提供底层算力支撑与服务保障,免去运维负担,专注业务迭代。 ## 专注开发,放心扩展 借助 PPIO 派欧云,企业与开发者可在降低成本的同时,聚焦核心产品创新: * 无需自建算力,享受弹性扩展 * 无需关注底层部署,专注应用逻辑 * 无需担忧大规模使用成本,轻松实现快速上线与持续迭代 **立即访问模型广场,开启高效智能开发之旅。**[控制台 - 模型 API 服务 | PPIO派欧云](https://ppio.com/model-api/console) # 视觉语言模型 Source: https://ppio.com/docs/model/visual 了解 PPIO 视觉语言模型的接入与使用方式,查阅图像和文本相关能力的说明,为构建多模态应用和视觉交互流程提供参考。 ## 功能介绍 视觉语言模型(Vision-Language Model,VLM)是一类同时支持图像与文本输入的多模态大模型,具备对图像内容的理解与跨模态信息处理能力。模型能够基于图片与文本的组合信息,输出高质量的响应内容,广泛应用于图像识别、内容理解、智能问答等场景。 ### 典型应用场景 * **图像内容识别与描述**:自动识别图片中的物体、颜色、场景与空间关系,生成自然语言描述。 * **图文综合理解**:结合图像与文本输入,实现上下文相关的多轮对话与复杂任务响应。 * **视觉辅助问答**:可作为 OCR 工具的补充,识别图像中嵌入的文本信息并完成问答。 * **未来拓展应用**:适用于智能视觉助手、机器人感知、增强现实等交互场景。 ## API 调用说明 调用视觉语言模型需通过 `/chat/completions` 接口,支持图文混合输入。 ### 图片处理参数 通过 `detail` 字段设置图像处理精度,支持以下选项: * `high`:高分辨率,保留更多细节,适合精细化任务。 * `low`:低分辨率,处理速度快,适合实时响应。 * `auto`:系统自动选择合适模式。 ### 消息格式示例 #### URL 图片形式 ```json theme={null} { "role": "user", "content": [ { "type": "image_url", "image_url": { "url": "https://example.com/image.png", "detail": "high" } }, { "type": "text", "text": "请描述图片中的场景。" } ] } ``` #### Base64 图片形式 ```json theme={null} { "role": "user", "content": [ { "type": "image_url", "image_url": { "url": "data:image/jpeg;base64,{base64_image}", "detail": "low" } }, { "type": "text", "text": "图片中有哪些文字内容?" } ] } ``` ### Base64 图像编码示例代码(Python) ```python theme={null} import base64 from PIL import Image import io def image_to_base64(image_path): with Image.open(image_path) as img: buffered = io.BytesIO() img.save(buffered, format="JPEG") return base64.b64encode(buffered.getvalue()).decode('utf-8') base64_image = image_to_base64("path/to/your/image.jpg") ``` ## 多图模式 支持发送多张图片与文本共同作为输入,建议最多两张,以获得更佳的性能与理解效果。 ```json theme={null} { "role": "user", "content": [ { "type": "image_url", "image_url": { "url": "https://example.com/image1.png" } }, { "type": "image_url", "image_url": { "url": "data:image/jpeg;base64,{base64_image}" } }, { "type": "text", "text": "比较这两张图片的共同特征。" } ] } ``` ## 支持模型 以下为当前平台支持的视觉语言模型(VLM): 请在模型广场中查看完整模型列表与更新情况。 ## 计费方式 视觉语言模型的图像输入将转换为 Tokens,与文本共同计算调用费用: * 每个模型的图像 Token 估算规则略有不同; * 详细的计费标准可在对应模型介绍页中查看。 ## API 调用示例代码 ### 单图像描述 ```python theme={null} from openai import OpenAI client = OpenAI(api_key="YOUR_KEY", base_url="https://api.ppio.com/openai") response = client.chat.completions.create( model="qwen/qwen3.8-flash", messages=[ { "role": "user", "content": [ {"type": "image_url", "image_url": {"url": "https://example.com/cityscape.jpg"}}, {"type": "text", "text": "描述图片中的主要建筑物。"} ] } ], stream=True ) for chunk in response: print(chunk.choices[0].delta.content or "", end="", flush=True) ``` ### 多图像对比分析 ```python theme={null} response = client.chat.completions.create( model="qwen/qwen3.8-flash", messages=[ { "role": "user", "content": [ {"type": "image_url", "image_url": {"url": "https://example.com/product1.jpg"}}, {"type": "image_url", "image_url": {"url": "https://example.com/product2.jpg"}}, {"type": "text", "text": "请对比一下这两个产品的主要区别。"} ] } ], stream=True ) for chunk in response: print(chunk.choices[0].delta.content or "", end="", flush=True) ``` ## 常见问题与说明 * 图像分辨率与清晰度会影响模型识别准确率,推荐使用清晰图源。 * Base64 编码体积较大,建议图片不超过 1 MB。 * 如遇问题,请参考平台开发者文档或提交工单获取支持。 # API 鉴权方式 Source: https://ppio.com/docs/models/reference-authentication 查阅 PPIO 模型 API 的身份认证说明,了解使用 API 密钥准备请求的方式,为应用接入模型服务和排查鉴权问题提供参考。 [PPIO 派欧云平台](https://ppio.com) API 使用 `请求头` 中的 Authorization 字段携带 API 密钥进行身份认证。您可以在[API 密钥管理页面](https://ppio.com/settings/key-management)查看和管理您的 API 密钥。 ```json theme={null} { "Authorization": "Bearer {{API 密钥}}" } ``` # API 错误码说明 Source: https://ppio.com/docs/models/reference-error-code 了解 PPIO 模型 API 错误码的含义与相关说明,根据返回信息检查调用问题,为接口集成与服务排查提供参考。 ## 图片 / 视频 / 音频
错误名称 状态码 说明
INVALID_REQUEST_BODY 400 请求参数校验失败
IMAGE_FILE_EXCEEDS_MAX_SIZE 400 图片大小超出限制
INVALID_IMAGE_FORMAT 400 图片格式与要求不符
IMAGE_EXCEEDS_MAX_RESOLUTION 400 图片分辨率超出限制
INVALID_IMAGE_SIZE 400 图片长或宽超出限制
API_NOT_FOUND 404 API 不存在
IMAGE_NO_FACE_DETECTED 400 未检测到人脸
INVALID_CUSTOM_OUTPUT_PATH 400 OSS 路径不合法
ILLEGAL_PROMPT 400 Prompt 含不适宜内容
ILLEGAL_IMAGE_CONTENT 400 图片含不适宜内容
INVALID_AUDIO_FILE 400 输入音频不合法
BILLING_FAILED 500 计费服务异常
BILLING_AUTH_FAILED 403 计费服务鉴权失败
BILLING_BALANCE_NOT_ENOUGH 400 余额不足
MISSING_API_KEY 400 未提供 API Key
INVALID_API_KEY 403 API Key 校验失败
FEATURE_NOT_ALLOWED 403 没有模型上传权限
API_NOT_ALLOWED 403 无权限使用该 API
RATE_LIMIT_EXCEEDED 429 触发频率控制限制
NEED_REAL_NAME_VERIFY 403 未完成企业认证
CREATE_TASK_FAILED 500 创建任务失败
TASK_NOT_FOUND 404 任务不存在
GET_RESULT_FAILED 500 获取任务结果失败
TASK_FAILED 500 任务执行失败
## 大语言
错误名称 状态码 说明
INVALID_API_KEY 403 未提供 API Key
MODEL_NOT_FOUND 404 模型不存在
FAILED_TO_AUTH 401 认证失败
NOT_ENOUGH_BALANCE 403 余额不足
INVALID_REQUEST_BODY 400 请求体格式错误,详见 message
RATE_LIMIT_EXCEEDED 429 请求过快,请稍后重试
TOKEN_LIMIT_EXCEEDED 429 Token 数超限,请稍后重试
SERVICE_NOT_AVAILABLE 503 服务不可用
ACCESS_DENY 403 无权限访问
## 账单
错误名称 状态码 说明
UNKNOWN 500 未知错误,请联系我们
LIST_BILL_TOO_FAST 429 请求过于频繁,请稍后重试
INVALID_PRODUCT_CATEGORY 400 productCategory 参数错误
INVALID_BILL_CYCLE 400 cycle 参数错误
LIST_BILL_ERROR 500 查询错误,请联系我们
# 取消批处理任务 Source: https://ppio.com/docs/models/reference-llm-cancel-batch POST https://api.ppio.com/openai/v1/batches/{batch_id}/cancel 查阅 PPIO 取消 LLM 批处理任务的接口说明,了解如何结束不再需要继续处理的批量请求,为维护异步推理任务提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值: `application/json` **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 路径参数 **batch_id** `string` *required* 要取消的批处理任务唯一标识符。 ## 响应 **id** `string` *required* 批处理任务的唯一标识符。 **object** `string` *required* 对象类型,恒为 `batch`。 **endpoint** `string` *required* 批处理任务用于处理请求的 API 端点。 **input_file_id** `string` *required* 包含批处理请求的输入文件 ID。 **output_file_id** `string` *required* 包含批处理结果的输出文件 ID。在批处理完成之前为空。 **error_file_id** `string` *required* 包含批处理过程中发生的错误的错误文件 ID。在出现错误之前为空。 **completion_window** `string` *required* 批处理完成的时间窗口。当前固定为 `48h`。 **in_progress_at** `string | null` 批处理开始处理的时间戳。若尚未开始则为 null。 **expires_at** `string | null` 批处理到期的时间戳。若未设置则为 null。 **finalizing_at** `string | null` 批处理开始进入最终化阶段的时间戳。若尚未进入则为 null。 **completed_at** `string | null` 批处理完成的时间戳。若尚未完成则为 null。 **failed_at** `string | null` 批处理失败的时间戳。若未失败则为 null。 **expired_at** `string | null` 批处理过期的时间戳。若未过期则为 null。 **cancelling_at** `string | null` 批处理开始取消的时间戳。若未在取消中则为 null。 **cancelled_at** `string | null` 批处理被取消的时间戳。若未被取消则为 null。 **status** `string` *required* 批处理任务的当前状态。 可用状态: * `VALIDATING` - 在批处理开始前正在验证输入文件 * `PROGRESS` - 批处理进行中 * `COMPLETED` - 批处理成功完成 * `FAILED` - 批处理失败 * `EXPIRED` - 批处理超过截止时间 * `CANCELLING` - 正在取消批处理 * `CANCELLED` - 批处理已取消 **errors** `string` 批处理过程中发生错误时的错误信息。 **version** `integer` *required* 批处理任务的版本号。 **created_at** `string` *required* 批处理任务的创建时间戳。 **updated_at** `string | null` 批处理任务最近一次更新的时间戳。若从未更新则为 null。 **created_by** `string` *required* 创建该批处理任务的用户唯一标识符。 **created_by_key_id** `string` *required* 用于创建该批处理任务的 API Key ID。 **remark** `string` 批处理任务的可选备注信息。 **total** `integer` *required* 批处理中的请求总数。 **completed** `integer` *required* 批处理中已完成的请求数量。 **failed** `integer` *required* 批处理中失败的请求数量。 **metadata** `object | null` 与批处理任务关联的附加元数据。若无则为 null。 **request_counts** `object` *required* 请求计数的详细信息。 **properties** **total** `integer` *required* 批处理中的请求总数。 **completed** `integer` *required* 成功完成的请求数量。 **failed** `integer` *required* 失败的请求数量。 # 创建批处理任务 Source: https://ppio.com/docs/models/reference-llm-create-batch POST https://api.ppio.com/openai/v1/batches 了解 PPIO 创建 LLM 批处理任务的接口,查阅批量请求提交与任务组织方式,为集中处理模型推理工作提供参考。 成功 [上传文件](/docs/models/reference-llm-upload-batch-input-file) 后,使用该文件的 ID 来发起一个批处理任务。请注意,完成窗口固定为 48 小时,当前不可修改。 ## 请求头 **Content-Type** `string` *required* 枚举值: `application/json` **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **input_file_id** `string` *required* 已上传的、包含批处理请求的输入文件 ID。 **endpoint** `string` *required* 批处理所使用的端点。可用端点为 `/v1/chat/completions` 和 `/v1/completions`。 > [!WARNING] > > 为了兼容 OpenAI API,请将 `endpoint` 参数设置为 `/v1/chat/completions` 或 `/v1/completions`。 **completion_window** `string` 批处理完成的时间窗口。当前固定为 `48h`,不可调整。 ## 响应 **id** `string` *required* 批处理任务的唯一标识符。 **object** `string` *required* 对象类型,恒为 `batch`。 **endpoint** `string` *required* 批处理任务用于处理请求的 API 端点。 **input_file_id** `string` *required* 包含批处理请求的输入文件 ID。 **output_file_id** `string` *required* 包含批处理结果的输出文件 ID。在批处理完成之前为空。 **error_file_id** `string` *required* 包含批处理过程中发生的错误的错误文件 ID。在出现错误之前为空。 **completion_window** `string` *required* 批处理完成的时间窗口。当前固定为 `48h`。 **in_progress_at** `string | null` 批处理开始处理的时间戳。若尚未开始则为 null。 **expires_at** `string | null` 批处理到期的时间戳。若未设置则为 null。 **finalizing_at** `string | null` 批处理开始进入最终化阶段的时间戳。若尚未进入则为 null。 **completed_at** `string | null` 批处理完成的时间戳。若尚未完成则为 null。 **failed_at** `string | null` 批处理失败的时间戳。若未失败则为 null。 **expired_at** `string | null` 批处理过期的时间戳。若未过期则为 null。 **cancelling_at** `string | null` 批处理开始取消的时间戳。若未在取消中则为 null。 **cancelled_at** `string | null` 批处理被取消的时间戳。若未被取消则为 null。 **status** `string` *required* 批处理任务的当前状态。 可用状态: * `VALIDATING` - 在批处理开始前正在验证输入文件 * `PROGRESS` - 批处理进行中 * `COMPLETED` - 批处理成功完成 * `FAILED` - 批处理失败 * `EXPIRED` - 批处理超过截止时间 * `CANCELLING` - 正在取消批处理 * `CANCELLED` - 批处理已取消 **errors** `string` 批处理过程中发生错误时的错误信息。 **version** `integer` *required* 批处理任务的版本号。 **created_at** `string` *required* 批处理任务的创建时间戳。 **updated_at** `string | null` 批处理任务最近一次更新的时间戳。若从未更新则为 null。 **created_by** `string` *required* 创建该批处理任务的用户唯一标识符。 **created_by_key_id** `string` *required* 用于创建该批处理任务的 API Key ID。 **remark** `string` 批处理任务的可选备注信息。 **total** `integer` *required* 批处理中的请求总数。 **completed** `integer` *required* 批处理中已完成的请求数量。 **failed** `integer` *required* 批处理中失败的请求数量。 **metadata** `object | null` 与批处理任务关联的附加元数据。若无则为 null。 **request_counts** `object` *required* 请求计数的详细信息。 **properties** **total** `integer` *required* 批处理中的请求总数。 **completed** `integer` *required* 成功完成的请求数量。 **failed** `integer` *required* 失败的请求数量。 # 创建聊天对话请求 Source: https://ppio.com/docs/models/reference-llm-create-chat-completion POST https://api.ppio.com/openai/v1/chat/completions 查阅 PPIO Chat Completions 聊天请求接口,了解对话消息与模型请求的使用方式,为 AI 应用和 Agent 工作流接入语言模型提供参考。 根据指定的聊天对话生成模型回复 ## 请求头 **Content-Type** `string` *required* 枚举值: `application/json` **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **model** `string` *required* 对应的模型名称。可用模型名称请参考:[模型列表](https://ppio.com/model-api/product/llm-api) **messages** `object[]` *required* 截至目前组成对话的消息列表。 **properties** **content** `string | object[] | null` *required* 消息的内容。所有消息都需要 content,对于包含函数调用的 assistant 消息,content 可以为 null。 您可以根据不同的模态使用以下参数。 > [tab] 文本内容 > > 选项 1:您可以使用字符串类型来表示消息的文本内容。 > > 选项 2:使用内容部分的数组,object\[]。详细字段如下: > > **type** `string` *required* > > 内容部分的类型,在此情况下为 `text`。 > > **text** `string` *required* > > 文本内容。 > [tab] 图像内容 > > 仅视觉语言模型可使用。内容部分的数组,object\[]。详细字段如下: > > **type** `string` *required* > > 内容部分的类型,在此情况下为 `image_url`。 > > **image_url** `string` *required* > > **properties** > > **url** `string` *required* > > 图像的 URL 或 base64 编码的图像数据。 > [tab] 视频内容 > > 仅支持视频的模型可使用。内容部分的数组,object\[]。详细字段如下: > > **type** `string` *required* > > 内容部分的类型,在此情况下为 `video_url`。 > > **video_url** `string` *required* > > **properties** > > **url** `string` *required* > > 视频的 URL。 > [tab] 音频内容 > > 仅支持音频的模型可使用。输出模态参数: > > **modalities** `string[]` > > 设置模型输出的模态。当前支持两种:`["text"]`、`["text","audio"]`。 > 如果传入 `["text"]`,模型只返回文字内容。如果传入 `["text","audio"]`,模型会同时返回文字内容和音频内容。 > 默认为 `["text"]`。 > > 内容部分的数组,object\[]。详细字段如下: > > **type** `string` *required* > > 内容部分的类型,在此情况下为 `input_audio`。 > > **input_audio** `object` *required* > > **properties** > > **data** `string` *required* > > 音频的 URL 或者 base64 编码。 > > **format** `string` *required* > > 音频的格式。如 `wav`, `mp3`。 **role** `string` *required* 消息作者的角色。可以是 system、user、assistant 之一。Enum: `system, user, assistant` **name** `string | null` 此消息的作者名称。可以包含小写字母 a-z、大写字母 A-Z、数字 0-9 和下划线,最大长度为 64 个字符。 **max_tokens** `integer` *required* 在生成对话时可产生的最大 tokens 数。\ \ 如果您的提示(之前的消息)中的 tokens 数量加上 max_tokens 超过了模型的上下文长度,则行为取决于 context_length_exceeded_behavior。默认情况下,max_tokens 会被调整以适应上下文窗口,而不是返回错误。 **stream** `boolean | null` 是否使用流式传输。默认为 false,如果设置了,tokens 将以 data-only server-sent events(SSE)发送,并以 data: \[DONE] 消息终止流。 **stream_options** `object` 流式回复选项。仅当 stream 设置为 true 时设置。 **properties** **include_usage** `boolean` 如果设置,将在数据: \[DONE] 消息之前流式传输一个额外的 chunk。此 chunk 中的 usage 字段显示整个请求的令牌使用统计信息,而 choices 字段始终为空数组。所有其他 chunk 也将包含一个 usage 字段,但值为 null。 **n** `integer | null` 每个提示生成多少个对话。默认值为 1。\ \ 注意:由于此参数会生成多个对话,因此可能会快速消耗您的 tokens 计费额度。请谨慎使用,并确保为 max_tokens 和 stop 设置了合理的值。\ 所需范围:1 \< x \< 128 **seed** `integer | null` 如果指定,我们的系统将尽最大努力进行确定性采样,以便相同的 seed 和参数的重复请求应返回相同的结果。 **frequency_penalty** `number | null` 默认值为 0,正值会根据新 tokens 在当前文本中的出现频率对其进行惩罚,从而降低模型重复相同内容的可能性。\ \ 如果目的是仅仅减少重复样本,合理的值大约在 0.1 到 1 之间。如果目的是强烈抑制重复,可以将系数提高到 2,但这可能会明显降低样本质量。负值可以用来增加重复的可能性。\ \ 另见 presence_penalty,用于以固定速率惩罚至少出现一次的 tokens\ 所需范围:-2 \< x \< 2 **presence_penalty** `number | null` 默认值为 0,正值会根据新 tokens 是否出现在当前文本中对其进行惩罚,从而增加模型谈论新话题的可能性。\ \ 如果目的是稍微减少重复样本,合理的值大约在 0.1 到 1 之间。如果目的是强烈抑制重复,可以将系数提高到 2,但这可能会显著降低样本质量。负值可以用来增加重复的可能性。\ \ 另见 frequency_penalty,用于根据 tokens 出现的频率按递增速率进行惩罚\ 所需范围:-2 \< x \< 2 **repetition_penalty** `number | null` 对重复的 tokens 应用惩罚,以抑制或鼓励重复。值为 1.0 表示没有惩罚,允许自由重复。大于 1.0 的值会惩罚重复,降低重复 tokens 的可能性。介于 0.0 和 1.0 之间的值会奖励重复,增加重复 tokens 的机会。为了达到良好的平衡,通常建议使用 1.2。请注意,在仅解码器模型中,惩罚会同时应用于生成的输出和提示。\ 所需范围:0 \< x \< 2 **stop** `string | null` 最多 4 个序列,API 将停止生成更多 tokens。返回的文本包含停止序列。 **temperature** `number | null` 对话中的随机性程度,默认值为 1,介于 0 和 2 之间。较高的值(如 0.8)会使输出更加随机,而较低的值(如 0.2),会使输出更集中且确定性更强。\ \ 我们通常建议只调整此项或 top_p,而不是同时调整两者。\ 所需范围:0 \< x \< 2 **top\_p** `number | null` 作为 temperature 的替代方法,称为 nucleus sampling,模型会考虑具有 top_p 概率质量的 tokens 的结果。因此,0.1 意味着只考虑构成前 10% 概率质量的 tokens。我们通常建议只调整此项或 temperature,而不是同时调整两者。\ 所需范围:0 \< x ≤ 1 **top\_k** `integer | null` Top-k 采样是另一种采样方法,在这种方法中,k 个最可能的下一个 tokens 会被筛选出来,并且概率质量仅在这 k 个 tokens 之间重新分配。k 的值控制了在每一步生成文本时,下一个 tokens 的候选数量。\ 所需范围:1 \< x \< 128 **min\_p** `number | null` 表示一个 tokens 被考虑的最小概率的浮动值,相对于最有可能的 tokens 的概率。\ 所需范围:0 ≤ x ≤ 1 **logit_bias** `map[string, integer]` 默认为 null。修改指定 tokens 在对话中出现的可能性。接受一个 JSON 对象,将 tokens 映射到一个从 -100 到 100 的关联偏差值。 **logprobs** `boolean | null` 是否返回输出 tokens 的对数概率。如果为 true,则返回消息内容中每个输出 tokens 的对数概率。 **top_logprobs** `integer | null` 一个介于 0 到 20 之间的整数,指定在每个 tokens 位置返回的最可能的 tokens 数量,每个 tokens 都有一个关联的对数概率。如果使用此参数,必须将 logprobs 设置为 true。\ 所需范围:0 ≤ x ≤ 20 **tools** `object[] | null` 模型可以调用的工具列表。目前仅支持函数作为工具。使用此参数提供模型可能生成 JSON 输入的函数列表。 在[工具调用(Function Calling)](/docs/model/llm-function-calling)中了解更多关于函数调用的信息。 **properties** **type** `string` *required* 工具的类型。 支持的类型:`function` **function** `object` *required* **properties** **name** `string` *required* 要调用的函数名称。必须是 a-z、A-Z、0-9 或包含下划线和破折号,最大长度为 64 个字符。 **description** `string | null` 函数功能的描述,模型使用此信息来选择何时以及如何调用函数。 **parameters** `object | null` 函数接受的参数,以 JSON Schema 对象的形式描述。有关格式的文档,请参阅 [JSON Schema 参考](https://json-schema.org/understanding-json-schema/)。 **strict** `boolean` (default: false) 是否在生成函数调用时启用严格遵守 schema。如果设置为 true,模型将完全按照 parameters 字段中定义的 schema 进行操作。 **response_format** `object | null` 允许强制模型产生特定的输出格式。 设置为 `{ "type": "json_schema", "json_schema": {...} }` 启用结构化输出,确保模型匹配您提供的 JSON schema。 设置为 `{ "type": "json_object" }` 启用较旧的 JSON 模式,确保模型生成的消息是有效的 JSON。对于支持的模型,推荐使用 `json_schema`。 **properties** **type** `string` *required* (default: text) 枚举值:`text`, `json_object`, `json_schema` **json_schema** `object | null` JSON Schema 响应格式。用于生成结构化的 JSON 响应。 仅在 `type` 设置为 `json_schema` 时支持,且当 `type` 设置为 `json_schema` 时为必需项。 在[结构化输出](/docs/model/llm-structured-outputs)中了解更多信息。 **properties** **name** `string` *required* 响应格式的名称。必须是 a-z、A-Z、0-9 或包含下划线和破折号,最大长度为 64 个字符。 **description** `string | null` 响应格式用途的描述,模型使用此信息来确定如何以该格式响应。 **schema** `object | null` 响应格式的 schema,以 JSON Schema 对象的形式描述。在[这里](https://json-schema.org/specification)学习如何构建 JSON schema。 支持的类型:`string`, `number`, `integer`, `boolean`, `array`, `object`, `enum`, `anyOf`。 **strict** `boolean` (default: false) 是否在生成输出时启用严格的 schema 遵守。如果设置为 true,模型将始终遵循 schema 字段中定义的确切 schema。当 strict 为 true 时,仅支持 JSON Schema 的子集。 如果您通过提供 `strict: true` 启用结构化输出并使用不支持的 JSON Schema 调用 API,您将收到错误。 **separate_reasoning** `boolean | null` 控制是否将 “思考内容” 单独放入 “reasoning_content” 字段中。默认为 false,即不单独返回 “思考内容”。 目前支持的模型:deepseek/deepseek-r1-turbo **enable_thinking** `boolean | null` (default: false) 控制是否开启思考模式。 目前支持的模型: * deepseek/deepseek-v3.2-exp ## 响应参数 **choices** `object[]` *required* 生成的对话选择列表。 **properties** **finish_reason** `string` *required* 模型停止生成 tokens 的原因。如果模型遇到自然停止点或提供的停止序列,则为 ‘stop’;如果请求中指定的最大 tokens 数量已达到,则为 ‘length’。枚举值: `stop,length` **index** `integer` *required* 对话选择的索引。 **message** `object` *required* **properties** **role** `string` *required* 消息作者的角色。枚举值: `system, user, assistant` **content** `string | null` 消息的内容。 **reasoning_content** `string | null` 思考内容。 目前支持的模型:deepseek/deepseek-r1-turbo **created** `integer` *required* 响应生成的 Unix 时间戳(以秒为单位)。 **id** `string` *required* 响应的唯一标识符。 **model** `string` *required* 用于对话的模型。 **object** `string` *required* 对象类型,始终为 chat.completion。 **usage** `object` 使用统计。\ 对于流式回复,usage 字段被包含在返回的最后一个回复块中。 **properties** **completion_tokens** `integer` *required* 对话生成的 tokens 数。 **prompt_tokens** `integer` *required* prompt 中的 tokens 数。 **total_tokens** `integer` *required* 请求中使用的总 tokens 数(prompt + completion)。 # 创建对话请求 Source: https://ppio.com/docs/models/reference-llm-create-completion POST https://api.ppio.com/openai/v1/completions 了解 PPIO Completions 请求接口的调用方式,查阅相关请求与响应说明,为使用该接口的应用提供集成参考。 根据指定的 prompt 与参数生成模型回复 ## 请求头 **Content-Type** `string` *required* 枚举值: `application/json` **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **model** `string` *required* 对应的模型名称。可用模型名称请参考:[模型列表](https://ppio.com/model-api/product/llm-api) **prompt** `string` *required* 用于生成对话的提示(提示可以是字符串、字符串数组、tokens 数组或 tokens 数组的数组)。 **max_tokens** `integer` 在生成对话时可产生的最大 tokens 数。\ prompt 的 tokens 数量加上 max_tokens 不能超过模型的上下文长度。 **stream** `boolean | null` 是否使用流式传输。默认为 false,如果设置了,tokens 将以 data-only server-sent events(SSE)发送,并以 data: \[DONE] 消息终止流。 **stream_options** `object` 流式回复选项。仅当 stream 设置为 true 时设置。 **properties** **include_usage** `boolean` 如果设置,将在数据: \[DONE] 消息之前流式传输一个额外的 chunk。此 chunk 中的 usage 字段显示整个请求的令牌使用统计信息,而 choices 字段始终为空数组。所有其他 chunk 也将包含一个 usage 字段,但值为 null。 **n** `integer | null` 每个提示生成多少个对话。默认值为 1。\ \ 注意:由于此参数会生成多个对话,因此可能会快速消耗您的 tokens 计费额度。请谨慎使用,并确保为 max_tokens 和 stop 设置了合理的值。\ 所需范围:1 \< x \< 128 **seed** `integer | null` 如果指定,我们的系统将尽最大努力进行确定性采样,以便相同的 seed 和参数的重复请求应返回相同的结果。 **frequency_penalty** `number | null` 默认值为 0,正值会根据新 tokens 在当前文本中的出现频率对其进行惩罚,从而降低模型重复相同内容的可能性。\ \ 如果目的是仅仅减少重复样本,合理的值大约在 0.1 到 1 之间。如果目的是强烈抑制重复,可以将系数提高到 2,但这可能会明显降低样本质量。负值可以用来增加重复的可能性。\ \ 另见 presence_penalty,用于以固定速率惩罚至少出现一次的 tokens\ 所需范围:-2 \< x \< 2 **presence_penalty** `number | null` 默认值为 0,正值会根据新 tokens 是否出现在当前文本中对其进行惩罚,从而增加模型谈论新话题的可能性。\ \ 如果目的是稍微减少重复样本,合理的值大约在 0.1 到 1 之间。如果目的是强烈抑制重复,可以将系数提高到 2,但这可能会显著降低样本质量。负值可以用来增加重复的可能性。\ \ 另见 frequency_penalty,用于根据 tokens 出现的频率按递增速率进行惩罚\ 所需范围:-2 \< x \< 2 **repetition_penalty** `number | null` 对重复的 tokens 应用惩罚,以抑制或鼓励重复。值为 1.0 表示没有惩罚,允许自由重复。大于 1.0 的值会惩罚重复,降低重复 tokens 的可能性。介于 0.0 和 1.0 之间的值会奖励重复,增加重复 tokens 的机会。为了达到良好的平衡,通常建议使用 1.2。请注意,在仅解码器模型中,惩罚会同时应用于生成的输出和提示。\ 所需范围:0 \< x \< 2 **stop** `string | null` 最多 4 个序列,API 将停止生成更多 tokens。返回的文本包含停止序列。 **temperature** `number | null` 对话中的随机性程度,默认值为 1,介于 0 和 2 之间。较高的值(如 0.8)会使输出更加随机,而较低的值(如 0.2),会使输出更集中且确定性更强。\ \ 我们通常建议只调整此项或 top_p,而不是同时调整两者。\ 所需范围:0 \< x \< 2 **top\_p** `number | null` 作为 temperature 的替代方法,称为 nucleus sampling,模型会考虑具有 top_p 概率质量的 tokens 的结果。因此,0.1 意味着只考虑构成前 10% 概率质量的 tokens。我们通常建议只调整此项或 temperature,而不是同时调整两者。\ 所需范围:0 \< x ≤ 1 **top\_k** `integer | null` Top-k 采样是另一种采样方法,在这种方法中,k 个最可能的下一个 tokens 会被筛选出来,并且概率质量仅在这 k 个 tokens 之间重新分配。k 的值控制了在每一步生成文本时,下一个 tokens 的候选数量。\ 所需范围:1 \< x \< 128 **min\_p** `number | null` 表示一个 tokens 被考虑的最小概率的浮动值,相对于最有可能的 tokens 的概率。\ 所需范围:0 ≤ x ≤ 1 **logit_bias** `map[string, integer]` 默认为 null。修改指定 tokens 在对话中出现的可能性。接受一个 JSON 对象,将 tokens 映射到一个从 -100 到 100 的关联偏差值。 **logprobs** `integer | null` 返回最可能的 logprobs 个输出 token 的对数概率,同时包含被选中 token 的概率。例如,如果 logprobs 设为 5,API 会返回每步生成时前 5 个最可能 token 的对数概率列表。\ logprobs 的最大值为 5。 **best_of** `integer` 默认为 1。生成 best_of 个对话并在服务器端进行处理,返回‘最佳’(即每个 tokens 的对数概率最高的那个)。结果无法流式传输。\ \ 与 n 一起使用时,best_of 控制候选对话的数量,n 指定返回多少个对话。best_of 必须大于 n。\ \ 注意:由于此参数会生成多个对话,因此可能会快速消耗您的 tokens 计费额度。请谨慎使用,并确保为 max_tokens 和 stop 设置了合理的值。 ## 响应参数 **choices** `object[]` *required* 生成的对话选择列表。 **properties** **finish_reason** `string` *required* 模型停止生成 tokens 的原因。如果模型遇到自然停止点或提供的停止序列,则为 ‘stop’;如果请求中指定的最大 tokens 数量已达到,则为 ‘length’。枚举值: `stop,length` **index** `integer` *required* 对话选择的索引。 **logprobs** `object` *required* 最有可能的 tokens 的对数概率。 **properties** **text_offset** `integer[]` 文本偏移的整数数组。 **token_logprobs** `number[]` token 对数概率的数字数组。 **tokens** `string[]` tokens 的字符串数组。 **top_logprobs** `object[]` 包含 top 对数概率的对象数组。 **properties** **\{key}** `integer` *required* 给定键的对数概率值。 **text** `string` *required* 对话返回的内容。 **created** `integer` *required* 响应生成的 Unix 时间戳(以秒为单位)。 **id** `string` *required* 响应的唯一标识符。 **model** `string` *required* 用于对话的模型。 **object** `string` *required* 对象类型,始终为 text_completion。 **usage** `object` *required* 使用统计。\ 对于流式回复,usage 字段被包含在返回的最后一个回复块中。 **properties** **completion_tokens** `integer` *required* 对话生成的 tokens 数。 **prompt_tokens** `integer` *required* prompt 中的 tokens 数。 **total_tokens** `integer` *required* 请求中使用的总 tokens 数(prompt + completion)。 # 创建嵌入请求 Source: https://ppio.com/docs/models/reference-llm-create-embeddings POST https://api.ppio.com/openai/v1/embeddings 查阅 PPIO Embeddings 嵌入请求接口,了解向量表示服务的调用方式,为语义检索、文本处理与 AI 应用集成提供参考。 创建一个表示输入文本的嵌入向量。 ## 请求头 **Content-Type** `string` *required* 枚举值: `application/json` **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **input** `string | arrary` *required* 要嵌入的输入文本,编码为字符串或 tokens 数组。要在单个请求中嵌入多个输入,请传入字符串数组或 tokens 数组的数组。输入不得超过模型的最大输入 tokens(text-embedding-ada-002 的最大输入为 8192 个 tokens),不能是空字符串,且任何数组的维度不得超过 2048。 **model** `enum\` *required* 要使用的模型 ID。Enum: `baai/bge-m3` **encoding_format** `string` 返回嵌入的格式。可以为 float 或 base64。 ## 响应参数 **object** `string` *required* 固定为 list **data** `object[]` *required* 模型生成的嵌入列表。 **properties** **index** `integer` *required* 嵌入向量的索引。 **embedding** `number[]` *required* 嵌入向量。 **object** `string` *required* 固定为 embedding **model** `string` *required* 使用的模型 ID。 **usage** `object` *required* 使用情况信息。 **properties** **prompt_tokens** `integer` *required* prompt tokens 的数量。 **total_tokens** `integer` *required* 总 tokens 的数量。 # 创建重排序请求 Source: https://ppio.com/docs/models/reference-llm-create-rerank POST https://api.ppio.com/openai/v1/rerank 了解 PPIO Rerank 重排序接口,查阅相关请求配置与结果处理方式,为检索应用组织候选结果排序提供接入参考。 创建一个重排序请求。 ## 请求头 **Content-Type** `string` *required* 枚举值: `application/json` **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **model** `string` *required* 要使用的模型名称。 **query** `string` *required* 查询内容。 **documents** `string[]` *required* 文档列表。 **top\_n** `integer` 返回最相关文档或索引的数量。 ## 响应参数 **id** `string` *required* ID **results** `object[]` *required* **properties** **document** `object` 文档内容。 **properties** **text** `string` **index** `integer` 在输入候选文档数组中的索引值。 **relevance_score** `number` 相似度分数。 **usage** `object` Token 使用统计信息。 **properties** **completion_tokens** `integer` *required* 对话生成的 tokens 数。 **prompt_tokens** `integer` *required* prompt 中的 tokens 数。 **total_tokens** `integer` *required* 请求中使用的总 tokens 数(prompt + completion)。 # 删除文件 Source: https://ppio.com/docs/models/reference-llm-delete-file DELETE https://api.ppio.com/openai/v1/files/{file_id} 查阅 PPIO 模型服务删除文件接口,了解如何清理不再使用的文件资源,为维护模型任务输入和文件清单提供参考。 根据文件 ID 删除指定文件。 ## 请求头 **Content-Type** `string` *required* 枚举值: `application/json` **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 路径参数 **file_id** `string` *required* 要删除的文件唯一标识符。 ## 响应 **deleted** `boolean` *required* 指示文件是否被成功删除。删除成功时返回 `true`。 **id** `string` *required* 被删除文件的唯一标识符。 **object** `string` *required* 对象类型,恒为 `file`。 # 查询批处理任务列表 Source: https://ppio.com/docs/models/reference-llm-list-batches GET https://api.ppio.com/openai/v1/batches 了解 PPIO LLM 批处理任务列表接口,查阅如何获取已有批量任务信息,为跟踪异步推理工作和组织任务清单提供参考。 查询所有可用的批处理任务列表。 ## 请求头 **Content-Type** `string` *required* 枚举值: `application/json` **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 响应 **data** `object[]` *required* 批处理任务对象数组。 **properties** **id** `string` *required* 批处理任务的唯一标识符。 **object** `string` *required* 对象类型,恒为 `batch`。 **endpoint** `string` *required* 批处理任务用于处理请求的 API 端点。 **input_file_id** `string` *required* 包含批处理请求的输入文件 ID。 **output_file_id** `string` *required* 包含批处理结果的输出文件 ID。在批处理完成之前为空。 **error_file_id** `string` *required* 包含批处理过程中发生的错误的错误文件 ID。在出现错误之前为空。 **completion_window** `string` *required* 批处理完成的时间窗口。当前固定为 `48h`。 **in_progress_at** `string | null` 批处理开始处理的时间戳。若尚未开始则为 null。 **expires_at** `string | null` 批处理到期的时间戳。若未设置则为 null。 **finalizing_at** `string | null` 批处理开始进入最终化阶段的时间戳。若尚未进入则为 null。 **completed_at** `string | null` 批处理完成的时间戳。若尚未完成则为 null。 **failed_at** `string | null` 批处理失败的时间戳。若未失败则为 null。 **expired_at** `string | null` 批处理过期的时间戳。若未过期则为 null。 **cancelling_at** `string | null` 批处理开始取消的时间戳。若未在取消中则为 null。 **cancelled_at** `string | null` 批处理被取消的时间戳。若未被取消则为 null。 **status** `string` *required* 批处理任务的当前状态。 可用状态: * `VALIDATING` - 在批处理开始前正在验证输入文件 * `PROGRESS` - 批处理进行中 * `COMPLETED` - 批处理成功完成 * `FAILED` - 批处理失败 * `EXPIRED` - 批处理超过截止时间 * `CANCELLING` - 正在取消批处理 * `CANCELLED` - 批处理已取消 **errors** `string` 批处理过程中发生错误时的错误信息。 **version** `integer` *required* 批处理任务的版本号。 **created_at** `string` *required* 批处理任务的创建时间戳。 **updated_at** `string | null` 批处理任务最近一次更新的时间戳。若从未更新则为 null。 **created_by** `string` *required* 创建该批处理任务的用户唯一标识符。 **created_by_key_id** `string` *required* 用于创建该批处理任务的 API Key ID。 **remark** `string` 批处理任务的可选备注信息。 **total** `integer` *required* 批处理中的请求总数。 **completed** `integer` *required* 批处理中已完成的请求数量。 **failed** `integer` *required* 批处理中失败的请求数量。 **metadata** `object | null` 与批处理任务关联的附加元数据。若无则为 null。 **request_counts** `object` *required* 请求计数的详细信息。 **properties** **total** `integer` *required* 批处理中的请求总数。 **completed** `integer` *required* 成功完成的请求数量。 **failed** `integer` *required* 失败的请求数量。 **first_id** `string` *required* 列表中第一个批处理任务的 ID。 **has_more** `boolean` *required* 指示在该列表之外是否还有更多批处理任务。 **last_id** `string` *required* 列表中最后一个批处理任务的 ID。 **object** `string` *required* 对象类型,恒为 `list`。 # 查询文件列表 Source: https://ppio.com/docs/models/reference-llm-list-files GET https://api.ppio.com/openai/v1/files 查阅 PPIO 模型服务文件列表接口,了解已有文件资源的查询方式,为选择任务输入、维护文件清单和组织批处理提供参考。 查询所有可用的文件列表。 ## 请求头 **Content-Type** `string` *required* 枚举值: `application/json` **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 响应 **code** `string` *required* 表示请求结果的 HTTP 状态码。 **message** `string` *required* 关于请求结果的描述信息。 **data** `object[]` *required* 文件对象数组。 **properties** **id** `string` *required* 文件的唯一标识符。 **object** `string` *required* 对象类型,恒为 `file`。 **bytes** `integer` *required* 文件大小(字节)。 **filename** `string` *required* 文件名。 **created_at** `integer` *required* 文件创建时的 Unix 时间戳(秒)。 **expires_at** `integer` 文件到期的 Unix 时间戳(秒)。仅对输出文件返回。 **purpose** `string` *required* 文件的用途。 可用用途: * `batch` - 批处理的输入文件 * `batch_output` - 批处理的输出文件 **metadata** `object` *required* 关于该文件的附加元数据。 **properties** **total_requests** `integer` 批处理输入文件中的请求总数。仅对批处理输入文件返回。 # 列出模型 Source: https://ppio.com/docs/models/reference-llm-list-models GET https://api.ppio.com/openai/v1/models 了解 PPIO 模型列表接口的使用方式,查阅如何获取模型信息,为应用准备模型选择与请求配置提供接入参考。 列出当前可用的 LLM 模型,并提供每个模型的基本信息。 该 Endpoint 与 OpenAI API 兼容。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 响应参数 **data** `object[]` *required* 包含以下属性的模型对象的数组。字段含义与[检索模型](/docs/models/reference-llm-retrieve-model)接口返回的模型对象一致。 **properties** **id** `string` *required* 模型 ID ,用于标识模型。可以在 API Endpoints 中引用。 **created** `integer` *required* 模型创建时的 Unix 时间戳(以秒为单位)。 **object** `string` *required* 对象类型。取值固定为 model 。 **owned_by** `string` *required* 模型所属方。取值固定为 ppio 。 **permission** `null` *required* OpenAI 兼容字段,固定返回 null 。 **root** `string` *required* OpenAI 兼容字段,固定返回空字符串。 **parent** `string` *required* OpenAI 兼容字段,固定返回空字符串。 **title** `string` *required* 模型名称,与 id 相同。 **display_name** `string` *required* 模型展示名称,例如 GLM 5.1 。 **description** `string` *required* 模型描述。 **tags** `string[]` *required* 模型标签列表,没有标签时为空数组。 **model_type** `string` *required* 模型类型,取值为 chat 。 **status** `integer` *required* 模型状态。1 表示可用,3 表示待上线,4 表示已下架。 **context_size** `integer` *required* 模型允许的最大上下文长度。 **max_output_tokens** `integer` 模型单次请求允许输出的最大 Token 数。 **min_output_tokens** `integer` 模型单次请求要求输出的最小 Token 数。仅配置了该限制的模型返回。 **features** `string[]` 模型支持的能力标识,取值为 function-calling 、structured-outputs 、reasoning 、serverless 。没有能力标识的模型不返回该字段。 **endpoints** `string[]` *required* 模型支持的 Endpoint,取值为 chat/completions 、completions 、responses 、anthropic 。 **input_modalities** `string[]` *required* 模型支持的输入模态,取值为 text 、image 、video 、audio 。 **output_modalities** `string[]` *required* 模型支持的输出模态,取值为 text 、audio 。 **input_token_price_per\_m** `integer` *required* 输入价格(每百万 Token)。单位为万分之一元,例如 60000 表示 6 元。已包含当前生效的折扣,与 pricing.prompt.price_per_m 相同;不返回 pricing 的模型该值为 0。 **output_token_price_per\_m** `integer` *required* 输出价格(每百万 Token)。单位为万分之一元。已包含当前生效的折扣,与 pricing.completion.price_per_m 相同;不返回 pricing 的模型该值为 0。 **pricing** `object` 按计费项拆分的价格,每个计费项同时给出目录价和折后价。没有价格的模型不返回该字段。 每个计费项都包含以下 4 个字段: * origin_price_per_m:目录价(每百万 Token),单位为万分之一元。 * price_per_m:当前生效折扣后的价格(每百万 Token),单位为万分之一元。没有折扣时与 origin_price_per_m 相同。 * origin_price_per_m_decimal:目录价(每百万 Token),单位为元,以字符串返回。 * price_per_m_decimal:折后价(每百万 Token),单位为元,以字符串返回。 精确值以 decimal 字段为准;decimal 字段为空字符串时以整数字段为准。 **properties** **prompt** `object` *required* 输入 Token 价格。 **completion** `object` *required* 输出 Token 价格。 **input_cache_read** `object` 缓存读取价格,即命中 Prompt Cache 的输入 Token 价格。仅支持 Prompt Cache 的模型返回。 **input_cache_write** `object` 缓存写入价格,即写入 Prompt Cache 的输入 Token 价格。仅缓存写入单独计费的模型返回。 **input_cache_write_1h** `object` 缓存有效期为 1 小时时的缓存写入价格。仅支持 1 小时缓存的模型返回。 **multimodal_input** `object[]` 按输入模态拆分的输入价格,仅按模态分别计价的模型返回。每项包含 modals(模态列表,例如 \["image"])、input_token_base_price(目录价)和 input_token_discount_price(折后价),价格为每百万 Token,单位为万分之一元。 **multimodal_output** `object[]` 按输出模态拆分的输出价格,仅按模态分别计价且有非文本输出的模型返回。每项包含 modals、output_token_base_price(目录价)和 output_token_discount_price(折后价),价格为每百万 Token,单位为万分之一元。 **is_tiered_billing** `boolean` *required* 是否阶梯计费。为 true 时价格按单次请求的 Token 数分区间,各区间价格见 tiered_billing_configs 。 **tiered_billing_configs** `object[]` 阶梯计费配置,仅 is_tiered_billing 为 true 时返回。单次请求按输入 Token 数落入的区间计费;少数模型同时按输出 Token 数划分区间。阶梯计费模型的实际价格以各区间的 pricing 为准,顶层 input_token_price_per_m 和 output_token_price_per_m 与最高输入区间一致。 **properties** **min_tokens** `integer` *required* 区间的输入 Token 数下限。 **max_tokens** `integer` *required* 区间的输入 Token 数上限。 **output_min_tokens** `integer` 区间的输出 Token 数下限。仅同时按输出 Token 数划分的区间返回。 **output_max_tokens** `integer` 区间的输出 Token 数上限。仅同时按输出 Token 数划分的区间返回。 **pricing** `object` *required* 该区间的价格,结构与顶层 pricing 相同,包含 prompt 、completion 以及该区间单独配置的缓存计费项。 # 查询文件 Source: https://ppio.com/docs/models/reference-llm-query-file GET https://api.ppio.com/openai/v1/files/{file_id} 查阅 PPIO 模型服务文件查询接口,了解指定文件信息的读取方式,为核对任务输入和维护文件资源提供参考。 根据文件 ID 查询指定文件的详细信息。 ## 请求头 **Content-Type** `string` *required* 枚举值: `application/json` **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 路径参数 **file_id** `string` *required* 要查询的文件唯一标识符。 ## 响应 **id** `string` *required* 文件的唯一标识符。 **object** `string` *required* 对象类型,恒为 `file`。 **bytes** `integer` *required* 文件大小(字节)。 **filename** `string` *required* 文件名。 **created_at** `integer` *required* 文件创建时的 Unix 时间戳(秒)。 **expires_at** `integer` 文件到期的 Unix 时间戳(秒)。仅对输出文件返回。 **purpose** `string` *required* 文件的用途。 可用用途: * `batch` - 批处理的输入文件 * `batch_output` - 批处理的输出文件 **metadata** `object` *required* 关于该文件的附加元数据。 **properties** **total_requests** `integer` 批处理输入文件中的请求总数。仅对批处理输入文件返回。 # 查询批处理任务 Source: https://ppio.com/docs/models/reference-llm-retrieve-batch GET https://api.ppio.com/openai/v1/batches/{batch_id} 了解 PPIO LLM 批处理任务查询接口,查阅指定任务信息的获取方式,为跟踪批量推理进展和组织结果处理提供参考。 根据批处理任务的 ID,查询该任务的状态与详细信息。 ## 请求头 **Content-Type** `string` *required* 枚举值: `application/json` **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 路径参数 **batch_id** `string` *required* 要查询的批处理任务唯一标识符。 ## 响应 **id** `string` *required* 批处理任务的唯一标识符。 **object** `string` *required* 对象类型,恒为 `batch`。 **endpoint** `string` *required* 批处理任务用于处理请求的 API 端点。 **input_file_id** `string` *required* 包含批处理请求的输入文件 ID。 **output_file_id** `string` *required* 包含批处理结果的输出文件 ID。在批处理完成之前为空。 **error_file_id** `string` *required* 包含批处理过程中发生的错误的错误文件 ID。在出现错误之前为空。 **completion_window** `string` *required* 批处理完成的时间窗口。当前固定为 `48h`。 **in_progress_at** `string | null` 批处理开始处理的时间戳。若尚未开始则为 null。 **expires_at** `string | null` 批处理到期的时间戳。若未设置则为 null。 **finalizing_at** `string | null` 批处理开始进入最终化阶段的时间戳。若尚未进入则为 null。 **completed_at** `string | null` 批处理完成的时间戳。若尚未完成则为 null。 **failed_at** `string | null` 批处理失败的时间戳。若未失败则为 null。 **expired_at** `string | null` 批处理过期的时间戳。若未过期则为 null。 **cancelling_at** `string | null` 批处理开始取消的时间戳。若未在取消中则为 null。 **cancelled_at** `string | null` 批处理被取消的时间戳。若未被取消则为 null。 **status** `string` *required* 批处理任务的当前状态。 可用状态: * `VALIDATING` - 在批处理开始前正在验证输入文件 * `PROGRESS` - 批处理进行中 * `COMPLETED` - 批处理成功完成 * `FAILED` - 批处理失败 * `EXPIRED` - 批处理超过截止时间 * `CANCELLING` - 正在取消批处理 * `CANCELLED` - 批处理已取消 **errors** `string` 批处理过程中发生错误时的错误信息。 **version** `integer` *required* 批处理任务的版本号。 **created_at** `string` *required* 批处理任务的创建时间戳。 **updated_at** `string | null` 批处理任务最近一次更新的时间戳。若从未更新则为 null。 **created_by** `string` *required* 创建该批处理任务的用户唯一标识符。 **created_by_key_id** `string` *required* 用于创建该批处理任务的 API Key ID。 **remark** `string` 批处理任务的可选备注信息。 **total** `integer` *required* 批处理中的请求总数。 **completed** `integer` *required* 批处理中已完成的请求数量。 **failed** `integer` *required* 批处理中失败的请求数量。 **metadata** `object | null` 与批处理任务关联的附加元数据。若无则为 null。 **request_counts** `object` *required* 请求计数的详细信息。 **properties** **total** `integer` *required* 批处理中的请求总数。 **completed** `integer` *required* 成功完成的请求数量。 **failed** `integer` *required* 失败的请求数量。 # 查询文件内容 Source: https://ppio.com/docs/models/reference-llm-retrieve-file-content GET https://api.ppio.com/openai/v1/files/{file_id}/content 查阅 PPIO 模型服务文件内容读取接口,了解如何获取指定文件的数据,为处理模型任务文件和后续结果分析提供参考。 根据文件 ID 获取指定文件的内容。通常用于下载批处理的输出文件或错误文件。 ## 请求头 **Content-Type** `string` *required* 枚举值: `application/json` **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 路径参数 **file_id** `string` *required* 要获取内容的文件唯一标识符。 ## 响应 响应返回原始文件内容。对于批处理输出文件,内容为 JSONL 格式,其中每一行包含一个批处理请求的结果。 **示例响应** 对于批处理输出文件,每一行的内容类似如下: ```json theme={null} { "custom_id": "request-2589", "error": null, "id": "batch_req_task_d2c", "response": { "body": { "id": "29e1432c-edfb-44a4-b531-c23c600abfae", "object": "chat.completion", "created": 1754902266, "model": "deepseek-test", "choices": [ { "index": 0, "message": { "role": "assistant", "content": "你好!👋 今天我能为你做些什么?😊" }, "finish_reason": "stop" } ], "usage": { "prompt_tokens": 5, "completion_tokens": 13, "total_tokens": 18 } }, "request_id": "request-2589", "status_code": 200 } } ``` # 检索模型 Source: https://ppio.com/docs/models/reference-llm-retrieve-model GET https://api.ppio.com/openai/v1/models/{model} 了解 PPIO 模型检索接口,查阅指定模型信息的读取方式,为应用核对模型标识和准备服务调用提供参考。 检索模型实例,并提供相关模型的基本信息。 该 Endpoint 与 OpenAI API 兼容。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 路径参数 **id** `string` *required* 用于此请求的模型 ID 。 ## 响应参数 **id** `string` *required* 模型 ID ,用于标识模型。可以在 API Endpoints 中引用。 **created** `integer` *required* 模型创建时的 Unix 时间戳(以秒为单位)。 **object** `string` *required* 对象类型。取值固定为 model 。 **owned_by** `string` *required* 模型所属方。取值固定为 ppio 。 **permission** `null` *required* OpenAI 兼容字段,固定返回 null 。 **root** `string` *required* OpenAI 兼容字段,固定返回空字符串。 **parent** `string` *required* OpenAI 兼容字段,固定返回空字符串。 **title** `string` *required* 模型名称,与 id 相同。 **display_name** `string` *required* 模型展示名称,例如 GLM 5.1 。 **description** `string` *required* 模型描述。 **tags** `string[]` *required* 模型标签列表,没有标签时为空数组。 **model_type** `string` *required* 模型类型,取值为 chat 。 **status** `integer` *required* 模型状态。1 表示可用,3 表示待上线,4 表示已下架。 **context_size** `integer` *required* 模型允许的最大上下文长度。 **max_output_tokens** `integer` 模型单次请求允许输出的最大 Token 数。 **min_output_tokens** `integer` 模型单次请求要求输出的最小 Token 数。仅配置了该限制的模型返回。 **features** `string[]` 模型支持的能力标识,取值为 function-calling 、structured-outputs 、reasoning 、serverless 。没有能力标识的模型不返回该字段。 **endpoints** `string[]` *required* 模型支持的 Endpoint,取值为 chat/completions 、completions 、responses 、anthropic 。 **input_modalities** `string[]` *required* 模型支持的输入模态,取值为 text 、image 、video 、audio 。 **output_modalities** `string[]` *required* 模型支持的输出模态,取值为 text 、audio 。 **input_token_price_per\_m** `integer` *required* 输入价格(每百万 Token)。单位为万分之一元,例如 60000 表示 6 元。已包含当前生效的折扣,与 pricing.prompt.price_per_m 相同;不返回 pricing 的模型该值为 0。 **output_token_price_per\_m** `integer` *required* 输出价格(每百万 Token)。单位为万分之一元。已包含当前生效的折扣,与 pricing.completion.price_per_m 相同;不返回 pricing 的模型该值为 0。 **pricing** `object` 按计费项拆分的价格,每个计费项同时给出目录价和折后价。没有价格的模型不返回该字段。 每个计费项都包含以下 4 个字段: * origin_price_per_m:目录价(每百万 Token),单位为万分之一元。 * price_per_m:当前生效折扣后的价格(每百万 Token),单位为万分之一元。没有折扣时与 origin_price_per_m 相同。 * origin_price_per_m_decimal:目录价(每百万 Token),单位为元,以字符串返回。 * price_per_m_decimal:折后价(每百万 Token),单位为元,以字符串返回。 精确值以 decimal 字段为准;decimal 字段为空字符串时以整数字段为准。 **properties** **prompt** `object` *required* 输入 Token 价格。 **completion** `object` *required* 输出 Token 价格。 **input_cache_read** `object` 缓存读取价格,即命中 Prompt Cache 的输入 Token 价格。仅支持 Prompt Cache 的模型返回。 **input_cache_write** `object` 缓存写入价格,即写入 Prompt Cache 的输入 Token 价格。仅缓存写入单独计费的模型返回。 **input_cache_write_1h** `object` 缓存有效期为 1 小时时的缓存写入价格。仅支持 1 小时缓存的模型返回。 **multimodal_input** `object[]` 按输入模态拆分的输入价格,仅按模态分别计价的模型返回。每项包含 modals(模态列表,例如 \["image"])、input_token_base_price(目录价)和 input_token_discount_price(折后价),价格为每百万 Token,单位为万分之一元。 **multimodal_output** `object[]` 按输出模态拆分的输出价格,仅按模态分别计价且有非文本输出的模型返回。每项包含 modals、output_token_base_price(目录价)和 output_token_discount_price(折后价),价格为每百万 Token,单位为万分之一元。 **is_tiered_billing** `boolean` *required* 是否阶梯计费。为 true 时价格按单次请求的 Token 数分区间,各区间价格见 tiered_billing_configs 。 **tiered_billing_configs** `object[]` 阶梯计费配置,仅 is_tiered_billing 为 true 时返回。单次请求按输入 Token 数落入的区间计费;少数模型同时按输出 Token 数划分区间。阶梯计费模型的实际价格以各区间的 pricing 为准,顶层 input_token_price_per_m 和 output_token_price_per_m 与最高输入区间一致。 **properties** **min_tokens** `integer` *required* 区间的输入 Token 数下限。 **max_tokens** `integer` *required* 区间的输入 Token 数上限。 **output_min_tokens** `integer` 区间的输出 Token 数下限。仅同时按输出 Token 数划分的区间返回。 **output_max_tokens** `integer` 区间的输出 Token 数上限。仅同时按输出 Token 数划分的区间返回。 **pricing** `object` *required* 该区间的价格,结构与顶层 pricing 相同,包含 prompt 、completion 以及该区间单独配置的缓存计费项。 # 上传文件 Source: https://ppio.com/docs/models/reference-llm-upload-batch-input-file POST https://api.ppio.com/openai/v1/files 查阅 PPIO 模型批处理输入文件上传接口,了解文件提交方式与相关请求说明,为组织批量推理任务准备输入资源。 上传批处理输入文件,以便在创建批处理时能够被正确引用。 ## 请求头 **Content-Type** `string` *required* 枚举值: `application/json` **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **file** `file` *required* 上传的文件应为批处理输入文件,格式为 `.jsonl`,其中每行描述一个 API 推理请求的详细信息。 每个请求必须包含一个唯一的 `custom_id`,以便在批处理完成后在输出文件中查找相应的推理结果。每行的 `body` 字段中的参数将作为实际推理请求参数发送到指定的 endpoint。 > [!WARNING] > > 单个 JSONL 文件中的所有请求必须使用同一个模型,请不要在一个批次中混合不同模型的请求。 以下是包含两个请求的示例输入文件: ```JSON theme={null} {"custom_id": "request-1", "body": {"model": "deepseek/deepseek-v3-0324", "messages": [{"role": "user", "content": "Hello, world!"}], "max_tokens": 400}} {"custom_id": "request-2", "body": {"model": "deepseek/deepseek-v3-0324", "messages": [{"role": "system", "content": "You are a helpful assistant."},{"role": "user", "content": "Hello world!"}],"max_tokens": 1000}} ``` **purpose** `string` *required* 上传文件的用途。用于批处理时,应设置为 `batch`。 枚举值: `batch` ## 响应 **id** `string` *required* 上传文件的唯一标识符。 **object** `string` *required* 对象类型,恒为 `file`。 **bytes** `integer` *required* 上传文件的字节大小。 **created_at** `integer` *required* 文件创建时的 Unix 时间戳(秒)。 **filename** `string` *required* 上传文件的名称。 **purpose** `string` *required* 上传文件的用途。 **metadata** `object` 关于上传文件的附加元数据。 **properties** **total_requests** `integer` *required* 批处理输入文件中包含的请求总数。 # MiniMax H3 Source: https://ppio.com/docs/models/reference-minimax-h3 查阅 PPIO MiniMax H3 视频生成原厂协议,了解视频生成、视频重生成和 H3-Context-IR 的请求字段、任务查询和计费规则。 `POST https://api.ppio.com/v3/minimax/v2/video_generation` 参数及使用方式已对齐官方,详细参数可直接参考官方文档。 ## 一、概述 本文档说明 MiniMax H3 视频生成原厂协议的调用方式、请求参数、任务查询和计费规则。 MiniMax H3 为异步视频生成接口:提交任务后返回任务 ID,客户端通过查询接口获取任务状态。任务成功后,响应中的 `content.url` 为生成结果地址。 参数及使用方式已对齐官方,详细参数可直接参考官方文档。 ### 1.1 接口地址 MiniMax H3 原厂协议包含三种能力,创建接口各不相同,查询接口共用: | 能力 | 创建任务 | | - | - | | 视频生成 | `POST /v3/minimax/v2/video_generation` | | 视频重生成 | `POST /v3/minimax/v2/video_regeneration` | | H3-Context-IR | `POST /v3/minimax/v2/h3_context_ir` | 三种能力共用同一个查询接口: ``` GET https://{api_domain}/v3/minimax/v2/query/video_generation/{task_id} ``` 其中 `{api_domain}` 为平台为您提供的 API 域名,`{task_id}` 为创建任务接口返回的任务 ID。查询响应中的 `task.task_type` 区分能力(`generation`、`regeneration` 或 `h3_context_ir`)。 ### 1.2 鉴权 所有请求都需要携带平台 API Key;创建任务的 POST 请求还必须指定 JSON 内容类型: ```http theme={null} Authorization: Bearer Content-Type: application/json ``` ### 1.3 支持模型 请求体中的 `model` 决定使用的模型,可选值如下: | 模型 | 支持分辨率 | 输入计费 | | - | - | - | | `MiniMax-H3` | `768P`、`2K` | 输入图片前 5 张免费,超出部分按张计费;参考视频输入按秒计费 | | `MiniMax-H3-Max` | `480P`、`768P` | 输入图片前 2 张免费,超出部分按张计费;参考视频输入按秒计费 | | `MiniMax-H3-Highspeed` | `480P`、`768P` | 输入图片前 5 张免费,超出部分按张计费;参考视频输入按秒计费 | | `MiniMax-H3-Lite` | `480P`、`768P` | 输入图片前 5 张免费,超出部分按张计费;参考视频输入按秒计费 | 四个模型共用相同的接口地址、鉴权方式、请求与查询结构,仅 `model` 取值、支持的分辨率以及输入计费方式不同。 ### 1.4 计费说明 MiniMax H3 按实际生成用量计费,任务提交时不预扣费: | 用量 | 计费单位 | | - | - | | 输入图片 | MiniMax-H3、MiniMax-H3-Highspeed 与 MiniMax-H3-Lite 前 5 张不计费、MiniMax-H3-Max 前 2 张不计费,超过部分按张计费 | | 参考视频输入 | 秒 | | 生成视频输出 | 秒 | 768P 和 2K 使用不同的价格档位。具体单价以您所在平台的价格页面为准。失败或取消的任务不产生成功生成费用。MiniMax-H3-Max 按 480P / 768P 分档,输入图片前 2 张免费、超出部分按张计费,参考视频输入按秒计费。MiniMax-H3-Highspeed 与 MiniMax-H3-Lite 按 480P / 768P 分档,输入计费规则与 MiniMax-H3 相同。 ### 1.5 计费与 usage 字段对照 每次生成成功后,响应的 usage 里会返回本次用量。费用只和其中的秒数 / 图片数有关,按视频分辨率分档定价(H3 为 768P / 2K,H3-Max、H3-Highspeed 与 H3-Lite 为 480P / 768P),token 相关字段不参与计费。下表以 MiniMax-H3 为例逐字段说明;MiniMax-H3-Highspeed 与 MiniMax-H3-Lite 的规则与 MiniMax-H3 相同;MiniMax-H3-Max 的规则相同,仅输入图片免费张数为 2。逐字段说明如下: | usage 字段 | 含义 | 是否计费 | 计费规则 | | - | - | - | - | | output_seconds | 生成视频的输出时长(秒) | ✅ 计费 | 按分辨率单价 × output_seconds | | input_seconds | 输入视频时长(秒) | ✅ 计费(为 0 则不收) | 按分辨率单价 × input_seconds | | input_image_count | 输入图片张数 | ✅ 超出部分计费 | H3 / H3-Highspeed / H3-Lite 前 5 张免费:(input_image_count − 5) × 图片单价;H3-Max 前 2 张免费:(input_image_count − 2) × 图片单价 | | total_seconds | = input_seconds + output_seconds | ❌ 不计费 | 仅为汇总校验 | | total_tokens | 上游返回的 token 统计 | ❌ 不计费 | 仅供参考,不参与计费 | | prompt_tokens | 同上 | ❌ 不计费 | 仅供参考 | | completion_tokens | 同上 | ❌ 不计费 | 仅供参考 | 计费公式:单项费用 = 分辨率单价 × 用量;本次费用 = 各计费项之和。视频分辨率可在查询响应的 task.resolution 字段查看。任务成功后一次性结算,失败或取消不计费。 ## 二、创建视频生成任务 ### 2.1 请求示例:文生视频 文生视频必须提供文本提示词和非自适应画幅: ```bash theme={null} curl -X POST 'https://{api_domain}/v3/minimax/v2/video_generation' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "model": "MiniMax-H3", "content": [ { "type": "text", "text": "A cinematic product video in a clean studio" } ], "resolution": "768P", "duration": 4, "ratio": "16:9" }' ``` MiniMax-H3-Highspeed 与 MiniMax-H3-Lite 的请求结构相同,替换 `model` 即可,`resolution` 可选 `480P` 或 `768P`: ```bash theme={null} curl -X POST 'https://{api_domain}/v3/minimax/v2/video_generation' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "model": "MiniMax-H3-Lite", "content": [ { "type": "text", "text": "A cinematic product video in a clean studio" } ], "resolution": "480P", "duration": 4, "ratio": "16:9" }' ``` ### 2.2 请求示例:首帧生视频 ```bash theme={null} curl -X POST 'https://{api_domain}/v3/minimax/v2/video_generation' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "model": "MiniMax-H3", "content": [ { "type": "text", "text": "Animate the subject naturally and keep the composition stable" }, { "type": "image_url", "image_url": { "url": "https://your-cdn.example.com/first-frame.png" }, "role": "first_frame" } ], "resolution": "768P", "duration": 4, "ratio": "adaptive" }' ``` 也可以传一张不带 `role` 的图片作为唯一图片,此时它按首帧处理。 ### 2.3 请求示例:参考素材生视频 参考图片、视频和音频使用对应的 `role`: ```bash theme={null} curl -X POST 'https://{api_domain}/v3/minimax/v2/video_generation' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "model": "MiniMax-H3", "content": [ { "type": "text", "text": "Create a product demonstration while preserving the reference style" }, { "type": "image_url", "image_url": { "url": "https://your-cdn.example.com/product.png" }, "role": "reference_image" }, { "type": "video_url", "video_url": { "url": "https://your-cdn.example.com/reference.mp4" }, "role": "reference_video" }, { "type": "audio_url", "audio_url": { "url": "https://your-cdn.example.com/reference.mp3" }, "role": "reference_audio" } ], "resolution": "2K", "duration": 6, "ratio": "16:9" }' ``` ### 2.4 请求字段 | 字段 | 类型 | 必填 | 说明 | | - | - | - | - | | `model` | string | 是 | `MiniMax-H3`、`MiniMax-H3-Max`、`MiniMax-H3-Highspeed` 或 `MiniMax-H3-Lite` | | `content` | array | 是 | 多模态输入列表;每个请求必须包含一个非空 `text` 项 | | `content[].type` | string | 是 | `text`、`image_url`、`video_url` 或 `audio_url` | | `content[].text` | string | 文本项必填 | 非空提示词,每个文本项最多 7000 个字符 | | `content[].image_url.url` | string | 图片项必填 | 公网 URL、`mm_file://{file_id}` 或图片 Base64 data URI | | `content[].video_url.url` | string | 视频项必填 | 公网 URL、`mm_file://{file_id}` 或 MP4 Base64 data URI | | `content[].audio_url.url` | string | 音频项必填 | 公网 URL、`mm_file://{file_id}` 或音频 Base64 data URI | | `content[].role` | string | 按场景必填 | `first_frame`、`last_frame`、`reference_image`、`reference_video` 或 `reference_audio`;唯一图片不写 `role` 时按首帧处理 | | `resolution` | string | 是 | Minimax-H3:`768P` 或 `2K`;Minimax-H3-Max:`480P` 或 `768P`;MiniMax-H3-Highspeed 与 MiniMax-H3-Lite:`480P` 或 `768P` | | `duration` | integer | 是 | Minimax-H3:4 至 15 秒的整数;Minimax-H3-Max:5 至 15 秒的整数;MiniMax-H3-Highspeed 与 MiniMax-H3-Lite:4 至 15 秒的整数 | | `ratio` | string | 文生视频必填 | `adaptive`、`21:9`、`16:9`、`4:3`、`1:1`、`3:4` 或 `9:16`;文生视频不可用 `adaptive`,图生视频固定按 `adaptive` 处理;MiniMax-H3-Lite 的参考素材生视频不支持 `adaptive` | | `callback_url` | string | 否 | 不支持。传入该字段会返回 400,请通过查询接口轮询任务状态 | ### 2.5 内容组合规则 | 规则 | 限制 | | - | - | | 文本 | 每个请求必须包含一个非空文本提示词;每个文本项最多 7000 个字符 | | 首帧/尾帧 | 首帧和尾帧各最多 1 张;支持仅首帧、仅尾帧以及首尾帧组合 | | 参考图片 | 最多 9 张,使用 `role=reference_image` | | 参考视频 | 最多 3 个,使用 `role=reference_video`;单段 2 至 15 秒,总时长不超过 15 秒 | | 参考音频 | 最多 3 个,使用 `role=reference_audio`;单段 2 至 15 秒,总时长不超过 15 秒;可作为唯一一种参考素材与文本一起提交 | | 素材模式 | 首帧/尾帧模式不能和 `reference_image`、`reference_video`、`reference_audio` 模式混用 | | 文生视频画幅 | 必须传 `ratio`,且不能使用 `adaptive` | | 图生视频画幅 | 由输入图片决定,始终按 `adaptive` 处理;传入其他合法值会被忽略 | | 参考素材生视频画幅 | `ratio` 可省略,默认 `adaptive`;也可指定具体画幅。MiniMax-H3-Lite 不支持 `adaptive`,必须指定具体画幅 | | 回调 | 不支持 `callback_url`(传入返回 400);请通过查询接口轮询,状态值为 `queued`、`running`、`succeeded`、`failed`、`cancelled` | ### 2.6 输入素材限制 单次请求体总大小不得超过 64 MB。Base64 会使数据体积增加约 33%,较大的素材应优先使用公网 URL 或 `mm_file://{file_id}`。 | 素材 | 格式 | 单文件限制 | 数量、时长及尺寸限制 | | - | - | - | - | | 图片 | JPG、JPEG、PNG、WEBP、HEIC、HEIF | 不超过 30 MB | 宽高均为 256 至 5760 px;宽高比 0.4 至 2.5;首帧最多 1 张、尾帧最多 1 张、参考图片最多 9 张 | | 参考视频 | MP4、MOV;视频编码 H.264/AVC 或 H.265/HEVC;音频编码 AAC 或 MP3 | 不超过 50 MB | 最多 3 个;单段 2 至 15 秒、总时长不超过 15 秒;宽高均为 256 至 5760 px;宽高比 0.4 至 2.5;帧率 23.976 至 60 fps | | 参考音频 | WAV、MP3 | 不超过 15 MB | 最多 3 个;单段 2 至 15 秒、总时长不超过 15 秒 | ### 2.7 创建响应 创建成功返回任务 ID: ```json theme={null} { "task_id": "427916141998479" } ``` 请保存该 ID,并使用它调用查询接口。任务 ID 是后续查询任务状态和获取结果的唯一标识。 ## 三、查询任务 ### 3.1 查询示例 ```bash theme={null} curl -X GET 'https://{api_domain}/v3/minimax/v2/query/video_generation/427916141998479' \ -H 'Authorization: Bearer ' ``` 查询接口只能查询最近 7 天内创建的任务(UTC 时间窗口 `[T-7d, T)`);超出该窗口的 `task_id` 会返回 `invalid task_id`。 ### 3.2 处理中响应 任务处于 `queued` 或 `running` 时,请等待后继续查询: ```json theme={null} { "task": { "id": "427916141998479", "status": "running", "task_type": "generation", "model": "MiniMax-H3", "resolution": "768P" } } ``` 建议轮询间隔为 10 至 30 秒,具体可根据业务场景调整。不要高频请求查询接口。 ### 3.3 成功响应 ```json theme={null} { "task": { "id": "427916141998479", "model": "MiniMax-H3", "status": "succeeded", "created_at": 1785125529, "updated_at": 1785125946, "content": { "url": "https://your-result-cdn.example.com/video.mp4" }, "resolution": "768P", "duration": 4, "usage": { "total_seconds": 4, "input_seconds": 0, "output_seconds": 4, "input_image_count": 0 }, "ratio": "16:9", "task_type": "generation", "modality": "video" } } ``` `content.url` 为生成结果地址。该下载 URL 有有效期,请及时下载或保存到自己的存储中;过期后可再次查询任务以获取新 URL。 ### 3.4 失败和取消响应 ```json theme={null} { "task": { "id": "427916141998479", "model": "MiniMax-H3", "status": "failed", "error": { "code": "1026", "message": "video description contains sensitive content" }, "created_at": 1785125529, "updated_at": 1785125700, "resolution": "768P", "duration": 4, "usage": {}, "ratio": "16:9", "task_type": "generation", "modality": "video" } } ``` `status` 可能为: | 状态 | 说明 | | - | - | | `queued` | 已创建,等待处理 | | `running` | 正在生成 | | `succeeded` | 生成成功,可读取 `content.url` | | `failed` | 生成失败;错误详情位于 `error.code` 和 `error.message` | | `cancelled` | 任务已取消 | ### 3.5 查询返回字段 `task` 对象字段如下。不同状态下部分字段可能不返回;成功任务的输出位于 `content`,失败任务的错误位于 `error`。 | 字段 | 类型 | 说明 | | - | - | - | | `task.id` | string | 任务 ID | | `task.model` | string | 任务使用的模型,例如 `MiniMax-H3` | | `task.status` | string | `queued`、`running`、`succeeded`、`failed` 或 `cancelled` | | `task.error.code` | string | 异步任务失败的业务错误码;仅失败时返回 | | `task.error.message` | string | 异步任务失败的错误信息;仅失败时返回 | | `task.created_at` | integer | 任务创建时间,Unix 秒级时间戳 | | `task.updated_at` | integer | 任务状态最后更新时间,Unix 秒级时间戳 | | `task.content.url` | string | 视频输出的限时下载 URL;视频任务成功后返回 | | `task.content.prompt` | string | H3-Context-IR 的结构化增强提示词;仅对应任务成功后返回 | | `task.resolution` | string | 输出分辨率 | | `task.duration` | integer | 输出时长,单位为秒 | | `task.usage` | object | 用量信息;成功时包含计量字段,失败响应中可能为空对象 | | `task.ratio` | string | 实际输出画幅;不适用时可能为空字符串 | | `task.task_type` | string | `generation`、`h3_context_ir` 或 `regeneration` | | `task.modality` | string | 输出模态:视频任务为 `video`,H3-Context-IR 为 `text` | 视频任务的 `usage` 字段如下;没有对应输入时,部分字段可能不返回。 | 字段 | 类型 | 说明 | | - | - | - | | `usage.total_seconds` | integer | 总计量秒数,即输入秒数加输出秒数 | | `usage.input_seconds` | integer | 参考视频输入秒数 | | `usage.output_seconds` | integer | 输出视频秒数 | | `usage.input_image_count` | integer | 输入图片总数,包括首帧、尾帧和参考图片 | | `usage.input_audio_seconds` | integer | 参考音频输入秒数;没有参考音频时不返回 | | `usage.total_tokens` | integer | 总 Token 数,即 `prompt_tokens + completion_tokens` | | `usage.prompt_tokens` | integer | 输入折算 Token 数 | | `usage.completion_tokens` | integer | 输出折算 Token 数 | ## 四、视频重生成 视频重生成把一段已满足 MiniMax-H3 768P 规格的源视频重新生成为 2K。它使用独立的创建接口,`model` 仍为 `MiniMax-H3`,`resolution` 固定为 `2K`,并共用第三节的查询接口;查询响应中 `task.task_type` 为 `regeneration`。 ### 4.1 请求示例 两种输入方式二选一,不能同时提供,也不能都不提供: * **按源任务 ID**:传 `source_task_id`,即此前一个成功的 `/v2/video_generation` 任务 ID(须属于同一账号、状态为 `succeeded`、且仍在 7 天查询窗口内)。 * **按源视频**:传 `content`,其中恰好包含一个 `type=video_url`、`role=base_video` 的源视频项,并把生成该 768P 视频时的其余输入一并重传。 按源任务 ID: ```bash theme={null} curl -X POST 'https://{api_domain}/v3/minimax/v2/video_regeneration' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "model": "MiniMax-H3", "source_task_id": "424010985738629", "resolution": "2K" }' ``` 按源视频: ```bash theme={null} curl -X POST 'https://{api_domain}/v3/minimax/v2/video_regeneration' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "model": "MiniMax-H3", "content": [ { "type": "video_url", "video_url": { "url": "https://your-cdn.example.com/source-768p.mp4" }, "role": "base_video" }, { "type": "text", "text": "最终实际下发给模型的提示词" } ], "resolution": "2K" }' ``` `content` 中的 `text` 必须是最终实际下发给模型的提示词,不能使用 H3-Context-IR 处理前的原始提示词。 ### 4.2 请求字段 | 字段 | 类型 | 必填 | 说明 | | - | - | - | - | | `model` | string | 是 | 固定为 `MiniMax-H3` | | `resolution` | string | 是 | 固定为 `2K` | | `source_task_id` | string | 与 `content` 二选一 | 此前一个成功的视频生成任务 ID;须属于同一账号、状态 `succeeded`、仍在 7 天查询窗口内 | | `content` | array | 与 `source_task_id` 二选一 | 输入项列表,须恰好包含一个 `role=base_video` 的 `video_url` 项,并重传原始输入 | | `aigc_watermark` | boolean | 否 | 是否添加 AIGC 水印,默认 `false` | 不支持 `callback_url`。源视频(768P 输出)须包含音轨、帧率 24 fps、宽高均为 32 的倍数、面积在 768×768 至 768×1344 之间、总帧数 107 至 362 帧(约 4 至 15 秒)。单次请求体不超过 64 MB,较大素材请使用公网 URL 或 `mm_file://{file_id}`。 创建成功返回任务 ID,之后按第三节轮询查询;任务成功后从 `task.content.url` 获取 2K 视频。 ### 4.3 计费说明 视频重生成按最终生成的 2K 视频时长计费,同时包含输出与输入两部分,均按该时长计: | 用量 | 计费单位 | | - | - | | 输出 2K 视频 | 秒 | | 输入源视频 | 秒 | | 输入图片 | 前 5 张不计费,超过部分按张计费 | 重生成保持源视频时长不变,上游仅在 `output_seconds` 返回该时长(`input_seconds` 为 0),因此输入源视频一项按 `output_seconds` 计费。任务成功后一次性结算,失败或取消不计费。具体单价以您所在平台的价格页面为准。 ## 五、H3-Context-IR H3-Context-IR 把原始提示词与多模态输入改写为结构化的增强提示词,用于随后的视频生成,不产出视频。它使用独立的创建接口,`model` 为 `MiniMax-H3`,并共用第三节的查询接口;查询响应中 `task.task_type` 为 `h3_context_ir`、`task.modality` 为 `text`,增强提示词位于 `task.content.prompt`。 ### 5.1 请求示例 ```bash theme={null} curl -X POST 'https://{api_domain}/v3/minimax/v2/h3_context_ir' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "model": "MiniMax-H3", "content": [ { "type": "text", "text": "A cinematic product video in a clean studio" }, { "type": "image_url", "image_url": { "url": "https://your-cdn.example.com/product.png" }, "role": "reference_image" } ], "duration": 6 }' ``` ### 5.2 请求字段 | 字段 | 类型 | 必填 | 说明 | | - | - | - | - | | `model` | string | 是 | 固定为 `MiniMax-H3` | | `content` | array | 是 | 多模态输入列表,不能为空;项的结构与视频生成一致(`text`、`image_url`、`video_url`、`audio_url`,可带 `role`) | | `duration` | integer | 否 | 目标视频时长,4 至 15 秒的整数 | 不支持 `callback_url`。 ### 5.3 响应 创建成功返回任务 ID,之后按第三节轮询查询。任务成功时增强提示词位于 `task.content.prompt`: ```json theme={null} { "task": { "id": "424262868365581", "model": "MiniMax-H3", "status": "succeeded", "content": { "prompt": "改写后的结构化增强提示词" }, "task_type": "h3_context_ir", "modality": "text", "usage": { "prompt_tokens": 120, "completion_tokens": 480, "total_tokens": 600 } } } ``` 把 `task.content.prompt` 作为视频生成或视频重生成请求里的最终提示词使用。 ### 5.4 计费说明 H3-Context-IR 按 Token 计费,输入与输出分别计价,单位为每百万 Token: | 用量 | 计费单位 | | - | - | | 输入 | 每百万 `prompt_tokens` | | 输出 | 每百万 `completion_tokens` | 任务成功后一次性结算,失败或取消不计费。具体单价以您所在平台的价格页面为准。 ## 六、Python 调用示例 以下示例使用标准 `requests` 库,不依赖特定 SDK: ```python theme={null} import os import time import requests api_domain = os.environ["API_DOMAIN"] api_key = os.environ["PLATFORM_API_KEY"] headers = { "Authorization": f"Bearer {api_key}", "Content-Type": "application/json", } payload = { "model": "MiniMax-H3", "content": [{"type": "text", "text": "A calm cinematic landscape"}], "resolution": "768P", "duration": 4, "ratio": "16:9", } created = requests.post( f"https://{api_domain}/v3/minimax/v2/video_generation", headers=headers, json=payload, timeout=30, ) created.raise_for_status() task_id = created.json()["task_id"] while True: result = requests.get( f"https://{api_domain}/v3/minimax/v2/query/video_generation/{task_id}", headers=headers, timeout=30, ) result.raise_for_status() task = result.json()["task"] if task["status"] == "succeeded": print(task["content"]["url"]) break if task["status"] in ("failed", "cancelled"): raise RuntimeError(task) time.sleep(20) ``` ## 七、常见错误 | HTTP | 场景 | 处理建议 | | - | - | - | | 400 | 请求 JSON、模型、画幅、时长或 `content` 组合不合法 | 根据 `error.message` 修正请求 | | 401 | API Key 缺失或无效 | 检查 `Authorization: Bearer ` 请求头 | | 402 | 余额或额度不足(创建接口) | 充值或调整额度后重试 | | 422 | 输入包含敏感内容(创建接口) | 修改提示词或输入素材后重新创建任务 | | 429 | 请求频率超过限制 | 降低提交或轮询频率,并使用退避重试 | | 500 | 服务端错误 | 使用指数退避重试;避免无幂等控制地重复提交同一业务任务 | ### 7.1 HTTP 错误响应结构 创建或查询接口直接返回非 2xx HTTP 状态时,响应体采用以下结构。注意 `error.http_code` 是字符串,`request_id` 可用于排查请求。 ```json theme={null} { "type": "error", "error": { "type": "bad_request_error", "message": "invalid params, content must include a non-empty text item (prompt is required) (2013)", "http_code": "400" }, "request_id": "021785229015510a2c883cf675b9804d" } ``` 这里的 HTTP 错误体与查询到的异步失败任务不同:HTTP 错误详情位于顶层 `error.type`、`error.message`、`error.http_code`;异步任务失败详情位于 `task.error.code` 和 `task.error.message`。 上游业务错误会尽量保留原始错误码和错误信息。对于 `failed` 或 `cancelled` 任务,不要继续等待同一个 task ID;请修正请求后创建新任务。 ## 八、使用建议 1. 创建任务后持久化 `task_id`,不要只依赖客户端内存。 2. 查询接口使用 10 至 30 秒轮询间隔,并在客户端设置整体超时。 3. 收到 `succeeded` 后立即下载 `content.url`,下载 URL 可能过期;过期后可再次查询任务获取新 URL。 4. 输入素材 URL 必须可被平台和 MiniMax 上游访问,不能依赖客户内网或临时登录态。 5. 需要首尾帧时使用 `first_frame`/`last_frame`;需要参考素材时使用 `reference_image`、`reference_video` 或 `reference_audio`,不要混用两种模式。 # MiniMax Speech Source: https://ppio.com/docs/models/reference-minimax-speech 查阅 PPIO MiniMax Speech 原厂协议,了解同步与异步语音合成、文件管理、音色快速复刻和音色设计的接口字段与计费规则。 `POST https://api.ppio.com/v3/minimax/v1/t2a_v2` 参数及使用方式已对齐官方,详细参数可直接参考官方文档。 ## 一、概述 本文档说明如何通过 MiniMax Speech 原厂协议使用同步语音合成、异步长文本语音合成、文件管理、音色快速复刻和音色设计。 同步接口在一次 POST 请求中直接返回音频或 SSE;异步接口先返回 task_id,调用方再查询任务状态,并通过 file_id 获取结果文件。 ### 1.1 接口地址 | 能力 | 方法与路径 | | - | - | | 同步语音合成 | POST /v3/minimax/v1/t2a_v2 | | 创建异步语音任务 | POST /v3/minimax/v1/t2a_async_v2 | | 查询异步语音任务 | GET /v3/minimax/v1/query/t2a_async_query_v2?task_id= | | 上传文件 | POST /v3/minimax/v1/files/upload | | 查询文件 | GET /v3/minimax/v1/files/retrieve?file_id= | | 下载文件 | GET /v3/minimax/v1/files/retrieve_content?file_id= | | 音色快速复刻 | POST /v3/minimax/v1/voice_clone | | 音色设计 | POST /v3/minimax/v1/voice_design | 完整地址为 https\://\{api_domain} 加上表中的路径,其中 \{api_domain} 为您使用的 API 域名。 ### 1.2 鉴权 所有请求都需要平台 API Key。JSON POST 请求还必须指定内容类型: ``` Authorization: Bearer Content-Type: application/json ``` 文件上传使用 multipart/form-data;GET 请求不需要 Content-Type。 ### 1.3 响应与资源访问 接口保留 MiniMax 原厂响应字段与错误结构。JSON 响应通常包含 base_resp.status_code 和 base_resp.status_msg;HTTP 200 不一定表示业务成功,请始终检查 base_resp.status_code=0。 task_id 和 file_id 可能超过 JavaScript 安全整数范围,请使用无损整数或字符串保存。文件、任务和私有音色只能由创建它们的平台用户访问;查询时应使用创建资源时的同一个平台 API Key。 ## 二、同步语音合成 官方参数说明:[同步语音合成 HTTP](https://platform.minimaxi.com/docs/api-reference/speech-t2a-http) ### 2.1 调用接口 ``` POST https://{api_domain}/v3/minimax/v1/t2a_v2 ``` 常用请求字段: | 字段 | 类型 | 必填 | 说明 | | - | - | - | - | | model | string | 是 | speech-2.8-hd 或 speech-2.8-turbo | | text | string | 是 | 待合成文本,少于 10,000 字符;超过 3,000 字符建议流式输出 | | stream | boolean | 否 | 是否返回原厂 SSE,默认 false | | voice_setting | object | 是 | 音色 ID、语速、音量、音调和情绪等设置 | | audio_setting | object | 否 | 采样率、码率、格式和声道设置 | | language_boost | string | 否 | 指定语言或 auto | | output_format | string | 否 | hex(默认)或 url;流式仅支持 hex,URL 有效期为 24 小时 | | subtitle_enable | boolean | 否 | 是否返回字幕,默认 false | pronunciation_dict、timbre_weights、voice_modify、stream_options 等原厂扩展字段会原样转发,详细约束以 MiniMax 官方文档为准。 ### 2.2 调用示例 ```bash theme={null} curl -X POST 'https://{api_domain}/v3/minimax/v1/t2a_v2' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "model": "speech-2.8-hd", "text": "Welcome to our service.", "stream": false, "voice_setting": { "voice_id": "male-qn-qingse", "speed": 1, "vol": 1, "pitch": 0 }, "audio_setting": { "sample_rate": 32000, "bitrate": 128000, "format": "mp3", "channel": 1 }, "output_format": "url" }' ``` 流式调用只需设置 stream=true 并使用支持流式读取的客户端,例如 curl -N。 ### 2.3 响应说明 ```json theme={null} { "data": { "audio": "https://example.com/audio.mp3", "status": 2 }, "extra_info": { "usage_characters": 26, "audio_length": 9900, "audio_format": "mp3" }, "trace_id": "provider-trace-id", "base_resp": { "status_code": 0, "status_msg": "success" } } ``` 流式响应为原厂 SSE。最终成功事件的 data.status 为 2,用量位于 extra_info.usage_characters。 ### 2.4 计费说明 按上游最终返回的 extra_info.usage_characters 计费,计费单位为每 10,000 字符。失败请求、原厂业务错误和没有成功终止事件的 SSE 不收费。具体单价以您所使用服务的价格页面为准。 ## 三、异步长文本语音合成 官方参数说明:[创建异步任务](https://platform.minimaxi.com/docs/api-reference/speech-t2a-async-create)、[查询异步任务](https://platform.minimaxi.com/docs/api-reference/speech-t2a-async-query) ### 3.1 创建任务 ``` POST https://{api_domain}/v3/minimax/v1/t2a_async_v2 ``` | 字段 | 类型 | 必填 | 说明 | | - | - | - | - | | model | string | 是 | speech-2.8-hd 或 speech-2.8-turbo | | text | string | 二选一 | 待合成文本,最长 50,000 字符;与 text_file_id 二选一 | | text_file_id | integer | 二选一 | 通过文件上传获得;支持 txt 或 zip,单文件文本少于 1,000,000 字符 | | voice_setting | object | 是 | 音色和语音参数 | | audio_setting | object | 否 | 输出音频设置 | | language_boost | string | 否 | 指定语言或 auto | ### 3.2 创建示例 ```bash theme={null} curl -X POST 'https://{api_domain}/v3/minimax/v1/t2a_async_v2' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "model": "speech-2.8-turbo", "text": "A longer narration.", "voice_setting": { "voice_id": "audiobook_male_1", "speed": 1, "vol": 1, "pitch": 0 } }' ``` ```json theme={null} { "task_id": 95157322514444, "task_token": "provider-task-token", "file_id": 95157322514444, "usage_characters": 101, "base_resp": { "status_code": 0, "status_msg": "success" } } ``` 请保存 task_id。异步任务创建成功时即按响应中的 usage_characters 收费;后续查询不重复收费。 ### 3.3 查询任务 ```bash theme={null} curl -X GET 'https://{api_domain}/v3/minimax/v1/query/t2a_async_query_v2?task_id=95157322514444' \ -H 'Authorization: Bearer ' ``` 该查询接口每秒最多调用 10 次。状态包括 Processing、Success、Failed 和 Expired;到达终态后停止轮询。 ```json theme={null} { "task_id": 95157322514444, "status": "Success", "file_id": 95157322514496, "base_resp": { "status_code": 0, "status_msg": "success" } } ``` 任务成功后使用 file_id 查询或下载文件。MiniMax 官方说明下载 URL 自生成起约 9 小时有效,请及时保存结果。 ## 四、文件管理 官方参数说明:[文件上传](https://platform.minimaxi.com/docs/api-reference/file-management-upload)、[文件检索](https://platform.minimaxi.com/docs/api-reference/file-management-retrieve)、[文件下载](https://platform.minimaxi.com/docs/api-reference/file-management-retrieve-content) ### 4.1 上传文件 ```bash theme={null} curl -X POST 'https://{api_domain}/v3/minimax/v1/files/upload' \ -H 'Authorization: Bearer ' \ -F 'purpose=voice_clone' \ -F 'file=@voice.wav' ``` | purpose | 用途与格式 | | - | - | | voice_clone | 快速复刻原始音频;mp3、m4a、wav | | prompt_audio | 音色复刻示例音频;mp3、m4a、wav | | t2a_async_input | 异步长文本输入;txt、zip | 请求必须且只能包含一个 purpose 和一个文件。单次平台请求体上限为 64 MiB,MiniMax 对各用途的格式、时长和大小限制仍然适用。 ### 4.2 查询与下载 ```bash theme={null} curl -X GET 'https://{api_domain}/v3/minimax/v1/files/retrieve?file_id=95157322514496' \ -H 'Authorization: Bearer ' curl -X GET 'https://{api_domain}/v3/minimax/v1/files/retrieve_content?file_id=95157322514496' \ -H 'Authorization: Bearer ' \ --output result.mp3 ``` retrieve 返回文件元数据和 download_url;retrieve_content 直接返回二进制文件。上传、查询和下载不收费。 ## 五、音色快速复刻 官方参数说明:[音色快速复刻](https://platform.minimaxi.com/docs/api-reference/voice-cloning-clone) ### 5.1 调用接口与字段 ``` POST https://{api_domain}/v3/minimax/v1/voice_clone ``` | 字段 | 类型 | 必填 | 说明 | | - | - | - | - | | file_id | integer | 是 | purpose=voice_clone 上传所得文件 ID;音频 10 秒至 5 分钟且不超过 20 MB | | voice_id | string | 是 | 自定义音色 ID,长度 8–256,以字母开头,不得与已有 ID 重复 | | clone_prompt | object | 否 | 示例音频;使用时 prompt_audio 和 prompt_text 都必填 | | text | string | 否 | 试听文本,最多 1,000 字符 | | model | string | 条件必填 | 传 text 时必填;使用 speech-2.8-hd 或 speech-2.8-turbo | | text_validation | string | 否 | 样本预期文本,最多 200 字符 | | accuracy | number | 否 | ASR 相似度阈值,0–1,默认 0.7 | ### 5.2 调用示例与响应 ```bash theme={null} curl -X POST 'https://{api_domain}/v3/minimax/v1/voice_clone' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "file_id": 123456789, "voice_id": "MyVoice001", "need_noise_reduction": false, "need_volume_normalization": false }' ``` ```json theme={null} { "input_sensitive": false, "demo_audio": "", "base_resp": { "status_code": 0, "status_msg": "success" } } ``` 成功请求按一个音色计费。若请求中生成试听音频,平台不额外增加语音合成 SKU。MiniMax 官方说明,克隆音色若 7 天内未正式用于语音合成,可能被删除。 ## 六、音色设计 官方参数说明:[音色设计](https://platform.minimaxi.com/docs/api-reference/voice-design-design) ### 6.1 调用接口与字段 ``` POST https://{api_domain}/v3/minimax/v1/voice_design ``` | 字段 | 类型 | 必填 | 说明 | | - | - | - | - | | prompt | string | 是 | 目标音色描述 | | preview_text | string | 是 | 试听文本,最多 500 字符 | | voice_id | string | 否 | 自定义音色 ID;不传时由 MiniMax 生成 | | aigc_watermark | boolean | 否 | 是否在试听音频结尾添加节奏标识,默认 false | ### 6.2 调用示例与响应 ```bash theme={null} curl -X POST 'https://{api_domain}/v3/minimax/v1/voice_design' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "prompt": "A warm, clear adult narrator with a calm delivery.", "preview_text": "Welcome to our service." }' ``` ```json theme={null} { "voice_id": "ttv-voice-generated-id", "trial_audio": "hex-encoded-audio", "base_resp": { "status_code": 0, "status_msg": "success" } } ``` 成功请求按一个音色计费,试听音频包含在本次接口计费中,不额外增加语音合成 SKU。 ## 七、常见错误和注意事项 | 现象 | 说明与处理建议 | | - | - | | HTTP 200,但 base_resp.status_code!=0 | MiniMax 业务错误;根据 status_msg 修正输入,不要按成功处理 | | HTTP 400 | JSON、multipart、模型名、查询参数或必填字段不合法 | | HTTP 401/403 | 检查平台 API Key、余额和权限 | | HTTP 404 | 文件、任务或私有音色不存在,或不属于当前平台用户 | | HTTP 429 | 降低请求/查询频率并使用指数退避;异步查询不得超过每秒 10 次 | | HTTP 5xx | 保留响应和平台 trace ID 后联系技术支持;非幂等创建请求不要无控制重试 | * 原厂字段会尽量原样转发,但本服务只开放本文列出的八个路径。 * 单次请求体和单个 SSE 事件上限为 64 MiB。 * 客户端断开后,服务可能继续读取已开始的 SSE 以完成用量结算。 * 异步任务必须通过本文的 MiniMax 查询接口获取状态,不使用平台通用异步结果接口。 * 收到文件 URL 或成功文件 ID 后请及时下载;URL 和文件可能过期。 ## 八、Python 调用示例 以下示例演示异步创建和轮询。生产环境请设置整体超时、指数退避和最大轮询次数。 ```python theme={null} import os import time import requests api_domain = os.environ["API_DOMAIN"] api_key = os.environ["PLATFORM_API_KEY"] headers = { "Authorization": f"Bearer {api_key}", "Content-Type": "application/json", } created = requests.post( f"https://{api_domain}/v3/minimax/v1/t2a_async_v2", headers=headers, json={ "model": "speech-2.8-turbo", "text": "A longer narration.", "voice_setting": {"voice_id": "audiobook_male_1"}, }, timeout=60, ) created.raise_for_status() created_body = created.json() if created_body["base_resp"]["status_code"] != 0: raise RuntimeError(created_body) task_id = created_body["task_id"] while True: response = requests.get( f"https://{api_domain}/v3/minimax/v1/query/t2a_async_query_v2", headers={"Authorization": f"Bearer {api_key}"}, params={"task_id": task_id}, timeout=30, ) response.raise_for_status() task = response.json() if task["base_resp"]["status_code"] != 0: raise RuntimeError(task) if task["status"] == "Success": print(task["file_id"]) break if task["status"] in {"Failed", "Expired"}: raise RuntimeError(task) time.sleep(2) ``` # Seedream Source: https://ppio.com/docs/models/reference-seedream-cn `POST https://api.ppio.com/v3/bytedance-cn/api/v3/images/generations` 参数及使用方式与火山方舟图片生成 API 一致,详细参数说明请参考:[火山方舟图片生成 API](https://docs.volcengine.com/docs/ark/image-generation-api?lang=zh)。 ## 一、概述 本接口为同步接口:请求返回时即包含生成结果,不需要轮询。三个模型共用同一个接口,请求体中的 `model` 决定使用的模型;支持文生图、图生图、多图融合和图层拆分。 ### 1.1 接口地址 | 操作 | 接口 | | - | - | | 生成图片 | `POST /v3/bytedance-cn/api/v3/images/generations` | 其中 `{api_domain}` 为平台为您提供的 API 域名,完整地址为 `https://{api_domain}` 加上表中路径。 ### 1.2 鉴权 所有请求都需要携带平台 API Key,并指定 JSON 内容类型: ```http theme={null} Authorization: Bearer Content-Type: application/json ``` ### 1.3 支持模型 | 模型 | 支持场景 | 说明 | | - | - | - | | `doubao-seedream-5-5-261028` | 文生图、单图生图、多图融合、图层拆分 | 画面真实感、审美和多轮编辑一致性更好;支持透明背景直出、最多 99 个图层的图层拆分和图层文字识别;按输出图片像素分档计费,每张输入图片计费 | | `doubao-seedream-5-0-pro-260628` | 文生图、单图生图、多图融合、图层拆分 | 按输出图片像素分档计费,图层拆分单独计价,从第 2 张起的参考图计费;支持 `optimize_prompt_options.mode` 取 `fast` | | `doubao-seedream-5-0-flash-260915` | 文生图、单图生图、多图融合、图层拆分 | 生成速度更快;每张输出图片单价相同,输入图片不计费 | 三个模型的接口、鉴权、请求与响应结构相同,差异在于 `model` 取值、部分参数的默认值和可选值(见 2.5、2.6)以及计费方式。三者都不支持组图生成和流式输出。 ## 二、调用图片生成 参数说明:[火山方舟图片生成 API](https://docs.volcengine.com/docs/ark/image-generation-api?lang=zh) ### 2.1 请求示例:文生图 ```bash theme={null} curl -X POST 'https://{api_domain}/v3/bytedance-cn/api/v3/images/generations' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "model": "doubao-seedream-5-5-261028", "prompt": "一只戴着红色围巾的金毛犬,在雪山湖边的自然光下,电影感摄影", "size": "2K", "response_format": "url", "watermark": false }' ``` ### 2.2 请求示例:多图融合 ```bash theme={null} curl -X POST 'https://{api_domain}/v3/bytedance-cn/api/v3/images/generations' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "model": "doubao-seedream-5-0-flash-260915", "prompt": "将图1中的人物换上图2中的服装,放在城市夜景中,保持人物特征一致", "image": [ "https://example.com/person.png", "https://example.com/outfit.png" ], "size": "2048x1152", "response_format": "url" }' ``` `image` 传单个字符串即为单图生图;传数组即为多图融合,最多 10 张。 ### 2.3 请求示例:图层拆分 ```bash theme={null} curl -X POST 'https://{api_domain}/v3/bytedance-cn/api/v3/images/generations' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "model": "doubao-seedream-5-5-261028", "prompt": "把人物、背景和标题文字拆成独立图层", "image": "https://example.com/poster.png", "layer_decomposition": true, "layer_decomposition_options": { "max_images": 30, "text_recognition": true }, "size": "auto" }' ``` 图层拆分把单张输入图拆成一张底图和多个可独立编辑的图层:Seedream 5.5 最多 99 个图层,可用 `layer_decomposition_options.max_images` 控制底图加图层的总张数;Seedream 5.0 Pro 和 Seedream 5.0 Flash 最多 16 个图层。`prompt` 可选,不传时模型自动识别图片中的主要元素并拆分。 ### 2.4 请求示例:透明背景 ```bash theme={null} curl -X POST 'https://{api_domain}/v3/bytedance-cn/api/v3/images/generations' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "model": "doubao-seedream-5-5-261028", "prompt": "一只玻璃质感的蓝色小鸟,透明背景", "background": "transparent", "output_format": "png", "size": "2K", "response_format": "url" }' ``` Seedream 5.5 在文生图和图生图中都可以直接输出带透明通道的 PNG 图片。 ### 2.5 请求字段 | 字段 | 类型 | 必填 | 说明 | | - | - | - | - | | `model` | string | 是 | `doubao-seedream-5-5-261028`、`doubao-seedream-5-0-pro-260628` 或 `doubao-seedream-5-0-flash-260915` | | `prompt` | string | 图片生成时必填;图层拆分时可选 | 支持中文、英文及多种其他语言;建议中文不超过 300 字、英文不超过 600 词 | | `image` | string / string\[] | 图层拆分时必填 | 参考图 URL 或 Base64 Data URL;限制见 2.7 | | `layer_decomposition` | boolean | 否 | 默认 `false`;`true` 时开启图层拆分 | | `layer_decomposition_options.max_images` | integer | 否 | 仅 Seedream 5.5;图层拆分时底图加图层的最多张数,取值 2 到 100,默认 30 | | `layer_decomposition_options.text_recognition` | boolean | 否 | 仅 Seedream 5.5;默认 `false`;`true` 时对规整文字图层返回 `data[].text_recognition`,见 2.8 | | `size` | string | 否 | 图片生成默认 `2K`,可选 `1K`、`1.5K`、`2K` 或 `宽x高`;图层拆分默认 `auto`,可选 `1K`、`1.5K`、`2K`、`auto`;规则见 2.6 | | `output_format` | string | 否 | `jpeg` 或 `png`;Seedream 5.5 默认 `png`,Seedream 5.0 Pro 和 Seedream 5.0 Flash 默认 `jpeg`;图层拆分时只控制底图格式,图层始终为 `png` | | `background` | string | 否 | Seedream 5.5 可选 `auto`(默认)、`transparent`、`opaque`;Seedream 5.0 Pro 和 Seedream 5.0 Flash 可选 `opaque`(默认)、`transparent`;限制见 2.6 | | `optimize_prompt_options.mode` | string | 否 | `standard`(默认);Seedream 5.0 Pro 还支持 `fast`,生成更快、效果略低;Seedream 5.5 只支持 `standard` | | `safety_identifier` | string | 否 | 终端用户的唯一标识,用于协助识别违规使用;不超过 64 个字符,建议传用户 ID 的哈希值;响应中原样返回 | | `response_format` | string | 否 | `url`(默认)或 `b64_json` | | `watermark` | boolean | 否 | 默认 `true`,在图片右下角添加「AI 生成」水印 | ### 2.6 尺寸与组合规则 `size` 的取值: | 场景 | 可选值 | 说明 | | - | - | - | | 图片生成 | `1K`、`1.5K`、`2K`(默认) | 由模型结合提示词中的宽高比描述决定实际尺寸,例如 `2K` + 3:2 输出 `2496x1664` | | 图片生成 | `宽x高` | 总像素在 921,600(1280x720)到 4,624,220 之间,宽高比在 1/16 到 16 之间 | | 图层拆分 | `1K`、`1.5K`、`2K`、`auto`(默认) | 只支持档位,不支持 `宽x高`;底图分辨率等于 `size`,各图层分辨率接近 `size` 并保持其在原图中的宽高比 | 图层拆分 `auto` 模式下,原始尺寸在 921,600 到 4,624,220 像素之间的底图和图层按原尺寸输出,小于 1K 的按 1K 输出,大于 2K 的按 2K 输出。 组合约束: * 图层拆分时 `image` 必填且只能传一张,传多张返回错误。 * 图层拆分为全有或全无:任一图层生成失败,整个请求失败。 * Seedream 5.5 图层拆分最多返回 `max_images` 张图片(底图加图层);提示词要求的拆分数量超过上限时,部分图层信息可能丢失。 * Seedream 5.5:`background` 为 `transparent` 时文生图、图生图都支持,输入图片最多 10 张,且不要求带透明通道。`output_format` 为 `jpeg` 时,`auto` 一定输出不透明图片,`transparent` 返回错误。图层拆分时不能传 `background`,传入返回错误。 * Seedream 5.0 Pro 和 Seedream 5.0 Flash:`background` 为 `transparent` 时只支持图生图,且只能输入一张带透明通道的图片;输出默认为 `png`,同时指定 `output_format` 为 `jpeg` 会返回错误。 * 不支持 `stream`、`sequential_image_generation` 和 `sequential_image_generation_options`,传入任一字段返回 400。 ### 2.7 输入图片限制 | 场景 | 格式 | 大小 | 其他 | | - | - | - | - | | 图片生成 | jpeg、png、webp、bmp、tiff、gif、heic、heif | ≤ 30 MB | 最多 10 张;宽高比 1/16 到 16;宽、高均大于 14 px;总像素 196 到 36,000,000 | | 图层拆分 | png、jpeg | ≤ 30 MB | 只能 1 张;宽高比 1/16 到 16;总像素 262,144(512x512)到 36,000,000 | 图片 URL 必须可公开访问。Base64 格式为 `data:image/<图片格式>;base64,`,图片格式需小写,如 `data:image/png;base64,...`。 ### 2.8 响应说明 成功响应示例: ```json theme={null} { "created": 1793952000, "model": "doubao-seedream-5-5-261028", "data": [ { "url": "https://example.com/generated-image.png", "size": "2496x1664", "output_format": "png", "background": "opaque" } ], "usage": { "generated_images": 1, "input_images": 0, "output_tokens": 16224, "total_tokens": 16224 } } ``` | 字段 | 类型 | 说明 | | - | - | - | | `created` | integer | 创建时间,Unix 时间戳(秒) | | `model` | string | 本次请求的模型 | | `data[].url` | string | `response_format` 为 `url` 时返回;24 小时内有效,请及时下载 | | `data[].b64_json` | string | `response_format` 为 `b64_json` 时返回 | | `data[].size` | string | 实际输出尺寸,格式 `宽x高`;Seedream 5.5 和 Seedream 5.0 Pro 按它确定价格档位 | | `data[].output_format` | string | `jpeg` 或 `png` | | `data[].background` | string | 仅 Seedream 5.5 返回;实际背景类型,`transparent` 或 `opaque`;图层拆分时底图为 `opaque`,图层为 `transparent` | | `data[].z_index` | integer | 仅图层拆分返回;底图为 `0`,图层从 `1` 递增,数值越大越靠上 | | `data[].name` / `data[].description` | string | 仅图层拆分返回;图层名称和描述 | | `data[].bounding_box` | object | 仅图层返回(底图不返回);`absolute` 为底图坐标系下的像素坐标 `[left, top, right, bottom]`,`normalized` 为换算到 0–1000 的坐标 | | `data[].text_recognition` | object | 仅 Seedream 5.5 在开启 `layer_decomposition_options.text_recognition` 时,对规整文字图层返回;结构见下表 | | `safety_identifier` | string | 请求中传入时原样返回 | | `usage.generated_images` | integer | 成功生成的图片数 | | `usage.input_images` | integer | 输入图片数 | | `usage.output_tokens` / `usage.total_tokens` | integer | 输出图片的 token 数,不参与计费 | 图片生成返回一个 `data` 项;图层拆分返回多个 `data` 项(一张底图加多个图层),按 `z_index` 从小到大叠放即可还原。 `data[].text_recognition` 的结构: | 字段 | 类型 | 说明 | | - | - | - | | `text` | string | 图层的完整文本,按从上到下、从左到右排列,行间以 `\n` 分隔 | | `lines[].bounding_box` | object | 文字行在底图坐标系中的位置,含 `absolute` 和 `normalized` | | `lines[].runs[].text` | string | 同一样式的文字片段,不含换行符 | | `lines[].runs[].style` | object | 文字片段的近似样式:`similar_font_family`(无法识别时为 `unknown`)、`foreground_color`(`#RRGGBB`)、`bold`、`italic`、`underline`、`strikethrough`、`shadow`、`translucent` | 非文字图层,以及艺术字、手写体等非规整文字图层,不返回 `text_recognition`。样式由模型识别,可能与原始设计文件中的属性有偏差。 ## 三、计费说明 ``` 请求费用 = Σ(每张成功输出图片的单价) + 输入图片费用(Seedream 5.5、Seedream 5.0 Pro) ``` 三个模型都按请求**实际生成结果**计费,请求返回时完成计费: | 项目 | Seedream 5.5 | Seedream 5.0 Pro | Seedream 5.0 Flash | | - | - | - | - | | 计费数量 | 每张成功输出图片计 1 张;图层拆分时底图和每个图层各计 1 张 | 同左 | 同左 | | 价格档位 | 每张输出图片按其 `data[].size` 的像素分档:≤ 2,610,000 像素与 > 2,610,000 像素两档;图层拆分与图片生成单价相同 | 两档同左;图层拆分使用单独的图层价格 | 不分档,所有输出图片单价相同 | | 输入图片 | 每张输入图片计费 | 第 1 张免费,从第 2 张起每张计费 | 不计费 | | 失败请求 | 未生成图片的请求不产生费用 | 同左 | 同左 | 同一次图层拆分请求的底图和各图层像素不同,可能分别落在两个档位,账单按各档位张数分别累计。Seedream 5.5 图层拆分按实际返回的张数计费,与 `max_images` 的取值无关。图片生成时,`1K`、`1.5K` 档的输出通常在 2,610,000 像素以内,`2K` 档的输出通常超过 2,610,000 像素;以响应中的 `data[].size` 为准。 ### 3.1 计费与 usage 字段对照 | 字段 | 是否参与计费 | 说明 | | - | - | - | | `data[].size` | 是(Seedream 5.5、Seedream 5.0 Pro) | 决定每张输出图片的价格档位 | | `usage.generated_images` | 是 | 成功输出图片数,与计费张数一致 | | `usage.input_images` | 是(Seedream 5.5、Seedream 5.0 Pro) | 输入图片数;Seedream 5.5 按该值计费,Seedream 5.0 Pro 计费的额外参考图张数为该值减 1 | | `usage.output_tokens` / `usage.total_tokens` | 否 | 仅供参考 | 具体单价以您所使用服务的价格页面为准。 ## 四、常见错误 | HTTP | 场景 | 处理建议 | | - | - | - | | 400 | JSON 格式错误;`model` 不在支持列表中;传入 `stream: true` 或组图字段 | 根据 `metadata.details` 修正请求 | | 400 | API Key 缺失 | 检查 `Authorization: Bearer ` 请求头 | | 400 | 参数取值不合法,如 `size` 超出范围、图片无法读取、Seedream 5.5 传入 `optimize_prompt_options.mode: fast` | 根据 `error.message` 修正请求,错误体见 4.1 | | 403 | API Key 无效;余额或预算不足 | 检查 API Key,或充值、调整预算后重试 | | 429 | 请求频率超过限制 | 降低请求频率,并使用退避重试 | | 500 | 服务端错误 | 使用 `trace_id` 联系技术支持 | ### 4.1 错误响应结构 请求格式、鉴权、余额和模型校验失败时,错误体如下,`metadata.trace_id` 可用于排查: ```json theme={null} { "code": 400, "reason": "INVALID_REQUEST_BODY", "message": "invalid request body", "metadata": { "details": "body.model must be one of: doubao-seedream-5-0-flash-260915, doubao-seedream-5-0-pro-260628, doubao-seedream-5-5-261028", "trace_id": "platform-trace-id" } } ``` 参数取值不合法、图片无法读取或内容审核未通过时,错误体如下,`error.code` 与 `error.message` 说明具体原因: ```json theme={null} { "error": { "code": "InvalidParameter", "message": "The parameter `size` specified in the request are not valid: image area must be at least 921600 pixels. Request id: ...", "param": "size", "type": "BadRequest" } } ``` 两种错误体都表示请求未生成图片,不产生费用。 ## 五、使用建议 1. 收到成功响应后立即下载 `data[].url`,地址 24 小时后失效。 2. 需要控制 Seedream 5.5 或 Seedream 5.0 Pro 的成本时,可使用 `1K` 或 `1.5K` 档,输出通常落在 2,610,000 像素以内的低档。 3. 图层拆分时只传一张图片,`size` 使用档位或 `auto`,不要传 `宽x高`。Seedream 5.5 可用 `max_images` 控制拆分粒度,取值越大拆分通常越细。 4. 需要透明背景时,Seedream 5.5 可直接传 `background: transparent`,并保持 `output_format` 为 `png`。 5. 不要传 `stream`、`sequential_image_generation`、`sequential_image_generation_options`,否则返回 400。 6. 生成较慢时可设置较长的客户端超时(建议 120 秒以上);超时不代表请求一定未成功,请结合业务侧幂等控制决定是否重试。 7. 对时延敏感的业务,可使用 Seedream 5.0 Flash,或使用 Seedream 5.0 Pro 的 `optimize_prompt_options.mode: fast`。 ## 六、Python 调用示例 以下示例使用标准 `requests` 库演示文生图。图生图、多图融合或图层拆分只需在请求体中加入 `image`、`layer_decomposition` 等字段。 ```python theme={null} import os import requests api_domain = os.environ["API_DOMAIN"] api_key = os.environ["PLATFORM_API_KEY"] payload = { "model": "doubao-seedream-5-5-261028", "prompt": "一只戴着红色围巾的金毛犬,在雪山湖边的自然光下,电影感摄影", "size": "2K", "response_format": "url", } response = requests.post( f"https://{api_domain}/v3/bytedance-cn/api/v3/images/generations", headers={ "Authorization": f"Bearer {api_key}", "Content-Type": "application/json", }, json=payload, timeout=180, ) response.raise_for_status() result = response.json() for item in result["data"]: print(item["size"], item["url"]) print(result["usage"]) ``` # Apifox接入 PPIO LLM API Source: https://ppio.com/docs/third-party/Apifox-use 按照 Apifox 接入教程配置 PPIO LLM API,了解接口连接与调用测试方式,为在 Apifox 中调试模型服务提供参考。 开发者调用 API 时,常在多个工具间切换,数据同步较为复杂。 Apifox 集 API 文档、调试、Mock、自动化测试于一体,将全流程集成于一个工具,提升开发效率与协作体验。 PPIO 派欧云的模型 API 服务可集成在 Apifox 中。完成配置后,即可在 Apifox 调用各主流模型,简化大模型集成流程。 ## **PPIO × Apifox配置教程** ### 获取 API key **1. 获取 API 密钥** 注册并登录派欧云。 打开 API 密钥管理页面,点击创建按钮,输入自定义密钥名称,生成 API 密钥。 ![1280X1280(1).PNG](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/third-party/images/Apifox/1280X1280\(1\).PNG?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=31f40641d61d540fc426a5213fead0a6) **2. 生成并保存 API 密钥** **注意**:密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建一个新的密钥。 ![1280X1280.PNG](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/third-party/images/Apifox/1280X1280.PNG?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=1e70b1d5b10ddf62acfacc879688dfe6) **3. 获取模型 ID** **需要使用的模型 ID** * deepseek/deepseek-v4-pro * deepseek/deepseek-v4.1-flash * qwen/qwen3.8-max * zai-org/glm-5.3 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/ai-computing/llm-api) ### 下载并配置 Apifox **1. 下载 Apifox** 前往 Apifox 官网下载应用。 下载地址:[https://apifox.com/](https://apifox.com/) ![1280X1280(2).PNG](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/third-party/images/Apifox/1280X1280\(2\).PNG?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=bb3ebfa2ad76f3df2e7f4eff6524ef81) **2. 克隆 API 项目** 打开 Apifox 客户端,点开「主窗口」左侧边栏的 API Hub,搜索找到 PPIO 派欧云项目并点进去。 ![d375ba84-7eee-4e1f-bd71-4462a95b87b8.png](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/Apifox/d375ba84-7eee-4e1f-bd71-4462a95b87b8.png?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=ab52a010cc3f17d71498cf28a0b01f96) 点击「克隆项目」,将该 API 文档克隆到你的团队。 ![aca7ca29-7b42-4576-933f-125a27c68206.png](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/Apifox/aca7ca29-7b42-4576-933f-125a27c68206.png?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=a28609c00b60405bb280eef03c7303df) **3. 配置 API Key** 打开克隆项目,选择「正式环境」,并在环境变量「api_key」中填入从派欧云官网保存的密钥,保存配置。 ![e095f54c-4b9c-45f6-a5bf-0179d694e81b.png](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/Apifox/e095f54c-4b9c-45f6-a5bf-0179d694e81b.png?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=d9474167f7f1582d38ef2cab00eb1d3d) **4. 配置聊天对话请求** 在大语言服务中,选择「创建聊天对话请求」,点击运行,按以下配置输入。 ```json theme={null} { "model": "deepseek/deepseek-v4-pro", "messages": [ { "content": "你是谁", "role": "user" } ], "max_tokens": 1000, "stream": false } ``` ![f8d64e2c-09c7-4881-98e5-0e61fe92fdc9.png](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/Apifox/f8d64e2c-09c7-4881-98e5-0e61fe92fdc9.png?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=abadc0fdb43b5f217b9e5940b38f2fa5) 如需切换模型,需将「model」字段值改为对应模型名称。 如:调用 deepseek/deepseek-v4.1-flash "model": "deepseek/deepseek-v4.1-flash" ![1bff28a6-aa43-4596-bfcb-d19c7d6b0e2f.png](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/third-party/images/Apifox/1bff28a6-aa43-4596-bfcb-d19c7d6b0e2f.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=dc94d3c203f6a3c91e7aa55ea58745bf) **5. 发送请求** 配置完成后,点击发送,即可收到模型返回的响应。 ![82bf51c4-cd6b-4afd-9024-ed0938e3e44e.png](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/Apifox/82bf51c4-cd6b-4afd-9024-ed0938e3e44e.png?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=a5469e2cae8e4f08aeda1dc534e62113) # AstrBot接入 PPIO LLM API Source: https://ppio.com/docs/third-party/AstrBot-use 查阅 AstrBot 接入 PPIO LLM API 的配置流程,了解模型服务连接与使用方式,为机器人应用准备语言模型能力。 在消息平台接入专属聊天机器人,可快速生成答案。与项目管理、CRM 等系统集成后,机器人能根据任务进展自动建群、推送进度提醒,并 @ 相关人员。 AstrBot 是一个多平台聊天机器人及开发框架,可调用多款主流 LLM,支持接入飞书、钉钉等消息平台。其模块化、低耦合的特点便于快速部署功能扩展。 以下为完整接入教程。 项目地址:[https://github.com/AstrBotDevs/AstrBot](https://github.com/AstrBotDevs/AstrBot) ## **PPIO × AstrBot配置教程** ### 获取 API key **1. 获取 API 密钥** 注册并登录派欧云。 打开 API 密钥管理页面,点击创建按钮,输入自定义密钥名称,生成 API 密钥。 ![1280X1280.PNG](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/AstrBot/1280X1280\(3\).PNG?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=7af8bc55e224ad729fb01f9cb9a36253) **2. 生成并保存 API 密钥** **注意**:密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并新建一个密钥。 ![1280X1280.PNG](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/AstrBot/1280X1280.PNG?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=fe2b8fa12a9d7731fce66da87940331e) **3. 获取模型 ID** **推荐使用的模型 ID** * deepseek/deepseek-v4-pro * deepseek/deepseek-v4.1-flash * qwen/qwen3.8-max * zai-org/glm-5.3 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ### 部署 AstrBot 通过 Docker 部署 **AstrBot**。 Docker 可将 AstrBot 部署到 Windows、macOS、Linux。 以下教程默认已安装 Docker。未安装请参考 Docker 官方文档。 文档地址:[https://docs.docker.com/get-started/get-docker/](https://docs.docker.com/get-started/get-docker/) ```bash theme={null} mkdir astrbot sudo docker run -itd -p 6180-6200:6180-6200 -p 11451:11451 -v $PWD/data:/AstrBot/data -v /etc/localtime:/etc/localtime:ro -v /etc/timezone:/etc/timezone:ro --name astrbot soulter/astrbot:latest ``` 如不需要映射全部端口,可参考下表: | Port | Description | Type | | :-: | :- | :-: | | 6185 | AstrBot WebUI 默认 端口 | 需要 | | 6195 | 企业微信 默认 端口 | 可选 | | 6199 | OneBot(aiocqhttp) 默认 端口 | 可选 | | 6196 | QQ 官方 API(Webhook) HTTP callback server 默认 端口 | 可选 | | 11451 | Gewechat callback HTTP server 默认 端口 | 可选 | Windows 下不需要加 sudo,下同。Windows 同步 Host Time 需要 WSL2。 ```bash theme={null} -v \\wsl.localhost\(your-wsl-os)\etc\timezone:/etc/timezone:ro -v \\wsl.localhost\(your-wsl-os)\etc\localtime:/etc/localtime:ro ``` 通过以下命令查看 AstrBot 日志: ```bash theme={null} sudo docker logs -f astrbot ``` AstrBot 支持基于 Docker 的沙箱代码执行器。如需使用,请额外添加 -v /var/run/docker.sock:/var/run/docker.sock 参数,即: ```bash theme={null} sudo docker run -itd -p 6180-6200:6180-6200 -p 11451:11451 -v $PWD/data:/AstrBot/data -v /var/run/docker.sock:/var/run/docker.sock -v /etc/localtime:/etc/localtime:ro -v /etc/timezone:/etc/timezone:ro --name astrbot soulter/astrbot:latest ``` 安装成功后,即可看到 AstrBot 打印的日志。 ### 配置 AstrBot **1. 访问管理面板** 当启动 AstrBot 之后,你可以通过浏览器访问[http://localhost:6185](http://localhost:6185) 来访问管理面板。默认用户名和密码是 astrbot 和 astrbot。 ![1e118328-eb1a-4535-8ea2-4486acaf5439.png](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/AstrBot/1e118328-eb1a-4535-8ea2-4486acaf5439.png?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=1c791c8fb7012bd6250088d6dab7de41) **2. 可视化配置** 在管理面板中,可通过可视化配置来配置 AstrBot 的插件。点击左栏配置即可进入配置页面。 ![f3c36f3d-5b8a-4a17-b283-0c5e1752da77.png](https://mintcdn.com/ppinfra/oBzzq-U4N4SIxMnr/third-party/images/AstrBot/f3c36f3d-5b8a-4a17-b283-0c5e1752da77.png?fit=max\&auto=format\&n=oBzzq-U4N4SIxMnr\&q=85\&s=e8ef11a2a2e7269dd2142c04e2070989) 顶部两个按钮可切换可视化编辑配置和代码编辑配置。 在可视化编辑配置中,修改完配置后,需点击右下角保存按钮保存配置。 在代码编辑配置中,可直接编辑配置文件。编辑完后先点击应用此配置,配置将应用到可视化配置中,再点击右下角保存按钮保存配置。 ![8e4e8624-9cfc-47ae-8cf1-9381c25db0a1.png](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/AstrBot/8e4e8624-9cfc-47ae-8cf1-9381c25db0a1.png?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=80459579b8ddbf77c51e81b840dfe46a) **3. 配置服务供应商** 打开 AstrBot,选择服务供应商,点击新增服务供应商,选择 PPIO 派欧云。 ![54713981-7729-4348-9816-626f23b92d90.jpg](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/AstrBot/54713981-7729-4348-9816-626f23b92d90.jpg?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=cc4529ac3291487550f05202baa689d4) ![8bc6cd7a-1cae-4548-b60f-026290878d14.jpg](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/AstrBot/8bc6cd7a-1cae-4548-b60f-026290878d14.jpg?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=747bb25e03fb099828b5973a6eaf94be) **4. 按以下方案配置模型** * ID:PPIO * 启用:开启 * API Key:PPIO 派欧云官网保存的密钥 * API Base URL:固定为 `https://api.ppio.com/openai` * 模型名称:从派欧云官网复制的模型名称 ![8fcde90c-e4f9-4191-90f6-45d93f3dffbe.jpg](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/AstrBot/8fcde90c-e4f9-4191-90f6-45d93f3dffbe.jpg?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=34fe8f8ebc6eb8803144ebfbb3f558ba) ### 接入平台 AstrBot 支持在多种消息平台上部署聊天机器人,此处以飞书为例。 **1. 创建机器人** 前往飞书「开发者后台」,创建企业自建应用,添加应用能力「机器人」。 地址:[https://open.feishu.cn/app](https://open.feishu.cn/app) ![12f614bd-c4d3-4456-81b5-b36e02f063bb.png](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/AstrBot/12f614bd-c4d3-4456-81b5-b36e02f063bb.png?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=416e274b53d295a0584ed0bf9c754ca2) ![227573a2-0ada-4fc9-9a2d-938413c5c7e8.png](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/AstrBot/227573a2-0ada-4fc9-9a2d-938413c5c7e8.png?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=f4a0f396413bd87efc42fd6d5c6714b4) **2. 获取凭证信息** 点击凭证与基础信息,获取 app_id 和 app_secret。 ![a86e4a30-f634-4904-82b0-ea904dffb70f.png](https://mintcdn.com/ppinfra/oBzzq-U4N4SIxMnr/third-party/images/AstrBot/a86e4a30-f634-4904-82b0-ea904dffb70f.png?fit=max\&auto=format\&n=oBzzq-U4N4SIxMnr\&q=85\&s=6817e1f7c03a92efa0a219aeea230be6) **3. 进入 AstrBot 管理面板** 进入 AstrBot 管理面板。 **4. 打开消息平台** 点击左边栏「消息平台」。 **5. 新增适配器** 在右侧界面中,点击 + 新增适配器。 **6. 选择飞书适配器** 选择 lark(飞书)。 **7. 填写配置项** 弹出的配置项填写: * ID(id):随意填写,用于区分不同的消息平台实例。 * 启用(enable):勾选。 * app_id:获取的 app_id * app_secret:获取的 app_secret * 飞书机器人的名字 如使用国际版飞书,请将 domain 设置为 `https://open.larksuite.com`。 **8. 在飞书后台配置事件与回调** 接下来,点击事件与回调,使用长连接接收事件,点击保存。如果上一步没有成功启动,这里将无法保存。 ![b3ef89a2-cfd9-4d24-a1bd-e6d53483ac7e.png](https://mintcdn.com/ppinfra/oBzzq-U4N4SIxMnr/third-party/images/AstrBot/b3ef89a2-cfd9-4d24-a1bd-e6d53483ac7e.png?fit=max\&auto=format\&n=oBzzq-U4N4SIxMnr\&q=85\&s=3324a1ee735b7f12e2287b27beae1311) 点击添加事件,消息与群组,下拉找到「接收消息」,确认添加。 ![8b5ff487-40aa-4766-b32f-2d8b9c68368b.png](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/AstrBot/8b5ff487-40aa-4766-b32f-2d8b9c68368b.png?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=52eb150e756d1719d4f6be1b0f898074) 点击开通以下权限。 ![97982c95-c3e5-45af-a71a-d30facbe8700.png](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/AstrBot/97982c95-c3e5-45af-a71a-d30facbe8700.png?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=549442d695916dda57b8b4e097f75563) 再点击上方的保存按钮。 **9. 开通消息权限** 接下来,点击权限管理,点击开通权限,输入 `im:message:send,im:message,im:message:send_as_bot`,添加筛选到的权限。 再次输入 ` im:resource:upload,im:resource` 开通上传图片相关的权限。 最终开通的权限如下图: ![a7ef4383-a302-430a-ba88-593291b2e596.png](https://mintcdn.com/ppinfra/oBzzq-U4N4SIxMnr/third-party/images/AstrBot/a7ef4383-a302-430a-ba88-593291b2e596.png?fit=max\&auto=format\&n=oBzzq-U4N4SIxMnr\&q=85\&s=9eb8a44c1b5f2dff9879674a6d4c60de) **10. 创建版本** ![19fc4899-a3e6-4864-8d5a-064ef0d11efb.png](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/AstrBot/19fc4899-a3e6-4864-8d5a-064ef0d11efb.png?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=e36b6cbe0b27cde89a54c1966da63fb7) **11. 开启对话** 进入飞书 APP(网页版飞书无法添加机器人),搜索刚刚创建的机器人名称,即可开启对话。 ![022a76a8-8506-49a5-b2ef-350337c76b52.jpg](https://mintcdn.com/ppinfra/R2NxCPPdlM2Tr19d/third-party/images/AstrBot/022a76a8-8506-49a5-b2ef-350337c76b52.jpg?fit=max\&auto=format\&n=R2NxCPPdlM2Tr19d\&q=85\&s=0e6ab546728527806f5935a6a4c0adae) # GPT4All 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/GPT4All-use 按照 GPT4All 集成指南连接 PPIO LLM API,查阅服务地址与模型配置相关说明,为在工具中使用模型服务提供参考。 用 AI 协助工作能提升效率,但把公司文件、客户资料上传到平台,存在信息泄露和合规风险。AI 缺少行业专业知识时,生成内容准确度不高,难以作为参考。 在本地电脑上分析整理文档、构建私有知识库,可以降低数据泄露风险,减少幻觉,让 AI 的回答更贴合实际业务场景。 下面使用 GPT4All 结合 PPIO 派欧云提供的高性能大模型 API 服务,构建本地知识库,让 AI 成为最懂你业务的「私人顾问」。 ## **PPIO × GPT4All 配置教程** ### 获取 API key **1. 获取 API 密钥** 注册并登录派欧云。 打开 API 密钥管理页面,点击创建按钮,输入自定义密钥名称,生成 API 密钥。 ![1280X1280(2).PNG](https://mintcdn.com/ppinfra/oBzzq-U4N4SIxMnr/third-party/images/GPT4All/1280X1280\(2\).PNG?fit=max\&auto=format\&n=oBzzq-U4N4SIxMnr\&q=85\&s=5284801011f8d93a6db7fef2fbe60fa3) **2. 生成并保存 API 密钥** **注意**:密钥在服务端是加密存储,请在生成时保存好密钥;若遗失可以在控制台上删除并创建一个新的密钥。 ![1280X1280.PNG](https://mintcdn.com/ppinfra/oBzzq-U4N4SIxMnr/third-party/images/GPT4All/1280X1280.PNG?fit=max\&auto=format\&n=oBzzq-U4N4SIxMnr\&q=85\&s=6c4cc8da7b38ef6e699c7c6583c6c962) **3. 获取模型 ID** **需要使用的模型 ID** * deepseek/deepseek-v4-pro * deepseek/deepseek-v4.1-flash * qwen/qwen3.8-max * zai-org/glm-5.3 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ## 下载并配置GPT4All **1. 下载GPT4All** 前往 GPT4All 官网下载应用。 下载地址:[https://www.nomic.ai/gpt4all](https://www.nomic.ai/gpt4all) ![1280X1280(1).PNG](https://mintcdn.com/ppinfra/oBzzq-U4N4SIxMnr/third-party/images/GPT4All/1280X1280\(1\).PNG?fit=max\&auto=format\&n=oBzzq-U4N4SIxMnr\&q=85\&s=f4ddfeda7650665d08bedc7533d362f7) **2. 配置API密钥** 主页点击【查找模型】,选择【自定义】,填入对应内容。 * ① API 密钥:从派欧云官网保存的 API 密钥; * ② 基础 URL:`https://api.ppio.com/openai` * ③ 添加你所需要的模型名称,例如:deepseek/deepseek-v4.1-flash ![download.png](https://mintcdn.com/ppinfra/oBzzq-U4N4SIxMnr/third-party/images/GPT4All/download.png?fit=max\&auto=format\&n=oBzzq-U4N4SIxMnr\&q=85\&s=1faed5ebb67bd4656b9d22e6ac4dfa21) ![841cbcd0-db43-4b64-9985-2a79dcb368b7.png](https://mintcdn.com/ppinfra/oBzzq-U4N4SIxMnr/third-party/images/GPT4All/841cbcd0-db43-4b64-9985-2a79dcb368b7.png?fit=max\&auto=format\&n=oBzzq-U4N4SIxMnr\&q=85\&s=4f41dd8eb9a677eb5f956e07e12bdef0) **3. 选择所需模型** 打开对话窗口,选择所需使用模型,此时已经可以进行对话,但想要模型根据本地文档生成内容,还需构建私有知识库。 ![d3b4457f-c928-42b8-b689-bf78323679b8.png](https://mintcdn.com/ppinfra/oBzzq-U4N4SIxMnr/third-party/images/GPT4All/d3b4457f-c928-42b8-b689-bf78323679b8.png?fit=max\&auto=format\&n=oBzzq-U4N4SIxMnr\&q=85\&s=6b30922b9360160d3d64be748605889c) ## 构建私有知识库 **1. 创建本地文档合集** 点击【本地文档】,选择你的本地文档所在文件夹,并输入文档名称。 ![444a6dfa-314e-4a77-9e69-5aa3e639eeac.png](https://mintcdn.com/ppinfra/oBzzq-U4N4SIxMnr/third-party/images/GPT4All/444a6dfa-314e-4a77-9e69-5aa3e639eeac.png?fit=max\&auto=format\&n=oBzzq-U4N4SIxMnr\&q=85\&s=a842d8ecb1d64217eabb5fe5a3c70ff3) **2. 配置Embedding模型** 文档合集创建后,系统会自动下载所需 Embedding 模型,模型下载完成显示「准备」时,即代表已完成配置。 ![7ad92fb5-bba9-49f8-bbf2-22e06d668a27.png](https://mintcdn.com/ppinfra/oBzzq-U4N4SIxMnr/third-party/images/GPT4All/7ad92fb5-bba9-49f8-bbf2-22e06d668a27.png?fit=max\&auto=format\&n=oBzzq-U4N4SIxMnr\&q=85\&s=ee9d92c0e3092c52083ba945fb089fa5) ![d2475be4-1904-489f-8b94-5e751a375488.png](https://mintcdn.com/ppinfra/oBzzq-U4N4SIxMnr/third-party/images/GPT4All/d2475be4-1904-489f-8b94-5e751a375488.png?fit=max\&auto=format\&n=oBzzq-U4N4SIxMnr\&q=85\&s=6c383db26d9b5f976daf606fbb8f3a26) **3. 开启本地知识库使用** 回到对话页面,勾选此前创建本地文档合集,对话时就可以看到模型从本地知识库开始检索并生成回答。 ![ec8d0b96-0407-421b-9b4a-0a410067a48d.png](https://mintcdn.com/ppinfra/oBzzq-U4N4SIxMnr/third-party/images/GPT4All/ec8d0b96-0407-421b-9b4a-0a410067a48d.png?fit=max\&auto=format\&n=oBzzq-U4N4SIxMnr\&q=85\&s=92ef5805f556885e2310bcb96ec99411) # OneAPI 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/OneAPI-use 了解 OneAPI 接入 PPIO LLM API 的配置方式,查阅模型服务连接与调用说明,为管理应用的模型接口提供参考。 OneAPI 是 LLM API 管理与分发系统,支持多种主流大模型,提供统一的 API 适配方案,用于密钥管理和二次分发。 OneAPI 支持通过 PPIO 派欧云的 API 密钥接入 DeepSeek 大模型。OneAPI 提供单可执行文件和 Docker 镜像,支持一键部署。 下方教程包含完整的接入方案(含密钥配置),约 3 分钟即可完成。 ## PPIO x OneAPI 图文使用教程 ### 配置前置条件 **1. 获取 API 密钥** 登录派欧云控制台 [API密钥管理](https://ppio.com/settings/key-management) 页面,点击创建按钮。 ![1.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oneapi/1.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=f8ff01bf89a83fcec51d4a72165a0509) **2. 生成并保存 API 密钥** **注意**:密钥在服务端是加密存储,请在生成时保存好密钥;若遗失可以在控制台上删除并创建一个新的密钥。 ![2.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oneapi/2.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=26a44056e6a5abb04160a2ed9b849b1e) ![3.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oneapi/3.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=4068116bae6b32f3c581b915b223160a) **3. 获取需要使用的模型 ID** deepseek 系列: DeepSeek V4 Pro:deepseek/deepseek-v4-pro DeepSeek V4.1 Flash:deepseek/deepseek-v4.1-flash 其他模型 ID 及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ### 软件配置和使用 首先部署 OneAPI 至本地(参考 [https://github.com/songquanpeng/one-api](https://github.com/songquanpeng/one-api) 部署)。 #### 新建 PPIO 渠道 **1. 登录 OneAPI 并添加渠道** 登录至 OneAPI 首页,点击渠道页面并点击添加新的渠道。 ![4.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oneapi/4.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=b45f97a61b99282ee4f459476a1f1973) **2. 填写渠道信息并提交** ![5.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oneapi/5.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=9d97a92b3cc545c5c58a527a5d63ad4f) **3. 选择模型并测试渠道** 返回渠道页面,选择 deepseek/deepseek-v4-pro 模型,点击测试。 ![6.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oneapi/6.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=ca84a64de2e0c92c017fbc7ec220af98) #### 新建令牌生成 Token **1. 添加新的令牌** 点击令牌页面,添加新的令牌。 ![7.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oneapi/7.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=b0aa8804158430757ab02e10ce3db35c) **2. 填写令牌信息并提交** ![8.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oneapi/8.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=4a157e3c57be674b1daf8a7d287fc4c3) **3. 获取 OneAPI 生成的 Token** ![9.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oneapi/9.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=e0eafee4e4fee0af900d082cb2d89ebd) #### 验证 OneAPI 生成的 Token **1. 发送询问请求验证 Token** 对 deepseek/deepseek-v4-pro 发送一个询问请求。 通过 OneAPI 生成的 token,你可以使用 OneAPI 部署的 base url 加上这个 token,自定义额度、模型等信息,更方便管理你的 API。这里可以直接在 cmd 中通过 curl 命令查看是否成功: ``` curl "http://${OneAPI部署的地址:端口}/v1/chat/completions" -H "accept: application/json" -H "authorization: Bearer ${OneAPI Token}" -H "content-type: application/json" -X POST -d "{\"messages\":[{\"role\":\"user\",\"content\":\"你好\"}],\"model\":\"deepseek/deepseek-v4-pro\",\"temperature\":0.5,\"presence_penalty\":0,\"frequency_penalty\":0,\"top_p\":1}" ``` 会出现如下的返回结果: ![10.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oneapi/10.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=fe6394f086c6f34447e8cfa1f0f0fb3a) 同理也可以通过可以自定义 base url 以及 API key 的应用(比如 ChatBox)来验证。 **2. 查看额度** 回到 OneAPI 界面查看额度,可以发现额度已经使用了一部分。 ![11.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oneapi/11.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=65e39f81c0b5eadbaf6591f916dfa9e1) # OpenAI Agents SDK 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/OpenAI-Agents-SDK 查阅 OpenAI Agents SDK 与 PPIO LLM API 的集成指南,了解模型连接和相关配置,为构建智能体应用提供接入参考。 3 月 12 日,OpenAI 推出 Agents SDK。[OpenAI Agents SDK](https://github.com/openai/openai-agents-python) 是用于构建多代理工作流的轻量级框架,可将搭建 AI 代理的时间从几周缩短到几分钟。 该 SDK 基于 OpenAI 语言模型,支持创建可理解自然语言、执行任务并与用户交互的智能代理,兼容任何支持 OpenAI Chat Completions API 格式的模型提供商。 ![1.PNG](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/OpenAI-Agents-SDK/1.PNG?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=bdf9889c5f65e58c6d7ab4a87209a061) PPIO 派欧云提供高性能 API 服务,涵盖 DeepSeek、Qwen、GLM、Kimi 等系列模型,一行代码即可调用;支持在 chatbox、AnythingLLM、Ragflow 等 20+ 主流第三方平台调用。 以下教程介绍如何集成 PPIO LLM API 与 OpenAI Agents SDK,构建多代理工作流。 ## PPIO X OpenAI Agents SDK 图文集成教程 ### 前置条件:获取 PPIO LLM API key 【API Base URL】:固定为:[https://api.ppio.com/openai](https://api.ppio.com/openai) **1. 创建 API 密钥** 登录派欧云控制台[API密钥管理](https://ppio.com/settings/key-management)页面,点击【+创建】按钮。 ![2.PNG](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/OpenAI-Agents-SDK/2.PNG?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=24f462f75841c9d3958408fb4a17aac2) **2. 生成并保存 API 密钥** 生成并保存【API密钥】 **注意**:密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建新的密钥。 ![3.PNG](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/OpenAI-Agents-SDK/3.PNG?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=01af9d069ec9d0f874973365dcb23016) ![4.PNG](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/OpenAI-Agents-SDK/4.PNG?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=9de165bb89654ec59b093df94c3a7480) **3. 获取需要使用的模型 ID** 获取需要使用的模型 ID,推荐使用: * deepseek/deepseek-v4-pro * deepseek/deepseek-v4.1-flash * qwen/qwen3.8-max * zai-org/glm-5.3 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ### 设置 Python 环境并安装 Agents SDK 设置 Python 环境并安装 Agents SDK,输入以下代码即可完成操作: ``` python -m venv env source env/bin/activate pip install openai-agents==0.0.7 ``` ## 运行示例 ### 示例1:输出功能 运行前,请确保已设置`PPIO API KEY`和`模型名称`环境变量 ```python theme={null} import os from openai import AsyncOpenAI from agents import ( Agent, Runner, set_default_openai_api, set_default_openai_client, set_tracing_disabled, ) BASE_URL = "https://api.ppio.com/openai" API_KEY = "在此处粘贴 PPIO 官网的 API Key" #此处需修改 MODEL_NAME = "在此输入模型名称" #此处需修改 # 基于PPIO不支持responses API,因此我们使用chat completions API作为示例 set_default_openai_api("chat_completions") set_default_openai_client(AsyncOpenAI(base_url=BASE_URL, api_key=API_KEY)) # 在此示例中禁用追踪# 如需使用自定义追踪处理器,请参考:https://openai.github.io/openai-agents-python/tracing/#external-tracing-processors-list set_tracing_disabled(disabled=True) agent = Agent(name="Assistant", instructions="You are a helpful assistant", model=MODEL_NAME) result = Runner.run_sync( agent, "Write a haiku about recursion in programming.") print(result.final_output) #输出示例: # Code within the code, # Functions calling themselves, # Infinite loop's dance. ``` ### 示例2:Handoff 运行前,请确保已设置`PPIO API KEY`和`模型名称`环境变量 ```python theme={null} import os import asyncio from openai import AsyncOpenAI from agents import ( Agent, Runner, set_default_openai_api, set_default_openai_client, set_tracing_disabled, ) BASE_URL = "https://api.ppio.com/openai" API_KEY = "在此处粘贴PPIO官网的API Key" #此处需修改 MODEL_NAME = "在此输入模型名称" #此处需修改 # 基于PPIO不支持responses API,因此我们使用chat completions API作为示例 set_default_openai_api("chat_completions") set_default_openai_client(AsyncOpenAI(base_url=BASE_URL, api_key=API_KEY)) # 该示例中禁止使用追踪 #如需使用自定义追踪处理器,请参考:https://openai.github.io/openai-agents-python/tracing/#external-tracing-processors-list to use the custom spans. set_tracing_disabled(disabled=True) spanish_agent = Agent( name="Spanish agent", instructions="You only speak Spanish.", model=MODEL_NAME, ) english_agent = Agent( name="English agent", instructions="You only speak English", model=MODEL_NAME, ) triage_agent = Agent( name="Triage agent", instructions="Handoff to the appropriate agent based on the language of the request.", handoffs=[spanish_agent, english_agent], model=MODEL_NAME, ) async def main(): result = await Runner.run(triage_agent, input="Hola, ¿cómo estás?") print(result.final_output) #输出示例: # ¡Hola! Estoy bien, gracias por preguntar. ¿Y tú, cómo estás? if __name__ == "__main__": asyncio.run(main()) ``` ### 示例3:函数工具调用 运行前,请确保已设置`PPIO API KEY`和`模型名称`环境变量 ```python theme={null} import os import asyncio from openai import AsyncOpenAI from agents import ( Agent, Runner, set_default_openai_api, set_default_openai_client, set_tracing_disabled, function_tool, ) BASE_URL = "https://api.ppio.com/openai" API_KEY = "在此处粘贴PPIO官网的API Key" #此处需修改 MODEL_NAME = "在此输入模型名称" #此处需修改 # 基于PPIO不支持responses API,因此我们使用chat completions API作为示例 set_default_openai_api("chat_completions") set_default_openai_client(AsyncOpenAI(base_url=BASE_URL, api_key=API_KEY)) # 该示例中禁止使用追踪 #如需使用自定义追踪处理器,请参考:https://openai.github.io/openai-agents-python/tracing/#external-tracing-processors-list to use the custom spans. set_tracing_disabled(disabled=True) @function_tool def get_weather(city: str) -> str: return f"The weather in {city} is sunny." agent = Agent( name="Hello world", instructions="You are a helpful agent.", tools=[get_weather], model=MODEL_NAME, ) async def main(): result = await Runner.run(agent, input="What's the weather in Tokyo?") print(result.final_output) #输出示例: # The weather in Tokyo is sunny. if __name__ == "__main__": asyncio.run(main()) ``` # RuoYi AI 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/RuoYiAI-use 按照 RuoYi AI 接入指南配置 PPIO LLM API,了解模型服务连接与使用流程,为在应用中调用语言模型提供参考。 AI 应用已覆盖金融、医疗、教育等领域,需求差异大。 传统开发流程搭建 AI 应用,需要微服务架构支撑高并发请求,还要整合知识图谱构建、多轮对话管理、意图识别引擎等十余项技术模块。 如何更简单、高效地搭建 AI 应用? 全栈式 AI 开发平台 RuoYi AI 提供开箱即用的开源方案,涵盖前端应用、后台管理、小程序应用。系统基于 MIT 协议,可自由修改和分发代码,支持免费商用,省去繁琐的搭建过程。 在 PPIO 派欧云高性能 API 服务支持下,开发者可调用 DeepSeek、Qwen、GLM、Kimi 等主流大模型,为 AI 应用「注入灵魂」。完整配置教程如下。 ## **PPIO × RuoYi AI 配置教程** ### 项目环境 * JDK 17 * MySQL 5.7、8.0 * Redis 版本必须 >= 5.X * Maven 3.8+ * Node.js 20+ 与 pnpm ### 安装后端 **1. 下载项目** [https://gitee.com/ageerle/ruoyi-ai](https://gitee.com/ageerle/ruoyi-ai) **2. idea 导入项目** ![1280X1280(3).PNG](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/RuoYiAI/1280X1280\(3\).PNG?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=fc8c03d3798bb1f155dc4968398950e4) **3. 配置 Maven 文件** 配置 Maven 文件 - 设置 - 左上角搜索框输入 Maven - 选择 Maven 安装目录 ![1280X1280.PNG](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/RuoYiAI/1280X1280.PNG?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=5d859bf640895dd9119514896e652046) XML 配置 ```bash theme={null} D:/dev/apache-maven-3.9.9/repository aliyunmaven * 阿里云公共仓库 https://maven.aliyun.com/repository/public jdk-17 true 17 17 17 17 ``` **4. 初始化数据库** ![2e9715ba-1463-4fd3-9578-529ef61d2a6e.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/RuoYiAI/2e9715ba-1463-4fd3-9578-529ef61d2a6e.png?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=9abd39244c91aa1182790e3bed5faee4) ![92763c60-7c29-4620-ac76-9258e0f5eded.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/RuoYiAI/92763c60-7c29-4620-ac76-9258e0f5eded.png?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=e8bc292292a8ab9bdd4bc32c75e45c84) **5. 启动 redis** * 下载地址:[https://github.com/tporadowski/redis/releases](https://github.com/tporadowski/redis/releases) ![8bb5c31d-7947-4737-9a21-47816654fb55.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/RuoYiAI/8bb5c31d-7947-4737-9a21-47816654fb55.png?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=47da48ac0b2c8715c65657b940b37daa) **6. 启动项目** ![f6c1e1e7-7ec9-4ed8-bf6a-a4c824588770.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/RuoYiAI/f6c1e1e7-7ec9-4ed8-bf6a-a4c824588770.png?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=ea3fc60328db9fa6af1b00eab3635a8d) ## 安装管理端 **1. 下载项目** [https://gitee.com/ageerle/ruoyi-admin](https://gitee.com/ageerle/ruoyi-admin) **2. 安装依赖** ```javascript theme={null} pnpm install ``` **3. 运行项目** ```javascript theme={null} pnpm dev ``` **4. 打包** ```javascript theme={null} pnpm build ``` **5. 修改配置项** * 后台接口:`/apps/web-antd/vite.config.mts` ![343335cf-840f-4c6f-88f7-95b502fd2661.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/RuoYiAI/343335cf-840f-4c6f-88f7-95b502fd2661.png?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=d5a405176417ba48787be3d594f51129) * 其他配置:`/apps/web-antd/.env.development` ## 安装用户端 **1. 下载项目** [https://gitee.com/ageerle/ruoyi-web](https://gitee.com/ageerle/ruoyi-web) **2. 安装依赖** JavaScript ```javascript theme={null} npm install ``` **3. 运行项目** JavaScript ```javascript theme={null} npm run dev ``` **4. 打包** JavaScript ```javascript theme={null} npm run build ``` ## 接入AI大模型 **1. 获取 API 密钥** 注册并登录派欧云。 打开 API 密钥管理页面,点击创建按钮,输入自定义密钥名称,生成 API 密钥。 ![b4494865-1b3c-4052-a4fc-9ee04d470f4e.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/RuoYiAI/b4494865-1b3c-4052-a4fc-9ee04d470f4e.png?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=d8d83c751d241cb128d98075610e626c) ![980d9163-97ec-4318-99c0-58c2adf14afb.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/RuoYiAI/980d9163-97ec-4318-99c0-58c2adf14afb.png?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=91be5cb0c8d2d6aad8068aca82c939a7) **2. 生成并保存 API 密钥** **注意**:密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建一个新的密钥。 ![838ecbae-0422-473b-b2e8-d700004d5efa.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/RuoYiAI/838ecbae-0422-473b-b2e8-d700004d5efa.png?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=ac85c5da7bc413b1a4c35e9837fe67c7) **3. 获取 API Base URL** 固定为:`https://api.ppio.com/openai` **4. 获取需要使用的模型 ID** * deepseek/deepseek-v4-pro * deepseek/deepseek-v4.1-flash * qwen/qwen3.8-max * zai-org/glm-5.3 其他模型 ID、最大上下文及价格可参考:[PPIO派欧云 - AI 云端一体化解决方案: 模型 API、Serverless、GPU 租赁](https://ppio.com/model-api/console) **5. 后台模型管理配置** 前往 RuoYi AI 运营管理-系统模型页面配置模型。 * 模型名称:所需模型名称,如 qwen/qwen3.8-flash * 模型描述:所需模型名称,如 qwen/qwen3.8-flash * 模型价格:规定模型价格 * 计算类型:次数计费 * 请求地址:`https://api.ppio.com/openai` * 密钥:派欧云官网所保存密钥 ![b65b799c-a202-49eb-9c33-6df0755599c7.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/RuoYiAI/b65b799c-a202-49eb-9c33-6df0755599c7.png?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=5f9551e5973dd131cff26d73d21b9bb5) 效果展示: ![6245663e-c9e1-4101-8336-08dfe121e4c5.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/RuoYiAI/6245663e-c9e1-4101-8336-08dfe121e4c5.png?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=55afc8feab887754b6df335cfc20e15e) # UI-TARS 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/UI-TARS-use 了解 UI-TARS 接入 PPIO LLM API 的配置方式,查阅工具与模型服务的连接说明,为使用相关 AI 交互流程提供参考。 UI-TARS Desktop 是字节跳动近期推出的开源项目,通过自然语言理解和处理来控制计算机界面。 PPIO 派欧云提供高性能 API 服务,涵盖 DeepSeek、Qwen、GLM、Kimi 等系列模型,一行代码即可调用。 ## PPIO x UI-Tars 图文使用教程 ### 配置前置条件 API Base URL 固定为:`https://api.ppio.com/openai` **1. 获取 API Key** 登录派欧云控制台[API密钥管理](https://ppio.com/settings/key-management)页面,点击创建按钮。 ![1.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/UI-TARS/1.PNG?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=45734a851a280da23494447e2611ef4f) **2. 生成并保存 API 密钥** **注意**:密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并新建一个密钥。 ![2.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/UI-TARS/2.PNG?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=8bac6ef99ce317e1c000bbba2bcd5fe7) ![3.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/UI-TARS/3.PNG?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=40941e09c8b0d8d142bb0b3552163f6a) **3. 获取需要使用的模型 ID** 推荐使用: * deepseek/deepseek-v4-pro * deepseek/deepseek-v4.1-flash * qwen/qwen3.8-max * zai-org/glm-5.3 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ### 安装和配置 UI-Tars **1. 下载并安装客户端** 前往:[https://github.com/bytedance/UI-TARS-desktop/releases/tag/Agent-TARS-v1.0.0-alpha.5](https://github.com/bytedance/UI-TARS-desktop/releases/tag/Agent-TARS-v1.0.0-alpha.5) 下载并安装最新版本的客户端(目前仅支持 macOS)。 **2. 打开设置** 下载完成后点击左下角【设置】。 ![4.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/UI-TARS/4.PNG?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=58e72f436fa577142d209e8abcf7fd83) **3. 填写自定义模型配置** 先打开【Use custom model name】的按钮,在【Model Name】处填写官网的模型名称,在【API Key】处填写创建的密钥,在【Custom Endpoint】处填写官网的 Base URL,最后点击 Save。 ![5.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/UI-TARS/5.png?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=bac3b148f574c1474aa723abc47063e5) ### 运行效果展示 输入准备好的 prompt: ``` 使用网络浏览器查询旧金山当前的天气情况。 ``` ![6.gif](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/UI-TARS/6.gif?s=863078085e98613443c60b264bd235b7) UI-TARS 按「获取旧金山天气信息」的指令执行,通过浏览器查询旧金山地区的天气数据源,并呈现当前天气信息。 # Zotero接入 PPIO LLM API Source: https://ppio.com/docs/third-party/Zoter-use 查阅 Zotero 接入 PPIO LLM API 的指南,了解工具中的模型连接与相关设置,为文献工作流使用语言模型服务提供参考。 科研人员每天要花大量时间阅读整理文献,这些时间本可以用于更重要的思考与创新。 Zotero 是免费开源的文献管理工具,支持文献分类管理、自动生成多种格式引文、批注笔记和云同步。用户还可通过插件扩展翻译、自动下载 PDF 等功能。 结合 PPIO 派欧云的大模型 API 服务,Zotero 除整理文献外还支持 AI 对话,可通过 AskPDF 标签向 PDF 提问,自动生成文献核心观点摘要、提炼研究方法和结论数据。以下为配置教程,介绍如何用「PPIO + Zotero」搭建论文提效工具。 ## **PPIO × Zotero 配置教程** ### 获取 API key **1. 获取 API 密钥** 注册并登录[派欧云](https://ppio.com/)。 打开 API 密钥管理页面,点击创建按钮,输入自定义密钥名称,生成 API 密钥。 ![1280X1280(3).PNG](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/Zoter/1280X1280\(3\).PNG?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=488eea0e325e53b8eb1764aee0c19166) **2. 生成并保存 API 密钥** **注意**:密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建一个新的密钥。 ![1280X1280.PNG](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/Zoter/1280X1280.PNG?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=92b795c50b7bc3e422a71f2b3c2b2f0b) **3. 获取 【API Base URL】** 固定为:`https://api.ppio.com/openai` **4. 获取需要使用的模型 ID** * deepseek/deepseek-v4-pro * deepseek/deepseek-v4.1-flash * qwen/qwen3.8-max * zai-org/glm-5.3 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ### 安装 Zotero 及插件 Awesome GPT **1. 下载并安装Zotero** 下载地址:[https://www.zotero.org/](https://www.zotero.org/) ![1280X1280(1).PNG](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/Zoter/1280X1280\(1\).PNG?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=684c0b34c2abba4aab90857273b7cda1) **2. 下载插件 Awesome GPT** 下载 Zotero 插件 Awesome GPT 在 Zotero 中文社区找到 Awesome GPT 并下载,注意区分 Zotero 版本,2 个版本互不兼容。 下载地址:[https://zotero-chinese.com/](https://zotero-chinese.com/) ![b3867559-a627-4609-824d-3c238ffc9042.png](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/Zoter/b3867559-a627-4609-824d-3c238ffc9042.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=0cbaea563aad317f9fe89e4bd6ad5d2c) ![4f99efd5-f0b3-4512-b18f-02a16c7aecf2.png](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/Zoter/4f99efd5-f0b3-4512-b18f-02a16c7aecf2.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=a82a9f92a24d419a9d2640d8e40bcd28) **3. 安装Awesome GPT** 打开 Zotero - 工具 - 插件 - Install Plugin From File - 找到自己下载的文件(如 zotero-gpt.xpi)。 ![0dc1caab-1ac6-4f9b-a875-0fc9b0cf1bd9.png](https://mintcdn.com/ppinfra/FhPQL2dauyVkuUFM/third-party/images/Zoter/0dc1caab-1ac6-4f9b-a875-0fc9b0cf1bd9.png?fit=max\&auto=format\&n=FhPQL2dauyVkuUFM\&q=85\&s=6ebee264bcefb1ee0cb3e0398cf3a686) ![40adb0ef-afad-4b3f-9955-a6aa43b00c88.png](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/Zoter/40adb0ef-afad-4b3f-9955-a6aa43b00c88.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=8c76ca135abeaaede5a19b60c86aaec0) **4. 升级插件版本(确保在1.6.6以上)** ![64804747-1a57-466d-8ef8-0b2674fb79c6.png](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/Zoter/64804747-1a57-466d-8ef8-0b2674fb79c6.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=30e47fd376ae4d8e0562d55766d83bca) ### 配置 Zotero **1. 设置Awesome GPT** 打开 编辑 - 设置 - GPT,按以下内容填写对应输入框: * ① `https://api.ppio.com/openai` * ② 从派欧云官网保存的 API 密钥 * ③ deepseek/deepseek-v4.1-flash * ④ `https://api.ppio.com/openai/v1/embeddings` * ⑤ 从派欧云官网保存的 API 密钥 * ⑥ `baai/bge-m3` ![7891e682-a803-4e72-a657-de68d4a955df.png](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/Zoter/7891e682-a803-4e72-a657-de68d4a955df.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=3ebba33cddb3b4583deeddff7316ea52) **2. 测试是否配置成功** 点击 Test,显示 Normal 代表成功。 ![f956fcf9-1f48-49c9-82a4-451bb767dfe5.png](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/Zoter/f956fcf9-1f48-49c9-82a4-451bb767dfe5.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=34e34f983a4777ce4331522f1964ad7a) **3. 主页唤醒GPT,开启沟通** 点击文章页 GPT 图标,唤醒 GPT,即可高效阅读整理文献。 ![5d19ce51-fb79-40e7-85a5-48b4298c1be8.png](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/Zoter/5d19ce51-fb79-40e7-85a5-48b4298c1be8.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=95c1c21794d39feb54ac15cf7abc696f) # AnythingLLM 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/anythingllm-use 按照 AnythingLLM 集成指南连接 PPIO LLM API,了解模型服务配置与使用方式,为在应用中组织语言模型任务提供参考。 ## 教程概述 **AnythingLLM** 是本地化部署工具,支持接入多种大模型 API。主要特点: * **免费开源**:无需额外付费。 * **简单易用**:国内网络可直接使用。 * **功能强大**:集成本地文件,支持多任务处理。 搭配 PPIO 派欧云 API 通道,AnythingLLM 响应更快、稳定性更高。 完整教程约 3 分钟即可完成配置。 ## 安装 AnythingLLM 软件 首先,在 [AnythingLLM](https://anythingllm.com/desktop) 官网下载并安装软件,安装完成后打开软件。 ![AnythingLLM 安装](https://static.ppinfra.com/docs/image/llm/NQa5b9pPSoXMLexZZjzcM4oCngh.png) ## 注册 PPIO 派欧云账号并生成 API Key 调用模型前,需在 [PPIO 派欧云官网](https://ppio.com/) 注册账号并生成 API Key。 **1. 注册账号** 前往 PPIO 派欧云官网注册账号并完成实名认证。 **2. 生成 API 密钥** 前往 [PPIO 派欧云 API 密钥管理](https://ppio.com/settings/key-management),点击【用户头像】—【API 密钥管理】进入控制台 ![PPIO 派欧云 API 密钥管理](https://static.ppinfra.com/docs/image/llm/O60Jbx6LJo3LF2x8bffcyAtrn6g.png) 点击【+ 创建】按钮创建新的 API 密钥。自定义密钥名称,生成的**密钥仅在生成时呈现,务必复制并保存到文档中,以免影响后续使用** ![PPIO 派欧云 API 密钥管理](https://static.ppinfra.com/docs/image/llm/MIXQbkCgNouz6mxBdpVcxAaHnof.png) **3. 复制模型名称** 前往 [PPIO 模型列表](https://ppio.com/model-api/pricing) 复制模型名称,例如:`deepseek/deepseek-v4-pro` 或 `deepseek/deepseek-v4.1-flash`;最后点击 SAVE ## 配置 AnythingLLM 设置 **1. 打开设置页面** 打开 AnythingLLM 软件,点击左下方图标进入设置页面。 ![AnythingLLM 设置](https://static.ppinfra.com/docs/image/llm/LjWLbZybkohp0vxIsyZcEdIDnYb.png) **2. 选择 Generic Open AI** 在 LLM 提供商选项中,选择 **Generic Open AI**。 **3. 填写连接信息并保存** * 在 API Key 栏中,粘贴你从 PPIO 派欧云生成的 API Key。 * 在 Base URL 栏中,填写:`https://api.ppio.com/openai`。 * 在 Model ID 栏中,粘贴你从 [PPIO 模型列表页](https://ppio.com/model-api/product/llm-api) 复制的模型 ID(例如:`deepseek/deepseek-v4-pro`)。 * Token context window 建议设置为默认值 4096。 * 点击【Save changes】保存配置。 ![AnythingLLM 设置](https://static.ppinfra.com/docs/image/llm/LPVLbSmuhoR81Bxqznic9zXun3f.png) ## 上传本地文件或网页 完成配置后,点击下图中的本地文件或网页上传图标上传文件,点击「Save and Embed」完成上传,然后点击「Move to Workspace」。 ![AnythingLLM 上传文件](https://static.ppinfra.com/docs/image/llm/PvxGbykHSoQ6CHxwT0fcwb5Hnoe.png) ![AnythingLLM 上传文件](https://static.ppinfra.com/docs/image/llm/CP31bstk7oWqtdxFDZucGcCOnzh.png) ## 尝试提问 在 AnythingLLM 中提问,模型将基于上传的文件内容回答,对话中会显示引用的文件内容。 ![AnythingLLM 提问](https://static.ppinfra.com/docs/image/llm/IL9Hb12ojockEzxdpYacNa8znr7.png) # CC Switch 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/cc-switch 按步骤获取 PPIO API Key、安装 CC Switch,在预设供应商中添加 PPIO,在 Claude Code、Hermes 等工具中切换使用 PPIO 模型。 ![CC Switch 接入 PPIO](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/cc-switch/img_v3_0214u_45631d99-a5d8-4d7e-99b2-7c39393b12eg.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=55d0b9ac0d325c91ab0f0c5e5f46451a) AI 编程工具的重度用户,大概率经历过这样的场景: 想从官方 Claude 切到性价比更高的第三方模型,需要先翻文档找 API 地址,再手动编辑 `settings.json`,逐项修改 API Key 和模型名。 格式写错一行,终端直接报错。调通之后,又想同时用 Codex 和 Gemini CLI 跑同一个项目,只能在三个工具里分别配置一遍相同的密钥。 成本同样难以掌握:不同供应商的 Token 价格差异很大,却没有一个地方能直观看到「这个月各家到底花了多少钱」,选模型只能凭感觉。 CC Switch 可以解决这些问题。 CC Switch 是一款跨平台桌面应用,面向使用 AI 编程工具的开发者,用于统一管理 Claude Code、Claude Desktop、Codex、Gemini CLI、OpenCode、OpenClaw 和 Hermes 等受管应用的配置。无需手动维护配置文件,在界面上点击即可在不同 Agent 工具之间切换任意模型。 CC Switch 在 GitHub 上有 129K 星标。 CC Switch 已集成 PPIO 的模型服务。在预设供应商页面点击 PPIO,几分钟内即可完成配置,之后可一键切换、监控用量。 ![CC Switch 预设供应商](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/cc-switch/Clipboard_Screenshot_1787654634.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=a16c8a809e6783b4c78ecd90de41ebd3) ## 获取 PPIO 的 API key 配置 CC Switch 时,只有 API Key 需要手动输入。先注册 PPIO 账号并登录,打开 [API 密钥管理页面](https://ppio.com/settings/key-management) 点击创建,输入自定义密钥名称、选择生命周期时长,即可创建成功。 注册地址:[https://ppio.com/](https://ppio.com/) ![创建 API 密钥](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/cc-switch/Clipboard_Screenshot_1787642707.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=014b95d9f046e8fd1910941bc85f9261) ![API 密钥创建成功](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/cc-switch/Clipboard_Screenshot_1787642764.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=90d6d4460f46705aedbc02f24717018c) ## 安装 CC Switch 下面以 macOS 为例,更多安装方式参见:[CC Switch GitHub](https://github.com/farion1231/cc-switch) ### 方式一:通过 Homebrew 安装(推荐) ```bash theme={null} brew install --cask cc-switch ``` 后续更新: ```bash theme={null} brew upgrade --cask cc-switch ``` ### 方式二:手动下载 手动安装请下载 `CC-Switch-v{版本号}-macOS.dmg`。CC Switch macOS 版本已通过 Apple 代码签名和公证,可直接安装打开。 ## 添加 PPIO 作为模型服务商 **1. 添加新模型供应商** 安装完成后打开主页面,以 Claude Code 为例,点击右侧 + 号添加新模型供应商。 ![添加模型供应商](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/cc-switch/image-5.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=49c29d21f721c361a4a1cc7a2c3a0cf6) **2. 选择 PPIO 预设** 在预设供应商中选择 PPIO。 ![选择 PPIO 预设](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/cc-switch/image.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=114be5ce370fb785948d5cfa73576b26) **3. 填入 API Key** 将上一步创建的 API Key 填入即可,其他选项可以采用默认配置。 ![填入 API Key](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/cc-switch/image-3.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=a0116f6946b33b7e1bf05b281040795a) **4. 设置默认模型** PPIO 提供的默认模型为 `deepseek/deepseek-v4-flash-0731`。如需使用其他模型,将模型名称填入默认兜底模型替换 `deepseek/deepseek-v4-flash-0731` 即可。PPIO 的模型名称可在模型广场查询。 ![设置默认模型](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/cc-switch/image-2.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=866c8a977a9b5cef10dff67f36c428de) **5. 保存并启用 PPIO** 添加完成后选择保存,PPIO 的卡片会出现在主页面中,点击启用。 ![启用 PPIO](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/cc-switch/Clipboard_Screenshot_1787646632.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=94ee55354c26e9008b2ef76705e81be4) **6. 在 Claude Code 中验证** 打开 Claude Code 验证配置,模型名称已切换为 `deepseek/deepseek-v4-flash-0731`。输入问题测试,成功回复即代表配置成功。 ![Claude Code 验证成功](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/cc-switch/image-1.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=0843e533274e23bf5bced894ab50637c) 除 Claude Code 外,PPIO 同时支持 Hermes Agent 等产品。在顶部应用切换器中切换到 Hermes,点击 + 按钮,在预设中选择 PPIO(已自动处理 API 格式差异),粘贴同一个 API Key,即可在 Hermes 中一键切换 PPIO 模型。 ![Hermes 接入 PPIO](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/cc-switch/image-4.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=2a3d366e7a185be08e42694a2e8461f1) 一次配置,即可省去手动修改 JSON 的步骤。CC Switch 让切换更简单,PPIO 帮你降低成本。 如果你已经在用其他组合(如 PPIO + Codex、Gemini CLI),欢迎分享。 PPIO 是独立 Agentic Cloud 服务商,2026 年 7 月的日均 Token 调用量达 2.2 万亿,提供可靠、可扩展、高性价比的模型服务。 # Chatbox 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/chatbox-use 查阅 Chatbox 接入 PPIO LLM API 的配置流程,了解模型服务连接方式,为在聊天客户端中选择和使用模型提供参考。 ## 教程概述 **Chatbox** 是一款开源免费的多平台智能对话工具,支持 Windows、macOS、Linux、Android、iOS 及网页端,可接入主流 LLM 模型。支持同时管理多个 API 密钥与服务商,内置 Prompt 工作台用于调试对话,数据存储在本地,支持导出聊天记录。 PPIO 算力云优化了 API 服务通道,即时响应,稳定性 99.9%,直连模型无需等待。配合 Chatbox 客户端,2 步即可在本地调用 DeepSeek。 下方教程含完整/配置指引,1 分钟上车享受「PPIO 高速通道 + Chatbox 便捷管理」的黄金组合。 ## 进入 Chatbox,添加 PPIO 作为模型供应商 进入 Chatbox 官网:[ [https://chatboxai.app/zh](https://chatboxai.app/zh) ](https://chatboxai.app/zh),下载或直接使用网页版,点击【Use My Own API Key/Local Model】—【Add Custom Provider】。 ![Chatbox 接入 PPIO LLM API 教程](https://static.ppinfra.com/docs/image/llm/chatbox-01.jpg) ## 进行模型设置 **1. 修改自定义名称** 修改自定义名称,例如:`PPIO-deepseek/deepseek-v4-pro`。 **2. 填写 API Host 与 Path** 输入 API Host:`https://api.ppio.com/openai`;API Path:`/chat/completions`,与图片一致即可。 ![Chatbox 接入 PPIO LLM API 教程](https://static.ppinfra.com/docs/image/llm/chatbox-02.jpeg) **3. 开启网络兼容** 打开「网络兼容」选项。 **4. 创建并保存 API 密钥** 前往 [ PPIO 派欧云 API 密钥管理 ](https://ppio.com/settings/key-management),创建 API 密钥,生成密钥后(务必先复制)返回粘贴。 点击【用户头像】—【API 密钥管理】进入控制台。 ![Chatbox 接入 PPIO LLM API 教程](https://static.ppinfra.com/docs/image/llm/ppinfra-create-api-key-01.png) 点击【+ 创建】按钮创建新的 API 密钥。自定义密钥名称,**生成的密钥仅在生成时呈现,务必复制并保存到文档中,以免影响后续使用**。 ![Chatbox 接入 PPIO LLM API 教程](https://static.ppinfra.com/docs/image/llm/ppinfra-create-api-key-02.png) **5. 填写模型名称并保存** 输入模型名称:前往 [ PPIO 模型列表 ](https://ppio.com/model-api/pricing) 复制模型名称,例如:`deepseek/deepseek-v4-pro` 或 `deepseek/deepseek-v4.1-flash`;最后点击 SAVE。 ## 模型对话使用设置 点击【对话设置】→【Speific model settings】,选择刚刚设置好的模型名称,最后点击【SAVE】,即可使用。 ![Chatbox 接入 PPIO LLM API 教程](https://static.ppinfra.com/docs/image/llm/chatbox-setting-01.png) ![Chatbox 接入 PPIO LLM API 教程](https://static.ppinfra.com/docs/image/llm/chatbox-setting-02.png) # ChatHub 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/chathub-use 了解 ChatHub 接入 PPIO LLM API 的设置方式,查阅模型连接与使用流程,为在工具中调用语言模型服务提供参考。 ## 教程概述 **ChatHub** 是一款聊天机器人聚合客户端,可在同一应用内切换 ChatGPT、Google Gemini、Claude 3、Bing Chat、Perplexity 等模型,并支持接入更多开源机器人。 ChatHub 支持通过 PPIO 派欧云 API 密钥接入 DeepSeek 模型。此外还提供 Prompt Library、快捷键唤起、Markdown 及代码高亮、Dark mode 和联网搜索等功能。 下方教程包含完整接入方案(含密钥配置),约 3 分钟完成「ChatHub + PPIO API」配置。 ## 配置前置条件 **1. 获取 API 密钥** 登录派欧云控制台 [API 密钥管理](https://ppio.com/settings/key-management) 页面,点击创建按钮。 ![](https://static.ppinfra.com/docs/image/llm/Rpogb7t2uoHoDixIRS2cXoVbnhf.png) **2. 生成并保存 API 密钥** > [!WARNING] > > 密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建一个新的密钥。 ![](https://static.ppinfra.com/docs/image/llm/MkfHbTSBJo4GmfxEjIIc0S1fnFc.png) ![](https://static.ppinfra.com/docs/image/llm/G5WzbAPcloNBh7xXiSqcP6l5nEd.png) **3. 获取需要使用的模型 ID** DeepSeek 系列: * DeepSeek V4 Pro:deepseek/deepseek-v4-pro * DeepSeek V4.1 Flash:deepseek/deepseek-v4.1-flash 其他模型 ID 及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ## 软件配置和使用 **1. 下载 ChatHub 插件** 在 Chrome 应用商店下载 [ChatHub 插件](https://chromewebstore.google.com/detail/chathub-gpt-4-gemini-clau/iaakpnchhognanibcahlpcplchdfmgma) ![](https://static.ppinfra.com/docs/image/llm/Lg3KbXcSmoYtboxWBDHcZWngn0d.png) **2. 添加自定义聊天机器人** 点击设置,下拉到自定义聊天机器人,点击 "Add",添加自定义聊天机器人。 ![](https://static.ppinfra.com/docs/image/llm/UHZ2bsPeio71kaxXDpqc19ZdnDh.png) **3. 自定义聊天机器人的配置设置** * **Chatbot Name**:自定义聊天机器人的名称,比如 PPIO * **API Host:** `https://api.ppio.com/openai` * **API Key**:填写 API 密钥 * **Model**:设置为 `deepseek/deepseek-v4-pro` 或者 `deepseek/deepseek-v4.1-flash` 点击 "Confirm" 保存设置 ![](https://static.ppinfra.com/docs/image/llm/MBoIbvuyBoDGf0xVsVPcG52VnTd.png) **4. 开始对话** 在侧边栏的自定义模型列表中,选择「PPIO」即可启动对话。 ![](https://static.ppinfra.com/docs/image/llm/NMIcb9VUhopdvExpF0scGyHbnKg.png) # ChatWise 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/chatwise-use 按照 ChatWise 接入指南配置 PPIO LLM API,了解服务连接与模型使用方法,为在客户端开展 AI 对话提供参考。 市面上的 AI 聊天工具不少,但常见的问题是支持模型有限、响应慢、数据上传云端有隐私风险。 ChatWise 定位为「第二快的 AI 聊天机器人」,支持包括 DeepSeek、Qwen 在内的任意 LLM 模型,并提供本地数据存储、多模态交互和联网搜索。 配合 PPIO 派欧云高性能 API 服务,ChatWise 可满足多场景模型调用需求。以下为完整配置步骤。 ## **PPIO × ChatWise配置教程** ### **获取 API key** **1. 获取 API 密钥** 注册并登录派欧云。 打开 API 密钥管理页面,点击创建按钮,输入自定义密钥名称,生成 API 密钥。 ![c.PNG](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/chatwise/c.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=c11077e6b6135b603b30d8ea519999fd) **2. 生成并保存 API 密钥** **注意**:密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并新建一个密钥。 ![b.PNG](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/chatwise/b.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=a621dc9e749372ccb3171f197a318e48) **3. 获取【模型 ID】** **需要使用的模型 ID** * deepseek/deepseek-v4-pro * deepseek/deepseek-v4.1-flash * qwen/qwen3.8-max * zai-org/glm-5.3 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ### **下载并配置ChatWise** **1. 下载 ChatWise** 前往 ChatWise 官网下载应用。 下载地址:[https://chatwise.app/](https://chatwise.app/) ![a.PNG](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/chatwise/a.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=78a4bc8f3b2cef891c9ea10ce1d07948) **2. 添加 OpenAI Compatible 提供商** 打开应用,点击左下角 设置 - 模型提供商,点击左下角添加,选择「OpenAI Compatible」添加模型提供商。 ![ced6d591-3342-4a8f-96d9-c3c3411c5293.png](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/chatwise/ced6d591-3342-4a8f-96d9-c3c3411c5293.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=71eadeeb4b5d8ff0164765c078ae17c9) **3. 填写提供商配置** ![1fd8a62c-4218-4be8-91b8-a9878cc99235.png](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/chatwise/1fd8a62c-4218-4be8-91b8-a9878cc99235.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=673ede8f63bdde13d1585c7f1768454e) 按以下信息配置所需模型: * Provider name:PPIO 派欧云 * API Base URL:固定为 `https://api.ppio.com/openai` * API Key:PPIO 派欧云官网保存的密钥 * Models:添加所需模型,左边为任意自定义昵称,右边为 PPIO 派欧云官网模型广场复制的模型名称 ![dc0d42cc-5735-4d32-a2f2-4afc7fbbc9cf.png](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/chatwise/dc0d42cc-5735-4d32-a2f2-4afc7fbbc9cf.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=d26b9ee34db180205d1c47184d700ab2) **4. 选择已配置的模型** 回到主页,选择已经配置好的所需模型。 ![4ef331c0-cf92-4897-8aff-b5a70598cd59.png](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/chatwise/4ef331c0-cf92-4897-8aff-b5a70598cd59.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=b33d82255fd15c6d9b53b03fb54d5dd6) ChatWise 支持多模态聊天,可上传附件进行对话,生成更精准的内容。 ![e2d38b8b-e479-46e1-a213-1f9c32d931e1.png](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/chatwise/e2d38b8b-e479-46e1-a213-1f9c32d931e1.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=23d305155a2cbdaac73d5deed35c81e6) ChatWise 所有数据均存储在本地设备,不上传云端,用户可按需导入、导出和清除数据。 ![e8c96b53-719c-4167-bac9-7a305ce34e72.png](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/chatwise/e8c96b53-719c-4167-bac9-7a305ce34e72.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=1b604ca64179c29f29c4ee4ac7b132fa) # 沉浸式导读接入 PPIO LLM API Source: https://ppio.com/docs/third-party/chenjinshidaodu-use 查阅沉浸式导读接入 PPIO LLM API 的指南,了解阅读工具的模型服务配置,为在导读流程中使用 AI 能力提供参考。 ## 教程概述 **沉浸式导读**浏览器插件识别网页核心内容,支持切换阅读模式与自适应光线调节,减少信息干扰。 PPIO 的 DeepSeek API 承担「隐形架构师」的角色。阅读网页长文时,引擎完成网页结构解构;多用户同时启用纯净模式时,动态资源调度系统在边缘节点间平衡负载。 下方教程包含完整接入方案(含密钥配置),3 分钟完成「沉浸式导读 + PPIO 高性能 API」接入。 ## 配置前置条件 **1. 获取 API 接口地址** 固定为:`https://api.ppio.com/openai/v1/chat/completions`。 **2. 获取 API 密钥** 登录派欧云控制台 [API 密钥管理](https://ppio.com/settings/key-management) 页面,点击创建按钮。 ![](https://static.ppinfra.com/docs/image/llm/OCbpb6g3DoloiRxMTNncNlGLn5d.png) **3. 生成并保存 API 密钥** > [!WARNING] > > 密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可以在控制台删除并创建一个新的密钥。 ![](https://static.ppinfra.com/docs/image/llm/Rr3gb81RxokPoHxr39Dc660Hnjd.png) ![](https://static.ppinfra.com/docs/image/llm/O2Wpb8lz0oRlDCxdQz6cgGI5nVe.png) **4. 获取需要使用的模型 ID** deepseek 系列: DeepSeek V4 Pro:deepseek/deepseek-v4-pro DeepSeek V4.1 Flash:deepseek/deepseek-v4.1-flash 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ## 前往 Google 应用商店下载插件 ![](https://static.ppinfra.com/docs/image/llm/O2bbbTADnoCL7MxmT2qcFwgSnmd.png) ## 配置插件 **1. 点击 Google 浏览器右上角,再点击安装的插件** ![](https://static.ppinfra.com/docs/image/llm/T9KJbNcIGo0CYOx8lMBcoKbLnOc.png) **2. 点击【设置】** ![](https://static.ppinfra.com/docs/image/llm/LAOKb5AwQogKhsxzbQwci5Opn0F.png) **3. 填写插件配置** 在【接口地址】填写「获取 API 接口地址」步骤中的地址,如图;在【密钥】填入「生成并保存 API 密钥」步骤中保存的 API key;在【模型】填入「获取需要使用的模型 ID」步骤中的模型名称,与图片一致即可。最后点击【测试 API 链接】,通过后即可正常使用。 ![](https://static.ppinfra.com/docs/image/llm/BY7qb6UvvoOFhbxLAfycRoG2nqc.png) # Cherry Studio 接入 PPIO Embedding API Source: https://ppio.com/docs/third-party/cherry-studio-embedding 了解 Cherry Studio 接入 PPIO Embedding API 的配置方式,查阅嵌入模型与向量服务相关说明,为工具中的向量处理任务提供参考。 Cherry Studio 是一款集多模型对话、知识库管理、AI 绘画、翻译等功能于一体的 AI 助手平台。其高度自定义的设计、扩展能力和用户体验,适合专业用户和 AI 爱好者使用。零基础用户和开发者都能在 Cherry Studio 中找到适合自己的 AI 功能。 PPIO 算力云提供 Embedding 模型 API 服务通道,即时响应,稳定性 99.9%,可直接调用顶尖模型。 搭配 Cherry Studio 客户端的知识库功能,3 步即可在本地环境调用 baai/bge-m3,搭建专属知识库,以低成本实现知识库的自动化管理。 下方教程含完整接入方案(含密钥配置),3 分钟完成「PPIO 高性能 API + Cherry Studio 知识库搭建」。 ## 进入 Cherry Studio,添加”PPIO"作为模型供应商 首先前往官网下载 Cherry Studio:[ https://www.cherry-ai.com/download ](https://www.cherry-ai.com/download)(如果无法访问,可打开下面的百度云链接下载所需版本:[ https://pan.baidu.com/s/1EgMxS-pdb4wq1zMdxjHNpw?pwd = mcy2 ](https://pan.baidu.com/s/1EgMxS-pdb4wq1zMdxjHNpw?pwd=mcy2)) **1. 添加 PPIO 供应商** 先点击左下角设置,自定义提供商名称为:PPIO,点击「确定」 ![](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/cherry-studio-embedding/1.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=c236ed45c0b94ee0f0173c1e307d222e) **2. 创建 API 密钥** 前往 [PPIO 派欧云 API 密钥管理 ](https://ppio.com/settings/key-management),点击【用户头像】—【API 密钥管理】进入控制台 ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cherry-studio-embedding/2.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=082ed0193a027714210da0fffa420989) 点击【+ 创建】按钮创建新的 API 密钥。自定义一个密钥名称,**生成的密钥仅在生成时呈现,务必复制并保存到文档中,以免影响后续使用** ![](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/cherry-studio-embedding/156.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=3c08a0579cf2bcc3d71d377ee3bb741a) **3. 填入密钥和地址** 在 Cherry Studio 填入密钥和地址 直接复制粘贴:`https://api.ppio.com/openai` ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cherry-studio-embedding/4.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=6735467779c896466637c205873fe131) **4. 填写模型 ID 并添加模型** 将官网模型名称:baai/bge-m3 直接复制到【模型 ID】,下方自动填充 ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cherry-studio-embedding/55.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=7357a1aa1c9e643d18048db9bdc62e5e) 如需更换其他模型,前往 [PPIO 模型列表 ](https://ppio.com/model-api/pricing)复制模型名称。例如:baai/bge-m3;最后点击【添加模型】 ## 模型使用配置 ### 创建知识库 **1. 进入知识库管理** 在 Cherry Studio 左侧工具栏,点击知识库图标,即可进入管理页面;点击添加,开始创建知识库; ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cherry-studio-embedding/6.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=2c9f4068138e6511d307e93723e71278) **2. 命名并添加嵌入模型** 输入知识库的名称并添加嵌入模型,以 bge-m3 为例,即可完成创建。 ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cherry-studio-embedding/7.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=b74f4d220d647af3220c6b09188d9a48) ### 添加文件并向量化 **1. 添加文件** 点击添加文件的按钮,打开文件选择; ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cherry-studio-embedding/8.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=c3e5d161af2029a14763a9d410d8f958) **2. 选择文件并打开** 选择支持的文件格式,如 pdf、docx、pptx、xlsx、txt、md、mdx 等,并打开; ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cherry-studio-embedding/9.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=11763d118b71621051e7fa9ea27f474e) **3. 等待向量化完成** 系统会自动进行向量化处理,当显示完成时(绿色 ✓),代表向量化已完成。 ![](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/cherry-studio-embedding/10.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=96b47a2c8e461aa665a8dd079c641229) ### 搜索知识库 文件等资料向量化完成后,可进行查询,步骤如下: **1. 搜索知识库** 点击页面下方的搜索知识库按钮; ![](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/cherry-studio-embedding/11.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=df3ba4be18ab46ced945444d779b8100) **2. 输入查询内容** 输入查询的内容; ![](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/cherry-studio-embedding/12.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=140d874274005a134ff710875319897a) **3. 查看搜索结果与匹配分数** 呈现搜索结果,并显示该条结果的匹配分数。 ![](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/cherry-studio-embedding/11.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=df3ba4be18ab46ced945444d779b8100) ![](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/cherry-studio-embedding/12.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=140d874274005a134ff710875319897a) ### 对话中引用知识库生成回复 **1. 引用知识库** 创建一个新的话题,在对话工具栏中,点击知识库,会展开已经创建的知识库列表,选择需要引用的知识库; ![](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/cherry-studio-embedding/13.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=d645906a81a0fcfd7dc9c123add6628e) **2. 输入并发送问题** 输入并发送问题,模型即返回通过检索结果生成的答案; **3. 查看引用来源** 同时,引用的数据来源会附在答案下方,可快捷查看源文件。 ![](https://mintcdn.com/ppinfra/UGbFBbGGBJeRybcz/third-party/images/cherry-studio-embedding/14.png?fit=max\&auto=format\&n=UGbFBbGGBJeRybcz\&q=85\&s=fbbd0075922fc512efed008ddfc71724) ## PPIO×Cherry Studio 知识库使用详情教程 如需了解更多 PPIO 与 Cherry Studio 知识库应用教程,可访问 Cherry Studio 官方平台帮助文档,了解 PPIO 嵌入模型 API 的应用场景。点击下方链接直达教程文档→[https://docs.cherry-ai.com/knowledge-base/knowledge-base](https://docs.cherry-ai.com/knowledge-base/knowledge-base) 【教程来源:Cherry Studio】 # Cherry Studio 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/cherry-studio-use 按照 Cherry Studio 教程配置 PPIO LLM API,了解语言模型的连接与使用方式,为客户端中的对话和 AI 工作流提供参考。 ## 教程概述 Cherry Studio 是一款多模型桌面客户端,支持 Windows、Linux、macOS 安装包。它聚合主流 LLM 模型,提供多场景辅助,支持智能会话管理、开源定制和多主题界面。 Cherry Studio 已适配 PPIO 高性能 API 通道,支持 DeepSeek 高速响应,服务可用性 99.9%。 下方教程包含完整接入方案(含密钥配置),3 分钟完成 Cherry Studio 接入 PPIO API。 ## 进入 CherryStudio,添加 「PPIO」 作为模型提供商 **1. 下载 Cherry Studio** 首先前往官网下载 Cherry Studio:\[ [https://www.cherry-ai.com/download](https://www.cherry-ai.com/download) ]\([https://www.cherry-ai.com/download)(如果进不去,可以打开下面的百度云链接下载所需版本:\[](https://www.cherry-ai.com/download\)(如果进不去,可以打开下面的百度云链接下载所需版本:\[) [https://pan.baidu.com/s/1EgMxS-pdb4wq1zMdxjHNpw?pwd](https://pan.baidu.com/s/1EgMxS-pdb4wq1zMdxjHNpw?pwd) = mcy2 ]\([https://pan.baidu.com/s/1EgMxS-pdb4wq1zMdxjHNpw?pwd=mcy2))](https://pan.baidu.com/s/1EgMxS-pdb4wq1zMdxjHNpw?pwd=mcy2\))) **2. 添加自定义提供商** 先点击左下角设置,自定义提供商名称为:`PPIO`,点击「确定」。 ![Cherry Studio 接入 PPIO LLM API 教程](https://static.ppinfra.com/docs/image/llm/cherry-studio-setting.png) **3. 进入 API 密钥管理并创建密钥** 前往 [ PPIO 派欧云 API 密钥管理 ](https://ppio.com/settings/key-management),点击【用户头像】—【API 密钥管理】进入控制台。 ![Cherry Studio 接入 PPIO LLM API 教程](https://static.ppinfra.com/docs/image/llm/ppinfra-create-api-key-01.png) 点击【+ 创建】按钮创建新的 API 密钥。自定义密钥名称,**生成的密钥仅在生成时呈现,务必复制并保存,以免影响后续使用** ![Cherry Studio 接入 PPIO LLM API 教程](https://static.ppinfra.com/docs/image/llm/ppinfra-create-api-key-02.png) **4. 填入 API 密钥并检查** 在 Cherry Studio 填入密钥,点击设置,选择【PPIO 派欧云】,输入官网生成的 API 密钥,最后点击【检查】。 ![](https://static.ppinfra.com/docs/image/llm/cherry-studio-3601.PNG) 点击【检查】,显示连接成功后即可正常使用。 ![](https://static.ppinfra.com/docs/image/llm/cherry-studio-3603.png) **5. 选择模型** 选择模型:以 deepseek/deepseek-v4-pro 为例,如需更换其他模型,可直接更换。 ![](https://static.ppinfra.com/docs/image/llm/cherry-studio-3602.PNG) ## 模型使用配置 最后点击【@】,选择 PPIO 供应商下刚刚添加的 DeepSeek V4 Pro 模型,即可开始聊天。 ![Cherry Studio 接入 PPIO LLM API 教程](https://static.ppinfra.com/docs/image/llm/cherry-studio-ppio-config-02.png) 【部分素材来源:[ 陈恩 ](https://www.kdocs.cn/l/ctGiF5K6PQoO)】 ## PPIO×Cherry Studio 视频使用教程 若您更倾向直观学习,我们在 B 站准备了视频教程,讲解「PPIO API+Cherry Studio」的配置方法,点击下方链接直达视频 → [《【还在为 DeepSeek 疯狂转圈抓狂?】派欧云 + DeepSeek 满血版 =?不再拥堵,即刻起飞》](https://www.bilibili.com/video/BV1BZNmeTEwg/) 【视频素材来源:sola】 # Claude Code 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/claude-code 查阅 Claude Code 接入 PPIO LLM API 的说明,了解模型连接与相关配置,为在 AI 编程工作流中使用模型服务提供参考。 Claude Code 是 Anthropic 推出的 AI 辅助编程工具,提供终端界面,开发者可在终端将复杂编程任务委托给 Claude Code 完成。 PPIO 派欧云提供 [Anthropic SDK 兼容的 LLM API 服务](/docs/model/llm-anthropic-compatibility),可在 Claude Code 中使用 PPIO 派欧云的大语言模型完成任务。接入步骤见下文。 ## 快速开始 **1. 安装 Claude Code** > [!WARNING] > > 安装 Claude Code 前,请确保本地环境已安装 [Node.js 18 或更高版本](https://nodejs.org/en/download/)。 在终端执行以下命令安装 Claude Code: ```bash Bash icon='terminal' theme={null} npm install -g @anthropic-ai/claude-code ``` **2. 开启一个终端会话** > [!TIP] > [!TIP] > > 请在 [这里](/docs/model/llm-anthropic-compatibility#支持的模型) 查看当前可在 Claude Code 中使用的模型列表。 打开终端,按如下方式设置环境变量: ```bash Bash icon='terminal' highlight={2} theme={null} # 设置 PPIO 派欧云兼容 Anthropic SDK 的 API 地址 export ANTHROPIC_BASE_URL="https://api.ppio.com/anthropic" export ANTHROPIC_AUTH_TOKEN="" # 设置 PPIO 派欧云支持的模型 export ANTHROPIC_MODEL="moonshotai/kimi-k3.1-pro" export ANTHROPIC_SMALL_FAST_MODEL="deepseek/deepseek-v4.1-flash" ``` 进入项目文件目录并启动 Claude Code,会看到如下提示: ```bash Bash icon='terminal' theme={null} cd claude . ``` ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/claude-code/init-2.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=4bfc7d8be5d3456ef6d03048a81d820b) **3. 从 0 到 1 构建一个小游戏** 输入任务和需求描述,按回车键开始任务。 ```bash Bash icon='terminal' theme={null} > 创建一个贪吃蛇网页游戏。仅使用 HTML、CSS 和 JavaScript,尽量创造一些新颖的内容,最终输出是单个 HTML 文件。 ``` ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/claude-code/first-prompt.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=8df99fbc6353b8718fd275747fb5a0bd) Claude Code 会根据需求规划多步任务,并自动执行。 ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/claude-code/task-plan.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=d0e7e0c1f8ff4fc36cb126f74c8b1ea3) 每完成一个任务,Claude Code 会勾选已完成的任务,并规划、说明下一个任务的细节。 ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/claude-code/task-plan-checklist.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=baea8a0605645f51c3853811ce202eda) **4. 任务执行结果与预览** 所有任务执行完成后,终端会显示如下提示: ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/claude-code/task-result.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=f46874c21e2e7c489f7b113f44d4ecf9) 在浏览器中打开 `quantum-snake.html` 文件,查看游戏效果。 ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/claude-code/task-result-preview.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=2ccbdfddee3342c40ccf5d36c4c5aab3) **5. 修复一个 bug** 生成结果存在一个 bug:底部的控制说明文本挡住了按钮。继续输入需求,让 Claude Code 修复该 bug。 ```bash Bash icon='terminal' theme={null} > 底部的控制说明把按钮挡住了,请修复这个bug ``` ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/claude-code/task-result-fixed.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=5b7245e471a65cb148a6f2e9d35f020a) 修复完成后的效果: ![](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/claude-code/task-result-fixed-preview.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=77a29f649c4c962ae10ba4bd48f2ddbf) ## 尝试更多的工作流 以下按不同工作流提供 prompt 模板示例,供参考: * 代码重构 ```bash Bash icon='terminal' theme={null} > 请使用 Next.js 框架重构当前项目 ``` * 编写单元测试 ```bash Bash icon='terminal' theme={null} > 请为项目中的价格计算逻辑编写单元测试 ``` * 更新文档 ```bash Bash icon='terminal' theme={null} > 请更新 README 中关于安装依赖的说明部分 ``` * 代码 Review ```bash Bash icon='terminal' theme={null} > 请 Review 当前项目中的代码,并给出优化建议 ``` ## 常用命令 | 命令 | 说明 | 示例 | | :- | :- | :- | | `claude` | 开启交互模式 | `claude` | | `claude "任务描述信息"` | 跑一个一次性任务 | `claude "底部的控制说明把按钮挡住了,请修复这个bug"` | | `claude -p "查询内容"` | 执行一次查询任务,然后退出 | `claude -p "请介绍下游戏中相关的控制逻辑是怎么实现的"` | | `claude -c` | 继续最近一次会话任务 | `claude -c` | | `claude -r` | 恢复上一次会话任务 | `claude -r` | | `claude commit` | 创建一个 Git commit | `claude commit` | | `/clear` | 清空历史对话信息 | `> /clear` | | `/help` | 查看当前可用命令 | `> /help` | | `exit` or Ctrl+C | 退出当前会话 | `> exit` | # Cline 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/cline-use 按照 Cline 集成指南配置 PPIO LLM API,了解模型服务接入方式,为在编程工具中使用语言模型开展代码任务提供参考。 还在为 Cursor 的价格和外网限制而头疼吗?还在为 AI 编程工具的选择而纠结吗? Cline 是一款免费、简单、强大的 VS Code 插件,支持调用 DeepSeek 模型。 Cline 是专为 VS Code 设计的插件,支持 ChatGPT、Claude、DeepSeek 等主流大模型 API。它的优势在于: * **免费**:无需付费即可使用。 * **简单**:无需翻墙,国内开发者可直接上手。 * **强大**:集成 VS Code,减少繁琐操作。 PPIO 派欧云优化了 API 通道,提供低延迟和高稳定性,可搭配 Cline 调用 DeepSeek 模型。 完整教程已备好,3 分钟快速上手,解锁「PPIO+Cline」的组合 ## Cline×PPIO:调用DeepSeek模型详细教程 ### 安装 Cline 插件 首先,在 VS Code 中安装 Cline 插件。打开 VS Code,进入插件库,搜索「Cline」,然后点击安装。安装完成后,Cline 插件图标将出现在 VS Code 的侧边栏中。 ![1.PNG](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cline/1.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=ff417b1905c2968f9a66254ec9f54f7a) ### 注册 PPIO 派欧云账号并生成 API Key **1. 注册 PPIO 派欧云账号** 在调用 DeepSeek 模型之前,你需要在[PPIO派欧云官网](https://ppio.com/)注册一个账号。 **2. 进入 API 密钥管理控制台** 前往[PPIO 派欧云API密钥管理](https://ppio.com/settings/key-management),点击【用户头像】—【API密钥管理】进入控制台 ![2.PNG](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cline/2.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=4aa8c16098058740c6c0b6981e60456c) **3. 创建并保存 API 密钥** 点击【+ 创建】按钮创建新的 API 密钥。自定义一个密钥名称,生成的**密钥仅在生成时呈现,务必复制并保存到文档中,以免影响后续使用** ![3.PNG](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cline/3.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=5de443d88af6595cc367e11545fa1082) **4. 复制模型名称** 输入模型名称:前往[PPIO 模型列表](https://ppio.com/model-api/pricing)复制模型名称,例如:`deepseek/deepseek-v4-pro` 或 `deepseek/deepseek-v4.1-flash`;最后点击 SAVE ### 配置 Cline 插件 安装好 Cline 插件后,点击右侧的 Cline 插件图标,选择「OpenAI Compatible」选项。在配置页面中,填写以下信息: * Base URL: `https://api.ppio.com/openai` * API Key 粘贴 PPIO 派欧云的密钥 * Model ID:从[PPIO 模型列表页](https://ppio.com/model-api/product/llm-api)复制你想使用的模型 ID(例如:`deepseek/deepseek-v4-pro`) ![4.png](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cline/4.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=fea21109fe35de2ccdddd911b34a27e4) ### 开始对话 完成配置后,就可以在 Cline 的对话框中与 DeepSeek 模型对话。输入问题或指令,模型将即时响应。 ![5.png](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cline/5.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=359e8dceed54ac3c110092dc1e8041ce) # Codex 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/codex 了解 Codex 接入 PPIO LLM API 的配置流程,查阅模型服务连接与使用说明,为 AI 编程任务组织模型调用提供参考。 Codex 是运行在终端中的 AI 编程工具。通过自定义 OpenAI-compatible endpoint,可将 Codex 连接到 PPIO 派欧云的大语言模型 API,用于代码理解、生成、重构和调试。 > [!WARNING] > > Codex 当前仅支持 Responses API。请按本文配置 `wire_api = "responses"`,不要切换到 Chat Completions 模式。 ## 前置准备 开始前,请准备以下信息: * **API Key**:前往 [API 密钥管理](https://ppio.com/settings/key-management) 创建或复制 API Key。 * **Base URL**:`https://api.ppio.com/openai/v1` * **Model ID**:在模型广场或模型详情页复制模型 ID,例如 `deepseek/deepseek-v4.1-flash`。 > [!TIP] > > 请妥善保存 API Key。API Key 仅用于本地 Codex 配置,不要提交到 Git 仓库或公开文档。 ## 安装 Codex 安装 Codex 前,请确保本地已安装 [Node.js 18 或更高版本](https://nodejs.org/en/download/)。 如果使用 macOS 且已安装 Homebrew,可执行: ```bash theme={null} brew install node ``` 检查 Node.js 与 npm 版本: ```bash theme={null} node -v npm -v ``` 安装 Codex CLI: ```bash theme={null} npm install -g @openai/codex ``` 检查 Codex 版本: ```bash theme={null} codex --version ``` ## 配置 API Key 打开 shell 配置文件,例如 `~/.zshrc`: ```bash theme={null} nano ~/.zshrc ``` 写入环境变量: ```bash theme={null} export PPIO_API_KEY="" ``` 保存后刷新配置,并确认变量已生效: ```bash theme={null} source ~/.zshrc echo $PPIO_API_KEY ``` ## 配置 Codex 打开 Codex 配置文件: ```bash theme={null} mkdir -p ~/.codex nano ~/.codex/config.toml ``` 写入以下配置,将 `model` 替换为要使用的 PPIO 模型 ID: ```toml theme={null} model_provider = "ppio" model = "deepseek/deepseek-v4.1-flash" [model_providers] [model_providers.ppio] name = "PPIO" wire_api = "responses" requires_openai_auth = true base_url = "https://api.ppio.com/openai/v1" env_key = "PPIO_API_KEY" ``` ## 启动 Codex 进入项目目录,启动 Codex: ```bash theme={null} cd codex ``` 启动后,可输入编程任务,例如: ```text theme={null} 请帮我阅读这个项目,并总结主要模块职责。 ``` 如果 Codex 返回模型不存在或鉴权失败,请检查: * `PPIO_API_KEY` 是否已在当前终端会话中生效。 * `model` 是否与 PPIO 模型详情页中的 Model ID 完全一致。 * `base_url` 是否为 `https://api.ppio.com/openai/v1`。 # Cursor 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/cursor-use 查阅 Cursor 接入 PPIO LLM API 的指南,了解编辑器中的模型连接设置,为使用模型服务辅助代码开发提供参考。 最近,整个开发者社区都在热议 DeepSeek——这个在代码生成领域正面硬刚 GPT-4 的国产模型。但热度背后,不少尝鲜者却陷入尴尬:官方 API 在高并发时的响应波动,让紧急调试成了「抽卡游戏」;生成到一半突然限流的提示,更是直接打断深度编码的心流。 Cursor 支持自定义模型供应商。在设置中把 API 终端替换为 PPIO 提供的专用地址和密钥,即可获得企业级算力保障,实现 **DeepSeek 高速响应**与 **99.9% 服务可用性**。 下方教程包含完整接入方案(含密钥配置),3 分钟完成「Cursor + PPIO 高性能 API」接入 ## Cursor × PPIO API使用教程 前往 Cursor 官网下载:[https://www.cursor.com/](https://www.cursor.com/) ### 配置模型到Cursor **1. 添加自定义模型** ![1.PNG](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cursor/1.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=7b75b0eabecccd96a4afac776e17f285) 点击【设置】→【Add model】,修改模型名称,可复制图中模型(如需更换其他模型,需与 PPIO 官网名称一致)。 PS:注意取消勾选其他模型 **2. 前往 PPIO 官方生成 API 密钥** 前往[PPIO 派欧云API密钥管理](https://ppio.com/settings/key-management),点击【用户头像】—【API密钥管理】进入控制台 ![2.PNG](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cursor/2.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=a0f64c43475d233052f1156f7aa762e2) 点击【+ 创建】按钮创建新的 API 密钥。自定义密钥名称,生成的**密钥仅在生成时呈现,务必复制并保存到文档中,以免影响后续使用** ![3.PNG](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cursor/3.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=2e8db341bbd792f77fa7d80bc310bb87) **3. 填写 Base URL** 回到 Cursor,输入 URL:[https://api.ppio.com/openai,与图一致。](https://api.ppio.com/openai,与图一致。) **4. 保存并验证** 点击【SAVE】,点击【Verify】。 ### 在Cursor中使用对话 **1. 点击右上角【面板】调出聊天框** ![4.PNG](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/cursor/4.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=77f0694dc38a22ffbe6951eacc7fed92) **2. 开启对话** 点击【CHAT】或【COMPOSER】即可开启对话 # Deepchat 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/deepchat-use 了解 Deepchat 接入 PPIO LLM API 的配置方式,查阅客户端连接模型服务的流程,为对话与 AI 使用场景提供参考。 用 AI 处理文件时担心数据安全,可以自行接入一个桌面 AI 助手。 DeepChat 是可接入多个开源模型的桌面 AI 助手,支持本地化部署,模型随时调用,数据存储在本地。 PPIO 是一站式 AIGC 云服务平台,提供高性能大模型 API 服务,涵盖 DeepSeek、Qwen、GLM、Kimi 等系列模型,一行代码即可调用,并支持在 chatbox、AnythingLLM、Ragflow 等 20 多个主流第三方平台调用。 借助 PPIO 派欧云优化的高性能 API,可以搭建从文档解析到智能分析的完整工作流。以下为配置教程,1 分钟即可开启【PPIO+DeepChat】的组合。 ## PPIO × DeepChat 配置教程 ### 配置前置条件 **1. 获取 API 密钥** 注册并登录[派欧云](https://ppio.com/)。 打开 API 密钥管理页面,点击创建按钮,输入自定义密钥名称,生成 API 密钥。 ![图片1.png](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/deepchat/%E5%9B%BE%E7%89%871.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=2793ce9c2622d3172ca78b2e215d70fe) **2. 生成并保存 API 密钥** **注意**:密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可以在控制台上删除并创建一个新的密钥。 ![图片2.png](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/deepchat/%E5%9B%BE%E7%89%872.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=3fabd1cd09f4a02261b7ab1d3a3fb427) **3. 获取需要使用的模型 ID** * deepseek/deepseek-v4-pro * deepseek/deepseek-v4.1-flash * qwen/qwen3.8-max * zai-org/glm-5.3 其他模型 ID、最大上下文及价格可参考:模型列表 ### 软件配置及使用 **1. 下载并配置服务商** 进入 DeepChat 官网,下载并安装软件。打开软件,在【服务商设置】中,开启【派欧云】选项,并将此前复制的 API 密钥粘贴至 API Key 输入框。 ![图片2 - 副本.png](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/deepchat/%E5%9B%BE%E7%89%872-%E5%89%AF%E6%9C%AC.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=ca2f6ebcac81749b3309ab767cb6ca54) **2. 选择所需模型,即可开启畅聊** ![图片4.png](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/deepchat/%E5%9B%BE%E7%89%874.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=2fb8a17c6d9ee5e7d9009c1accba5923) # DeepSearcher 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/deepsearcher-use 按照 DeepSearcher 接入指南连接 PPIO LLM API,了解模型配置与使用流程,为检索研究相关应用组织语言模型调用提供参考。 OpenAI 的 Deep Research 与 X 平台主推的 Grok Deepsearch 具备较强的信息整合能力。但每月 200 美金的订阅成本、仅限单一模型、依赖社交数据,限制了部分应用场景,在专业领域难以满足部分开发者的要求。 专注于向量数据库的 **Zilliz** 在开发者社区给出了新的解法:7.1k stars 的 **GitHub 开源项目 DeepSearcher**。 * **0** 订阅成本:即刻部署,**0 订阅成本**使用 * 可**多模型**切换:自由切换 DeepSeek/Qwen 等大模型 * **本地**知识导入:融合企业文档/CAD 图纸/代码库等非结构化数据,隐私保护更佳 **PPIO 派欧云**是国内最早上线 DeepSeek 全模型 API 的供应商之一,为 DeepSearcher 提供支持。PPIO 派欧云是一站式 AIGC 云服务平台,为 AI 开发者和企业提供低成本、稳定可靠、接入简单的大模型 API 与 GPU 算力服务。API 服务覆盖最新的 DeepSeek、Qwen 等系列模型,低价、稳定、快速,一行代码即可调用,还支持在 chatbox、AnythingLLM、Ragflow 等 20 多个主流第三方平台使用。 以下教程从环境配置到接入 PPIO,帮助你在 10 分钟内搭建"开源引擎+自选大模型+私有知识库"的三重架构。 ## PPIO x DeepSearcher 图文使用教程 ### 获取 PPIO 配置信息 **1. 获取 API Base URL** 固定为:`https://api.ppio.com/openai` **2. 获取 API Key** 登录派欧云控制台[API密钥管理](https://ppio.com/settings/key-management)页面,点击创建按钮。 ![image.png](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/deepsearcher/image.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=f47ca77c54987058206581a6e19a391c) **3. 生成并保存 API 密钥** **注意**:密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可以在控制台上删除并创建一个新的密钥。 ![image(1).png](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/deepsearcher/image\(1\).png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=28104191ae7546c7b005e595b64cb644) ![image(2).png](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/deepsearcher/image\(2\).png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=f2fc35106cbe942ce532c1edcadb3f71) **4. 获取需要使用的模型 ID** 推荐使用: * deepseek/deepseek-v4-pro * deepseek/deepseek-v4.1-flash * qwen/qwen3.8-max * zai-org/glm-5.3 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ### 安装 DeepSearcher 在 PPIO 官网准备好信息后,安装指南参考:[https://github.com/zilliztech/deep-searcher](https://github.com/zilliztech/deep-searcher) **1. 克隆仓库** ``` git clone https://github.com/zilliztech/deep-searcher.git cd deep-searcher ``` **2. 创建一个虚拟环境并激活它** ``` #MAKE SURE the python version is greater than or equal to 3.10 python3 -m venv .venv source .venv/bin/activate ``` **3. 安装依赖** ``` pip install -e . ``` ### 修改示例代码以接入 PPIO 模型 示例代码位于 `examples/basic_example.py`,可用其运行 DeepSearcher。 **1. 配置 PPIO API Key** 将您刚刚获取的 API Key 设置到本地环境变量 `PPIO_API_KEY` 中。 ```bash theme={null} export PPIO_API_KEY="您的 PPIO API Key" ``` **2. 配置 PPIO 模型** 在示例代码的 `config = Configuration()` 这一行后添加代码,设置 PPIO 的 LLM 与 Embedding 模型: ```python theme={null} config = Configuration() config.set_provider_config("llm", "PPIO", {"model": "deepseek/deepseek-v4-pro"}) config.set_provider_config("embedding", "PPIOEmbedding", {"model": "baai/bge-m3"}) init_config(config=config) ``` **3. 配置检索文件路径与 prompt** 从指定的本地路径加载文件,并将其内容存储到集合中。修改调用 `load_from_local_files` 处的代码。 您可以使用项目提供的 `examples/data/WhatisMilvus.pdf` 文件,也可以使用您自己的文件。 如需执行时删除并重新创建该集合,可将 `force_new_collection` 设置为 `True` ```python theme={null} load_from_local_files( paths_or_directory=os.path.join(current_dir, "data/WhatisMilvus.pdf"), collection_name="milvus_docs", collection_description="All Milvus Documents", force_new_collection=True, # If you want to drop origin collection and create a new collection every time,set force_new_collection to True ) question="Write a report comparing Milvus with other vector databases." ``` **4. 运行示例代码** 在项目根目录下运行: ```bash theme={null} python examples/basic_example.py ``` ## 运行效果展示 以下两个场景展示 DeepSearcher 的效果。 ### 车企行业报告分析 我们为 DeepSearcher 提供了一份 .xlsx 格式的车企行业报告。 **Prompt:** ``` 请从财务和宏观经济角度,对 A 股新能源汽车行业以及行业内 TOP5 车企的发展进行分析。在财务分析部分,需涵盖基本的财务关键指标。在宏观经济分析部分,考虑宏观经济指标对行业的影响,对 A 股新能源汽车行业整体发展趋势进行总结,并基于财务和宏观经济分析,对 TOP5 新能源车企的未来发展潜力和竞争态势做出比较和预测,指出各车企的优势与挑战。请以专业、严谨的语言,结合具体数据进行分析阐述。 ``` **输出内容:** ``` 基于文档数据,A股新能源汽车行业及TOP5车企分析如下: 一、财务分析(以比亚迪、长安汽车为例): 1. 比亚迪2024Q3营收430.48亿元(同比-17.74%),净利润6.91亿元(同比-39.45%),显示成本端承压明显;但2025年股息分配方案达10派30.98元,现金流表现优于同业。 2. 长安汽车2023Q4营收744.71亿元(同比+0.09%),净利润14.11亿元(同比-12.48%),盈利能力弱于比亚迪,但2024Q2实现净利润6.63亿元(环比+44.22%),展现弹性恢复。 二、宏观经济影响: 1. 行业2024年营收普遍负增长(比亚迪-17.74%,长安-12.82%),反映补贴退坡与消费疲软双重压力。2024Q3行业净利润环比-92.85%,显示季度波动加剧。 2. 原材料价格高位震荡,2024年TOP5车企平均毛利率同比下降3-5个百分点,成本传导能力分化。 三、行业趋势与竞争格局: 1. 行业集中度提升:比亚迪2024年营收规模超长安汽车1.6倍,头部效应显著。2025年研发投入头部车企占比预计提升至8-10%。 2. 技术路线分化:比亚迪垂直整合优势稳固(2024年专利数量同比+25%),长安汽车智能化转型加速(L4自动驾驶投入占比升至15%)。 四、TOP5车企竞争力预测: 1. 比亚迪:优势在于全产业链布局(电池自供率85%)和海外市场突破(2024出口占比升至18%),挑战来自原材料套期保值风险。 2. 长安汽车:依托燃油车利润反哺(2024传统业务贡献65%现金流),但新能源转型速度滞后(电动化率21% vs 行业均值35%)。 3. 其他头部:需关注新势力企业的毛利率改善(2024Q3平均毛利率回升至18.7%)及传统车企的混动技术突破。 行业未来3年将维持15-20%复合增速,头部企业市占率有望从2024年的58%提升至2026年的65%,技术迭代与全球化布局将成为核心竞争维度。 ``` **输出结果分析:** DeepSearcher 通过补贴削减、成本压力等具体因素,建立了宏观经济与行业表现的联系。回答涵盖财务指标、宏观经济影响和竞争趋势,数据丰富,适合需要基于证据做评估的读者。 运行效果展示: ![deepseracher-car.gif](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/deepsearcher/deepsearcher-car.gif?s=db74b01114b3869c00b1c572d36b4dd1) ### 根据JD筛选简历 我们为 DeepSearcher 提供了多份候选人简历 PDF 文件。 **Prompt:** ``` 请根据以下优先级及标准,严格评估候选人的简历匹配度,从筛选出适合团队合作的3个与岗位匹配的实习生简历,并说明原因。筛选条件:1.硬性条件:Excel技能达标;英语能力达标。2.加分条件:(1)跨境电商经历(权重40%):考虑平台经验;欧盟业务;数据成果。(2)供应链经验(权重30%):选品分析;物流管理;单证处理。(3)工具能力(权重20%):BI工具;ERP系统;自动化。(4)文化适配(权重10%):跨文化经历;抗压案例;协作证明 ``` **输出内容:** ``` **简历一([姓名 1])** 匹配原因: 1. 具备Shopee欧洲站运营经验,直接参与选品、数据分析和物流优化,熟悉跨境电商全链路; 2. 熟练运用Excel高级函数(VLOOKUP/SUMIFS)和BI工具,完成供应链可视化项目; 3. 英语CET-6 550分,参与跨部门协作的供应链优化项目,团队协同能力突出。 **简历三([姓名 3])** 匹配原因: 1. 参与校园跨境电商创业项目,完成欧洲市场选品和跨语言协作,体现团队执行力; 2. 掌握Excel数据清洗和基础分析技能,英语CET-6 505分满足基础沟通需求; 3. 市场调研经历可为欧洲市场竞品分析提供支持。 **简历十([姓名 10])** 匹配原因: 1. 自主运营eBay欧洲站店铺,实现从0到5000美元月销售额,实战经验丰富; 2. 主导选品和供应链优化项目,直接降低15%采购成本,展现业务闭环能力; 3. 英语CET-6 508分,熟悉跨境电商全流程操作,创业经历强化问题解决能力。 ``` **输出结果分析:** DeepSearcher 结合岗位需求给出细节和数据支持,将岗位需求画像与候选人能力对应,并对团队合作能力做出评估。 DeepSearcher 在数据处理准确性、分析结构化程度和洞察力方面表现较好。处理复杂查询更稳定,分析贴合数据本身,输出质量较高,适合生成可靠、深入的行业报告。 # DeepSeek Harness 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/deepseek-harness 按步骤创建 PPIO API Key、通过 npm 安装 DeepSeek Harness,在设置中添加 PPIO 自定义提供方并导入模型后运行任务。 ![DeepSeek Harness 架构示意](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/deepseek-harness/image.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=ee4acc916be2d2ccb8306737057c68c4) DeepSeek Harness 发布不到一个月,在 GitHub 积累 21 万星标,社区已开发超过 13000 个插件。 DeepSeek Harness 的核心设计理念为「一切皆插件」。与 Claude Code、Codex 等封闭系统 Agent 产品不同,DeepSeek Harness 的模型、工具、技能、会话、沙箱、存储等能力均可自由替换、重组。 DeepSeek 官方提出的公式:**Agent = Model + Harness**。模型是 Agent 的核心,Harness 让 Agent 能够理解环境、使用工具,并在真实场景中持续工作。 DeepSeek Harness 除 DeepSeek 官方模型外,也可接入其他数十家厂商的大模型。 PPIO 模型服务平台支持一键接入 DeepSeek Harness。**平台提供 DeepSeek、GLM、Kimi、Qwen、MiniMax 等主流开源系列模型,配置一个统一的 API Key,即可在 DeepSeek Harness 中切换模型。** PPIO 企业 Token Plan 的模型调用低至 4.5 折,最多支持 200 个席位。团队使用 DeepSeek Harness 时,可作为高性价比的「Token 加油包」。 ## 准备工作:创建 PPIO API Key **1. 注册并登录 PPIO 账号** API Key 是配置 DeepSeek Harness 的关键信息。获取 API Key 需先注册 PPIO 账号并登录,然后打开 [API 密钥管理页面](https://ppio.com/settings/key-management) 点击创建。 注册地址:[https://ppio.com/](https://ppio.com/) ![API 密钥管理页面](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/deepseek-harness/image-4.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=860f1b82ac37292b9f719c0faef5960c) **2. 填写密钥名称与生命周期** 按需输入自定义密钥名称、选择生命周期时长,即可创建 API 密钥。 ![创建 API 密钥](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/deepseek-harness/image-1.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=b30c86ce59cf646d99b15da569f1561f) ![API 密钥创建成功](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/deepseek-harness/api-key-created.jpg?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=112c1569775650b876dc258304289c6c) ## 四步接入,丝滑使用 DeepSeek Harness 与 WorkBuddy、Manus 等下载安装即用的产品不同,DeepSeek Harness 目前只支持通过 `npm` 运行和源码运行两种方式。 可以将 GitHub 链接发给 Claude Code 或 WorkBuddy 等工具代为安装,也可以手动安装。手动安装以 npm 运行方式为例。 **1. 安装 Node.js** Node.js 是 DeepSeek Harness 的运行环境。以 Mac 电脑为例,打开终端后输入以下代码检查是否已安装 Node.js: ```bash theme={null} node -v ``` 如果已安装 Node.js,会出现版本号,比如 `v24.14.1`;如果未安装,可前往 [Node.js 下载页](https://nodejs.org/en/download) 安装。 ![检查 Node.js 版本](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/deepseek-harness/image-6.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=2e097cf330dcb5c8531d341cb9867d44) **2. 安装并运行 DeepSeek Harness** 安装 Node.js 后,打开终端输入一行代码即可: ```bash theme={null} npx @deepseek-ai/dsh web ``` 第一次运行会下载相关依赖文件,可能耗时较长。命令执行完成后会打开默认浏览器启动 Web UI,地址为 [http://127.0.0.1:3080/](http://127.0.0.1:3080/) ![DeepSeek Harness Web UI](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/deepseek-harness/image-3.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=763fec58056f090ad9dba95117b182c0) > [!TIP] > > 如果安装过程报错,可能是权限不足、下载失败等问题,可求助 DeepSeek、Claude Code 等 AI 助手再次尝试。 **3. 配置 PPIO API Key** 首次进入 DeepSeek Harness 页面时会提示填入 DeepSeek 官方 API Key,选择稍后配置,改用自定义的 PPIO 模型。 ![稍后配置官方 API Key](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/deepseek-harness/image-9.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=74d81b73e3efda9b6e5b97c4304583d9) 点击左下角设置,选择「模型」里的「添加自定义提供方」。 ![添加自定义提供方](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/deepseek-harness/image-5.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=ce62a67147c2165111b50021ba7df048) 将 PPIO 的相关配置填入,包括: * **Provider ID 与显示名称**:自定义即可,比如命名为 PPIO * **API 地址**,即 PPIO 的 Base URL:`https://api.ppio.com/openai`(OpenAI 兼容协议) * **API 密钥**:即上一步创建的 PPIO 密钥 * **模型目录**:点击「获取可用模型」,会自动导入 PPIO 的 Qwen、GLM、DeepSeek、Kimi、MiniMax 等多个系列模型 ![填写 PPIO 配置](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/deepseek-harness/image-2.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=d4536518cced067daa780e72717601c4) 点击创建后,模型即自定义配置成功。 ![自定义提供方创建成功](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/deepseek-harness/image-10.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=b8536b0514374f345a9ce32a5c39ec15) **4. 运行任务** 运行任务前需先选择一个工作区,然后在已配置好的 PPIO 模型列表中选择要调用的模型。 ![选择工作区与模型](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/deepseek-harness/image-7.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=b7ff4b2d35a0617c51fa78b4ce4039c4) DeepSeek Harness 提供四种 Agent 运行模式:标准模式、PTC 模式、极简模式与创造模式。下面用默认状态下的标准模式和 GLM-5.3-Flash 模型运行一个任务:「梳理 2026 年 8 月份市场上发布的大语言模型以及价格,做成一张图」。 ![运行任务示例](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/deepseek-harness/image-8.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=017fe90c68cc5e25506f957f45df725d) 最终交付结果包括成品图、矢量源文件和生成脚本。成品图如下: ![任务交付成品图](https://mintcdn.com/ppinfra/ooq5n4l3-ff6ax38/third-party/images/deepseek-harness/chart-aug2026.png?fit=max\&auto=format\&n=ooq5n4l3-ff6ax38\&q=85\&s=e53a772653ca7349daf09f5cf59819b8) 如果有更好的 DeepSeek Harness 使用心得,欢迎在留言区评论交流。 # Dify 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/dify-use 查阅 Dify 接入 PPIO LLM API 的配置说明,了解应用平台中的模型连接方式,为构建 AI 应用与工作流提供参考。 ## 教程概述 **Dify** 通过低代码技术降低 AI 应用开发门槛,为开发者和企业提供可视化协作平台。平台支持主流开源模型与云厂商接口对接,并提供可视化工作流设计和 API 管理功能。 下方教程包含完整接入方案(含密钥配置),3 分钟完成「Dify 智能调度 + PPIO 高性能 API」接入。 ## 进入 Dify,更改模型提供商 **1. 打开个人设置** 先点击右上角【个人头像】,点击设置。 ![Dify 设置](https://static.ppinfra.com/docs/image/llm/Q8BvbPsQWoYA86xhDq3ccOc6nLd.png) **2. 添加模型供应商** 点击【模型供应商】,下拉找到 Open-AI-API-competible,点击【添加模型】。 ![Dify 添加模型](https://static.ppinfra.com/docs/image/llm/Vd0EbD8okou0TqxqRgScx3wgnMe.png) ## 配置自定义模型 **1. 添加自定义 LLM 模型** 选择模型类型【LLM】,将官网模型名称:`deepseek/deepseek-v4-pro` 直接复制到【模型模型】。 如需更换其他模型,前往 [PPIO 模型列表](https://ppio.com/model-api/pricing?utm_medium=article\&utm_source=official_wechat)复制模型名称,例如:`deepseek/deepseek-v4.1-flash`;最后点击【添加模型】。 ![Dify 添加模型](https://static.ppinfra.com/docs/image/llm/X9wfb7dRgo643AxW1jbcInirnGb.png) **2. 创建 API 密钥** 前往[PPIO 派欧云 API 密钥管理](https://ppio.com/settings/key-management),点击【用户头像】—【API 密钥管理】进入控制台。 ![Dify 添加模型](https://static.ppinfra.com/docs/image/llm/E3owbKq8AohCibxaF2qcl5EwnFg.png) 点击【+ 创建】按钮创建新的 API 密钥。自定义一个密钥名称,生成的**密钥仅在生成时呈现,务必复制并保存到文档中,以免影响后续使用**。 ![Dify 添加模型](https://static.ppinfra.com/docs/image/llm/XyI2bnOcNo0ToExuPiNclBCvnwg.png) **3. 填写 Base URL 并保存** 输入 URL:`https://api.ppio.com/openai`,和图片一致即可,最后点击【保存】。 # FastGPT 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/fastgpt-use 了解 FastGPT 接入 PPIO LLM API 的使用流程,查阅模型服务配置,为在应用平台中组织对话与 AI 任务提供参考。 **FastGPT** 是一个可视化平台,把 AI 开发、部署和使用全流程简化为可视化操作。开发者不需要深入研究算法,用户也不需要掌握复杂技术,通过一站式服务即可使用人工智能技术。 PPIO 派欧云提供 API 接口,开发者可调用 DeepSeek 等模型。 * **对开发者**:无需重构架构,3 个接口完成从文本生成到决策推理的全场景接入; * **对生态**:自动适配从中小应用到企业级系统的资源需求。 下方教程提供完整接入方案(含密钥配置),将 FastGPT 与 PPIO API 连接起来。 ## 配置前置条件 **1. 获取 API 接口地址** 固定为:`https://api.ppio.com/openai/v1/chat/completions`。 **2. 获取 API 密钥** 登录派欧云控制台 [API 密钥管理](https://ppio.com/settings/key-management) 页面,点击创建按钮。 ![](https://static.ppinfra.com/docs/image/llm/BKWqbzI5PoYG6qxwAPxcinQDnob.png) **3. 生成并保存 API 密钥** > [!WARNING] > > 密钥在服务端是加密存储,请在生成时保存好密钥;若遗失可以在控制台上删除并创建一个新的密钥。 ![](https://static.ppinfra.com/docs/image/llm/OkUwbbWrcoCY2SxwVMIcM2aZnrs.png) ![](https://static.ppinfra.com/docs/image/llm/GExfbvcosoJhVKxpzKVczlsdn3d.png) **4. 获取需要使用的模型 ID** deepseek 系列: DeepSeek V4 Pro:deepseek/deepseek-v4-pro DeepSeek V4.1 Flash:deepseek/deepseek-v4.1-flash 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ## 部署最新版 FastGPT 到本地环境 > [!NOTE] > > 请使用 v4.8.22 以上版本,部署参考:[https://doc.fastgpt.io/docs/introduction/development/intro](https://doc.fastgpt.io/docs/introduction/development/intro) ## 模型配置(下面两种方式二选其一) ### 通过 OneAPI 接入模型 PPIO 模型 **1. 修改 FastGPT 环境变量** 参考 OneAPI 使用文档,修改 FastGPT 的环境变量 在 One API 生成令牌后,FastGPT 可以通过修改 baseurl 和 key 去请求到 One API,再由 One API 去请求不同的模型。修改下面两个环境变量: 务必写上 v1。如果在同一个网络内,可改成内网地址。 `OPENAI_BASE_URL=http://OneAPI-IP:OneAPI-PORT/v1` 下面的 key 是由 One API 提供的令牌 CHAT_API_KEY=sk-UyVQcpQWMU7ChTVl74B562C28e3c46Fe8f16E6D8AeF8736e **2. 重启并选择派欧云** 按下图在模型提供商中选择派欧云。 ![](https://static.ppinfra.com/docs/image/llm/Fvqzb3kTroys5Uxkjlzco7kwnsb.png) **3. 测试连通性** 以 deepseek 为例,在模型中选择使用 deepseek/deepseek-v4-pro,点击图中②的位置进行连通性测试,出现图中绿色的成功显示证明连通成功,可以进行后续的配置对话了 ![](https://static.ppinfra.com/docs/image/llm/FzKGbGsSPoX4Eexobj2cxcaTnib.png) ### 不使用 OneAPI 接入 PPIO 模型 **1. 在模型提供商中选择派欧云** 按照下图在模型提供商中选择派欧云。 ![](https://static.ppinfra.com/docs/image/llm/QbcdbPqRsoAmuyx2nlycQWFanrc.png) **2. 配置模型** 自定义请求地址中输入:`https://api.ppio.com/openai/v1/chat/completions` ![](https://static.ppinfra.com/docs/image/llm/ZVyAbDIaxo7ksAxLI3HcexYYnZf.png) ![](https://static.ppinfra.com/docs/image/llm/Ha9YbggkwoQsVdx1Z4Gc9zUSnle.png) **3. 测试连通性** ![](https://static.ppinfra.com/docs/image/llm/V1f0b89uloab9uxxj7IcKT0rn3e.png) 出现图中绿色的成功显示证明连通成功,可以进行对话配置 ## 配置对话 **1. 新建工作台** ![](https://static.ppinfra.com/docs/image/llm/ZaGpbBH6QoVubIx2TsLcwYEInfe.png) **2. 开始聊天** ![](https://static.ppinfra.com/docs/image/llm/HzcTb4gobokVRQxTlU7cD5OunMf.png) # Hermes 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/hermes 按照 Hermes 接入指南配置 PPIO LLM API,了解智能体使用模型服务的连接方式,为组织 AI Agent 任务提供参考。 Hermes 是 Nous Research 推出的 Agent 工具,支持通过自定义 OpenAI-compatible endpoint 连接模型服务。本文介绍在 Hermes 中接入 PPIO 派欧云大语言模型 API 的方法。 ## 前置准备 开始前,请准备以下信息: * **API Key**:前往 [API 密钥管理](https://ppio.com/settings/key-management) 创建或复制 API Key。 * **Base URL**:`https://api.ppio.com/openai/v1` * **Model ID**:前往模型广场或模型详情页,复制需要使用的模型 ID,例如 `deepseek/deepseek-v4.1-flash`。 > [!TIP] > > Hermes 会在本地保存 endpoint 与 API Key 配置。不要把包含密钥的配置文件提交到 Git 仓库。 ## 安装 Hermes Hermes 提供终端版与桌面版,按需选择一种方式安装。 ### Linux / macOS / WSL2 ```bash theme={null} curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash ``` ### Windows PowerShell ```bash theme={null} iex (irm https://hermes-agent.nousresearch.com/install.ps1) ``` ### Desktop 也可以访问 Hermes Desktop 页面下载安装: ```text theme={null} https://hermes-agent.nousresearch.com/desktop ``` ## 配置 PPIO endpoint 安装完成后,运行 Hermes 配置向导。不同版本的命令入口可能略有差异,以 Hermes 终端提示为准。 配置过程中,按以下方式选择和填写: **1. 选择自定义提供商** 选择 **Custom endpoint** 或手动输入 URL 的自定义提供商。 **2. 填写 Base URL** 在 Base URL 中填写:`https://api.ppio.com/openai/v1` **3. 填写 API Key** 在 API Key 中填写您的 PPIO API Key。 **4. 选择 API 类型** 在 API 类型中选择默认自动检测。如需手动指定,请选择 OpenAI-compatible / Chat Completions 相关模式。 **5. 选择模型** 在模型列表中选择目标模型,或手动输入 PPIO 模型 ID,例如 `deepseek/deepseek-v4.1-flash`。 **6. 设置 max tokens** 根据模型上下文长度设置 max tokens;不确定时可保留默认或自动检测。 **7. 为配置命名** 为该模型配置设置一个便于识别的名称,例如 `ppio-deepseek-v4.1-flash`。 **8. 选择运行环境** 如果仅在本地使用,运行环境选择默认的 Local。 **9. 跳过渠道集成** 如果不需要连接 Telegram、Slack、Matrix 等渠道,集成渠道保持跳过即可。 ## 刷新终端配置 如果 Hermes 安装完成后提示需要刷新 shell,请执行: ```bash theme={null} source ~/.zshrc ``` ## 启动 Hermes 在终端中启动 Hermes: ```bash theme={null} hermes ``` 输入一条测试消息,例如: ```text theme={null} 你好,请介绍一下当前连接的模型能力。 ``` 如果请求失败,请检查: * API Key 是否填写正确。 * Base URL 是否为 `https://api.ppio.com/openai/v1`。 * 模型 ID 是否与 PPIO 模型详情页保持一致。 * 当前选择的 API 类型是否兼容 OpenAI-compatible endpoint。 # 沉浸式翻译接入 PPIO LLM API Source: https://ppio.com/docs/third-party/immersive-translate-use 查阅沉浸式翻译接入 PPIO LLM API 的指南,了解翻译工具中的模型配置与连接方式,为使用 AI 翻译服务提供参考。 ## 教程概述 **[沉浸式翻译](https://immersivetranslate.com/)** 是一款双语对照网页翻译插件,使用 LLM 模型,支持跨语种理解,可用于网页阅读、PDF 翻译、EPUB 电子书翻译、视频双语字幕翻译等场景,并支持各类浏览器插件和应用。 通过 PPIO 派欧云开发者平台,三步即可在沉浸式翻译中接入 DeepSeek 的翻译能力。 下方教程包含完整接入方案(含密钥配置),3 分钟完成「沉浸式翻译 + PPIO 高性能 API」配置。 ## 安装沉浸式翻译插件 在「沉浸式翻译」[官网](https://immersivetranslate.com/zh-Hans/)选择「安装浏览器插件」,选择对应的浏览器版本,按提示安装。已安装对应插件可跳过本步骤。 ![沉浸式翻译插件安装](https://static.ppinfra.com/docs/image/llm/Ur4xbpWanoIT1RxRTmpcIgnvnKb.png) ## 配置前置条件 **1. 获取 API 接口地址** 固定为:`https://api.ppio.com/openai/v1/chat/completions`。 **2. 获取 API 密钥** 登录派欧云控制台 [API 密钥管理](https://ppio.com/settings/key-management) 页面,点击创建按钮。 ![PPIO 派欧云 API 密钥管理](https://static.ppinfra.com/docs/image/llm/NyaGbZm6jo5QJQxM7lZc6rqwnWg.png) **3. 生成并保存 API 密钥** > [!WARNING] > > 密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建一个新的密钥。 ![PPIO 派欧云 API 密钥管理](https://static.ppinfra.com/docs/image/llm/GBkfbbRyVoHLWrx6dI3chCsRnOb.png) **4. 获取需要使用的模型 ID** 推荐使用 DeepSeek 系列: * DeepSeek V4 Pro:deepseek/deepseek-v4-pro * DeepSeek V4.1 Flash:deepseek/deepseek-v4.1-flash 其他模型 ID 及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ## 插件配置 **1. 打开插件【设置】** ![沉浸式翻译插件设置](https://static.ppinfra.com/docs/image/llm/PpOXb2zBJoPfw0xpV8ocCwcOnSc.png) **2. 添加 OpenAI 兼容服务** 选择【**翻译服务**】—【**添加 OpenAI 兼容服务**】。 ![沉浸式翻译插件设置](https://static.ppinfra.com/docs/image/llm/WbNRbMzGTogMnQxWMCbc6LDrn1g.png) **3. 添加接口地址及密钥** 添加 PPIO 派欧云接口地址及密钥 key。 ![沉浸式翻译插件设置](https://static.ppinfra.com/docs/image/llm/Vmaabb4MoocWtwxqtbQcdgpRnme.jpg) **4. 配置自定义模型** 添加自定义模型,在模型下拉框点击 **设置更多模型**,填入「获取需要使用的模型 ID」步骤中对应的 DeepSeek 模型 ID,点击 **保存** 按钮。 ![沉浸式翻译插件设置](https://static.ppinfra.com/docs/image/llm/AYrRbwnz0o9kgUxk3SOcRJlbnKe.png) ![沉浸式翻译插件设置](https://static.ppinfra.com/docs/image/llm/XpR6bz4Amo1cNexJFHEcV7mWnOS.png) **5. 测试服务** 点击 **点此测试服务**,验证配置是否正确。 ![沉浸式翻译插件设置](https://static.ppinfra.com/docs/image/llm/ElSKbgsLLo9hf2xrsbHcrmxUn0f.png) **6. 设为默认翻译服务** 返回 翻译服务,打开 PPIO 派欧云 并配置为默认。 ![沉浸式翻译插件设置](https://static.ppinfra.com/docs/image/llm/G079bDHHRo2UHHx7Jjlc87iRnUC.png) # PPIO × Kilo Code:开源编程 Agent,让 AI 真正进项目里干活 Source: https://ppio.com/docs/third-party/kilo-code 按照 Kilo Code 接入教程配置 PPIO LLM API,了解 API Key、Base URL、模型 ID 和自定义服务商设置,以及企业 Token Plan 与 Fusion 融合模型的使用方式。 ![20261104-143008.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/kilo-code/hero.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=3b30880d93f4884b94bbf2905d1d4d14) 凌晨一点,终端里又亮起一片红。 你把报错复制给 AI,它很快给出一段修改建议。粘回编辑器,重新运行,新的报错又冒了出来。于是你继续复制、继续追问,再把代码一段段搬回项目。 折腾几轮后会发现,问题未必是模型不会写代码,而是它根本不在“现场”:看不到完整的项目结构,不知道你刚刚改过什么,也没法替你运行命令、检查结果。 Kilo Code 想缩短的,正是这段距离。 它把 AI 放进开发环境,让模型能够读取项目文件、分析代码、规划修改、执行命令并根据结果继续工作。普通聊天窗口更像隔着电话报修,Kilo Code 则像坐在项目目录旁边的搭档。你只要说清目标,它就能沿着代码和工具输出往下做。 如果你希望 AI 不只“给答案”,还能参与真实的开发过程,Kilo Code 值得认识一下。 ![ScreenShot_2026-11-03_163515_533.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/kilo-code/kilo-code-overview.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=e7bc59941917da2693736a5d730ed79b) ## 01 认识 Kilo Code:一个能在项目里行动的开源编程 Agent Kilo Code 是一**款采用 MIT 许可证的开源编程 Agent**,可运行在 VS Code、Cursor、Windsurf、JetBrains、CLI 和云端等环境中。 与普通聊天式 AI 不同,它能**直接进入项目现场**:读取文件、分析依赖、制定方案、修改代码、执行命令,并根据测试结果继续调整。Ask、Plan、Code、Debug 和 Custom 等模式,分别适合代码问答、方案设计、功能实现、问题排查及自定义工作流。 在 OpenRouter 的热门 APP 调用量排行榜上,Kilo Code 高居第五位,每周的 Token 调用量超过 5T。 ![Clipboard_Screenshot_1793759951.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/kilo-code/openrouter-ranking.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=2b962db37110e94eecdac1aa439f34a5) Kilo Code 支持 500 多款模型,也允许接入自己的 API Key、第三方服务和本地模型。通过 OpenAI 兼容配置,能将 PPIO 作为模型入口。此外,自定义规则和 MCP 可帮助团队接入开发规范、知识库及内部工具,搭建更符合自身需求的 AI 编程流程。 ## 02 简单三步,在 Kilo Code 中接入 PPIO Kilo Code 支持 OpenAI 兼容协议的定义服务商,因此接入 PPIO 不需要修改插件代码。准备好 API Key、接口地址和模型 ID 后,在设置页面完成配置即可。 ### 第一步 创建并保存 PPIO API Key 首先注册一个 PPIO 账号,通过专属链接注册还可以获得 ¥50 代金券: [https://ppio.com/activity/kilo_code](https://ppio.com/activity/kilo_code) 注册并登录后进入 API 密钥管理页面创建 API Key。 ![ScreenShot_2026-11-03_153508_401.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/kilo-code/api-key-management.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=485240e59a196686a7536e68cd53f11b) ![ScreenShot_2026-11-03_154946_370.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/kilo-code/api-key-created.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=2ca2ca7381024e0e307ccbefd464c686) ### 第二步 选择模型并确认接口地址 进入 PPIO 模型广场,选择准备使用的模型,在详情页复制完整的 Base URL 和 Model ID。 ![ScreenShot_2026-11-03_154838_694.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/kilo-code/model-api-guide.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=eb5ae279ac9c784d2b1e69c2ce2fd40b) ### 第三步 在 Kilo Code 添加自定义服务商 安装 Kilo Code 后,打开设置页面并进入 **Providers**,滚动到底部,点击 **Custom provider,将接口地址(即 Base URL)、API Key 和模型名称(即 Model ID)依次填入即可。** ![ScreenShot_2026-11-03_155335_713.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/kilo-code/custom-provider.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=2e753714b9358889da60c7ebf29947b7) ![ScreenShot_2026-11-03_155424_962.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/kilo-code/provider-settings.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=3ecf8fafb40d4671c3a2071e0cffc7f9) ![ScreenShot_2026-11-03_161908_710.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/kilo-code/model-configured.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=350ddab171aeaad00ffd65ae4f9bb404) ## 03 订阅 PPIO 企业 Token Plan,旗舰模型低至 6 折 PPIO 企业 Token Plan 是一套标准化的预付费折扣产品,核心机制是“融合 Token”:以 DeepSeek V4 Flash 输入 Token 为基准单位(系数 1.000),其他模型按照各自的抵扣系数折算消耗,共用同一套余额。 PPIO 企业 Token Plan 支持 200+席位,特别适合中小 AI 开发者团队。**PPIO Token Plan 搭配 Kilo Code,就是最好的编程协作伙伴。** PPIO 企业 Token Plan 目前覆盖了 17 款模型,包括 DeepSeek V4 Flash 正式版、Kimi K3、GLM-5.2、MiniMax M3 等国产开源旗舰模型在内的全系列模型。后续,新模型上线也将及时同步更新到订阅包中。 PPIO 企业 Token Plan 分三档(见下图),三档基准单价相同,均为 ¥0.95/Mtoken,差异在于 Token 配额、并发上限和服务级别。具体折扣幅度因模型而异 —— DeepSeek 系列约 9 折,Qwen 3.5、GLM-5.2 等官方定价偏高的模型可低至 5\~6 折,综合成本节省空间最高接近一半。 ![rYal2cXe.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/kilo-code/token-plan.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=3aaff70110d60d4ac80197582523bc6d) ## 04 Fusion 融合模型已上线,用 1/10 的价格超越顶级模型的智商 除了常规模型之外,PPIO 最新上线的 Fusion 融合模型也已支持接入 Kilo code。 Fusion 融合模型是 PPIO 智能模型网关提供的多模型融合推理能力。调用融合模型时,网关不会只询问一个模型,而是将请求同时分发给多个各需要长的“专家模型”作答,再通过思考编排与交叉验证,由主模型生成最终答案——汇聚模型每次调用都变成一次“专家会诊”。与只做简单请求转发的传统 API 网关不同,融合模型以智能优先、兼顾算计:通过工程化的融合手段,把答案质量稳定放在头部旗舰模型梯队,同时把成本控制在中低梯队。 在 DRACO 深度研究基准测试中,PPIO Fusion 融合模型以 Kimi K3、GLM 5.2、MiniMax M3 为参考模型(Advisors)、DeepSeek V4 Flash 为融合主模型(Aggregator)进行融合推理,超越了 Claude Fable 5,而总成本接近其约 1/10。Fusion 融合模型提供 OpenAI 兼容接口,Base URL 无需改变,只需要将模型名称设置为 `pprouter/fusion` 即可。 Kilo Code 将 AI 从代码问答带进了真实的项目执行流程。接入 PPIO 后,开发者可以根据任务灵活选择模型:日常代码解释和小范围修改使用单模型,遇到跨模块重构、复杂故障排查或关键代码审查时,则可切换至 Fusion,让多个模型共同分析 Kilo Code 提供的项目上下文,无需在多个工具之间反复传递代码和报错信息。 截至 2026 年 9 月,PPIO 日均 Token 调用量达 3.4 万亿,成为国内最大独立“Token 工厂”,为用户持续提供可靠、可扩展、高性价比的模型服务。 # LangBot 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/langbot-use 了解 LangBot 接入 PPIO LLM API 的配置流程,查阅机器人与模型服务的连接方式,为聊天机器人应用提供参考。 在日常学习、工作中,聊天机器人可协同用户进行定时提醒、问答、整理文件等,提升效率。 LangBot 是一个开源即时通信机器人平台,支持接入飞书、钉钉、QQ 等消息平台,用户可直接在平台内处理任务。 借助 PPIO 的模型 API 服务,LangBot 可接入 DeepSeek、Qwen 等主流模型,用户按需选择以适配不同场景。以下为完整配置教程。 ## **PPIO × LangBot配置教程** ### 获取 API key **1. 获取 API 密钥** 注册并登录 PPIO。 打开 API 密钥管理页面,点击创建按钮,输入自定义密钥名称,生成 API 密钥。 ![20250613-145217.jpeg](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/langbot/20250613-145217.jpeg?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=88724a3c0fe8ba8d0bc2a4d26a44e6d7) **2. 生成并保存 API 密钥** **注意**:密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建一个新的密钥。 ![20250613-145225.jpeg](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/langbot/20250613-145225.jpeg?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=ccce78dc66b85da153496b4de9860ab3) **3. 获取模型 ID** **推荐使用的模型 ID** * deepseek/deepseek-v4-pro * deepseek/deepseek-v4.1-flash * qwen/qwen3.8-max * zai-org/glm-5.3 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ## 部署并配置 LangBot 通过 Docker 可将 LangBot 部署到 Windows、macOS、Linux 上。 部署前,请确保已安装 Git、Docker。 项目地址:[https://github.com/RockChinQ/LangBot](https://github.com/RockChinQ/LangBot) **1. 通过 Docker 部署 LangBot** Git 克隆本项目: ``` git clone https://github.com/RockChinQ/LangBot cd LangBot ``` 启动容器: ``` docker compose up ``` 如果主机位于中国大陆,可将 `docker-compose.yaml` 文件中的镜像名称改为 `docker.langbot.app/langbot-public/rockchin/langbot:latest`,以使用 LangBot 提供的镜像源。 **2. 创建配置文件** 首次启动会输出创建配置文件的提示,请按照生成的配置文件继续配置。 容器会映射 `5300` 端口供 WebUI 使用,可访问 `http://127.0.0.1:5300` 查看 WebUI;还会映射 `2280-2290` 端口,供使用 OneBot 协议的消息平台适配器反向连接。 **3. 配置对话模型** 打开 LangBot,点击模型配置,模型提供商选择派欧云。 ![5a3035cd-2c5d-44f4-9da6-411d7a5c5028.jpg](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/langbot/5a3035cd-2c5d-44f4-9da6-411d7a5c5028.jpg?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=02fdd2b30fda35181f040b3de5d7091a) ![download.jpg](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/langbot/download.jpg?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=bd7d150869ebd32b1856b2dd803141ec) 按以下信息配置模型。 * 模型名称:从 PPIO 官网复制的所需模型名称 * 模型提供商:派欧云 * 请求 URL:固定为 `https://api.ppio.com/openai` * API Key:从派欧云官网保存的密钥 ![e709b012-c8ad-4f13-b989-ebfdff5711aa.jpg](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/langbot/e709b012-c8ad-4f13-b989-ebfdff5711aa.jpg?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=026e843d4036d33a4b39c0b7b1842190) ## 接入平台 LangBot 支持将聊天机器人接入 QQ、微信公众平台、飞书等平台。以钉钉为例,接入教程如下。 ### 创建机器人 **1. 进入开发者后台** 进入 [钉钉开发者后台](https://open-dev.dingtalk.com/?spm=ding_open_doc.document.0.0.74f445e5MkawbT#/),登录并进入组织。 地址:[https://open-dev.dingtalk.com/](https://open-dev.dingtalk.com/) ![cd68ddcf-f538-46a4-963b-7b970c82ad29.jpg](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/langbot/cd68ddcf-f538-46a4-963b-7b970c82ad29.jpg?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=9dd07a390b2555d23d5e2f1e130585e8) **2. 创建应用** 点击上方的 `应用开发`,选择 `创建应用`,填写机器人的基本信息并保存。 ![4838716d-c88b-4b9c-a2ff-b0d5cf7d132a.jpg](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/langbot/4838716d-c88b-4b9c-a2ff-b0d5cf7d132a.jpg?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=84105541c853413e9247569d7e69fd60) **3. 添加机器人能力** 选择「添加应用能力」为应用添加机器人能力。 ![21a22730-ee41-4f2f-9cd3-bd464d133ca2.jpg](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/langbot/21a22730-ee41-4f2f-9cd3-bd464d133ca2.jpg?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=77fe1f16cf22b36917f53a540b4c4e11) ### 配置机器人 **1. 填写机器人信息并发布** 点击左侧「机器人」选项卡,填写机器人配置信息,完成名称、简介、消息名称等基础配置,配置完成后点击发布。 ![9de0f769-abff-4aca-b903-5e73527fac60.jpg](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/langbot/9de0f769-abff-4aca-b903-5e73527fac60.jpg?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=7b51a5991c131ec7056be04b1f311aa5) **2. 配置版本并发布** 发布成功后,点击左侧最下方的版本管理与发布,配置应用版本号及版本描述。 ![f1241e3d-5509-47ab-ac2f-66a59003e75a.jpg](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/langbot/f1241e3d-5509-47ab-ac2f-66a59003e75a.jpg?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=61db5a51e91c4b96294981b16ff1b495) **3. 设置事件订阅** 事件订阅选择「Stream 模式」,无需注册公网回调地址。 ![e230bc70-48a9-4f3b-9003-d9a1b1a47b7c.jpg](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/langbot/e230bc70-48a9-4f3b-9003-d9a1b1a47b7c.jpg?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=f4d28df1f9cca771db55273458c4522f) **4. 记录凭证信息** 点击「凭证与基础信息」,记录 Client ID 和 Client Secret;点击左侧机器人,记录 RobotCode 和机器人名称。 ![1f25c601-9ae6-4683-b837-1b8a1bf8e26c.jpg](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/langbot/1f25c601-9ae6-4683-b837-1b8a1bf8e26c.jpg?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=209b37a2284ca9fb3a706ea440f64d6b) **5. 填写 LangBot 机器人配置** 记录以上配置项后,填入 LangBot 机器人配置表单,确认提交。 ![7357567b-664d-459c-84a3-6f49411226ab.jpg](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/langbot/7357567b-664d-459c-84a3-6f49411226ab.jpg?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=308a4bdb89abb10875c06d749fae8ae6) **6. 绑定流水线** 启动 LangBot,编辑机器人,绑定流水线(初始会有一个 ChatPipeline 流水线),平台选择钉钉。 ![f78a1745-fdd2-4f1e-a859-e93b66abd4cd.jpg](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/langbot/f78a1745-fdd2-4f1e-a859-e93b66abd4cd.jpg?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=4aec573cc88272fcdcdf9e383a910c28) **7. 配置 AI 能力** 编辑流水线,在 AI 能力配置中选择内置 Agent,并选择此前绑定好的所需模型。 ![b85ac1a9-8bb5-4922-bd19-dd8f09fc8cee.jpg](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/langbot/b85ac1a9-8bb5-4922-bd19-dd8f09fc8cee.jpg?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=9c1bd8137b3ce1ae5ac61dd5920e35dd) ![e0815d11-fb6f-413c-9e8d-33becda159ae.jpg](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/langbot/e0815d11-fb6f-413c-9e8d-33becda159ae.jpg?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=ce8e00ba0db242bc2e430a17aa92d52d) ### 使用机器人 **1. 搜索机器人并聊天** 在钉钉搜索刚刚配置的机器人名称,点击机器人即可与其聊天。 ![51c00478-159a-4299-905b-a900089cca8f.png](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/langbot/51c00478-159a-4299-905b-a900089cca8f.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=a5cc346891be3f880670fbf7073653b3) **2. 添加机器人到群聊** 如需将机器人添加到群,点击钉钉群的「群管理」并选择「添加机器人」,搜索机器人名称即可在群聊中使用。 ![76d14ae1-a31b-4165-9924-d2e1917548ec.png](https://mintcdn.com/ppinfra/HqssR35NC59tPJra/third-party/images/langbot/76d14ae1-a31b-4165-9924-d2e1917548ec.png?fit=max\&auto=format\&n=HqssR35NC59tPJra\&q=85\&s=1a8177af146bc49e903557a4db8f379d) # WPS 灵犀接入 PPIO LLM API Source: https://ppio.com/docs/third-party/lingxi-use 按照 WPS 灵犀接入教程配置 PPIO LLM API,获取 API Key、Base URL 和 Model ID,了解自定义模型、Token Plan 与 Fusion 融合模型的使用方式。 ![PPIO 与 WPS 灵犀自定义模型接入](https://mintcdn.com/ppinfra/JdjOrbWaycN3lXdJ/third-party/images/lingxi/hero.png?fit=max\&auto=format\&n=JdjOrbWaycN3lXdJ\&q=85\&s=d2015edb3ee4815fcb5425de783eb89e) WPS 在《中国 AI 办公出海榜 TOP20》中位居榜首,获 S 级评级。WPS 将 AI 写作、翻译、摘要、校对和内容处理嵌入日常办公,提高效率与便捷度。 ![WPS 在中国 AI 办公出海榜中的排名](https://mintcdn.com/ppinfra/JdjOrbWaycN3lXdJ/third-party/images/lingxi/wps-ai-ranking.png?fit=max\&auto=format\&n=JdjOrbWaycN3lXdJ\&q=85\&s=12082147dbfa974e3657a8955d52f73e) 金山办公于 2026 年 7 月 15 日 AI 生产力大会发布灵犀专业版(Lingxi Pro)。灵犀将大语言模型与智能对话、文档处理、数据分析、网页自动化、代码执行等能力结合,支持办公产物端到端交付。 针对 AI 产品「AI 味太浓」、格式不兼容等问题,灵犀推出"我的风格"功能:授权读取历史文档后,学习用户的分段习惯与行文语气,直接输出 `.docx`、`.xlsx`、`.pptx` 等标准格式文件,兼容 WPS 及 Microsoft Office。 据公开资料显示,在"行业级智能体 TOP100"评选中,灵犀位列办公领域第一。 ![灵犀在行业级智能体评选中的排名](https://mintcdn.com/ppinfra/JdjOrbWaycN3lXdJ/third-party/images/lingxi/lingxi-ranking.png?fit=max\&auto=format\&n=JdjOrbWaycN3lXdJ\&q=85\&s=7632e0b2438d84b8be8e279e37b42fa2) 复杂任务需要更强的模型能力,而灵犀默认的「智点」积分加订阅套餐计费,在高频调用下成本较高。灵犀开放了自定义模型功能,接入后调用不再消耗智点。 以接入 PPIO 为例,无需改动配置,填写接口地址、API Key 和模型名称三个参数,即可在灵犀中调用 PPIO 的模型。 PPIO Token Plan 支持主流模型统一接入,调用价格低至 6 折,提供 200+ 团队席位,适合专业、高频的模型调用场景。 ## 简单三步,在灵犀中接入 PPIO **1. 获取并保存 API Key** API Key 是用于身份验证和权限访问控制的密钥。 首先需要注册一个 PPIO 账号。 注册并登录后打开 [API 密钥管理页面](https://ppio.com/settings/key-management),点击创建按钮,输入自定义密钥名称,生成 API 密钥。 ![进入 PPIO API 密钥管理页面](https://mintcdn.com/ppinfra/JdjOrbWaycN3lXdJ/third-party/images/lingxi/api-key-entry.png?fit=max\&auto=format\&n=JdjOrbWaycN3lXdJ\&q=85\&s=caf5c7183633ee03add66987eaf0595c) ![PPIO API 密钥管理页面](https://mintcdn.com/ppinfra/JdjOrbWaycN3lXdJ/third-party/images/lingxi/api-key-management.png?fit=max\&auto=format\&n=JdjOrbWaycN3lXdJ\&q=85\&s=941fe4b216f43147fdd0462bf8f215b7) ![创建 PPIO API 密钥](https://mintcdn.com/ppinfra/JdjOrbWaycN3lXdJ/third-party/images/lingxi/api-key-create.png?fit=max\&auto=format\&n=JdjOrbWaycN3lXdJ\&q=85\&s=3c05f74f15e8698cd2795cdffcae9aba) ![复制并保存新创建的 PPIO API 密钥](https://mintcdn.com/ppinfra/JdjOrbWaycN3lXdJ/third-party/images/lingxi/api-key-copy.png?fit=max\&auto=format\&n=JdjOrbWaycN3lXdJ\&q=85\&s=b0034d4da3b3e55228f0d3d4167ea646) **2. 获取 Base URL 和 Model ID** Base URL 是 API 服务的根地址,Model ID 用于指定调用的具体模型资源。 在 [PPIO 模型广场](https://ppio.com/model-api) 点击任一模型后,可以从 API 接入指南获取 Base URL 以及模型 ID(见下图),Base URL 为固定地址:`https://api.ppio.com/openai` ![从 PPIO 模型 API 接入指南获取 Base URL 和 Model ID](https://mintcdn.com/ppinfra/JdjOrbWaycN3lXdJ/third-party/images/lingxi/model-api-guide.png?fit=max\&auto=format\&n=JdjOrbWaycN3lXdJ\&q=85\&s=77f2252364dd0b7094965e35bb034003) **3. 在灵犀中配置自定义模型** 下载并安装灵犀。在配置自定义模型中,将 PPIO 的接口地址(即 Base URL)、API Key 和模型名称(即 Model ID)依次填入即可。 ![进入灵犀自定义模型配置](https://mintcdn.com/ppinfra/JdjOrbWaycN3lXdJ/third-party/images/lingxi/custom-model-entry.png?fit=max\&auto=format\&n=JdjOrbWaycN3lXdJ\&q=85\&s=7d0be214125846795a0b1990abecbe9f) ![在灵犀中配置 PPIO 接口地址、API Key 和模型名称](https://mintcdn.com/ppinfra/JdjOrbWaycN3lXdJ/third-party/images/lingxi/custom-model-settings.png?fit=max\&auto=format\&n=JdjOrbWaycN3lXdJ\&q=85\&s=aea92bf1edc58fedac7938f078efabfb) ## 订阅 PPIO 企业 Token Plan,旗舰模型低至 6 折 PPIO 企业 Token Plan 是一套标准化的预付费折扣产品,核心机制是「融合 Token」:以 DeepSeek V4 Flash 输入 Token 为基准单位(系数 1.000),其他模型按各自抵扣系数折算消耗,共用同一套余额。 PPIO 企业 Token Plan 支持 200+ 席位,适合中小 AI 开发者团队。 PPIO 企业 Token Plan 目前覆盖 17 款模型,包括 DeepSeek V4 Flash 正式版、Kimi K3、GLM-5.2、MiniMax M3 等国产开源旗舰模型。新模型上线后将同步更新到订阅包中。 PPIO 企业 Token Plan 分三档(见下图),三档基准单价相同,均为 ¥0.95/Mtoken,差异在于 Token 配额、并发上限和服务级别。折扣幅度因模型而异:DeepSeek 系列约 9 折,Qwen 3.5、GLM-5.2 等官方定价偏高的模型可低至 5\~6 折,综合成本节省空间最高接近一半。 ![PPIO 企业 Token Plan 套餐对比](https://mintcdn.com/ppinfra/JdjOrbWaycN3lXdJ/third-party/images/lingxi/token-plan.png?fit=max\&auto=format\&n=JdjOrbWaycN3lXdJ\&q=85\&s=162bfb7bb71da859f17014861cab4e26) ## Fusion 融合模型,用 1/10 的价格超越顶级模型的智商 PPIO 最新上线的 Fusion 融合模型也已支持接入灵犀。 Fusion 融合模型是 PPIO 智能模型网关提供的多模型融合推理能力。调用时,网关将请求同时分发给多个各有所长的「专家模型」作答,再通过思考编排与交叉验证,由主模型生成最终答案,让每次模型调用都变成一次「专家会诊」。与只做请求转发的传统 API 网关不同,融合模型以智能优先、兼顾成本:把答案质量稳定在头部旗舰模型梯队,同时把成本控制在中低梯队。 在 DRACO 深度研究基准测试中,PPIO Fusion 融合模型以 Kimi K3、GLM 5.2、MiniMax M3 为参考模型(Advisors)、DeepSeek V4 Flash 为融合主模型(Aggregator)进行融合推理,超越 Claude Fable 5,总成本接近其约 1/10。Fusion 融合模型提供 OpenAI 兼容接口,Base URL 无需改变,只需将模型名称设置为 `pprouter/fusion`。 除了灵犀,你还可以将 PPIO 模型服务接入 Claude Code、Codex、OpenClaw、Hermes Agent、WorkBuddy、Qoder 等 AI 工具。 截至 2026 年 9 月,PPIO 日均 Token 调用量达 3.4 万亿,是国内最大独立「Token 工厂」之一,为用户提供可靠、可扩展、高性价比的模型服务。 # 流畅阅读接入 PPIO LLM API Source: https://ppio.com/docs/third-party/liuchangyuedu-use 按照流畅阅读接入教程配置 PPIO LLM API,了解阅读工具中的模型服务设置,为在阅读场景中使用 AI 能力提供参考。 ## 教程概述 **流畅阅读**是一款浏览器插件,用于提升网页阅读体验。它识别网页正文,过滤广告、弹窗等干扰元素,将页面转为简洁的阅读模式。新闻、博客、技术文档均可使用,点击插件图标即可聚焦正文。 插件内置自适应排版,按屏幕尺寸调整字体、行距和对比度,支持日间/夜间模式切换。「专注计时器」功能可设置阅读目标时长,搭配背景音效。 PPIO 派欧云提供底层支撑:页面解析速度提升;采用全球分布式节点;通过 DeepSeek 模型,可捕获并重组表格中的嵌套数据。 下方教程包含完整接入方案(含密钥配置),3 分钟完成「流畅阅读 + PPIO 高性能 API」接入。 ## 配置前置条件 **1. 获取 API 接口地址** 固定为:`https://api.ppio.com/openai/v1/chat/completions`。 **2. 获取 API 密钥** 登录派欧云控制台 [API 密钥管理](https://ppio.com/settings/key-management) 页面,点击创建按钮。 ![](https://static.ppinfra.com/docs/image/llm/LhjEbvZMUoaO9uxSqUMcyBkQnCb.png) **3. 生成并保存 API 密钥** > [!WARNING] > > 密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建一个新的密钥。 ![](https://static.ppinfra.com/docs/image/llm/IG77bO56eoFPnUxL645cqkn6nic.png) ![](https://static.ppinfra.com/docs/image/llm/QnxRbwn9SoIrxlxt3zMc1IeEnUe.png) **4. 获取需要使用的模型 ID** DeepSeek 系列: DeepSeek V4 Pro:deepseek/deepseek-v4-pro DeepSeek V4.1 Flash:deepseek/deepseek-v4.1-flash 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ## 安装流畅阅读插件 ![](https://static.ppinfra.com/docs/image/llm/EF0mbm4vOorQLLx1jR3ct2NynQh.png) ## 配置插件 **1. 打开流畅阅读** 点击 Google 右上角插件,再点击【流畅阅读】。 ![](https://static.ppinfra.com/docs/image/llm/YjPAbbqqgo2BdBxMrlecMflrnxg.png) **2. 填写翻译服务配置** 在翻译服务栏选择【自定义】,在【访问令牌】处输入「生成并保存 API 密钥」步骤中的密钥,在【自定义接口】处输入「获取 API 接口地址」步骤中的地址,最后在【自定义模型】处输入「获取需要使用的模型 ID」步骤中的模型名称。 ![](https://static.ppinfra.com/docs/image/llm/LhUPbRvXqoMlxMxoUubcnKoJnc1.png) ![](https://static.ppinfra.com/docs/image/llm/A5n1bY6gRoCiM5x4v6jcFQbMnNh.png) ## 插件使用 先选择需要分析的文本,再在对话框处输入需求,即可使用插件。 ![](https://static.ppinfra.com/docs/image/llm/G0QxbAgbCob31yxHRCrcn4Jrnse.png) # LobeChat 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/lobechat-use 查阅 LobeChat 接入 PPIO LLM API 的说明,了解聊天应用中的模型连接方式,为配置 AI 对话和相关使用流程提供参考。 ## 教程概述 **LobeChat** 是一款开源 AI 聊天工具,面向企业和开发者。它支持语音合成、多模态交互和插件系统,可高度定制。该框架可接入 DeepSeek 等模型,用于自然语言处理和多模态任务。PPIO 派欧云提供高性能 API,保障服务稳定流畅。 下方教程包含完整接入方案(含密钥配置),3 分钟完成「LobeChat + PPIO 高性能 API」接入。 ## 配置前置条件 **1. 获取 API 密钥** 登录派欧云控制台 [API 密钥管理](https://ppio.com/settings/key-management) 页面,点击创建按钮。 ![](https://static.ppinfra.com/docs/image/llm/JOTIb2kyboTWQCxfBsmcRP10n2Q.png) **2. 生成并保存 API 密钥** > [!WARNING] > > 密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建一个新的密钥。 ![](https://static.ppinfra.com/docs/image/llm/AZwlbGGtvozDTpxNAvGcefzlnmS.png) ![](https://static.ppinfra.com/docs/image/llm/TupobPpnGoEVQZxtxmYccvAonuf.png) ## 软件配置和使用 **1. 在 LobeChat 中找到 PPIO** 登录 [LobeChat 官网](https://lobechat.com/),点击左侧【发现】,下拉找到 PPIO。 ![](https://static.ppinfra.com/docs/image/llm/lobechat-3601.png) **2. 填写 API Key 并检查连通性** 在供应商设置界面【API Key】处填写在 PPIO 官网准备好的密钥,连通性检查处选择 deepseek/deepseek-v4-pro 模型,最后点击【检查】。 ![](https://static.ppinfra.com/docs/image/llm/lobechat-3602.png) 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) **3. 开始对话测试** 配置完成后,你可以直接在应用中调用这些自定义配置,开始与 AI 进行对话测试。 ![](https://static.ppinfra.com/docs/image/llm/lobechat-3603.png) # n8n接入 PPIO LLM API Source: https://ppio.com/docs/third-party/n8n-use 了解 n8n 接入 PPIO LLM API 的配置方式,查阅自动化流程中的模型连接说明,为工作流调用语言模型提供参考。 ![1280X1280(1).PNG](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/1280X1280\(1\).PNG?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=5047190dca73001b66185874ea5c12c9) 工作流(workflow)决定 AI Agent 如何感知、思考、行动并适应复杂任务。 n8n 是一个工作流自动化平台,兼顾代码的灵活性和无代码的速度,GitHub 超 89.9k star。关键能力包括: * 按需编写代码:编写 JavaScript/Python 代码,添加 npm 包,或使用可视化界面 * 原生 AI 平台:基于 LangChain 构建基于本地数据和模型的 AI 代理工作流 * 完全掌控:自主托管,使用公平代码许可,或使用云服务 * 企业级就绪:高级权限管理、单点登录(SSO)和离线部署 * 活跃社区:400 多种集成和 900 多个现成可用的模板 **通过 n8n 调用 PPIO 派欧云提供的高性能大模型 API 服务,可以构建自动化流程,同时完全掌控数据和部署。** ## PPIO × n8n 配置教程 ### **前置工作:获取 PPIO API Key** 将 PPIO API 接入 n8n(以及其他 AI 平台),需要准备三个基本信息:Base URL、Model ID 以及 API Key(**密钥**)。 Base URL 是 API 服务的根地址,API Key 用于身份验证和权限访问控制,Model ID 用于指定调用的具体模型资源。 获取 Base URL:PPIO 的 Base URL 固定地址为 `https://api.ppio.com/openai`。 **1. 获取并保存 API Key** 首先,注册并登录 PPIO 派欧云。 然后,打开 API 密钥管理页面,点击【创建】按钮,输入自定义密钥名称,生成 API 密钥。 **注意**:密钥在服务端是加密存储,请在生成时保存好密钥(比如记录在备忘录里);若遗失密钥,可以在控制台上删除并创建一个新的密钥。 ![1280X1280.PNG](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/1280X1280.PNG?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=414a3f7252e57d1497a887cca878b96e) **2. 获取模型 ID** **获取需要使用的模型 ID,包括:** * deepseek/deepseek-v4-pro * deepseek/deepseek-v4.1-flash * qwen/qwen3.8-max * zai-org/glm-5.3 此外,在模型广场点击任一模型后,可以从 API 接入指南获取 Base URL 以及模型 ID。更多信息比如最大上下文及价格可参考模型列表:[https://ppio.com/pricing](https://ppio.com/pricing) ![822b5696-ea02-4792-bb52-41a2ef6c56f8.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/822b5696-ea02-4792-bb52-41a2ef6c56f8.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=07524febddb5c6721c0d4eea1619b99b) ## 在 n8n 中集成 PPIO API,构建聊天 AI Agent ### 准备工作:注册 n8n n8n 有两种使用方式。 一是本地下载安装,使用 n8n 的开源代码许可。开源地址:[https://github.com/n8n-io/n8n?tab=readme-ov-file](https://github.com/n8n-io/n8n?tab=readme-ov-file) 二是直接使用在线的云服务。本文以云服务方式演示如何用 n8n 构建一个简单的聊天 AI Agent。 ### 创建一个新的工作流 新用户先打开 n8n 网址 [https://n8n.io](https://n8n.io) 注册。注册完成后进入 n8n 主界面,会看到一个空白的工作流;n8n 老用户可以直接创建一个新的工作流。 ![dad42f53-6e65-421e-885c-ab73419a9c20.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/dad42f53-6e65-421e-885c-ab73419a9c20.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=bca71cf38e7ba88718c8abf08c56ce77) ### 添加触发节点(trigger node) 每个工作流都需要一个起点。在 n8n 中,这些被称为「触发节点」。我们从聊天节点开始。 **1. 打开节点菜单** 选择「**添加第一步**」或按 Tab 打开节点菜单。 ![fba77da3-71c5-4539-805e-051864be2136.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/n8n/fba77da3-71c5-4539-805e-051864be2136.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=d148bc201b75263379fd4381a59ba596) **2. 搜索聊天触发器** 搜索「**聊天触发器(Chat Trigger)」**。n8n 会显示与搜索相匹配的节点列表。 ![0a437f71-f342-4938-918c-9127682ebf2c.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/0a437f71-f342-4938-918c-9127682ebf2c.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=ebf1d8097b265cf3c3e20f8e64fc9896) **3. 添加聊天触发器节点** 选择**聊天触发器**(Chat Trigger)将节点添加到画布,节点详细信息可以选择默认。 ![82f332e7-6905-4d06-aa0b-b61c1c8c69af.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/82f332e7-6905-4d06-aa0b-b61c1c8c69af.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=695f421d849fbdac8a86d87876e90164) **4. 返回画布** **选择「返回画布」后,添加聊天节点成功。** ![e7f93f7b-7639-4275-bddc-b406ab3b61f0.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/n8n/e7f93f7b-7639-4275-bddc-b406ab3b61f0.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=ca224a9df455e616d84c07bcd5b52225) ### 添加 AI Agent 节点 AI Agent 节点是将 AI 添加到工作流的核心。 **1. 添加节点** 选择**添加节点**,触发节点上的连接器调出节点搜索。 ![877e07f9-0ad4-400d-a5d6-8b7031b70610.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/877e07f9-0ad4-400d-a5d6-8b7031b70610.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=4b4b284d4165e055c34cdba13213c4ab) **2. 选择 AI Agent 节点** 输入「AI」并选择**AI Agent**节点来添加它。 ![4792b6b7-f11e-4ff9-8509-7f0351152bee.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/4792b6b7-f11e-4ff9-8509-7f0351152bee.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=e983612dd28520175d9665930052f9fa) 现在将显示**AI Agent**的编辑视图。有一些字段可以更改。由于我们使用的是**Chat Trigger**节点,因此提示的来源和规范的默认设置无需更改。 ![49013383-8ce0-4a9f-82c7-61aec7cba670.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/49013383-8ce0-4a9f-82c7-61aec7cba670.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=fba2a60f21d01c04bbb6b724065722cd) **3. 返回画布** 选择返回画布,添加 AI Agent 节点成功。 ![371d2007-0519-4dee-bd4d-dbea602d906b.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/371d2007-0519-4dee-bd4d-dbea602d906b.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=bc44559b8ff29eade0b9375eac521709) ### 添加 PPIO API 凭证 AI Agent 需要附加聊天模型来处理输入的提示。 **1. 添加聊天模型** 单击 AI 代理节点上的聊天模型的加号添加聊天模型。随即会出现「语言模型」的搜索对话框。这些是 n8n 内置支持的大模型。我们拉到最下方,选择 OpenAI Chat Model,以此来添加 PPIO 的模型(跟 OpenAI API 协议兼容)。 ![ce53609b-0361-4a92-9ba5-417d1dcd2cfb.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/ce53609b-0361-4a92-9ba5-417d1dcd2cfb.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=300bbabf68bbadad59e3b65ff76a94f2) **2. 添加凭证** 打开节点编辑器,为 PPIO 模型添加凭证,以此来让 n8n 与 PPIO 模型建立通信连接。此处的凭证,就是前面准备的 PPIO Base URL 以及 API Key。 ![eef430e0-59d7-45d0-a5dd-b19934bcc41f.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/n8n/eef430e0-59d7-45d0-a5dd-b19934bcc41f.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=4fe7e12c00ecffa627df0cb41282c51f) **3. 填写 API Key 与 Base URL** **到了最关键的一步**:新凭证可自定义名称,然后将提前准备好的 PPIO API Key 以及 Base URL 填写进去并保存。保存之后会弹出连接成功的提示。 ![download.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/download.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=c3cf392786e2e5b56eef1d46e948875a) ![56927b06-5fcf-4dd0-96ec-dafbe0bd2397.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/56927b06-5fcf-4dd0-96ec-dafbe0bd2397.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=42940542c2d5ad56fc110faee53da251) **4. 选择模型** 返回上一步,此时会看到在模型 list 里出现 PPIO 支持的模型列表。我们选择 DeepSeek V4 Pro 作为演示实例。 ![89e3259f-ff4f-4a25-af4d-cd6934e00fa3.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/89e3259f-ff4f-4a25-af4d-cd6934e00fa3.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=04b5bb37b6d79bb2843785c1846b9f00) **5. 返回画布确认** 返回画布,此时看到聊天模型已经添加成功。 ![3888287d-1f37-4bca-92f5-298cc9edba3a.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/3888287d-1f37-4bca-92f5-298cc9edba3a.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=2c2c745cc60f6f580f4192b3cd378f89) ### 测试节点 节点已连接到**聊天触发器**和聊天模型,点击 Open chat 测试工作流。输入问题后,聊天模型的响应出现在消息下方,日志窗口显示 AI 代理的输入和输出。回答成功后,工作流会显示绿色。 ![31dd4fd3-3a5b-4d68-b68b-457e79d9d5ec.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/31dd4fd3-3a5b-4d68-b68b-457e79d9d5ec.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=8452b98d8d90881e51b193480cf1dca0) 到此,一个简单的聊天机器人 Agent 就配置完成了。 ### 更改节点设置 除基本配置外,还有更个性化的参数设置。 聊天机器人默认的角色是一位「乐于助人的助手」,在 AI Agent 节点的「系统消息(System Message)」里设置,可以改变聊天机器人的初始设置,实现不同风格的聊天。 ![cefe1ddd-a26e-4fea-9df9-8b9e062f526f.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/cefe1ddd-a26e-4fea-9df9-8b9e062f526f.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=5c32815155aa510866534617dafc74c3) 将其改为「你是一位才华横溢的诗人,总是用押韵的对句回复」。 ![aec407ce-1891-499e-b72b-739f86b02ebe.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/aec407ce-1891-499e-b72b-739f86b02ebe.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=48d6984b5edebeee322726f74e5a3b29) 再次问「你好吗」,效果如下: ![5a4a3767-5001-43cd-99dd-dd68e07b20a4.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/5a4a3767-5001-43cd-99dd-dd68e07b20a4.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=bdcb044dbd22cd8665e334fbae5d36f2) ### 添加记忆功能 聊天模型现在能给出有用的输出,但存在一些问题。比如,当你告诉聊天模型你的名字,例如「嗨,我叫路易」,等模型回复你之后,再次询问「我叫什么名字?」,AI 无论如何都无法回答你。 这是因为 n8n 的 AI Agent 工作流默认没有保存上下文,AI Agent 没有记忆。 要记住对话内容,AI Agent 需要保存上下文。可以在 **AI Agent** 节点中添加内存来实现。 **1. 添加简单内存** 在 **AI Agent** 节点底部的记忆节点点击 + 号。在出现的面板中,选择「简单内存」。这将使用运行 n8n 实例的内存,通常足以满足简单使用需求。 ![9a6fdcae-0d9b-4b70-99a7-cf1a5dd1a814.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/9a6fdcae-0d9b-4b70-99a7-cf1a5dd1a814.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=0b7d2b224f75647c92ac1b9ad54130b4) **2. 保持默认参数** 参数不用修改,默认为 5 次交互,然后返回画布。 ![dd687e26-dfc8-46d4-87f2-2aba6523f860.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/dd687e26-dfc8-46d4-87f2-2aba6523f860.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=bd42ae9975677c61ce07d84fbff65ff6) **3. 验证记忆效果** 此时,当你告知模型你的名字后,它就会记住。 ![cb19baed-1aa8-4584-adaa-b1d333395168.png](https://mintcdn.com/ppinfra/jwiFAWARXu14XQMl/third-party/images/n8n/cb19baed-1aa8-4584-adaa-b1d333395168.png?fit=max\&auto=format\&n=jwiFAWARXu14XQMl\&q=85\&s=e165df7f3dc3df49ebf30cfcdfce296d) **4. 保存工作流** 最后,在离开之前保存工作流。 至此,将 PPIO API 集成到 n8n 工作流的方式已经完成。 # Obsidian 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/obsidian-use 查阅 Obsidian 接入 PPIO LLM API 的指南,了解笔记工具中的模型连接与设置方式,为知识整理流程使用 AI 能力提供参考。 Obsidian 是以 Markdown 为核心的笔记工具,数据保存在本地文件夹,用双向链接生成知识图谱,插件市场可扩展功能。 PPIO DeepSeek API 提供 DeepSeek 推理能力,调用接口即可接入,数据全程加密。适用于智能笔记插件、私有化知识助手、离线 AI 功能等场景,3 步完成接入。 下方教程包含完整接入方案(含密钥配置),3 分钟完成「Word + PPIO 高性能 API」接入。 ## PPIO x Obsidian 图文使用教程 ### 配置前置条件 **1. 获取 API 接口地址** 固定为:[https://api.ppio.com/openai/v1/chat/completions](https://api.ppio.com/openai/v1/chat/completions) **2. 获取 API 密钥** 登录派欧云控制台 [API密钥管理](https://ppio.com/settings/key-management) 页面,点击创建按钮。 ![1.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/obsidian/1.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=6fbb58808e3ae01bf69c615443d19f40) **3. 生成并保存 API 密钥** **注意**:密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建新的密钥。 ![2.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/obsidian/2.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=e5aeb81873879a91d9360723ff91331d) ![3.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/obsidian/3.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=8544894defbc5f903a12ec6e74af84a5) **4. 获取需要使用的模型 ID** deepseek 系列: DeepSeek V4 Pro:deepseek/deepseek-v4-pro DeepSeek V4.1 Flash:deepseek/deepseek-v4.1-flash 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ### 添加模型 **1. 来到应用界面,点击【设置】** ![4.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/obsidian/4.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=30c494f8004a75d3eb10c2c618ea334d) **2. 浏览社区插件** 点击【Community plugins】→【Browse】。 ![5.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/obsidian/5.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=b2cc37031a86d5773c29c6ad3d28f948) **3. 搜索 Copilot 插件** 在搜索栏输入「Copilot」,点击【Copilot】插件。 ![6.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/obsidian/6.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=f4582005ab3f69c4029272d40f7c3b27) **4. 安装插件并点击 Options** 点击【Install】,页面跳转后点击【Options】。 ![7.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/obsidian/7.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=7a37a37227a426add7a79945f6c8cd68) ![8.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/obsidian/8.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=7d2c8c521378c298b1fd34b17f4cbf56) **5. 添加自定义模型** 点击【Model】下拉选择【Add Custom Model】。 ![9.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/obsidian/9.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=89f19f52056d8fd91d81ea5dcab196cc) ![10.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/obsidian/10.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=c8e036c29989acafbba7e839fd96715d) **6. 填写模型配置** 在【Model Name】处输入官网模型名称:deepseek/deepseek-v4-pro,复制与图片一致即可;在【Display Name】处自定义创建的名称,如:PPIO-DeepSeek V4 Pro;在【Provider】处选择【OpenAI Format】;在【Base URL】处输入:[http://api.ppio.com/openai;在【API](http://api.ppio.com/openai;在【API) Key】处输入官网生成的密钥,显示连接成功即可开始使用 ![11.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/obsidian/11.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=febe120df04a057a543eee88487c0c27) # PPIO X OpenDesign:10 万星开源设计 Agent,落地你的想象力 Source: https://ppio.com/docs/third-party/open-design 按照 OpenDesign 接入教程配置 PPIO LLM API,了解 API Key、Base URL、模型 ID 和模型供应商设置,以及企业 Token Plan 与 Fusion 融合模型在 AI 设计工作流中的使用。 ![20261112-132304.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/open-design/hero.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=6f732f633aeebf603e2c04cd37963e49) 要通过 AI 工具做一个设计产品,常常不是从画布开始,而是从整理上下文开始。 你要把需求、品牌风格、页面结构和参考案例交给 AI 工具,再等待云端生成。如果结果不对,就重新描述、重新生成;想换模型、迁移文件或继续开发时,还可能遇到格式、订阅和数据边界的限制。 而 OpenDesign 可以改变这套云端平台绑定的工作方式。 它把设计编排、预览和文件管理放回本地,并允许用户调用已经安装的 AI 编程助手作为生成引擎。你仍然可以使用熟悉的模型和 API 服务,却不必把整个创作流程锁在某一个设计平台里。**截至 2026 年 11 月 11 日,OpenDesign 在GitHub 仓库已获得约 10.7 万 Stars。** 如果你希望 AI 不只生成一张效果图,而是交付能够继续修改、演示和开发的设计成果,OpenDesign 值得认识一下。 ![WPS图片(1).png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/open-design/opendesign-overview.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=3a3aa25bfdd9dfbc7505c70524d8b763) ## 01 认识 OpenDesign: 本地优先的开源 AI 设计工作台 OpenDesign 是一款开源、本地优先的 AI 设计工作台。它不是创造一个封闭的云端画布,而是把你已经在用的编程 Agent、设计资料和项目文件放进同一套工作流里,让一句需求真正变成可运行、可修改的网页、原型、演示文稿或动效作品。 ### 它不是模型,而是 AI 设计流程的“总导演” OpenDesign 本身不负责“思考”,而是负责组织过程:接收 brief,调取设计系统和 Skill,把任务交给 AI Agent,再承载预览、修改与评审。 官网目前已经为 **22 个 AI Agent** 提供设计工作流指南,覆盖 Claude Code、Codex、Cursor、Gemini CLI、OpenCode、Kimi CLI、Qwen Code、Trae CLI、Qoder、Kilo、Pi 等工具。你不必重新适应一套陌生的 AI,只要把自己常用的 Agent 接进来,就能让它从“会写代码”进一步变成“能做设计”。 ![ScreenShot_2026-11-11_182956_571.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/open-design/supported-agents.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=e9760d3c70820a5ae8fdef29e7820903) ### 278 个设计系统参考,让 AI 不再只会模仿风格 去让 AI 做设计,常见做法是在提示词里写一句“像 Apple”或“参考 Linear”,最终效果往往只有表面相似。 OpenDesign 官网的设计系统目录目前已扩展到 **278 个条目**,覆盖配色、字体、间距、组件、布局和交互规则。除了直接选用参考,OpenDesign 还能从网站或已有设计中提取视觉语言,整理成 DESIGN.md、CSS Tokens 和 UI Kit,让一次设计沉淀为下一次生成可以继续复用的规范。 ![ScreenShot_2026-11-11_183344_991.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/open-design/design-systems.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=f07e1f2ecdda4a83f0f25b79241b8b9b) ### 296 个设计 Skill,把 Agent 的设计能力真正铺开 OpenDesign 官网目前收录 **296 个设计 Skill**,整理自 84 个开源仓库,覆盖网站、应用界面、品牌系统、演示文稿、动效视频、组件设计、排版审查和设计验收等任务。 这些 Skill 不是简单的功能名称,而是一套套可以交给 Agent 执行的工作方法。用户可以根据任务、交付成果和工具要求选择并导入,让 AI 知道先做什么、怎样检查、最后交付什么。部分 Skill 需要额外软件或服务,但也正因如此,OpenDesign 的能力可以随着开源生态不断扩展,而不必等待平台更新。 ![ScreenShot_2026-11-12_102347_729.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/open-design/design-skills.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=4ca9fa5fbce5a11b573e224ffa4cc48f) ## 02 简单三步,在 Open Design 中接入 PPIO ### 第一步 创建并保存 PPIO API Key 首先注册一个 PPIO 账号,通过专属链接注册还可以获得 ¥50 代金券: [https://ppio.com/activity/open_design](https://ppio.com/activity/open_design) 注册并登录后进入 API 密钥管理页面创建 API Key。 ![ScreenShot_2026-11-11_162152_429.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/open-design/api-key-management.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=4d39afe91b7712a89d371a385273bc97) ![新.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/open-design/api-key-created.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=a0e5170ec3c68f0f0818ffb9bfef3441) ### 第二步 选择模型并确认接口地址 进入 PPIO 模型广场,选择准备使用的模型,在详情页复制完整的 Base URL 和 Model ID。 ![ScreenShot_2026-11-12_101426_651.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/open-design/model-api-guide.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=e9b0626a32096ab019da48d0763ad9e5) ### 第三步 在 OpenDesign 中添加自定义服务商 安装 OpenDesign 后,打开设置页面并进入 模型与供应商,选择 API 提供商并找到 PPIO,**将接口地址(即 Base URL)、API Key 和模型名称(即 Model ID)依次填入即可。** ![ScreenShot_2026-11-12_101604_787.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/open-design/provider-settings.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=5389ef978103cbeb49d982c2223627fa) ## 03 订阅 PPIO 企业 Token Plan,旗舰模型低至 6 折 PPIO 企业 Token Plan 是一套标准化的预付费折扣产品,核心机制是“融合 Token”:以 DeepSeek V4 Flash 输入 Token 为基准单位(系数 1.000),其他模型按照各自的抵扣系数折算消耗,共用同一套余额。 PPIO 企业 Token Plan 支持 200+席位,特别适合中小 AI 开发者团队。**OpenDesign 负责把设计任务组织成可预览、可迭代、可协作的工作区;PPIO 负责提供可选择的模型、标准接口和用量管理。**把二者连接起来,就能把热门开源设计 Agent 变成自己的产品设计工作台。 PPIO 企业 Token Plan 目前覆盖了 17 款模型,包括 DeepSeek V4 Flash 正式版、Kimi K3、GLM-5.2、MiniMax M3 等国产开源旗舰模型在内的全系列模型。后续,新模型上线也将及时同步更新到订阅包中。 PPIO 企业 Token Plan 分三档(见下图),三档基准单价相同,均为 ¥0.95/Mtoken,差异在于 Token 配额、并发上限和服务级别。具体折扣幅度因模型而异 —— DeepSeek 系列约 9 折,Qwen 3.5、GLM-5.2 等官方定价偏高的模型可低至 5\~6 折,综合成本节省空间最高接近一半。 ![rYal2cXe.png](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/open-design/token-plan.png?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=8835022be808a9a619ead7f446780387) ## 04 Fusion 融合模型已上线,用 1/10 的价格超越顶级模型的智商 除了常规模型之外,PPIO 最新上线的 Fusion 融合模型也已支持接入 OpenDesign。 Fusion 融合模型是 PPIO 智能模型网关提供的多模型融合推理能力。调用融合模型时,网关不会只询问一个模型,而是将请求同时分发给多个各需要长的“专家模型”作答,再通过思考编排与交叉验证,由主模型生成最终答案——汇聚模型每次调用都变成一次“专家会诊”。与只做简单请求转发的传统 API 网关不同,融合模型以智能优先、兼顾算计:通过工程化的融合手段,把答案质量稳定放在头部旗舰模型梯队,同时把成本控制在中低梯队。 在 DRACO 深度研究基准测试中,PPIO Fusion 融合模型以 Kimi K3、GLM 5.2、MiniMax M3 为参考模型(Advisors)、DeepSeek V4 Flash 为融合主模型(Aggregator)进行融合推理,超越了 Claude Fable 5,而总成本接近其约 1/10。Fusion 融合模型提供 OpenAI 兼容接口,Base URL 无需改变,只需要将模型名称设置为 `pprouter/fusion` 即可。 # OpenCode 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/opencode 了解 OpenCode 接入 PPIO LLM API 的配置流程,查阅编程工具调用模型服务的方式,为 AI 代码任务提供接入参考。 OpenCode 是一款 AI 编程工具,支持通过自定义提供商连接 OpenAI-compatible endpoint。在 OpenCode 中配置 PPIO 派欧云的大语言模型 API,可用于代码生成、调试、重构和项目问答。 ## 前置准备 开始前,请先准备以下信息: * **API Key**:前往 [API 密钥管理](https://ppio.com/settings/key-management) 创建或复制 API Key。 * **Base URL**:`https://api.ppio.com/openai/v1` * **Model ID**:前往模型广场或模型详情页,复制需要使用的模型 ID,例如 `deepseek/deepseek-v4.1-flash`。 ## 安装 OpenCode OpenCode 提供命令行与桌面端,任选一种方式安装。 ### Linux / macOS / WSL2 任选一种安装方式: ```bash theme={null} curl -fsSL https://opencode.ai/install | bash ``` ```bash theme={null} brew install anomalyco/tap/opencode ``` ```bash theme={null} npm i -g opencode-ai ``` ### Desktop 也可访问 OpenCode 下载页面安装桌面端: ```text theme={null} https://opencode.ai/download ``` ## 配置自定义提供商 打开 OpenCode 设置页,找到提供商配置入口。不同版本入口名称可能略有差异,通常位于 **Settings** → **Providers** → **Custom Provider**。 填写以下信息: | 配置项 | 值 | | :- | :- | | Display name | `PPIO` | | Base URL | `https://api.ppio.com/openai/v1` | | API Key | 您的 PPIO API Key | | Model ID | 例如 `deepseek/deepseek-v4.1-flash` | > [!TIP] > > Model ID 需与 PPIO 模型详情页中的名称完全一致。不同模型的上下文长度、价格和能力以模型详情页为准。 ## 验证模型 完成配置后,在 OpenCode 中选择刚添加的 PPIO 模型,并输入一条测试消息: ```text theme={null} 请用一句话介绍你可以帮助我完成哪些编程任务。 ``` 模型正常回复说明配置已生效。若验证失败,请检查: * API Key 是否正确且账户余额可用。 * Base URL 是否填写为 `https://api.ppio.com/openai/v1`。 * Model ID 是否正确。 * 当前网络是否可以访问 PPIO API endpoint。 # OpenManus 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/openmanus-use 按照 OpenManus 集成指南连接 PPIO LLM API,了解 Agent 应用的模型配置与调用方式,为智能体任务执行提供参考。 Manus 是近期出现的 AI Agent,仅凭一个 Demo 视频就造成邀请码一码难求。 MetaGPT 团队用 3 小时复刻并推出开源版本 OpenManus,在 GitHub 上已获得近 28k star。 PPIO 派欧云提供高性能 API 服务,涵盖 DeepSeek、Qwen、GLM、Kimi 等系列模型,一行代码即可调用,支持在 Chatbox、AnythingLLM、RAGFlow 等 20+ 个第三方平台调用。 以下教程从环境配置到接入 PPIO,约 10 分钟完成 OpenManus 部署。 ## 配置前置条件 **1. 获取 API Base URL** 获取【API Base URL】:固定为:[https://api.ppio.com/openai](https://api.ppio.com/openai) **2. 获取 API Key** 获取【API Key】:登录派欧云控制台[API密钥管理](https://ppio.com/settings/key-management)页面,点击创建按钮。 ![1.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/openmanus/1.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=f12aae47c090340ddf5ccb83577c6f72) **3. 生成并保存【API密钥】** **注意**:密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建新密钥。 ![2.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/openmanus/2.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=8bcab6abc76eeb320de9b3defb6e21a7) ![3.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/openmanus/3.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=88e417ecbbc95928089b7a633fe8e055) **4. 获取模型 ID** 获取需要使用的模型 ID,推荐使用: * deepseek/deepseek-v4-pro * deepseek/deepseek-v4.1-flash * qwen/qwen3.8-max * zai-org/glm-5.3 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ## **安装 OpenManus** 在 PPIO 官网准备好信息后,安装步骤参考:[安装指南](https://github.com/FoundationAgents/OpenManus/blob/main/README_zh.md#%E5%AE%89%E8%A3%85%E6%8C%87%E5%8D%97)。以下以 Windows 系统、安装指南中的「方式二」为例。 **1. 克隆存储库** 继续在系统 command prompt 中克隆存储库 ``` git clone https://github.com/mannaandpoem/OpenManus.git cd OpenManus ``` **2. 创建并激活虚拟环境** 创建一个新的虚拟环境并激活它: ``` uv venv source .venv/bin/activate # On Unix/macOS # Or on Windows:# .venv\Scripts\activate ``` **3. 安装依赖项** ``` uv pip install -r requirements.txt ``` ## **配置 OpenManus** **1. 创建 config.toml** 在目录中创建一个`config.toml`文件`config` ``` cp config/config.example.toml config/config.toml ``` **2. 编辑 config.toml** 编辑`config/config.toml`,更改【model】、【base_url】、【api_key】。 可修改【api_key】后,将下列代码粘贴到`config.toml` ``` Global LLM configuration [llm] model = "qwen/qwen3.8-max" #如需更改模型,复制PPIO官网模型名称在此 base_url = "https://api.ppio.com/openai" api_key = "在此处粘贴PPIO官网的API Key" # 此处更改 max_tokens = 4096 temperature = 0.0 ``` ![4.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/openmanus/4.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=adc8865b5a1ebd77d4b00132fb08e60b) **3. 运行 OpenManus 并输入需求** 运行 OpenManus,然后在 `enter your prompt` 后输入需求 ``` python main.py ``` ## 运行效果展示 启动成功后,输入一个生成旅行计划的 prompt: I need a 7-day Japan itinerary for April 15-23 from Seattle, with a \$2500-5000 budget for my fiancée and me. We love historical sites, hidden gems, and Japanese culture (kendo, tea ceremonies, Zen meditation). We want to see Nara's deer and explore cities on foot. I plan to propose during this trip and need a special location recommendation. Please provide a detailed itinerary and a simple HTML travel handbook with maps, attraction descriptions, essential Japanese phrases, and travel tips we can reference throughout our journey. **终端页面效果展示** ![5(1).jpg](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/openmanus/5\(1\).jpg?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=42c15b7338efe6ea76dc850248f0a3a2) **前端页面效果展示** OpenManus 也提供前端界面。在项目目录下切换到 "front-end" 分支并重新安装依赖,运行 python app.py,成功后在浏览器访问:[http://localhost:5172/](http://localhost:5172/),即可使用前端界面。 ![6.jpg](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/openmanus/6.jpg?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=7651d0f84e31cb22574a5954fa52866b) 以上步骤完成后,PPIO API 已接入 OpenManus。 # 欧路词典 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/oulucidian-use 查阅欧路词典接入 PPIO LLM API 的配置说明,了解词典工具使用模型服务的方式,为语言学习和文本处理场景提供参考。 DeepSeek 的推理能力正在刷新 AI 技术的想象力,但比起参数竞赛,我们更在意如何让它真正融入日常工具。以欧路词典为例,没有冗余广告,秒速启动响应,用海量词库和拍照翻译覆盖语言学习全场景。这种「快而干净」的体验,才是用户需要的技术温度。 **PPIO DeepSeek API** 将这种理念带给所有开发者。无需理解复杂的模型架构,不必担忧数据隐私风险,只需调用极简接口: * 内置 DeepSeek 多语言理解能力,让翻译、语法检查、内容生成更精准; * DeepSeek 的 AI 翻译,告别传统 AI 服务的高延迟与死板。 下方教程包含完整接入方案(含密钥配置),3 分钟开启「欧路词典 + PPIO 高性能 API」的代码进阶模式 ## PPIO x 欧路词典 图文使用教程 ### 配置前置条件 **1. 获取 API 接口地址** 固定为:[https://api.ppio.com/openai/v1/chat/completions](https://api.ppio.com/openai/v1/chat/completions) **2. 获取 API 密钥** 登录派欧云控制台 [API密钥管理](https://ppio.com/settings/key-management) 页面,点击创建按钮。 ![1.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oulucidian/1.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=20574966804d876b395e57a6d21a473d) **3. 生成并保存 API 密钥** **注意**:密钥在服务端是加密存储,请在生成时保存好密钥;若遗失可以在控制台上删除并创建一个新的密钥。 ![2.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oulucidian/2.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=948c4393fd2c99496c37a54461896cea) ![3.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oulucidian/3.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=f1ff0c1afc63d50cbe53e155e5a79fb8) **4. 获取需要使用的模型 ID** deepseek 系列: DeepSeek V4 Pro:deepseek/deepseek-v4-pro DeepSeek V4.1 Flash:deepseek/deepseek-v4.1-flash 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ### 添加翻译引擎 **1. 打开引擎设置** 进入官方页面,点击【设置】→【引擎设置】。 ![4.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oulucidian/4.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=e73e32550b3c801cd5f04d612306769f) **2. 选择自定义引擎** 下拉选择【自定义】。 ![5.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oulucidian/5.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=4851265c6efe405f1cb9e26506d49353) **3. 填写自定义引擎信息** 【名称】处输入自定义名称,如:PPIO-DeepSeek V4 Pro;【API Key】处输入:在官网生成的密钥;在【自定义API接口地址】输入地址与图片一致;在【自定义模型名】输入官网模型名称和图片一致。 ![6.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oulucidian/6.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=8e663a5928fecf58ea2e249a54d049b8) **4. 保存并开始使用** 最后点击【保存】,即可正常使用。 ![7.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/oulucidian/7.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=21d018668be957740a1a6bc9b5572d4f) # 教程概览 Source: https://ppio.com/docs/third-party/overview 浏览 PPIO 第三方工具接入教程,查找编程助手、聊天客户端、知识工具与工作流平台的模型配置指南,选择适合应用的集成方式。 派欧云支持多种热门工具接入 PPIO LLM API,并提供了详细的接入教程,帮助您快速上手。 ## 开发工具 * [Apifox](/docs/third-party/Apifox-use) * [AstrBot](/docs/third-party/AstrBot-use) * [CC Switch](/docs/third-party/cc-switch) * [Claude Code](/docs/third-party/claude-code) * [Codex](/docs/third-party/codex) * [Cline](/docs/third-party/cline-use) * [Cursor](/docs/third-party/cursor-use) * [Deepchat](/docs/third-party/deepchat-use) * [DeepSeek Harness](/docs/third-party/deepseek-harness) * [Dify](/docs/third-party/dify-use) * [Hermes](/docs/third-party/hermes) * [Kilo Code](/docs/third-party/kilo-code) * [LangBot](/docs/third-party/langbot-use) * [n8n](/docs/third-party/n8n-use) * [OneAPI](/docs/third-party/OneAPI-use) * [OpenAI Agents SDK](/docs/third-party/OpenAI-Agents-SDK) * [OpenCode](/docs/third-party/opencode) * [OpenDesign](/docs/third-party/open-design) * [Pi](/docs/third-party/pi-use) * [Qoder](/docs/third-party/qode) * [RuoYi AI](/docs/third-party/RuoYiAI-use) * [Trae](/docs/third-party/trae-use) * [UI-TARS](/docs/third-party/UI-TARS-use) ## 对话助手 * [Chatbox](/docs/third-party/chatbox-use) * [WPS 灵犀](/docs/third-party/lingxi-use) * [ChatHub](/docs/third-party/chathub-use) * [ChatWise](/docs/third-party/chatwise-use) * **Cherry Studio** * [Cherry Studio 接入 LLM API](/docs/third-party/cherry-studio-use) * [Cherry Studio 接入 Embedding API](/docs/third-party/cherry-studio-embedding) * [LobeChat](/docs/third-party/lobechat-use) * [Siri](/docs/third-party/siri-use) ## 知识检索与问答 * [AnythingLLM](/docs/third-party/anythingllm-use) * [Deep Searcher](/docs/third-party/deepsearcher-use) * [FastGPT](/docs/third-party/fastgpt-use) * [GPT4All](/docs/third-party/GPT4All-use) * [RAGFlow](/docs/third-party/ragflow-use) ## 智能体 * [OpenManus](/docs/third-party/openmanus-use) ## 翻译工具 * [沉浸式翻译](/docs/third-party/immersive-translate-use) * [欧路词典](/docs/third-party/oulucidian-use) ## 阅读工具 * [沉浸式导读](/docs/third-party/chenjinshidaodu-use) * [流畅阅读](/docs/third-party/liuchangyuedu-use) ## 笔记工具 * [Obsidian](/docs/third-party/obsidian-use) * [思源笔记](/docs/third-party/siyuanbiji-use) ## 文档工具 * [Microsoft Word](/docs/third-party/word-use) * [WPS Office AI](/docs/third-party/wps-office-ai-use) * [Zotero](/docs/third-party/Zoter-use) # PPIO × Pi:极简编码 Agent,定制你的工作流 Source: https://ppio.com/docs/third-party/pi-use 按照 Pi 接入教程配置 PPIO LLM API,了解 API Key、接口地址和 models.json 的设置方式,在终端中使用 Kimi K3 与 Fusion 融合模型完成代码分析和工具调用。 ![PPIO × Pi:极简编码 Agent,定制你的工作流](https://mintcdn.com/ppinfra/ssyXDxnW17EHVzfX/third-party/images/pi/hero.png?fit=max\&auto=format\&n=ssyXDxnW17EHVzfX\&q=85\&s=601e15e9b1606867c6a4baf9ca647228) AI 编程 Agent 参与的工作范围正在扩大,包括阅读代码、定位问题、修改文件和运行测试。 如果习惯在终端里工作,并且希望自己决定使用什么模型、接入哪些工具、怎样组织开发流程,可以考虑 PI Agent(以下简称 Pi)。 Pi 是一款面向开发者的极简编码 Agent,由 libGDX 创始人 Mario Zechner 发起。他认为 Claude Code 功能过多,**80% 的功能自己用不上**,且每次发版都改动系统提示词和工具,打断工作流,于是决定自己写一个。同类产品在增加功能,Pi 则相反,秉持「less is more」的设计哲学,实现「让 Pi 适应你的工作流」。 ![Pi Agent 项目介绍](https://mintcdn.com/ppinfra/ssyXDxnW17EHVzfX/third-party/images/pi/pi-overview.png?fit=max\&auto=format\&n=ssyXDxnW17EHVzfX\&q=85\&s=d822b1c71f32e9f788d5cd386283bb13) ## 认识 Pi Agent:让 Agent 适应你的工作流 Pi 采用 MIT 开源协议,连接模型请求、工具执行、上下文组织和会话记录,开发者可在此基础上构建自己的工作方式。 ### 模型选择开放,同一个会话中也能切换 Pi 支持 15 家以上模型服务商、数百款模型,覆盖 Anthropic、OpenAI、Google、Azure、Bedrock、Mistral、OpenRouter、Ollama 等服务或运行环境,可通过 API Key 或 OAuth 认证。 对于内置列表之外的模型服务,Pi 支持通过 `models.json` 或扩展添加自定义服务商和模型。本文接入 PPIO 即使用这套机制。 ### 从需求到执行,形成连续的工作过程 Pi 提供读取文件、执行命令、编辑和写入文件等基础工具。收到任务后,它结合当前对话、项目指引和可用工具向模型发起请求;模型返回工具调用后,Pi 执行相应操作,再将结果交给模型继续处理。 例如,让 Pi 阅读项目说明和相关代码,分析一个接口报错,修改实现,再运行测试。若测试仍失败,它可根据新的输出继续分析。模型负责理解问题和决定下一步,Pi 负责组织执行过程,并记录消息、工具调用及其结果。 ### 上下文由你组织,会话历史也可树状回看 编程任务涉及规范、决策、大量文件与工具输出,Pi 提供几种控制方式:`AGENTS.md` 放项目约定,启动即加载;`SYSTEM.md` 与 `APPEND_SYSTEM.md` 替换或追加系统指令;Skills 按需加载,需要时才读全文;接近上限自动压缩,`/compact` 可指定保留重点,原始消息仍留在记录里。扩展还能注入信息、筛选历史或接入 RAG。 对话过程完整保留为树状结构。通过 `/tree` 可返回之前的对话节点,从那里继续尝试另一条思路。多个分支可保存在同一个会话文件中,也能按消息类型筛选记录,为重要节点添加标签。 ### 定制能力与运行方式,能力边界由你决定 Pi 将常见定制需求拆成几种资源,可按需组合: ![Pi 的定制资源](https://mintcdn.com/ppinfra/ssyXDxnW17EHVzfX/third-party/images/pi/customization-resources.jpeg?fit=max\&auto=format\&n=ssyXDxnW17EHVzfX\&q=85\&s=f00508885c6cfe9c38513ddd7ba872d6) 从终端到应用的四种运行模式: ![Pi 的四种运行模式](https://mintcdn.com/ppinfra/ssyXDxnW17EHVzfX/third-party/images/pi/runtime-modes.jpeg?fit=max\&auto=format\&n=ssyXDxnW17EHVzfX\&q=85\&s=a7fd55e5b4da787f7e2d8d1ec060d445) 外部工具可通过两条路径接入。Pi 已内置 MCP,可连接通过 MCP 提供的外部工具,具体能访问哪些系统、执行哪些操作,取决于配置的 MCP 服务及其提供的能力。 已有内部 API、知识库或自动化工具的团队,可通过 MCP 与扩展把这些能力接入 Pi,让模型结合项目文件和外部信息完成任务。 ## 简单三步,在 Pi 中接入 PPIO ### 创建 PPIO API Key 打开 [PPIO 官网](https://ppio.com/),注册并登录账号,进入 [API 密钥管理页面](https://ppio.com/settings/key-management),创建并保存 API Key。 ![PPIO API 密钥管理](https://mintcdn.com/ppinfra/ssyXDxnW17EHVzfX/third-party/images/pi/api-key-management.png?fit=max\&auto=format\&n=ssyXDxnW17EHVzfX\&q=85\&s=eab4fd78dbc3ab5bdbbbbcdfb9587fa2) ![创建并保存 PPIO API Key](https://mintcdn.com/ppinfra/ssyXDxnW17EHVzfX/third-party/images/pi/api-key-created.png?fit=max\&auto=format\&n=ssyXDxnW17EHVzfX\&q=85\&s=4aca5c8b78a5102c49dd9791554948a9) 该密钥用于验证调用身份。请妥善保管,并确认账号有可用额度、密钥有权访问准备使用的模型。 ### 选择模型,确认接口地址 **1. 选择模型并查看接入指南** 进入 [PPIO 模型广场](https://ppio.com/ai-computing/llm-api),选择需要使用的模型,在详情页找到 API 接入指南。 ![在 PPIO 模型广场选择模型](https://mintcdn.com/ppinfra/ssyXDxnW17EHVzfX/third-party/images/pi/model-selection.png?fit=max\&auto=format\&n=ssyXDxnW17EHVzfX\&q=85\&s=10a5c3949101138c3cd060d73c3ad8ab) ![查看模型 API 接入指南](https://mintcdn.com/ppinfra/ssyXDxnW17EHVzfX/third-party/images/pi/model-api-guide.png?fit=max\&auto=format\&n=ssyXDxnW17EHVzfX\&q=85\&s=fe338c1f3b5144fb4845e1db15105bf8) Pi 需要通过工具调用来读取文件、执行命令,因此应选择支持 **Function Calling** 的模型。 **注意接口地址的拼接方式。** PPIO 页面展示的服务根地址为 `https://api.ppio.com/openai`,Chat Completions 接口路径为 `/v1/chat/completions`。Pi 使用的 OpenAI SDK 会在 `baseUrl` 后追加 `/chat/completions`,因此本文配置中保留 `/v1`,使最终请求落到正确的接口。 **2. 复制 Model ID** Model ID 请从模型详情页复制,保留完整的厂商前缀与版本信息。 ### 安装 Pi,添加模型配置 本文按 **Pi 1.4.0** 的配置方式编写,需要 **Node.js 22.19.0 或更新版本**。Pi 当前官方 npm 包为 `@earendil-works/pi-coding-agent`。 **1. 安装 Pi** 在终端执行: ```bash theme={null} npm install -g --ignore-scripts @earendil-works/pi-coding-agent@1.4.0 pi --version ``` **2. 设置 API Key 环境变量** 下面的终端命令以 macOS / Linux 为例。先将 API Key 设置为环境变量,把占位内容替换为自己的密钥: ```bash theme={null} export PPIO_API_KEY="替换为你的 PPIO API Key" ``` Windows PowerShell 对应写法为: ```powershell theme={null} $env:PPIO_API_KEY = "替换为你的 PPIO API Key" ``` 以上设置仅对当前终端会话及其启动的程序生效,后续也要在已配置该变量的终端中启动 Pi。 **3. 编辑 models.json** 接着,在用户目录下创建或编辑 `.pi/agent/models.json`,即默认路径 `~/.pi/agent/models.json`,填入以下内容。如果文件中已有其他服务商配置,将 `ppio` 合并到原来的 `providers` 中即可。 ```json theme={null} { "providers": { "ppio": { "baseUrl": "https://api.ppio.com/openai/v1", "api": "openai-completions", "apiKey": "$PPIO_API_KEY", "compat": { "supportsStore": false, "supportsDeveloperRole": false, "maxTokensField": "max_tokens" }, "models": [ { "id": "moonshotai/kimi-k3", "name": "PPIO · Kimi K3" } ] } } } ``` 这里的 `apiKey` 使用 Pi 当前版本支持的环境变量引用语法,`PPIO_API_KEY` 会读取前面设置的密钥;`compat` 则让请求使用常见的兼容字段。示例采用基础模型配置,如需使用更长上下文、图像输入或调整思考强度,可按 Pi 与具体模型的文档补充相应参数。 **4. 启动 Pi 并选择模型** 保存后,进入准备处理的项目目录并启动 Pi: ```bash theme={null} cd /你的项目目录 pi --provider ppio --model moonshotai/kimi-k3 ``` 也可以在 Pi 中输入 `/model`,搜索并选择 PPIO · Kimi K3。打开模型选择器时,Pi 会重新读取模型配置。 ![在 Pi 中选择 PPIO · Kimi K3](https://mintcdn.com/ppinfra/ssyXDxnW17EHVzfX/third-party/images/pi/kimi-model-selection.png?fit=max\&auto=format\&n=ssyXDxnW17EHVzfX\&q=85\&s=6ba7a37bf6b496b4dd633d9e195938f6) **5. 验证工具调用** 接下来,先尝试一个简单任务: > 请读取当前项目的 README,概括项目用途和启动方式,不修改文件。 如果项目没有 README,可以改为读取一个确定存在的文本文件。观察 Pi 是否实际调用了读取工具,并根据文件内容给出回答;再到 PPIO 控制台查看是否产生了对应调用记录。这样可以同时确认模型请求和工具调用链路。 ![使用 Kimi K3 验证文件读取和工具调用](https://mintcdn.com/ppinfra/ssyXDxnW17EHVzfX/third-party/images/pi/kimi-tool-call.png?fit=max\&auto=format\&n=ssyXDxnW17EHVzfX\&q=85\&s=f74b25c40a030333a9aaf8e7bc11df75) 完成接入后,可继续让 Pi 分析代码、实现功能、定位问题或运行测试。 ## 接入 Fusion 融合模型,让复杂问题多一层分析 复杂代码分析、技术方案比较或难定位的问题,可使用 PPIO 的 Fusion 融合模型。 Fusion 将请求分发给多个参考模型并行作答,再由融合主模型结合多方结果生成最终响应。整个过程由 PPIO 网关完成,客户端仍通过标准 Chat Completions 接口调用。PPIO 文档显示,Fusion 支持流式输出和 Function Calling,可用于 Agent 的工具调用流程。 **1. 添加 Fusion 模型条目** 在前面的 `models` 数组中追加一个模型条目即可,与原有条目之间用逗号分隔: ```json theme={null} { "id": "pprouter/fusion", "name": "PPIO · Fusion" } ``` **2. 切换到 Fusion 模型** 接口地址和 API Key 配置保持不变,然后在 Pi 中通过 `/model` 切换,或在启动时指定: ```bash theme={null} pi --provider ppio --model pprouter/fusion ``` ![在 Pi 中选择 PPIO · Fusion](https://mintcdn.com/ppinfra/ssyXDxnW17EHVzfX/third-party/images/pi/fusion-model-selection.png?fit=max\&auto=format\&n=ssyXDxnW17EHVzfX\&q=85\&s=30fce9fd34f29a69a2c0e574c16a8290) **3. 验证 Fusion 分析** 你可以尝试这样的任务: > 阅读当前项目的登录与鉴权相关代码,分析可能遗漏的边界条件,给出修改建议和验证方法。 ![使用 Fusion 分析项目代码](https://mintcdn.com/ppinfra/ssyXDxnW17EHVzfX/third-party/images/pi/fusion-analysis.png?fit=max\&auto=format\&n=ssyXDxnW17EHVzfX\&q=85\&s=01d039880c5e0784e9d52dc4b9c4c9ce) Fusion 适合重视分析质量、能接受额外等待时间的任务。一次请求内部会发生多次模型调用,费用按实际参与模型的用量汇总,响应时间通常高于单模型直接调用。可先将它用于关键分析步骤,再根据实际效果决定使用范围。 **Pi 提供终端中的任务执行能力,PPIO 提供可选择的模型服务与用量管理**。将二者连接,即可围绕自己的项目和预算搭建 AI 编程工作流。 # PPIO x 全新Qoder:阿里出品的智能体工作台,一键接入 Source: https://ppio.com/docs/third-party/qode 按照 Qoder 接入教程配置 PPIO LLM API,了解 API Key、Base URL 和 Model ID 的填写方式,以及企业 Token Plan 与 Fusion 融合模型的使用。 ![20261016-114500.png](https://mintcdn.com/ppinfra/6ayvDgVwknPNLKE0/third-party/images/qode/overview.png?fit=max\&auto=format\&n=6ayvDgVwknPNLKE0\&q=85\&s=1c5ce80da3034b5f080a802f56017408) Qoder 是以 Coding 为核心能力的智能体工作台,面向所有用户。 Qoder 是阿里云推出的智能体编程平台,2026 年 8 月完成战略升级,新增桌面宠物、实时语音交互和通用任务模式,致力于让非技术人员也能用自然语言快速落地创意,实现「人人都是开发者」的愿景。 截至 2026 年 8 月,Qoder 累计全球用户超过 600 万,服务超过 10 万家企业客户。 Qoder 的 Agent 模式响应快、上手成本低,但采用 Credits 计费,消耗速度可能超出预期。不少用户反映即使是付费套餐,额度也可能在几天内用完,性价比不高。 Qoder 的 Token 额度不足时,PPIO 的 Token Plan 可作为模型替代方案。 Qoder 支持自定义配置第三方模型,只需配置三个参数即可调用 PPIO 的模型。PPIO Token Plan 统一接入主流模型,调用低至 6 折,支持 200 团队席位,适合专业、高频的模型调用需求。 ## 简单三步,在 Qoder 中接入 PPIO 专业用户可以直接到 PPIO 控制台创建 API Key,然后进入 Qoder 的自定义模型设置,按照提示依次填写接口地址、API Key 和模型名称三个参数。 新用户按以下三个步骤操作。 **1. 获取并保存 API key** 获取并保存【API key】,用于身份验证和权限访问控制。 首先注册一个 PPIO 账号。 注册并登录后打开 API 密钥管理页面,点击创建按钮,输入自定义密钥名称,生成 API 密钥。 ![屏幕截图_12-10-2026_151636_ppio.com.jpeg](https://mintcdn.com/ppinfra/6ayvDgVwknPNLKE0/third-party/images/qode/api-key-management.jpeg?fit=max\&auto=format\&n=6ayvDgVwknPNLKE0\&q=85\&s=4e4152458dc061ed6db0abd846eac94a) ![屏幕截图_12-10-2026_15173_ppio.com.jpeg](https://mintcdn.com/ppinfra/6ayvDgVwknPNLKE0/third-party/images/qode/create-api-key.jpeg?fit=max\&auto=format\&n=6ayvDgVwknPNLKE0\&q=85\&s=31483921edc1b2d049369124d1ff2921) ![屏幕截图_12-10-2026_151726_ppio.com.jpeg](https://mintcdn.com/ppinfra/6ayvDgVwknPNLKE0/third-party/images/qode/api-key-created.jpeg?fit=max\&auto=format\&n=6ayvDgVwknPNLKE0\&q=85\&s=73e4fee619d25bcfe16a7efd223d4cb4) **2. 获取 Base URL 和 Model ID** 获取【Base URL】和【Model ID】,前者是 API 服务的根地址,后者用于指定调用的具体模型资源。 在 PPIO 模型广场点击任一模型,从 API 接入指南获取 Base URL 以及模型 ID(见下图),Base URL 为固定地址:`https://api.ppio.com/openai` ![zIoFlGxy.png](https://mintcdn.com/ppinfra/6ayvDgVwknPNLKE0/third-party/images/qode/model-api-guide.png?fit=max\&auto=format\&n=6ayvDgVwknPNLKE0\&q=85\&s=4a6a8dd168976a11c2f6d7aede4c5f3a) **3. 下载并安装 Qoder** 下载并安装 Qoder。 **4. 填入 Base URL、API Key 和 Model ID** 在配置自定义模型中,将 PPIO 的接口地址(即 Base URL)、API Key 和模型名称(即 Model ID)依次填入。 ![屏幕截图 2026-10-12 152941.png](https://mintcdn.com/ppinfra/6ayvDgVwknPNLKE0/third-party/images/qode/model-management.png?fit=max\&auto=format\&n=6ayvDgVwknPNLKE0\&q=85\&s=a37e5e317156b990a35473dcab63482e) ![屏幕截图 2026-10-12 162510.png](https://mintcdn.com/ppinfra/6ayvDgVwknPNLKE0/third-party/images/qode/add-model.png?fit=max\&auto=format\&n=6ayvDgVwknPNLKE0\&q=85\&s=3ab51f8908c1678c2e19773595de1675) ![屏幕截图 2026-10-12 162540.png](https://mintcdn.com/ppinfra/6ayvDgVwknPNLKE0/third-party/images/qode/model-saved.png?fit=max\&auto=format\&n=6ayvDgVwknPNLKE0\&q=85\&s=a712ade1d48f571a1ae2385ef79e7486) ## **订阅 PPIO 企业 Token Plan,旗舰模型低至 6 折** PPIO 企业 Token Plan 是标准化的预付费折扣产品,核心机制是「融合 Token」:以 DeepSeek V4 Flash 输入 Token 为基准单位(系数 1.000),其他模型按各自的抵扣系数折算消耗,共用同一套余额。 PPIO 企业 Token Plan 支持 200+ 席位,适合中小 AI 开发者团队。 PPIO 企业 Token Plan 目前覆盖 17 款模型,包括 DeepSeek V4 Flash 正式版、Kimi K3、GLM-5.2、MiniMax M3 等国产开源旗舰模型。新模型上线后会同步更新到订阅包。 PPIO 企业 Token Plan 分三档(见下图),三档基准单价相同,均为 ¥0.95/Mtoken,差异在于 Token 配额、并发上限和服务级别。折扣幅度因模型而异:DeepSeek 系列约 9 折,Qwen 3.5、GLM-5.2 等官方定价偏高的模型可低至 5\~6 折,综合成本最高可节省接近一半。 ![rYal2cXe.png](https://mintcdn.com/ppinfra/6ayvDgVwknPNLKE0/third-party/images/qode/token-plan.png?fit=max\&auto=format\&n=6ayvDgVwknPNLKE0\&q=85\&s=419cc9be66258cc9885e3dfbabde6d39) ## ## Fusion 融合模型已上线,用 1/10 的价格超越顶级模型的智商 PPIO 最新上线的 Fusion 融合模型也已支持接入 Qoder。 Fusion 融合模型是 PPIO 智能模型网关提供的多模型融合推理能力。调用时,网关将请求同时分发给多个各有所长的「专家模型」作答,再通过思考编排与交叉验证,由主模型生成最终答案,每次调用都变成一次「专家会诊」。与只做请求转发的传统 API 网关不同,融合模型以智能优先、兼顾成本:通过工程化的融合手段,把答案质量稳定在头部旗舰模型梯队,同时把成本控制在中低梯队。 在 DRACO 深度研究基准测试中,PPIO Fusion 融合模型以 Kimi K3、GLM 5.2、MiniMax M3 为参考模型(Advisors)、DeepSeek V4 Flash 为融合主模型(Aggregator)进行融合推理,效果超越 Claude Fable 5,总成本约为其 1/10。Fusion 融合模型提供 OpenAI 兼容接口,Base URL 无需改变,只需将模型名称设置为 `pprouter/fusion`。 ![屏幕截图 2026-10-12 160214.png](https://mintcdn.com/ppinfra/6ayvDgVwknPNLKE0/third-party/images/qode/fusion-selected.png?fit=max\&auto=format\&n=6ayvDgVwknPNLKE0\&q=85\&s=e09c408b92d5738068ec64a1ec75d265) 除 Qoder 外,还可以将 PPIO 模型服务接入 Claude Code、Codex、OpenClaw、Hermes Agent、WorkBuddy 等 AI 工具。 截至 2026 年 9 月,PPIO 日均 Token 调用量达 3.4 万亿,是国内最大的独立「Token 工厂」,持续提供可靠、可扩展、高性价比的模型服务。 # RAGFlow 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/ragflow-use 了解 RAGFlow 接入 PPIO LLM API 的配置方式,查阅检索增强应用中的模型连接说明,为组织文档问答流程提供参考。 ### 教程概述 **RAGFlow** 结合大语言模型(LLM),针对合同、论文、技术文档等复杂格式数据提供问答服务,并给出引用来源。 PPIO 派欧云开发者平台开放了这些能力。按以下步骤接入 RAGFlow,并结合 DeepSeek 模型处理文档。 下方教程包含完整接入方案(含密钥配置),约 3 分钟完成「RAGFlow + PPIO 高性能 API」接入。 ## 访问 [RAGFlow 官网](https://ragflow.io) ![RAGFlow 官网](https://static.ppinfra.com/docs/image/llm/YVbDbpxZbokrYqxgIgLcDb4Mnwh.png) ## 获取 API 密钥信息 **1. 获取 API 接口地址** `https://api.ppio.com/openai`。 **2. 创建 API 密钥** 登录派欧云控制台 [API 密钥管理](https://ppio.com/settings/key-management) 页面,点击创建按钮。 ![PPIO 派欧云 API 密钥管理](https://static.ppinfra.com/docs/image/llm/PViSbNDzoovxdvxUgBScSqyEn9d.png) **3. 生成并保存 API 密钥** > [!WARNING] > > 密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建一个新的密钥。 ![PPIO 派欧云 API 密钥管理](https://static.ppinfra.com/docs/image/llm/EP1PbMRFtoWtyJxLaXkcH9ZMnWc.png) ![PPIO 派欧云 API 密钥管理](https://static.ppinfra.com/docs/image/llm/HIPTbcefkorXprxYCu9c4JERnzh.png) **4. 获取需要使用的模型 ID** **推荐 DeepSeek 系列模型:** * DeepSeek V4 Pro:deepseek/deepseek-v4-pro * DeepSeek V4.1 Flash:deepseek/deepseek-v4.1-flash 其他模型 ID 及价格可参考:[模型列表](https://ppio.com/model-api/pricing)。 ## 软件配置和使用 **1. 添加模型供应商** 选择 **模型供应商**,找到 **OpenAI-API-Compatible**,点击 **添加模型**。 ![RAGFlow 添加模型](https://static.ppinfra.com/docs/image/llm/P3Hcb201mo5zgrx40aucja9dn2g.png) **2. 选择和填写对应配置** ![RAGFlow 添加模型](https://static.ppinfra.com/docs/image/llm/MmbPbLwjpoCPrkxkLtfcfZnOn3c.jpg) **3. 提交 OK** 显示已经添加成功的模型。 ![RAGFlow 添加模型](https://static.ppinfra.com/docs/image/llm/IWxAb5KaeocjMjxkxVOcTuUznwg.png) # Siri 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/siri-use 按照 Siri 接入 PPIO LLM API 的教程了解连接流程,查阅语音助手调用模型服务的配置,为个人 AI 使用场景提供参考。 ## 教程概述 借助快捷指令,你可以让 Siri 调用 DeepSeek 完成对话和文本处理。 配置快捷指令需要若干步骤,按下方教程逐步操作即可完成。 下方教程包含完整接入方案(含密钥配置),3 分钟完成「Siri + PPIO 高性能 API」接入。 ## 配置前置条件 **1. 获取 API 密钥** 登录派欧云控制台 [API 密钥管理](https://ppio.com/settings/key-management) 页面,点击创建按钮。 ![](https://static.ppinfra.com/docs/image/llm/UQt6bboLxoKBsSxF9qdcHlZNnQd.png) **2. 生成并保存 API 密钥** > [!WARNING] > > 密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建一个新的密钥。 ![](https://static.ppinfra.com/docs/image/llm/WxoSbY7KboU2dlxhgq3c1o6xnkh.png) ![](https://static.ppinfra.com/docs/image/llm/E14ObbvbFoBZuNxnUXZcqQrJnzd.png) **3. 获取需要使用的模型 ID** 推荐 DeepSeek 系列模型: * DeepSeek V4 Pro:deepseek/deepseek-v4-pro * DeepSeek V4.1 Flash:deepseek/deepseek-v4.1-flash 其他模型 ID 及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ## 创建 Siri 快捷指令 **1. 搜索听写文本操作** 搜索操作「听写文本」,语言选中文(中国),不能用默认。 **2. 搜索 URL 操作** 搜索操作「URL」,粘贴 `https://api.ppio.com/openai/v1/chat/completions`。 ![](https://static.ppinfra.com/docs/image/llm/M6aHb7Ch0obPOxxpbzUczA95nae.png) ![](https://static.ppinfra.com/docs/image/llm/A39ibWv0uopfwVxDhYgcDk7Xntn.png) **3. 配置请求体** ![](https://static.ppinfra.com/docs/image/llm/D5LAbnHxwoqcSqxCDDgcpxahnId.png) ![](https://static.ppinfra.com/docs/image/llm/CBa8bAsGZo1Ci3xqcxFcsC1cnye.png) **4. 添加显示结果操作** 搜索操作「显示结果」。 # 思源笔记 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/siyuanbiji-use 查阅思源笔记接入 PPIO LLM API 的指南,了解笔记工具的模型连接设置,为知识记录与内容处理流程使用 AI 能力提供参考。 DeepSeek 以接近人类的逻辑推理能力,扩展了「聪明」的边界。将智能融入真实场景的产品更能改变生活,比如你正在用的笔记工具。 **思源笔记**用块编辑组织复杂思考,用双向链接建立知识网络,全程离线的隐私设计和端到端加密同步,让它成为数字时代的「思维堡垒」。 要让产品具备这种能力,可使用 **PPIO 的 DeepSeek API**。 下方教程包含完整接入方案(含密钥配置),3 分钟完成「PPIO 高性能 API x 思源笔记」接入。 ## PPIO x 思源笔记 图文使用教程 ### 配置前置条件 **1. 获取 API 接口地址** 固定为:[https://api.ppio.com/openai](https://api.ppio.com/openai) **2. 获取 API 密钥** 登录派欧云控制台 [API密钥管理](https://ppio.com/settings/key-management) 页面,点击创建按钮。 ![1.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/siyuanbiji/1.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=3625b5865527c29eebaeaca6fd154721) **3. 生成并保存 API 密钥** **注意**:密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建一个新的密钥。 ![2.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/siyuanbiji/2.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=16026adf75d4066969bee697ec8249a0) ![3.PNG](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/siyuanbiji/3.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=df2826198f7946de69ba3ed437f84b9e) **4. 获取需要使用的模型 ID** DeepSeek 系列: DeepSeek V4 Pro:deepseek/deepseek-v4-pro DeepSeek V4.1 Flash:deepseek/deepseek-v4.1-flash 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ### 添加模型 **1. 下载并安装思源笔记** 前往:[https://b3log.org/siyuan/download.html,下载并安装思源笔记。](https://b3log.org/siyuan/download.html,下载并安装思源笔记。) ![4.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/siyuanbiji/4.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=8f6bec4bbbe3d6ee8b16d36330500e74) **2. 打开插件** 进入主页后,点击右上角【插件】。 ![5.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/siyuanbiji/5.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=e7954cfbfab46f4d55ac03d4694ab416) **3. 填写模型与接口地址** 进入页面,先选择【OpenAI】,在【模型】处复制官网模型名称,如图;在【API Key】处输入官网生成的密钥;在【API基础地址】处输入地址,与图片一致即可。 ![6.png](https://mintcdn.com/ppinfra/gkx64qIVVA0YXPyk/third-party/images/siyuanbiji/6.png?fit=max\&auto=format\&n=gkx64qIVVA0YXPyk\&q=85\&s=24e42291a2730a77bcbec4cedad3b2b1) # PPIO × Trae:0基础也能快速上手AI编码 | SOLO Code放送中 Source: https://ppio.com/docs/third-party/trae-use 按照 Trae 接入教程配置 PPIO LLM API,了解 API Key、模型 ID、VS Code 或 Cursor 配置导入和模型选择,通过自然语言创建编程任务并查看生成效果。 ![xmtxDBA0.webp](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/trae/hero.webp?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=a1de59609da7ea3ee906a98291a6ee8f) 用 AI 工具进行编程可以极大程度提升开发效率。但是 Cursor、Claude Code 等 AI 编程工具每月动辄几十上百美金,对于开发者来说属实是一笔不小的支出。 由字节跳动推出的智能编程助手Trae 具备完备的 IDE 功能,支持代码编写、项目管理、插件管理、源代码管理等功能,开发者可以与 AI 灵活协作,实现高效开发。 现在,Trae 已支持接入 PPIO 提供的高性能模型 API 服务,通过简单接入,即可调用 kimi-k2、glm-4.5 等模型进行代码编写,性能强悍、性价比更高。以下为完整教程,三个步骤即可获取 AI 编程神器! ## PPIO × Trae 配置教程 ### 第一步:获取 API key #### 1. 获取 API 密钥 点击阅读原文,注册登录 PPIO ,填写邀请码【MLDYQ1】得 15 元代金券。 打开 API 密钥管理页面,点击创建按钮,输入自定义密钥名称,生成 API 密钥。 ![640.webp](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/trae/api-key-management.webp?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=2f566867ada3e4eae5b1c1b8af89c504) #### 2. 生成并保存 API 密钥 **!!注意:**秘钥在服务端是加密存储,请在生成时保存好秘钥;若遗失可以在控制台上删除并创建一个新的秘钥。 ![640 (1).webp](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/trae/api-key-created.webp?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=7b6241a97a5bcd0a34ca5f236ed14569) #### 3. 获取 【模型ID】 **推荐使用的模型 ID** * moonshotai/kimi-k2-instruct * deepseek/deepseek-r1-0528 * deepseek/deepseek-v3-0324 * qwen/qwen3-235b-a22b-fp8 其他模型 ID、最大上下文及价格可参考:[https://ppio.com/pricing](https://ppio.com/pricing) ### 第二步:安装并配置 Trae #### 1. 安装并启动 Trae 前往 TRAE 官网,按照安装步骤将 **Trae** 安装至电脑。 地址:[https://www.trae.cn/](https://www.trae.cn/) ![640 (2).webp](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/trae/install.webp?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=19e9d9b0573461d6c171d63dec52fb69) #### 2. 从 VS Code 或 Cursor 中导入配置 若你的电脑中已安装并配置 VS Code 或 Cursor,你可以点击 **从 VS Code 导入** 或 **从 Cursor 导入** 按钮。系统将会从对应的 IDE 中获取插件、IDE 设置、快捷键设置等信息并一键导入到 TRAE 中,帮助你快速从其他 IDE 切换到 TRAE。 ![640 (3).webp](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/trae/import-settings.webp?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=c6ff1680ca382fdc62d168fcb89b932e) #### 3. 配置所需模型 找到 AI 功能管理,选择配置模型,点击添加模型。 ![640 (4).webp](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/trae/model-management.webp?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=897e4d741b756238bda0d25633aebdd6) 在服务商栏找到 PPIO,模型列表选择所需模型,如列表未显示所需模型,可点击自定义模型,将 PPIO 官网模型名称复制至自定义模型栏。模型添加成功后,在 API 密钥栏填入从 PPIO 官网复制的 API Key。 ![640 (5).webp](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/trae/add-model.webp?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=88d35373c3409f4d38fe14850c59f9cd) 回到对话页面,点击对话框右下角,选择已经添加好的自定义模型,完成模型配置。 ![640 (6).webp](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/trae/select-model.webp?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=a8cb79a638355eaa6e90f5f2eb6eceee) 新建一个文件夹并打开,测试是否接入成功。Trae 左侧是文件夹,中间是代码区域,右侧是对话区域。 ![640 (7).webp](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/trae/project-workspace.webp?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=2a80d4a2165d27b6a2af8173c36f1807) ### 第三步:创建任务 可以通过自然语言输入需求,即可自动规划项目流程,并生成代码。 如:以北京时间搭建一个节假日倒计时网页,上面显示当下距离 2025 年每一个节假日的倒计时。 ![640 (8).webp](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/trae/create-task.webp?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=c55db4ef66421e63a191d7f58591bcd0) 生成完毕以后,点击全部接受,如果没有出现全部接受,将所有生成的文件都点击应用。程序完成后,可自动在浏览器打开,查看生成效果。 ![640 (9).webp](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/trae/apply-changes.webp?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=1822cac5cb3c0bd20de4b62f9bcb610d) ![640 (10).webp](https://mintcdn.com/ppinfra/en9tAeO_PLt9YXDT/third-party/images/trae/preview.webp?fit=max\&auto=format\&n=en9tAeO_PLt9YXDT\&q=85\&s=89d6e49a908a1f3c31a890db9d57ff3b) # Microsoft Word 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/word-use 了解 Microsoft Word 接入 PPIO LLM API 的配置流程,查阅文档工具使用模型服务的方式,为文稿处理与 AI 写作场景提供参考。 ## 教程概述 Microsoft Word 已发布近 40 年。从文字录入工具发展为集写作、云端协作、跨平台编辑于一体的办公软件。 注册 PPIO 可获取千万 token 免费额度,用于搭建 Word 续写助手。 下方教程包含完整接入方案(含密钥配置),约 3 分钟完成「Microsoft Word + PPIO API」接入。 ## 配置前置条件 **1. 获取 API 接口地址** 获取 API 接口地址:`https://api.ppio.com/openai/v1/chat/completions`。 **2. 创建 API 密钥** 登录派欧云控制台 [API 密钥管理](https://ppio.com/settings/key-management) 页面,点击创建按钮。 ![](https://static.ppinfra.com/docs/image/llm/X1FEblFBEoUweExxa2ocrNO7nhh.png) **3. 生成并保存 API 密钥** 生成并保存 API 密钥。 > [!WARNING] > > 密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建一个新的密钥。 ![](https://static.ppinfra.com/docs/image/llm/AFnpb8Bgvo0pryx5PzJctdvSn6b.png) ![](https://static.ppinfra.com/docs/image/llm/LcsSb7rFjobCF0xCKJ2cSEVVnsc.png) **4. 获取模型 ID** 获取需要使用的模型 ID。**推荐 DeepSeek 系列模型:** * DeepSeek V4 Pro:deepseek/deepseek-v4-pro * DeepSeek V4.1 Flash:deepseek/deepseek-v4.1-flash 其他模型 ID、最大上下文及价格可参考:[模型列表](https://ppio.com/model-api/pricing) ## 在 Word 创建开发工具 **1. 点击【文件】** ![](https://static.ppinfra.com/docs/image/llm/FXcubjhZAouC39xKonRch1D8nMf.png) **2. 点击【更多】→【选项】** ![](https://static.ppinfra.com/docs/image/llm/NABRbibshoEwLjxIzlBcunr4nIe.png) **3. 启用宏并信任 VBA** 点击【信任中心】→【信任中心设置】;在信任中心页面点击【宏设置】→【启用所有宏】→【信任对 VBA 工程对象模型的访问】,全部勾选即可关闭。 ![](https://static.ppinfra.com/docs/image/llm/K9HxbwllzohpvJx1YA1c3q2HnCc.png) **4. 再次打开【选项】** 回到主界面,再点击【文件】→【更多】→【选项】 ![](https://static.ppinfra.com/docs/image/llm/B7VCbKcMooYKIMx5O1ncwB3JnJd.png) ![](https://static.ppinfra.com/docs/image/llm/X7MQbx6JyoIkuvxr1Kmc8sThnKg.png) **5. 勾选【开发工具】** 打开【自定义功能区】——勾选【开发工具】→【确定】 ![](https://static.ppinfra.com/docs/image/llm/HEHmbLv3ForwtJxH0lFco9KlnBb.png) **6. 打开 Visual Basic** 回到主界面,点击【开发工具】→【Visual Basic】 ![](https://static.ppinfra.com/docs/image/llm/CRr6biAHDo15EvxmBMucCrvTnGT.png) **7. 点击【插入】→【模块】** ![](https://static.ppinfra.com/docs/image/llm/E6qkb9laToeeZcxZoLtcu25Dnfh.png) **8. 粘贴代码并填入 API 密钥** 复制代码到命令框,仅需修改【api_key = " " 】,在" "中填入「生成并保存 API 密钥」步骤中保存的 API 密钥 ![](https://static.ppinfra.com/docs/image/llm/NaDhbNlZ4oQ7fGxqC4RckwaMnMb.png) 全部代码如下图: ![](https://static.ppinfra.com/docs/image/llm/S5ESb7LeNoZnqaxGQ39cyvU7nzb.png) ## 配置开发工具 **1. 新建并命名功能组** 点击【自定义功能区】→【新建组】,点击【新建组(自定义)】→【重命名】;在显示名称处将自定义名称修改为「PPIO」,【确定】修改名称 ![](https://static.ppinfra.com/docs/image/llm/ViPEbykdCoMGe2xCQWXcsN7Jnvh.jpg) **2. 添加宏命令** 点击新建的【PPIO(自定义)】,在命令下拉中选择【宏】→【Project 模块 1】→【添加】→【确定】 ![](https://static.ppinfra.com/docs/image/llm/YZvsb3fSsoM06xxaOFeczu3Ln5O.jpg) **3. 选中文字生成续写** 回到主界面,选中需要续写的文字,点击刚刚创建的模块,Word 中会自动在下列行中输出 PPIO 的 DeepSeek 续写结果。 ![](https://static.ppinfra.com/docs/image/llm/FM9UbYc24oQ8BnxubwpckV6qn6c.png) # WorkBuddy 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/workbuddy-use 按照 WorkBuddy 接入教程配置 PPIO LLM API,了解工具与模型服务的连接方式,为办公和 AI 任务使用提供参考。 ![img_v3_0214g_707726ee-b39c-4484-b819-849f6cafa05g.png](https://static.ppinfra.com/docs/image/llm/img_v3_0214g_707726ee-b39c-4484-b819-849f6cafa05g.png) WorkBuddy 是 2026 年 AI 领域快速崛起的产品。 它从腾讯内部一个 10 人团队的项目起步,几个月内成长为国内用户规模最大的 AI 办公智能体之一。你可以用 WorkBuddy 做研究、写文档、做设计、搞开发。 办公能力的背后是 Token 消耗。深度 AI 用户任务执行频率高,Token 消耗额度也会是一笔不小的开支。 WorkBuddy 的 Token 额度告急时,PPIO 的 Token Plan 可作为模型替代方案。WorkBuddy 开放了模型配置权限,支持自定义配置第三方模型。 配置三个参数,就可以在 WorkBuddy 里调用 PPIO 的模型。**PPIO Token Plan 支持主流模型统一接入,调用低至 6 折,支持 200 团队席位,适合专业、高频的模型调用需求。** ## 简单三步,在 WorkBuddy 中接入 PPIO 专业用户可以直接到 PPIO 控制台创建 API Key,然后进入 WorkBuddy 的自定义模型设置,依次填写接口地址、API Key 和模型名称三个参数。 新用户按以下三个步骤操作。 **1. 获取并保存 API Key** 获取并保存【API key】,用于身份验证和权限访问控制。 先注册 PPIO 账号并登录;然后打开 [API 密钥管理页面](https://ppio.com/settings/key-management),点击创建按钮,输入自定义密钥名称,生成 API 密钥。 注册地址:[https://ppio.com/](https://ppio.com/) ![Clipboard_Screenshot_1786356531.png](https://static.ppinfra.com/docs/image/llm/Clipboard_Screenshot_1786356531.png) ![Clipboard_Screenshot_1786529425.png](https://static.ppinfra.com/docs/image/llm/Clipboard_Screenshot_1786529425.png) **2. 获取 Base URL 和 Model ID** 获取【Base URL】和【Model ID】,前者是 API 服务的根地址,后者用于指定调用的具体模型资源。 在 PPIO 模型广场点击任一模型后,可以从 API 接入指南获取 Base URL 以及模型 ID(见下图),Base URL 为固定地址:[https://api.ppio.com/openai](https://api.ppio.com/openai) ![Clipboard_Screenshot_1786353902.png](https://static.ppinfra.com/docs/image/llm/Clipboard_Screenshot_1786353902.png) **3. 下载安装并配置 WorkBuddy** 下载并安装 WorkBuddy。在自定义模型配置中,将 PPIO 的接口地址(即 Base URL)、API Key 和模型名称(即 Model ID)依次填入。 ![image.png](https://static.ppinfra.com/docs/image/llm/image%201.png) ![image.png](https://static.ppinfra.com/docs/image/llm/image.png) 保存后,选择新增的模型即可使用。 ![image.png](https://static.ppinfra.com/docs/image/llm/image%202.png) ## 订阅 PPIO 企业 Token Plan,旗舰模型低至 6 折 PPIO 企业 Token Plan 是一套标准化的预付费折扣产品,核心机制是「融合 Token」:以 DeepSeek V4 Flash 输入 Token 为基准单位(系数 1.000),其他模型按各自的抵扣系数折算消耗,共用同一套余额。 PPIO 企业 Token Plan 支持 200+ 席位,适合中小 AI 开发者团队。 PPIO 企业 Token Plan 目前覆盖 17 款模型,包括 **DeepSeek V4 Flash 正式版、Kimi K3、GLM-5.2、MiniMax M3** 等国产开源旗舰模型。后续新模型上线也会同步更新到订阅包中。 PPIO 企业 Token Plan 分三档(见下图),三档基准单价相同,均为 ¥0.95/Mtoken,差异在于 Token 配额、并发上限和服务级别。折扣幅度因模型而异:DeepSeek 系列约 9 折,Qwen 3.5、GLM-5.2 等官方定价偏高的模型可低至 5\~6 折,综合成本节省最高接近一半。 ![Clipboard_Screenshot_1786355605.png](https://static.ppinfra.com/docs/image/llm/Clipboard_Screenshot_1786355605.png) ## Fusion 融合模型已上线,用 1/10 的价格超越顶级模型的智商 除常规模型外,PPIO 最新上线的 Fusion 融合模型也已支持接入 WorkBuddy。 Fusion 融合模型是 PPIO 智能模型网关提供的多模型融合推理能力。调用融合模型时,网关将请求同时分发给多个各有所长的「专家模型」作答,再通过思考编排与交叉验证,由主模型生成最终答案,每次调用都变成一次「专家会诊」。与只做请求转发的传统 API 网关不同,融合模型以智能优先、兼顾成本:通过工程化的融合手段,把答案质量稳定在头部旗舰模型梯队,同时把成本控制在中低梯队。 在 DRACO 深度研究基准测试中,PPIO Fusion 融合模型以 Kimi K3、GLM 5.2、MiniMax M3 为参考模型(Advisors)、DeepSeek V4 Flash 为融合主模型(Aggregator)进行融合推理,超越了 Claude Fable 5,而总成本接近其约 1/10。 Fusion 融合模型提供 OpenAI 兼容接口,Base URL 无需改变,只需将模型名称设置为 `pprouter/fusion`。 ![Clipboard_Screenshot_1786355930.png](https://static.ppinfra.com/docs/image/llm/Clipboard_Screenshot_1786355930.png) 除 WorkBuddy 外,你还可以将 PPIO 模型服务接入 Claude Code、Codex、OpenClaw、Hermes Agent 等 AI 工具。 截至 2026 年 6 月,PPIO 日均 Token 调用量达 1.2 万亿,是国内最大的独立「Token 工厂」,为用户持续提供可靠、可扩展、高性价比的模型服务。 # WPS Office AI 接入 PPIO LLM API Source: https://ppio.com/docs/third-party/wps-office-ai-use 查阅 WPS Office AI 接入 PPIO LLM API 的配置说明,了解办公工具中的模型连接流程,为文档与 AI 办公使用提供参考。 ## 教程概述 通过 Office AI 插件接入 PPIO 大语言模型 API,可在 WPS 中生成报告、提取关键信息、进行智能问答。借助 DeepSeek 模型,WPS 可作为 AI 助手使用。 DeepSeek 系列模型支持合同解析、论文摘要、数据提取等场景。面对复杂合同,可一键提取关键条款;面对冗长论文,可生成摘要;面对杂乱的数据表格,可提取核心信息。 PPIO 优化后的 API 通道响应快、稳定性高,支持处理大型文档和高频次问答。 下方教程包含完整接入方案(含密钥配置),3 分钟完成「WPS Office AI 插件 + PPIO API」接入。 ## 下载安装 WPS 第三方插件 Office AI 插件 **1. 访问官方网站** 访问官方网站 [https://www.office-ai.cn/。](https://www.office-ai.cn/。) **2. 下载两个插件** 下载以下两个插件:OfficeAI.exe 和 OfficeAI_Server.exe。 ![](https://static.ppinfra.com/docs/image/llm/S1TSbeuqtoqTktxT46ucuj9dnIe.png) **3. 安装插件** ![](https://static.ppinfra.com/docs/image/llm/O6RcbCsHMofxXFxcb3lcaFnAns3.jpg) ## 配置前置条件 **1. 获取 API 接口地址** **获取 API 接口地址**:`https://api.ppio.com/openai`。 **2. 创建 API 密钥** 登录派欧云控制台 [API 密钥管理](https://ppio.com/settings/key-management) 页面,点击创建按钮。 ![](https://static.ppinfra.com/docs/image/llm/UUv4blb3kogvkhx5VigcpxNXnwg.png) **3. 生成并保存 API 密钥** 生成并保存 API 密钥 > [!WARNING] > > 密钥在服务端加密存储,请在生成时保存好密钥;若遗失,可在控制台删除并创建一个新的密钥。 ![](https://static.ppinfra.com/docs/image/llm/J2kRbmGCWoPsTcx3m9mcV8eNnRg.png) ![](https://static.ppinfra.com/docs/image/llm/XDh4bVpMMoP8mJxAMH5cNTLvnqb.png) **4. 获取模型 ID** 获取需要使用的模型 ID。**推荐 DeepSeek 系列模型:** * DeepSeek V4 Pro:deepseek/deepseek-v4-pro * DeepSeek V4.1 Flash:deepseek/deepseek-v4.1-flash 其他模型 ID 及价格可参考:[模型列表](https://ppio.com/model-api/pricing)。 ## 插件配置 **1. 打开 OfficeAI 设置** 打开 WPS,点击工具栏中的「OfficeAI」图标。在弹出的窗口中,找到并点击「设置」。 ![](https://static.ppinfra.com/docs/image/llm/WVCNbgBB7oRjZbxz3R3c5Iqjnjf.png) **2. 选择 ApiKey 选项** 在设置界面中,依次选择:「大模型设置」,「本地模型/API-KEY」,选择「ApiKey」选项。 **3. 选择自定义 OpenAI 协议** 在下拉菜单中,选择「自定义(OpenAI 协议)」。 ![](https://static.ppinfra.com/docs/image/llm/JWZfbZ9mBoFU6Vx0pxhctRbgn2d.png) **4. 测试效果** ![](https://static.ppinfra.com/docs/image/llm/XfvhbeXKrokjLAxZWrncKm0inNc.png) # 使用加速服务 Source: https://ppio.com/docs/gpu/accelerate 了解 PPIO GPU 实例相关资源下载加速服务的使用方式与适用范围,为开发环境准备和资源获取提供操作参考。 PPIO 派欧云平台针对**部分站点**资源下载提供了加速服务,能够极大提升您的资源下载速度。 > [!NOTE] > > 该功能服务还在 Beta 阶段,如果您在使用过程中遇到问题,请[联系我们](https://ppio.com/contact)。 ## 支持站点 * [huggingface.co](https://huggingface.co/) * [github.com](https://github.com/) * [githubusercontent.com](https://githubusercontent.com/) * [githubassets.com](https://githubassets.com/) * [pypi.org](https://pypi.org/) * [docker.com](https://docker.com/) * [docker.io](https://docker.io/) * [gcr.io](https://gcr.io/) * [k8s.io](https://k8s.io/) * [research.microsoft.com](https://research.microsoft.com/) ## 开启/关闭加速 通过以下方式设置,会在当前容器实例内全局生效。 ### 开启加速 设置实例环境变量: * 在创建实例时设置请参考文档:[创建 GPU 实例](/docs/gpu/create-instances#5-创建实例)。 * 在创建实例后设置请参考文档:[升级 GPU 实例](/docs/gpu/upgrade-instance)。 ```bash theme={null} HTTP_PROXY=http://172.17.0.1:1081 HTTPS_PROXY=http://172.17.0.1:1081 ``` ### 关闭加速 参考文档 [升级 GPU 实例](/docs/gpu/upgrade-instance) 将环境变量 `HTTP_PROXY` 和 `HTTPS_PROXY` 删除即可。 # 创建 Async Serverless Endpoint Source: https://ppio.com/docs/gpu/async-serverless-endpoint 了解如何在 PPIO 创建 Async Serverless Endpoint,查阅异步推理端点的配置与使用流程,为按需运行 AI 推理任务准备服务入口。 首次操作时,请先完成账号的注册、实名认证和账户充值。详情请参见[新手指引](/docs/support/quickstart)。 本文以部署一个基于 PPIO SDK 的 ComfyUI worker 镜像 `image.ppinfra.com/prod-gpucloudpublic/comfyui-worker:v0.0.1` 为例,介绍如何创建一个 Async Serverless Endpoint。 ## 1. 准备容器镜像 您需要提前将运行环境打包成 Docker 镜像,并上传至镜像仓库。支持指定公共镜像仓库地址和私有镜像仓库地址(需提供镜像仓库认证凭证)。 * 您可以将镜像上传至 Docker Hub,目前平台已针对该站点提供镜像预热服务。详情请参见[使用镜像预热服务](/docs/gpu/image-pre-warming)。 本示例使用 `image.ppinfra.com/prod-gpucloudpublic/comfyui-worker:v0.0.1` 模型镜像。该镜像内置 ComfyUI 与 PPIO worker SDK,任务输入为 ComfyUI workflow JSON,输出图片会通过 worker handler 返回。建议配置 `BUCKET_ENDPOINT_URL` 等对象存储相关环境变量,将 Async Serverless Endpoint 产生的图片、视频上传到对象存储 Bucket,并在任务结果中返回文件 URL。 ## 2. 选择实例规格 目前Async Serverless Endpoint 支持以下两种 GPU 实例规格: * RTX 4090 24GB * H100 SXM 80GB 本示例中的 `comfyui-worker` 推荐选择 **RTX 4090 24GB**。 如有更多需求,请[联系我们](https://ppio.com/about?index=2)。 ## 3. 创建云存储(可选) 如果有共享存储和持久化存储的需求,可以在[存储管理页面](https://ppio.com/gpu-instance/console/storage)创建云存储,然后在创建实例时为容器挂载云存储。详情请参见[管理云存储](/docs/gpu/manage-cloud-storage)。 ## 4.创建 Endpoint 1. 进入 [Serverless GPUs 页面](https://ppio.com/gpu-instance/console/serverless),选择规格,单击「创建 Endpoint」。 2. 完成 Endpoint 的参数配置。 * Endpoint 名称:用于唯一标识 Endpoint,在创建job时是URL的一部分。系统会自动生成一个默认随机生产的名称,支持自定义,请优先用默认的名称。 * Worker 配置 | **配置项** | **说明** | | - | - | | **最小 Worker 数** | Endpoint 最少需要保留的实例数。设置最小实例数可以帮助减少冷启动时间。如果设置为0,则服务没有请求时不会保留任何实例,这可能会导致无法快速响应后续的请求,因此对于响应时间要求较高的场景,请谨慎设置为0。 | | **最大 Worker 数** | Endpoint 最大可以扩展的实例数。当服务请求增加,触发自动扩容机制时,会增加 Worker 数,因此限制最大 Worker 数可以帮助控制成本。 | | **空闲超时(秒)** | 当触发自动缩容机制而准备释放 Worker 时,在指定的时间内(即空闲超时),平台会为您保留该 Worker ,以便快速应对后续可能上涨的请求量。请注意,平台会收取这段时间对应的 Worker 费用。 | | **最大并发数** | 每个 Worker 能处理的请求最大并发数,当并发数超过最大值时,会将请求调度到其他 Worker 上。如果所有 Worker 并发都被打满,则会将请求存放到队列中等待被执行。 | | **GPUs / Worker** | 每个 Worker 占用的 GPU 卡数。 | | **CUDA 版本** | 支持指定 CUDA 版本。 | * 本示例推荐选择 **RTX 4090 24GB**,`GPUs / Worker` 设置为 `1`。 * Type * Endpoint类型,请选择 **异步(Async)**; * 弹性策略 * 策略类型请选择 **队列请求数策略**。 * 单 worker 目标并发请配置为 `1`。本示例中的 ComfyUI worker 每个 Worker 同一时间处理一个 job;当排队请求数超过当前 Worker 可处理能力时,平台会根据队列请求数自动扩容,直到达到最大 Worker 数。 * 镜像配置 * 镜像地址:要部署的镜像的地址。例如 `image.ppinfra.com/prod-gpucloudpublic/comfyui-worker:v0.0.1`。 * 镜像仓库凭证:如果指定的镜像为私有镜像,需要配置镜像仓库访问凭证才能拉取镜像。您可以在[安全凭证管理页面](https://ppio.com/gpu-instance/console/settings)创建凭证。 * HTTP 端口:Worker 对外开放的 HTTP 端口。 * 容器启动命令:容器启动时执行的命令。 * 存储配置 * 系统盘:每个 Worker 的系统盘容量大小。 * 云存储:如果要挂载云存储,请选择云存储。详情请参见[管理云存储](/docs/gpu/manage-cloud-storage)。 * 其他 * 健康检查路径:此参数暂未启用。 * 环境变量:设置服务所需的环境变量,以便在 Worker 启动时自动初始化。以腾讯云对象存储 COS 示例如下: ```bash Bash icon="terminal" theme={null} BUCKET_ENDPOINT_URL=https://cos..myqcloud.com BUCKET_ACCESS_KEY_ID=AKIASVYYYN6L4S6TTTTTT BUCKET_SECRET_ACCESS_KEY=maVz2OwY98UUUUUUGjMsmR/Yo8/Zzw0qWMMMMMMM ``` 在使用 `comfyui-worker` 这个镜像时,**强烈推荐配置对象存储相关配置,将输出图片上传到对象存储的 Bucket 中**;最终的图片上传效果取决于 worker handler 的实现。客户端调用使用的 API Key 不需要配置到 worker 环境变量中,worker 运行时鉴权信息由平台注入。 3. 确认费用信息,单击「一键部署」。 ## 5.访问服务 1. [Serverless GPUs 页面](https://ppio.com/gpu-instance/console/serverless),找到新创建的 Endpoint,确认状态已变为**运行中**。 2. 确认 Endpoint 中至少有一个 Worker 处于运行中。 3. 确认拥有对应的 API Key 用于调用鉴权,创建 Endpoint 的用户与 API Key 对应的用户应处于同一团队中。 调用 Async Serverless Endpoint 需要准备以下信息: | **参数** | **说明** | | - | - | | **公网调用地址** | `https://async-public.serverless.ppinfra.com/v1` | | **Endpoint 名称** | 创建 Endpoint 后得到的名称,例如 `0f43a6867e05fddd`。该名称是任务提交 URL 的一部分。 | | **API Key** | 进入控制台的 API Key / 密钥管理页面创建或复制 API Key。调用时放在 `Authorization: Bearer ` 请求头中。 | 获取 API Key: 1. 登录 PPIO 控制台。 2. 进入 API Key / 密钥管理页面。 3. 单击创建 API Key,复制生成的 `sk_...` 字符串。 4. 确认该 API Key 所属用户与 Endpoint 所属用户在同一团队中。 ### 5.1 通过Curl的方式来创建job 以及获取执行结果 **创建Job** 这里给出一个 `comfyui-worker` worker 中实际可执行的例子。该请求地址和 payload 与测试用例保持一致。请将 URL 中的 `0f43a6867e05fddd` 替换为您的真实 Endpoint 名称,并将 `sk_xxxx` 替换为您的真实 API Key。 请注意:Async Serverless Endpoint 所能接受**最大的 job size 大小为 4MiB**; ```bash Bash icon="terminal" theme={null} curl -X POST https://async-public.serverless.ppinfra.com/v1/0f43a6867e05fddd/run \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer sk_xxxx' \ -d '{ "input": { "workflow": { "4": { "class_type": "CheckpointLoaderSimple", "inputs": { "ckpt_name": "flux1-dev-fp8.safetensors" } }, "5": { "class_type": "EmptyLatentImage", "inputs": { "width": 512, "height": 512, "batch_size": 1 } }, "6": { "class_type": "CLIPTextEncode", "inputs": { "clip": ["4", 1], "text": "a red apple on a table" } }, "7": { "class_type": "CLIPTextEncode", "inputs": { "clip": ["4", 1], "text": "blurry, low quality" } }, "3": { "class_type": "KSampler", "inputs": { "model": ["4", 0], "positive": ["6", 0], "negative": ["7", 0], "latent_image": ["5", 0], "seed": 42, "steps": 10, "cfg": 7, "sampler_name": "euler", "scheduler": "normal", "denoise": 1 } }, "8": { "class_type": "VAEDecode", "inputs": { "samples": ["3", 0], "vae": ["4", 2] } }, "9": { "class_type": "SaveImage", "inputs": { "filename_prefix": "test", "images": ["8", 0] } } }, "output_node_id": "9" } }' ``` 创建成功得到的 response 如下,其中的 `id` 为 `job_id`: ```json JSON icon="brackets-curly" theme={null} {"id": "8cb6a77c-62aa-4eb4-9226-1ca5724fd9dd","status":"PENDING"} ``` **查看job状态及获取执行结果:** 请注意:您能通过 Async Service Endpoint 的 `status` 接口能获取到的**最大 output size 为 4MiB**;所以请通过配置 S3 环境变量的方式在 `handler.py` 中将输出的图片或视频上传到 S3 对象存储,这种情况下 output 的大小不受限制; 请注意:Job执行结束后,执行结果在Async serverless Endpoint中**最多保存 6 小时**; ```bash Bash icon="terminal" theme={null} curl -X GET https://async-public.serverless.ppinfra.com/v1/0f43a6867e05fddd/status/33a0bc4b-7312-41f6-ad15-eb9016bd68f9 \ -H 'Authorization: Bearer sk_xxxx' ``` **Cancel(取消) Job :** ```bash Bash icon="terminal" theme={null} curl -X POST https://async-public.serverless.ppinfra.com/v1/0f43a6867e05fddd/cancel/e5f3c3c0-c3b1-49c2-9452-bb96eaa34ce6 \ -H 'Authorization: Bearer sk_xxxx' ``` **查看Endpoint Job队列状态:** ```bash Bash icon="terminal" theme={null} curl -X GET https://async-public.serverless.ppinfra.com/v1/0f43a6867e05fddd/health \ -H 'Authorization: Bearer sk_xxxx' ``` 得到的 response 如下: ```json JSON icon="brackets-curly" theme={null} { "workers": { "idle": 0, "running": 0, "throttled": 0, "total": 0 }, "jobs": { "completed": 0, "failed": 0, "inProgress": 0, "inQueue": 0, "retried": 0 } } ``` ### 5.2 通过 PPIO SDK 来创建 Job 及获取执行结果 安装 SDK: ```bash Bash icon="terminal" theme={null} pip install ppio-gpus ``` ```python Python icon="python" theme={null} import ppio_gpus ppio_gpus.api_key = "sk_xxx" input_payload = { "workflow": { "4": { "class_type": "CheckpointLoaderSimple", "inputs": {"ckpt_name": "flux1-dev-fp8.safetensors"}, }, "5": { "class_type": "EmptyLatentImage", "inputs": {"width": 512, "height": 512, "batch_size": 1}, }, "6": { "class_type": "CLIPTextEncode", "inputs": {"clip": ["4", 1], "text": "a red apple on a table"}, }, "7": { "class_type": "CLIPTextEncode", "inputs": {"clip": ["4", 1], "text": "blurry, low quality"}, }, "3": { "class_type": "KSampler", "inputs": { "model": ["4", 0], "positive": ["6", 0], "negative": ["7", 0], "latent_image": ["5", 0], "seed": 42, "steps": 10, "cfg": 7, "sampler_name": "euler", "scheduler": "normal", "denoise": 1, }, }, "8": { "class_type": "VAEDecode", "inputs": {"samples": ["3", 0], "vae": ["4", 2]}, }, "9": { "class_type": "SaveImage", "inputs": {"filename_prefix": "test", "images": ["8", 0]}, }, }, "output_node_id": "9", } endpoint = ppio_gpus.Endpoint("0f43a6867e05fddd") run_request = endpoint.run(input_payload) status = run_request.status() print(f"Initial job status: {status}") if status != "COMPLETED": # Polling with timeout for long-running tasks output = run_request.output(timeout=60) else: output = run_request.output() print(f"Job output: {output}") ``` `ppio-gpus` SDK 默认请求地址已经是 `https://async-public.serverless.ppinfra.com/v1`。这里设置的 `ppio_gpus.api_key` 只用于客户端提交、查询、取消任务,不用于 worker 拉取任务或回传结果。 如需使用 `ppio-gpus` SDK 编写自定义 worker handler、上报进度或上传图片/文件,请参见《PPIO GPUs SDK 使用指南》。 ## 6. 管理 Async Serverless Endpoint 参考 [管理 serverless Endpoint](/docs/gpu/manage-serverless-endpoint) 文档; # 远程连接实例 Source: https://ppio.com/docs/gpu/connect-to-instance 了解 PPIO GPU 容器实例的远程连接方式,查阅终端访问和连接配置说明,为进入云端开发环境、管理任务及排查连接问题提供参考。 实例创建完成后,您可以通过 Web Terminal 或者 SSH 工具连接实例,以便在实例内部执行命令。 ## 通过 Web Terminal 连接 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances)。 2. 找到目标实例,单击对应的「连接」。 3. 在「连接选项」页签下,单击「启动 Web Terminal」。 4. 等待 Web Terminal 启动成功后,复制下方的用户名和密码,然后单击「连接到 Web Terminal」。 ![Web Terminal](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/web-terminal.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=de1795bebac4e23a7f1ca30deb5e43ca) 5. 在弹出的对话框中输入用户名和密码,即可连接到实例。 ## 通过 SSH 连接(密钥登录) ### 配置 SSH 密钥登录 如果本地是 Linux/MacOS 环境,可直接执行以下操作;如果本地是 Windows 环境,需要额外的命令行工具(如Cmder)生成 SSH 密钥,操作与 Linux 一致。 > [!TIP] > > 大多数机器学习和 AI 编程都是在 Linux 上完成的,我们强烈建议您在 Windows 机器上安装一个 Linux 子系统,比如 WSL。 1. 生成 SSH 密钥。 以下命令可以生成一个 RSA 类型的 SSH 密钥对,包括一个私钥和一个公钥,默认保存为`~/.ssh/id_rsa`和`~/.ssh/id_rsa.pub`。 ```bash theme={null} ssh-keygen -t rsa ``` 2. 强制守护进程加载新私钥,并确认已加载。 ```bash theme={null} ssh-add; ssh-add -l ``` 3. 获取公钥。 ```bash theme={null} cat ~/.ssh/id_rsa.pub ``` 4. 进入[安全凭证管理页面](https://ppio.com/gpu-instance/console/instances),将公钥内容复制到「SSH 公钥」处,然后单击「更新公钥」。 ![SSH key](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/ssh-key.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=1246e4232de3735f8b4c834590cafc08) 5. 指定对应的私钥文件进行 SSH 连接。 ```bash theme={null} ssh -i [私钥文件的存储路径] -p [端口号] root@[实例地址] ``` * 如果私钥文件存储在默认的`~/.ssh/id_rsa`,则无需指定。 * 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances),单击目标实例的「连接」,在弹出页面可以获取实例 SSH 连接时的端口号和地址。 ### 常见错误 如果您遇到“Permission denied(publickey)” 的报错,可能是以下原因: * 尝试从实例内部运行 SSH/SCP。 * 密钥设置不正确或使用了错误/不匹配的密钥。 * 使用的 SSH 密钥格式不正确/不支持。 * 私钥未通过 `ssh-add` 正确加载,可能需使用 `-i` 参数。 * 新增或更新密钥后,对已创建的资源不生效。 * SSH 密钥权限设置不正确。 您可以使用 `ssh -vv` 命令获取详细信息。 ## 通过 SSH 连接(密码登录) 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances)。 2. 找到目标实例,单击对应的「连接」。 3. 在「连接选项」页签下,获取实例登录的用户名和密码,以及 SSH 连接命令。 ![ssh-connect](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/ssh-connect.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=7ae660990215d991cb82d93eeb4a70e8) 4. 在本地执行获取到的 SSH 连接命令,输入密码即可连接实例。 * 本地是 Linux 环境:直接执行。 * 本地是 MacOS 环境:通过 Terminal 执行。 * 本地是 Windows 环境:通过 SSH 工具执行,例如 OpenSSH、PuTTY等。 # 创建 GPU 容器实例 Source: https://ppio.com/docs/gpu/create-instances 按照 PPIO GPU 容器实例创建流程准备运行环境,了解镜像、资源规格与实例配置的选择,为模型开发、部署和推理任务准备云端算力。 > [!TIP] > > 首次操作时,请先完成账号的注册、实名认证和账户充值。详情请参见[新手指引](/docs/support/quickstart)。 ## 1. 准备容器镜像 PPIO 派欧云平台的**官方模板**已提供一些常用的基础镜像,您可以直接使用。 > [!TIP] > > 在[算力市场页面](https://ppio.com/gpu-instance/console/explore),在「当前模板」处单击「选择模板」,在弹出页面可以查看所有官方模板。 如果业务有自定义配置,您需要提前将运行环境打包成 Docker 镜像,并上传至镜像仓库。支持指定**公共镜像仓库地址**和**私有镜像仓库地址**(需提供镜像仓库认证凭证)。 * 您可以将镜像上传至 Docker Hub,目前平台已针对该站点提供加速服务。详情请参见[使用加速服务](/docs/gpu/accelerate)。 * 您也可以将镜像上传至平台的私有镜像仓库,以便统一管理镜像。详情请参见[管理容器镜像](/docs/gpu/manage-docker-image)。 ## 2. 选择实例规格 PPIO 派欧云平台提供了多种不同配置的实例规格以支持各种应用场景,您可以在[算力市场页面](https://ppio.com/gpu-instance/console/explore)查看。更多信息,请参见[实例规格](/docs/gpu/product-specifications)。 请基于业务需求选择合适的规格。 * **CPU**:CPU 核数将影响实例的处理能力和性能。对于计算密集型应用程序建议配置更多的 CPU 核数。 * **内存**:充足的内存可以提高数据处理速度,减少延迟,确保应用程序在高负载下稳定运行。 * **GPU 卡型**:‌不同的 GPU 卡型在显存、性能和适用场景上存在差异,请根据应用程序的需求进行选择。 * **CUDA 版本**:CUDA 是 NVIDIA 开发的并行计算平台和 API 模型,能够充分发挥 NVIDIA GPU 的性能。选择合适的 CUDA 版本对于运行优化的应用程序至关重要,尤其是在进行机器学习、深度学习和 3D 渲染等计算密集型任务时。不同的 CUDA 版本可能会影响软件的兼容性和性能,因此请确保选择与您的应用程序和硬件相匹配的版本,以获得最佳的计算效率和稳定性。 ## 2. 创建模板(可选) 模板包含了实例配置信息,包括容器镜像、容器启动命令、对外端口等。您可以直接使用官方模板,也可以在[模板管理页面](https://ppio.com/gpu-instance/console/templates)创建自定义模板。详情请参见[管理模板](/docs/gpu/manage-template)。 ## 4. 创建云存储(可选) 如果有共享存储的需求,可以在[存储管理页面](https://ppio.com/gpu-instance/console/storage)创建云存储,然后在创建实例时为容器挂载云存储。详情请参见[管理云存储](/docs/gpu/manage-cloud-storage)。 > [!WARNING] > > 注意: > > * 云存储按秒计费。如果账户欠费,且无运行中的实例,云存储空间将在 3 天后自动释放。 > * 云存储是在使用 GPU 执行任务时提供的,不作为长期的数据备份解决方案。强烈建议您及时在本地或云服务商处备份数据。 ## 5. 创建实例 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances),单击「创建新实例」。 2. 在「选择模板和 GPU 」配置页,完成模板、计费方式等配置,然后单击要使用的规格对应的「部署」。 | **配置项** | **说明** | | - | - | | **当前模板** | 单击「选择模板」,然后找到要使用的模板,单击「使用模板」。详情请参见[管理模板](/docs/gpu/manage-template)。 | | **计费方式** | 实例的计费方式。详情请参见[GPU 容器实例计费说明](/docs/gpu/gpu-instance-pricing)。对于短期运行,可容忍中断的业务,可选择抢占式计费节约成本,详情请参见[抢占式 GPU 实例](/docs/gpu/spot-instance)。 | | **云存储** | 可选配置。如果要挂载云存储,请选择云存储。详情请参见[管理云存储](/docs/gpu/manage-cloud-storage)。 | | **当前地区** | 不同地区支持的规格不同,且只有部分地区支持云存储。 | | **规格** | 可通过 CPU 、内存和支持的 CUDA 版本来筛选规格。支持的规格信息请参见[实例规格](/docs/gpu/product-specifications)。找到要使用的规格后,可修改 GPU 数。 | | **系统盘容量** | 默认填入模板配置的系统盘容量,您可以按需修改。超出免费额度需要支付存储费用。 | 3. 在「自定义参数」配置页,完成参数配置,然后单击「下一步」。 支持配置的参数如下,默认会填入模板配置信息,可按需修改。 | **配置项** | **说明** | | - | - | | **模板** | 如需修改,单击「选择模板」,然后找到要使用的模板,单击「使用模板」。详情请参见[管理模板](/docs/gpu/manage-template)。 | | **系统盘** | 系统盘的容量大小。超出免费额度需要支付存储费用。 | | **容器镜像地址** | 用于部署容器的镜像地址。如果是私有镜像仓库的镜像,需提供镜像仓库认证凭证。 | | **容器启动命令** | 启动容器后要执行的命令。该配置会覆盖镜像构建时设置的 CMD。 | | **对外 HTTP 端口**、**对外 TCP 端口** | 实例对外开放的端口。请根据服务的具体需求选择暴露的端口,平台将为您的服务提供灵活的端口映射功能。支持多个端口的输入,使用英文半角逗号(,)分隔。请确保所选端口与您的应用程序配置相匹配。合理配置端口可以提高服务的可访问性和安全性。 | | **环境变量** | 设置所需的环境变量,以便在实例启动时自动初始化。这些环境变量可以影响应用程序的运行方式,例如设置路径或调整性能参数。 | 4. 修改并确认计费方式,然后确认规格、镜像等配置,以及费用信息,单击「部署」。 > [!TIP] > > 如果选择「包年包月」计费方式,支持开启自动续费。建议您为运行关键业务的实例开启自动续费,避免因未及时续费,而导致实例自动关机甚至释放,影响业务运行。更多信息,请参见[续费实例](/docs/gpu/gpu-instance-pricing#续费实例)。 5. 返回实例管理页面,确认实例已经部署成功(状态为**运行中**)。 ## 6.更多操作 * [管理实例状态](/docs/gpu/manage-instances) 可根据需求启动、停止、重启和释放实例。 * **查看监控数据** 在实例列表中单击目标实例,即可查看该实例的监控数据,包括CPU、内存、GPU、显存和系统盘的利用率。 * [远程连接实例](/docs/gpu/connect-to-instance) 可通过 Web Terminal 或者 SSH 工具连接实例,以便在实例内部执行命令。 * [修改实例配置](/docs/gpu/edit-instance) 支持修改系统盘容量和对外端口。 * [升级实例镜像](/docs/gpu/upgrade-instance) 如果业务有所变更,可以升级实例镜像,支持修改实例的 Docker 镜像、容器启动命令和容器环境变量。 * [保存实例镜像](/docs/gpu/save-image) 支持将当前实例环境与配置导出为 Docker 镜像,后续您可以使用该镜像创建新的实例,适用于实例批量快速创建、实例迁移等场景。 # 创建 Serverless Endpoint Source: https://ppio.com/docs/gpu/create-serverless-endpoint 查阅 PPIO Serverless Endpoint 的创建流程,了解推理端点与运行环境的配置方式,为通过服务端点运行模型任务提供使用参考。 > [!TIP] > > 首次操作时,请先完成账号的注册、实名认证和账户充值。详情请参见[新手指引](/docs/support/quickstart)。 本文以部署一个 **ComfyUI:SD3** 为例,介绍如何创建一个 Serverless Endpoint。 ## 1. 准备容器镜像 您需要提前将运行环境打包成 Docker 镜像,并上传至镜像仓库。支持指定**公共镜像仓库地址**和**私有镜像仓库地址**(需提供镜像仓库认证凭证)。 * 您可以将镜像上传至 Docker Hub,目前平台已针对该站点提供加速服务。详情请参见[使用加速服务](/docs/gpu/accelerate)。 * 您也可以将镜像上传至平台的私有镜像仓库,以便统一管理镜像。详情请参见[管理容器镜像](/docs/gpu/manage-docker-image)。 本示例使用 ComfyUI:SD3 模型镜像:image.ppinfra.com/prod-gpucloudpublic/comfyui:sd3,您可以直接使用该镜像地址。 ## 2. 选择实例规格 目前 Serverless Endpoint 仅支持以下两种 GPU 实例规格: * RTX 4090 24GB * RTX 3090 24GB > [!TIP] > > 如有更多需求,请[联系我们](https://ppio.com/contact)。 ## 3. 创建云存储(可选) 如果有共享存储和持久化存储的需求,可以在[存储管理页面](https://ppio.com/gpu-instance/console/storage)创建云存储,然后在创建实例时为容器挂载云存储。详情请参见[管理云存储](/docs/gpu/manage-cloud-storage)。 ## 4.创建 Endpoint 1. 进入[Serverless GPUs 页面](https://ppio.com/gpu-instance/console/serverless),选择规格,单击「创建 Endpoint」。 2. 完成 Endpoint 的参数配置。 * **Endpoint 名称**:用于标识 Endpoint。系统会自动生成一个默认名称,支持自定义。 * **应用名称**:应用名称是 Endpoint URL 的组成部分,默认为 Endpoint ID,支持自定义(仅支持小写字母、数字和 - )。 * **Worker 配置** | **配置项** | **说明** | | - | - | | **最小 Worker 数** | Endpoint 最少需要保留的实例数。设置最小实例数可以帮助减少冷启动时间。如果设置为0,则服务没有请求时不会保留任何实例,这可能会导致无法快速响应后续的请求,因此对于响应时间要求较高的场景,请谨慎设置为0。 | | **最大 Worker 数** | Endpoint 最大可以扩展的实例数。当服务请求增加,触发自动扩容机制时,会增加 Worker 数,因此限制最大 Worker 数可以帮助控制成本。 | | **空闲超时(秒)** | 当触发自动缩容机制而准备释放 Worker 时,在指定的时间内(即空闲超时),平台会为您保留该 Worker ,以便快速应对后续可能上涨的请求量。请注意,平台会收取这段时间对应的 Worker 费用。 | | **最大并发数** | 每个 Worker 能处理的请求最大并发数,当并发数超过最大值时,会将请求调度到其他 Worker 上。如果所有 Worker 并发都被打满,则会将请求存放到队列中等待被执行。 | | **GPUs / Worker** | 每个 Worker 占用的 GPU 卡数。 | | **CUDA 版本** | 支持指定 CUDA 版本。 | * **弹性策略** * **队列延迟策略**:根据队列中请求的等待时间调整 Worker 数量。此时您需要配置**队列等待时间**,当队列中请求的等待时间超过该值时,会触发自动扩容,小于该值时,会触发自动缩容。 * **队列请求数策略**:根据队列中的请求数调整 Worker 数量。此时您需要配置**队列最大请求数**,当队列中的请求数超过该值时,会触发自动扩容,小于该值时,会触发自动缩容。 > [!TIP] > > 缩容时,系统会自动结合**空闲超时**来决定 Worker 具体的释放时间。 * **镜像配置** * **镜像地址**:要部署的镜像的地址。例如 `vllm/vllm-openai:latest`。 * **镜像仓库凭证**:如果指定的镜像为私有镜像,需要配置镜像仓库访问凭证才能拉取镜像。您可以在[安全凭证管理页面](https://ppio.com/gpu-instance/console/settings)创建凭证。 * **HTTP 端口**:Worker 对外开放的 HTTP 端口。 * **容器启动命令**:容器启动时执行的命令。 * **存储配置** * **系统盘**:每个 Worker 的 系统盘容量大小。 * **本地存储**:按需配置本地存储,包括本地盘容量和挂载路径。 * **云存储**:如果要挂载云存储,请选择云存储。详情请参见[管理云存储](/docs/gpu/manage-cloud-storage)。 * **其他** * **健康检查路径**:使用 HTTP 请求方式进行健康检查时,要检测的路径。通过判断返回的状态码是否为 200 来决定是否将请求转发到该 Worker 上。 * **环境变量**:设置服务所需的环境变量,以便在 Worker 启动时自动初始化。 示例如下: * `HUGGING_FACE_HUB_TOKEN={您在 Hugging Face 上的 Access Token(有读权限)}` * `HTTP_PROXY=http://172.17.0.1:1081` * ` HTTPS_PROXY=http://172.17.0.1:1081` 3. 确认费用信息,单击「一键部署」。 ## 5.访问服务 1. [Serverless GPUs 页面](https://ppio.com/gpu-instance/console/serverless),找到新创建的 Endpoint,确认状态已变为服务中。 2. 确认 Endpoint 中至少有一个 Worker 处于运行中。 3. 复制 URL,使用`curl`命令访问部署好的服务。 # 修改实例配置 Source: https://ppio.com/docs/gpu/edit-instance 了解 PPIO GPU 容器实例的配置修改方式,查阅相关设置与操作流程,按应用需求调整实例环境并核对变更后的运行状态。 对于已有实例,支持修改系统盘容量和对外端口。 ## 注意事项 * 您可以在实例运行时修改实例配置,修改后实例不会重启。 * 变更预计会在 1 分钟内生效。 ## 操作步骤 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances)。 2. 单击目标实例,然后单击「更多操作」,在菜单中选择「修改」。 * **系统盘容量**可以修改为比当前容量更大的值,即支持扩容,但不支持缩容。如果扩容后的容量超出免费额度,需要支付存储费用。 * **对外 HTTP 端口**和**对外 TCP 端口**不能和已经被占用的端口冲突。 3. 完成修改后,单击「保存」。 # 常见问题 Source: https://ppio.com/docs/gpu/faq 查阅 PPIO GPU 容器服务常见问题,了解实例使用、容器镜像、连接与存储等问题的处理思路,为云端开发和运维提供参考。 ## 计费 ### 如何查看 GPU 容器实例的价格? 您可以在[价格计算器页面](https://ppio.com/gpu-instance/pricing)查看 GPU 实例的价格及其配置项(系统盘、云存储等)费用。 > [!WARNING] > > 算力市场显示的为参考价格,具体以控制台实际下单结果为准。 ### GPU 容器实例从什么时候开始计费? 从实例拉取镜像阶段开始计费。 ### 包年包月实例到期后如何处理? 包年包月实例到期后: * **数据保留**:实例停止运行,但系统盘、本地盘中的数据会保留一段时间(通常 7 天)。 * **续费**:在保留期内续费可恢复实例正常运行,数据不丢失。 * **超期释放**:超过保留期后,实例及其关联数据将被永久释放,无法恢复。 建议在到期前开启[自动续费](/docs/gpu/manage-instances),避免数据丢失。 ### GPU 实例的抢占式(Spot)计费是什么?如何使用? GPU 实例支持 Spot 抢占式计费模式,价格约为按量计费的 **5 折**,适合对中断容忍度较高的训练 / 推理任务。 * **下单入口**:[算力市场](https://ppio.com/gpu-instance/console/explore) 创建实例时,在「计费方式」中选择「Spot 抢占式」 * **中断风险**:当资源被高优先级任务抢占时,实例会被强制释放,请确保任务支持断点续训或镜像快照保存 * **价格详情**:以下单页实时展示为准,详见 [Serverless 与抢占式计费说明](/docs/gpu/serverless-pricing) 平台其他折扣机制(包括企业私有化、初创加速计划等)请参见[账户 FAQ — 如何申请折扣](/docs/support/faq#如何申请折扣)。 ## 实例 ### 实例停止后为什么无法再开机? > [!NOTE] > > 此问题仅适用于**按量计费**实例。包月计费实例的资源已预留,不会出现此情况。 停止实例后,实例所属资源会被释放,如果实例所属资源已被抢占,则会造成无法再开机的情况。如果实例本地盘没有数据,您可以基于该实例[保存镜像](/docs/gpu/save-image),然后基于保存的镜像来创建新的实例。 > [!WARNING] > > 保存实例镜像后,系统盘的数据会随镜像被一起保存,而本地盘的数据不会。对于持久性要求比较高的数据,建议使用[云存储](/docs/gpu/manage-cloud-storage)保存。 ### 实例状态异常,如何处理? 请先查看日志和错误信息,然后根据日志和报错进行处理。如果无法解决,可[联系我们](https://ppio.com/about?index=2)。 ### 如何查看实例的显卡使用情况? 由于 Docker 容器的 PID 隔离限制,无法使用 `nvidia-smi` 命令查看进程。您可以安装 `py3nvml` 库,通过 Python 脚本查看进程占用显卡情况: ```bash theme={null} # 安装 py3nvml 库 $ pip install py3nvml # 查看显卡使用情况 $ (base) root@ab9beba1ecf*****:~# py3smi Fri Sep 20 12:17:39 2024 +-----------------------------------------------------------------------------+ | NVIDIA-SMI Driver Version: 550.54.14 | +---------------------------------+---------------------+---------------------+ | GPU Fan Temp Perf Pwr:Usage/Cap| Memory-Usage | GPU-Util Compute M. | +=================================+=====================+=====================+ | 5 35% 28C 8 11W / 450W | 353MiB / 24564MiB | 0% Default | +---------------------------------+---------------------+---------------------+ +-----------------------------------------------------------------------------+ | Processes: GPU Memory | | GPU Owner PID Uptime Process Name Usage | +=============================================================================+ +-----------------------------------------------------------------------------+ ``` 具体安装及详细使用方法,请参考[py3nvml 库官方文档](https://py3nvml.readthedocs.io/en/latest/)。 ### 如何创建多个 GPU 实例? 两种方式: 1. **控制台逐个创建**:在[算力市场](https://ppio.com/gpu-instance/console/explore)中选择规格,每次创建一个实例。 2. **API 批量创建**:通过[创建实例 API](/docs/gpus/instance/reference-create-gpu-instance) 循环调用,实现批量创建。 > [!NOTE] > > 每个账号的实例数量有配额限制,如需大批量创建,请[联系我们](https://ppio.com/contact)申请提升配额。 ## 容器 ### 容器内如何启动加速? 请参见[开启加速](/docs/gpu/accelerate)。 ### 容器运行时显存不足,如何处理? 一般是由于模型过大,无法加载导致 OOM。请确认显存使用情况。 ### 在新的宿主机上拉起容器时,容器启动速度慢,怎么办? 请[联系我们](https://ppio.com/about?index=2)提前预热镜像到节点,以节约镜像拉取耗时,加快容器启动。 ## 镜像 ### 是否支持自定义镜像? 支持。在创建和升级实例时,可以指定自定义镜像。如果镜像存放在私有镜像仓库,您需要提供镜像仓库认证凭证才可以拉取。 ### 保存镜像失败,怎么办? 在[任务管理页面](https://ppio.com/gpu-instance/console/jobs),找到对应的保存镜像任务,您可以通过查看日志来确认问题。 一般出现此问题是由于镜像仓库认证有误。如果要保存镜像到指定的私有镜像仓库,需要提供该仓库的认证信息,您可以在[安全凭证管理页面](https://ppio.com/gpu-instance/console/settings)添加和确认镜像仓库认证信息。 如果无法解决,可[联系我们](https://ppio.com/about?index=2)。 ### 官方模板不符合要求,怎么办? 您可以自行构建镜像或者直接使用 NVIDIA、DockerHub 的官方镜像。如需更多支持,也可以[联系我们](https://ppio.com/about?index=2)。 ## CUDA ### 没有符合要求的 CUDA 版本,怎么办? CUDA 版本向前兼容。例如,如果您的服务依赖 12.1 版本的 CUDA,可以选择带有大于或等于 12.1 版本 CUDA 的实例规格。 ### 如何查看平台支持的最大 CUDA 版本? 您可以在[算力市场页面](https://ppio.com/gpu-instance/console/explore),通过「支持CUDA版本」下拉列表确认支持的 CUDA 版本信息。 ## 网络 ### 如何配置端口映射? PPIO GPU 实例支持配置对外 HTTP 端口和对外 TCP 端口,两种方式: **方式一:创建实例时配置(推荐)** 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances),点击「创建新实例」 2. 在「自定义参数」配置页,找到**对外 HTTP 端口**或**对外 TCP 端口** 3. 输入需要开放的端口号(多个端口用英文半角逗号分隔,如 `80,443`) 4. 确认后点击「部署」 **方式二:对已有实例修改端口(无需重启)** 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances) 2. 单击目标实例,点击「更多操作」→「修改」 3. 在对外端口配置中填入新端口 4. 点击「保存」,变更预计在 1 分钟内生效 > [!WARNING] > > PPIO GPU 实例采用端口映射(NAT),平台不直接分配独享公网 IP。如需固定 IP 和特定端口(例如 443),建议通过外部反向代理(Nginx / Caddy)实现,或联系客服申请独享 IP。 ### 能否支持独享 IP /独享带宽/专线? 可以支持。目前平台暂未对外开放这个能力。如有需求,请[联系我们](https://ppio.com/about?index=2)。 ## SSH 连接 ### 实例处于运行中,为什么无法看到 SSH 登录信息? 一般是由于容器发生 OOMkilled,不影响运行。您可以先通过 Web Terminal 进入容器。 ### 基于 SSH 连接的 VS Code 无法使用/连接不稳定/连接时间太短,怎么办? 建议在容器中安装标准 sshd。 当前派欧云平台提供的官方模板已经默认安装。如果是私有镜像,需自行安装 sshd 并配置 22 端口映射。 ### 为什么要安装标准 sshd?为什么不能直接使用控制台密码、PublicKey? 当前平台为了保证平台能力不侵入用户容器,SSH 和 Web Terminal 是用一个 Sidecar 方式提供登录能力,所以容器中并没有真正启动 sshd 服务。您可以后续在容器中配置启动 sshd,两者之间并不冲突。 ### 如何安装标准 sshd? 1. [创建 GPU 容器实例](/docs/gpu/create-instances)或[修改实例配置](/docs/gpu/edit-instance)时,在「对外 TCP 端口」处配置 22 端口。 2. 通过 SSH 或 Web Terminal [远程连接实例](/docs/gpu/connect-to-instance)。 3. 参考执行以下命令,安装标准 sshd。 当前仅支持Ubuntu。 ```bash theme={null} # 安装 SSH 服务 apt update && apt install openssh-server -y # 开启远程访问 sed -i 's/#PermitRootLogin.*/PermitRootLogin yes/'/etc/ssh/sshd_config # 开启 SFTP 服务 sed -i 's|Subsystem\s\+sftp\s\+/usr/lib/openssh/sftp-server|Subsystem sftp internal-sftp|' /etc/ssh/sshd_config # 启动(重启) SSH 服务 service ssh restart # 设置 SSH 服务开机自启动 echo "service ssh start" >> /root/.bashrc # 修改 root 密码 passwd # 使用其他用户登录 # 添加用户 # useradd test # 修改用户密码 # echo "test:654321" | chpasswd ``` ### 是否适配 SFTP / SCP? 当前派欧云平台的 SSH 是通过 Sidecar 的方式支持的,容器中无需安装 SSH,但是兼容性可能存在差异。如需使用 SFTP / SCP,优先推荐安装标准 sshd。 ### 如何使用 SCP 上传文件到实例中? 1. [创建 GPU 容器实例](/docs/gpu/create-instances)或[修改实例配置](/docs/gpu/edit-instance)时,在「对外 TCP 端口」处配置 22 端口。 2. 远程连接实例,然后重置实例密码。 1. 在[实例管理页面](https://ppio.com/gpu-instance/console/instances)找到目标实例,单击对应的「连接」。 2. 启动 Web Terminal 后,单击「连接到 Web Terminal」,然后输入用户名和密码进行登录。 ![Web Terminal](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/web-terminal.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=de1795bebac4e23a7f1ca30deb5e43ca) 3. 执行以下命令重置实例密码。 ```bash theme={null} passwd root ``` 3. 使用自定义 SSH 服务(如 WinSCP )上传文件。 ![winscp](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/winscp.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=dbdbafad09076d009ee891422b529423) 登录所需的信息如下: * **主机名**、**端口号**: 在[实例管理页面](https://ppio.com/gpu-instance/console/instances)找到目标实例,单击对应的「连接」,然后单击「 TCP 端口映射」页签,获取主机名和端口号。 示例如下图所示:主机名为 TCP 端口的 proxy.cn-south-1.gpu-instance.ppinfra.com;端口为 TCP 端口映射的端口号 55089。 ![tcp](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/faq-tcp.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=c4599585ee607179673ad296c0be7a04) * **用户名**:root * **密码**:上一步重置的密码 4. 返回 Web Terminal 窗口,通过 ls 命令查看文件列表,确认文件上传成功。 ## 存储 ### 什么是云存储挂载? **挂载云存储**是指将云端的存储空间连接到您的实例(GPU 容器或 Sandbox)的某个本地目录上,使您可以像操作本地文件夹一样读写云端数据。 **核心特点:** * 具有独立生命周期,实例删除后数据不会丢失 * 支持多个实例共享同一云存储 * 计费标准:**¥0.01 / GB / 天** * 最小容量:10 GB * 仅支持扩容,不支持缩容 可前往[存储管理页面](https://ppio.com/gpu-instance/console/storage)创建和管理云存储。 ### 系统盘、本地盘和云存储有什么差异? * **系统盘** * 不支持动态扩容,只能在创建实例时指定容量。 * 挂载目录为`/`(不支持自定义)。 * 保存镜像时会保存数据。 * 支持 **130GB** 的免费额度,超过免费额度后会对超出部分收费。详情请参见[系统盘计费说明](/docs/gpu/gpu-instance-pricing#系统盘)。 * **本地盘** * 支持动态扩容。 * 默认挂载目录为`/workspace`(可自定义)。 * 保存镜像时**不会**保存数据。 * 读写速度与系统盘一致。 * **云存储** * 支持动态扩容。 * 默认挂载目录为`/network`(可自定义)。 * 云存储具有独立的生命周期,即使删除实例,云存储的数据依然存在。 * 读写速度整体比系统盘或本地盘慢(以具体使用情况为准)。 * 云存储按照容量和使用时长单独收费。详情请参见[云存储计费说明](/docs/gpu/gpu-instance-pricing#云存储)。 ### 单个实例是否可以挂载多个云存储? 支持,控制台和 API 均可为单个实例挂载多个云存储。 > [!WARNING] > > 挂载多个云存储时,实例会自动重启,请提前保存好当前工作状态。 # 功能概览 Source: https://ppio.com/docs/gpu/gpu-function-overview 了解 PPIO GPU 容器实例的功能组成与操作入口,查阅实例运行、环境管理和相关服务的说明,建立对 GPU 云端开发流程的整体认识。 ## GPU 容器实例 | 功能 | 说明 | | - | - | | [创建实例](/docs/gpu/create-instances) | 准备好容器镜像,选择合适的规格、计费方式等即可创建实例,用于运行 GPU 容器业务。 | | [管理实例](/docs/gpu/manage-instances) | 创建实例后,可通过启动、停止、重启等操作修改实例的状态,如果实例不再使用,可以释放实例。 | | [远程连接实例](/docs/gpu/connect-to-instance) | 创建实例后,支持通过 Web Terminal 和 SSH 远程连接实例。 | | [管理容器镜像](/docs/gpu/manage-docker-image) | 支持上传自定义镜像到派欧云平台,以便查看和管理。 | | [管理模板](/docs/gpu/save-image) | 模板包含了实例的配置信息,用于快速批量创建实例。派欧云平台提供了官方模版供您直接使用,您也基于自身业务的常用配置创建自定义模板。 | | [修改实例配置](/docs/gpu/edit-instance) | 支持扩容系统盘容量,修改实例的对外 HTTP 端口和对外 TCP 端口。 | | [升级实例镜像](/docs/gpu/upgrade-instance) | 如果业务有所变更,可以升级实例镜像,支持修改实例的 Docker 镜像、容器启动命令和容器环境变量。 | | [保存实例镜像](/docs/gpu/save-image) | 支持将已有实例的当前环境导出为 Docker 镜像,以便后续可以使用该镜像快速批量部署相同环境的实例。 | | [迁移实例](/docs/gpu/save-image) | 支持迁移已有实例到其他节点。迁移后实例信息(实例 ID、IP等)不会改变,但迁移会导致系统盘和本地盘的数据丢失,需提前备份数据。 | | [Jupyter Lab](/docs/gpu/jupyterlab) | 派欧云平台提供的官方镜像模板自带了 Jupyter Lab 环境,如需使用,可在创建实例时勾选 「启动 Jupyter」。 | ## 云存储 | 功能 | 说明 | | - | - | | [创建云存储](/docs/gpu/manage-cloud-storage#创建云存储) | 如果容器有共享存储的需求,可以创建云存储。 | | [使用云存储](/docs/gpu/manage-cloud-storage#使用云存储) | 创建 GPU 容器实例或者 Serverless Endpoint 时,可以为容器挂载云存储。 | | [扩容云存储](/docs/gpu/manage-cloud-storage#扩容云存储) | 如果云存储的容量不足,可以按需扩容。 | | [删除云存储](/docs/gpu/manage-cloud-storage#删除云存储) | 如果不再使用云存储,建议及时删除避免持续计费。删除前,请确保已备份所需数据。 | ## Serverless Endpoint | 功能 | 说明 | | - | - | | [创建 Endpoint](/docs/gpu/create-serverless-endpoint) | Serverless Endpoint 包含 Worker(即 GPU 容器实例)、负载均衡器、弹性伸缩器等组件,可以运行 GPU 容器业务,并根据业务请求实现自动弹性伸缩和负载均衡。 | | [管理 Endpoint](/docs/gpu/manage-serverless-endpoint) | 支持修改Serverless Endpoint的配置;如果不再使用,可以删除。 | ## 其他 | 功能 | 说明 | | - | - | | [加速服务](/docs/gpu/accelerate) | 针对 GitHub、Hugging Face 等常用站点,派欧云平台支持开启加速服务,提升资源下载速度。 | # GPU 容器实例计费说明 Source: https://ppio.com/docs/gpu/gpu-instance-pricing 查阅 PPIO GPU 容器实例的计费方式、费用项目与相关规则,了解不同使用方式的成本构成,为算力预算和实例选择提供参考。 ## 计费概述 ### 计费方式 GPU 容器实例支持以下几种计费方式: * **包年包月**:一种预付费的计费方式,即先付费再使用。通过预先支付一定时间的费用,来获得一定的折扣优惠。 * **按量计费**:一种后付费的计费方式,即先使用再付费。可以根据业务需求随时创建和释放资源,为实际使用时长付费。 * **抢占式(Spot)**:计费规则与按量计费类似,先使用再付费,为实际使用时长付费。价格相比按量计费可以优惠50%,但使用该计费方式的实例在资源库存不足时会被中断回收。详情请参见[抢占式 GPU 实例](/docs/gpu/spot-instance)。 ### 计费项 | **计费项** | **是否必选** | **计费说明** | **计费方式** | **账单类型** | | :- | :- | :- | :- | :- | | 计算资源 | 必选 | 计算资源包括 CPU、内存和 GPU,以实例规格的形式提供,整体一起计费。 | 包年包月、按量计费、抢占式 | 实例 | | 系统盘 | 必选 | 一个实例带有一块系统盘,支持 130 GB 的免费额度。超出免费额度后,将对超出部分收取系统盘费用。 | 和实例(计算资源)一致 | 存储 | | 云存储 | 可选 | 您可以按需为实例挂载云存储。云存储按照容量和使用时长,单独计费。 | 按量计费 | 存储 | #### 计算资源 计算资源包括 CPU、内存和 GPU,以实例规格的形式提供,整体一起计费。您可以基于业务特点,参考下表为实例选择合适的计费方式。 | **计费说明** | **包年包月** | **按量计费** | 抢占式(Spot) | | :- | :- | :- | - | | 计费公式 | 单个实例费用 = 规格包年包月单价 \* GPU 数 \* 计费时长 | 单个实例费用 = 规格按量计费单价 \* GPU 数 \* 计费时长 | 单个实例费用 = 规格抢占式计费单价 \* GPU 数 \* 计费时长 | | 资源价格 | 在[算力市场页面](https://ppio.com/gpu-instance/console),选择「计费方式」为「包年包月」,即可查看各个规格的包年包月单价。 | 在[算力市场页面](https://ppio.com/gpu-instance/console),选择「计费方式」为「按量计费」,即可查看各个规格的按量计费单价。 | 在[算力市场页面](https://ppio.com/gpu-instance/console),选择「计费方式」为「抢占式计费」,即可查看各个规格的按量计费单价。 | | 计费时长 | 购买时选择的租用时长,支持1~12个月。从实例创建成功进入运行中状态的时间(精确到秒)开始计费,按照租用时长自动计算到期时间。 | 实例的实际运行时长,精确到秒。从实例创建成功进入运行中状态的时间开始计费,到实例释放或停止后停止计费。期间如果实例处于非运行中状态,也不计费。 | 实例的实际运行时长,精确到秒。抢占式实例在1小时保护内能稳定运行,您可以按需开关机或释放。超出保护期后,抢占式实例随时可能被释放(资源库存不足会触发中断回收,提前1小时发送回收通知)。 | | 付费方式 | 预付费,在购买时一次性付清实例费用。 | 后付费,在使用后再根据账单(按小时出账)支付实例费用。 | 后付费,在使用后再根据账单(按小时出账)支付实例费用。 | | 适用场景 | 较为稳定,需要长期使用资源的业务。 | 具有波动性和临时性,无法预估资源使用时长的业务。 | 短期运行,可以容忍中断的业务。 | | 成本优化 | 包年包月的实例在购买时选择的租用时间越长,折扣越大。 | 处于运行中状态的按量计费实例,即使未运行业务,也会持续计费。如需节约成本,请停止或者释放未运行业务的实例。 | / | #### 系统盘 一个实例带有一块系统盘,支持 130 GB 的免费额度。超出免费额度后,将收取系统盘费用。 * **计费方式**:和实例(计算资源)一致。如果是包年包月实例,则随计算资源一起预付费用;如果是按量计费实例,则单独按秒计费,按天出账。 * **计费公式**:系统盘费用 = 超出容量 \* 系统盘单价 \* 计费时长。 * 超出容量:按需设置容量,大于免费额度的部分为超出容量。 * 系统盘单价:0.01 元/GB/天。 * 计费时长:系统盘的使用时长(即实例从创建到释放的时长),按秒计算。 #### 云存储 云存储按照容量和使用时长单独计费。一个云存储可以被多个实例共享使用。 * **计费方式**:按量计费。按秒计费,按天出账。 * **计费公式**:云存储费用 = 云存储容量 \* 云存储单价 \* 计费时长。 * 云存储容量:按需设置容量。取值范围为 10 GB \~ 4 TB。 * 云存储单价:0.01 元/GB/天。 * 计费时长:云存储从创建到释放的使用时长,按秒计算。 ### 计费示例 > [!TIP] > > 以下计费示例中涉及的价格信息仅供参考,实际价格以平台显示和账单为准。 * 示例一 创建了一台按量计费的实例,实例规格为 RTX 3090 24GB(单价为 1.39 元/小时),GPU 数为 2,系统盘容量为 100 GB,不使用云存储。则每小时的实例费用 = 1.39 \* 2 \* 1 = 2.78 元。 * 示例二 创建了一台包年包月的实例,实例规格为 RTX 3090 24GB(单价为 859.68 元/月),GPU 数为 1,系统盘容量为 150 GB,不使用云存储。假设租用时长为 1 个月(31天),则需要预付的费用包括实例费用和系统盘费用。 * 实例费用 = 859.68 \* 1 \* 1 = 859.68 元。 * 系统盘费用 =(150 - 130 )\* 0.01 \* 31 = 6.2 元。 * 示例三 创建了一台按量计费的实例,实例规格为 RTX 3090 24GB(单价为 1.39 元/小时),GPU 数为 1,系统盘容量为 150 GB,使用的云存储为10 GB。则每小时需要支付实例费用,每天需要支付存储费用(包括系统盘和云存储)。 * 每小时的实例费用 = 1.39 \* 1 \* 1 = 1.39 元。 * 每天的系统盘费用 = (150 - 130 )\* 0.01 \* 1 = 0.2 元。 * 每天的云存储费用 = 10 \* 0.01 \* 1 = 0.1 元。 ## 转换计费方式 按量计费实例支持转为包年包月实例,以便提前预留资源,并获得一定的价格优惠。 > [!TIP] > > 目前暂不支持包年包月实例转为按量计费实例。 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances)。 2. 找到按量计费的实例,单击「更多操作」,然后选择「转包年包月」。 3. 在弹出的对话框中,选择时长并确认到期时间和费用,以及选择是否开启自动续费,然后单击「确认」。 ## 续费实例 包年包月实例的租用时长到期后,如果没有续费,实例会自动关机(停止)。关机后,数据会保留 7 天,如果在 7 天内没有及时续费并启动实例,数据将被清除并且不可恢复。 ### 手动续费 临近实例到期日,系统会给您发送相关通知提醒(例如短信),请在到期前及时续费,避免因实例关机甚至释放,而影响业务运行,甚至丢失数据。 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances)。 2. 找到包年包月的实例,单击「续费」。 3. 在弹出的对话框中,选择续费时长,并确认到期时间和费用,然后单击「确认」。 ### 自动续费 您可以为实例开启自动续费,系统会自动在到期前3天开始尝试扣款来续费实例,如果扣款失败则会自动重试到到期日(请及时充值),到期后仍扣款失败则会转为按量计费。 * **新建实例** 创建实例时,如果选择「包年包月」计费方式,可在最后一步确认计费方式时,打开「自动续费」开关并设置「续费周期」。 * **已有实例** 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances)。 2. 单击包年包月的实例,然后单击「更多操作」,在菜单中选择「设置自动续费」。 3. 在弹出的对话框中,确认当前到期时间,打开「自动续费」开关并设置「续费时长」,然后单击「确认」。 > [!TIP] > > 如果后续不再需要,请及时关闭自动续费,避免系统自动扣款造成不必要的资金损失。 ## 查看账单 您可以按照计费方式、计费项、统计时间等多个维度查看和导出账单。 1. 进入[费用明细页面](https://ppio.com/billing/billing-details)。 2. 按需单击「按量账单」或者「包年包月账单」,然后单击「GPU 实例」或「存储」。 * 「GPU 实例」包括计算资源的账单。 * 「存储」包括系统盘账单和云存储账单。 3. 设置查询条件,查看账单。 如需进一步操作账单数据,可在查询后单击「导出账单」,将账单数据导出为.xlsx文件。 ## 欠费说明 结算账单时,如果账户的可用额度(包括账户可用余额和代金劵余额)小于待支付的账单,则视为账户欠费。欠费后,可能会导致资源释放,数据丢失,进而影响业务运行。在使用期间,请确保账户额度充足。欠费后,系统会给您发送相关通知提醒(例如短信),请及时充值。 > [!TIP] > > 您可以在[账户概览页面](https://ppio.com/billing),确认账户余额和代金券情况,按需进行充值,或者设置余额预警。详情请参见[账户充值](/docs/support/payment-methods)。 具体的欠费影响如下: * 无法创建新的实例和云存储。 * 已有的包年包月实例在到期前可以继续使用。 * 已有的按量计费实例会在欠费 30 分钟后停机,如果没有及时充值,欠费停机的实例会在 7 天后释放,并自动清理数据。 * 云存储无法使用,数据会在 3 天后自动释放。 ## 退订说明 如果您不想继续使用 GPU 容器实例,请及时释放(删除) 实例、云存储等资源,确保各个资源已停止计费,避免产生不必要的费用损失。 * 对于按量计费的资源,先使用再付费,因此不涉及退款。 * 对于包年包月的资源,目前暂不支持退款。如有需求,请[联系我们](https://ppio.com/contact)。 # GPUs SDK 使用指南 Source: https://ppio.com/docs/gpu/gpus-sdk-usage 查阅 PPIO GPUs SDK 的使用说明,了解通过代码接入 GPU 服务的方式,为将实例与相关资源管理整合进开发流程提供参考。 本文介绍如何使用 `ppio-gpus` SDK 调用 Async Serverless Endpoint,以及如何自定义 worker handler。 ## 1. 安装 SDK 在客户端环境或 worker 运行环境中安装 SDK: ```bash Bash icon="terminal" theme={null} pip install ppio-gpus ``` ## 2. 使用 SDK 提交任务 `ppio-gpus` SDK 默认请求地址为 `https://async-public.serverless.ppinfra.com/v1`。调用时只需要设置 API Key,并使用 Endpoint 名称创建客户端。这里的 API Key 用于客户端提交、查询、取消任务,不用于 worker 拉取任务或回传结果。 ```python Python icon="python" theme={null} import ppio_gpus ppio_gpus.api_key = "sk_xxxx" endpoint = ppio_gpus.Endpoint("0f43a6867e05fddd") job = endpoint.run({ "prompt": "a red apple on a table" }) print(job.status()) output = job.output(timeout=300) print(output) ``` ## 3. ComfyUI 任务示例 对于 `image.ppinfra.com/prod-gpucloudpublic/comfyui-worker:v0.0.1`,任务输入需要包含 ComfyUI workflow。下面是一个最小示例: ```python Python icon="python" theme={null} import ppio_gpus ppio_gpus.api_key = "sk_xxxx" endpoint = ppio_gpus.Endpoint("0f43a6867e05fddd") job = endpoint.run({ "workflow": { "4": { "class_type": "CheckpointLoaderSimple", "inputs": {"ckpt_name": "flux1-dev-fp8.safetensors"}, }, "5": { "class_type": "EmptyLatentImage", "inputs": {"width": 512, "height": 512, "batch_size": 1}, }, "6": { "class_type": "CLIPTextEncode", "inputs": {"clip": ["4", 1], "text": "a red apple on a table"}, }, "7": { "class_type": "CLIPTextEncode", "inputs": {"clip": ["4", 1], "text": "blurry, low quality"}, }, "3": { "class_type": "KSampler", "inputs": { "model": ["4", 0], "positive": ["6", 0], "negative": ["7", 0], "latent_image": ["5", 0], "seed": 42, "steps": 10, "cfg": 7, "sampler_name": "euler", "scheduler": "normal", "denoise": 1, }, }, "8": { "class_type": "VAEDecode", "inputs": {"samples": ["3", 0], "vae": ["4", 2]}, }, "9": { "class_type": "SaveImage", "inputs": {"filename_prefix": "test", "images": ["8", 0]}, }, }, "output_node_id": "9", }) print(job.status()) print(job.output(timeout=300)) ``` ## 4. 自定义 Handler worker 侧使用 `ppio_gpus.start({"handler": handler})` 启动任务循环。平台会把任务内容传入 `handler(job)`: * `job["id"]`:当前 job id * `job["input"]`:提交任务时的 input 内容 * handler 返回的内容会作为任务 output * 如果返回 dict 中包含 `error` 字段,任务会被标记为失败 最小 handler 示例: ```python Python icon="python" theme={null} import time import ppio_gpus def handler(job: dict) -> dict: job_id = job["id"] job_input = job.get("input", {}) prompt = job_input.get("prompt", "hello") ppio_gpus.progress_update(job, { "status": "running", "message": "job accepted", }) time.sleep(1) return { "job_id": job_id, "prompt": prompt, "result": "ok", } if __name__ == "__main__": ppio_gpus.start({"handler": handler}) ``` ## 5. 返回图片或文件 Async Serverless Endpoint 的 `status` 接口返回结果有大小限制。图片、视频等大文件建议先上传到对象存储,再在 output 中返回 URL。 在 Endpoint 环境变量中配置对象存储: ```bash Bash icon="terminal" theme={null} BUCKET_ENDPOINT_URL=https:// BUCKET_ACCESS_KEY_ID= BUCKET_SECRET_ACCESS_KEY= BUCKET_NAME= ``` handler 中上传图片: ```python Python icon="python" theme={null} import ppio_gpus def handler(job: dict) -> dict: image_url = ppio_gpus.upload_image(job["id"], "/tmp/output.png") return { "images": [ { "filename": "output.png", "url": image_url, } ] } if __name__ == "__main__": ppio_gpus.start({"handler": handler}) ``` ## 6. 常见问题 ### handler 返回什么会被认为失败? 如果 handler 返回 dict 且包含 `error` 字段,任务会被标记为失败: ```python Python icon="python" theme={null} return {"error": "invalid input"} ``` # 镜像预热 Source: https://ppio.com/docs/gpu/image-pre-warming 了解 PPIO GPU 服务的镜像预热功能与配置方式,查阅相关操作流程,为部署前准备容器镜像和管理运行环境提供参考。 镜像预热功能支持将指定镜像从源镜像仓库提前同步至集群的本地缓存。当实例启动或 Serverless 场景触发弹性扩容时,可直接从本地缓存加载镜像,避免从远端仓库拉取,提升启动性能并优化扩缩容响应时间。 > [!NOTE] > > 默认情况下:系统会在集群内选择缓存节点进行镜像预热,其他节点在启动实例或扩容时将通过内网从该节点拉取镜像。 ## 操作步骤 1. **进入镜像管理页面**。 2. **创建预热任务**: 点击 **“创建预热任务”** 按钮,进入任务创建页面并完成以下配置: * 可**手动输入镜像地址**,或**直接选择已创建的预热模板**以加载模板中配置的镜像。 * 若镜像位于**非公共仓库**,需选择**已提前配置的镜像仓库认证信息**。 * 选择目标**预热区域**。 * 选择需要预热的**卡型**(GPU/加速卡类型);如未选择,系统将默认对**所有卡型**执行预热。 * 点击 **“确认创建”**,系统将生成镜像预热任务。 3. **查看任务状态**: 可在**预热任务列表**中实时查看任务进度和状态。 4. **基于预热镜像创建模板**: 预热完成后,可直接基于已预热的镜像**创建镜像模板**,用于后续实例或服务部署。 > [!WARNING] > > 注意事项: > > 镜像预热过程中会在集群内多个节点并行拉取镜像。请提前确认源镜像仓库是否存在**访问限流策略**。 > > 若存在限流或带宽限制,可能导致预热任务长时间处于执行状态或失败。 ## Quota限制 当前镜像预热功能默认支持**同时存在最多 5 个预热任务**,且**单次任务的镜像拉取配额上限为 100 GB**。 如需调整任务并发数量或单次拉取配额,请联系技术支持协助配置。 # 使用Jupyter Lab Source: https://ppio.com/docs/gpu/jupyterlab 查阅在 PPIO GPU 实例中使用 Jupyter Lab 的指南,了解云端交互式开发环境的访问与使用方式,为模型实验和代码调试提供参考。 Jupyter Lab 是一个交互式笔记本,支持运行 40 多种编程语言。Jupyter Lab 的本质是一个开源的 Web 应用程序,便于创建和共享文学化程序文档,支持实时代码,数学方程,可视化和 markdown 等编辑功能。 PPIO 派欧云平台提供的「官方模版」中的镜像自带了 Jupyter Lab 环境,您可以按需使用。 ## 启动 Jupyter Lab 在创建实例时使用官方模板,然后选中「启动 Jupyter」,即可启动Jupyter Lab。 > [!NOTE] > > 部分「官方模版」可能不支持 Jupyter Lab 环境,如有需求,可[联系我们](https://ppio.com/contact)。 ![Jupyter](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/Jupyter.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=08947df78d130bf95f832204a58797eb) ## 访问 Jupyter Lab 实例创建成功后,可通过以下步骤访问 Jupyter Lab: 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances)。 2. 单击目标实例,然后单击「连接」。 3. 在弹出的对话框中,单击「连接到 Jupyter Lab」即可跳转到实例部署的 Jupyter Lab。 ![连接Jupyter Lab](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/connect-Jupyter.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=921621a2a3202f128d3d06fa5e51e90c) 4. 使用 Jupyter Lab。 ![使用Jupyter Lab](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/use-Jupyter.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=d52a53bf5649d610412c190ecce6f36a) # 管理云存储 Source: https://ppio.com/docs/gpu/manage-cloud-storage 了解 PPIO GPU 容器相关云存储的管理方式,查阅存储创建、使用与维护流程,为模型文件和应用数据准备合适的存储资源。 云存储能为 GPU 容器实例提供存储空间,其具有独立的生命周期,有大容量、可扩展、低成本等特点。如果容器有共享存储的需求,可以创建云存储。 ## 计费说明 云存储按照容量和使用时长单独计费,单价为 0.01 元/GB/天。详情请参见[云存储计费](/docs/gpu/gpu-instance-pricing#云存储)。 ## 注意事项 * 云存储按秒计费。如果账户欠费,且无运行中的实例,云存储空间将在 3 天后自动释放。 * 云存储是在使用 GPU 执行任务时提供的,不作为长期的数据备份解决方案。强烈建议您及时在本地或云服务商处备份数据。 ## 创建云存储 1. 进入[存储管理页面](https://ppio.com/gpu-instance/console/storage)。 2. 单击「创建云存储」。 3. 配置云存储相关参数,然后单击「确认」. * 集群:根据实例地区选择云存储集群。云存储所在集群与实例为强绑定关系,暂不支持跨集群挂载云存储至实例。 * 云存储名称:输入名称,自定义。 * 容量:输入云存储的容量,最小为 10 GB。 ## 使用云存储 创建 GPU 容器实例 或者 Serverless Endpoint 时,可以为容器挂载云存储。 * [创建 GPU 容器实例](/docs/gpu/create-instances) * [创建 Serverless Endpoint](/docs/gpu/create-serverless-endpoint) ## 扩容云存储 如果云存储的容量无法满足现有需求,可以进行扩容。扩容时,不会影响云存储中的原有数据。 1. 进入[存储管理页面](https://ppio.com/gpu-instance/console/storage)。 2. 找到要扩容的云存储,单击![operation](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/operation.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=78594517e382f700f166f8dc6b019781),然后单击「编辑」。 3. 修改云存储的容量为要扩容到的容量。 > [!NOTE] > > 仅支持扩容,不支持缩容,即修改的容量大小不能低于修改前的容量大小。 ## 删除云存储 正在被实例挂载的云存储无法被删除。对于不再使用的云存储,建议及时删除避免持续计费。 > [!WARNING] > > 删除为不可逆操作,为避免数据丢失,请谨慎操作。 > > * 删除前,请确保已备份所需数据。 > * 删除后,云存储的数据无法恢复。 1. 进入[存储管理页面](https://ppio.com/gpu-instance/console/storage)。 2. 找到要删除的云存储,单击![operation](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/operation.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=78594517e382f700f166f8dc6b019781),然后单击「删除」。 # 管理容器镜像 Source: https://ppio.com/docs/gpu/manage-docker-image 查阅 PPIO 容器镜像管理指南,了解镜像资源的使用与维护方式,为在 GPU 实例中部署自定义软件环境提供操作参考。 PPIO 派欧云平台提供了镜像仓库供您使用,可用的存储容量为 500 GB。您可以将您的容器镜像上传到平台,实现对自定义镜像的统一管理。 ## 上传自定义镜像 1. 获取镜像上传凭证。 在[安全凭证管理页面](https://ppio.com/gpu-instance/console/settings),您可以获取镜像上传凭证,包括镜像仓库地址,以及登录所需的用户名和密码。 2. 登录派欧云平台的镜像仓库。 在您镜像所在的 Docker 环境,执行以下命令登录镜像仓库。请根据获取的镜像上传凭证替换用户名和密码信息(单击「镜像上传凭证」处的「复制信息」可以直接生成对应的命令)。 ```bash theme={null} docker login image.ppinfra.com --username=****** --password=****** ``` 3. 向派欧云平台的镜像仓库推送镜像。 在您镜像所在的 Docker 环境,执行以下命令推送镜像。请使用实际的镜像信息、镜像上传凭证中的地址信息替换以下命令。 ```bash theme={null} docker tag [imageId] image.ppinfra.com/prod-xgmdbroksk******/[image]:[tag] docker push image.ppinfra.com/prod-xgmdbroksk******/[image]:[tag] ``` 4. 进入[镜像管理页面](https://ppio.com/gpu-instance/console/image),确认镜像上传成功,并且状态为正常。 ![image](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/image.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=36e4eee9aef2e04bf3de8f27050cdcff) ## 管理自定义镜像 进入[镜像管理页面](https://ppio.com/gpu-instance/console/image),可以查看和管理您上传的自定义镜像。 * **编辑**:可以修改镜像名称。 * **删除**:如果镜像不再使用,可以及时删除,以释放镜像仓库的空间。 > [!TIP] > > 在[安全凭证管理页面](https://ppio.com/gpu-instance/console/settings)的「镜像仓库上传凭证」处,可以查看当前镜像仓库已使用的存储容量。 # 管理实例 Source: https://ppio.com/docs/gpu/manage-instances 了解 PPIO GPU 容器实例的日常管理流程,查阅实例启动、停止、重启和释放等操作,为维护计算任务与资源状态提供参考。 ## 启动实例 对于已停止的实例,如需继续使用,可以启动实例。 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances)。 2. 单击目标实例,然后单击「更多操作」,在菜单中选择「启动」。 3. 在弹出的对话框中,确认提示信息,然后单击「启动」。 等待实例状态从**待启动**变更为**运行中**,表示启动成功。 ## 停止实例 对于暂时不使用的实例,您可以停止实例(即关机)。 > [!WARNING] > > 停止实例会中断您的业务,请谨慎操作。 **停止实例的影响** * 按量计费实例 * 停止后,数据将保留7天,7天后数据会被清理。如有重要数据,请提前做好备份。 * 停止后,如有其他用户抢占资源,您的实例可能无法正常启动。 * 包年包月实例 * 停止后,到期时间**不会**延长。 **操作步骤** 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances)。 2. 单击目标实例,然后单击「更多操作」,在菜单中选择「停止」。 3. 在弹出的对话框中,确认提示信息,然后单击「停止」。 等待实例状态从**待停止**变更为**已停止**,表示停止成功。 ## 重启实例 对于运行中的实例,支持重启操作。 > [!WARNING] > > 重启实例会造成一定时间的实例停止,可能导致业务中断,建议您在非业务高峰期时执行该操作。 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances)。 2. 单击目标实例,然后单击「更多操作」,在菜单中选择「重启」。 3. 在弹出的对话框中,确认提示信息,然后单击「重启」。 等待实例状态从**重启中**变更为**运行中**,表示重启成功。 ## 释放实例 对于不再使用的实例,您可以释放该实例,避免产生不必要的费用。目前仅支持释放按量计费实例,不支持释放包年包月实例。 > [!WARNING] > > 释放为不可逆操作,该操作会删除您的实例配置以及除云存储外的其他数据。实例释放后数据无法恢复,如有需要保存的数据,请提前备份。 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances)。 2. 单击目标实例,然后单击「更多操作」,在菜单中选择「删除」。 3. 在弹出的对话框中,确认提示信息,然后单击「确定」。 # 管理 Serverless Endpoint Source: https://ppio.com/docs/gpu/manage-serverless-endpoint 查阅 PPIO Serverless Endpoint 的管理流程,了解端点信息查看与配置维护方式,为运行和维护 AI 推理服务提供参考。 在 [Serverless GPUs 页面](https://ppio.com/gpu-instance/console/serverless),您可以查看和管理 Endpoint,包括查看 Worker 数量和运行状态,修改 Endpoint 配置,查看 Endpoint 日志等。 ## 查看 Endpoint 1. 进入 [Serverless GPUs 页面](https://ppio.com/gpu-instance/console/serverless),单击目标 Endpoint 的下拉图标。 2. 查看 Endpoint 信息。 可以看到Endpoint 的配置信息,当前 Worker 数量和运行状态,以及 Worker 日志。 如需查看 Endpoint 日志,可单击「日志」。 ## 修改 Endpoint 1. 进入 [Serverless GPUs 页面](https://ppio.com/gpu-instance/console/serverless),单击目标 Endpoint 的下拉图标。 2. 单击对应的![edit](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/edit.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=4aad7045aaeca538a45a28cbc9169fd3)。 3. 按需修改配置,然后单击「保存修改」。 除了应用名称无法修改外,其他配置均可修改。关于各配置的说明,请参见[创建 Serverless Endpoint](/docs/gpu/create-serverless-endpoint#4-创建-endpoint)。 ## 删除 Endpoint 1. 进入 [Serverless GPUs 页面](https://ppio.com/gpu-instance/console/serverless),单击目标 Endpoint 的下拉图标。 2. 单击对应的![edit](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/delete.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=405e4166f1adabb6a2ec7a90fb5d3986)。 3. 确认提示信息,并复制输入 Endpoint 名称,然后单击「删除」。 # 管理模板 Source: https://ppio.com/docs/gpu/manage-template 了解 PPIO GPU 容器部署模板的管理方式,查阅模板创建与维护流程,为复用运行环境和配置不同计算任务提供参考。 模板保存了实例的配置信息,可用于批量快速创建实例,避免重复配置,提高配置效率。 模板包括以下两种: * **官方模板**:PPIO 派欧云平台提供了部分常用环境作为官方模版,您可以直接使用。 * **自定义模板**:您基于自身业务的常用配置,自行创建的模板。 ## 使用官方模板 在[算力市场页面](https://ppio.com/gpu-instance/console/explore),在「当前模板」处单击「选择模板」,在弹出页面可以查看所有官方模板。 * 如需了解更多配置信息,可单击「模板详情」。 * 如需使用该模板创建实例,可单击「使用模板」。 ![官方模板](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/template.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=c0e2fb8490f98e2f60ccb12a79b58167) ## 创建自定义模版 如果官方模板不符合使用需求,您可以创建自定义模板。 1. 进入[模板管理页面](https://ppio.com/gpu-instance/console/templates)。 2. 单击「创建模板」。 3. 完成模板参数配置,然后单击「确认」。 | **配置项** | **说明** | | - | - | | **模板名称** | 模板标识,自定义输入。 | | **容器镜像** | 用于部署容器的镜像地址。 | | **镜像仓库认证凭证** | 如果镜像来源于私有镜像仓库,需配置认证凭证以访问该镜像仓库。 | | **容器启动命令** | 启动容器后要执行的命令。该配置会覆盖镜像构建时设置的 CMD。 | | **系统盘** | 系统盘的容量大小。超出免费额度需要支付存储费用。 | | **对外 HTTP 端口**、**对外 TCP 端口**。 | 实例对外开放的端口。请根据服务的具体需求选择暴露的端口,平台将为您的服务提供灵活的端口映射功能。支持多个端口的输入,使用英文半角逗号(,)分隔。请确保所选端口与您的应用程序配置相匹配。合理配置端口可以提高服务的可访问性和安全性。 | | **环境变量** | 用于配置操作系统的环境变量,您可以在此设置所需的环境变量,以便在实例启动时自动初始化。这些环境变量可以影响应用程序的运行方式,例如设置路径或调整性能参数。 | | **README** | README 信息,请使用 Markdown 语法输入。 | ## 管理自定义模板 进入[模板管理页面](https://ppio.com/gpu-instance/console/templates),您可以管理已有的自定义模板。 ![管理模板](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/manage-template.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=b9d84413b6b6259fe6e2465f182e4737) > [!TIP] > > 如果想基于已有模板的配置来快速创建新的模板,可先复制模板,然后再修改模板。 ### 修改模板 如果要修改模板配置,可单击目标模板对应的![edit](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/edit.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=4aad7045aaeca538a45a28cbc9169fd3),然后在弹出页面按需修改配置,修改完成后单击「确认」。 ### 复制模板 单击目标模版对应的![edit](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/copy.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=fc9751529ea7b30294f88b466395f9fd),可快速创建一个相同配置的模板。 ### 删除模板 对于不再使用的模板,可单击对应的![edit](https://mintcdn.com/ppinfra/pGuwYZ6NEz3RzrAp/gpu/image/delete.png?fit=max\&auto=format\&n=pGuwYZ6NEz3RzrAp\&q=85\&s=405e4166f1adabb6a2ec7a90fb5d3986),确认后即可删除。 # 迁移实例 Source: https://ppio.com/docs/gpu/migrate-instance 查阅 PPIO GPU 容器实例的迁移流程与使用说明,了解迁移前需要核对的实例状态和操作步骤,为调整资源位置提供参考。 对于已停止的实例,如果由于资源被抢占而启动失败,您可以迁移实例。 ## 注意事项 * 迁移后,实例信息(实例ID、出口IP等)不会发生变化,但迁移会导致系统盘的数据丢失,请提前备份重要数据。 * 以下原因可能导致迁移失败,请联系技术支持。 * 迁移时仅支持同集群迁移,同集群无空闲资源时会迁移失败。 * 如果实例镜像过大(超过 200 GB),可能会迁移失败。 ## 操作步骤 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances)。 2. 单击目标实例,然后单击「更多操作」,在菜单中选择「迁移实例」。 3. 在弹出的对话框中,确认提示信息,然后单击「迁移」。 # 在 GPU 容器实例中运行 MinerU Tianshu 实现文件格式转换 Source: https://ppio.com/docs/gpu/mineru-tianshu 了解如何在 PPIO GPU 容器实例中运行 MinerU Tianshu,按照教程准备应用环境并进行文件格式转换,为文档处理任务提供实践参考。 ## 什么是 MinerU Tianshu MinerU Tianshu 是一个企业级多 GPU 文档解析服务,适用于 RAG 数据预处理等场景。它结合 SQLite 任务队列 + LitServe GPU 负载均衡,支持将 PDF 等多种格式的文档转换为 Markdown 或 JSON 结构化数据,可以解决文档解析、多 GPU 调度、任务管理等生产环境痛点。 MinerU Tianshu 的核心特性如下: * **高性能架构** * Worker 主动拉取:0.5秒响应速度,无需调度器触发 * 并发安全:原子操作防止任务重复,支持多 Worker 并发 * GPU 负载均衡:LitServe 自动调度,避免显存冲突 * 多 GPU 隔离:每个进程只使用分配的 GPU ,彻底解决多卡占用 * **企业级功能** * 异步处理:客户端立即响应(\~ 100 ms),无需等待处理完成 * 任务持久化:SQLite 存储,服务重启任务不丢失 * 优先级队列:重要任务优先处理 * 自动清理:定期清理旧结果文件,保留数据库记录 * **智能解析** * 双解析器:PDF / 图片用 MinerU(GPU加速), Office / HTML 等用 MarkItDown(快速) * 内容获取:API 自动返回 Markdown 内容,支持图片上传到 MinIO * RESTful API:支持任何编程语言接入 * 实时查询:随时查看任务进度和状态 如需了解更多,请在[MinerU 项目官方网站](https://github.com/opendatalab/MinerU/tree/master)上查看详细信息。 ## 运行 MinerU Tianshu 1. 进入[算力市场页面](https://ppio.com/gpu-instance/console/explore)。 2. 单击「选择模板」,找到 **MinerU Tianshu** ,单击「使用模板」。 ![tianshu-1](https://mintcdn.com/ppinfra/-ffZxKUcWcNh5Zwk/gpu/image/tianshu-1.png?fit=max\&auto=format\&n=-ffZxKUcWcNh5Zwk\&q=85\&s=483ee71490aa09a1134a5a53a40330e9) 3. 按照需要,选择计费方式、地区、实例规格等配置。 ![tianshu-2](https://mintcdn.com/ppinfra/-ffZxKUcWcNh5Zwk/gpu/image/tianshu-2.png?fit=max\&auto=format\&n=-ffZxKUcWcNh5Zwk\&q=85\&s=52fcf125c3b942cc6b6b4dd5c9b6a585) 4. 检查磁盘大小,并在环境变量中替换 OSS 信息。 ![tianshu-3](https://mintcdn.com/ppinfra/-ffZxKUcWcNh5Zwk/gpu/image/tianshu-3.png?fit=max\&auto=format\&n=-ffZxKUcWcNh5Zwk\&q=85\&s=db1fb3299d4fb0661cc85f6fbd6717b6) 5. 确认配置无误后,单击「部署」。 6. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances),查看新创建的实例。等待实例创建成功,状态变为运行中。 ![tianshu-4](https://mintcdn.com/ppinfra/-ffZxKUcWcNh5Zwk/gpu/image/tianshu-4.png?fit=max\&auto=format\&n=-ffZxKUcWcNh5Zwk\&q=85\&s=f0135854e4bec3443afd03cbb3725a8a) 7. 查看实例日志,确保服务正常启动。 ![tianshu-5](https://mintcdn.com/ppinfra/-ffZxKUcWcNh5Zwk/gpu/image/tianshu-5.png?fit=max\&auto=format\&n=-ffZxKUcWcNh5Zwk\&q=85\&s=b5c30c197d0ca6a4cb8b89c69c22b640) ## 使用 MinerU Tianshu 1. 在[实例管理页面](https://ppio.com/gpu-instance/console/instances),单击实例对应的「连接」。 2. 在弹出的对话框中,获取 HTTP 服务地址。 ![tianshu-7](https://mintcdn.com/ppinfra/-ffZxKUcWcNh5Zwk/gpu/image/tianshu-7.png?fit=max\&auto=format\&n=-ffZxKUcWcNh5Zwk\&q=85\&s=4cab6056b34f481fba7f1d25cac13c00) 3. 启动 Web Terminal,然后通过 Web Terminal 远程连接实例。 ![tianshu-6](https://mintcdn.com/ppinfra/-ffZxKUcWcNh5Zwk/gpu/image/tianshu-6.png?fit=max\&auto=format\&n=-ffZxKUcWcNh5Zwk\&q=85\&s=db11d5cbfd949fd14464d8135ff91e6d) 4. 在 Web Terminal 中,切换到`/vllm-workspace/MinerU/projects/mineru_tianshu`目录。 5. 创建 test_auto_upload_images.py。 test_auto_upload_images.py 的代码示例如下,请将`API_BASE_URL`的值替换为实际的 HTTP 服务地址,将`LOCAL_PDF_PATH`的值和`OUTPUT_DIR`的值替换为测试的实际路径。 ```bash theme={null} # ==================== 配置 ==================== API_BASE_URL = "http://localhost:8000" LOCAL_PDF_PATH = "./1.pdf" # 要上传的 PDF 文件路径 OUTPUT_DIR = "./auto_upload_output" # 本地保存目录 ``` 6. 运行 test_auto_upload_images.py。 ```bash theme={null} python3 test_auto_upload_images.py ``` 预期返回: ```bash theme={null} ============================================================ MinerU Tianshu - 自动上传图片到对象存储示例 ============================================================ 📋 Step 1: Submit task ------------------------------------------------------------ 📤 Submitting task: demo1.pdf Backend: http-client Parse method: auto Languages: ['zh'] ✅ Task submitted successfully! Task ID: 4c18cb2b-ff8c-4d14-b9a6-d2e80c64f9f3 📋 Step 2: Wait for task completion ------------------------------------------------------------ ⏳ Waiting for task 4c18cb2b-ff8c-4d14-b9a6-d2e80c64f9f3 to complete... Status: pending (elapsed: 0.0s) Status: processing (elapsed: 2.0s) Status: processing (elapsed: 4.0s) Status: processing (elapsed: 6.0s) Status: processing (elapsed: 8.0s) Status: processing (elapsed: 10.0s) Status: processing (elapsed: 12.0s) Status: processing (elapsed: 14.0s) Status: processing (elapsed: 16.0s) Status: processing (elapsed: 18.0s) Status: processing (elapsed: 20.0s) Status: processing (elapsed: 22.0s) Status: processing (elapsed: 24.0s) Status: processing (elapsed: 26.0s) ✅ Task completed! 📋 Step 3: Get results with auto image upload to storage ------------------------------------------------------------ 🖼️ Requesting API to upload images to object storage... ✅ Results retrieved successfully! Markdown file: demo1.md Content length: 51753 characters Images uploaded to storage: True 📋 Step 4: Save results to local ------------------------------------------------------------ ✅ Saved Markdown to: auto_upload_output/4c18cb2b-ff8c-4d14-b9a6-d2e80c64f9f3_demo1.md ✅ Saved metadata to: auto_upload_output/4c18cb2b-ff8c-4d14-b9a6-d2e80c64f9f3_metadata.json 📋 Step 5: Download images from storage to local ------------------------------------------------------------ 🖼️ Downloading images from object storage... 📥 Found 8 images to download 🔐 Downloading from OSS: a625057f-d84f-44a8-92fa-53b3b512edfd.jpg ✅ Downloaded: a625057f-d84f-44a8-92fa-53b3b512edfd.jpg (33785 bytes) 🔐 Downloading from OSS: 366f3f26-01bb-4d88-a3ca-0c066fabfc2f.jpg ✅ Downloaded: 366f3f26-01bb-4d88-a3ca-0c066fabfc2f.jpg (54819 bytes) 🔐 Downloading from OSS: 9999568b-0075-4cf1-bddc-c4708a0847e2.jpg ✅ Downloaded: 9999568b-0075-4cf1-bddc-c4708a0847e2.jpg (12612 bytes) 🔐 Downloading from OSS: 7ab0e083-c22c-4f65-b98f-65acfd4e6dc0.jpg ✅ Downloaded: 7ab0e083-c22c-4f65-b98f-65acfd4e6dc0.jpg (30049 bytes) 🔐 Downloading from OSS: 572ed653-a760-4c41-a5a0-79207219593a.jpg ✅ Downloaded: 572ed653-a760-4c41-a5a0-79207219593a.jpg (47093 bytes) 🔐 Downloading from OSS: 6b2465d4-eba5-4ffd-b1fa-629edf4cb634.jpg ✅ Downloaded: 6b2465d4-eba5-4ffd-b1fa-629edf4cb634.jpg (20770 bytes) 🔐 Downloading from OSS: aa1f1bfa-16c8-463b-99af-5dc4dfc4c994.jpg ✅ Downloaded: aa1f1bfa-16c8-463b-99af-5dc4dfc4c994.jpg (17916 bytes) 🔐 Downloading from OSS: 7e8db6de-9533-4257-b767-1b2300dfb4ab.jpg ✅ Downloaded: 7e8db6de-9533-4257-b767-1b2300dfb4ab.jpg (21239 bytes) ✅ Downloaded 8 images ✅ Saved updated Markdown to: auto_upload_output/4c18cb2b-ff8c-4d14-b9a6-d2e80c64f9f3/demo1.md Images directory: auto_upload_output/4c18cb2b-ff8c-4d14-b9a6-d2e80c64f9f3/images ============================================================ ✅ 完成! ============================================================ 📁 本地文件: • Markdown (含本地图片路径): auto_upload_output/4c18cb2b-ff8c-4d14-b9a6-d2e80c64f9f3/demo1.md • 图片目录: auto_upload_output/4c18cb2b-ff8c-4d14-b9a6-d2e80c64f9f3/images (8 张图片) • 原始 Markdown (含云端链接): auto_upload_output/4c18cb2b-ff8c-4d14-b9a6-d2e80c64f9f3_demo1.md • 元数据: auto_upload_output/4c18cb2b-ff8c-4d14-b9a6-d2e80c64f9f3_metadata.json 🖼️ 图片存储: • 云端:所有图片已上传到对象存储(MinIO/COS/OSS) • 本地:已下载 8 张图片到本地 • Markdown 图片链接:本地路径 (images/xxx.png) • 存储类型由服务端配置决定(STORAGE_TYPE 环境变量) 📂 服务器本地文件(如需要): 📄 Markdown 内容预览(前 200 字符): ------------------------------------------------------------ (显示本地图片版本) # The response of flow duration curves to afforestation Patrick N.J. Lane $^{a,c,*}$ , Alice E. Best $^{b,c,d}$ , Klaus Hickel $^{b,c}$ , Lu Zhang $^{b,c}$ $^{a}$ School of Forest and Ecosystem Stud ... (truncated) ``` # 实例规格 Source: https://ppio.com/docs/gpu/product-specifications 查阅 PPIO GPU 容器实例的资源规格说明,按应用的计算与运行环境需求比较实例配置,为模型开发和部署选择合适的算力。 PPIO 派欧云平台提供了多种 GPU 容器算力规格供您选择,以满足不同虚拟化能力需求,支持广泛业务应用与服务场景。 > [!TIP] > > 不同地区支持的规格不同。实际供应情况以[算力市场页面](https://ppio.com/gpu-instance/console)为准。 ## 规格参数 各算力规格基于硬件能力进行区分,采用不同的CPU/内存配比、GPU 显卡等。 | 实例规格ID | GPU 卡型 | 显存(GB) | CPU(核) | 内存(GB) | | - | - | - | - | - | | 3090.16c92g | RTX 3090 | 24 | 16 | 92 | | 4090.8c62g | RTX 4090 | 24 | 8 | 62 | | 4090.16c62g | RTX 4090 | 24 | 16 | 62 | | 4090.16c62g.os | RTX 4090 | 24 | 16 | 62 | | 4090.16c96g.v2 | RTX 4090 | 24 | 16 | 96 | | 4090.16c125g | RTX 4090 | 24 | 16 | 125 | | 4090.18c60g.fw | RTX 4090 | 24 | 18 | 60 | | 4090.18c62g | RTX 4090 | 24 | 18 | 62 | | 4090.hf.20c58g | RTX 4090 高主频 | 24 | 20 | 58 | | 4090.hf.24c58g | RTX 4090 高主频 | 24 | 24 | 58 | | A100-80GB.12c210g | A100 80GB | 80 | 12 | 210 | | A100-80GB.14c240g | A100 80GB | 80 | 14 | 240 | | H100-80GB.20c236g | H100 80GB | 80 | 20 | 236 | | H100-80GB.22c150g | H100 80GB | 80 | 22 | 150 | | H20.16c154g | H20 | 96 | 16 | 154 | | L40S.28c125g | L40S | 48 | 28 | 125 | ## 各地区支持的规格 ### 中国地区 | 地区 | 支持的规格ID | | - | - | | 西北-01 | 3090.16c92g、4090.16c125g、4090.18c62g、4090.hf.24c58g、A100-80GB.14c240g、H20.16c154g | | 西北-02 | 4090.8c62g、4090.16c62g | | 浙江-云存储-01 | 4090.18c60g.fw | ### 其他国家和地区 | 地区 | 支持的规格ID | | - | - | | 美国-加利福尼亚-03 | 3090.16c92g、4090.16c125g、4090.18c62g、4090.hf.20c58g、4090.hf.24c58g、A100-80GB.12c210g、A100-80GB.14c240g | | 美国-02 | H100-80GB.20c236g | | 欧洲-德国 | 4090.16c62g、4090.16c125g | | 欧洲-德国-02 | 4090.16c62g.os、4090.16c96g.v2、H100-80GB.22c150g、L40S.28c125g | | 欧洲-英国-01 | 4090.16c62g.os、4090.16c96g.v2、H100-80GB.22c150g、L40S.28c125g | | 亚洲-日本-01 | 4090.16c62g | | 亚洲-日本-02 | 4090.16c62g.os、4090.16c96g.v2、H100-80GB.22c150g、L40S.28c125g | | 亚洲-阿联酋-01 | 4090.16c62g.os、4090.16c96g.v2、H100-80GB.22c150g、L40S.28c125g | | 亚洲-新加坡-02 | 4090.16c62g.os、4090.16c96g.v2、H100-80GB.22c150g、L40S.28c125g | | 亚洲-印度-01 | 4090.16c62g.os、4090.16c96g.v2、H100-80GB.22c150g、L40S.28c125g | | 非洲-南非-01 | 4090.16c62g.os、4090.16c96g.v2、H100-80GB.22c150g | | 大洋洲-澳大利亚-01 | 4090.16c62g.os、4090.16c96g.v2、H100-80GB.22c150g、L40S.28c125g | | 南美洲-巴西-01 | 4090.16c62g.os、4090.16c96g.v2、H100-80GB.22c150g、L40S.28c125g | # 保存实例镜像 Source: https://ppio.com/docs/gpu/save-image 了解如何保存 PPIO GPU 实例的运行环境镜像,查阅操作流程与相关说明,为复用已配置的软件环境和再次部署任务提供参考。 保存镜像功能可以将当前实例环境与配置导出为 Docker 镜像,后续您可以使用该镜像创建新的实例,适用于实例批量快速创建、实例迁移等场景。 ## 注意事项 为了保证导出的镜像的完整性,请确保待保存镜像的实例已停止。关于停止实例的影响和操作,请参见[停止实例](/docs/gpu/manage-instances#停止实例)。 ## 操作步骤 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances)。 2. 单击已停止的目标实例,然后单击「更多操作」,在菜单中选择「保存镜像」。 3. 在弹出的对话框中,输入镜像地址,然后单击「保存」。 > [!NOTE] > > 如果镜像保存到私有镜像仓库,请配置镜像仓库认证信息。 4. 在[任务管理页面](https://ppio.com/gpu-instance/console/jobs),确认对应任务的执行状态和进展。 * 如果要取消保存镜像,可单击「终止」。 * 如果保存镜像失败,可单击「查看日志」,获取相关信息。 # Serverless GPUs Source: https://ppio.com/docs/gpu/serverless-overview 了解 PPIO Serverless GPUs 的产品定位和使用流程,认识面向 AI 推理的弹性 GPU 服务,为按需部署模型任务选择运行方式。 **Serverless GPUs** 是专为 AI 推理场景设计的 GPU 弹性容器云产品。它提供了弹性伸缩和负载均衡的按需算力,您仅需指定容器镜像地址并根据您的业务场景稍作配置,即可快速部署一个 AI 推理服务。 ## 功能特性 * **按需付费** 仅需为 GPU 容器实例的实际运行时长付费,按秒计费,避免资源闲置,有效降低成本。 * **秒级启动** 通过 GPU 容器实例保留、镜像预热以及高性能硬件等技术,能实现秒级冷启动,从容应对流量高峰。 * **弹性伸缩** 支持弹性伸缩能力,可以在业务流量高峰期自动快速扩容,流量低谷期自动缩容。在保证服务稳定性的同时,尽可能为您节省成本。 * **负载均衡** 内置高效负载均衡算法,确保请求均匀分布到各 GPU 容器实例。 * **实时日志** 提供完整的日志功能,支持查询实时日志流,帮助您快速发现并解决潜在问题。 ## 产品架构 一个 **Serverless Endpoint** 包含了多个Worker,以及弹性伸缩器、负载均衡器等组件,并且可以对外提供 URL 访问。 * **Worker**:用于处理具体请求的 GPU 容器实例,一个 Worker 对应一个 GPU 容器实例。 * **弹性伸缩器**:基于配置的弹性策略进行弹性伸缩,在流量高峰时自动扩容,流量低谷时自动缩容。 * **负载均衡器**:自动进行健康检查和负载均衡,确保请求均匀分布到 Worker。 ## 产品计费 采用按量计费的方式,对实际使用的 Worker、系统盘、云存储等进行计费。详情请参见[Serverless GPUs 计费说明](/docs/gpu/serverless-pricing)。 ## 产品使用 您可以通过[控制台](https://ppio.com/gpu-instance/console/serverless)或者 [API](/docs/gpus/endpoint/reference-create-endpoint) 创建和管理 Serverless Endpoint。 # Serverless GPUs 计费说明 Source: https://ppio.com/docs/gpu/serverless-pricing 查阅 PPIO Serverless GPUs 的费用项目与计费规则,了解弹性推理服务的成本构成,为端点使用和算力预算管理提供参考。 ## 计费项 | **计费项** | **是否必选** | **计费说明** | **计费方式** | **账单类型** | | - | - | - | - | - | | 计算资源 | 必选 | 根据实际启动的 Worker 数量和 Worker 实际运行时长计费。 | 按量计费 | Serverless | | 系统盘 | 必选 | 支持 130 GB 的免费额度。超出免费额度后,将对超出部分收取系统盘费用。 | 按量计费 | 存储 | | 云存储 | 可选 | 单独计费,根据容量和使用时长计费。 | 按量计费 | 存储 | ### 计算资源 一个 Serverless Endpoint 包含 多个 Worker,每个 Worker 对应一个 GPU 实例,带有CPU、内存和GPU等计算资源。Serverless Endpoint 的计算资源费用,按 Workers 的GPU 规格、GPU 数和实际运行时长计费。 * **计费方式**:按量计费。按秒计费,按小时出账。 * **计费公式** * Serverless Endpoint 费用 = 该 Serverless Endpoint 包含的所有 Worker 运行时产生的费用。 * 单个 Worker 费用 = Worker 单价 \* Worker 计费时长。 * Worker 单价:根据该 Worker 分配的 GPU 规格和 GPU 数确定,Worker 单价 = GPU 规格单价 \* GPU 数。 可在 [Serverless Endpoint 创建页面](https://ppio.com/gpu-instance/console/serverless)确认 GPU 规格单价,可按需配置 GPU 数。 * Worker 计费时长:Worker 实际运行时长,即仅处于运行中的 Worker 计费,精确到秒。 ### 系统盘 每个 Worker 带有一块系统盘,支持 130 GB 的免费额度。超出免费额度后,将收取系统盘费用。 * **计费方式**:按量计费。按秒计费,按天出账。 * **计费公式**:单个 Worker 的系统盘费用 = 超出容量 \* 系统盘单价 \* 计费时长。 * 超出容量:按需设置容量,大于免费额度的部分为超出容量。 * 系统盘单价:0.01 元/GB/天。 * 计费时长:系统盘的使用时长(即 Worker 实际运行时长),按秒计算。 ### 云存储 云存储按照容量和使用时长单独计费。一个云存储可以被多个 Worker 共享使用。 * **计费方式**:按量计费。按秒计费,按天出账。 * **计费公式**:云存储费用 = 云存储容量 \* 云存储单价 \* 计费时长。 * 云存储容量:按需设置容量。取值范围为 10 GB \~ 4 TB。 * 云存储单价:0.01 元/GB/天。 * 计费时长:云存储从创建到释放的使用时长,按秒计算。 ## 查看账单 您可以按照计费方式、计费项、统计时间等多个维度查看和导出账单。 1. 进入[费用明细页面](https://ppio.com/billing/billing-details)。 2. 单击「按量账单」,然后单击「Serverless」或「存储」。 * 「Serverless」包括计算资源的账单。 * 「存储」包括系统盘账单和云存储账单。 3. 设置查询条件,查看账单。 如需进一步操作账单数据,可在查询后单击「导出账单」,将账单数据导出为.xlsx文件。 ## 欠费说明 结算账单时,如果账户的可用额度(包括账户可用余额和代金劵余额)小于待支付的账单,则视为账户欠费。欠费后,可能会导致资源释放,数据丢失,进而影响业务运行。在使用期间,请确保账户额度充足。欠费后,系统会给您发送相关通知提醒(例如短信),请及时充值。 > [!TIP] > > 您可以在[账户概览页面](https://ppio.com/billing),确认账户余额和代金券情况,按需进行充值,或者设置余额预警。详情请参见[账户充值](/docs/support/payment-methods)。 具体的欠费影响如下: * 无法创建新的 Serverless Endpoint。 * 对于已有的 Serverless Endpoint,仅支持查看或删除操作,不支持修改操作。其中: * 运行中的 Worker 不再接收新的请求。 * 正在处理请求中的 Worker 会继续保持运行,直到已有请求处理完毕。 * 处理完已有请求后,运行中的 Worker 会被自动释放。 * 最终 Serverless Endpoint 中的 Worker 数会缩容至 0,且不再新建 Worker。 > [!NOTE] > > 充值并结清账单后,您的账户会恢复正常。已有的 Serverless Endpoint 会根据配置自动扩容,并恢复服务。 # 抢占式 GPU 实例 Source: https://ppio.com/docs/gpu/spot-instance 了解 PPIO 抢占式 GPU 实例的使用方式与中断边界,结合任务对连续性的要求选择算力方案,查阅资源使用和相关计费说明。 ## 基本介绍 抢占式 GPU 实例(Spot 实例)是一种使用闲置算力的实例。相比于普通按量计费的实例,价格可以低至 5 折,但性能没有差异。Spot 实例在平台资源库存充足时可以购买使用,在资源库存不足时会被中断回收,适用于短期运行,可以容忍中断的业务场景,能够帮助您节约资源使用成本。 > [!NOTE] > > Spot 实例的具体价格请参见[GPU 定价](https://ppio.com/pricing?gpu=1)。更多关于计费方式的说明,请参见[GPU 容器实例计费说明](/docs/gpu/gpu-instance-pricing)。 使用 Spot 实例让您在享受成本优势的同时,获得可靠的服务保障。 * **更低的使用成本**:Spot 实例的价格通常为按量计费价格的50%,计费规则与按量计费类似,即先使用再付费,为实际使用时长付费。 * **保护期内运行稳定**:Spot 实例在创建后默认享有1个小时的保护期,在保护期内可以稳定运行,不会被中断回收。 * **中断回收时提前通知**:超出保护期后,如果出现资源库存不足,Spot 实例会被中断回收。回收前1小时,平台会通过 API 、短信等方式发送通知。到点后,平台会强制回收实例。 建议您结合业务场景,灵活地组合使用包年包月、按量计费和 Spot,在满足业务需求的同时节约资源使用成本。 ## 适用场景 由于 Spot 实例有中断回收的风险,因此适用于短期运行,可以容忍中断的业务场景。例如: * 短时间或实验性的深度学习训练与推理任务。如:模型训练实验、算法验证、小规模推理等。 * 夜间或周末批处理、可重算型任务。如:数据处理、批量计算、定时任务等。 * 其他短时任务。如课堂实验、技术演示等。 > [!WARNING] > > 对于关键业务,以及实时性和稳定性要求较高的业务场景,如持续运行的任务等,建议使用包年包月或按量计费实例来确保服务连续性。 ## 运行流程 ![spot](https://mintcdn.com/ppinfra/s_g3l06FqMXgKJKX/gpu/image/spot.png?fit=max\&auto=format\&n=s_g3l06FqMXgKJKX\&q=85\&s=bc9819af2d2ded5c80daff5d4552a139) 1. 选择合适的实例规格创建 GPU 实例,计费方式选择抢占式计费。即创建抢占式 GPU 实例(Spot 实例)。 2. 创建后的1小时保护期内,Spot 实例稳定运行。您可以按需开关机或释放。 3. 平台定时检测资源库存。当资源库存不足时,对于超出保护期的 Spot 实例,发送1小时后中断回收的通知。 4. 收到回收通知后,请您及时确认和响应,保存需要的数据。 5. 到回收时间点后,Spot 实例被强制回收,自动释放。 ## 创建方式 ### 控制台 在[实例管理页面](https://ppio.com/gpu-instance/console/instances)单击「创建新实例」,「计费方式」选择「抢占式计费」,并完成其他参数设置,即可创建抢占式 GPU 实例。更多关于创建 GPU 实例时的参数配置,请参见[创建 GPU 容器实例](/docs/gpu/create-instances)。 ### API 调用[创建 GPU 实例](/docs/gpus/instance/reference-create-gpu-instance)接口时,将`billingMode`设置为`spot`,即可创建抢占式 GPU 实例。 ## 最佳实践 Spot 实例的中断回收不可避免,请根据自身业务场景,为可以容忍中断的业务选择使用。使用时,您可以参考以下建议,最大化 Spot 实例的使用效果。 * **开启断点续训** 定期保存 Checkpoint 至独立存储,确保在实例中断时能够快速恢复。 * **设计可重试任务** 在作业层面进行拆分设计,设置重试、幂等、队列等。将任务拆分为多个小的可重试单元,支持断点续传和失败重试机制。 * **混合使用计费方式** 根据业务场景和重要程度灵活选择计费方式,关键性业务使用包年包月或按量计费实例,非关键性/短时/可重算业务使用 Spot 实例。 * **及时响应回收通知** 收到 Spot 实例的回收通知后,请尽快保存镜像/数据等,避免因**强制回收**(即使正在进行保存镜像操作等也会按时释放)造成数据丢失。 # 通过模板快速上手ComfyUI --- 以wan2.1_t2v为例 Source: https://ppio.com/docs/gpu/started-comfyUI 按照 PPIO 教程使用 ComfyUI 模板,以 Wan 2.1 文生视频工作流为例了解环境与运行流程,为在 GPU 容器中开展生成任务提供参考。 本文主要介绍如何基于现有工作流制作适配的 ComfyUI 模板 为了方便理解,本文以工作流为 wan2.1_t2v.json 为例进行说明。 wan2.1_t2v.json ```json theme={null} { "id": "8a815138-573d-48df-88b4-599fd7994cbb", "revision": 0, "last_node_id": 48, "last_link_id": 95, "nodes": [ { "id": 37, "type": "UNETLoader", "pos": [ 20, -30 ], "size": [ 346.7470703125, 82 ], "flags": {}, "order": 0, "mode": 0, "inputs": [], "outputs": [ { "name": "MODEL", "type": "MODEL", "slot_index": 0, "links": [ 94 ] } ], "properties": { "Node name for S&R": "UNETLoader", "models": [ { "name": "wan2.1_t2v_1.3B_fp16.safetensors", "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/diffusion_models/wan2.1_t2v_1.3B_fp16.safetensors?download=true", "directory": "diffusion_models" } ] }, "widgets_values": [ "wan2.1_t2v_1.3B_fp16.safetensors", "default" ], "color": "#322", "bgcolor": "#533" }, { "id": 48, "type": "ModelSamplingSD3", "pos": [ 440, -30 ], "size": [ 210, 58 ], "flags": {}, "order": 4, "mode": 0, "inputs": [ { "name": "model", "type": "MODEL", "link": 94 } ], "outputs": [ { "name": "MODEL", "type": "MODEL", "slot_index": 0, "links": [ 95 ] } ], "properties": { "Node name for S&R": "ModelSamplingSD3" }, "widgets_values": [ 8 ] }, { "id": 3, "type": "KSampler", "pos": [ 870, 50 ], "size": [ 315, 262 ], "flags": {}, "order": 7, "mode": 0, "inputs": [ { "name": "model", "type": "MODEL", "link": 95 }, { "name": "positive", "type": "CONDITIONING", "link": 46 }, { "name": "negative", "type": "CONDITIONING", "link": 52 }, { "name": "latent_image", "type": "LATENT", "link": 91 } ], "outputs": [ { "name": "LATENT", "type": "LATENT", "slot_index": 0, "links": [ 35 ] } ], "properties": { "Node name for S&R": "KSampler" }, "widgets_values": [ 839327983272663, "randomize", 30, 6, "uni_pc", "simple", 1 ] }, { "id": 38, "type": "CLIPLoader", "pos": [ 20, 100 ], "size": [ 330, 100 ], "flags": {}, "order": 1, "mode": 0, "inputs": [], "outputs": [ { "name": "CLIP", "type": "CLIP", "slot_index": 0, "links": [ 74, 75 ] } ], "properties": { "Node name for S&R": "CLIPLoader", "models": [ { "name": "umt5_xxl_fp8_e4m3fn_scaled.safetensors", "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/text_encoders/umt5_xxl_fp8_e4m3fn_scaled.safetensors?download=true", "directory": "text_encoders" } ] }, "widgets_values": [ "umt5_xxl_fp8_e4m3fn_scaled.safetensors", "wan", "default" ], "color": "#322", "bgcolor": "#533" }, { "id": 39, "type": "VAELoader", "pos": [ 20, 250 ], "size": [ 330, 60 ], "flags": {}, "order": 2, "mode": 0, "inputs": [], "outputs": [ { "name": "VAE", "type": "VAE", "slot_index": 0, "links": [ 76 ] } ], "properties": { "Node name for S&R": "VAELoader", "models": [ { "name": "wan_2.1_vae.safetensors", "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/vae/wan_2.1_vae.safetensors?download=true", "directory": "vae" } ] }, "widgets_values": [ "wan_2.1_vae.safetensors" ], "color": "#322", "bgcolor": "#533" }, { "id": 40, "type": "EmptyHunyuanLatentVideo", "pos": [ 30, 390 ], "size": [ 340, 130 ], "flags": {}, "order": 3, "mode": 0, "inputs": [], "outputs": [ { "name": "LATENT", "type": "LATENT", "slot_index": 0, "links": [ 91 ] } ], "properties": { "Node name for S&R": "EmptyHunyuanLatentVideo" }, "widgets_values": [ 832, 480, 33, 1 ], "color": "#322", "bgcolor": "#533" }, { "id": 8, "type": "VAEDecode", "pos": [ 870, 380 ], "size": [ 210, 46 ], "flags": {}, "order": 8, "mode": 0, "inputs": [ { "name": "samples", "type": "LATENT", "link": 35 }, { "name": "vae", "type": "VAE", "link": 76 } ], "outputs": [ { "name": "IMAGE", "type": "IMAGE", "slot_index": 0, "links": [ 56, 93 ] } ], "properties": { "Node name for S&R": "VAEDecode" }, "widgets_values": [] }, { "id": 28, "type": "SaveAnimatedWEBP", "pos": [ 1270, 50 ], "size": [ 600, 460 ], "flags": {}, "order": 9, "mode": 0, "inputs": [ { "name": "images", "type": "IMAGE", "link": 56 } ], "outputs": [], "properties": {}, "widgets_values": [ "ComfyUI", 16, false, 90, "default" ] }, { "id": 47, "type": "SaveWEBM", "pos": [ 1280, 570 ], "size": [ 330, 312.3846130371094 ], "flags": { "collapsed": false }, "order": 10, "mode": 4, "inputs": [ { "name": "images", "type": "IMAGE", "link": 93 } ], "outputs": [], "properties": { "Node name for S&R": "SaveWEBM", "cnr_id": "comfy-core", "ver": "0.3.26" }, "widgets_values": [ "video/wan2.1", "vp9", 24.000000000000004, 32 ] }, { "id": 6, "type": "CLIPTextEncode", "pos": [ 450, 90 ], "size": [ 340, 120 ], "flags": {}, "order": 5, "mode": 0, "inputs": [ { "name": "clip", "type": "CLIP", "link": 74 } ], "outputs": [ { "name": "CONDITIONING", "type": "CONDITIONING", "slot_index": 0, "links": [ 46 ] } ], "title": "CLIP Text Encode (Positive Prompt)", "properties": { "Node name for S&R": "CLIPTextEncode" }, "widgets_values": [ "a majestic old white-robed wizard casting a spell under a starlit sky, standing on an ancient stone altar in a ruined medieval forest temple, glowing magic symbols, celestial energy swirling around, long silver beard, ornate staff with glowing crystal, cinematic lighting, volumetric fog, fantasy atmosphere, ultra detailed, 4K, highly realistic, by greg rutkowski, artgerm, cinematic fantasy, animation of swirling energy, slow motion magical aura forming, glowing runes pulsing, cloak flowing in the wind" ], "color": "#232", "bgcolor": "#353" }, { "id": 7, "type": "CLIPTextEncode", "pos": [ 460, 250 ], "size": [ 340, 100 ], "flags": {}, "order": 6, "mode": 0, "inputs": [ { "name": "clip", "type": "CLIP", "link": 75 } ], "outputs": [ { "name": "CONDITIONING", "type": "CONDITIONING", "slot_index": 0, "links": [ 52 ] } ], "title": "CLIP Text Encode (Negative Prompt)", "properties": { "Node name for S&R": "CLIPTextEncode" }, "widgets_values": [ "low quality, blurry, ugly, poorly drawn hands, deformed face, extra limbs, bad anatomy, low resolution, disfigured, unrealistic, cartoonish, watermark, text, signature, distorted proportions, creepy, glitch, jpeg artifacts\n" ], "color": "#323", "bgcolor": "#535" } ], "links": [ [ 35, 3, 0, 8, 0, "LATENT" ], [ 46, 6, 0, 3, 1, "CONDITIONING" ], [ 52, 7, 0, 3, 2, "CONDITIONING" ], [ 56, 8, 0, 28, 0, "IMAGE" ], [ 74, 38, 0, 6, 0, "CLIP" ], [ 75, 38, 0, 7, 0, "CLIP" ], [ 76, 39, 0, 8, 1, "VAE" ], [ 91, 40, 0, 3, 3, "LATENT" ], [ 93, 8, 0, 47, 0, "IMAGE" ], [ 94, 37, 0, 48, 0, "MODEL" ], [ 95, 48, 0, 3, 0, "MODEL" ] ], "groups": [ { "id": 1, "title": "Load models", "bounding": [ 10, -100, 360, 430 ], "color": "#3f789e", "font_size": 24, "flags": {} } ], "config": {}, "extra": { "ds": { "scale": 0.839054528882439, "offset": [ 173.82027100712344, 171.24661681774091 ] }, "node_versions": { "comfy-core": "0.3.27" } }, "version": 0.4 } ``` 需要制作一个满足 wan2.1_t2v.json 工作流的 Dockerfile ### 模型下载 在开始构建镜像之前,需要提前准备好模板运行所需的模型文件。 不同工作流依赖的模型不同,这一步以你使用的工作流需求为准。 你需要确认以下内容: * 这个模板依赖哪些模型 * 每个模型应该放在哪个目录 * 模型文件名是否需要和工作流中的引用保持一致 已知该 **comfyui:wan2.1-t2v-14b** 的官方提供的工作流需要下载三个模型 将需要的模型分别下载到该模型所需要的目录里 模型可以在 [hugging face 官网](https://huggingface.co/) 下载 首先在浏览器搜索需要下载的模型,选择 hugging face 官网的链接 确认模型名称,再点击 Copy download link ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/1.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=4ca3d59598f2a855b4115d3ab6130ad0) 标蓝区域为下载后的模型名称,标绿区域为模型的下载链接。 Dockerfile 片段 ```dockerfile theme={null} RUN cd /root/ComfyUI/models/diffusion_models && \ curl -L -o wan2.1_t2v_14B_fp8_scaled.safetensors https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/diffusion_models/wan2.1_t2v_14B_fp8_scaled.safetensors ``` umt5_xxl_fp8_e4m3fn_scaled.safetensors 和 wan_2.1_vae.safetensors 同理 结果如下 Dockerfile 片段 ```dockerfile theme={null} RUN cd /root/ComfyUI/models/diffusion_models && \ curl -L -o wan2.1_t2v_14B_fp8_scaled.safetensors https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/diffusion_models/wan2.1_t2v_14B_fp8_scaled.safetensors RUN cd /root/ComfyUI/models/text_encoders && \ curl -L -o umt5_xxl_fp8_e4m3fn_scaled.safetensors https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/text_encoders/umt5_xxl_fp8_e4m3fn_scaled.safetensors RUN cd /root/ComfyUI/models/vae && \ curl -L -o wan_2.1_vae.safetensors https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/vae/wan_2.1_vae.safetensors ``` 三个模型的 huggingface 地址 [wan2.1_t2v_14B_fp8_scaled.safetensors](https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/blob/main/split_files/diffusion_models/wan2.1_t2v_14B_fp8_scaled.safetensors) [umt5_xxl_fp8_e4m3fn_scaled.safetensors](https://huggingface.co/f5aiteam/CLIP/blob/main/umt5_xxl_fp8_e4m3fn_scaled.safetensors) [wan_2.1_vae.safetensors](https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/tree/main/split_files/vae) 节点下载同理,即 把节点下载到所需要的目录中 节点可以去 [github 官网](https://github.com/) 下载 ### 工作流的替换 复制工作流到 Dockerfile 里 Dockerfile 片段 ```dockerfile theme={null} #Copy wan2.1-t2v-14b default workflow COPY wan2.1_t2v.json /root/ComfyUI/user/default/workflows/wan2.1_t2v.json ``` ## 制作 Dockerfile Dockerfile 用于定义运行环境、依赖安装方式以及 ComfyUI 初始化内容,后续构建镜像时会直接使用它。 本文推荐以 pytorch/pytorch:2.7.1-cuda12.8-cudnn9-runtime 为基础镜像进行操作。 **以下为 comfyui:wan2.1-t2v-14b 的 Dockefile** ```bash theme={null} FROM pytorch/pytorch:2.7.1-cuda12.8-cudnn9-runtime ENV DEBIAN_FRONTEND=noninteractive ENV PYTHONUNBUFFERED=1 # install system packages RUN apt update -y && apt install -y \ python3 python-is-python3 python3-pip \ libgl1-mesa-glx \ ffmpeg \ curl \ libglib2.0-0 \ git aria2 && \ apt clean # install python packages RUN pip install \ diffusers \ opencv-python RUN cd /root && git clone https://github.com/comfyanonymous/ComfyUI && \ cd ComfyUI && pip install -r requirements.txt WORKDIR /root/ComfyUI #Download comfyui-manager RUN cd custom_nodes && git clone https://github.com/ltdrdata/ComfyUI-Manager comfyui-manager RUN cd /root/ComfyUI/models/diffusion_models && \ curl -L -o wan2.1_t2v_14B_fp8_scaled.safetensors https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/diffusion_models/wan2.1_t2v_14B_fp8_scaled.safetensors RUN cd /root/ComfyUI/models/text_encoders && \ curl -L -o umt5_xxl_fp8_e4m3fn_scaled.safetensors https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/text_encoders/umt5_xxl_fp8_e4m3fn_scaled.safetensors RUN cd /root/ComfyUI/models/vae && \ curl -L -o wan_2.1_vae.safetensors https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/vae/wan_2.1_vae.safetensors #Copy wan2.1-t2v-14b default workflow COPY wan2.1_t2v.json /root/ComfyUI/user/default/workflows/wan2.1_t2v.json CMD ["/bin/bash", "-c", "cd /root/ComfyUI && python3 main.py --listen 0.0.0.0"] ``` 可以将以上当作模板,通过修改替换为你所需要下载的节点和模型,来适配你所需的工作流。 如果后面要安装自定义节点、下载模型或复制工作流文件,也通常会继续补在这个 Dockerfile 里 `#Download comfyui-manager` 之上的内容无需修改,为 ComfyUI 环境配置,我们只需要完成修改节点和模型的下载来适配所需工作流,以及工作流的替换。 ### 检查文件位置 ```go theme={null} . ├── Dockerfile └── wan2.1_t2v.json ``` 你需要重点确认以下内容: * Dockerfile 在正确位置 * 工作流文件在正确位置 * 模型文件在正确位置,模型名称完全正确 * 如果有自定义节点或额外脚本,也放在正确位置 #### 预期结果 完成后,你应当已经确认模板制作涉及的关键文件都放在了预期目录中 这本质上是把前面准备好的环境和文件打包成一个可部署的镜像。 接下来就可以将 Dockefile 打成镜像推送到镜像仓库了。 ## 镜像的构建和推送 在制作完 Dockerfile 之后 需要进行镜像构建,并将其推送到目标镜像仓库,供后续平台创建模板时使用。 ### 获取镜像仓库凭证 在镜像构建和推送之前,需要获取镜像仓库凭证 首先在 PPIO 官网的安全凭证管理处复制镜像上传凭证 ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/2.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=e196a79f041e3e18677614dabd66a6d1) 完成认证 ```bash theme={null} docker login image.ppinfra.com --username="你的username" --password="你的password" WARNING! Using --password via the CLI is insecure. Use --password-stdin. WARNING! Your credentials are stored unencrypted in '/root/.docker/config.json'. Configure a credential helper to remove this warning. See https://docs.docker.com/go/credential-store/ ``` 构建镜像时,确认当前目录下是 Dockerfile 文件 这里我以 PPIO 内部官方仓库地址做演示 ```text theme={null} image.ppinfra.com/prod-gpucloudpublic/ ``` 你需要使用你自己的认证仓库地址 ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/3.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=3a4e14d7db02638bb83074e1dff0c2e3) 比如这里是 ```shell theme={null} image.ppinfra.com/prod-zirllhuyllegrjroryqb/ ``` 示例 ```text theme={null} image.ppinfra.com/prod-zirllhuyllegrjroryqb/comfyui:wan2.1-t2v-14v-test ``` ### 构建镜像 ```bash theme={null} docker build -t image.ppinfra.com/prod-gpucloudpublic/comfyui:wan2.1-t2v-14v-test . ``` ```bash theme={null} docker build -t image.ppinfra.com/prod-gpucloudpublic/comfyui:wan2.1-t2v-14v-test . [+] Building 1.3s (16/16) FINISHED docker:default => [internal] load build definition from dockerfile 0.0s => => transferring dockerfile: 1.60kB 0.0s => [internal] load metadata for docker.io/pytorch/pytorch:2.7.1-cuda12.8-cudnn9-runtime 1.3s => [auth] pytorch/pytorch:pull token for registry-1.docker.io 0.0s => [internal] load .dockerignore 0.0s => => transferring context: 2B 0.0s => [internal] load build context 0.0s => => transferring context: 37B 0.0s => [ 1/10] FROM docker.io/pytorch/pytorch:2.7.1-cuda12.8-cudnn9-runtime@sha256:c16f4c749e2d9e96878875cdf6cc45cddda1d1a36fddd371dd6f2360f1b6e2a2 0.0s => CACHED [ 2/10] RUN apt update -y && apt install -y python3 python-is-python3 python3-pip libgl1-mesa-glx ffmpeg curl libglib2.0-0 git aria2 && apt clean 0.0s => CACHED [ 3/10] RUN pip install diffusers opencv-python 0.0s => CACHED [ 4/10] RUN cd /root && git clone https://github.com/comfyanonymous/ComfyUI && cd ComfyUI && pip install -r requirements.txt 0.0s => CACHED [ 5/10] WORKDIR /root/ComfyUI 0.0s => CACHED [ 6/10] RUN cd custom_nodes && git clone https://github.com/ltdrdata/ComfyUI-Manager comfyui-manager 0.0s => CACHED [ 7/10] RUN cd /root/ComfyUI/models/diffusion_models && curl -L -o wan2.1_t2v_14B_fp8_scaled.safetensors https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/diffusi 0.0s => CACHED [ 8/10] RUN cd /root/ComfyUI/models/text_encoders && curl -L -o umt5_xxl_fp8_e4m3fn_scaled.safetensors https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/text_enco 0.0s => CACHED [ 9/10] RUN cd /root/ComfyUI/models/vae && curl -L -o wan_2.1_vae.safetensors https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/vae/wan_2.1_vae.safetensors 0.0s => CACHED [10/10] COPY wan2.1_t2v.json /root/ComfyUI/user/default/workflows/wan2.1_t2v.json 0.0s => exporting to image 0.0s => => exporting layers 0.0s => => writing image sha256:4df410a289e838464aef108a279c052cfd9db77e556c6ee044dfb9970d7c49cc 0.0s => => naming to image.ppinfra.com/prod-gpucloudpublic/comfyui:wan2.1-t2v-14v-test ``` ### 推送镜像 ```bash theme={null} docker push image.ppinfra.com/prod-gpucloudpublic/comfyui:wan2.1-t2v-14v-test ``` ```yaml theme={null} docker push image.ppinfra.com/prod-gpucloudpublic/comfyui:wan2.1-t2v-14v-test The push refers to repository [image.ppinfra.com/prod-gpucloudpublic/comfyui] 02c0cebd2181: Pushed 3da69cbe286a: Pushed b430801dea2e: Pushed 6daa0b6e53ca: Pushed 32ba4a599da5: Pushed 5f70bf18a086: Layer already exists 8881a2774363: Pushed b17ac8104109: Pushed 9169cd407ef5: Pushed 1fda46049be1: Layer already exists 2bf9ca7c9c37: Layer already exists 105c4058ec6f: Layer already exists f862e1968e4b: Layer already exists wan2.1-t2v-14v-test: digest: sha256:6bd8b53186a79650a0105904fe6008e4c25bdcbbd959123956cdabe48770396d size: 3274 ``` 镜像推送到仓库后,去 PPIO 官网创建模板 ## 创建模板 在 [PPIO 控制台](https://ppio.com/gpu-instance/console/templates) 创建新模板 点击创建模板 ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/4.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=0a9cedbc658d8836167d51d3d4afec3a) 配置好对应模板参数点击确认 容器镜像填写你推送的镜像地址 ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/5.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=ef593a56bd4171d115ae0afd5b68722c) 在算力市场找到创建的模板 ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/6.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=171eef2367cd3a75757c4c7a39c521c2) 按照需求选择卡型 ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/7.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=c58ce5659f95060a6823e770832a46eb) 确认参数点击部署 ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/8.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=7a444112843cb22ac72a2d8137b75f5d) ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/9.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=d4837980c6e801b391d0d5eebd14db54) 等待实例运行,并查看实例日志,确保服务正常启动。 ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/10.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=3a1c6835fafa8b0f63f7d8cce3105bbf) ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/11.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=c071e44795721c929a2bec054c14d7e0) 点击 连接到 HTTP 服务 进入 ComfyUI 网页 ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/12.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=6e0e8125bd8a72e2f753756b0be15d15) 点击 启动 Web Terminal 选项,启动后点击连接选项即可连接到网页终端,也支持 SSH 连接到终端。 ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/13.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=97cc37f62b3d237dbaafd525da53295a) 进入 ComfyUI 页面后,选择工作流,以及工作流所需模型,点击运行。 ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/14.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=ec6a0c54743feed0472b1e2b0c7e42dd) ## API调用 首先导出工作流的 api json 文件 1. 在 ComfyUI 界面点击顶部菜单栏的**工作流** (Workflow) 2. 选择**导出(API)** (Export API) 3. 浏览器会自动下载一个 JSON 文件,这里是 wan2.1_t2v.json ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/15.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=bbe428f014157b8f8bfb363b2e7dce4d) wan2.1_t2v.json(api) ```json theme={null} { "3": { "inputs": { "seed": 313877827673034, "steps": 30, "cfg": 6, "sampler_name": "uni_pc", "scheduler": "simple", "denoise": 1, "model": [ "48", 0 ], "positive": [ "6", 0 ], "negative": [ "7", 0 ], "latent_image": [ "40", 0 ] }, "class_type": "KSampler", "_meta": { "title": "K采样器" } }, "6": { "inputs": { "text": "a majestic old white-robed wizard casting a spell under a starlit sky, standing on an ancient stone altar in a ruined medieval forest temple, glowing magic symbols, celestial energy swirling around, long silver beard, ornate staff with glowing crystal, cinematic lighting, volumetric fog, fantasy atmosphere, ultra detailed, 4K, highly realistic, by greg rutkowski, artgerm, cinematic fantasy, animation of swirling energy, slow motion magical aura forming, glowing runes pulsing, cloak flowing in the wind", "clip": [ "38", 0 ] }, "class_type": "CLIPTextEncode", "_meta": { "title": "CLIP Text Encode (Positive Prompt)" } }, "7": { "inputs": { "text": "low quality, blurry, ugly, poorly drawn hands, deformed face, extra limbs, bad anatomy, low resolution, disfigured, unrealistic, cartoonish, watermark, text, signature, distorted proportions, creepy, glitch, jpeg artifacts\n", "clip": [ "38", 0 ] }, "class_type": "CLIPTextEncode", "_meta": { "title": "CLIP Text Encode (Negative Prompt)" } }, "8": { "inputs": { "samples": [ "3", 0 ], "vae": [ "39", 0 ] }, "class_type": "VAEDecode", "_meta": { "title": "VAE解码" } }, "28": { "inputs": { "filename_prefix": "ComfyUI", "fps": 16, "lossless": false, "quality": 90, "method": "default", "images": [ "8", 0 ] }, "class_type": "SaveAnimatedWEBP", "_meta": { "title": "保存动画(WEBP)" } }, "37": { "inputs": { "unet_name": "wan2.1_t2v_14B_fp8_scaled.safetensors", "weight_dtype": "default" }, "class_type": "UNETLoader", "_meta": { "title": "UNet加载器" } }, "38": { "inputs": { "clip_name": "umt5_xxl_fp8_e4m3fn_scaled.safetensors", "type": "wan", "device": "default" }, "class_type": "CLIPLoader", "_meta": { "title": "加载CLIP" } }, "39": { "inputs": { "vae_name": "wan_2.1_vae.safetensors" }, "class_type": "VAELoader", "_meta": { "title": "加载VAE" } }, "40": { "inputs": { "width": 832, "height": 480, "length": 33, "batch_size": 1 }, "class_type": "EmptyHunyuanLatentVideo", "_meta": { "title": "空Latent视频(Hunyuan)" } }, "48": { "inputs": { "shift": 8, "model": [ "37", 0 ] }, "class_type": "ModelSamplingSD3", "_meta": { "title": "采样算法(SD3)" } } } ``` test.py ```python theme={null} import argparse import json import os import time import uuid from urllib.parse import urlencode import requests def load_prompt(path: str) -> dict: with open(path, "r", encoding="utf-8") as f: return json.load(f) def patch_prompt(prompt: dict, positive=None, negative=None, seed=None, steps=None, cfg=None, width=None, height=None, length=None, fps=None): # 6/7: prompt if positive is not None: prompt["6"]["inputs"]["text"] = positive if negative is not None: prompt["7"]["inputs"]["text"] = negative # 3: KSampler if seed is not None: prompt["3"]["inputs"]["seed"] = int(seed) if steps is not None: prompt["3"]["inputs"]["steps"] = int(steps) if cfg is not None: prompt["3"]["inputs"]["cfg"] = float(cfg) # 40: video latent if width is not None: prompt["40"]["inputs"]["width"] = int(width) if height is not None: prompt["40"]["inputs"]["height"] = int(height) if length is not None: prompt["40"]["inputs"]["length"] = int(length) # 28: SaveAnimatedWEBP if fps is not None: prompt["28"]["inputs"]["fps"] = int(fps) return prompt def post_prompt(base_url: str, prompt: dict, client_id: str) -> dict: payload = {"client_id": client_id, "prompt": prompt} r = requests.post(f"{base_url}/prompt", json=payload, timeout=60) r.raise_for_status() return r.json() def get_history(base_url: str, prompt_id: str) -> dict: r = requests.get(f"{base_url}/history/{prompt_id}", timeout=60) r.raise_for_status() return r.json() def wait_done(base_url: str, prompt_id: str, interval=2, timeout=3600) -> dict: start = time.time() while True: if time.time() - start > timeout: raise TimeoutError(f"Timeout waiting prompt_id={prompt_id}") hist = get_history(base_url, prompt_id) if prompt_id in hist: return hist[prompt_id] time.sleep(interval) def extract_files(history_item: dict): """ history_item["outputs"] 示例(你的 SaveAnimatedWEBP 通常在 node 28 下): { "outputs": { "28": { "animated": [ {filename, subfolder, type}, ...] } } } """ outputs = history_item.get("outputs", {}) files = [] for node_id, node_out in outputs.items(): if not isinstance(node_out, dict): continue for slot, v in node_out.items(): if isinstance(v, list): for item in v: if isinstance(item, dict) and item.get("filename"): files.append({ "node_id": node_id, "slot": slot, "filename": item["filename"], "subfolder": item.get("subfolder", ""), "type": item.get("type", "output"), }) return files def view_url(base_url: str, f: dict) -> str: q = urlencode({ "filename": f["filename"], "subfolder": f.get("subfolder", ""), "type": f.get("type", "output") }) return f"{base_url}/view?{q}" def download(base_url: str, f: dict, out_dir: str) -> str: os.makedirs(out_dir, exist_ok=True) url = view_url(base_url, f) out_path = os.path.join(out_dir, f["filename"]) with requests.get(url, stream=True, timeout=600) as r: r.raise_for_status() with open(out_path, "wb") as fp: for chunk in r.iter_content(1024 * 64): if chunk: fp.write(chunk) return out_path def main(): ap = argparse.ArgumentParser() ap.add_argument("--url", default="http://127.0.0.1:8188", help="ComfyUI base url") ap.add_argument("--workflow", default="workflow_api.json", help="your api json (prompt dict)") ap.add_argument("--out", default="outputs", help="download dir") ap.add_argument("--download", action="store_true", help="download output files") # 可选覆盖参数 ap.add_argument("--positive") ap.add_argument("--negative") ap.add_argument("--seed", type=int) ap.add_argument("--steps", type=int) ap.add_argument("--cfg", type=float) ap.add_argument("--width", type=int) ap.add_argument("--height", type=int) ap.add_argument("--length", type=int) ap.add_argument("--fps", type=int) args = ap.parse_args() client_id = str(uuid.uuid4()) prompt = load_prompt(args.workflow) prompt = patch_prompt(prompt, args.positive, args.negative, args.seed, args.steps, args.cfg, args.width, args.height, args.length, args.fps) resp = post_prompt(args.url, prompt, client_id) prompt_id = resp["prompt_id"] print("prompt_id:", prompt_id) history_item = wait_done(args.url, prompt_id) files = extract_files(history_item) print("outputs:") for f in files: print(f"- node={f['node_id']} slot={f['slot']} file={f['filename']}") print(" ", view_url(args.url, f)) if args.download: for f in files: p = download(args.url, f, args.out) print("downloaded:", p) if __name__ == "__main__": main() ``` 将 test.py 的 [http://127.0.0.1:8188](http://127.0.0.1:8188) 替换为 HTTP 服务的 url ```bash theme={null} python3 test.py prompt_id: d6ca7d86-034c-44cb-bdf6-1d16aa446e85 outputs: - node=28 slot=images file=ComfyUI_00002_.webp https://2d39822a3e1ef448-8188.cn-south-1.gpu-instance.ppinfra.com/view?filename=ComfyUI_00002_.webp&subfolder=&type=output ``` ![](https://mintcdn.com/ppinfra/KAl1NtWBg8jYzoyG/gpu/image/comfyUI/16.png?fit=max\&auto=format\&n=KAl1NtWBg8jYzoyG\&q=85\&s=ff3f28ae03994189a8e907c254b6b28f) # 升级实例镜像 Source: https://ppio.com/docs/gpu/upgrade-instance 查阅 PPIO GPU 容器实例的镜像升级流程,了解运行环境更新方式与操作说明,为维护实例软件环境和应用部署提供参考。 如果业务有所变更,可以升级实例镜像,支持修改实例的 Docker 镜像、容器启动命令和容器环境变量。 ## 注意事项 * 升级实例镜像时,平台会为您保存系统盘数据,但如果数据和升级后的实例系统**不兼容**,则数据**无法**成功恢复到新的实例中。 * 升级实例镜像后,实例会被重置,但实例原本占用的资源**不会被释放**。 ## 操作步骤 1. 进入[实例管理页面](https://ppio.com/gpu-instance/console/instances)。 2. 单击目标实例,然后单击「更多操作」,在菜单中选择「升级」。 3. 按需修改镜像相关配置,然后单击「升级」。 * **Docker 镜像名称**:输入新镜像的地址。 * **镜像仓库认证**:如果新镜像存储在私有镜像仓库,请选择对应的镜像仓库认证。 * **容器启动命令**:按需输入容器启动时要执行的命令。 * **环境变量**:按需增加环境变量。 # 创建 Endpoint Source: https://ppio.com/docs/gpus/endpoint/reference-v2-create-endpoint gpus/v2-spec/create-endpoint.json POST /gpus/v2/endpoints PPIO 算力 API v2 文档介绍如何创建推理服务端点,说明相关请求与结果处理方式,为开发者准备可调用的模型运行入口提供参考。 # 删除 Endpoint Source: https://ppio.com/docs/gpus/endpoint/reference-v2-delete-endpoint gpus/v2-spec/delete-endpoint.json DELETE /gpus/v2/endpoints/{endpoint_id} PPIO 算力 API v2 文档介绍如何删除不再使用的服务端点,说明相关请求与结果处理方式,为开发者清理端点资源并维护服务清单提供参考。 # 查询 Endpoint 详情 Source: https://ppio.com/docs/gpus/endpoint/reference-v2-get-endpoint gpus/v2-spec/get-endpoint.json GET /gpus/v2/endpoints/{endpoint_id} PPIO 算力 API v2 文档介绍如何读取指定服务端点的信息,说明相关请求与结果处理方式,为开发者检查端点配置与资源详情提供参考。 # 查询 Endpoint 列表 Source: https://ppio.com/docs/gpus/endpoint/reference-v2-list-endpoint gpus/v2-spec/list-endpoint.json GET /gpus/v2/endpoints PPIO 算力 API v2 文档介绍如何查询服务端点列表,说明相关请求与结果处理方式,为开发者查看已有端点并组织服务资源提供参考。 # 更新 Endpoint Source: https://ppio.com/docs/gpus/endpoint/reference-v2-update-endpoint gpus/v2-spec/update-endpoint.json PUT /gpus/v2/endpoints/{endpoint_id} PPIO 算力 API v2 文档介绍如何更新服务端点配置,说明相关请求与结果处理方式,为开发者按任务需求维护已有推理端点提供参考。 # 创建镜像预热任务 Source: https://ppio.com/docs/gpus/image/reference-v2-create-image-prewarm gpus/v2-spec/create-image-prewarm.json POST /gpus/v2/prewarm-tasks PPIO 算力 API v2 文档介绍如何创建镜像预热任务,说明相关请求与结果处理方式,为开发者为运行环境部署准备镜像资源提供参考。 # 删除镜像 Source: https://ppio.com/docs/gpus/image/reference-v2-delete-image gpus/v2-spec/delete-image.json DELETE /gpus/v2/images/{image_id} PPIO 算力 API v2 文档介绍如何删除指定镜像资源,说明相关请求与结果处理方式,为开发者维护镜像仓库并清理不再使用的环境提供参考。 # 批量删除镜像预热任务 Source: https://ppio.com/docs/gpus/image/reference-v2-delete-image-prewarm gpus/v2-spec/delete-image-prewarm.json DELETE /gpus/v2/prewarm-tasks PPIO 算力 API v2 文档介绍如何批量删除镜像预热任务,说明相关请求与结果处理方式,为开发者清理不再需要的预热安排提供参考。 # 查询镜像预热任务详情 Source: https://ppio.com/docs/gpus/image/reference-v2-get-image-prewarm gpus/v2-spec/get-image-prewarm.json GET /gpus/v2/prewarm-tasks/{task_id} PPIO 算力 API v2 文档介绍如何读取指定镜像预热任务详情,说明相关请求与结果处理方式,为开发者查看任务信息并核对预热配置提供参考。 # 查询镜像列表 Source: https://ppio.com/docs/gpus/image/reference-v2-list-image gpus/v2-spec/list-image.json GET /gpus/v2/images PPIO 算力 API v2 文档介绍如何查询镜像资源列表,说明相关请求与结果处理方式,为开发者查找已有镜像并选择部署环境提供参考。 # 查询镜像预热任务列表 Source: https://ppio.com/docs/gpus/image/reference-v2-list-image-prewarm gpus/v2-spec/list-image-prewarm.json GET /gpus/v2/prewarm-tasks PPIO 算力 API v2 文档介绍如何查询镜像预热任务列表,说明相关请求与结果处理方式,为开发者查看预热安排并维护部署准备流程提供参考。 # 按量计费实例转为包年包月实例 Source: https://ppio.com/docs/gpus/instance/reference-change-billing-instance POST https://api.ppio.com/gpu-instance/openapi/v1/gpu/instance/transToMonthlyInstance PPIO 算力 API 文档介绍如何将按量计费实例转为包年包月,说明相关请求与结果处理方式,为开发者调整计算资源的计费安排提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **instanceId** `string` *required* 要转为包年包月的按量计费实例 ID。 **month** `integer` *required* 转为包年包月实例后的租用时长。单位为月。 # 创建 CPU 实例 Source: https://ppio.com/docs/gpus/instance/reference-create-cpu-instance POST https://api.ppio.com/gpu-instance/openapi/v1/gpu/instance/create PPIO 算力 API 文档介绍如何创建 CPU 实例,说明相关请求与结果处理方式,为开发者为应用准备云端计算环境提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **name** `string` CPU 实例名称。字符串,长度限制:0-255 字符。 **productId** `string` *required* 用于部署实例的产品 ID。可以调用[获取 CPU 产品列表接口](/docs/gpus/reference-list-cpu-products)查询。字符串,长度限制:1-255 字符。 **imageUrl** `string` *required* 容器镜像地址。字符串,长度限制:1-500 字符。 **imageAuth** `string` 镜像仓库认证。格式为 username:password。使用私有镜像时需配置,使用公共镜像或派欧云平台的镜像时,无需配置。字符串,长度限制:0-10239 字符。 **imageAuthId** `string` 镜像仓库认证 ID。 **ports** `string` 实例对外开放的端口。字符串,示例:80/http, 3306/tcp。支持的端口号范围:1-65535,其中 2222、2223、2224 为内部端口,不可使用。支持的端口类型为 tcp、http。ports + tools 最多使用 15 个端口。 **envs** `object[]` 实例环境变量。数组,最多 100 组环境变量。 **properties** **key** `string` 环境变量名称。字符串,长度限制:0-511 字符。 **value** `string` 环境变量取值。字符串,长度限制:0-4095 字符。 **tools** `object[]` 是否开启官方镜像支持工具。数组,目前部分官方镜像仅包含 Jupyter。ports + tools 最多使用 15 个端口。 **properties** **name** `string` 工具名称。可选值:Jupyter。 **port** `string` 工具使用端口,支持的端口号范围:1-65535,其中 2222、2223、2224 为内部端口,不可使用。 **type** `string` 工具使用端口类型。可选值:tcp、http。 **command** `string` 容器启动命令。该配置会覆盖 Docker 镜像的 CMD。字符串,长度限制:0-2047 字符。 **entrypoint** `string` 容器启动 entrypoint。该配置会覆盖 Docker 镜像的 ENTRYPOINT。字符串,长度限制:0-2047 字符。 **clusterId** `string` 指定集群 ID 创建实例,填空值则随机在一个集群创建实例。字符串,长度限制:0-255 字符。 **localStorageMountPoint** `string` 本地存储的挂载路径。默认值:"/workspace",字符串,长度限制:1-4095 字符。 **networkStorages** `object[]` 云存储挂载配置。数组,最多支持挂载 30 个云存储。 **properties** **Id** `string` 云存储 ID。 **mountPoint** `string` 云存储的挂载路径。默认值:"/network",字符串,长度限制:1-4095 字符。 **networkId** `string` vpc 网络 ID。不使用 vpc 网络则填空值。 **kind** `string` *required* 实例类型。可选值:cpu、gpu。取值固定为 cpu。 ## 响应参数 **id** `string` 创建的实例 ID。 # 创建 GPU 实例 Source: https://ppio.com/docs/gpus/instance/reference-create-gpu-instance POST https://api.ppio.com/gpu-instance/openapi/v1/gpu/instance/create PPIO 算力 API 文档介绍如何创建 GPU 实例,说明相关请求与结果处理方式,为开发者为模型与计算任务准备运行资源提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **name** `string` 实例名称。字符串,长度限制:0-255 字符。 **productId** `string` *required* GPU 产品 ID。字符串,长度限制:1-255 字符。可以调用[获取 GPU 产品列表接口](/docs/gpus/reference-list-gpu-products)查询。 **gpuNum** `integer` *required* GPU 数量。整数,取值范围:\[1, 8]。 **rootfsSize** `integer` *required* 系统盘大小。整数,取值范围:\[10, 6144]。最小值小于 10 GB 时,系统会默认设置为 10GB。最大值上限受可用存储资源限制动态变化,可通过产品列表接口查询。 **imageUrl** `string` *required* 镜像地址。字符串,长度限制:1-500 字符。 **imageAuth** `string` 镜像认证(username:password)。字符串,长度限制:0-10239 字符。 **imageAuthId** `string` 镜像仓库认证ID。 **ports** `string` 实例开放端口,示例: 80/http, 3306/tcp。支持的端口号范围:\[1-65535],其中 2222, 2223, 2224 为内部端口,不可使用。支持的端口类型为 \[tcp、http]。ports + tools 最多使用 15 个端口。 **envs** `object[]` 实例环境变量。最多创建 100 组环境变量。 **properties** **key** `string` 环境变量名。字符串,长度限制:0-511 字符。 **value** `string` 环境变量值。字符串,长度限制:0-4095 字符。 **tools** `object[]` 是否开启官方镜像支持工具。目前部分官方镜像仅包含 Jupyter。ports + tools 最多使用 15 个端口。 **properties** **name** `string` 工具名称。取值范围:\[Jupyter]。 **port** `string` 工具使用端口。支持的端口号范围:\[1-65535],其中 2222, 2223, 2224 为内部端口,不可使用。 **type** `string` 工具使用端口类型。支持的端口类型为 \[tcp、http]。 **command** `string` 实例启动命令。字符串,长度限制:0-2047 字符。 **entrypoint** `string` 实例启动 entrypoint。该配置会覆盖 Docker 镜像的 ENTRYPOINT。字符串,长度限制:0-2047 字符。 **clusterId** `string` 指定集群 ID 创建实例,填空值则随机在一个集群创建实例。 **networkStorages** `object[]` 云挂载配置。最多支持挂载 30 个云存储。 **properties** **Id** `string` 网络存储ID。 **mountPoint** `string` 网络存储挂载路径,默认值:"/network"。字符串,长度限制:1-4095 字符。 **networkId** `string` vpc网络ID,不使用 vpc 网络则填空值。 **kind** `string` *required* 实例类型。取值范围:\[gpu、cpu]。 **month** `integer` 包年包月实例月份,填 0 则创建按量付费实例。整数,取值范围:大于等于 0。 **billingMode** `string` 实例的计费方式。可选值:`onDemand`(按量计费)、`monthly`(包年包月)、`spot`(抢占式计费)。\ 默认值:`onDemand`。\ 注意:如果设置了 month > 0,则强制为 `monthly` 计费方式。 * `onDemand`:按量计费 * `monthly`:包年包月计费 * `spot`:抢占式计费 **autoRenew** `boolean` 是否自动续费。布尔值,默认值:false。\ 注意:只有包年包月计费生效时,该参数才有效。 **autoRenewMonth** `integer` 自动续费月数。整数,取值范围:1-12。\ 注意:只有包年包月计费生效并且自动续费开启时,该参数才有效。 **minCudaVersion** `string` 创建实例支持的最小 CUDA 版本,需填写指定格式,例如:11.8、12.4。长度:\[0-255]。 ## 响应参数 **id** `string` 创建的实例 ID。 # 删除实例 Source: https://ppio.com/docs/gpus/instance/reference-delete-instance POST https://api.ppio.com/gpu-instance/openapi/v1/gpu/instance/delete PPIO 算力 API 文档介绍如何删除指定实例,说明相关请求与结果处理方式,为开发者结束资源使用并维护实例清单提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **instanceId** `string` *required* 要删除的实例 ID。 # 编辑实例 Source: https://ppio.com/docs/gpus/instance/reference-edit-instance POST https://api.ppio.com/gpu-instance/openapi/v1/gpu/instance/edit PPIO 算力 API 文档介绍如何编辑实例配置,说明相关请求与结果处理方式,为开发者按运行需求维护已有实例环境提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **instanceId** `string` *required* 要编辑的实例 ID。 **ports** `object[]` 实例对外开放的端口。ports + tools 最多使用 15 个端口。 **properties** **port** `integer` 端口号。支持的端口号范围:1-65535,其中 2222, 2223, 2224 为内部端口,不可使用。 **type** `string` 协议类型。支持 `tcp`、`http`。 **expandRootDisk** `integer` 系统存储扩容大小,单位 GB。整数,取值范围 >= 0,不扩容填 0 即可。 # 查询实例详情 Source: https://ppio.com/docs/gpus/instance/reference-get-instance GET https://api.ppio.com/gpu-instance/openapi/v1/gpu/instance PPIO 算力 API 文档介绍如何读取指定实例详情,说明相关请求与结果处理方式,为开发者核对实例信息与相关运行配置提供参考。 ## 请求头 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 查询参数 **instanceId** `string` *required* 要查询详情的实例 ID。 ## 响应参数 **id** `string` *required* 实例 ID。 **name** `string` *required* 实例名称。 **clusterId** `string` *required* 集群 ID。 **clusterName** `string` *required* 集群名称。 **status** `string` *required* 实例状态。取值: * `toCreate`:待创建 * `creating`:创建中 * `pulling`:拉取镜像中 * `running`:运行中 * `toStart`:待启动 * `starting`:启动中 * `toStop`:待停止 * `stopping`:停止中 * `exited`:已停止 * `toRestart`:待重启 * `restarting`:重启中 * `toRemove`:待删除 * `removing`:删除中 * `removed`:已删除 * `toReset`:待重置(升级) * `resetting`:重置中 * `migrating`:迁移中 * `freezing`:冻结中 **sshCommand** `string` 用于 SSH 远程登录的命令。 **password** `string` 用于 SSH 远程登录的密码。 **imageUrl** `string` *required* 容器镜像地址。 **imageAuthId** `string` *required* 镜像仓库认证信息。 **command** `string` *required* 容器启动命令。 **entrypoint** `string` 容器启动 entrypoint。 **cpuNum** `string` *required* 实例的 CPU 数。单位为核。 **memory** `string` *required* 实例的内存大小。单位为 GB。 **gpuNum** `string` *required* 实例的 GPU 卡数。 **createdAt** `string` *required* 实例的创建时间。格式为 Unix 时间戳。 **lastStartedAt** `string` *required* 实例最近一次的启动时间。格式为 Unix 时间戳。 **lastStoppedAt** `string` *required* 实例最近一次的停止时间。格式为 Unix 时间戳。 **useTime** `string` *required* 实例的使用时长。单位为秒。 **billingMode** `string` *required* 实例的计费方式。取值: * onDemand:按量计费。 * monthly:包年包月。 * spot: 抢占式计费。 **productId** `string` *required* 用于部署实例的产品 ID。 **productName** `string` *required* 用于部署实例的产品名称。 **rootfsSize** `integer` *required* 系统盘大小。单位为 GB。 **tools** `object[]` 工具信息。目前部分官方镜像包含 Jupyter。 **properties** **name** `string` 工具名称。 **port** `string` 工具使用端口。 **type** `string` 工具使用端口类型。 **endpoint** `string` 工具访问地址。 **volumeMounts** `object[]` 实例的存储配置。 **properties** **type** `string` 存储类型。取值: * network:云存储。 * local:本地存储。 **size** `string` 存储容量大小。 **id** `string` 云存储 ID。当 type = network 时返回。 **mountPath** `string` 存储挂载路径。 **node** `object[]` 节点信息。 **properties** **maxRootfsSize** `string` 最大可用系统盘大小。 **jobs** `object[]` 当前实例正在运行的任务。 **properties** **id** `string` 任务 ID。 **type** `string` 任务类型。目前仅有saveImage,表示保存镜像。 **statusError** `object` 实例创建失败或实例不可用时的错误信息。 **properties** **state** `string` 实例异常状态。 **message** `string` 错误信息。 **network** `object` 实例的 VPC 网络信息。 **properties** **id** `string` VPC 网络的 ID。 **ip** `string` 实例的 IP 地址。 **portMappings** `object[]` *required* 实例端口映射信息。 **properties** **port** `integer` *required* 端口号。 **endpoint** `string` *required* Endpoint。 **type** `string` *required* 协议类型。 **envs** `object[]` 实例的环境变量信息。 **properties** **key** `string` 环境变量名称。 **value** `string` 环境变量取值。 **connectComponentSSH** `object` 实例 SSH 连接信息。 **properties** **isRunning** `boolean` 是否正在 SSH 远程登录。 **connectComponentWebTerminal** `object` 实例 Web Terminal连接信息。 **properties** **address** `string` 用于 Web 远程登录的地址。 **username** `string` 用于 Web 远程登录的用户名。 **password** `string` 用于 Web 远程登录的密码。 **isRunning** `boolean` 是否正在通过 Web 远程登录。 **connectComponentJupyter** `object` 实例 Jupyter 连接信息(如果有)。 **properties** **port** `integer` 连接端口。 **address** `string` 连接地址。 **isRunning** `boolean` 是否正在通过 Jupyter 远程登录。 **connectComponentLog** `object` 实例日志连接信息(HTTP Stream)。 **properties** **systemLogAddress** `string` 系统日志地址。 **instanceLogAddress** `string` 实例日志地址。 请求日志时可在地址中增加如下参数: * follow=0 或 1:是否持续获取日志。取值 0(不持续) 或 1(持续)。默认 1。 * sse=0 或 1:是否使用 SSE 协议返回日志。取值 0(不使用) 或 1(使用)。默认 1。 * timestamp=0 或 1:是否需要时间戳。取值 0(不需要) 或 1(需要)。默认 1。 * tail=x:初始化日志时获取最后 x 行。 示例:`https://c092dad5a76a3da2-2224.gpu-instance.ppinfra.com/sys?follow=1&sse=1×tamps=1&tail=200` **isRunning** `boolean` 是否正在连接。 **kind** `string` 实例类型。 **endTime** `string` 包年包月实例到期时间。若是按量计费实例,则返回 -1。 **freeStorageSize** `integer` 免费的系统盘容量大小。单位为 GB。 **keepDataDay** `integer` 实例关机后,数据保留的天数。 # 获取实例监控数据 Source: https://ppio.com/docs/gpus/instance/reference-instance-monitor GET https://api.ppio.com/openapi/v1/metrics/gpu/instance PPIO 算力 API 文档介绍如何获取实例监控数据,说明相关请求与结果处理方式,为开发者观察计算资源运行情况提供参考。 ## 请求头 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 查询参数 **instanceId** `string` *required* 实例 ID。 **startTime** `integer` 查询监控数据起始时间,取值范围:(0, endTime - 60],默认值:当前时间戳 - 60。 **endTime** `integer` 查询监控数据结束时间,取值范围:(0, 当前时间戳],默认值:当前时间戳。 **interval** `integer` 查询监控数据时间粒度,单位(s),取值范围:> 15,默认值:15。 注意:endTime、startTime、interval 传参不符合要求会重置为默认值。获取实时的监控数据可能有一分钟左右延迟。 ## 响应参数 **cpuUtilization** `object[]` *required* CPU 使用率数据。 **properties** **timestamp** `string` *required* 时间戳。 **value** `number` *required* CPU 使用率。 **memUtilization** `object[]` *required* 内存使用率数据。 **properties** **timestamp** `string` *required* 时间戳。 **value** `number` *required* 内存使用率。 **rootDiskUtilization** `object[]` *required* 系统盘使用率数据。 **properties** **timestamp** `string` *required* 时间戳。 **value** `number` *required* 系统盘使用率。 **gpuUtilization** `object` *required* GPU 使用率数据。 **properties** **avg** `object[]` *required* 所有 GPU 平均使用率。 **properties** **timestamp** `string` *required* 时间戳。 **value** `number` *required* 使用率。 **gpuIds** `object[]` *required* 每个 GPU 使用率。 **properties** **gpuId** `string` *required* 实际使用的 GPU 编号。 **items** `object[]` *required* GPU 使用率数据。 **properties** **timestamp** `string` *required* 时间戳。 **value** `number` *required* 使用率。 **gpuMemUtilization** `object` *required* GPU 显存使用率数据。 **properties** **avg** `object[]` *required* 所有 GPU 显存平均使用率。 **properties** **timestamp** `string` *required* 时间戳。 **value** `number` *required* 使用率。 **gpuIds** `object[]` *required* 每个 GPU 显存使用率。 **properties** **gpuId** `string` *required* 实际使用的 GPU 编号。 **items** `object[]` *required* GPU 显存使用率数据。 **properties** **timestamp** `string` *required* 时间戳。 **value** `number` *required* 使用率。 # 查询实例列表 Source: https://ppio.com/docs/gpus/instance/reference-list-instance GET https://api.ppio.com/gpu-instance/openapi/v1/gpu/instances PPIO 算力 API 文档介绍如何查询计算实例列表,说明相关请求与结果处理方式,为开发者查看和组织现有云端计算资源提供参考。 ## 请求头 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 查询参数 **pageSize** `integer` *required* 每页返回的最大条数。整数,取值 >= 0。 **pageNum** `integer` *required* 获取第几页。整数,取值 >= 0。 **name** `string` 实例名称(支持模糊查询)。字符串,长度限制:0-255 字符。 **productName** `string` 产品名称(支持模糊查询)。字符串,长度限制:0-255 字符。 **status** `string` 实例状态。字符串,长度限制:0-63 字符。可选值: * `toCreate`:待创建 * `creating`:创建中 * `pulling`:拉取镜像中 * `running`:运行中 * `toStart`:待启动 * `starting`:启动中 * `toStop`:待停止 * `stopping`:停止中 * `exited`:已停止 * `toRestart`:待重启 * `restarting`:重启中 * `toRemove`:待删除 * `removing`:删除中 * `removed`:已删除 * `toReset`:待重置(升级) * `resetting`:重置中 * `migrating`:迁移中 * `freezing`:冻结中 ## 响应参数 **instances** `object[]` *required* 实例信息。 **properties** **id** `string` *required* 实例 ID。 **name** `string` *required* 实例名称。 **clusterId** `string` *required* 集群 ID。 **clusterName** `string` 集群名称。 **status** `string` *required* 实例状态。 **imageUrl** `string` *required* 容器镜像地址。 **imageAuthId** `string` 镜像仓库认证信息。 **command** `string` 容器启动命令。 **entrypoint** `string` 容器启动 entrypoint。 **cpuNum** `string` *required* 实例的 CPU 数。单位为核。 **memory** `string` *required* 实例的内存大小。单位为 GB。 **gpuNum** `string` *required* 实例的 GPU 卡数。 **portMappings** `object[]` 实例端口信息。 **properties** **port** `integer` *required* 端口值。 **type** `string` *required* 端口类型。 **productId** `string` *required* 用于部署实例的产品 ID。 **productName** `string` *required* 用于部署实例的产品名称。 **rootfsSize** `integer` *required* 系统盘大小。单位为 GB。 **volumeMounts** `object[]` 实例的存储配置。 **properties** **type** `string` 存储类型。取值: * network:云存储。 * local:本地存储。 **size** `string` 存储容量大小。 **id** `string` 云存储 ID。当 type = network 时返回。 **mountPath** `string` 存储挂载路径。 **statusError** `object` 实例创建失败或实例不可用时的错误信息。 **properties** **state** `string` 实例异常状态。 **message** `string` 错误信息。 **envs** `object[]` 实例的环境变量信息。 **properties** **key** `string` 环境变量名称。 **value** `string` 环境变量取值。 **kind** `string` 实例类型。 **billingMode** `string` *required* 实例的计费方式。取值: * onDemand:按量计费。 * monthly:包年包月。 * spot:抢占式计费。 **endTime** `string` 包年包月实例到期时间。若是按量计费实例,则返回 -1。 查询结果的总条数。 # 迁移实例 Source: https://ppio.com/docs/gpus/instance/reference-migrate-instance POST https://api.ppio.com/gpu-instance/openapi/v1/gpu/instance/migrate PPIO 算力 API 文档介绍如何迁移指定计算实例,说明相关请求与结果处理方式,为开发者按资源调整需求维护部署位置提供参考。 ## 接口说明 迁移实例时,不保存系统盘和本地磁盘新增的数据。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **instanceId** `string` *required* 要迁移的实例 ID。 # 续费包年包月实例 Source: https://ppio.com/docs/gpus/instance/reference-renewal-instance POST https://api.ppio.com/gpu-instance/openapi/v1/gpu/instance/renewInstance PPIO 算力 API 文档介绍如何办理实例续费,说明相关请求与结果处理方式,为开发者维护已有计算资源的使用安排提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **instanceId** `string` *required* 要续费的包年包月实例 ID。 **month** `integer` *required* 续费时长。单位为月。 # 重启实例 Source: https://ppio.com/docs/gpus/instance/reference-restart-instance POST https://api.ppio.com/gpu-instance/openapi/v1/gpu/instance/restart PPIO 算力 API 文档介绍如何重启指定实例,说明相关请求与结果处理方式,为开发者管理计算环境的运行状态提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **instanceId** `string` *required* 要重启的实例 ID。 # 设置自动迁移策略 Source: https://ppio.com/docs/gpus/instance/reference-set-auto-migrate POST https://api.ppio.com/gpu-instance/openapi/v1/gpu/instance/setAutoMigrate PPIO 算力 API 文档介绍如何配置实例自动迁移策略,说明相关请求与结果处理方式,为开发者管理资源迁移相关行为提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **instanceId** `string` *required* 实例 ID。 **autoMigrateOpen** `boolean` *required* 启动/关闭实例迁移。 **autoMigrateSystemDisk** `boolean` *required* 启动/关闭实例迁移系统盘。 # 包年包月设置自动续费 Source: https://ppio.com/docs/gpus/instance/reference-set-autorenew POST https://api.ppio.com/gpu-instance/openapi/v1/gpu/instance/setAutoRenew PPIO 算力 API 文档介绍如何配置实例自动续费,说明相关请求与结果处理方式,为开发者维护续费策略和资源使用计划提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **instanceIds** `string[]` *required* 实例 ID 列表。 **autoRenew** `boolean` *required* 是否开启自动续费。 **autoRenewMonth** `integer` *required* 自动续费月数。 # 启动实例 Source: https://ppio.com/docs/gpus/instance/reference-start-instance POST https://api.ppio.com/gpu-instance/openapi/v1/gpu/instance/start PPIO 算力 API 文档介绍如何启动已有实例,说明相关请求与结果处理方式,为开发者使计算环境进入任务运行流程提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **instanceId** `string` *required* 要启动的实例 ID。 # 停止实例 Source: https://ppio.com/docs/gpus/instance/reference-stop-instance POST https://api.ppio.com/gpu-instance/openapi/v1/gpu/instance/stop PPIO 算力 API 文档介绍如何停止指定实例,说明相关请求与结果处理方式,为开发者管理任务结束后的资源状态提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **instanceId** `string` *required* 要停止的实例 ID。 # 升级实例 Source: https://ppio.com/docs/gpus/instance/reference-upgrade-instance POST https://api.ppio.com/gpu-instance/openapi/v1/gpu/instance/upgrade PPIO 算力 API 文档介绍如何升级实例环境,说明相关请求与结果处理方式,为开发者维护应用运行所需的实例配置提供参考。 ## 接口说明 升级实例时,参数必须全量传递。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **instanceId** `string` *required* 要升级的实例 ID。 **imageUrl** `string` *required* 容器镜像地址。字符串,长度限制:1-500 字符。 **imageAuthId** `string` 镜像仓库认证 ID。 **envs** `object[]` *required* 实例环境变量。最多创建 100 组环境变量。 **properties** **key** `string` 环境变量名称。字符串,长度限制:0-511 字符。 **value** `string` 环境变量取值。字符串,长度限制:0-4095 字符。 **command** `string` *required* 容器启动命令。字符串,长度限制:0-2047 字符。 **entrypoint** `string` *required* 容器启动 entrypoint。该配置会覆盖 Docker 镜像的 ENTRYPOINT。字符串,长度限制:0-2047 字符。 **save** `boolean` *required* 是否保存旧实例中的数据。布尔值,取值:true、false。 **networkVolume** `object` *required* 编辑云存储(type:network),一个实例最大支持挂载 30 个云存储。如果需要移除所有云存储挂载,volumeMounts 请传空数组:\[]。 **properties** **volumeMounts** `object[]` *required* 云存储挂载信息。 **properties** **type** `string` *required* 存储类型。固定取值为 network。 **id** `string` *required* 云存储 ID。 **mountPath** `string` *required* 云存储的挂载路径。默认值:"/network",字符串,长度限制:1-4095 字符。 # 修改实例计费方式 Source: https://ppio.com/docs/gpus/instance/reference-v2-change-billing-instance gpus/v2-spec/change-billing-instance.json PUT /gpus/v2/instances/{instance_id}/billing-mode PPIO 算力 API v2 文档介绍如何调整实例的计费方式,说明相关请求与结果处理方式,为开发者按使用计划维护实例费用配置提供参考。 # 创建实例 Source: https://ppio.com/docs/gpus/instance/reference-v2-create-gpu-instance gpus/v2-spec/create-gpu-instance.json POST /gpus/v2/instances PPIO 算力 API v2 文档介绍如何创建实例,说明相关请求与结果处理方式,为开发者为模型与计算任务准备运行资源提供参考。 # 删除实例 Source: https://ppio.com/docs/gpus/instance/reference-v2-delete-instance gpus/v2-spec/delete-instance.json DELETE /gpus/v2/instances/{instance_id} PPIO 算力 API v2 文档介绍如何删除指定实例,说明相关请求与结果处理方式,为开发者结束资源使用并维护实例清单提供参考。 # 扩容实例系统盘 Source: https://ppio.com/docs/gpus/instance/reference-v2-expand-rootfs gpus/v2-spec/expand-rootfs.json PUT /gpus/v2/instances/{instance_id}/rootfs-expand PPIO 算力 API v2 文档介绍如何扩容实例系统盘,说明相关请求与结果处理方式,为开发者按应用需求调整系统盘容量提供参考。 # 查询实例详情 Source: https://ppio.com/docs/gpus/instance/reference-v2-get-instance gpus/v2-spec/get-instance.json GET /gpus/v2/instances/{instance_id} PPIO 算力 API v2 文档介绍如何读取指定实例详情,说明相关请求与结果处理方式,为开发者核对实例信息与相关运行配置提供参考。 # 查询实例列表 Source: https://ppio.com/docs/gpus/instance/reference-v2-list-instance gpus/v2-spec/list-instance.json GET /gpus/v2/instances PPIO 算力 API v2 文档介绍如何查询计算实例列表,说明相关请求与结果处理方式,为开发者查看和组织现有云端计算资源提供参考。 # 迁移实例 Source: https://ppio.com/docs/gpus/instance/reference-v2-migrate-instance gpus/v2-spec/migrate-instance.json PUT /gpus/v2/instances/{instance_id}/migrate PPIO 算力 API v2 文档介绍如何迁移指定计算实例,说明相关请求与结果处理方式,为开发者按资源调整需求维护部署位置提供参考。 # 实例续费 Source: https://ppio.com/docs/gpus/instance/reference-v2-renewal-instance gpus/v2-spec/renewal-instance.json PUT /gpus/v2/instances/{instance_id}/renew PPIO 算力 API v2 文档介绍如何办理实例续费,说明相关请求与结果处理方式,为开发者维护已有计算资源的使用安排提供参考。 # 重启实例 Source: https://ppio.com/docs/gpus/instance/reference-v2-restart-instance gpus/v2-spec/restart-instance.json PUT /gpus/v2/instances/{instance_id}/restart PPIO 算力 API v2 文档介绍如何重启指定实例,说明相关请求与结果处理方式,为开发者管理计算环境的运行状态提供参考。 # 设置实例自动迁移 Source: https://ppio.com/docs/gpus/instance/reference-v2-set-auto-migrate gpus/v2-spec/set-auto-migrate.json PUT /gpus/v2/instances/{instance_id}/auto-migrate PPIO 算力 API v2 文档介绍如何配置实例自动迁移策略,说明相关请求与结果处理方式,为开发者管理资源迁移相关行为提供参考。 # 设置实例自动续费 Source: https://ppio.com/docs/gpus/instance/reference-v2-set-autorenew gpus/v2-spec/set-autorenew.json PUT /gpus/v2/instances/{instance_id}/auto-renew PPIO 算力 API v2 文档介绍如何配置实例自动续费,说明相关请求与结果处理方式,为开发者维护续费策略和资源使用计划提供参考。 # 设置 Web Terminal Source: https://ppio.com/docs/gpus/instance/reference-v2-set-web-terminal gpus/v2-spec/set-web-terminal.json PUT /gpus/v2/instances/{instance_id}/web-terminal PPIO 算力 API v2 文档介绍如何设置实例 Web Terminal,说明相关请求与结果处理方式,为开发者管理浏览器终端相关访问配置提供参考。 # 启动实例 Source: https://ppio.com/docs/gpus/instance/reference-v2-start-instance gpus/v2-spec/start-instance.json PUT /gpus/v2/instances/{instance_id}/start PPIO 算力 API v2 文档介绍如何启动已有实例,说明相关请求与结果处理方式,为开发者使计算环境进入任务运行流程提供参考。 # 停止实例 Source: https://ppio.com/docs/gpus/instance/reference-v2-stop-instance gpus/v2-spec/stop-instance.json PUT /gpus/v2/instances/{instance_id}/stop PPIO 算力 API v2 文档介绍如何停止指定实例,说明相关请求与结果处理方式,为开发者管理任务结束后的资源状态提供参考。 # 更新实例端口 Source: https://ppio.com/docs/gpus/instance/reference-v2-update-ports gpus/v2-spec/update-ports.json PUT /gpus/v2/instances/{instance_id}/ports PPIO 算力 API v2 文档介绍如何更新实例端口配置,说明相关请求与结果处理方式,为开发者维护应用服务对外连接设置提供参考。 # 升级实例 Source: https://ppio.com/docs/gpus/instance/reference-v2-upgrade-instance gpus/v2-spec/upgrade-instance.json PUT /gpus/v2/instances/{instance_id}/upgrade PPIO 算力 API v2 文档介绍如何升级实例环境,说明相关请求与结果处理方式,为开发者维护应用运行所需的实例配置提供参考。 # 强制中断任务 Source: https://ppio.com/docs/gpus/job/reference-break-job POST https://api.ppio.com/gpu-instance/openapi/v1/job/break PPIO 算力 API 文档介绍如何终止指定 Job 任务,说明相关请求与结果处理方式,为开发者结束不再需要继续执行的计算工作提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **jobId** `string` *required* 任务 ID。字符串,长度限制:0-255 字符。 ## 响应参数 **jobId** `string` *required* 任务 ID。 ## 示例 ### 请求示例 ```bash theme={null} curl --location --request POST 'https://api.ppio.com/gpu-instance/openapi/v1/job/break' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{API 密钥}}' \ --data-raw '{ "jobId": "10wi9visv0rqt57w" }' ``` ### 响应示例 ```json theme={null} { "jobId": "10wi9visv0rqt57w" } ``` # 查询任务列表 Source: https://ppio.com/docs/gpus/job/reference-list-jobs GET https://api.ppio.com/gpu-instance/openapi/v1/jobs PPIO 算力 API 文档介绍如何查询计算任务列表,说明相关请求与结果处理方式,为开发者查看已有 Job 并维护任务清单提供参考。 ## 请求头 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 查询参数 **pageSize** `integer` 获取 x 条/页。整数,取值范围:大于等于 0。 **pageNum** `integer` 获取第 x 页。整数,取值范围:大于等于 0。 **jobId** `string` 过滤任务 ID。字符串,长度限制:0-255 字符。 **type** `string` 过滤任务类型。可选值: * `saveImage`:保存镜像 * `instanceMigrate`:实例迁移 * `autoInstanceMigrate`:实例自动迁移 **state** `string` 过滤任务状态。可选值: * `pulling`:准备中 * `running`:运行中 * `fail`:失败 * `success`:成功 * `break`:中断 **startTime** `integer` 查询开始时间戳,单位秒。取值范围:大于等于 0,默认:0。 **endTime** `integer` 查询截止时间戳,单位秒。取值范围:大于等于 0,默认:0。 **creators** `string` 过滤任务创建人 ID。字符串,长度限制:0-255 字符。 ## 响应参数 **jobs** `object[]` *required* 任务列表。 **properties** **Id** `string` *required* 任务 ID。 **user** `string` *required* 发起该任务的用户 ID。 **type** `string` *required* 任务类型。可选值:`saveImage`、`instanceMigrate`、`autoInstanceMigrate`。 **envs** `object[]` 执行任务的环境变量配置。 **state** `object` *required* 当前任务状态信息。 **properties** **state** `string` *required* 当前任务状态。可选值:`pulling`、`running`、`fail`、`success`、`break`。 **error** `string` 错误代码(如有)。 **errorMessage** `string` 错误描述(如有)。 **logAddress** `string` 日志访问地址,可查看任务执行日志。 **createdAt** `string` *required* 任务创建时间(Unix 时间戳,单位秒)。 **instanceId** `string` *required* 任务执行时关联的实例 ID。 **total** `integer` *required* 当前任务总数。 ## 示例 ### 请求示例 ```bash theme={null} curl --location --request GET 'https://api.ppio.com/gpu-instance/openapi/v1/jobs?pageSize=5&pageNum=1&jobId&type&state&startTime&endTime&creators' \ --header 'Authorization: Bearer {{API 密钥}}' ``` ### 响应示例 ```json theme={null} { "jobs": [ { "Id": "osjl7wr6my1vuefg", "user": "xxx", "type": "saveImage", "envs": [], "state": { "state": "break", "error": "", "errorMessage": "" }, "logAddress": "https://osjl7wr6my1vuefg-xxxxxx/job", "createdAt": "1755052230", "instanceId": "6334d0f2c779ae1d" } ], "total": 56 } ``` # 终止 Job Source: https://ppio.com/docs/gpus/job/reference-v2-break-job gpus/v2-spec/break-job.json POST /gpus/v2/jobs/{job_id}/stop PPIO 算力 API v2 文档介绍如何终止指定 Job 任务,说明相关请求与结果处理方式,为开发者结束不再需要继续执行的计算工作提供参考。 # 查询 Job 详情 Source: https://ppio.com/docs/gpus/job/reference-v2-get-job gpus/v2-spec/get-job.json GET /gpus/v2/jobs/{job_id} PPIO 算力 API v2 文档介绍如何读取指定 Job 详情,说明相关请求与结果处理方式,为开发者检查任务信息与执行记录提供参考。 # 查询 Job 列表 Source: https://ppio.com/docs/gpus/job/reference-v2-list-jobs gpus/v2-spec/list-jobs.json GET /gpus/v2/jobs PPIO 算力 API v2 文档介绍如何查询计算任务列表,说明相关请求与结果处理方式,为开发者查看已有 Job 并维护任务清单提供参考。 # 保存镜像 Source: https://ppio.com/docs/gpus/job/reference-v2-save-image gpus/v2-spec/save-image.json POST /gpus/v2/jobs/save-image PPIO 算力 API v2 文档介绍如何通过 Job 保存环境镜像,说明相关请求与结果处理方式,为开发者为后续部署复用已配置的软件环境提供参考。 # API 错误码说明 Source: https://ppio.com/docs/gpus/reference-error-code 查阅 PPIO GPU 服务 API 错误码及相关说明,根据请求返回的信息定位资源管理与服务接入问题,为调用排查提供参考。 ## GPU
错误名称 状态码 说明
UNKNOWN 500 未知错误
GET_TOKEN_FAILED 400 获取令牌失败
FORBIDDEN 403 禁止访问/无权限
UNAUTHORIZED 401 未授权
USER_ALREADY_EXISTS 400 用户已存在
INVALID_USER_OR_PASSWORD 400 无效的用户或密码
INVALID_CODE 400 无效的验证码
USER_NOT_FOUND 400 用户未找到
USER_PHONE_NOT_CONSIST 400 用户手机不一致
SEND_CODE_TOO_FAST 429 发送验证码过于频繁
INVALID_PUBLIC_KEY 400 无效的公钥
USER_NOT_ACTIVATED 400 用户未激活
USER_ALREADY_ACTIVATED 400 用户已激活
INVALID_USER_TOKEN 400 无效的用户令牌
BANNED_USER 400 账号已被禁用
RATE_LIMIT_EXCEEDED 429 超出请求频率限制
RESOURCE_NOT_FOUND 400 资源未找到(例如,容器未找到)
CONFLICT 400 冲突(例如,容器冲突)
VALIDATOR_PARAM 400 参数校验失败/无效参数
REQUEST 400 请求错误
OPERATION_LIMIT 400 操作限制
INSUFFICIENT_RESOURCE 400 资源不足
CLUSTER_STATUS 400 集群状态异常
NODE_STATUS 400 节点状态异常
DEPENDENT_RESOURCE_STATE 400 依赖资源状态异常
PREPAID_INSTANCE_NOT_SUPPORT_RELEASE 400 预付费实例不支持释放
CREATING_INSTANCE_NOT_SUPPORT_RENEWAL 400 创建中的实例不支持续费
INSTANCE_LOCAL_STORAGE_NOT_FOUND 400 实例本地存储未找到
INVALID_COMMAND_PARAM 400 无效的实例启动命令参数
GPU_SPEC_USED 400 GPU 规格已被使用
INCORRECT_USER_SYNCER_REQUIRE_PARAMS 400 用户同步请求参数不正确
MIGRATE_INSUFFICIENT_RESOURCE 400 迁移资源不足
WALLET_NOT_FOUND 500 钱包未找到
WALLET_UNSUPPORT_RECHARGE_METHOD 400 钱包不支持该充值方式
BALANCE_NOT_ENOUGH 400 余额不足
UNSUPPORTED_BILLING_MODE 400 不支持的计费模式
EXPIRED_OR_BALANCE_NOT_ENOUGH 400 过期或余额不足
ORDER_NOT_FOUND 400 订单未找到
SAVING_PLAN_ALREADY_EXISTS 400 Saving plan 计划已存在
CREATE_INSTANCE_LIMIT 400 创建实例数量达到上限,请充值或删除其他实例
NETWORK_STORAGE_TOO_LARGE 400 网络存储过大
CUR_CLUSTER_NETWORK_STORAGE_NOT_SUPPORT 400 当前区域不支持网络存储
NETWORK_STORAGE_IN_USE 400 网络存储正在使用中
NETWORK_STORAGE_UNAVAILABLE 400 网络存储不可用
NETWORK_STORAGE_NOT_FOUND 400 网络存储未找到
IMAGE_NOT_FOUND 400 镜像未找到
IMAGE_AUTH_IN_USE 400 镜像认证正在使用中
NETWORK_NOT_FOUND 400 实例网络未找到
NETWORK_IN_USE 400 实例网络正在使用中
NETWORK_MAX_LIMIT 400 实例网络超出最大创建限制
SEND_MSG_ERROR 400 发送消息错误
JOB_NOT_FOUND 400 实例任务未找到
SERVERLESS_ENDPOINT_NOT_FOUND 400 Serverless endpoint 未找到
SERVERLESS_WORKER_NOT_FOUND 400 Serverless worker 未找到
SERVERLESS_PRODUCT_NOT_FOUND 400 Serverless 产品未找到
SERVERLESS_APP_NAME_IS_EXIST 400 Serverless 应用名称已存在
TEMPLATE_IS_PRIVATE 400 模板是私有的
TEMPLATE_NOT_FOUND 400 模板未找到
## 账单
错误名称 状态码 说明
UNKNOWN 500 未知错误,请联系我们
LIST_BILL_TOO_FAST 429 请求过于频繁,请稍后重试
INVALID_PRODUCT_CATEGORY 400 productCategory 参数错误
INVALID_BILL_CYCLE 400 cycle 参数错误
LIST_BILL_ERROR 500 查询错误,请联系我们
# 获取账户信息 Source: https://ppio.com/docs/gpus/reference-get-user-info GET https://api.ppio.com/v3/user PPIO 算力 API 文档介绍如何读取账户相关信息,说明相关请求与结果处理方式,为开发者核对服务使用与账户资源信息提供参考。 用于查询账户余额等信息。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 响应参数 **credit_balance** `number` *required* 账户余额信息。 # 获取集群信息 Source: https://ppio.com/docs/gpus/reference-list-clusters GET https://api.ppio.com/gpu-instance/openapi/v1/clusters PPIO 算力 API 文档介绍如何查询集群信息,说明相关请求与结果处理方式,为开发者了解部署时可参考的集群资源提供参考。 ## 请求头 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 响应参数 **data** `object[]` *required* **properties** **id** `string` *required* 集群 ID。 **name** `string` *required* 集群名称。 **availableGpuType** `[string]` *required* 集群支持的 GPU 类型。 **supportNetworkStorage** `boolean` *required* 集群是否支持创建云存储。 **supportInstanceNetwork** `boolean` *required* 集群是否支持创建 VPC 网络。 # 获取 CPU 产品列表 Source: https://ppio.com/docs/gpus/reference-list-cpu-products GET https://api.ppio.com/gpu-instance/openapi/v1/cpu/products PPIO 算力 API 文档介绍如何查询 CPU 产品列表,说明相关请求与结果处理方式,为开发者比较可用 CPU 资源的配置提供参考。 ## 请求头 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 查询参数 **clusterId** `string` 筛选指定集群 ID。字符串,长度限制:0-255 字符。 **productName** `string` 筛选的产品名称(模糊匹配)。字符串,长度限制:0-255 字符。 ## 响应参数 **id** `string` *required* CPU 产品 ID。 **name** `string` *required* CPU 产品名称。 **cpuNum** `integer` CPU 数。单位为核。 **memorySize** `integer` 内存大小。单位为 GB。 **rootfsSize** `integer` 系统盘大小。单位为 GB。 **localVolumeSize** `integer` 本地盘大小。单位为 GB。 **availableDeploy** `boolean` 该产品是否可以创建实例。取值: * true:该产品可以创建实例。 * false::该产品资源不足,不能创建实例。 **price** `integer` 产品单价。 # 获取 GPU 产品列表 Source: https://ppio.com/docs/gpus/reference-list-gpu-products GET https://api.ppio.com/gpu-instance/openapi/v1/products PPIO 算力 API 文档介绍如何查询 GPU 产品列表,说明相关请求与结果处理方式,为开发者比较可用 GPU 资源的配置提供参考。 ## 请求头 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 查询参数 **clusterId** `string` 筛选指定集群ID。字符串,长度限制:0-255 字符。 **gpuNum** `integer` 筛选的显卡数量。整数,取值范围:\[0, 8]。 **productName** `string` 筛选的产品名称(模糊匹配)。字符串,长度限制:0-255 字符。 **minCpuPerGpu** `integer` 筛选规格(最小可使用cpu 核/卡)。整数,取值范围:大于等于 0。 **minMemoryPerGpu** `integer` 筛选规格(最小可使用内存 GB/卡)。整数,取值范围:大于等于 0。 **minRootFSSize** `integer` 筛选规格(最小可使用系统盘存储 GB/卡)。整数,取值范围:大于等于 0。 **billingMethod** `string` 筛选计费模式。可选值: * `onDemand`: 按量计费实例(默认) * `monthly`: 包年包月计费实例 * `spot`: 抢占式计费 ## 响应参数 **data** `object[]` *required* GPU 产品信息。 **properties** **id** `string` *required* 产品 ID。 **name** `string` *required* 产品名称。 **cpuPerGpu** `integer` *required* CPU 数。单位为核/卡。 **memoryPerGpu** `integer` *required* 内存大小。单位为 GB/卡。 **diskPerGpu** `integer` *required* 磁盘大小。单位为 GB/卡。 **availableDeploy** `boolean` *required* 该产品是否可以创建实例。取值: * true:产品可以创建实例。 * false::产品资源不足,不能创建实例。 **minRootFS** `integer` *required* 系统盘可用最小值。单位为 GB。 **maxRootFS** `integer` *required* 系统盘可用最大值。单位为 GB。 **minLocalStorage** `integer` *required* 本地盘可用最小值。单位为 GB。 **maxLocalStorage** `integer` *required* 本地盘可用最大值。单位为 GB。 **regions** `[string]` *required* 可用集群。表示该产品仅在指定集群可用,如果列表为空,则所有集群均可使用。 **price** `integer` *required* 该产品创建按量计费实例的价格。 **monthlyPrice** `object[]` *required* 该产品创建包年包月实例的价格。 **properties** **price** `integer` *required* 包年包月实例的单价。 **month** `integer` *required* 包年包月实例的租用时长。单位为月。 **billingMethods** `string[]` *required* 该产品支持的计费方式。可选值: * `onDemand`:按量计费 * `monthly`:包年包月计费 * `spot`:抢占式计费 **spotPrice** `string` 抢占式计费实例价格。 **inventoryState** `string` 产品库存状态。 * `none`:无库存 * `low`:库存较少 * `normal`:库存一般 * `high`:库存充足 # API 使用说明 Source: https://ppio.com/docs/gpus/reference-start 了解 PPIO GPU 服务 API 的基本使用方式,查阅接口接入与请求组织说明,为将计算资源管理整合进应用和运维流程提供参考。 ## API 鉴权方式 API 使用请求头 中的 Authorization 字段携带 API 密钥进行身份认证。您可以在[API 密钥管理页面](https://ppio.com/settings#key-management)查看和管理您的 API 密钥。 ```json theme={null} { "Authorization": "Bearer {{API 密钥}}" } ``` > [!NOTE] > > GPU 容器 API 当前提供 V2 与 V1 两个版本,推荐优先使用 V2。下方管理流程默认给出 V2 接口链接,V1 接口请在「GPU 容器 API v1」分组下查看。 ## 实例管理流程(V2) 1. 创建并获取 API 密钥。详情请参见[管理 API 密钥](/docs/support/api-key)。 2. (可选)[创建 VPC 网络](/docs/gpus/vpc/reference-v2-create-vpc)。 3. 创建实例。 * [查询产品列表](/docs/gpus/reference-v2-list-gpu-products)、[创建实例](/docs/gpus/instance/reference-v2-create-gpu-instance) 4. 查询实例。 * [查询实例列表](/docs/gpus/instance/reference-v2-list-instance) * [查询实例详情](/docs/gpus/instance/reference-v2-get-instance) 5. 管理实例。 * [更新实例端口](/docs/gpus/instance/reference-v2-update-ports) * [启动实例](/docs/gpus/instance/reference-v2-start-instance) * [停止实例](/docs/gpus/instance/reference-v2-stop-instance) * [重启实例](/docs/gpus/instance/reference-v2-restart-instance) * [升级实例](/docs/gpus/instance/reference-v2-upgrade-instance) * [扩容实例系统盘](/docs/gpus/instance/reference-v2-expand-rootfs) * [迁移实例](/docs/gpus/instance/reference-v2-migrate-instance) * [实例续费](/docs/gpus/instance/reference-v2-renewal-instance) * [修改实例计费方式](/docs/gpus/instance/reference-v2-change-billing-instance) 6. [删除实例](/docs/gpus/instance/reference-v2-delete-instance)。 ## Serverless 管理流程(V2) 1. 创建并获取 API 密钥。详情请参见[管理 API 密钥](/docs/support/api-key)。 2. [查询产品列表](/docs/gpus/reference-v2-list-gpu-products)。 3. [创建 Endpoint](/docs/gpus/endpoint/reference-v2-create-endpoint)。 4. 查询 Endpoint。 * [查询 Endpoint 列表](/docs/gpus/endpoint/reference-v2-list-endpoint) * [查询 Endpoint 详情](/docs/gpus/endpoint/reference-v2-get-endpoint) 5. [更新 Endpoint](/docs/gpus/endpoint/reference-v2-update-endpoint)。 6. [删除 Endpoint](/docs/gpus/endpoint/reference-v2-delete-endpoint)。 # 查询产品列表 Source: https://ppio.com/docs/gpus/reference-v2-list-gpu-products gpus/v2-spec/list-gpu-products.json GET /gpus/v2/products PPIO 算力 API v2 文档介绍如何查询产品列表,说明相关请求与结果处理方式,为开发者比较可用 GPU 资源的配置提供参考。 # 创建模板 Source: https://ppio.com/docs/gpus/template/reference-create-template POST https://api.ppio.com/gpu-instance/openapi/v1/template/create PPIO 算力 API 文档介绍如何创建部署模板,说明相关请求与结果处理方式,为开发者将运行环境配置组织为可复用资源提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **template** `object` *required* 模板信息对象,用于定义实例模板配置。 **properties** **name** `string` *required* 模板名称。长度:\[1-255]。 **type** `string` *required* 模板类型。可选值: * `instance` **channel** `string` *required* 模板可见性。可选值: * `private` **readme** `string` 模板说明,支持 Markdown。长度:\[0-102400]。 **image** `string` *required* 镜像地址,可为公共镜像或私有镜像。长度:\[1-500]。 **imageAuth** `string` 私有镜像认证信息 ID。长度:\[0-255]。 **startCommand** `string` 启动命令。长度:\[0-2047]。 **entrypoint** `string` 实例启动 entrypoint。该配置会覆盖 Docker 镜像的 ENTRYPOINT。长度:\[0-2047]。 **rootfsSize** `integer` *required* 系统盘大小(单位:GB)。取值范围:> 0。 **ports** `object[]` 端口配置列表,用于定义暴露的服务端口。 **properties** **type** `string` *required* 端口类型。可选值:`tcp`、`http`。 **ports** `integer[]` *required* 端口号数组。取值范围:\[1-65535];其中 2222、2223、2224 为内部端口,不可使用。 **envs** `object[]` 实例环境变量。最多创建 100 组。 **properties** **key** `string` 环境变量名。长度:\[0-511]。 **value** `string` 环境变量值。长度:\[0-4095]。 **minCudaVersion** `string` 模板支持的最小 CUDA 版本,需填写指定格式,例如:11.8、12.4。长度:\[0-255]。 ## 响应参数 **templateId** `string` *required* 模板 ID。 ## 示例 ### 请求示例 ```bash theme={null} curl --location --request POST 'https://api.ppio.com/gpu-instance/openapi/v1/template/create' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{API 密钥}}' \ --data-raw '{ "template": { "name": "test", "type": "instance", "channel": "private", "readme": "test create template", "image": "nginx", "imageAuth": "", "startCommand": "echo test", "entrypoint": "", "rootfsSize": 60, "ports": [ {"type": "http", "ports": [80, 443]}, {"type": "tcp", "ports": [90, 95]} ], "envs": [ {"key": "test1", "value": "template1"}, {"key": "test2", "value": "test2"} ], "minCudaVersion": "11.8" } }' ``` ### 响应示例 ```json theme={null} { "templateId": "101034" } ``` # 更新模板 Source: https://ppio.com/docs/gpus/template/reference-update-template POST https://api.ppio.com/gpu-instance/openapi/v1/template/update PPIO 算力 API 文档介绍如何更新部署模板,说明相关请求与结果处理方式,为开发者维护后续部署所使用的环境配置提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **template** `object` *required* 模板信息对象,用于定义实例模板配置。 **properties** **Id** `string` *required* 模板 ID。长度:\[1-255]。 **name** `string` *required* 模板名称。长度:\[1-255]。 **type** `string` *required* 模板类型。可选值: * `instance` **channel** `string` *required* 模板可见性。可选值: * `private` **readme** `string` 模板说明,支持 Markdown。长度:\[0-102400]。 **image** `string` *required* 镜像地址,可为公共镜像或私有镜像。长度:\[1-500]。 **imageAuth** `string` 私有镜像认证信息 ID。长度:\[0-255]。 **startCommand** `string` 启动命令。长度:\[0-2047]。 **entrypoint** `string` 实例启动 entrypoint。该配置会覆盖 Docker 镜像的 ENTRYPOINT。长度:\[0-2047]。 **rootfsSize** `integer` *required* 系统盘大小(单位:GB)。取值范围:> 0。 **ports** `object[]` 端口配置列表,用于定义暴露的服务端口。 **properties** **type** `string` *required* 端口类型。可选值:`tcp`、`http`。 **ports** `integer[]` *required* 端口号数组。取值范围:\[1-65535];其中 2222、2223、2224 为内部端口,不可使用。 **envs** `object[]` 实例环境变量。最多创建 100 组。 **properties** **key** `string` 环境变量名。长度:\[0-511]。 **value** `string` 环境变量值。长度:\[0-4095]。 **minCudaVersion** `string` 模板支持的最小 CUDA 版本,需填写指定格式,例如:11.8、12.4。长度:\[0-255]。 ## 响应参数 **templateId** `string` *required* 模板 ID。 ## 示例 ### 请求示例 ```bash theme={null} curl --location --request POST 'https://api.ppio.com/gpu-instance/openapi/v1/template/update' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{API 密钥}}' \ --data-raw '{ "template": { "Id": "101036", "name": "test", "type": "instance", "channel": "private", "readme": "test create template", "image": "nginx", "imageAuth": "", "startCommand": "echo test", "entrypoint": "", "rootfsSize": 60, "ports": [ {"type": "http", "ports": [80, 443]}, {"type": "tcp", "ports": [90, 95]} ], "envs": [ {"key": "test1", "value": "template1"}, {"key": "test2", "value": "test2"} ], "minCudaVersion": "11.8" } }' ``` ### 响应示例 ```json theme={null} { "templateId": "101036" } ``` # 创建模板 Source: https://ppio.com/docs/gpus/template/reference-v2-create-template gpus/v2-spec/create-template.json POST /gpus/v2/templates PPIO 算力 API v2 文档介绍如何创建部署模板,说明相关请求与结果处理方式,为开发者将运行环境配置组织为可复用资源提供参考。 # 删除模板 Source: https://ppio.com/docs/gpus/template/reference-v2-delete-template gpus/v2-spec/delete-template.json DELETE /gpus/v2/templates/{template_id} PPIO 算力 API v2 文档介绍如何删除指定部署模板,说明相关请求与结果处理方式,为开发者清理不再使用的环境配置提供参考。 # 查询模板详情 Source: https://ppio.com/docs/gpus/template/reference-v2-get-template gpus/v2-spec/get-template.json GET /gpus/v2/templates/{template_id} PPIO 算力 API v2 文档介绍如何读取部署模板详情,说明相关请求与结果处理方式,为开发者核对镜像与运行环境配置提供参考。 # 查询模板列表 Source: https://ppio.com/docs/gpus/template/reference-v2-list-templates gpus/v2-spec/list-templates.json GET /gpus/v2/templates PPIO 算力 API v2 文档介绍如何查询部署模板列表,说明相关请求与结果处理方式,为开发者浏览已有模板并选择任务环境提供参考。 # 更新模板 Source: https://ppio.com/docs/gpus/template/reference-v2-update-template gpus/v2-spec/update-template.json PUT /gpus/v2/templates/{template_id} PPIO 算力 API v2 文档介绍如何更新部署模板,说明相关请求与结果处理方式,为开发者维护后续部署所使用的环境配置提供参考。 # 创建 VPC 网络 Source: https://ppio.com/docs/gpus/vpc/reference-create-vpc POST https://api.ppio.com/gpu-instance/openapi/v1/network/create PPIO 算力 API 文档介绍如何创建网络资源,说明相关请求与结果处理方式,为开发者为实例连接准备网络环境提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **clusterId** `string` *required* 集群 ID。可以调用[获取集群信息](/docs/gpus/reference-list-clusters)接口获取。字符串,长度限制:1-255 字符。 **name** `string` VPC 网络的名称。自定义设置。字符串,长度限制:0-30 字符。 ## 响应参数 **network** `object[]` *required* VPC 网络信息。 **properties** **Id** `string` *required* VPC 网络的ID。 **user** `string` *required* 用户账号 ID。 **name** `string` *required* VPC 网络的名称。 **state** `object[]` *required* VPC 网络的状态。 **properties** **state** `string` *required* VPC 网络的状态。取值: * creating:创建中。 * ready:创建成功。 **error** `string` VPC 网络创建失败或者网络不可用时的错误提示。 **segment** `string` *required* VPC 网络的网段。 **clusterId** `string` *required* 集群 ID。 **Addresses** `object[]` *required* VPC 网络下的实例信息。 **properties** **Id** `string` *required* 实例 ID。 **Ip** `string` *required* 实例的 IP 地址。 **createTime** `string` *required* VPC 网络的创建时间。 # 删除 VPC 网络 Source: https://ppio.com/docs/gpus/vpc/reference-delete-vpc POST https://api.ppio.com/gpu-instance/openapi/v1/network/delete PPIO 算力 API 文档介绍如何删除指定网络资源,说明相关请求与结果处理方式,为开发者清理不再使用的网络配置提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **networkId** `string` *required* 集群ID。字符串,长度限制:1-255 字符。删除前,请确认该 VPC 网络下已没有实例。 # 修改 VPC 网络 Source: https://ppio.com/docs/gpus/vpc/reference-edit-vpc POST https://api.ppio.com/gpu-instance/openapi/v1/network/update PPIO 算力 API 文档介绍如何修改网络资源配置,说明相关请求与结果处理方式,为开发者维护实例连接所需的网络设置提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **networkId** `string` *required* 集群ID。字符串,长度限制:1-255 字符。 **name** `string` 自定义网络名称。字符串,长度限制:1-30 字符。 # 查询 VPC 网络详情 Source: https://ppio.com/docs/gpus/vpc/reference-get-vpc GET https://api.ppio.com/gpu-instance/openapi/v1/network PPIO 算力 API 文档介绍如何读取指定网络详情,说明相关请求与结果处理方式,为开发者核对网络资源信息提供参考。 ## 请求头 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 查询参数 **networkId** `string` *required* 集群ID。字符串,长度限制:1-255 字符。仅支持一个。 ## 响应参数 **network** `object[]` *required* VPC 网络信息。 **properties** **Id** `string` *required* VPC 网络的ID。 **user** `string` *required* 用户账号 ID。 **name** `string` *required* VPC 网络的名称。 **state** `object[]` *required* VPC 网络的状态。 **properties** **state** `string` *required* VPC 网络的状态。取值: * creating:创建中。 * ready:创建成功。 **error** `string` VPC 网络创建失败或者网络不可用时的错误提示。 **segment** `string` *required* VPC 网络的网段。 **clusterId** `string` *required* 集群 ID。 **Addresses** `object[]` *required* VPC 网络下的实例信息。 **properties** **Id** `string` *required* 实例 ID。 **Ip** `string` *required* 实例的 IP 地址。 **createTime** `string` *required* VPC 网络的创建时间。格式为 Unix时间戳。 # 查询 VPC 网络列表 Source: https://ppio.com/docs/gpus/vpc/reference-list-vpc GET https://api.ppio.com/gpu-instance/openapi/v1/networks PPIO 算力 API 文档介绍如何查询网络资源列表,说明相关请求与结果处理方式,为开发者查看已有网络并组织实例连接提供参考。 ## 请求头 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 查询参数 **pageSize** `integer` 获取 x 条/页。整数,取值范围:大于等于 0。 **pageNum** `integer` 获取第 x 页。整数,取值范围:大于等于 0。 **name** `string` 自定义网络名称(支持模糊查询)。字符串,长度限制:0-255 字符。 **creators** `string` 创建者用户ID。字符串,长度限制:0-255 字符。 ## 响应参数 **network** `object[]` *required* VPC 网络信息。 **properties** **Id** `string` *required* VPC 网络的ID。 **user** `string` *required* 用户账号 ID。 **name** `string` *required* VPC 网络的名称。 **state** `object[]` *required* VPC 网络的状态。 **properties** **state** `string` *required* VPC 网络的状态。取值: * creating:创建中。 * ready:创建成功。 **error** `string` VPC 网络创建失败或者网络不可用时的错误提示。 **segment** `string` *required* VPC 网络的网段。 **clusterId** `string` *required* 集群 ID。 **Addresses** `object[]` *required* VPC 网络下的实例信息。 **properties** **Id** `string` *required* 实例 ID。 **Ip** `string` *required* 实例的 IP 地址。 **createTime** `string` *required* VPC 网络的创建时间。格式为 Unix时间戳。 **total** `string` *required* 查询结果的条数。 # 创建 Network Source: https://ppio.com/docs/gpus/vpc/reference-v2-create-vpc gpus/v2-spec/create-vpc.json POST /gpus/v2/networks PPIO 算力 API v2 文档介绍如何创建网络资源,说明相关请求与结果处理方式,为开发者为实例连接准备网络环境提供参考。 # 删除 Network Source: https://ppio.com/docs/gpus/vpc/reference-v2-delete-vpc gpus/v2-spec/delete-vpc.json DELETE /gpus/v2/networks/{network_id} PPIO 算力 API v2 文档介绍如何删除指定网络资源,说明相关请求与结果处理方式,为开发者清理不再使用的网络配置提供参考。 # 更新 Network Source: https://ppio.com/docs/gpus/vpc/reference-v2-edit-vpc gpus/v2-spec/edit-vpc.json PUT /gpus/v2/networks/{network_id} PPIO 算力 API v2 文档介绍如何修改网络资源配置,说明相关请求与结果处理方式,为开发者维护实例连接所需的网络设置提供参考。 # 查询 Network 详情 Source: https://ppio.com/docs/gpus/vpc/reference-v2-get-vpc gpus/v2-spec/get-vpc.json GET /gpus/v2/networks/{network_id} PPIO 算力 API v2 文档介绍如何读取指定网络详情,说明相关请求与结果处理方式,为开发者核对网络资源信息提供参考。 # 查询 Network 列表 Source: https://ppio.com/docs/gpus/vpc/reference-v2-list-vpc gpus/v2-spec/list-vpc.json GET /gpus/v2/networks PPIO 算力 API v2 文档介绍如何查询网络资源列表,说明相关请求与结果处理方式,为开发者查看已有网络并组织实例连接提供参考。 # 查询 Region 列表 Source: https://ppio.com/docs/gpus/vpc/reference-v2-list-vpc-region gpus/v2-spec/list-vpc-region.json GET /gpus/v2/regions PPIO 算力 API v2 文档介绍如何查询网络相关 Region 列表,说明相关请求与结果处理方式,为开发者了解配置网络时涉及的区域信息提供参考。 # 创建 Endpoint Source: https://ppio.com/docs/gpus/endpoint/reference-create-endpoint POST https://api.ppio.com/gpu-instance/openapi/v1/endpoint/create PPIO 算力 API 文档介绍如何创建推理服务端点,说明相关请求与结果处理方式,为开发者准备可调用的模型运行入口提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **endpoint** `object` *required* Endpoint 配置信息。 **properties** **name** `string` Endpoint 名称。字符串,长度限制:0-220 字符。 **appName** `string` 应用名称(体现在 url 中)。应用名称是 Endpoint URL 的组成部分,支持自定义,默认为 Endpoint ID。 **workerConfig** `object` *required* Worker 配置。范围通过参数限制范围接口动态获取。 **properties** **minNum** `integer` *required* 最小 worker 数。 **maxNum** `integer` *required* 最大 worker 数。 **freeTimeout** `integer` *required* 空闲超时(秒)。 **maxConcurrent** `integer` *required* 最大并发数。 **gpuNum** `integer` *required* GPU 卡数 / Worker。每个 Worker 的 GPU 卡数。 **requestTimeout** `integer` *required* 请求超时(秒)。 **ports** `object[]` *required* HTTP 端口。仅支持一个。支持的端口号范围:1-65535,其中 2222、2223、2224 为内部端口,不可使用。 **properties** **port** `string` *required* HTTP 端口。 **policy** `object` *required* 弹性策略。范围通过参数限制范围接口动态获取。 **properties** **type** `string` *required* 弹性策略类型。可选值: * `queue`:队列延迟策略,表示根据队列中请求的等待时间调整 Worker 的数量。 * `concurrency`:队列请求策略,表示根据队列中的请求数,自动调整 Worker 的数量。 **value** `integer` *required* 根据 type 的取值,value 表示不同。 * type = queue 时,value 表示队列等待时间,单位为秒。 * type = concurrency 时,value 表示队列最大请求数。 **image** `object` *required* 镜像信息。 **properties** **image** `string` *required* 镜像地址。字符串,长度限制:0-511 字符。 **authId** `string` 私有镜像凭证 ID(公共镜像或者本平台用户镜像可以不用填)。字符串,长度限制:0-255 字符。 **command** `string` 容器启动命令。字符串,长度限制:0-2047 字符。 **products** `object[]` *required* 产品信息。 **properties** **id** `string` *required* 产品 ID。 **rootfsSize** `integer` *required* 系统盘大小(GB)。当前填固定值 100。 **volumeMounts** `object[]` *required* 存储信息(GB)。 **properties** **type** `string` *required* 存储类型。可选值: * `local`:本地存储。 * `network`:网络存储。 **size** `integer` 本地存储大小,当前填固定值 30,网络存储不需要填。 **id** `string` 网络存储 ID,本地存储不需要填。 **mountPath** `string` *required* 存储挂载路径。字符串,长度限制:0-255 字符。 **clusterID** `string` 集群信息,挂载云存储必填。且需要与云存储所在集群 ID 一致。字符串,长度限制:0-255 字符。 **envs** `object[]` 环境变量信息。 **properties** **key** `string` *required* 环境变量名称。 **value** `string` *required* 环境变量取值。 **healthy** `object` *required* 监控检查接口路径。 **properties** **path** `string` *required* 使用 HTTP 请求方式进行健康检查时,要检测的路径。 ## 响应参数 **id** `string` 创建的 Endpoint ID。 # 删除 Endpoint Source: https://ppio.com/docs/gpus/endpoint/reference-delete-endpoint POST https://api.ppio.com/gpu-instance/openapi/v1/endpoint/delete PPIO 算力 API 文档介绍如何删除不再使用的服务端点,说明相关请求与结果处理方式,为开发者清理端点资源并维护服务清单提供参考。 ## 接口说明 删除 Endpoint 后,与该 Endpoint 关联的工作进程将被自动删除,请谨慎操作。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **name** `string` *required* 要删除的 Endpoint ID。 # 查询 Endpoint 详情 Source: https://ppio.com/docs/gpus/endpoint/reference-get-endpoint GET https://api.ppio.com/gpu-instance/openapi/v1/endpoint PPIO 算力 API 文档介绍如何读取指定服务端点的信息,说明相关请求与结果处理方式,为开发者检查端点配置与资源详情提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 查询参数 **id** `string` *required* 需要查询的 Endpoint ID。 ## 响应参数 **endpoint** `object` *required* Endpoint 信息。 **properties** **id** `string` *required* Endpoint ID。 **name** `string` *required* Endpoint 名称。 **appName** `string` *required* 应用名称。 **state** `object` *required* Endpoint 状态。 **properties** **state** `string` *required* Endpoint 状态。取值为 serving 时,表示 Endpoint 可以正常服务。 **error** `string` Endpoint 处于异常状态时的错误码。 **message** `string` Endpoint 处于异常状态时的错误信息。 **url** `string` *required* Endpoint URL。通过该 URL 可以访问 您的 HTTP 服务。 **workerConfig** `object` *required* Endpoint 的 Worker 配置。 **properties** **minNum** `integer` *required* 最小 Worker 数。 **maxNum** `integer` *required* 最大 Worker 数。 **freeTimeout** `string` *required* 空闲超时。单位为秒。 **maxConcurrent** `string` *required* 最大并发数。 **gpuNum** `integer` *required* 每个 Worker 的 GPU 卡数。 **requestTimeout** `integer` *required* 请求超时(秒)。 **cudaVersion** `string` *required* CUDA 版本。 **policy** `object` *required* Endpoint 的弹性策略。 **properties** **type** `string` *required* 弹性策略类型。取值: * queue:队列延迟策略,表示根据队列中请求的等待时间调整 Worker 的数量。 * concurrency:队列请求策略,表示根据队列中的请求数,自动调整 Worker 的数量。 **value** `string` *required* 根据 type 的取值,value 表示不同。 * type = queue 时,value 表示队列等待时间,单位为秒。 * type = concurrency 时,value 表示队列最大请求数。 **image** `object` *required* Endpoint 的镜像配置。 **properties** **image** `string` *required* 镜像地址。 **authId** `string` *required* 镜像仓库凭证。 **command** `string` *required* 容器启动命令。 **rootfsSize** `integer` *required* 系统盘大小。 **volumeMounts** `object[]` *required* Endpoint 的存储配置。 **properties** **type** `string` *required* 存储类型。取值: * local:本地存储。 * network:云存储。 **id** `string` *required* 云存储 ID。 **size** `integer` *required* type = local 时返回,表示本地盘的大小。 **mountPath** `string` *required* 存储的挂载路径。 **envs** `object[]` *required* 环境变量。 **properties** **key** `string` *required* 环境变量名称。 **value** `string` *required* 环境变量取值。 **ports** `object[]` *required* HTTP 端口。 **properties** **port** `integer` *required* HTTP 端口。 **workers** `object[]` *required* Endpoint 的 Worker 信息。 **properties** **id** `string` *required* Worker ID。 **state** `object` *required* Worker 状态。 **properties** **state** `string` *required* Worker 状态。取值为 running 时,表示 Worker 可以正常服务。 **error** `string` Worker 处于异常状态时的错误码。 **message** `string` Worker 处于异常状态时的错误信息。 **log** `string` *required* Worker 的日志路径。 **metrics** `string` *required* Worker 的监控信息。 **healthy** `boolean` *required* Worker 是否健康。 **products** `object[]` *required* 产品信息。 **properties** **id** `string` *required* 产品 ID。 **healthy** `object` *required* Endpoint 的健康检查配置。 **properties** **path** `string` *required* 使用 HTTP 请求进行健康健康时,检测的路径。 **initialDelay** `integer` *required* 启动多久后开始健康检查。单位为秒。 **period** `integer` *required* 健康检查的执行周期。单位为秒。 **timeout** `integer` *required* 健康检查的超时时间。单位为秒。 **successThreshold** `integer` *required* 从上次检查失败后,重新认定为检查成功的次数。 **failureThreshold** `integer` *required* 从上次检查成功后,连续失败多少次认定为检查失败。 **clusterID** `string` *required* 云存储所在的集群 ID。使用云存储时返回。 **log** `string` *required* Endpoint 的日志路径。 # 查询 Endpoint 列表 Source: https://ppio.com/docs/gpus/endpoint/reference-list-endpoint GET https://api.ppio.com/gpu-instance/openapi/v1/endpoints PPIO 算力 API 文档介绍如何查询服务端点列表,说明相关请求与结果处理方式,为开发者查看已有端点并组织服务资源提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 查询参数 **pageSize** `integer` *required* 每页返回的最大条数。 **pageNum** `integer` *required* 当前页码。 ## 响应参数 **endpoints** `object[]` *required* Endpoint 信息。 **properties** **id** `string` *required* Endpoint ID。 **name** `string` *required* Endpoint 名称。 **appName** `string` *required* 应用名称。 **state** `object` *required* Endpoint 状态。 **properties** **state** `string` *required* Endpoint 状态。取值为 serving 时,表示 Endpoint 可以正常服务。 **error** `string` Endpoint 处于异常状态时的错误码。 **message** `string` Endpoint 处于异常状态时的错误信息。 **url** `string` *required* Endpoint URL。通过该 URL 可以访问 您的 HTTP 服务。 **workerConfig** `object` *required* Endpoint 的 Worker 配置。 **properties** **minNum** `integer` *required* 最小 Worker 数。 **maxNum** `integer` *required* 最大 Worker 数。 **freeTimeout** `string` *required* 空闲超时。单位为秒。 **maxConcurrent** `string` *required* 最大并发数。 **gpuNum** `integer` *required* 每个 Worker 的 GPU 卡数。 **requestTimeout** `integer` *required* 请求超时(秒)。 **cudaVersion** `string` *required* CUDA 版本。 **policy** `object` *required* Endpoint 的弹性策略。 **properties** **type** `string` *required* 弹性策略类型。取值: * queue:队列延迟策略,表示根据队列中请求的等待时间调整 Worker 的数量。 * concurrency:队列请求策略,表示根据队列中的请求数,自动调整 Worker 的数量。 **value** `string` *required* 根据 type 的取值,value 表示不同。 * type = queue 时,value 表示队列等待时间,单位为秒。 * type = concurrency 时,value 表示队列最大请求数。 **image** `object` *required* Endpoint 的镜像配置。 **properties** **image** `string` *required* 镜像地址。 **authId** `string` *required* 镜像仓库凭证。 **command** `string` *required* 容器启动命令。 **rootfsSize** `integer` *required* 系统盘大小。 **volumeMounts** `object[]` *required* Endpoint 的存储配置。 **properties** **type** `string` *required* 存储类型。取值: * local:本地存储。 * network:云存储。 **id** `string` *required* 云存储 ID。type = network 时返回。 **size** `integer` type = local 时返回,表示本地盘的大小。 **mountPath** `string` *required* 存储的挂载路径。 **envs** `object[]` *required* 环境变量。 **properties** **key** `string` *required* 环境变量名称。 **value** `string` *required* 环境变量取值。 **ports** `object[]` *required* HTTP 端口。 **properties** **port** `string` *required* HTTP 端口。 **workers** `object[]` *required* Endpoint 的 Worker 信息。 **properties** **id** `string` *required* Worker ID。 **state** `object` *required* Worker 状态。 **properties** **state** `string` *required* Worker 状态。取值为 running 时,表示 Worker 可以正常服务。 **error** `string` Worker 处于异常状态时的错误码。 **message** `string` Worker 处于异常状态时的错误信息。 **log** `string` *required* Worker 的日志路径。 **metrics** `string` *required* Worker 的监控信息。 **healthy** `boolean` *required* Worker 是否健康。 **products** `object[]` *required* 产品信息。 **properties** **id** `string` *required* 产品 ID。 **healthy** `object` *required* Endpoint 的健康检查配置。 **properties** **path** `string` *required* 使用 HTTP 请求进行健康健康时,检测的路径。 **initialDelay** `integer` *required* 启动多久后开始健康检查。单位为秒。 **period** `integer` *required* 健康检查的执行周期。单位为秒。 **timeout** `integer` *required* 健康检查的超时时间。单位为秒。 **successThreshold** `integer` *required* 从上次检查失败后,重新认定为检查成功的次数。 **failureThreshold** `integer` *required* 从上次检查成功后,连续失败多少次认定为检查失败。 **clusterID** `string` *required* 云存储所在的集群 ID。使用云存储时返回。 **log** `string` *required* Endpoint 的日志路径。 **total** `integer` *required* 查询结果的条数。 # 获取 Endpoint 参数限制范围 Source: https://ppio.com/docs/gpus/endpoint/reference-query-endpoint-limit GET https://api.ppio.com/gpu-instance/openapi/v1/endpoint/limit PPIO 算力 API 文档介绍如何查询端点参数的限制范围,说明相关请求与结果处理方式,为开发者在配置端点前核对可用参数边界提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 响应参数 **minRootfsSize** `integer` *required* 系统盘最小容量大小。单位为 GB。 **maxRootfsSize** `integer` *required* 系统盘最大容量大小。单位为 GB。 **freeRootfsSize** `integer` *required* 免费系统盘容量大小。单位为 GB。 **minLocalVolumeSize** `integer` *required* 本地存储卷最小容量大小。单位为 GB。 **maxLocalVolumeSize** `integer` *required* 本地存储卷最大容量大小。单位为 GB。 **freeLocalVolumeSize** `integer` *required* 免费本地存储卷容量大小。单位为 GB。 **minWorkerNum** `integer` *required* 最小工作节点数量。 **maxWorkerNum** `integer` *required* 最大工作节点数量。 **minFreeTimeout** `integer` *required* 最小空闲超时时间。单位为秒。 **maxFreeTimeout** `integer` *required* 最大空闲超时时间。单位为秒。 **minConcurrencyNum** `integer` *required* 最小并发数。 **maxConcurrencyNum** `integer` *required* 最大并发数。 **minQueueWaitTime** `integer` *required* 最小队列等待时间。单位为秒。 **maxQueueWaitTime** `integer` *required* 最大队列等待时间。单位为秒。 **minRequestNum** `integer` *required* 最小请求数量。 **maxRequestNum** `integer` *required* 最大请求数量。 **minGPUNum** `integer` *required* 最小 GPU 数量。 **maxGPUNum** `integer` *required* 最大 GPU 数量。 \*\*minRequestTimeout \*\* `integer` *required* 最小请求超时。 **maxRequestTimeout** `integer` *required* 最大请求超时。 **cudaVersionList** `string[]` *required* 支持的 CUDA 版本列表。 # 更新 Endpoint Source: https://ppio.com/docs/gpus/endpoint/reference-update-endpoint POST https://api.ppio.com/gpu-instance/openapi/v1/endpoint/update PPIO 算力 API 文档介绍如何更新服务端点配置,说明相关请求与结果处理方式,为开发者按任务需求维护已有推理端点提供参考。 ## 接口说明 更新 Endpoint 时,参数必须全量传递。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **id** `string` *required* 需要更新的 Endpoint ID。 **name** `string` Endpoint 名称。 **clusterID** `string` 集群信息,挂载云存储必填,且需要与云存储所在集群 ID 一致。字符串,长度限制:0-255 字符。 **workerConfig** `object` *required* Worker 配置。取值范围通过参数限制范围接口动态获取。 **properties** **minNum** `integer` *required* 最小 Worker 数。 **maxNum** `integer` *required* 最大 Worker 数。 **freeTimeout** `integer` *required* 空闲超时(秒)。 **maxConcurrent** `integer` *required* 最大并发数。 **gpuNum** `integer` *required* GPU 卡数 / Worker。每个 Worker 的 GPU 卡数。 **requestTimeout** `integer` *required* 请求超时(秒)。 **ports** `object[]` *required* HTTP 端口。仅支持一个。支持的端口号范围:1-65535,其中 2222、2223、2224 为内部端口,不可使用。 **properties** **port** `string` *required* HTTP 端口。 **policy** `object` *required* 弹性策略。取值范围通过参数限制范围接口动态获取。 **properties** **type** `string` *required* 弹性策略类型。可选值: * `queue`:队列延迟策略,表示根据队列中请求的等待时间调整 Worker 的数量。 * `concurrency`:队列请求策略,表示根据队列中的请求数,自动调整 Worker 的数量。 **value** `integer` *required* 根据 type 的取值,value 表示不同。 * type = queue 时,value 表示队列等待时间,单位为秒。 * type = concurrency 时,value 表示队列最大请求数。 **image** `object` *required* 镜像信息。 **properties** **image** `string` *required* 镜像地址。字符串,长度限制:0-511 字符。 **authId** `string` 私有镜像凭证 ID(公共镜像或者本平台用户镜像可以不用填)。字符串,长度限制:0-255 字符。 **command** `string` 容器启动命令。字符串,长度限制:0-2047 字符。 **volumeMounts** `object[]` 存储信息(GB)。 **properties** **type** `string` *required* 存储类型。可选值: * `local`:本地存储。 * `network`:网络存储。 **size** `integer` 本地存储大小,当前填固定值 30,网络存储不需要填。 **id** `string` 网络存储 ID,本地存储不需要填。 **mountPath** `string` *required* 存储挂载路径。字符串,长度限制:0-255 字符。 **envs** `object[]` 环境变量信息。 **properties** **key** `string` *required* 环境变量名称。 **value** `string` *required* 环境变量取值。 **healthy** `object` 监控检查接口路径。 **properties** **path** `string` *required* 健康检查的路径。 # 创建镜像预热任务 Source: https://ppio.com/docs/gpus/image/reference-create-image-prewarm POST https://api.ppio.com/gpu-instance/openapi/v1/image/prewarm PPIO 算力 API 文档介绍如何创建镜像预热任务,说明相关请求与结果处理方式,为开发者为运行环境部署准备镜像资源提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **imageUrl** `string` *required* 镜像地址。 **repositoryAuth** `string` 镜像认证 ID。 **clusterId** `string` *required* 集群 ID。 **productIds** `[string]` 产品 ID 列表。 **note** `string` 任务备注。 ## 示例 ```bash theme={null} curl --location --request POST 'https://api.ppio.com/gpu-instance/openapi/v1/image/prewarm' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{API_KEY}}' \ --data-raw '{ "imageUrl": "nginx:latest", "repositoryAuth": "", "clusterId": "dev-test", "productIds": [], "note": "test" }' ``` ## 响应参数 **id** `string` *required* 预热任务 ID。 ## 响应示例 ```json theme={null} { "id": "nzd5nyi4keefsv2d" } ``` # 删除镜像 Source: https://ppio.com/docs/gpus/image/reference-delete-image POST https://api.ppio.com/gpu-instance/openapi/v1/image/delete PPIO 算力 API 文档介绍如何删除指定镜像资源,说明相关请求与结果处理方式,为开发者维护镜像仓库并清理不再使用的环境提供参考。 ## 接口说明 删除镜像会删除该镜像下所有标签(tags),请谨慎操作。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **imageId** `string` *required* 镜像 ID。 ## 示例 ```bash theme={null} curl --location --request POST 'https://api.ppio.com/gpu-instance/openapi/v1/image/delete' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{API_KEY}}' \ --data-raw '{ "imageId": "216" }' ``` # 删除镜像预热任务 Source: https://ppio.com/docs/gpus/image/reference-delete-image-prewarm POST https://api.ppio.com/gpu-instance/openapi/v1/image/prewarm/delete PPIO 算力 API 文档介绍如何删除镜像预热任务,说明相关请求与结果处理方式,为开发者清理不再需要的预热安排提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **ids** `[string]` *required* 要删除的预热任务 ID 列表。 ## 示例 ```bash theme={null} curl --location --request POST 'https://api.ppio.com/gpu-instance/openapi/v1/image/prewarm/delete' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{API_KEY}}' \ --data-raw '{ "ids": ["nzd5nyi4keefsv2d"] }' ``` # 获取镜像预热配额信息 Source: https://ppio.com/docs/gpus/image/reference-get-image-quota GET https://api.ppio.com/gpu-instance/openapi/v1/image/prewarm/quota PPIO 算力 API 文档介绍如何查询镜像预热配额信息,说明相关请求与结果处理方式,为开发者在安排预热任务前了解资源边界提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 示例 ```bash theme={null} curl --location --request GET 'https://api.ppio.com/gpu-instance/openapi/v1/image/prewarm/quota' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{API_KEY}}' ``` ## 响应参数 **total** `integer` *required* 已创建的预热任务数。 **limit** `integer` *required* 最大可创建的预热任务数。 **perImageSize** `integer` *required* 单个镜像允许的最大大小(GB)。 ## 响应示例 ```json theme={null} { "total": 2, "limit": 5, "perImageSize": 100 } ``` # 获取镜像列表 Source: https://ppio.com/docs/gpus/image/reference-list-image GET https://api.ppio.com/gpu-instance/openapi/v1/images PPIO 算力 API 文档介绍如何查询镜像资源列表,说明相关请求与结果处理方式,为开发者查找已有镜像并选择部署环境提供参考。 ## 请求头 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 查询参数 **type** `string` *required* 镜像类型。可选值: * `base`:平台官方镜像 * `private`:私有仓库镜像 **name** `string` 镜像名称(模糊匹配)。 **pageSize** `integer` *required* 每页数量。取值范围:>= 1。 **pageNum** `integer` *required* 页码。取值范围:>= 1。 ## 示例 ```bash theme={null} curl --location --request GET 'https://api.ppio.com/gpu-instance/openapi/v1/images?name=&type=private&pageSize=10&pageNum=1' \ --header 'Authorization: Bearer {{API_KEY}}' ``` ## 响应参数 **data** `object[]` *required* 镜像列表。 **properties** **id** `string` *required* 镜像 ID。 **name** `string` *required* 镜像名称。 **url** `string` *required* 首个上传的镜像带标签的完整地址。 **tags** `object[]` 镜像标签信息。 **properties** **name** `string` *required* 标签名称。 **url** `string` *required* 该标签对应的完整镜像地址(含标签)。 **pageSize** `integer` *required* 每页数量。 **pageNum** `integer` *required* 当前页码。 **total** `integer` *required* 镜像总数。 ## 响应示例 ```json theme={null} { "data": [ { "id": "42", "name": "nwe", "url": "test-image.ppinfra.com/dev-pukcnedkqkioyhnxrawo/image_ubuntu_test_keli_1202:v1", "tags": [ { "name": "v1", "url": "test-image.ppinfra.com/dev-pukcnedkqkioyhnxrawo/image_ubuntu_test_keli_1202:v1" }, { "name": "v3", "url": "test-image.ppinfra.com/dev-pukcnedkqkioyhnxrawo/image_ubuntu_test_keli_1202:v3" } ], "metadata": [], "port": [] } ], "pageSize": 10, "pageNum": 1, "total": 14 } ``` # 获取镜像预热任务列表 Source: https://ppio.com/docs/gpus/image/reference-list-image-prewarm GET https://api.ppio.com/gpu-instance/openapi/v1/image/prewarm PPIO 算力 API 文档介绍如何查询镜像预热任务列表,说明相关请求与结果处理方式,为开发者查看预热安排并维护部署准备流程提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 查询参数 **page** `integer` 页码,默认 1。 **pageSize** `integer` 每页数量,默认 10。 **state** `string` 预热任务状态。可选值: * `Pending`:待处理 * `Running`:进行中 * `Succeeded`:成功 * `Failed`:失败 **clusterId** `string` 集群 ID。 **name** `string` 镜像名或任务备注。 ## 示例 ```bash theme={null} curl --location --request GET 'https://api.ppio.com/gpu-instance/openapi/v1/image/prewarm' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{API_KEY}}' ``` ## 响应参数 **data** `object[]` *required* 任务列表。 **properties** **id** `string` *required* 任务 ID。 **imageName** `string` *required* 镜像名(取最后一段,去除 tag 部分)。 **imageUrl** `string` *required* 镜像地址。 **repositoryAuth** `string` 镜像认证 ID。 **clusterId** `string` *required* 集群 ID。 **clusterName** `string` *required* 集群名称。 **products** `object[]` 预热的产品卡信息。 **properties** **productId** `string` *required* 产品 ID。 **productName** `string` *required* 产品名称。 **imageSize** `string` *required* 镜像大小(字节)。 **createTime** `string` *required* 任务创建时间(Unix 时间戳秒)。 **state** `string` *required* 任务状态。可选值: * `Pending`:待处理 * `Running`:进行中 * `Succeeded`:成功 * `Failed`:失败 **completeTime** `string` 任务完成时间(Unix 时间戳秒)。 **note** `string` 任务备注。 **reason** `[string]` 任务原因或说明。 **total** `integer` *required* 任务总数。 ## 响应示例 ```json theme={null} { "data": [ { "id": "nzd5nyi4keefsv2d", "imageName": "nginx", "imageUrl": "nginx", "clusterId": "cn-dev-1", "clusterName": "v2测试(cn-dev-1)", "products": [], "imageSize": "72298048", "createTime": "1757656178", "state": "Succeeded", "completeTime": "1757656207", "note": "", "reason": [], "repositoryAuth": "" }, { "id": "fexahnwdp4l1ajva", "imageName": "pytorch", "imageUrl": "test-image.ppinfra.com/test-public/pytorch:v2", "clusterId": "cn-dev-1", "clusterName": "v2测试(cn-dev-1)", "products": [ { "productId": "4090.18c.60g.18c60g", "productName": "RTX 4090 24GB 18c" } ], "imageSize": "6762128493", "createTime": "1756361365", "state": "Succeeded", "completeTime": "1756361371", "note": "", "reason": [ "image pulled successfully" ], "repositoryAuth": "" } ], "total": 2 } ``` # 获取镜像认证信息列表 Source: https://ppio.com/docs/gpus/image/reference-list-repository-auths GET https://api.ppio.com/gpu-instance/openapi/v1/repository/auths PPIO 算力 API 文档介绍如何查询镜像仓库认证信息列表,说明相关请求与结果处理方式,为开发者核对镜像资源访问相关配置提供参考。 ## 请求头 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 响应参数 **data** `object[]` *required* 镜像仓库认证列表。 **properties** **id** `string` *required* 平台镜像认证 ID。 **name** `string` *required* 镜像认证展示名称。 **username** `string` *required* Docker 镜像认证用户名。 **password** `string` *required* Docker 镜像认证密码。 ## 示例 ### 请求示例 ```bash theme={null} curl --location --request GET 'https://api.ppio.com/gpu-instance/openapi/v1/repository/auths' \ --header 'Authorization: Bearer {{API 密钥}}' ``` ### 响应示例 ```json theme={null} { "data": [ { "id": "20", "name": "test", "username": "test", "password": "xxxxxxxx" } ] } ``` # 保存镜像 Source: https://ppio.com/docs/gpus/image/reference-save-image POST https://api.ppio.com/gpu-instance/openapi/v1/job/save/image PPIO 算力 API 文档介绍如何保存实例环境为镜像,说明相关请求与结果处理方式,为开发者为后续部署复用已配置的软件环境提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **instanceId** `string` *required* 实例 ID。长度范围:1-255。 **image** `string` *required* 镜像地址。长度范围:1-4095。 **registryAuthId** `string` *required* 镜像仓库认证 ID。长度范围:0-255。 **说明** * 镜像仓库认证信息可在「控制台 → 安全凭证管理 → 镜像仓库认证信息」中管理和查询。 * 上传到公共镜像仓库或平台提供的镜像仓库时无需填写。 * 上传到第三方私有镜像仓库时需填写。 ## 示例 ```bash theme={null} curl --location --request POST 'https://api.ppio.com/gpu-instance/openapi/v1/job/save/image' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{API_KEY}}' \ --data-raw '{ "instanceId": "079ac83991562f00", "image": "image.ppinfra.com/pukcnedkqkioyhnxrawo/20250909:v1", "registryAuthId": "8ba75437-0b83-4966-a775-0fb862081c4d" }' ``` ## 响应参数 **jobId** `string` *required* 异步任务 ID,可在控制台 → 任务管理中查询镜像保存任务状态与日志。 ## 响应示例 ```json theme={null} { "jobId": "0uplnmmbd1ggdaxu" } ``` # 编辑镜像预热任务 Source: https://ppio.com/docs/gpus/image/reference-update-image-prewarm POST https://api.ppio.com/gpu-instance/openapi/v1/image/prewarm/edit PPIO 算力 API 文档介绍如何编辑已有镜像预热任务,说明相关请求与结果处理方式,为开发者维护预热配置与部署准备流程提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **id** `string` *required* 预热任务 ID。 **note** `string` 预热任务备注。 ## 示例 ```bash theme={null} curl --location --request POST 'https://api.ppio.com/gpu-instance/openapi/v1/image/prewarm/edit' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{API_KEY}}' \ --data-raw '{ "id": "nzd5nyi4keefsv2d", "note": "" }' ``` # 删除模板 Source: https://ppio.com/docs/gpus/template/reference-delete-template POST https://api.ppio.com/gpu-instance/openapi/v1/template/delete PPIO 算力 API 文档介绍如何删除指定部署模板,说明相关请求与结果处理方式,为开发者清理不再使用的环境配置提供参考。 ## 请求头 **Content-Type** `string` *required* 枚举值:application/json。 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 请求体 **templateId** `string` *required* 模板 ID。长度:\[1-255]。 ## 响应参数 **templateId** `string` *required* 模板 ID。 ## 示例 ### 请求示例 ```bash theme={null} curl --location --request POST 'https://api.ppio.com/gpu-instance/openapi/v1/template/delete' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{API 密钥}}' \ --data-raw '{ "templateId": "101036" }' ``` ### 响应示例 ```json theme={null} { "templateId": "101036" } ``` # 获取模板详情 Source: https://ppio.com/docs/gpus/template/reference-get-template GET https://api.ppio.com/gpu-instance/openapi/v1/template PPIO 算力 API 文档介绍如何读取部署模板详情,说明相关请求与结果处理方式,为开发者核对镜像与运行环境配置提供参考。 ## 请求头 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 查询参数 **templateId** `string` *required* 模板 ID。 ## 响应参数 **template** `object` *required* 模板信息。 **properties** **Id** `string` *required* 模板唯一 ID。 **name** `string` *required* 模板名称。 **readme** `string` 模板说明。 **type** `string` *required* 模板类型,例如 `instance`。 **channel** `string` *required* 模板分类:`official`、`community`、`private`。 **image** `string` *required* 镜像地址。 **imageAuth** `string` 平台镜像认证 ID。 **startCommand** `string` 实例启动命令。 **entrypoint** `string` 实例启动 entrypoint。 **rootfsSize** `integer` *required* 系统盘大小(GB)。 **ports** `object[]` 端口配置列表。 **envs** `object[]` 环境变量配置列表。 **tools** `object[]` 模板内置工具列表(仅官方模板有)。 **createdAt** `string` *required* 模板创建时间戳(Unix 秒)。 **recommendCards** `object[]` 模板推荐的 GPU 卡规格信息(仅官方模板有)。 **minCudaVersion** `string` 模板要求的最低 CUDA 版本。 ## 示例 ### 请求示例 ```bash theme={null} curl --location --request GET 'https://api.ppio.com/gpu-instance/openapi/v1/template?templateId=101038' \ --header 'Authorization: Bearer {{API 密钥}}' ``` ### 响应示例 ```json theme={null} { "template": { "Id": "1", "name": "Pytorch:v2", "readme": "...", "type": "instance", "channel": "official", "image": "test-image.ppinfra.com/test-public/pytorch:v2", "imageAuth": "", "startCommand": "", "entrypoint": "", "rootfsSize": 100, "ports": [ {"type": "http", "ports": [80]}, {"type": "tcp", "ports": [7860]} ], "envs": [{"key": "test", "value": "template"}], "tools": [{"name": "Jupyter", "describe": "Start Jupyter Notebook", "port": 8888, "type": "http"}], "createdAt": "1715760544", "recommendCards": [{"gpuSpecId": "4090.18c.60g", "cardNum": "2"}], "minCudaVersion": "11.8" } } ``` # 获取模板列表 Source: https://ppio.com/docs/gpus/template/reference-list-templates GET https://api.ppio.com/gpu-instance/openapi/v1/templates PPIO 算力 API 文档介绍如何查询部署模板列表,说明相关请求与结果处理方式,为开发者浏览已有模板并选择任务环境提供参考。 ## 请求头 **Authorization** `string` *required* Bearer 身份验证格式,例如:Bearer \{\{API 密钥}}。 ## 查询参数 **pageSize** `integer` 获取 x 条/页。整数,取值范围:大于等于 0。 **pageNum** `integer` 获取第 x 页。整数,取值范围:大于等于 0。 **name** `string` 筛选指定模板名称(支持模糊匹配)。长度:\[1-255]。 **channel** `string` *required* 筛选模板分类。可选值: * `official`:官方模板 * `community`:社区模板 * `private`:私有模板 **isMyCommunity** `boolean` *required* 模板可见性。查询官方、社区模板传 false;查询私有模板传 true。 ## 响应参数 **template** `object[]` *required* 模板信息列表。 **properties** **Id** `string` *required* 模板唯一 ID。 **name** `string` *required* 模板名称。 **readme** `string` 模板说明。 **type** `string` *required* 模板类型,例如 `instance`。 **channel** `string` *required* 模板分类:`official`、`community`、`private`。 **image** `string` *required* 镜像地址。 **imageAuth** `string` 平台镜像认证 ID。 **startCommand** `string` 实例启动命令。 **entrypoint** `string` 实例启动 entrypoint。 **rootfsSize** `integer` *required* 系统盘大小(GB)。 **ports** `object[]` 端口配置列表。 **envs** `object[]` 环境变量配置列表。 **tools** `object[]` 模板内置工具列表(仅官方模板有)。 **createdAt** `string` *required* 模板创建时间戳(Unix 秒)。 **recommendCards** `object[]` 模板推荐的 GPU 卡规格信息(仅官方模板有)。 **minCudaVersion** `string` 模板要求的最低 CUDA 版本。 **total** `integer` *required* 查询到的模板总数量。 ## 示例 ### 请求示例 ```bash theme={null} curl --location --request GET 'https://api.ppio.com/gpu-instance/openapi/v1/templates?pageSize=10&pageNum=1&name=test&channel=private&isMyCommunity=true' \ --header 'Authorization: Bearer {{API 密钥}}' ``` ### 响应示例 ```json theme={null} { "template": [ { "Id": "1", "name": "Pytorch:v2", "readme": "...", "type": "instance", "channel": "official", "image": "test-image.ppinfra.com/test-public/pytorch:v2", "imageAuth": "", "startCommand": "", "entrypoint": "", "rootfsSize": 100, "ports": [ {"type": "http", "ports": [80]}, {"type": "tcp", "ports": [7860]} ], "envs": [{"key": "test", "value": "template"}], "tools": [{"name": "Jupyter", "describe": "Start Jupyter Notebook", "port": 8888, "type": "http"}], "createdAt": "1715760544", "recommendCards": [{"gpuSpecId": "4090.18c.60g", "cardNum": "2"}], "minCudaVersion": "11.8" } ], "total": 12 } ``` # API 密钥 Source: https://ppio.com/docs/sandbox/api-key 了解 PPIO Agent 沙箱所需 API 密钥的配置与使用方式,为通过 SDK 或其他工具访问沙箱服务准备认证信息。 在执行 SDK 代码之前请配置好`PPIO_API_KEY`环境变量,或者在代码中显式指定 API Key。 你可以在 PPIO [API 密钥管理页面](https://ppio.com/settings/key-management)创建一个 API key,并妥善保存以备后用。 > [!NOTE] > > **安全提醒** > 请妥善保管您的 API Key,不要在代码中硬编码或提交到版本控制系统。建议使用环境变量或密钥管理服务。 ## 方式一:使用环境变量(推荐) 推荐通过环境变量配置 API Key,SDK 会自动读取 `PPIO_API_KEY` 环境变量。这种方式可以避免在代码中暴露敏感信息,适合在生产环境中使用。 **设置环境变量** ```python Python theme={null} from ppio_sandbox import PPIO # SDK 会自动从环境变量 PPIO_API_KEY 读取 ppio = PPIO() sandbox = ppio.sandbox.create() ``` ```javascript JavaScript & TypeScript theme={null} import { PPIO } from 'ppio-sandbox' const ppio = new PPIO() // SDK 会自动从环境变量 PPIO_API_KEY 读取 const sandbox = await ppio.sandbox.create(); ``` ```bash CLI theme={null} export PPIO_API_KEY=sk_your_api_key_here ``` ## 方式二:在代码中显式指定 也可以在创建 Sandbox 时直接传入 API Key。这种方式适合在开发测试环境中使用,但**不推荐在生产环境中使用**,因为会在代码中暴露敏感信息。 ```python Python theme={null} from ppio_sandbox import PPIO # 显式传入 API Key(不推荐用于生产环境) ppio = PPIO(api_key="sk_your_api_key_here") sandbox = ppio.sandbox.create() print(f"Sandbox ID: {sandbox.sandbox_id}") print(f"状态: {sandbox.get_info().state}") ``` ```javascript JavaScript & TypeScript theme={null} import { PPIO } from 'ppio-sandbox' // 显式传入 API Key(不推荐用于生产环境) const ppio = new PPIO({ apiKey: 'sk_your_api_key_here' }) const sandbox = await ppio.sandbox.create(); console.log(`Sandbox ID: ${sandbox.sandboxId}`); console.log(`状态: ${(await sandbox.getInfo()).state}`); ``` # 生命周期管理 Source: https://ppio.com/docs/sandbox/archive/sandbox 查阅 PPIO Agent 沙箱生命周期的归档说明,了解该版本的资源创建与状态管理,为维护既有运行环境提供参考。 每个沙箱都有一个 **timeout**(“超时时间”)配置,当沙箱的运行时间超过该配置值时,沙箱将自动关闭并释放。 您可以参考如下方式在启动的时候显式指定 timeout 的配置值,如果未指定,则默认值为 5 分钟。当前允许设置的**最大值**为 1 小时。 ```js JavaScript & TypeScript icon="js" highlight={5} theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' // 创建一个沙箱,并保持运行 60 秒。 const sandbox = await Sandbox.create({ timeoutMs: 60_000, // 单位为毫秒。 }) await sandbox.kill() ``` ```python Python icon="python" highlight={5} theme={null} from ppio_sandbox.code_interpreter import Sandbox # 创建一个沙箱,并保持运行 60 秒。 sandbox = Sandbox.create( timeout=60, # 单位为秒。 ) sandbox.kill() ``` ## 更新沙箱超时时间 您可以参考如下示例来在沙箱运行过程中更新其 timeout 配置值,更新后,沙箱的 timeout 将重置为最新值(从更新生效后的时间点开始计时)。 > [!WARNING] > > 请注意,当前沙箱的最大存活时间为 **1 小时**,不能通过本方法让沙箱运行更长的时间。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' // 创建一个沙箱,并保持运行 60 秒。 const sandbox = await Sandbox.create({ timeoutMs: 60_000 }) // 更改沙箱超时时间为 30 秒(从方法执行后开始计时)。 await sandbox.setTimeout(30_000) await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox # 创建一个沙箱,并保持运行 60 秒。 sandbox = Sandbox.create(timeout=60) # 更改沙箱超时时间为 30 秒(从方法执行后开始计时)。 sandbox.set_timeout(30) sandbox.kill() ``` ## 获取沙箱信息 您可以通过如下方法来获取沙箱信息,包括沙箱 ID、沙箱模板 ID、沙箱元数据信息、开始时间和结束时间等。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' // 创建一个沙箱,并保持运行 60 秒。 const sandbox = await Sandbox.create({ timeoutMs: 60_000 }) // 获取沙箱信息。 const info = await sandbox.getInfo() console.log(info) // 输出结果示例: // { // sandboxId: 'iadj11lnd93v43ourpi0c', // templateId: 'br263f8awvhrqd7ss1ze', // name: 'code-interpreter-v1', // metadata: { // platform_metadata_member: '416092acae23419bbae0df344fd5fxxx', // platform_metadata_owner: '0712072841552xxx', // platform_metadata_team: 'team_xxx' // }, // envdVersion: '0.2.0', // startedAt: 2025-09-01T06:07:24.202Z, // endAt: 2025-09-01T06:08:24.202Z, // state: 'running', // cpuCount: 2, // memoryMB: 1024 // } await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox # 创建一个沙箱,并保持运行 60 秒。 sandbox = Sandbox.create(timeout=60) # 获取沙箱信息。 info = sandbox.get_info() print(info) sandbox.kill() ``` ## 关闭沙箱 您可以通过调用 `kill` 方法在沙箱自动超时前的任意时刻关闭沙箱实例。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' // 创建一个沙箱,并保持运行 60 秒。 const sandbox = await Sandbox.create({ timeoutMs: 60_000 }) // 立即关闭沙箱。 await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox # 创建一个沙箱,并保持运行 60 秒。 sandbox = Sandbox.create(timeout=60) # 立即关闭沙箱。 sandbox.kill() ``` # 环境变量 Source: https://ppio.com/docs/sandbox/archive/sandbox-environment-variables 了解 PPIO Agent 沙箱环境变量的归档配置方式,查阅该版本向运行环境传递配置的说明,为维护既有应用提供参考。 本节介绍如何在沙箱中设置和使用环境变量。 ## 设置环境变量 您可以通过如下 3 种方式来设置环境变量: * [创建沙箱时设置全局环境变量](#1-创建沙箱时设置全局环境变量) * [在沙箱中运行代码时设置环境变量](#2-运行代码时设置环境变量) * [在沙箱中运行命令时设置环境变量](#3-运行命令时设置环境变量) ### 1. 创建沙箱时设置全局环境变量 您可以在创建沙箱时设置全局环境变量。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' const sandbox = await Sandbox.create({ envs: { MY_VAR: 'my_value', }, }) // 命令跑在沙箱的 Shell 环境里 const result = await sandbox.commands.run("echo $MY_VAR") console.log(result) // 输出示例: // { exitCode: 0, error: undefined, stdout: 'my_value\n', stderr: '' } await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox sandbox = Sandbox.create( envs={ 'MY_VAR': 'my_value', }, ) # 命令跑在沙箱的 Shell 环境里 result = sandbox.commands.run("echo $MY_VAR") print(result) # 输出示例: # { exitCode: 0, error: undefined, stdout: '123\n', stderr: '' } sandbox.kill() ``` ### 2. 运行代码时设置环境变量 您可以为沙箱中特定的代码运行片段设置环境变量。 > [!NOTE] > > 如果您设置了同名的全局环境变量,全局环境变量值将被覆盖。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' const sandbox = await Sandbox.create() // 代码跑在沙箱实例里的 Jupyter Notebook 环境里 const result = await sandbox.runCode('import os; print(os.environ.get("MY_VAR"))', { envs: { MY_VAR: 'my_value', }, }) console.log(result.logs) await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox sandbox = Sandbox.create() # 代码跑在沙箱实例里的 Jupyter Notebook 环境里 result = sandbox.run_code( 'import os; print(os.environ.get("MY_VAR"))', envs={ 'MY_VAR': 'my_value' } ) print(result) sandbox.kill() ``` ### 3. 运行命令时设置环境变量 您可以为沙箱中特定的命令执行片段设置环境变量。 > [!NOTE] > > 如果您设置了同名的全局环境变量,全局环境变量值将被覆盖。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' const sandbox = await Sandbox.create() const result = await sandbox.commands.run('echo $MY_VAR', { envs: { MY_VAR: '123', }, }) console.log(result) // 输出示例: // { exitCode: 0, error: undefined, stdout: '123\n', stderr: '' } await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox sandbox = Sandbox.create() result = sandbox.commands.run( 'echo $MY_VAR', envs={ 'MY_VAR': '123' } ) print(result) # 输出示例: # CommandResult(stderr='', stdout='123\n', exit_code=0, error='') sandbox.kill() ``` # 沙箱事件 Source: https://ppio.com/docs/sandbox/archive/sandbox-events 查阅 PPIO Agent 沙箱事件的归档文档,了解该版本事件信息的使用方式,为观察既有沙箱运行过程提供参考。 本节介绍如何查询沙箱生命周期中的关键事件,适用于问题排查、审计、用量分析和账单核对等场景。 ## 查询沙箱事件 通过 Events API 可以获取当前账号下的沙箱事件列表,并按沙箱、模板、事件类型、状态和时间范围等条件过滤结果。 ### 使用 SDK 查询事件 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' const result = await Sandbox.getEvents({ sandboxID: 'iq721h44siv24wmyrh5oc', events: ['create', 'pause', 'resume', 'connect', 'timeout', 'delete'], limit: 10, offset: 0, }) console.log('Events:', result.items) if (result.hasMore) { const nextPage = await Sandbox.getEvents({ sandboxID: 'iq721h44siv24wmyrh5oc', limit: 10, offset: 10, }) console.log('Next page:', nextPage.items) } ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox result = Sandbox.get_events( sandbox_id="iq721h44siv24wmyrh5oc", events=["create", "pause", "resume", "connect", "timeout", "delete"], limit=10, offset=0, ) print("Events:", result.items) if result.has_more: next_page = Sandbox.get_events( sandbox_id="iq721h44siv24wmyrh5oc", limit=10, offset=10, ) print("Next page:", next_page.items) ``` ### 查询单个沙箱实例的事件 如果您已经创建了一个沙箱,可以直接通过该沙箱对象查询它的事件记录。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' const sandbox = await Sandbox.create() const result = await sandbox.getEvents({ events: ['create', 'pause', 'resume', 'connect', 'timeout', 'delete'], limit: 10, }) console.log(result.items) ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox sandbox = Sandbox.create() result = sandbox.get_events( events=["create", "pause", "resume", "connect", "timeout", "delete"], limit=10, ) print(result.items) ``` ## 筛选事件 使用查询参数缩小事件时间线范围。 | 参数 | 类型 | 是否必填 | 默认值 / 限制 | 说明 | | - | - | - | - | - | | `startTime` | `int64` | 否 | 默认为 `endTime - 30 days` | 查询开始时间,秒级 Unix 时间戳。查询范围包含该时间点。 | | `endTime` | `int64` | 否 | 默认为当前时间 | 查询结束时间,秒级 Unix 时间戳。必须大于 `startTime`。 | | `sandboxID` | `string` | 否 | - | 按沙箱 ID 筛选。支持模糊匹配。 | | `templateID` | `string` | 否 | - | 按模板 ID 筛选。支持模糊匹配。 | | `events` | `string` | 否 | 默认为关键事件集合 | 逗号分隔的事件类型。当前关键事件集合包括 `create`、`pause`、`resume`、`connect`、`timeout` 和 `delete`。 | | `state` | `string` | 否 | - | 按事件状态筛选,例如 `success` 或失败状态。 | | `orderAsc` | `bool` | 否 | `false` | 是否按 `recordAt` 升序排序。默认按降序返回事件。 | | `offset` | `int32` | 否 | 默认 `0`,最小值 `0` | 跳过的事件数量。 | | `limit` | `int32` | 否 | 默认 `10`,最小值 `1`,最大值 `100` | 本次最多返回的事件数量。 | > [!NOTE] > > 时间字段使用秒级 Unix 时间戳,请勿传入毫秒级时间戳。 > > 单次查询最大时间范围为 60 天。如需查询更长时间线,请拆分为多个较小时间范围。 ## 分页 Events API 使用基于 `offset` 的分页方式。首次请求从 `offset: 0` 开始;如果 `hasMore` 为 `true`,下一页使用 `offset + limit` 继续请求。`limit` 最大值为 100。 ## 响应字段 事件响应包含 `items` 数组和分页元数据。 | 字段 | 说明 | | - | - | | `items` | 符合查询条件的沙箱事件列表。 | | `total` | 分页前符合查询条件的事件总数。 | | `hasMore` | 当前页之后是否还有更多事件。 | `items` 中每个事件对象包含以下字段。 | 字段 | 说明 | | - | - | | `eventID` | 唯一事件 ID。 | | `recordAt` | 事件记录时间,秒级 Unix 时间戳。 | | `templateID` | 沙箱使用的模板 ID。 | | `templateName` | 沙箱使用的模板名称。 | | `sandboxID` | 沙箱 ID。 | | `eventName` | 事件类型,例如 `create`、`pause`、`resume`、`connect`、`timeout` 或 `delete`。 | | `state` | 事件状态。 | | `errorMsg` | 事件失败或发生异常时的错误信息。无错误时通常为空。 | | `statusCode` | 与操作相关的 HTTP 状态码,如可用。 | ## 响应示例 ```json theme={null} { "items": [ { "eventID": "evt_123", "recordAt": 1766650000, "templateID": "tmpl_abc", "templateName": "ubuntu-base", "sandboxID": "i3vrzzatkxojecvfuesnz", "eventName": "create", "state": "success", "errorMsg": "", "statusCode": 200 } ], "total": 1, "hasMore": false } ``` # 沙箱列表 Source: https://ppio.com/docs/sandbox/archive/sandbox-list 了解 PPIO Agent 沙箱列表功能的归档使用方法,查阅该版本通过程序查看沙箱资源的流程,为维护现有资源管理集成提供参考。 本节介绍如何通过各种方式查看您创建过的沙箱信息。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' // 创建一个沙箱,并设置元数据。 const sandbox = await Sandbox.create({ metadata: { name: 'My Sandbox', }, }) // 列出所有正在运行的沙箱。 const runningSandboxesPaginator = await Sandbox.list({ query: { state: ["running"], }, }) const runningSandboxes = await runningSandboxesPaginator.nextItems() const runningSandbox = runningSandboxes[0] console.log('Running sandbox metadata:', runningSandbox.metadata) console.log('Running sandbox id:', runningSandbox.sandboxId) console.log('Running sandbox started at:', runningSandbox.startedAt) console.log('Running sandbox template id:', runningSandbox.templateId) // 输出示例: // Running sandbox metadata: { name: 'My Sandbox' } // Running sandbox id: ili9gpg1fr0z407y1pyk8-1e67fa95 // Running sandbox started at: 2025-06-22T14:52:41.922Z // Running sandbox template id: uhop43uji8fr7qkfbmsp await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox, SandboxQuery, SandboxState # 创建一个沙箱,并设置元数据。 sandbox = Sandbox.create( metadata= { 'name': 'My Sandbox', }, ) # 列出所有正在运行的沙箱。 running_sandboxes_paginator = Sandbox.list( query=SandboxQuery( state=[SandboxState.RUNNING], ), ) running_sandboxes = running_sandboxes_paginator.next_items() running_sandbox = running_sandboxes[0] print('Running sandbox metadata:', running_sandbox.metadata) print('Running sandbox id:', running_sandbox.sandbox_id) print('Running sandbox started at:', running_sandbox.started_at) print('Running sandbox template id:', running_sandbox.template_id) # 输出结果: # Running sandbox metadata: { name: 'My Sandbox' } # Running sandbox id: i30sjldvvjx446kbkoofj-abf219fd # Running sandbox started at: 2025-06-22T15:09:28.822Z # Running sandbox template id: uhop43uji8fr7qkfbmsp sandbox.kill() ``` > [!NOTE] > > 当您拿到了正在运行的沙箱 ID 后,您可以 [连接到该沙箱](/docs/sandbox/archive/sandbox-connect)。 ### 根据元数据过滤沙箱 您可以通过指定 [元数据](/docs/sandbox/archive/sandbox-metadata) 键值对来过滤沙箱。指定多个键值对将返回匹配所有条件的沙箱列表。如果您创建了大量沙箱,通过这种方式能帮助高效查找到特定沙箱。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' // 创建一个沙箱,并设置元数据。 const sandbox = await Sandbox.create({ metadata: { env: 'dev', app: 'my-app', userId: '123', }, }) // 列出所有正在运行的沙箱,其中 `userId` 键的值为 `123` 且 `env` 键的值为 `dev`。 const runningSandboxesPaginator = await Sandbox.list({ query: { metadata: { userId: '123', env: 'dev' }, }, }) const runningSandboxes = await runningSandboxesPaginator.nextItems() for (const runningSandbox of runningSandboxes) { console.log(`list running sandbox (${runningSandbox.sandboxId}) metadata:`, runningSandbox.metadata) } await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox, SandboxQuery # 创建一个沙箱,并设置元数据。 sandbox = Sandbox.create( metadata={ "env": "dev", "app": "my-app", "user_id": "123", }, ) # 列出所有正在运行的沙箱,其中 `user_id` 键的值为 `123` 且 `env` 键的值为 `dev`。 paginator = Sandbox.list( query=SandboxQuery( metadata={ "user_id": "123", "env": "dev", } ), ) sandbox.kill() ``` ### 列出所有沙箱 现已支持分页获取沙箱列表,详情参考 [高级分页](#高级分页) 部分。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox, SandboxInfo } from 'ppio-sandbox/code-interpreter' const sandbox = await Sandbox.create() // 列出所有沙箱(包括正在运行的和暂停的) const paginator = Sandbox.list() const firstPage = await paginator.nextItems() if (paginator.hasNext) { const nextPage = await paginator.nextItems() } await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox sandbox = Sandbox.create() # 列出所有沙箱(包括正在运行的和暂停的) paginator = Sandbox.list() firstPage = paginator.next_items() if paginator.has_next: nextPage = paginator.next_items() sandbox.kill() ``` ### 按条件过滤沙箱 下面展示如何基于沙箱状态来过滤。状态参数可以是 `running`(正在运行的沙箱)、`paused`(已暂停的沙箱)或同时包含两者。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' const sandbox = await Sandbox.create() // 列出所有正在运行的或暂停的沙箱。 const paginator = Sandbox.list({ query: { state: ['running', 'paused'], }, }) const sandboxes = await paginator.nextItems() await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox, SandboxQuery, SandboxState sandbox = Sandbox.create() # 列出所有正在运行的或暂停的沙箱。 paginator = Sandbox.list( query=SandboxQuery( state=[SandboxState.RUNNING, SandboxState.PAUSED], ), ) # 获取第一页的沙箱(正在运行的和暂停的) sandboxes = paginator.next_items() sandbox.kill() ``` 下面展示如何基于沙箱的元数据键值对来做过滤。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' const sandbox = await Sandbox.create({ metadata: { env: 'dev', app: 'my-app', userId: '123', }, }) // 列出所有正在运行的沙箱,其中元数据中的 `userId` 值为 `123` 且 `env` 值为 `dev`。 const paginator = Sandbox.list({ query: { metadata: { userId: '123', env: 'dev' }, }, }) const sandboxes = await paginator.nextItems() await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox, SandboxQuery sandbox = Sandbox.create( metadata={ "env": "dev", "app": "my-app", "user_id": "123", }, ) # 列出所有正在运行的沙箱,其中元数据中的 `user_id` 值为 `123` 且 `env` 值为 `dev`。 paginator = Sandbox.list( query=SandboxQuery( metadata={ "user_id": "123", "env": "dev", } ), ) sandboxes = paginator.next_items() sandbox.kill() ``` ### 高级分页 您可以设置每页返回的沙箱数量(默认值和最大值都是 **1000**),通过指定偏移参数(`nextToken` 或 `next_token`)来分页获取沙箱列表。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' const sandbox = await Sandbox.create() const paginator = Sandbox.list({ limit: 1000, // nextToken: '', }) // 获取下一页的沙箱 await paginator.nextItems() // 是否有下一页 console.log("paginator.hasNext: ", paginator.hasNext) // 下一页的偏移参数 console.log("paginator.nextToken: ", paginator.nextToken) await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox sandbox = Sandbox.create() paginator = Sandbox.list( limit=1000, # next_token='', ) # 获取下一页的沙箱 paginator.next_items() # 是否有下一页 print("paginator.has_next: ", paginator.has_next) # 下一页的偏移参数 print("paginator.next_token: ", paginator.next_token) sandbox.kill() ``` 您可以通过循环遍历分页器来获取所有沙箱信息。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox, SandboxInfo} from 'ppio-sandbox/code-interpreter' const sandbox = await Sandbox.create() const paginator = Sandbox.list() // 循环遍历所有页面 const sandboxes: SandboxInfo[] = [] while (paginator.hasNext) { const items = await paginator.nextItems() sandboxes.push(...items) } for (const sandbox of sandboxes) { console.log(`list sandbox (${sandbox.sandboxId})`) } await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox, SandboxInfo sandbox = Sandbox.create() paginator = Sandbox.list() # 循环遍历所有页面 sandboxes: list[SandboxInfo] = [] while paginator.has_next: items = paginator.next_items() sandboxes.extend(items) sandbox.kill() ``` # 元数据 Source: https://ppio.com/docs/sandbox/archive/sandbox-metadata 了解 PPIO Agent 沙箱元数据的归档使用方式,查阅该版本标记与管理沙箱信息的方法,为维护既有资源组织方式提供参考。 沙箱**元数据**为附加在沙箱实例上的任意键值对信息。 适用于以下场景: * 将沙箱与用户会话关联。 * 为沙箱存储自定义用户数据,如 API 密钥。 * 将沙箱与用户 ID 关联并稍后需要重新 [连进沙箱](/docs/sandbox/archive/sandbox-connect)。 当您在创建沙箱时指定了元数据,可以通过如下方法列出正在运行的沙箱列表,并访问其元数据信息。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' // 创建沙箱并指定元数据。 const sandbox = await Sandbox.create({ metadata: { userId: '123', }, }) // 列出正在运行的沙箱并访问元数据。 const runningSandboxesPaginator = await Sandbox.list({ query: { state: ["running"], }, }) const runningSandboxes = await runningSandboxesPaginator.nextItems() console.log("runningSandboxes[0].metadata: ", runningSandboxes[0].metadata) // 输出示例: // { userId: '123' } await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox, SandboxQuery, SandboxState # 创建沙箱并指定元数据。 sandbox = Sandbox.create( metadata={ 'user_id': '123', }, ) # 列出正在运行的沙箱并访问元数据。 running_sandboxes_paginator = Sandbox.list( query=SandboxQuery( state=[SandboxState.RUNNING], ), ) running_sandboxes = running_sandboxes_paginator.next_items() print(running_sandboxes[0].metadata) # 输出示例: # { userId: '123' } sandbox.kill() ``` ## 按元数据过滤沙箱列表 您也可以基于元数据里的键值对来过滤沙箱列表,详情参考 [获取沙箱列表](/docs/sandbox/archive/sandbox-list#根据元数据过滤沙箱)。 # 监控指标 Source: https://ppio.com/docs/sandbox/archive/sandbox-metrics 查阅 PPIO Agent 沙箱监控指标的归档说明,了解该版本运行数据的使用方式,为观察既有任务与资源情况提供参考。 沙箱 “监控指标” 功能可以允许您获取有关沙箱 **vCPU 和内存使用情况** 的信息。 ## 获取监控指标信息 指标信息以一个包含时间戳的数组形式提供(参考下方示例),包含 vCPU 和内存使用信息。指标在沙箱启动时开始采集,之后每 2 秒采集一次,在沙箱被删除前会采集最后一次。 > [!NOTE] > > 在沙箱创建后,可能需要等待几秒后才能获取到指标信息,在这之前,将会得到一个空数组。 ### 使用 SDK 获取指标信息 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' const sandbox = await Sandbox.create() console.log('Sandbox created', sandbox.sandboxId) let metrics = await sandbox.getMetrics() // 您也可以通过指定沙箱 ID 来获取指标信息 // const metrics = await Sandbox.getMetrics(sandboxId) while (metrics && metrics.length <= 1) { console.log('Waiting for metrics...') await new Promise(resolve => setTimeout(resolve, 1000)) metrics = await sandbox.getMetrics() } console.log('Sandbox metrics:', metrics) await sandbox.kill() // 输出示例: // Sandbox metrics: [ // { // cpuCount: 2, // cpuUsedPct: 15.92, // memTotalMiB: 987, // memUsedMiB: 245, // timestamp: '2025-06-22T06:54:28.234Z' // }, // { // cpuCount: 2, // cpuUsedPct: 0.8, // memTotalMiB: 987, // memUsedMiB: 246, // timestamp: '2025-06-22T06:54:33.232Z' // } // ] ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox import time sandbox = Sandbox.create() print('Sandbox created', sandbox.sandbox_id) metrics = sandbox.get_metrics() # 您也可以通过指定沙箱 ID 来获取指标信息 # metrics = Sandbox.get_metrics(sbx.sandbox_id) while len(metrics) <= 1: print('Waiting for metrics...') time.sleep(1) metrics = sandbox.get_metrics() print('Sandbox metrics', metrics) # 输出示例: # Sandbox metrics [SandboxMetrics(timestamp=datetime.datetime(2025, 6, 22, 6, 59, 28, 595373, tzinfo=tzutc()), cpu_used_pct=15.94, cpu_count=2, mem_used_mib=245, mem_total_mib=987), SandboxMetrics(timestamp=datetime.datetime(2025, 6, 22, 6, 59, 33, 591684, tzinfo=tzutc()), cpu_used_pct=1.1, cpu_count=2, mem_used_mib=246, mem_total_mib=987)] sandbox.kill() ``` ### 使用 CLI 获取指标信息 ```bash Bash icon="terminal" theme={null} ppio-sandbox-cli sandbox metrics ``` # 暂停和恢复 Source: https://ppio.com/docs/sandbox/archive/sandbox-persistence 了解 PPIO Agent 沙箱暂停和恢复的归档操作流程,查阅该版本保留与恢复运行状态的方式,为维护现有任务提供参考。 您现在可以**暂停**沙箱并且在后续需要时**恢复**该沙箱,恢复后,沙箱的文件系统和内存状态,包括正在运行的进程、已加载的变量、数据等都将被恢复。在沙箱暂停期间,我们不会对沙箱的运行时间计费。 > [!WARNING] > > 请注意: > > * 暂停沙箱所需的时间和沙箱的 RAM(内存)大小有关,每 1 GB RAM 需要约 4 秒; > * 恢复沙箱需要约 1 秒; > * 暂停状态的沙箱数据将永久保留,直到您主动调用 `kill` 方法销毁沙箱。 ## 暂停沙箱 当您暂停沙箱时,沙箱的[文件系统](/docs/sandbox/archive/filesystem)和内存状态都将被保存。包括沙箱文件系统中的所有文件以及所有正在运行的进程、已加载的变量、数据等。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' // or import { Sandbox } from 'ppio-sandbox' // or import { Sandbox } from 'ppio-sandbox/desktop' const sandbox = await Sandbox.create() console.log('Sandbox created', sandbox.sandboxId) // 暂停沙箱 // 建议您将沙箱 ID 保存到数据库中,以便稍后恢复沙箱。 const result = await sandbox.betaPause() console.log('Sandbox paused', sandbox.sandboxId, result) await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox # or from ppio_sandbox.core import Sandbox # or from ppio_sandbox.desktop import Sandbox sandbox = Sandbox.create() print('Sandbox created', sandbox.sandbox_id) # 暂停沙箱 # 建议您将沙箱 ID 保存到数据库中,以便稍后恢复沙箱。 sandbox.beta_pause() print('Sandbox paused', sandbox.sandbox_id) sandbox.kill() ``` > [!WARNING] > > **注意:暂停后的短暂过渡期** > > 暂停(pause)是一个异步操作,调用 `beta_pause()` 后沙箱会在后台完成暂停过程。 > > 在暂停过程尚未完成的这段时间内: > > * **查询类操作**(如 `get_info`、`list`):正常返回,状态显示为 `paused` > * **执行类操作**(如 `commands.run`、访问沙箱公共 URL):将返回错误,属于预期行为,建议等待暂停完成后重试(耗时与内存大小相关,参考上方说明) > * **恢复操作**(`connect`):会自动等待暂停完成后再恢复沙箱,无需手动轮询或重试 ## 恢复沙箱 当您恢复沙箱时,沙箱在暂停前文件系统中的所有文件、所有正在运行的进程、已加载的变量、数据等将被恢复。 > [!TIP] > > 如果在调用 `beta_pause()` 之后立即调用 `connect()` 恢复沙箱,`connect()` 会自动等待暂停过程完成后再执行恢复。无需手动轮询沙箱状态,整个过程对调用方是透明的。 > [!WARNING] > > 如果尝试恢复(resume)一个已销毁或不存在的 Sandbox: > > * JavaScript SDK 会抛出 `NotFoundError` > * Python SDK 会抛出 `NotFoundException` ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' // or import { Sandbox } from 'ppio-sandbox' // or import { Sandbox } from 'ppio-sandbox/desktop' const sandbox = await Sandbox.create() console.log('Sandbox created', sandbox.sandboxId) // 暂停沙箱 // 建议您将沙箱 ID 保存到数据库中,以便稍后恢复沙箱。 const result = await sandbox.betaPause() console.log('Sandbox paused', sandbox.sandboxId, result) // 恢复沙箱 // 即使在暂停完成前调用 connect(),也会自动等待暂停结束后再恢复。 const resumedSandbox = await sandbox.connect() console.log('Sandbox resumed', resumedSandbox.sandboxId) await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox # or from ppio_sandbox.core import Sandbox # or from ppio_sandbox.desktop import Sandbox sandbox = Sandbox.create() print('Sandbox created', sandbox.sandbox_id) # 暂停沙箱 # 建议您将沙箱 ID 保存到数据库中,以便稍后恢复沙箱。 sandbox.beta_pause() print('Sandbox paused', sandbox.sandbox_id) # 恢复沙箱 # 即使在暂停完成前调用 connect(),也会自动等待暂停结束后再恢复。 connectedSandbox = sandbox.connect() print('Sandbox resumed', connectedSandbox.sandbox_id) sandbox.kill() ``` ## 恢复时指定超时时间 当您恢复沙箱时,沙箱的 timeout 会重置为默认的 5 分钟。您可以参考如下方法来自定义 timeout 值。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' // or import { Sandbox } from 'ppio-sandbox' // or import { Sandbox } from 'ppio-sandbox/desktop' const sandbox = await Sandbox.create() const connectedSandbox = await Sandbox.connect(sandbox.sandboxId, { timeoutMs: 60 * 1000 }) // 60 秒 console.log('Sandbox connected', connectedSandbox.sandboxId) await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox # or from ppio_sandbox.core import Sandbox # or from ppio_sandbox.desktop import Sandbox sandbox = Sandbox.create() connectedSandbox = Sandbox.connect(sandbox.sandbox_id, timeout=60) # 60 秒 print('Sandbox connected', connectedSandbox.sandbox_id) sandbox.kill() ``` ## 列出暂停的沙箱 您可以参考如下方式列出所有被暂停的沙箱。详情请参考 [沙箱列表](/docs/sandbox/archive/sandbox-list)。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox, SandboxInfo } from 'ppio-sandbox/code-interpreter' // or import { Sandbox, SandboxInfo } from 'ppio-sandbox' // or import { Sandbox, SandboxInfo } from 'ppio-sandbox/desktop' const sandbox = await Sandbox.create() // 过滤出所有被暂停的沙箱 const paginator = Sandbox.list({ query: { state: ['paused'] } }) // 分页获取所有被暂停的沙箱 const sandboxes: SandboxInfo[] = [] while (paginator.hasNext) { const items = await paginator.nextItems() sandboxes.push(...items) } console.log('all paused sandboxes', sandboxes) await sandbox.kill() ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox, SandboxInfo, SandboxQuery, SandboxState # or from ppio_sandbox.core import Sandbox, SandboxInfo, SandboxQuery # or from ppio_sandbox.desktop import Sandbox, SandboxInfo, SandboxQuery sandbox = Sandbox.create() sandbox.beta_pause() print('Sandbox paused', sandbox.sandbox_id) # 过滤出所有被暂停的沙箱 paginator = Sandbox.list(query=SandboxQuery(state=[SandboxState.PAUSED])) # 分页获取所有被暂停的沙箱 sandboxes: list[SandboxInfo] = [] while paginator.has_next: items = paginator.next_items() sandboxes.extend(items) print('all paused sandboxes', sandboxes) sandbox.kill() ``` ## 删除暂停的沙箱 您可以通过在沙箱实例上调用 `kill` 方法来删除暂停的沙箱。 ```js JavaScript & TypeScript icon="js" theme={null} import { Sandbox } from 'ppio-sandbox/code-interpreter' // or import { Sandbox } from 'ppio-sandbox' // or import { Sandbox } from 'ppio-sandbox/desktop' const sandbox = await Sandbox.create() console.log('Sandbox created', sandbox.sandboxId) // 暂停沙箱 await sandbox.betaPause() // 删除被暂停的沙箱 await sandbox.kill() // 或者通过指定沙箱 ID 来删除被暂停的沙箱 // await Sandbox.kill(sandboxId) ``` ```python Python icon="python" theme={null} from ppio_sandbox.code_interpreter import Sandbox # or from ppio_sandbox.core import Sandbox # or from ppio_sandbox.desktop import Sandbox sandbox = Sandbox.create() # 暂停沙箱 sandbox.beta_pause() # 删除被暂停的沙箱 sandbox.kill() # 或者通过指定沙箱 ID 来删除被暂停的沙箱 # Sandbox.kill(sandbox_id) ``` ## 网络连接 当您在沙箱内运行了服务并且暂停沙箱后,该服务将无法再从外部访问,所有客户端都将断开连接。在您恢复沙箱后,该服务可被再次访问,但您需要重新连接客户端。 # 认证 Source: https://ppio.com/docs/sandbox/cli-auth 查阅 PPIO Agent 沙箱 CLI 的认证指南,了解命令行访问沙箱服务所需的配置,为管理云端任务与资源准备身份认证。 在使用 PPIO Sandbox CLI 之前,你需要先完成认证。`ppio auth` 命令组用于管理你的登录会话、当前团队和本地凭证。凭证存储在本地的 `~/.ppio/config.json` 文件中。 ## 登录 使用 `auth login` 登录你的 PPIO 账号。CLI 会打开基于浏览器的授权页面;授权通过后,CLI 会获取你的访问令牌,选择你的默认团队,并将凭证写入 `~/.ppio/config.json`。 ```bash theme={null} ppio auth login ``` 登录成功后,你会看到已登录的邮箱和所选团队: ```plaintext theme={null} Logged in as you@example.com with selected team my-team ``` 如果你已处于登录状态,该命令会显示当前会话信息,而不会重新登录。若要以其他用户身份登录,请先运行 `auth logout`;若要切换团队,请运行 `auth configure`。 ## 登出 使用 `auth logout` 退出登录。该操作会删除本地凭证文件 `~/.ppio/config.json`。 ```bash theme={null} ppio auth logout ``` 如果存在会话,CLI 会输出 `Logged out.`;如果未登录,则输出 `Not logged in, nothing to do`。 ## 查看信息 使用 `auth info` 查看当前用户的信息,包括已登录的邮箱和所选团队。 ```bash theme={null} ppio auth info ``` 示例输出: ```plaintext theme={null} You are logged in as you@example.com, Selected team: my-team (team-id) ``` 如果未找到凭证,则输出 `Not logged in`。 ## 配置 使用 `auth configure` 为现有会话切换当前团队。CLI 会获取你所属的团队列表并提示你选择;所选团队的名称、ID 和 API key 会保存回 `~/.ppio/config.json`。 ```bash theme={null} ppio auth configure ``` 你必须先登录。如果未找到用户配置,CLI 会要求你先运行 `ppio auth login`,再进行团队配置。选择完成后,CLI 会确认所选团队: ```plaintext theme={null} Team my-team (team-id) selected. ``` # 执行命令 Source: https://ppio.com/docs/sandbox/cli-exec 了解 PPIO Agent 沙箱 CLI 的命令执行方式,查阅如何从命令行发起沙箱任务,为运行脚本和管理云端环境提供参考。 `sandbox exec` 命令在已经运行的沙箱内执行单个命令,并将其输出流式传输回您的终端。用于一次性命令、脚本和自动化;如需交互式 shell 会话,请改用远程 shell(`connect`)命令。 ## 前置条件 在运行命令之前设置 `PPIO_API_KEY` 环境变量。您还需要运行中沙箱的 ID。 ## 用法 ```bash theme={null} ppio sandbox exec ``` 该命令有别名 `ex`。沙箱 ID 之后的所有内容都被视为要执行的命令。 ```bash theme={null} # 运行一个简单的命令 ppio sandbox exec sbx-123 ls -l /tmp # 使用别名 ppio sandbox exec sbx-123 python3 --version ``` ## 参数 | 参数 | 说明 | | - | - | | `` | 要在其中执行命令的运行中沙箱的 ID。 | | `` | 要执行的命令。多个部分会被引用并合并为单个 shell 命令。 | ## 选项 | 选项 | 说明 | | - | - | | `-b, --background` | 在后台运行命令并立即返回。会打印进程 ID (PID),CLI 以代码 `0` 退出。 | | `-c, --cwd ` | 运行命令的工作目录。 | | `-u, --user ` | 以指定用户身份运行命令。 | | `-e, --env ` | 为命令设置环境变量。可重复使用以设置多个变量。 | ## 前台执行 默认情况下,命令在前台运行。它的 `stdout` 和 `stderr` 会实时流式传输到您的终端,CLI 以与远程命令相同的退出代码退出。 ```bash theme={null} # 在特定目录、以特定用户身份、使用环境变量运行 ppio sandbox exec sbx-123 \\ --cwd /home/user/app \\ --user root \\ --env LOG_LEVEL=debug \\ --env REGION=cn-shanghai-1 \\ ./run.sh ``` ## 后台执行 传递 `-b` / `--background` 可以启动命令并立即返回,而无需等待它完成。CLI 会打印进程 ID 并以代码 `0` 退出。 ```bash theme={null} ppio sandbox exec sbx-123 --background \\ "python3 -m http.server 3000" ``` ## 管道标准输入 您可以通过标准输入将数据通过管道传输到命令;CLI 会将其流式传输到远程进程,并在输入耗尽时发出文件结束信号,因此像 `cat`、`wc` 和 `grep` 这样的工具可以正确终止。 ```bash theme={null} # 将本地数据通过管道传输到在沙箱中运行的命令 cat local-file.txt | ppio sandbox exec sbx-123 "wc -l" # 将文件重定向到命令 ppio sandbox exec sbx-123 "grep error" < app.log ``` > [!NOTE] > > 管道标准输入需要较新的沙箱版本。如果沙箱不支持它,CLI 会打印警告并忽略管道输入 —— 重新构建您的模板以获取最新的沙箱版本。 ## 退出代码和中断 * 在前台,CLI 以远程命令的退出代码退出,因此它可以自然地与 shell 脚本和 CI 组合。 * 如果命令无法启动或发生其他错误,CLI 会打印错误并以代码 `1` 退出。 * 按 `Ctrl+C`(或发送终止信号)会在 CLI 退出之前杀死远程进程。 # 网络规则配置 Source: https://ppio.com/docs/sandbox/cli-network 查阅 PPIO Agent 沙箱 CLI 的网络规则配置说明,了解如何管理网络访问相关设置,为控制沙箱任务的连接范围提供参考。 CLI 的 `network` 命令更新运行中沙箱的**出站(outbound)规则**,让您可以控制沙箱允许或拒绝访问哪些外部目标。规则通过沙箱 ID 应用到沙箱,并在运行中的沙箱上生效。 > [!NOTE] > > **注意:** 如果未指定 `allowOut`,则允许所有出站流量。省略 `--allow-out` 和 `--deny-out` 会清除所有出站规则。 > `allow-out` 和 `deny-out` 仅支持 CIDR 的配置方式,不支持域名。 *** ## 前置条件 在运行命令之前设置环境变量中的 API 密钥: ```bash theme={null} export PPIO_API_KEY= ``` *** ## 用法 ```bash theme={null} ppio sandbox network [--allow-out ] [--deny-out ] ``` | 选项 / 参数 | 值 | 说明 | | - | - | - | | `` | string | 要更新的运行中沙箱的 ID(必填) | | `--allow-out` | destination | 允许的出站目标。可重复 —— 多次传递以允许多个目标 | | `--deny-out` | destination | 拒绝的出站目标。可重复 —— 多次传递以拒绝多个目标 | `destination` 是 IP 地址或 CIDR 范围,例如 `1.1.1.1` 或 `8.8.8.0/24`。 *** ## 示例 ```bash theme={null} # 仅允许出站到这两个目标 ppio sandbox network \ --allow-out 1.1.1.1 \ --allow-out 8.8.8.0/24 ``` ```bash theme={null} ppio sandbox network \ --deny-out 1.1.1.1 \ --deny-out 8.8.8.0/24 ``` ```bash theme={null} # 省略两个选项以删除所有出站规则 ppio sandbox network ``` 成功时 CLI 打印: ```text theme={null} Sandbox network has been updated ``` > [!WARNING] > > **注意:** 如果沙箱 ID 不存在,命令会报告 `Sandbox wasn't found` 并以非零状态退出。 # Remote Shell Source: https://ppio.com/docs/sandbox/cli-remote-shell 了解 PPIO Agent 沙箱 Remote Shell 的使用方式,查阅远程终端连接流程,为进入云端运行环境和交互式操作提供参考。 CLI 的 `connect` 命令可将一个交互式终端——即 **Remote Shell**——连接到已在运行的 Sandbox。它通过 PTY 在 Sandbox 内打开一个真实的 shell,将你的按键输入流式传入,并把 shell 的输出实时传回,让你可以像坐在 Sandbox 终端前一样运行命令、查看状态和进行调试。 > [!NOTE] > > **注意:** Sandbox 必须已处于运行状态。`connect` 通过 ID 连接到已有的 Sandbox,不会创建新的 Sandbox。断开连接不会影响该 Sandbox 以及其他用户的会话。 *** ## 前提条件 连接前,先在环境变量中设置你的 API key: ```bash theme={null} export PPIO_API_KEY= ``` *** ## 用法 ```bash theme={null} ppio sandbox connect # 使用简写别名(sandbox → sbx,connect → cn) ppio sbx cn ``` | 项目 | 值 | 说明 | | - | - | - | | 命令 | `sandbox connect` | 将终端连接到已在运行的 Sandbox | | 别名 | `sbx cn` | `sandbox connect` 的简写形式 | | 参数 | `` | 要连接的运行中 Sandbox 的 ID(必填) | 连接时,CLI 会打印该 Sandbox 在控制台中的 inspect URL 和一行确认信息,然后将你的终端交给 Sandbox 的 shell: ```text theme={null} Terminal connecting to sandbox user@sandbox:~$ ``` *** ## 结束会话 按平常的方式退出 shell 即可——输入 `exit` 或按 **Ctrl+C**。CLI 会清理终端、关闭连接并打印: ```text theme={null} Closing terminal connection to sandbox ``` > [!NOTE] > > **注意:** 断开连接只会结束你自己的终端会话,不会停止或销毁 Sandbox,也不会断开连接到同一 Sandbox 的其他用户。 # 通过 CLI 构建 Source: https://ppio.com/docs/sandbox/cli-template-create 按照 PPIO Agent 沙箱 CLI 指南构建 Template,了解命令行模板创建流程,为准备可复用的执行环境提供参考。 `ppio template create` 将 Dockerfile 直接构建成可重用的沙箱模板。它读取 Dockerfile、构建镜像、应用沙箱设置(启动/就绪命令、CPU、内存),并以模板名称注册结果 —— 然后您可以将该名称传递给 `sandbox.create(...)`。 ```bash theme={null} ppio template create [options] # 别名 ppio ct [options] ``` ## 参数 | 参数 | 必填 | 说明 | | - | - | - | | `` | 是 | 要创建或重建的模板名称。必须是小写,并且只能包含字母、数字、短横线和下划线(`^[a-z0-9-_]+$`)。 | ## 选项 | 选项 | 默认值 | 说明 | | - | - | - | | `-p, --path ` | 当前目录 | 更改执行命令的根目录。Dockerfile 查找和构建文件上下文相对于它解析。 | | `-d, --dockerfile ` | `ppio.Dockerfile`,然后是 `Dockerfile` | Dockerfile 的路径,相对于根目录。如果没有此选项,CLI 首先查找 `ppio.Dockerfile`,然后回退到 `Dockerfile`。 | | `-c, --cmd ` | — | 沙箱启动时执行的命令。必须与 `--ready-cmd` 一起使用。 | | `--ready-cmd ` | — | 必须以退出代码 0 退出才能将模板视为就绪的命令。可以单独使用。 | | `--cpu-count ` | `2` | 用于运行沙箱的 CPU 数量。 | | `--memory-mb ` | `512` | 用于运行沙箱的内存(单位为兆字节)。必须是偶数。 | | `--no-cache` | 关闭 | 构建模板时跳过构建缓存。有关构建缓存的工作原理,请参阅[缓存](/docs/sandbox/template-cache)。 | | `--patch-cmd ` | — | 在配置阶段结束时修补不兼容的基础镜像的命令。 | ## 行为和验证 * 需要身份验证:使用 `ppio auth login` 登录或在环境中设置 `PPIO_API_KEY`。 * 提供 `--cmd` 而不提供 `--ready-cmd` 将失败并显示 `Both start and ready commands must be provided.`;单独使用 `--ready-cmd` 是允许的。 * 无效的模板名称或奇数的 `--memory-mb` 值会在向服务器发送任何内容之前中止构建。 * 构建日志流式传输到终端。成功后,CLI 打印 Python / JS 代码片段,显示如何从新模板创建沙箱。 ## 示例 ```bash theme={null} # 最简:读取当前目录中的 ./ppio.Dockerfile(或 ./Dockerfile) ppio template create my-python-template # 显式指定 Dockerfile ppio template create my-python-template --dockerfile ./Dockerfile # 完整:自定义根目录、资源、启动/就绪命令、无缓存 ppio template create my-python-template \ --path ./app \ --dockerfile ./docker/ppio.Dockerfile \ --cpu-count 4 \ --memory-mb 2048 \ --cmd "python app.py" \ --ready-cmd "curl -sf http://localhost:8080/health" \ --no-cache ``` 上述命令使用的示例 Dockerfile: ```docker theme={null} FROM python:3.12 WORKDIR /home/user/app RUN pip install --no-cache-dir flask requests COPY app.py . ENV PORT=8080 CMD ["python", "app.py"] ``` 构建完成后,按名称从模板创建沙箱: ```typescript theme={null} const sandbox = await ppio.sandbox.create('my-python-template') ``` # 发布与取消发布 Source: https://ppio.com/docs/sandbox/cli-template-publish 了解 PPIO Agent 沙箱 CLI 的模板发布与取消发布流程,查阅模板状态管理方式,为分发和维护执行环境提供参考。 CLI 的 `publish` 和 `unpublish` 命令用于控制 Sandbox Template 的可见性。**发布**(publish)会将 Template 公开给团队以外的所有人;**取消发布**(unpublish)则将其恢复为团队私有。二者底层都是通过设置 Template 的 `public` 标志实现的。 > [!WARNING] > > **注意:** 默认情况下,该命令在更改可见性前会要求确认,并警告发布会使 Template 对团队以外的所有人公开。传入 `-y` / `--yes` 可跳过该确认提示。 *** ## 前提条件 在环境变量中设置你的 API Key: ```bash theme={null} export PPIO_API_KEY= ``` *** ## 用法 ```bash theme={null} # 发布(别名:tpl pb) ppio template publish [template] # 取消发布(别名:tpl upb) ppio template unpublish [template] ``` `[template]` 参数是可选的。有三种方式可以选择要操作的 Template: | 选择方式 | 行为 | | - | - | | 传入 `[template]` | 对指定 Template ID 对应的 Template 执行操作 | | 省略 `[template]` | 使用根目录下 `ppio.toml` 中定义的 Template | | `-s` / `--select` | 从交互式列表中选择(仅显示符合该操作条件的 Template) | ### 选项 | 选项 | 说明 | | - | - | | `-p, --path ` | 更改命令运行的根目录 | | `--config ` | Sandbox 配置 toml 文件的路径(默认为 `./ppio.toml`) | | `-s, --select` | 从交互式列表中选择 Template | | `-t, --team ` | 操作关联的团队 ID(与 `--select` 配合使用) | | `-y, --yes` | 跳过手动确认提示 | *** ## 示例 ```bash theme={null} ppio template publish ``` ```bash theme={null} ppio template publish -y ``` ```bash theme={null} ppio template unpublish --select --team ``` 发布成功后,会打印该 Template 发布时使用的公开名称: ```text theme={null} - Publishing sandbox template