# @gea-ai/contract 中文文档

规范地址：https://npmcn.com/package/%40gea-ai/contract/

版本：0\.2\.261114-alpha\.0
npm 元数据更新时间：2026-11-15T02:07:39.752Z
中文译文更新时间：2026-11-16T01:20:49.509Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gea-ai/contract
原文对照：https://npmcn.com/package/%40gea-ai/contract/?lang=original
项目主页：https://musegea.com/developers
源码仓库：https://github.com/bmrlab/gea

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：10.5 MB，416 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：7 个
- 首次发布：2026-05-14T11:25:52.577Z
- 最新版本发布：2026-11-15T02:07:39.565Z
- 近 30 天下载量：5448（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：122（近 12 个月 122 个）

## 中文简介

便携式GEA计划、API有效载荷类型和RPC合同.

## 安装

```sh
npm install @gea-ai/contract
```

也可以使用：`pnpm add @gea-ai/contract`、`yarn add @gea-ai/contract`、`bun add @gea-ai/contract`

## README

# @gea-ai/ 合同

便携式公共合同和共享型号Script有效载荷类型用于GEA.

本套件拥有共享合同第一计划,推断出TypeScript类型,以及 ORPC 合同路由器,可以被ORPC执行器和公众所消耗 SDK软件包.

路线实施应导入这些合同和使用 `@orpc/server` 合同执行者,而不是重新定义路由-本地输入计划。 共享 RPC 有效载荷类型需要跨越软件包边界,例如代理聊天 信件和常见的 ORPC 错误形状, 也住在这里 所以web, CLI, SDK,代理, 和 ORPC 包获得相同的 API 表面.

代理快照描述本地连接器的要求及其曝光 操作。 Feishu 宣布现有的平台连接器 `call` 操作; 其工具接收了 lark-cli `argv` 和可选 `stdin`。该平台拥有CLI 执行和连接证书。 企业身份由 `--as bot` 或者说 `--as user` 每个命令的 argv。 代理和扩展主机命令 投稿和计算机CLI准备被删除.

已经公布的快照仍可装入频道操作 。 分析 抛弃他们的退休特工 `commands` 和扩展命令贡献 元数据而不改变存储的文物或散列。 这些外地赠款 没有执行能力; 重建一个旧代理, 以宣布飞翔连接器.

`agentNodeSnapshotMetadataSchema` 复用克尼克模型, 计划版本, 和保留元数据读取器的计算机字段。 版本摘要 和共享秘密保护可以验证这些领域独立于执行 承认;可操作快照仍然使用完整的快照计划.

普通计算机 `commands.run` 并保留自定义工具命令权限 明确启用计算机的特工的单独能力.

App 服务器绝对路径字段接受 POSIX 和 Windows 驱动路径,包括 由 Rust Canonicalization 在 Windows 上返回的逐字记录格式。 这个 合同保留原生路径,而不是改写项目身份; 相对路径和驱动路径仍然无效.

工人合同对象保留了混凝土Zod schemas和缓存的战地身份. 私人连接器、核心、会话、通道和初始化诊断子树 ưμ㼯a `deferredSchemaShape` 获取器: 完整的构造表达式保留在 如此导入未使用的分支的获取器不会构建其帮助器计划 . 保持共享助手缓存, 并保持交叉schema `.shape` 阅读内部获取器; 读取 `.shape` 描述对象的每个领域。 《公约》的构成方法 被绑定的Zod版本保存了原始取取取器,但对象会扩散来评价它们. 在合同发布后,将SDK针对它释放,并重建应用程序到 包括这些初始化节余.

## 示范边界类型

`@gea-ai/contract/model-contracts` 拥有 `AgentModelMessage`, (中文(简体) ), `AgentModelUsage` 财务报告和审定财务报表 `AgentFinishReason`上下文和工人AI使用这些结构 合同。 现有 `ai` 信件/使用/完成类型仍可转让 上下文保留 API 名称和通用名。 坐标合同前 SDK 迁移这些共享类型时释放.

## 编制API

`@gea-ai/contract/benchmarks-api` 独立项目范围计划 基准、版本、案例、上传和运行. `@gea-ai/contract/benchmarks-openapi` 输出其独立的 OpenAPI 3.1 文档。 这些合同是拟定的合同; 新的航线尚未启用。 见 [合同边界](https://npmcn.com/package/%40gea-ai/contract/src/benchmarks-api.md) 用于出版,范围,一能,JSON限制和发相语义.

## 公共 HTTP 身份预测

`AgentHttpSession` 从 `@gea-ai/contract/agent-http-api` (亦被 常规 `AppAgentSession`)现在包括可选无效 `owner` 与 `user_id` 财务报告和审定财务报表 `display_name`. 行政清单/详细财产担保 当地生产商可以省略. `MemberHttpMember` 编号 : `MemberHttpList` 从 `@gea-ai/contract/member-http-api` 包括可选 `user_id`,仅以 `include_user_id=true` 名单/详情。 这些推断类型是犬科的 用于 SDK 消费者; 不存在 Agent SDK DTO 或成员 HTTP 客户端 . 成员 `email` 是一个需要无效的联系字段( q)`string | null`,包括: 用于创建没有真实邮件的成员。 消费者必须明确接受无效; 内部认证手柄不属于此公共接触域. 重新生成外部 OpenAPI SDK 以曝光查询和无效的电子邮件 。 老朋友 请求保留相同的字段, 电子邮件无效; 会话客户端拒绝未知字段 必须更新他们的计划,然后才能作出行政反应.

## 常见问题

### @gea-ai/contract 是什么？

便携式GEA计划、API有效载荷类型和RPC合同\.

### 如何安装 @gea-ai/contract？

在项目目录运行 npm install @gea-ai/contract，或使用 pnpm add / yarn add / bun add。

### @gea-ai/contract 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @gea-ai/contract 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @gea-ai/contract 可以商用吗？

@gea-ai/contract 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @gea-ai/contract 的下载量有多少？

根据 npm 官方下载统计，@gea-ai/contract 在 2026/10/16 – 2026/11/14 这 30 天内被下载 5,448 次，日均约 182 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gea-ai/contract 还在维护吗？

最新版本 0\.2\.261114-alpha\.0 发布于 2026/11/15（1 天前）；至今共发布 122 个版本，其中过去 12 个月发布了 122 个；首次发布于 2026/05/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

