@zov-chatui/agent

智能体对话 SDK，提供完整的智能体对话功能接口。

安装

npm install @zov-chatui/agent

依赖

本包依赖以下 peer dependencies，需要在使用项目中安装：

npm install react react-dom styled-components @zov-chatui/base
# 或
yarn add react react-dom styled-components @chat-ui/base
# 或
pnpm add react react-dom styled-components @chat-ui/base

必需依赖：

• react >= 16.8.0
• react-dom >= 16.8.0
• styled-components >= 5.0.0
• @zov-chatui/base >= 1.0.0

注意：如果使用 React 组件（如 AgentChatApp），必须安装上述所有依赖。如果只使用 API 接口（如 agentApi），则只需要安装 @zov-chatui/base。

快速开始

基础配置

import { setBaseURL, setAuthToken, setSuccessCode } from '@zov-chatui/agent';

// 设置 API 基础路径
setBaseURL('https://your-api-endpoint.com');

// 设置认证 Token
setAuthToken('your-share-token');

// 【可选】如果服务端还没有改造，使用旧格式（code: 0 表示成功）
// setSuccessCode(0);
// 默认使用新格式（code: 1 表示成功）

流式对话（自动创建会话）

import { agentApi } from '@zov-chatui/agent';

const messages = [
  {
    content: '你好，请介绍一下自己',
    doc_ids: [],
    id: 'msg_001',
    role: 'user'
  }
];

// 不提供 conversation_id，会自动创建新会话
for await (const chunk of agentApi.streamCompletion({
  agent_status: 1,
  messages: messages,
  dialog_id: 'dialog_001',
  chat_insulate: 'user_123'
})) {
  if (chunk.data?.is_new_conversation) {
    // 第一个片段：新会话信息
    console.log('新会话ID:', chunk.data.conversation.conversation_id);
  } else if (chunk.data === true) {
    // 最后一个片段：结束标志
    console.log('流式输出结束');
  } else if (chunk.data?.answer) {
    // 中间片段：答案内容
    console.log('答案:', chunk.data.answer);
  }
}

独立创建会话

import { agentApi } from '@zov-chatui/agent';

const response = await agentApi.createConversation({
  chat_insulate: 'user_123',
  dialog_id: 'dialog_001',
  name: '我的新对话'
});

console.log('会话ID:', response.data.conversation_id);

重要配置：成功状态码

SDK 默认使用 code: 1 表示成功（新格式）。如果您的服务端还没有改造，可以通过配置切换到旧格式。

方式1：统一配置所有接口

import { setSuccessCode } from '@zov-chatui/agent';

// 统一切换到旧格式（code: 0 表示成功）
setSuccessCode(0);

// 之后所有接口调用都会使用 code: 0 作为成功标志

方式2：分别配置流式接口和普通接口（推荐）

如果流式接口和普通接口的改造进度不同，可以分别配置：

import { setStreamSuccessCode, setApiSuccessCode } from '@zov-chatui/agent';

// 流式接口还没改造，使用旧格式
setStreamSuccessCode(0);

// 普通接口已改造，使用新格式
setApiSuccessCode(1);

配置说明

• 新格式：code: 1 表示成功，code !== 1 表示失败
• 旧格式：code: 0 表示成功，code !== 0 表示失败

主要功能

• ✅ 流式对话输出
• ✅ 自动创建会话
• ✅ 会话管理（创建、更新、删除）
• ✅ 附件上传
• ✅ 语音转换（支持百度 ASR）
• ✅ 会话分享
• ✅ 完整的 TypeScript 类型支持
• ✅ 新旧格式兼容
• ✅ 灵活配置成功状态码
• ✅ 支持流式接口和普通接口分别配置

文档

• 完整 API 文档
• 语音集成指南
• 发布指南 - 如何发布此包到 npm
• 快速发布 - 快速发布步骤

示例

查看 API.md 获取完整的使用示例和接口说明。

License

MIT