跳到主要内容

AI+

$w.ai 中可以获取到云开发 AI+ 能力,快速接入大模型、Agent。

$w.ai.LLM

集合了大模型相关的方法。

$w.ai.LLM.chat

使用此接口与大模型进行对话,支持流式与非流式对话。

当传入的 stream 参数为 true 时,进行流式对话,返回文本流和 SSE 事件流。

async function doStreamChat() {
const res = await $w.ai.LLM.chat({
provider: 'hunyuan',
model: 'hunyuan-lite',
messages: [{role: 'user', content: "你好"}],
stream: true
});

const textStream = res.textStream; // 文本流
for await (let text of textStream) {
console.log(text);
}

const eventStream = res.eventStream; // SSE 事件流
for await (let event of eventStream) {
console.log(event);
}
}

当不传入 stream 参数,或设置为 false 时,进行非流式对话,接口返回大模型响应。

async function doChat() {
const res = await $w.ai.LLM.chat({
provider: 'hunyuan',
model: 'hunyuan-lite',
messages: [{role: 'user', content: "你好"}]
});
console.log(res);
}

参数

参数类型含义示例必填
props.providerstring模型供应商'hunyuan'
props.modelstring使用的模型型号,请参考具体使用的大模型查看可用模型列表'hunyuan-lite'
props.messagesArray<{role: string, content: string}>对话消息列表[{role: "user", content: '你好'}]
props.streamboolean是否采用流式请求true
props.temperaturenumber温度参数,影响大模型生成结果多样性,请参考具体使用的大模型文档进按需设置1
props.top_pnumber核采样参数,影响大模型生成结果多样性,请参考具体使用的大模型文档进按需设置1

$w.ai.bot

集合了 Agent 相关的方法。

$w.ai.bot.sendMessage

使用此接口与 Agent 进行流式对话,返回文本流与 SSE 事件流。

async function sendMessageToAgent() {
const res = await $w.ai.bot.sendMessage({
botId: 'bot-xxx',
msg: '你好',
history: []
});

const textStream = res.textStream; // 文本流
for await (let text of textStream) {
console.log(text);
}

const eventStream = res.eventStream; // SSE 事件流
for await (let event of eventStream) {
console.log(event);
}
}

参数

该接口的参数与 @cloudbase/js-sdk 中的 Bot.sendMessage 一致。

$w.ai.bot.getRecommendQuestions

使用此接口获取 Agent 推荐的问题建议,返回文本流与 SSE 事件流。

async function getRecommendQuestionsFromAgent() {
const res = await $w.ai.bot.getRecommendQuestions({
botId: "bot-xxx",
introduction: "一个非常会聊天的机器人",
name: "聊天机器人",
});

const textStream = res.textStream; // 文本流
for await (let text of textStream) {
console.log(text);
}

const eventStream = res.eventStream; // SSE 事件流
for await (let event of eventStream) {
console.log(event);
}
}

参数

该接口的参数与 @cloudbase/js-sdk 中的 Bot.getRecommendQuestions 一致。

$w.ai.bot.get

获取某个 Agent 的信息。

该接口的入参、出参都与@cloudbase/js-sdk 中的 Bot.get 一致。

$w.ai.bot.list

批量获取多个 Agent 的信息。

该接口的入参、出参都与@cloudbase/js-sdk 中的 Bot.list 一致。

$w.ai.bot.getChatRecords

获取聊天记录。

该接口的入参、出参都与@cloudbase/js-sdk 中的 Bot.getChatRecords 一致。

$w.ai.bot.sendFeedback

发送对某条聊天记录的反馈信息。

该接口的入参、出参都与@cloudbase/js-sdk 中的 Bot.sendFeedback 一致。

$w.ai.bot.getFeedback

获取已存在的反馈信息。

该接口的入参、出参都与@cloudbase/js-sdk 中的 Bot.getFeedback 一致。