From 6428f7cf4e0bfadad913364a40056ea13ffec7fa Mon Sep 17 00:00:00 2001 From: DCloud_Heavensoft Date: Wed, 19 Apr 2023 03:28:30 +0800 Subject: [PATCH] Update uni-ai.md --- docs/uniCloud/uni-ai.md | 169 +++++++++++++++++++++++++--------------- 1 file changed, 106 insertions(+), 63 deletions(-) diff --git a/docs/uniCloud/uni-ai.md b/docs/uniCloud/uni-ai.md index da4f4269b..f145f784d 100644 --- a/docs/uniCloud/uni-ai.md +++ b/docs/uniCloud/uni-ai.md @@ -9,16 +9,16 @@ ai大潮来袭，如何把ai能力引入自己的应用中？几乎是每个开 1. 聚合 `uni-ai`，聚合了国内外各种流行的ai能力。包括 -- 大语言模型LLM：chatGPT、GPT-4、百度文心一言以及一些优秀创业公司 -- 图形能力：stable diffusion、文心一格、midjourney等 +- 大语言模型LLM：chatGPT、GPT-4、百度文心一言、minimax等 +- 图形能力：stable diffusion、文心一格、midjourney等（暂未发布） `uni-ai`支持配置自己在AI厂商处申请的API Key和代理，也支持免配直接使用。 2. prompt辅助 -自然语言谁都会说，但想提出一个好prompt来指挥ai满足自己的需求并不简单。 +自然语言谁都会说，但想提出一个好prompt来指挥ai满足自己的需求并不简单。所以出现了prompt工程师的说法。 -`uni-ai`整合了大量prompt模板，并且提供了 `format prompt`和`prompt插件市场`。 +`uni-ai`整合了大量prompt模板，并将提供 `format prompt`和`prompt插件市场`。 举个例子，如果你需要写一个产品营销文案，你可以使用自然语言，如`请帮我编写一份产品营销文案，产品名称叫uni-app，它的特点是开发一次全端覆盖。` @@ -41,26 +41,25 @@ ai大潮来袭，如何把ai能力引入自己的应用中？几乎是每个开 如何把私有数据灌入ai中，几乎是每个企业都关心的事情。 -`uni-ai`提供了一整套方案解决这个问题，只需把私有数据按指定格式提交到你的uniCloud服务空间，就可以自动把这些最新的、私有的知识加入到ai的回答中。 +`uni-ai`将提供一整套方案解决这个问题，只需把私有数据按指定格式提交到你的uniCloud服务空间，就可以自动把这些最新的、私有的知识加入到ai的回答中。 -4. 开源项目 +4. 现成开源项目 ai能力非常常见的应用场景，有智能客服和自动生成文稿。 `uni-ai`把这些常见场景对应的应用均已做好，并且开源。开发者可以直接拿走使用。 - uni-cms，内置了智能内容生成。[详见](https://uniapp.dcloud.net.cn/uniCloud/uni-cms.html) -- uni-im，内置了智能客服[详见](https://ext.dcloud.net.cn/plugin?id=11771) - +- uni-im，内置了智能客服。[详见](https://ext.dcloud.net.cn/plugin?id=11771) 这些完善的项目，包括了前端页面（全端可用）、云对象、云数据库等全套代码，开箱即用。 ![](https://web-assets.dcloud.net.cn/unidoc/zh/202304112225875.png) 在线体验：[https://hellouniadmin.dcloud.net.cn/](https://hellouniadmin.dcloud.net.cn/)。 -这是一个集成了uni-cms的uni-admin系统，登录后，左侧内容管理中新建一篇文章，toolbar右上角有ai按钮。注意测试系统的数据会定时清除。 +这是一个集成了uni-cms的[uni-admin](admin.md)系统。登录后，左侧内容管理中新建一篇文章，toolbar右上角有ai按钮。注意测试系统的数据会定时清除。 -注意这个系统不等于uni-ai，uni-ai是底层的api。uni-cms或uni-im都是开源的应用。 +注意这个系统不等于uni-ai，uni-ai是底层的api。uni-cms是集成了uni-ai的开源应用。 5. 费用优化 @@ -70,7 +69,7 @@ ai能力调用，是需要按token数量付费的。token太少会回答不准 ai都是回答文字内容，但实际场景中经常需要自动化执行一些命令。 -`uni-ai`提供了action机制，让ai变的更加强大。 +`uni-ai`将提供action机制，让ai变的更加强大。 例如，请ai帮忙写一段代码，其中涉及了未引用的三方插件，那么action可以通知HBuilder弹出下载这个插件的界面，不但代码生成了，其中的插件也自动下载了。 @@ -79,9 +78,7 @@ ai都是回答文字内容，但实际场景中经常需要自动化执行一些 ```js // 因涉及费用，ai能力调用均需在服务器端进行，也就是uniCloud云函数或云对象中 -let llm = uniCloud.ai.getLLMManager({ - provider -}) +let llm = uniCloud.ai.getLLMManager() llm.chatCompletion({ messages: [{ role: 'user', @@ -95,19 +92,20 @@ llm.chatCompletion({ > 新增于HBuilderX 3.7.13+ :::warning 注意 -如需在本地云函数内使用uni-cloud-ai扩展库的最新能力需要更新HBuilderX到最新版。云端扩展库会一直保持最新。云端和本地扩展库差异参考：[云端和本地扩展库差异](rundebug.md#diff-extension) +使用低版本HBuilder，只能上传到uniCloud云端联调。因为低版本的uniCloud本地运行插件不支持`uni-ai`。云端和本地扩展库差异参考：[云端和本地扩展库差异](rundebug.md#diff-extension) ::: ai作为一种云能力，相关调用被整合到uniCloud中。 如您的服务器业务不在uniCloud上，可以把[云函数URL化](http.md)，把`uni-ai`当做http接口调用。 -在实际应用中，大多数场景是直接使用uni-im和uni-cms的ai功能，这些开源项目已经把完整逻辑都实现，无需自己研究API。 +在实际应用中，大多数场景是直接使用`uni-im`和`uni-cms`的ai功能，这些开源项目已经把完整逻辑都实现，无需自己研究API。 -ai能力由`uni-cloud-ai`扩展库提供，在云函数或云对象中，对右键或在package.json中配置`uni-cloud-ai`扩展库。 -如何使用扩展库请参考：[使用扩展库](cf-functions.md#extension) +ai能力由`uni-cloud-ai`扩展库提供，在云函数或云对象中，对右键配置`uni-cloud-ai`扩展库。如何使用扩展库请参考：[使用扩展库](cf-functions.md#extension) -注意uni-ai是云函数扩展库，其api是`uniCloud.ai`，不是需要下载的三方插件。而uni-cms、uni-im等开源项目，是需要在插件市场下载的。 +如果HBuilderX版本低于3.7.13，在云函数的扩展库界面里找不到`uni-ai`。 + +注意`uni-ai`是云函数扩展库，其api是`uniCloud.ai`，不是需要下载的三方插件。而`uni-cms`、`uni-im`等开源项目，是需要在插件市场下载的。 ### 获取LLM服务商实例@get-llm-manager @@ -153,7 +151,9 @@ const openai = uniCloud.ai.getLLMManager({ ### 对话@chat-completion :::warning 注意 -对话接口响应一般比较慢，建议将云函数超时时间配置的长一些，比如30秒（客户端访问云函数最大超时时间：腾讯云为30秒，阿里云为40秒）。阿里云目前在云函数运行时间超出配置的超时时间时提示不准确，可能在云函数日志之内看到`unknown system error`字样，如果遇到此类错误请尝试将超时时间调整到40秒。如何配置云函数超时时间请参考：[云函数超时时间](cf-functions.md#timeout) +对话接口响应一般比较慢，建议将云函数超时时间配置的长一些，比如30秒（客户端访问云函数最大超时时间：腾讯云为30秒，阿里云为40秒）。如何配置云函数超时时间请参考：[云函数超时时间](cf-functions.md#timeout) + +阿里云目前在云函数运行时间超出配置的超时时间时提示不准确，可能在云函数日志之内看到`unknown system error`字样，如果遇到此类错误请尝试将超时时间调整到40秒。 ::: 用法：`llm.chatCompletion(Object ChatCompletionOptions)` @@ -168,14 +168,6 @@ const openai = uniCloud.ai.getLLMManager({ |temperature|number |否 |1 |较高的值将使输出更加随机，而较低的值将使输出更加集中和确定。建议temperature和top_p同时只调整其中一个 |百度文心一言不支持此参数 | |topP |number |否 |1 |采样方法，数值越小结果确定性越强；数值越大，结果越随机 |百度文心一言不支持此参数 | -**maxTokens参数说明** - -生成的token数量限制，即返回的文本对应的token数量不能超过此值。 - -另需注意此值和传入的messages对应的token数量相加不可大于4096。如果messages对应的token数为1024，当传递的maxTokens参数大于（4096-1024）时服务商接口会抛出错误。 - -未指定provider时默认最多生成128个token的结果，此默认值后续可能会调整。 - **messages参数说明** 需注意messages末尾有个`s`，它是数组，而不是简单的字符串。其中每项由消息内容content和角色role组成。 @@ -266,6 +258,13 @@ DCloud在[uni-im](https://uniapp.dcloud.net.cn/uniCloud/uni-im.html)和[uni-cms] |openai |chatCompletion |gpt-4、gpt-4-0314、gpt-4-32k、gpt-4-32k-0314、gpt-3.5-turbo（默认值）、gpt-3.5-turbo-0301 | |minimax|chatCompletion |abab4-chat、abab5-chat（默认值） | +**maxTokens参数说明** + +maxTokens指生成的token数量限制，即返回的文本对应的token数量不能超过此值。注意这个值不是总token。此参数名称后续可能改名。 + +注意此值和传入messages对应的token数量，两者相加不可大于4096。如果messages对应的token数为1024，当传递的maxTokens参数大于（4096-1024）时接口会抛出错误。 + +未指定provider时默认最多生成128个token的结果，也就是返回结果不会很长。如有需求请自行调整此值。目前128的默认值在后续版本会逐渐放宽。 **chatCompletion方法的返回值** @@ -284,7 +283,9 @@ DCloud在[uni-im](https://uniapp.dcloud.net.cn/uniCloud/uni-im.html)和[uni-cms] ||--totalTokens |number |是 |- |总token数量 | | -**示例** +### 示例 + +在你的云函数中加载`uni-cloud-ai`扩展库，写下如下代码，ctrl+r运行，即可调用ai返回结果。 ```js const llmManager = uniCloud.ai.getLLMManager() @@ -298,12 +299,13 @@ console.log(res); ``` +如果你之前未使用过uniCloud，后续有专门的[新手指南](#first)章节。 ### 错误码@err-code -在调用uni-cloud-ai提供的api时，如果出现错误，接口会将错误对象抛出。如需处理此类错误需对错误进行捕获 +在调用`uni-cloud-ai`提供的api时，如果出现错误，接口会将错误对象抛出。如需处理此类错误需对错误进行捕获 -**示例** +**捕获错误的代码示例** ```js try { @@ -329,15 +331,6 @@ try { |60002 |接口调用凭证、key等信息有误| |60003 |触发了服务商限流策略 | - -## 非uniCloud服务器调用 - -如果您需要在非uniCloud的传统服务器调用uni-ai，需要先在uniCloud上创建一个云函数或云对象，加载uni-cloud-ai扩展库，编写上述uni-ai的调用代码。 - -然后将云函数或云对象进行URL化，转成http接口，[详见](http.md) - -如果在您的传统服务器和uniCloud云函数之间需要建立安全通信机制，可使用s2s公共模块，[详见](uni-cloud-s2s.md) - ## 费用 - 如果您自己去ai厂商申请和缴费，比如openai，则缴费后在uni-ai中配置相关key即可使用。 @@ -352,59 +345,93 @@ uni-ai会持续快速迭代，未来会陆续提供： - 提供prompt辅助和插件市场 - 后置命令处理 -## 常用用途 +## 常见用途场景 + +现阶段的ai，被称之为AIGC，即生成式ai。我们需要了解它擅长和不擅长的地方，并管理预期。 + +ai是模糊的、概率的，不是精确的，不要问生成式ai数学题。 + +从本质来讲，生成式ai不是在回答问题，而是在通过前文预测下文。你的前文可以恰好是一个问题，也可以不是问题。 + +ai会推理出很多下文并打分，选择最高分的下文返回给你。但“不知道”这个下文的打分往往不如其他胡诌的下文得分高，所以你很少会遇到ai的下文是“不知道”。 + +ai会使用互联网上的数据进行学习训练，但训练语料不会包含最新的知识和互联网上未公开的知识。比如openai的训练数据是2021年9月以前的数据。 + +虽然原理是模糊的，但越好的ai，其理解和推理能力越优秀，可以猜的更逼近真实，甚至超过普通人的水平。 目前生成式ai的主要用途有： -- 文章生成、润色、续写：常见于生成文案、文书、宣传资料、营销邮件、笑话、诗词等。[uni-cms](https://uniapp.dcloud.net.cn/uniCloud/uni-cms.html)中，已经内置了这个功能 -- 闲聊：情感咨询、常识问答。[uni-im](https://ext.dcloud.net.cn/plugin?id=11771) +- 文章生成、润色、续写：常见于生成文案、文书、标语、名字、营销邮件、笑话、诗词等。[uni-cms](https://uniapp.dcloud.net.cn/uniCloud/uni-cms.html)中，已经内置了这个功能 +- 闲聊：情感咨询、常识问答。由于聊天本身有不少代码工作量，推荐使用现成开源的[uni-im](https://ext.dcloud.net.cn/plugin?id=11771) - 翻译：各国各民族语言翻译 - 代码注释补充和简单代码生成：需使用openai，其他provider在代码领域的能力暂时还不行 -如对生成内容有较高的准确性要求，一方面使用gpt-4等高级的模型；另一方面需要追加专业甚至私有的语料训练。目前gpt-4未开放微调，但uni-ai正在开发其他私有数据训练方案，后续会升级提供。 +**如对生成内容有较高的准确性要求，一方面使用gpt-4等高级的模型；另一方面需要追加专业甚至私有的语料训练。** + +目前gpt-4未开放微调，但uni-ai正在开发其他私有数据训练方案，后续会升级提供。 +gpt-4是目前准确性最高的ai，也是最贵的ai。开发者需根据需求场景选择，一般的文章生成和闲聊，可以不用gpt-4。 + +另外想得到良好的推理结果，优化prompt前文也非常重要。 ## 合规注意 -国内使用ai，需注意合规性。 +国内使用ai，需注意合规性。监管部门并不拒绝使用ai提升生产效率，但对于可能造成社会动员能力、价值观影响等政治问题、以及黄赌毒等违法问题非常敏感。 - ai生成的文章，如发布到互联网上，应当调用内容安全审查后再发布。比如[uni内容安全](https://ext.dcloud.net.cn/plugin?id=5460)。[uni-cms](https://uniapp.dcloud.net.cn/uniCloud/uni-cms.html)已经内置了uni内容安全，只需在配置里开启即可。 - 如开放给用户聊天使用，也应该通过内容安全来管控，避免出现违法违规内容，导致被下架。 - 在微信小程序等平台，名字或内容涉及ChatGPT，都会被平台封禁。所以上微信小程序时不能提及ChatGPT，也不要使用uni-ai的openai配置功能。可以使用国内ai或让uni-ai自动分配。同时输入和返回的内容都需要做安全审查，具体见上。 - 如果在企业内部通过openai提升生产力，这不涉及合规问题，可以放心使用。 -## 初次使用uniCloud用户指导 -1. 创建uniCloud云函数 -- 在uniCloud目录右键新建云函数 +## 初次使用uniCloud用户指南@first + +如之前未使用过uni-app，那请重头学起。[uni-app官网](https://uniapp.dcloud.net.cn) + +如了解uni-app，但未使用过uniCloud。请参考本章节继续。 + +1. 首先注册开通uniCloud，登录[https://unicloud.dcloud.net.cn/](https://unicloud.dcloud.net.cn/)，创建一个服务空间。 + +2. 在uni-app项目点右键创建uniCloud环境，关联之前创建的服务空间。 + +3. 创建uniCloud云函数 + +在项目下uniCloud目录右键，新建云函数 -- 云函数名称填写：`ai-demo`。此云函数需要扩展调用`uni-ai`的能力，这里我们需要为此云函数添加扩展库，如图：点击`添加公共模块或扩展库依赖`按钮。 +- 填写云函数名称，比如`ai-demo`。此云函数需要调用`uni-cloud-ai`扩展库，所以需点击`添加公共模块或扩展库依赖`按钮。 - 找到`uni-cloud-ai`勾选，点击确认，创建云函数 + -- 添加如下代码： +4. 云函数中添加如下代码： ```js - //event为客户端上传的参数 - console.log('event',event) - const {messages} = event - // 文档地址：https://uniapp.dcloud.net.cn/uniCloud/uni-ai.html#uni-ai - const LLMManager = uniCloud.ai.getLLMManager() + // 云函数的代码运行在uniCloud服务器上 + console.log('event',event) // event为客户端上传的参数 + const {messages} = event //实际代码中应校验客户端提交的参数 + const LLMManager = uniCloud.ai.getLLMManager() //创建llm对象 return await LLMManager.chatCompletion({ - messages, - // maxTokens:1000, - // model:"", - // temperature:"", - // topP:"" + messages // 初次调试时，可注掉本行代码，不从客户端获取数据，直接使用下面写死在云函数里的数据 + // messages: [{ + // role: 'user', + // content: 'uni-app是什么，20个字以内进行说明' + // }] }) ``` -2.在客户端通过callFunction调用`ai-demo`云函数 +如果不从客户端获取参数，直接在云函数里写messages，可以在云函数中直接按Ctrl+R（或工具栏的运行按钮），在本地运行云函数。 + +还可以断点调试云函数，详见[uniCloud运行调试教程](rundebug.md) + +5. 在客户端通过callFunction调用`ai-demo`云函数 + +注意uni-app客户端连接uniCloud不是通过`uni.request`。如果调用云函数是`uniCloud.callFunction`。（如调用云对象是`uniCloud.importObject`） + ```js const content = "你能给我提供什么服务" uni.showLoading(); uniCloud.callFunction({ - name: "ai-demo", + name: "ai-demo", // 这里是你的云函数的名称。如果你的云函数不叫ai-demo请自行更换 data: { messages: [{ role: 'user', @@ -430,4 +457,20 @@ uni-ai会持续快速迭代，未来会陆续提供： }) ``` -> 更多问题欢迎加入uni-ai官方交流群 群号:[699680439](https://qm.qq.com/cgi-bin/qm/qr?k=P_JoYXY56vNfb78uNHwwzqpODwl9e89B&jump_from=webapi&authKey=GDp321q9ZYW4V0ZQcejXikwMnNRs4KVBcQXMADs8lvC0hifSH9ORHsyERy6vO4bA) +运行客户端项目，比如运行到web浏览器，即可联调客户端和云端。 + +上述代码只是最简示例，真正的多轮聊天需要的代码较多较复杂，推荐使用现成的`uni-im`或`uni-cms`。 + +官方的`uni-im`或`uni-cms`等项目一般不使用云函数，而是使用云对象。想看懂这些项目源码，需要了解[云对象](cloud-obj.md) + +## 非uniCloud服务器调用 + +如需在非uniCloud的传统服务器调用`uni-ai`，需要先在uniCloud上创建一个云函数或云对象，加载uni-cloud-ai扩展库，编写上述uni-ai的调用代码。 + +然后将云函数或云对象进行URL化，转成http接口，[详见](http.md) + +如果在您的传统服务器和uniCloud云函数之间需要建立安全通信机制，可使用s2s公共模块，[详见](uni-cloud-s2s.md) + +## 交流群 + +更多问题欢迎加入uni-ai官方交流群 qq群号:[699680439](https://qm.qq.com/cgi-bin/qm/qr?k=P_JoYXY56vNfb78uNHwwzqpODwl9e89B&jump_from=webapi&authKey=GDp321q9ZYW4V0ZQcejXikwMnNRs4KVBcQXMADs8lvC0hifSH9ORHsyERy6vO4bA) -- GitLab