简介 | uni-app

字段	类型	默认值	描述
contentSecurity	Boolean	false	开启内容安全识别
spentScore	Number	0	对话一次所需消耗的积分数
earnedScore	object	-	配置积分的获取策略
\|- ad	Number	3	观看1次广告可获得的积分数量
\|- price	Number	3	支付1元可获得的积分数量(暂未支持)
chatCompletionOptions	Object	-	支持配置：`model`,`deploymentId`,`tokensToGenerate`（默认值：512）,`temperature`,`topP` 详情查看：https://uniapp.dcloud.net.cn/uniCloud/uni-ai.html#chat-completion
llm	Object	-	大语言模型配置，详情查看：https://uniapp.dcloud.net.cn/uniCloud/uni-ai.html#get-llm-manager

这里内置的内容安全是基于uni-sec-check插件，它是免费的，但有一些限制条件，请务必阅读该插件的文档：https://uniapp.dcloud.net.cn/uniCloud/uni-sec-check.html。

如果你需要使用其他的内容安全检测方案，请自行集成。

注意：如果对ai返回结果进行内容安全检查，会导致stream流式响应失效。

# stream流式响应实现解析

当访问 AI 接口时，如果生成的回复内容过大，响应时间会很长，导致前端用户需要等待很长时间才能收到结果。所以流式响应可以减少前端用户的等待，让ai回复的内容一个字或一段话逐步出现在前端用户的界面上。

uni-ai-chat的流式响应，调用的是uni-ai的llm API中的stream参数。

而stream参数是基于云函数的sse通道封装的。

而sse通道是基于uni-push2封装的。

所以使用流式响应必须给应用开通uni-push。

流式响应的流程图

流式响应的使用需客户端先通过 new uniCloud.SSEChannel() 创建 SSE 通道，并获得 channel 值（详情请参考：https://uniapp.dcloud.net.cn/uniCloud/sse-channel.html#create-sse-channel）。在客户端向 uniCloud 云对象发起请求时，需要将该 channel 值作为参数一同携带；然后 uniCloud 云对象与 uni-ai 建立流式响应(stream) 通讯，云对象监听 uni-ai 返回的分片数据，在接收到数据后再通过 sse-channel (反序列化消息通道)向客户端推送消息。

# 注意事项

使用sse-channel需要先开通uni-push

# 营运专题

v1.0.3起提供了商业化能力，与uni-ai对话消耗积分。

积分可通过看激励视频广告获得。如需要通过支付获取积分，可自行二次开发，接入uni-pay。

平台差异说明

App	H5	微信小程序	支付宝小程序	百度小程序	抖音小程序	QQ小程序	快应用	360小程序	快手小程序	京东小程序
√（3.4.8+）	x	√（3.4.8+）	x	x	x	x	x	x	x	x

# 流程概述

开通广告；在uni-ad官网点击菜单广告设置在应用列表，找到你的应用点击开通广告
创建激励视频广告位；在应用列表点击应用详情再点击新建广告位；如下图：广告类型选激励视频广告，配置服务器回调，选uni-ai-chat部署的uniCloud服务空间，回调云函数名称选：reward-video-callback

微信小程序端注意：
- 参考：uniAD微信小程序广告开通指南开通广告后会自动创建广告位
- 广告服务器回调，提前条件：详情查看https://uniapp.dcloud.net.cn/uni-ad/ad-rewarded-video.html#callbackweixin
配置广告位唯一标识（adpid）

客户端，配置路径：/config.js
服务端，配置路径：uniCloud/cloudfunctions/common/uni-config-center/uni-ad/config.json

一般情况下，新注册的用户将获得少量初始积分（即：对于新注册用户，系统将给予其n次免费对话机会）；在uni-id/hooks配置。路径：uniCloud/cloudfunctions/common/uni-config-center/uni-id/hooks/index.js
配置对话一次需要消耗多少积分needReduceScore详情查看
配置看一次广告获得多少积分earnedScore.ad详情查看

注意：因为广告服务器回调走的是云端，以上配置项，配置完成后记得上传。

客户端需要登录才能消耗积分才能与ai对话，所以要将chat页面配置为必须登录的页面。以下是pages.json里的设置

"uniIdRouter": {
	"loginPage": "uni_modules/uni-id-pages/pages/login/login-withoutpwd",
	"needLogin": [
		"pages/chat/chat"
	],
	"resToLogin": true
}

更多uniIdRouter自动路由详情参考：https://uniapp.dcloud.net.cn/uniCloud/uni-id/summary.html#uni-id-router

# 二次开发

