From 6f692baee132bd2e59b835be3e10b423a5801baa Mon Sep 17 00:00:00 2001 From: DCloud__JSON Date: Tue, 25 Apr 2023 11:49:57 +0800 Subject: [PATCH] update redme.md --- package.json | 22 +++++++++++++++++++++- redme.md | 29 +---------------------------- 2 files changed, 22 insertions(+), 29 deletions(-) diff --git a/package.json b/package.json index fe736d9..fe6a9eb 100644 --- a/package.json +++ b/package.json @@ -17,5 +17,25 @@ "highlight.js": "^11.7.0", "markdown-it": "^13.0.1" }, - "displayName": "uni-ai-chat" + "displayName": "uni-ai-chat", + "dcloudext": { + "sale": { + "regular": { + "price": "0.00" + }, + "sourcecode": { + "price": "0.00" + } + }, + "contact": { + "qq": "" + }, + "declaration": { + "ads": "无", + "data": "无", + "permissions": "无" + }, + "npmurl": "", + "type": "unicloud-template-project" + } } \ No newline at end of file diff --git a/redme.md b/redme.md index dd3a08f..3f07129 100644 --- a/redme.md +++ b/redme.md @@ -1,30 +1,3 @@ - -## 简介 > 仅支持3.8.0及以上版本的HBuilderX -uni-ai-chat是基于[uni-ai](https://uniapp.dcloud.net.cn/uniCloud/uni-ai.html)的云端一体AI项目模板 - -视频效果： - - -包含一个前端页面(路径：`/pages/chat/chat.vue`)和一个云对象(路径：`uniCloud/cloudfunctions/uni-ai-chat/index.obj.js`) - -## 响应流程图 - - -- 普通响应的流程较为简单，全流程基于 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))向客户端推送消息。 - -### 注意事项 @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控制台，更改`连接本地云函数`为`连接云端云函数`。 - -## 体验步骤 - -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项目点右键，关联之前创建的服务空间。 \ No newline at end of file +### 文档已移至uni-ai-chat文档[https://uniapp.dcloud.net.cn/uniCloud/uni-ai-chat.html](https://uniapp.dcloud.net.cn/uniCloud/uni-ai-chat.html) \ No newline at end of file -- GitLab