Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
lich流
unidocs-zh
提交
a3f3d1eb
U
unidocs-zh
项目概览
lich流
/
unidocs-zh
与 Fork 源项目一致
Fork自
DCloud / unidocs-zh
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
U
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
前往新版Gitcode,体验更适合开发者的 AI 搜索 >>
提交
a3f3d1eb
编写于
4月 26, 2023
作者:
DCloud_Heavensoft
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Update uni-ai-chat.md
上级
a0955afc
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
39 addition
and
16 deletion
+39
-16
docs/uniCloud/uni-ai-chat.md
docs/uniCloud/uni-ai-chat.md
+39
-16
未找到文件。
docs/uniCloud/uni-ai-chat.md
浏览文件 @
a3f3d1eb
## 简介
## 简介
> 仅支持3.8.0及以上版本的HBuilderX
uni-ai-chat是基于
[
uni-ai
](
https://uniapp.dcloud.net.cn/uniCloud/uni-ai.html
)
的云端一体AI项目模板
> 支持HBuilder版本,正式版 3.7.10+,alpha版 3.8.0+
`uni-ai-chat`
是基于
[
uni-ai
](
https://uniapp.dcloud.net.cn/uniCloud/uni-ai.html
)
的聊天项目模板。它包含一个前端页面(路径:
`/pages/chat/chat.vue`
)和一个云对象(路径:
`uniCloud/cloudfunctions/uni-ai-chat/index.obj.js`
)
它支持上文总结、流式响应,把众多复杂的ai聊天逻辑都封装好了。
**插件下载地址:[https://ext.dcloud.net.cn/plugin?name=uni-ai-chat](https://ext.dcloud.net.cn/plugin?name=uni-ai-chat)**
视频效果:
视频效果:
<video
controls
src=
"https://web-assets.dcloud.net.cn/unidoc/zh/uni-ai-chat/uni-ai-stream.mov"
style=
"max-width: 100%; max-height: 70vh;"
></video>
<video
controls
src=
"https://web-assets.dcloud.net.cn/unidoc/zh/uni-ai-chat/uni-ai-stream.mov"
style=
"max-width: 100%; max-height: 70vh;"
></video>
包含一个前端页面(路径:
`/pages/chat/chat.vue`
)和一个云对象(路径:
`uniCloud/cloudfunctions/uni-ai-chat/index.obj.js`
)
## 体验步骤
1.
如之前未使用过uni-app,那请从头学起。
[
uni-app官网
](
https://uniapp.dcloud.net.cn
)
2.
如果你还没有开通uniCloud,需要登录
[
https://unicloud.dcloud.net.cn/
](
https://unicloud.dcloud.net.cn/
)
,创建一个服务空间。
3.
打开
`uni-ai-chat`
插件下载地址:
[
https://ext.dcloud.net.cn/plugin?name=uni-ai-chat
](
https://ext.dcloud.net.cn/plugin?name=uni-ai-chat
)
4.
点击
`使用HBuilderX导入示例项目`
5.
对项目根目录uniCloud点右键选择“云服务空间初始化向导”界面按提示部署项目
6.
在uni-app项目点右键,关联之前创建的服务空间。
## stream流式响应实现解析
当访问 AI 接口时,如果生成的回复内容过大,响应时间会很长,导致前端用户需要等待很长时间才能收到结果。所以流式响应可以减少前端用户的等待,让ai回复的内容一个字或一段话逐步出现在前端用户的界面上。
`uni-ai-chat`
的流式响应,调用的是
`uni-ai`
的llm API中的
[
stream参数
](
uni-ai.md#chat-completion-stream
)
。
而stream参数是基于云函数的
[
sse通道
](
sse-channel.md#cloud-deserialize-channel
)
封装的。
而
`sse通道`
是基于
[
uni-push2
](
https://uniapp.dcloud.net.cn/unipush-v2.html
)
封装的。
所以
**使用流式响应必须给应用开通uni-push**
。
流式响应的流程图
## 响应流程图
<img
width=
"400px"
src=
"https://web-assets.dcloud.net.cn/unidoc/zh/uni-ai-chat/20230425203311.jpg"
>
<img
width=
"400px"
src=
"https://web-assets.dcloud.net.cn/unidoc/zh/uni-ai-chat/20230425203311.jpg"
>
-
普通响应的流程较为简单,全流程基于 HTTP 网络请求。其缺陷是,当访问 AI 聊天接口时,如果生成的回复内容过大,响应时间会很长,导致前端用户需要等待很长时间才能收到结果。详情请参考:
[
stream的优势
](
https://uniapp.dcloud.net.cn/uniCloud/uni-ai.html#chat-completion-stream
)
。
流式响应的使用需客户端先通过
`new uniCloud.SSEChannel()`
创建 SSE 通道,并获得
`channel`
值(详情请参考:
[
https://uniapp.dcloud.net.cn/uniCloud/sse-channel.html#create-sse-channel
](
https://uniapp.dcloud.net.cn/uniCloud/sse-channel.html#create-sse-channel
)
)。在客户端向 uniCloud 云对象发起请求时,需要将该
`channel`
值作为参数一同携带;然后 uniCloud 云对象与 uni-ai 建立 流式响应
[
(stream)
](
https://uniapp.dcloud.net.cn/uniCloud/uni-ai.html#chat-completion-stream
)
通讯,云对象监听 uni-ai 返回的分片数据,在接收到数据后再通过 sse-channel (
[
反序列化消息通道
](
https://uniapp.dcloud.net.cn/uniCloud/sse-channel.html#cloud-deserialize-channel
)
)向客户端推送消息
。
-
流式响应的使用需客户端先通过
`new uniCloud.SSEChannel()`
创建 SSE 通道,并获得
`channel`
值(详情请参考:
[
https://uniapp.dcloud.net.cn/uniCloud/sse-channel.html#create-sse-channel
](
https://uniapp.dcloud.net.cn/uniCloud/sse-channel.html#create-sse-channel
)
)。在客户端向 uniCloud 云对象发起请求时,需要将该
`channel`
值作为参数一同携带;然后 uniCloud 云对象与 uni-ai 建立 流式响应
[
(stream)
](
https://uniapp.dcloud.net.cn/uniCloud/uni-ai.html#chat-completion-stream
)
通讯,云对象监听 uni-ai 返回的分片数据,在接收到数据后再通过 sse-channel (
[
反序列化消息通道
](
https://uniapp.dcloud.net.cn/uniCloud/sse-channel.html#cloud-deserialize-channel
)
)向客户端推送消息。
### 注意事项 @heed
-
使用
`sse-channel`
需要先
[
开通uni-push
](
https://uniapp.dcloud.net.cn/unipush-v2.html#%E7%AC%AC%E4%B8%80%E6%AD%A5-%E5%BC%80%E9%80%9A
)
-
目前uni-push2.0不支持本地调试(后续版本会支持),需要在HBuilderX控制台,更改
`连接本地云函数`
为
`连接云端云函数`
。
## 配置
## 配置
文件路径
`uniCloud/cloudfunctions/common/uni-config-center/uni-ai-chat/config.json`
文件路径
`uniCloud/cloudfunctions/common/uni-config-center/uni-ai-chat/config.json`
目前的配置文件包括是否开启内容安全,即是否检查用户输入和ai返回结果的合规性。开启后,会延缓一定的响应时间,但保证了合规性。
| 字段 | 类型 | 默认值 | 描述 |
| 字段 | 类型 | 默认值 | 描述 |
| :-------- | :-------- | :--- | :------------------------ |
| :-------- | :-------- | :--- | :------------------------ |
| contentSecurity | Boolean | false | 开启内容安全识别 |
| contentSecurity | Boolean | false | 开启内容安全识别 |
### 注意事项 @heed
这里内置的内容安全是基于
`uni-sec-check`
插件,它是免费的,但有一些限制条件,请务必阅读该插件的文档:
[
https://uniapp.dcloud.net.cn/uniCloud/uni-sec-check.html
](
uni-sec-check.md
)
。
-
使用
`sse-channel`
需要先
[
开通uni-push
](
https://uniapp.dcloud.net.cn/unipush-v2.html#%E7%AC%AC%E4%B8%80%E6%AD%A5-%E5%BC%80%E9%80%9A
)
-
目前uni-push2.0不支持本地调试(后续版本会支持),需要在HBuilderX控制台,更改
`连接本地云函数`
为
`连接云端云函数`
。
## 体验步骤
如果你需要使用其他的内容安全检测方案,请自行集成。
注意:如果对ai返回结果进行内容安全检查,会导致stream流式响应失效。
1.
如之前未使用过uni-app,那请从头学起。
[
uni-app官网
](
https://uniapp.dcloud.net.cn
)
2.
如果你还没有开通uniCloud,需要登录
[
https://unicloud.dcloud.net.cn/
](
https://unicloud.dcloud.net.cn/
)
,创建一个服务空间。
3.
打开
`uni-ai-chat`
插件下载地址:
[
https://ext.dcloud.net.cn/plugin?name=uni-ai-chat
](
https://ext.dcloud.net.cn/plugin?name=uni-ai-chat
)
4.
点击
`使用HBuilderX导入示例项目`
5.
对项目根目录uniCloud点右键选择“云服务空间初始化向导”界面按提示部署项目
6.
在uni-app项目点右键,关联之前创建的服务空间。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录