@ factory/droid-sdk (英语)
Factory TypeScript SDK让应用程序运行Droid,继续对话, 流工作,控制工具,并连接到运行中的Droid守护进程.
安装
npm install @factory/droid-sdk
SDK需要节点.js 18或后.
入境点
| 导入 | 运行时间 | 目的 |
|---|---|---|
@factory/droid-sdk/node | 节点 | 启动 Droid 子进程, 运行提示, 管理本地会话, 定义 SDK MCP 工具 |
@factory/droid-sdk | 浏览器或节点 | 连接到现有的 Droid 守护进程并使用浏览器安全计划、类型和 REST 帮助器 |
@factory/droid-sdk/api | 浏览器或节点 | 通过从公共 API 光谱生成的客户端调用任何 Factory REST API 操作 |
默认情况下,节点会话 API 启动 droid 来自CLI PATH 读取
FACTORY_API_KEY。可以提供自定义可执行文件、 API 密钥或运输工具
通过会话选项.
快开始
import { run } from '@factory/droid-sdk/node';
const result = await run('Summarize this repository.');
if (!result.success) {
throw new Error(result.error?.message ?? 'The run did not complete.');
}
console.log(result.text);
使用 createSession() 多回合节点对话。 使用
connectToDaemon() 从根切入点开始管理会话
已有守护进程.
文档
这个 脚本 SDK 文档 实值 canonic 用户化指南:
- 节点和守护进程运行时间
- 运行、会话、流出、附件和结构化输出
- 权限、询问用户、工具、技能、MCP和钩子
- 会话替换和清理行为
- 浏览器和守护进程集成
- 可观察性、REST帮助者、先进资源和公众API
可用示例 examples/node 财务报告和审定财务报表
examples/browser。 。 。 .
自定义运输迁移
- 中断代理客户更改 :
DroidClientOptions.transport和习惯 现在需要的会话传输DroidClientTransport交换JsonRpcMessage对象通过send财务报告和审定财务报表onMessage无格式标记或 需要运行时间检测. - 内建
ProcessTransport拥有它的STDIO JSON代码. 它的直接send财务报告和审定财务报表onMessage呼叫者现在必须通过并接收对象而不是字符串. 在进程执行中交换快取而无需解码器. - 对于已有的习惯
StringFramedDroidClientTransport,明确通过withJsonRpcCodec(stringTransport)改为DroidClient或会话选项. 适配器和两个接口均导出自@factory/droid-sdk/node。 。 。 . 不要包写已经输入的传输 . - 中断守护进程客户端更改 : 替换
DaemonClient.onMessage与onTransportMessage删除JSON.parse从召回。 自定义DaemonClientTransport.send财务报告和审定财务报表message听众现在交换JsonRpcMessage对象。 将编码器放入跨越序列的运输工具 边界。 外线格式不变.
共享显示信件
filterMessagesForUI不再复制信件。 一条没有消息的信息 隐藏作为同一个对象回来, 一个剥去的信息作为投影 后来又打回电话 将结果视为只读: 变异 更改您的输入或后起的调值。 替换信件而不是 编辑它.
打开状态值( 0.11.0)
RemoteSession['status'], (中文(简体) ),MachineTemplateBuildStatus['status'],以及MachineTemplateBuildStatus['failureReason']现在接受更新的值 服务器添加而不是失败响应 。 详尽无遗switch结束 其中之一需要一个未知值的分支.- 这些领域
RemoteSessionSchema财务报告和审定财务报表MachineTemplateBuildStatusSchema是现在的工会,不是工会:.enum打开 他们走了.options列出工会成员计划,而不是 已知的数值.
机器模板列表 (0.1.10
listMachineTemplates不再需要钱limit或者说cursorAPI 软件 返回一个回复中的每个模板,与pagination.hasMore永远false财务报告和审定财务报表pagination.nextCursor永远null。 。 。 .ListMachineTemplatesOptions滴数limit财务报告和审定财务报表cursor但别走开 界面结束FactoryApiOptions,所以声明合并到它 保持 编译。 一个通过任意一字段的选项对象文字失败 类型检查; 带有额外属性的可变键编译, 帮助器 不发送它们.
这个 犬类 SDK 指南 仍为 完整 API 参考.
浏览器安全
守护进程客户端目前以 Factory API 密钥认证 。 浏览器 集成是用于可信赖的本地工具。 不运送工厂 API 密钥 在公共网站上,将其用于源控制,或将其放入URL.
许可证
Apache 2.0 (英语)