# @genkit-ai/firebase 中文文档

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

版本：1\.44\.0
npm 元数据更新时间：2026-11-03T20:50:30.723Z
中文译文更新时间：2026-11-16T03:41:02.959Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：313 kB，80 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：genkit ^1\.44\.0，firebase \>=11\.5\.0，firebase-admin \>=12\.2，@google-cloud/firestore ^7\.11\.0
- 首次发布：2024-04-04T17:45:59.611Z
- 最新版本发布：2026-11-03T20:50:30.544Z
- 近 30 天下载量：921461（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：168（近 12 个月 40 个）

## 中文简介

Genkit AI框架插件用于Firebase,包括Firestore track/ state store和用于Firebase的Cloud函数的部署助手.

## 安装

```sh
npm install @genkit-ai/firebase
```

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

## README

# Genkit 的火基地插件

Firebase插件将源基特与Firebase和Google Cloud集成. 它规定:

-   **遥测/监测** - 向 Google Cloud / Firebase 出口追踪、度量和日志 [基因组监测](https://genkit.dev/docs/js/observability/getting-started/)。 。 。 .
-   **持久流(Beta)** - 在Firestore或实时数据库中持续流出状态,以便恢复流出.
-   **会话存储 (Beta)** - 持续在Firestore提供代理会话快照,这种短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短篇短.

> **用编码代理? 先安装基因组JS技能.**
> 
> ```bash
> npx skills add genkit-ai/skills --skill developing-genkit-js
> ```
> 
> 它教你的代理人 现任Genkit JS APIs 和普通的gitchas. 其他语言的来源、人工安装和技能: [技能/技能](https://github.com/genkit-ai/skills)。 。 。 .

另见官方文件 [部署有火地基地的玄基](https://genkit.dev/docs/js/deployment/firebase/)。 。 。 .

## 安装插件

```bash
npm i --save @genkit-ai/firebase
```

## 遥测/监测

打电话 `enableFirebaseTelemetry()` 以导出 Google Cloud / Firebase 的 Genkit 跟踪、 度量和日志 :

```ts
import { genkit } from 'genkit';
import { enableFirebaseTelemetry } from '@genkit-ai/firebase';

enableFirebaseTelemetry();

const ai = genkit({
  plugins: [
    // ...
  ],
});
```

见 [监测文件](https://genkit.dev/docs/js/observability/getting-started/) 详细情况.

## 持久流(Beta)

此插件提供了两个 `StreamManager` 实施耐用流:

-   `FirestoreStreamManager`: Persists stream state in Google Firestore. (原始内容存档于2018-09-27).
-   `RtdbStreamManager`: 火地站实时数据库中的活塞流状态.

你可以用这个 `expressHandler` 或者说 `appRoute` 让你的流流持久.

### 使用量

要使用流管理器,请从 `@genkit-ai/firebase/beta` 并把它交给你的处理器:

```ts
import { expressHandler } from '@genkit-ai/express';
import { FirestoreStreamManager } from '@genkit-ai/firebase/beta';
import express from 'express';
import { initializeApp } from 'firebase-admin/app';
import { getFirestore } from 'firebase-admin/firestore';

// ... define your flow: myFlow

const fApp = initializeApp();
const firestore = new FirestoreStreamManager({
  firebaseApp: fApp,
  db: getFirestore(fApp),
  collection: 'streams',
});

const app = express();
app.use(express.json());

app.post('/myDurableFlow', expressHandler(myFlow, { streamManager: firestore }));

app.listen(8080);
```

同样,对于实时数据库:

```ts
import { RtdbStreamManager } from '@genkit-ai/firebase/beta';

const rtdb = new RtdbStreamManager({
  firebaseApp: fApp,
  refPrefix: 'streams',
});

app.post('/myDurableRtdbFlow', expressHandler(myFlow, { streamManager: rtdb }));
```

### 限制

-   **消防车**:整个溪流历史(cunks and final results)被存储在一个文档中. 消防车很严格 [1MB 文件大小限制](https://firebase.google.com/docs/firestore/quotas)。如果您的流输出超过此限制,流会失败.
-   **实时数据库**:虽然RTDB没有相同的1MB限制,但存储非常大的溪流可能影响性能或打出其他配额.

## 会话存储 (Beta)

`FirestoreSessionStore` 是一个火炉支撑 `SessionStore` 用于持续代理会话快照。 它是一个细小的防火基地 围绕核心执行在 [`@genkit-ai/google-cloud`](https://www.npmjs.com/package/@genkit-ai/google-cloud),添加一个 `firebaseApp` 从 Firebase 应用程序中获取 Firestore 实例的选项。 与天真的单一文件店不同,它作为JSON Patch diff的增量站点,一直持续到定期的被压榨的全州检查站,所以:

-   没有任何文档接近 Firestore [1个米B限制](https://firebase.google.com/docs/firestore/quotas) (状态在文档中变硬).
-   每个回合读出/写出的文件数量以下列文件为准: `checkpointInterval` 而不是总会话长度,因此它缩放为任意长会话(例如长寿的聊天员,编码代理).
-   重建仅在只读交易中使用文档-ID查看,因此不需要二次索引,而且非常一致.

### 使用量

从这里导入 `@genkit-ai/firebase/beta` 并传递作为 `store` 当定义代理人时:

```ts
import { genkit } from 'genkit/beta';
import { FirestoreSessionStore } from '@genkit-ai/firebase/beta';
import { initializeApp } from 'firebase-admin/app';

const fApp = initializeApp();

const ai = genkit({
  plugins: [
    // ...
  ],
});

const myAgent = ai.defineAgent({
  name: 'myAgent',
  model: 'googleai/gemini-flash-latest',
  system: 'You are a helpful assistant.',
  store: new FirestoreSessionStore({ firebaseApp: fApp }),
});
```

### 选项

`FirestoreSessionStore` 接受以下选项:

-   `firebaseApp`: 一个 Firebase 应用程序从 Firestore 实例中获取 .
-   `db`:一个明显的Firestore实例. 胜过 `firebaseApp`。 。 。 .
-   `collection`: 存储快照文档的集合 。 默认为 `"genkit-sessions"`由它衍生出两个伴生集: `"<collection>-pointers"` (每个会话一个指针文档)和 `"<collection>-shards"` (坚固的检查站状态).
-   `checkpointInterval`:全州检查站之间的转弯次数. 默认为 `25`. 降低(如:. `10`) 对于小国,读重会;提高会(例如. `50`\- 说吧`100`),用于长时间留存的大回转状态.
-   `shardSize`: 单个硬度/ diff 文档的最大字节大小。 默认为 `512 KiB`。任何超过此限的分数会被提升到一个被压碎的检查站,所以没有文件接近1 MiB 的限值.

* * *

此套件的来源主要为 [精灵](https://github.com/genkit-ai/genkit) 复发. 请提交问题 和拉请求反对的回波.

使用信息和参考详情见 [Genkit 文档](https://genkit.dev/)。 。 。 .

许可证: Apache 2.0

## 常见问题

### @genkit-ai/firebase 是什么？

Genkit AI框架插件用于Firebase,包括Firestore track/ state store和用于Firebase的Cloud函数的部署助手\.

### 如何安装 @genkit-ai/firebase？

在项目目录运行 npm install @genkit-ai/firebase，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：genkit（^1\.44\.0）、firebase-admin（\>=12\.2）、@google-cloud/firestore（^7\.11\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @genkit-ai/firebase 支持 TypeScript 吗？

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

### @genkit-ai/firebase 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @genkit-ai/firebase 可以商用吗？

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

### @genkit-ai/firebase 的下载量有多少？

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

### @genkit-ai/firebase 还在维护吗？

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

