vue-ai-chat
Version:
A Vue.js SDK for Q&A with image upload functionality
64 lines (52 loc) • 1.99 kB
Markdown
说明:
一个适用于 Vue.js 的 AI 聊天组件,可快速集成到 Vue 项目中,实现与 AI 服务的对话交互功能。
1.安装
通过 npm 安装:
npm i vue-ai-chat
2.引入与注册
在 Vue 组件中引入并注册该组件:
import { AiChatBox } from "vue-ai-chat";
import "vue-ai-chat/dist/vue-ai-chat.css";
export default {
components: {
AiChatBox
}
}
3.基本使用
在模板中使用组件,并配置必要参数:
<template>
<div>
<AiChatBox
ref="aiChatBox"
apiToken="your_api_token"
apiUrl="https://api.example.com/chat"
:modelId="'gpt-3.5-turbo'"
aiChatHeight="70vh"
/>
<button @click="sendMessage">发送消息</button>
</div>
</template>
<script>
export default {
methods: {
sendMessage() {
this.$refs.aiChatBox.sendMessage('你好,AI!');
}
}
}
</script>
4.参数说明
参数名 类型 是否必需 描述 单位支持 示例值
apiToken String 是 用于 API 身份验证的 token - "your_api_token_here"
apiUrl String 是 AI 聊天接口的请求地址 - "https://api.xxx.com"
modelId String 否 模型ID - "500px" 或 "70vh"
aiChatHight String 否 聊天容器的高度 px、vh "500px" 或 "70vh"
5.方法说明
sendMessage(message: string)
功能:向 AI 发送消息,可在代码中主动调用此方法触发 AI 对话。
参数:
message (string):要发送给 AI 的文本内容。
返回值:无
示例:
javascript
this.$refs.aiChatBox.sendMessage('请推荐一本好书');