# @godspeedai/cognate-proto 中文文档

规范地址：https://npmcn.com/package/%40godspeedai/cognate-proto/

版本：0\.10\.0
npm 元数据更新时间：2026-11-16T03:45:01.514Z
中文译文更新时间：2026-11-16T18:51:12.053Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40godspeedai/cognate-proto
原文对照：https://npmcn.com/package/%40godspeedai/cognate-proto/?lang=original
项目主页：https://github.com/GodSpeedAI/Cognate#readme
源码仓库：https://github.com/GodSpeedAI/Cognate

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

- 包体积（解压后）：82.6 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2026-10-09T02:29:51.143Z
- 最新版本发布：2026-11-16T03:45:01.207Z
- 近 30 天下载量：3528（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 20 个）

## 中文简介

为犬科原生/源生成了TypeScript绑定. 生成的文件从未通过手进行编辑(spec §21).

## 安装

```sh
npm install @godspeedai/cognate-proto
```

也可以使用：`pnpm add @godspeedai/cognate-proto`、`yarn add @godspeedai/cognate-proto`、`bun add @godspeedai/cognate-proto`

## README

# @ godspideai/ cognate- proto

生成了Cognate所制作的 Cononical protobuf schemas (the `cognate.v1` 软件包) [库夫](https://buf.build/) 财务报告和审定财务报表 [原生出产](https://protobuf-es.buf.build/)。 。 。 .

**何时使用此软件包 :** 您需要键入 `RuntimeService` 服务描述符和生成的用于Cognate电线格式的信息和enum类——用于自定义传输,另一个堆栈中的网关,或消息级工具. 简单的调用 Cognate 运行时间的应用程序 [`@godspeedai/cognate-client`](https://www.npmjs.com/package/@godspeedai/cognate-client) 或协议适配器;它们以这些绑定物为基础,为您处理电线细节.

## 安装

```sh
bun add @godspeedai/cognate-proto
```

要求数 [阿宝](https://bun.sh/) >= 1.4.0. 软件包取决于 `@bufbuild/protobuf`;通过 HTTP 调用运行时间需要连接传输(`@connectrpc/connect`附加时 `@connectrpc/connect-web` 或便利出口 [`@godspeedai/cognate-protocol-connect-bun`](https://www.npmjs.com/package/@godspeedai/cognate-protocol-connect-bun)) (中文(简体) ).

## 出口的东西

切入点再出口所有从卡通里产生的东西 `cognate/v1` 计划 :

-   页:1 `RuntimeService` 服务描述符(运行启动/get/cancel/list、事件流、续作、能力引用、文物、预测、共享状态、远程能力提供);
-   信件类型及其计划 `Event`编号 :`EventSchema`, (中文(简体) ), `Run`, (中文(简体) ), `Continuation`, (中文(简体) ), `StateUpdate`, (中文(简体) ), `RemoteCapabilityOffer`, (中文(简体) ), `SemanticRef`以及家庭其他成员;
-   词库 `RunStatus`, (中文(简体) ), `ContinuationStatus`, (中文(简体) ), `ContinuationAction`,以及 `ResolveOutcome`。 。 。 .

## 快开始

消息是普通的原生取出-es值——从JSON创建,再序列化为 canonical JSON或二进制原生取:

```ts
import { fromJson, toJson } from "@bufbuild/protobuf";
import { EventSchema } from "@godspeedai/cognate-proto";

const event = fromJson(EventSchema, {
  eventId: "e-1",
  streamId: "s-1",
  streamSequence: "1", // uint64 fields are strings in canonical JSON
  position: "1",
  eventType: "run.started",
  schemaVersion: 1,
  occurredAt: new Date().toISOString(),
  recordedAt: new Date().toISOString(),
  tenant: "tenant-a",
  correlationId: "c-1",
  scopeId: "workspace-1",
});

const json = toJson(EventSchema, event); // canonical JSON
const bytes = event.toBinary(); // binary protobuf
```

要调用一个输入客户端的服务运行时间, 请将服务描述符交给连接传输 :

```ts
import { createClient } from "@connectrpc/connect";
import { connectTransport } from "@godspeedai/cognate-protocol-connect-bun";
import { RuntimeService } from "@godspeedai/cognate-proto";

const client = createClient(RuntimeService, connectTransport("http://127.0.0.1:3000"));
const run = await client.getRun({ runId: "<run id>" });
```

偏爱 [`@godspeedai/cognate-protocol-connect`](https://www.npmjs.com/package/@godspeedai/cognate-protocol-connect)是因为 `createRemoteRuntimeService` 当您自己调用运行时间时 : 生成的客户端不会强制 plain JSON `google.protobuf.Value` 字段( 如运行) `input`),该适配器在双向执行转换并映射出错误代码.

## 重新生成

生成的文件( E)`src/gen/**`)是承诺的,从不手工编辑. 在Cognate寄存器中进行再生, 不在下游: 运行 `bun run generate` 在此软件包中执行 `buf generate` 被钉住 `protoc-gen-es` 插件对屏蔽 `proto/` 来源。 已出版软件包的消费者从不运行代码源——他们像其他模块一样导入承诺的输出.

生成是决定性的:两个跑入独立的目录是字节对相和对所承诺的输出的同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同.

## 限制

-   生成的 `RuntimeService` 仅声明无源和服务器流方法; 计划没有客户端流或双向方法 .
-   protobuf-es可以将每个消息序列化为JSON或二进制;选择有线格式是一种传输决定,而不是这个包配置的东西.
-   消息和字段形状只通过这个软件包的新发布来改变,因为没有下游的代码路径.

## 相关软件包

-   [`@godspeedai/cognate-protocol-connect`](https://www.npmjs.com/package/@godspeedai/cognate-protocol-connect) - 运输中立服务器路线和遥控器 `RuntimeService` 以这些束缚为基础.
-   [`@godspeedai/cognate-protocol-connect-bun`](https://www.npmjs.com/package/@godspeedai/cognate-protocol-connect-bun) 服务于 `Bun.serve` 并且提供接送工具.
-   [`@godspeedai/cognate-client`](https://www.npmjs.com/package/@godspeedai/cognate-client) 高级客户端大多数应用应该使用.
-   [`@godspeedai/cognate`](https://www.npmjs.com/package/@godspeedai/cognate) SDK伞.

## 许可证

阿帕奇 - 2.0

## 常见问题

### @godspeedai/cognate-proto 是什么？

为犬科原生/源生成了TypeScript绑定\. 生成的文件从未通过手进行编辑\(spec §21\)\.

### 如何安装 @godspeedai/cognate-proto？

在项目目录运行 npm install @godspeedai/cognate-proto，或使用 pnpm add / yarn add / bun add。

### @godspeedai/cognate-proto 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/godspeedai\_\_cognate-proto 是否存在。

### @godspeedai/cognate-proto 支持 ESM 还是 CommonJS？

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

### @godspeedai/cognate-proto 可以商用吗？

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

### @godspeedai/cognate-proto 的下载量有多少？

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

### @godspeedai/cognate-proto 还在维护吗？

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

