diff --git a/docs/Serverless API-integrated.md b/docs/Serverless API-integration.md similarity index 88% rename from docs/Serverless API-integrated.md rename to docs/Serverless API-integration.md index a473bdafd663c3988673cf96d54cad576b91afd6..68afaf82d7e012135de51a41a7e5d50df1401aa2 100644 --- a/docs/Serverless API-integrated.md +++ b/docs/Serverless API-integration.md @@ -1,7 +1,11 @@ # Serverless API 应用集成指南 + + [Serverless API](https://ai.gitee.com/serverless-api) 提供了五大类、数十个模型 API，只需调用 API 就可以将其强大的能力集成到您的应用中。本文为大家推荐了一些可集成 Serverless API 的应用，以及详细的集成配置指南。 + + 这些应用运行我们日常使用的平台上，如 Windows、mac 上的客户端、网页应用、浏览器插件，移动端 APP 等，通过使用这些应用，即可释放 Serverless API 的模型能力，从而提升您使用 AI 的便捷性。以下是应用的访问地址和简介： | 分类 | 应用名称 | 简介 | @@ -10,7 +14,7 @@ | | [OpenCat](https://opencat.app/zh-Hans/) | OpenCat 是一个 AI 对话聊天客户端，支持 ios 和 MacOS | | | [Dify](https://dify.ai/) | 一款开源的大语言模型(LLM) 应用开发平台。它融合了后端即服务和 [LLMOps](https://docs.dify.ai/v/zh-hans/learn-more/extended-reading/what-is-llmops) 的理念，使开发者可以快速搭建生产级的生成式 AI 应用 | | | [Nextchat](https://nextchat.dev/) | 只需轻点几下，就能在自己的服务器上搭建聊天服务 | -| | [Pal Chat ](https://apps.apple.com/us/app/pal-chat-ai-chat-client/id6447545085) | 一款可以在 iPhone 或 iPad 上使用的 AI 助手 | +| | [Pal Chat](https://apps.apple.com/us/app/pal-chat-ai-chat-client/id6447545085) | 一款可以在 iPhone 或 iPad 上使用的 AI 助手 | | | [Enconvo](https://www.enconvo.com/) | Enconvo是 AI 时代的启动器,是所有AI功能的入口,也是一位体贴的智能助理.】 | | | [Cherry Studio](https://www.cherrystudios.com/) | 一款为创造者而生的桌面版 AI 助手 | | 浏览器插件 | [沉浸式翻译](https://immersivetranslate.com/zh-Hans/) | 一款双语对照网页翻译插件，简洁，高效 | @@ -21,27 +25,37 @@ | | [QChatGPT](https://github.com/RockChinQ/QChatGPT) | 高稳定性、支持插件、实时联网的 LLM QQ / QQ频道 / One Bot 机器人 | | VScode 插件 | [Continue](https://github.com/continuedev/continue) | 开源 IDE 插件，使用 LLM 做你的编程助手 | + 以上应用均支持集成 Serverless API，配置操作也很简单，在选择 API 配置的时候，因为 Serverless API 与 OpenAI API 格式兼容，模型提供方只需要选择 OpenAl APl Compatible 。这个时候通常需要填写 API 调用地址、API key 等信息，下面是操作步骤： -## 操作步骤 + +## 操作步骤 + 1. **获取** **API** **路径：** 请在 Serverless API 页选择你想要使用的模型，点击调用，获取它的 API 调用地址，如下所示： _https://ai.gitee.com/api/inference/serverless/__resource__(示例)/chat/completions_ + + ![alt text](/img/serverless-api/integrated/integrate1.png) + 2. 通过上面获取的路径，通常需要将路径拆分，填写下方信息： - + - API Host (Domain)：_https://ai.gitee.com/_ - API Path：_api/inference/serverless/__resource__(示例)/chat/completions_ + + ![alt text](/img/serverless-api/integrated/integrate2.png) + + 3. 获取 API key： 前往 Gitee AI 工作台 - 设置 - 访问令牌，创建你的 API Key @@ -50,144 +64,145 @@ _https://ai.gitee.com/api/inference/serverless/__resource__(示例)/chat/complet + + ## 集成 OpenCat OpenCat 是一个 AI 对话聊天客户端，支持 ios 和 MacOS，在对话框内，可以快速的使用 prompt，展开新的对话，通过对接一些主流平台的 API ，可以选择与多种模型聊天。 + + ### 配置指南 + 1. 下载 [OpenCat](https://opencat.app/zh-Hans/) 2. 进入setting——Providers 3. 输入 API Domain、API Path、API Key - - API Domain：https://ai.gitee.com/ - - - API Path：不同模型的路径不同，示例：_api/inference/serverless/__resource__(示例)/chat/completions_ - - - API key： 在 Gitee AI 工作台-设置复制访问令牌（API key） - +- API Domain：https://ai.gitee.com/ +- API Path：不同模型的路径不同，示例：_api/inference/serverless/__resource__(示例)/chat/completions_ +- API key： 在 Gitee AI 工作台-设置复制访问令牌（API key） + 4. 点击验证，提示 Validate Success 即可 - ![alt text](/img/serverless-api/integrated/integrate4.png) + + ## 集成沉浸式翻译 + + [Immersive Translate](https://immersivetranslate.com/) 是一款浏览器插件，专注于提供高效的双语对照翻译服务。它支持网页、PDF、EPUB 等多种格式的翻译，能够实时翻译外语内容，并支持视频双语字幕翻译。插件提供了便捷的鼠标悬停翻译和输入框翻译功能，是提升信息获取效率的利器。 + + ### **配置指南** -1. 安装成功后，进入 Immersive Translate 插件 - “翻译服务”，滑到最底部添加自定义翻译服务。 - + + +1. 安装成功后，进入 Immersive Translate 插件 - “翻译服务”，滑到最底部添加自定义翻译服务。 -![alt text](/img/serverless-api/integrated/integrate5.png) +![alt text](/img/serverless-api/integrated/integrate5.png) 2. 在设置页面输入以下关键信息： - - - 自定义 API 接口地址： _此处填写 Serverless API 完整的调用地址_ - - APIKEY：在 Gitee AI 工作台-设置复制访问令牌（API key） - - 每秒最大请求数：1 - - 每次请求最大文本长度：1200 - - 每次请求最大段落数：8 - -3. 点击页面上方“点此测试服务”，显示“验证成功”即配置完成 - -![alt text](/img/serverless-api/integrated/integrate6.png) - +3. 点击页面上方“点此测试服务”，显示“验证成功”即配置完成 +![alt text](/img/serverless-api/integrated/integrate6.png) ## 集成 Dify + Dify 是一款开源的大语言模型(LLM) 应用开发平台。它融合了后端即服务（Backend as Service）和 [LLMOps](https://docs.dify.ai/v/zh-hans/learn-more/extended-reading/what-is-llmops) 的理念，使开发者可以快速搭建生产级的生成式 AI 应用。即使是非技术人员，也能参与到 AI 应用的定义和数据运营过程中。 ### 配置指南 + + Serverless API 支持在 Dify 中调用，使用步骤如下 1. [登录 dify](https://cloud.dify.ai/)，并按照下图操作，进入 API 配置页面 - ![alt text](/img/serverless-api/integrated/integrate7.png) - + 2. 填写 API 信息配置 - - - 模型名称：无格式要求 - - - API key：在 Gitee AI 工作台-设置复制访问令牌（API key） - - - API endpoint URL：在 Serverless API 调用窗口获取，此处无需粘贴 /chat/completions - - - Completion mode：选择对话类型 - - - 点击保存，保存会触发请求，保存成功即可使用 - - + +- 模型名称：无格式要求 +- API key：在 Gitee AI 工作台-设置复制访问令牌（API key） +- API endpoint URL：在 Serverless API 调用窗口获取，此处无需粘贴 /chat/completions +- Completion mode：选择对话类型 +- 点击保存，保存会触发请求，保存成功即可使用 + ![alt text](/img/serverless-api/integrated/integrate8.png) - + + ![alt text](/img/serverless-api/integrated/integrate9.png) + + ## 集成 Nextchat [Nextchat](https://nextchat.dev/) 是一款网页端的 AI 对话工具，支持自定义大模型。还支持在自己的服务器上搭建聊天服务。 + + ### 配置指南 -1. 点击设置，并滚动至自定义接口，选择 OpenAI - +1. 点击设置，并滚动至自定义接口，选择 OpenAI 2. Serverless API 链接，在调用窗口获取，填写完整 URL，示例：_https://ai.gitee.com/api/inference/serverless/ZBQ2F4KXXXX/chat/completions_ - + + ![alt text](/img/serverless-api/integrated/integrate10.png) - 3. 最后，创建新聊天，点击对话设置，选择刚刚配置的模型，就可以在对话框内调用模型了。 - + ![alt text](/img/serverless-api/integrated/integrate11.png) ![alt text](/img/serverless-api/integrated/integrate12.png) -## 集成 ChatGPTBox + +## 集成 ChatGPTBox + [ChatGPT Box](https://github.com/josStorer/chatGPTBox) 是一款浏览器插件，支持在浏览器内随时呼出 AI 对话框，并适用于手机端浏览器。支持自定义模型 API，它还提供框选内容执行任务、静态卡片浮出聊天框、代码高亮和复杂公式渲染、对话记录保存等功能。 + + ### 配置指南 下载 ChatGPTBox 并安装成功后，点击插件图标，按照以下要求操作: - - - 选择自定义模型 - - - 模型名称无严格要求 - - - API 地址：填写完整的 Serverless API 地址 - - - API key：在 Gitee AI 工作台-设置复制访问令牌（API key） - + +- 选择自定义模型 +- 模型名称无严格要求 +- API 地址：填写完整的 Serverless API 地址 +- API key：在 Gitee AI 工作台-设置复制访问令牌（API key） + ![alt text](/img/serverless-api/integrated/integrate13.png) - -更多应用，请查看文章顶部表格，如有疑问或建议，请随时[联系我们](https://ai.gitee.com/about)。 +更多应用，请查看文章顶部表格，如有疑问或建议，请随时[联系我们](https://ai.gitee.com/about)。 \ No newline at end of file diff --git a/docs/Serverless API-voice url.md b/docs/Serverless API-voice url.md index 41b132c4df09d71652caf4e1215ad827983c7100..605197f819d60fdfe50d40efee50002c2d7cf381 100644 --- a/docs/Serverless API-voice url.md +++ b/docs/Serverless API-voice url.md @@ -28,7 +28,7 @@ #### **1.1 制作音频文件** -使用录音软件录制普通话且吐字清晰的音频，时长建议保持在 5-15 秒，文件格式为 .mp3 或 .m4a ，建议文件不易过大。 +使用录音软件录制吐字清晰的音频，时长建议保持在 5-15 秒，文件格式为 .mp3 或 .m4a ，建议文件不易过大。 #### **1.2 生成 CosyVoice-300M 和 fish-speech-1.2-sft 模型的声纹文件** @@ -71,9 +71,10 @@ POST https://ai.gitee.com/api/inference/serverless/PH5EDMEALV1D/voice-feature-ex HTTP状态码为 200 时，表示成功。返回文件二进制流。 -**Curl示例** +**cURL 示例** -```curl +``` +cURL --location --request POST 'https://ai.gitee.com/api/inference/serverless/PH5EDMEALV1D/voice-feature-extraction' --header 'Authorization: Bearer 输入你的 Gitee AI 访问令牌 ' --form 'file=@"上传.mp3 或.m4a格式的文件"' diff --git a/sidebars.ts b/sidebars.ts index 79b14d2e92be5933c76059ef6d34f618c02d217a..3841de3326afa60a2c2a55f3e8e22cf02b61662a 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -181,10 +181,10 @@ const sidebars: SidebarsConfig = { type: 'doc', id: 'Serverless API-voice url', }, - + { type: 'doc', - id: 'Serverless API-integrated', + id: 'Serverless API-integration', }, ], },