@glodon-aiot/agent-cli-sdk 2.4.7 → 3.0.4

package/README.md

@@ -1,70 +1,157 @@
+# @glodon-aiot/agent-cli-sdk
 
-# @aiot/agent-cli-sdk：
+AIoT Agent 客户端 JavaScript SDK，提供与 AIoT 平台交互的能力，支持会话管理和消息处理。
 
-## 依赖安装
+## 安装
 
-`yarn install`
+```bash
+yarn add @glodon-aiot/agent-cli-sdk
+# 或
+npm install @glodon-aiot/agent-cli-sdk
+```
 
-yarn 安装可参考：https://blog.csdn.net/qq_45112637/article/details/125543953
+## 核心概念
 
-`yarn start`，运行模板项目。
+### BotClient
+主客户端类，负责与 AIoT 平台建立连接和管理会话。
 
-### 贡献代码
+### Session
+会话类，分为两种类型：
+- `AgentSession`: 代理会话
+- `DialogSession`: 对话会话
 
-`git switch master`，切换分支 master。
+## 基本使用
 
-`git pull`，获取 master 最新代码。
+### 初始化客户端
 
-`git switch –c feature/xxx`，在 master 分支下创建并切换到新分支 feature/xxx。
+```javascript
+import BotClient from '@glodon-aiot/agent-cli-sdk';
 
-在新分支编写代码。
+const token = 'your-aiot-token'; // AIoT 平台令牌
+const config = {
+  apiRoot: 'https://api.example.com' // AIoT API 根地址
+};
 
-`git add .`，把所有文件修改添加到暂存区。
+const client = new BotClient(token, config);
 
-`git commit -m "备注信息"`，将暂存区内容添加到本地仓库。
+// 监听客户端就绪事件
+client.addEventListener('ready', () => {
+  console.log('Client is ready');
+});
+```
 
-`git push`，把本地仓库的更新推到远程仓库。
+### 会话管理
 
-分支代码完成后提 PR，将分支`feature/xxx`merge 到 develop 分支。
+```javascript
+// 获取会话列表
+const sessions = await client.getSessions();
 
-- 若有冲突，`git switch feature/xxx`切换到该分支，然后`git pull origin develop`，手动解决冲突之后再次提交代码。
-- 没有冲突且测试没有问题，再提 PR，将 develop 分支 merge 到 master 分支。
+// 创建新会话
+const newSession = await client.loadSession('', {
+  name: 'New Session'
+});
 
-### 更换远程仓库
+// 激活会话
+client.activeSession = newSession.id;
+```
 
-**可向自己的代码仓库提交代码，不要在模板项目上提交代码哦~**
+### 发送消息
 
-关联远程库例子：`git remote add origin git@server-name:path/repo-name.git`，可参考https://www.liaoxuefeng.com/wiki/896043488029600/898732864121440。
+```javascript
+const session = await client.loadSession('session-id');
 
-`git add .`，把所有文件修改添加到暂存区。
+// 发送文本消息
+await session.send({
+  text: 'Hello, world!'
+}, {
+  stream: true // 启用流式响应
+});
 
-`git commit -m "备注信息"`，将暂存区内容添加到本地仓库。
+// 监听消息事件
+session.addEventListener('message:new', (message) => {
+  console.log('New message:', message);
+});
+```
 
-`git push`，把本地仓库的更新推到远程仓库。
+## 事件系统
 
-## 代码提交规范:
+### BotClient 事件
+- `ready`: 客户端准备就绪
+- `application:loaded`: 应用信息加载完成
 
-[@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional)
+### Session 事件
+- `message:new`: 收到新消息
+- `message:updated`: 消息更新
+- `history:loaded`: 历史消息加载完成
+- `data:updated`: 会话数据更新
 
+## 高级功能
+
+### 流式消息处理
+
+```javascript
+session.addEventListener('message:content', (content) => {
+  // 处理流式消息内容
+  console.log('Stream content:', content);
+});
+
+await session.send({
+  text: 'Streaming question'
+}, {
+  stream: true
+});
 ```
-{
-  'build': 打包
-  'chore': 性能,
-  'ci': 脚手架/工程化,
-  'docs': 文档,
-  'feat' : 新功能,
-  'fix': 修改bug,
-  'perf': 性能优化,
-  'refactor': 重构,
-  'revert'： 回退,
-  'style': 样式,
-  'test': 单元测试
-}
-```
 
-举个例子
+### 会话配置
+
+```javascript
+// 设置会话知识库
+await session.setKnowledges([{id: 'knowledge-1'}]);
+
+// 设置提示变量
+await session.setPromptVariables([
+  {key: 'var1', value: 'value1'}
+]);
+
+// 设置网络访问
+await session.setNetOpen(true);
 ```
-git commit -m "fix: some bug"
 
-git commit -m "feat: some feautre"
+## 开发指南
+
+### 依赖安装
+
+`yarn install`
+
+### 运行示例
+
+`yarn start`
+
+### 贡献代码
+
+1. 切换到 master 分支: `git switch master`
+2. 拉取最新代码: `git pull` 
+3. 创建新分支: `git switch -c feature/xxx`
+4. 提交代码: 
+   ```bash
+   git add .
+   git commit -m "feat: your feature"
+   git push
+   ```
+5. 创建 PR 合并到 develop 分支
+
+### 代码提交规范
+
+遵循 Conventional Commits 规范：
+- `feat`: 新功能
+- `fix`: bug 修复
+- `docs`: 文档更新
+- `style`: 代码样式
+- `refactor`: 代码重构
+- `test`: 测试相关
+- `chore`: 构建/工具变更
+
+示例：
 ```
+git commit -m "feat: add new session API"
+git commit -m "fix: message streaming issue"