主要文件目录结构


uni-ai-chat
├── uniCloud
│   ├── cloudfunctions
│   │   ├── common                         公共模块目录
│   │   │   ├── uni-config-center          uniCloud 配置中心
│   │   │   │   ├── uni-ad
│   │   │   │   │   └── config.json        广告信息配置
│   │   │   │   ├── uni-ai-chat              
│   │   │   │   │   └── config.json        ai对话项目配置文件详情查看
│   │   │   │   ├── uni-id              
│   │   │   │   │   ├── config.json        身份信息配置文件
│   │   │   │   │   └── hooks              
│   │   │   │   │      └── index.js        用户注册钩子文件
│   │   │   │   └── uni-open-bridge        三方平台认证凭据管理配置
│   │   │   └── uni-sec-check              内容安全检测公共模块
│   │   ├── reward-video-callback          激励视频广告回调云函数
│   │   ├── uni-ai-chat                    uni-ai-chat云对象
│   │   └── uni-open-bridge                三方平台认证凭据管理模块云对象
│   └── database
│       ├── newQuery.jql
│       └── uni-ai-chat.schema.json         
├── components
│   ├── uni-ad-rewarded-video               激励视频广告组件
│   └── uni-ai-msg                          消息内容渲染组件
├── lib                                     资源文件目录
│   ├── highlight
│   │   ├── github-dark.min.css             代码高亮库样式文件
│   │   └── highlight.min.js                代码高亮库脚本文件
│   ├── html-parser.js                      HTML String转nodes数组脚本文件
│   └── markdown-it.min.js                  Markdown 渲染库脚本文件
├── pages                                   页面目录
│   └── chat                                对话页面
├── static                                  静态资源目录
├─ uni_modules                              uni-app模块目录
│   ├── uni-id-pages                        统一身份信息管理模块详情查看
│   ├── uni-open-bridge                     三方平台认证凭据管理模块详情查看
│   ├── uni-id-pages                        统一身份信息管理模块详情查看
│   └── uni-sec-check                       内容安全检测模块详情查看
├─ App.vue                                  应用配置，用来配置App全局样式以及监听 应用生命周期
├─ changelog.md                             项目更新日志
├─ config.js                                项目配置文件
├─ main.js                                  项目初始化入口文件
├─ manifest.json                            配置应用名称、appid、logo、版本等打包信息，详情参考
├─ pages.json                               配置页面路由、导航条、选项卡等页面类信息，详情参考
└─ redme.md                                 自述文件

完整的uni-app目录结构详情参考

# 实现通过支付获取积分

二开流程思路如下：

服务端
根据uni-pay文档集成支付功能，在支付成功异步回调（路径：uni-pay-co/notify/earnedScore.js）给相关用户加积分示例代码如下：

'use strict';
// 读取配置的“支付1元可获得的积分数量”值
const uniAiChatConfig = require('uni-config-center')({
	pluginId: 'uni-ai-chat'
}).config()
module.exports = async (obj) => {
	let user_order_success = true;
	let { data = {} } = obj;
	let {
		user_id, //对应用户唯一身份标识
		total_fee, // 支付的金额
		order_no,
		out_trade_no
	} = data; // uni-pay-orders 表内的数据均可获取到
	
	let score = db.command.inc(uniAiChatConfig.earnedScore.pay * total_fee/100)
	let res = await db.collection('uni-id-users')
			.doc(user_id)
			.update({score})
	// console.log(res)
	return user_order_success;
};

客户端

新建组件earned-score-pay实现支付并回调支付结果
在chat页面（路径：pages/chat/chat.vue）搜索 uni-ad-rewarded-video修改同位置代码块如下：

	<view v-if="index == msgList.length-1 && msg.insufficientScore">
		<uni-ad-rewarded-video v-if="adpid" :adpid="adpid" @onAdClose="onAdClose"></uni-ad-rewarded-video>
		<earned-score-pay @success="paySuccess"></earned-score-pay>
	</view>

	paySuccess(){
		this.msgList.pop()
		this.$nextTick(()=>{
			this.retriesSendMsg()
			uni.showToast({
				title: '积分余额:'+score,
				icon: 'none'
			});
		})
	}

# 常见错误

uni-ai相关错误请参考：uni-ai错误码
错误信息："certificate has expired"
请参考文档：云函数通过https访问其他服务器时出现“certificate has expired”
错误信息："Wx0e203209e27b1e66 插件未授权使用添加插住(env: Windows,mp,1.06.2303060；1ib: 2.31.1)"
请参考文档：uniAD微信小程序广告开通指南