uni-ai.md

# uni-ai

ai大潮来袭，如何把ai能力引入自己的应用中？几乎是每个开发者都在关心的问题。

`uni-ai`，定位就是开发者使用ai能力的最佳开发库，更丰富、更易用、更高效。

## 特点

1. 聚合
`uni-ai`，聚合了国内外各种流行的ai能力。包括
- 大语言模型LLM：chatGPT、GPT-4、文心一言以及一些优秀创业公司
- 图形能力：stable diffusion、midjourney等

`uni-ai`支持配置自己在AI厂商处申请的API Key和代理，也支持免配直接使用。

2. prompt辅助
自然语言谁都会说，但想提出一个好prompt来指挥ai满足自己的需求并不简单。

`uni-ai`整合了大量prompt模板，并且提供了 `format prompt`和`prompt插件市场`。

举个例子，如果你需要写一个产品营销文案，你可以使用自然语言，如`请帮我编写一份产品营销文案，产品名称叫uni-app，它的特点是开发一次全端覆盖。`

但实际上，自然语言这么写是繁琐且容易纰漏的。format prompt是弹出一个表单，你在表单里填写：
```
产品名称：uni-app
目标用户：程序员
产品归类：前端应用开发框架
产品用途：使用该框架开发应用，一次编码可覆盖到Android app、iOS app、web、以及各家小程序，如微信、百度、支付宝、抖音、qq、京东等小程序和快应用。
卖点：高效、易学、生态完善
文风：技术风格
字数：500字
```

`uni-ai`，为你提供更好的prompt。

3. 私有数据训练
目前的大模型，没有最新的、以及企业私有的数据。各家也未开放fine-turning微调模型。

如何把私有数据灌入ai中，几乎是每个企业都关心的事情。

`uni-ai`提供了一整套方案解决这个问题，只需把私有数据按指定格式提交到你的uniCloud服务空间，就可以自动把这些最新的、私有的知识加入到ai的回答中。

4. 开源项目

ai能力非常常见的应用场景，有智能客服和自动生成文稿。

`uni-ai`把这些常见场景对应的应用均已做好，并且开源。开发者可以直接拿走使用。

- uni-im，内置了智能客服。[详见](https://uniapp.dcloud.net.cn/uniCloud/uni-im.html)
- uni-cms，内置了智能内容生成。[详见](https://uniapp.dcloud.net.cn/uniCloud/uni-cms.html)

这些完善的项目，包括了前端页面（全端可用）、云对象、云数据库等全套代码，开箱即用。
![](https://web-assets.dcloud.net.cn/unidoc/zh/uni-ai/uni-ai-pc-cms-im.png)

5. 费用优化

ai能力调用，是需要按token数量付费的。token太少会回答不准，太多则费用太高。

`uni-ai`提供了多种取舍策略，方便开发者平衡效果和费用。

6. 后置命令处理

ai都是回答文字内容，但实际场景中经常需要自动化执行一些命令。

`uni-ai`提供了action机制，让ai变的更加强大。

例如，请ai帮忙写一段代码，其中涉及了未引用的三方插件，那么action可以通知HBuilder弹出下载这个插件的界面，不但代码生成了，其中的插件也自动下载了。


使用简单的js api，快速开始你的ai之旅吧！

```js
// 因涉及费用，ai能力调用均需在服务器端进行，也就是uniCloud云函数或云对象中
let llm = uniCloud.ai.getLLMManager({
  provider,
  model
})
llm.chatCompletion({
  messages: [{
    role: 'user',
    content: '你好，ai'
  }]
})
```

## API

ai作为一种云能力，相关调用被整合到uniCloud中。

如您的服务器业务不在uniCloud上，可以把云函数URL化，把uni-ai当做http接口调用。

在实际应用中，大多数场景是直接使用uni-im和uni-cms的ai功能，这些开源项目已经把完整逻辑都实现，无需自己研究API。

## 内测邀请
目前`uni-ai`处于内测邀请阶段，可以在需求墙为uni-ai投票（在[需求墙](https://dev.dcloud.net.cn/wish/)选uniCloud分类，对uni-ai投票）。
DCloud会遴选邀请部分用户参与内测。完善后会正式推出。

### 获取LLM服务商实例@get-llm-manager

LLM指大语言模型，区别于ai生成图片等其他模型。

用法：`uniCloud.ai.getLLMManager(Object GetLLMManagerOptions);`

**参数说明GetLLMManagerOptions**

|参数		|类型	|必填		|默认值	|说明															|
|---		|---	|---		|---	|---															|
|provider	|string	|是			|-		|llm服务商，目前支持`openai`、`minimax`。不指定时由uni-ai自动分配	|
|apiKey		|string	|否			|-		|llm服务商的apiKey，如不填则使用uni-ai的key。目前openai是必填		|
|proxy		|string	|否			|-		|`openai`等国外服务的代理服务器地址								|

**示例**

```js
const llm = uniCloud.ai.getLLMManager({
  provider: 'minimax'
})
```

### 对话@chat-completion

用法：`llm.chatCompletion(Object ChatCompletionOptions)`

**参数说明ChatCompletionOptions**

|参数		|类型	|必填	|默认值								|说明																									|
|---		|---	|---	|---								|---																									|
|messages	|array	|是		| -									|提问信息																								|
|model		|string	|否		|openai默认为gpt-3.5-turbo			|模型名称，不同服务商可选模型不同，见下方说明															|
|maxTokens	|number	|否		|minimax为128、openai默认不限制		|总token数限制																							|
|temperature|number	|否		|minimax默认为0.95，openai默认为1	|较高的值将使输出更加随机，而较低的值将使输出更加集中和确定。建议temperature和top_p同时只调整其中一个	|
|topP		|number	|否		|minimax默认为0.9，openai默认为1	|采样方法，数值越小结果确定性越强；数值越大，结果越随机													|

**messages参数说明**

LLM没有记忆能力，messages参数内需要包含前文，LLM才能理解之前聊天的内容。

messages是一个数组，其中每项有消息内容和角色组成

messages示例

```js
const messages = [{
    role: 'system',
    content: '这里是一些对话的背景设定'
  },{
    role: 'user',
    content: '你好'
  }, {
    role: 'assistant',
    content: '你好'
  }, {
    role: 'user',
    content: '请讲解一下勾股定理'
  }]
```

role有三个可能的值：

- system 系统，对应的content字段一般用于对话背景设定等功能。system角色及信息只能放在messages数组第一项。
- user 用户，对应的content字段为用户输入的信息
- assistant ai助手，对应的content字段为ai返回的信息

多数情况下messages内容越多消耗的token越多，所以一般是需要开发者要求ai对上文进行总结，下次对话传递总结及总结之后的对话内容以实现更长的对话。

**可用模型**

|服务商	|接口						|模型																																											|
|---		|---						|---																																											|
|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（默认值）																													|

**示例**

```js
llm.chatCompletion({
  messages: [{
    role: 'user',
    content: '你好'
  }]
})
```