这个项目能做什么

此仓库提供用于构建Octavus AI代理应用的官方JavaScript/TypeScript SDK。它采用monorepo结构,包含多个npm包,每个包针对不同的集成层面。 包包括:@octavus/core(用于客户端/服务器通信的共享类型和工具)、@octavus/server-sdk(后端集成)、@octavus/client-sdk(框架无关的客户端)、@octavus/react(React hooks和绑定)、@octavus/cli(代理管理)以及@octavus/docs(文档内容)。 服务端SDK演示了如何使用API密钥创建OctavusClient,使用初始变量创建代理会话,通过自定义工具处理器附加到该会话,并在流式传输文本增量等响应事件时触发命名触发器。React包展示了useOctavusChat hook与HTTP传输的结合,其中触发器请求被转发到后端端点,并向UI暴露消息、状态和发送函数。 文档链接涵盖入门指南、服务端SDK、客户端SDK、协议参考和API参考。开发需要Node.js 20+和pnpm 10+,并提供安装、构建、lint、类型检查和格式化脚本。项目采用MIT许可证,并接受通过贡献指南提交的贡献。