# @creem\_io/ingestion 中文文档

规范地址：https://npmcn.com/package/%40creem_io/ingestion/

版本：0\.1\.3
npm 元数据更新时间：2026-09-25T08:14:23.853Z
中文译文更新时间：2026-11-11T00:18:07.874Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40creem_io/ingestion
原文对照：https://npmcn.com/package/%40creem_io/ingestion/?lang=original
项目主页：https://github.com/armitage-labs/creem/tree/main/packages/ingestion
源码仓库：https://github.com/armitage-labs/creem

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

- 包体积（解压后）：69.1 kB，34 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：1 个
- peer 依赖：@ai-sdk/provider \>=4\.0\.0
- 首次发布：2026-09-16T13:14:17.833Z
- 最新版本发布：2026-09-25T08:14:23.486Z
- 近 30 天下载量：3697（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

Creim使用摄入工具包——缓冲、安全、无阻事件交付和可插入计量战略

## 安装

```sh
npm install @creem_io/ingestion
```

也可以使用：`pnpm add @creem_io/ingestion`、`yarn add @creem_io/ingestion`、`bun add @creem_io/ingestion`

## README

# @ creem io/摄入

用量摄取工具包 [克里姆语](https://creem.io/) 缓冲、安全, 以可插接的战略层 自动计量(LLM呼叫,流出,定时处决).

```bash
npm install @creem_io/ingestion
```

## 为什么不直接给API打电话?

你可以.. `creem.events.ingestEvents()` 工作时 此软件包存在于 发送保证您的请求路径需求 :

-   **永远不要挡道,永远不要扔.** `enqueue()` 内存和返回中的缓冲 马上 交付失败通过 `onError` 钩子,不是 用户请求中的例外.
-   **通过建筑进行安全重试.** 每个事件都会有 `event_id` 在队列中 时间; 重试重新发送相同的 ID 和 Creem 的 `(store, event_id)` 脱下 他们倒闭了——重审的批次永远不能双开.
-   **击打.** 当批量填充( 100, 服务器盖) 时或当一个 间隔, 每起事件不会有一个 HTTP 呼叫 .
-   **倒毒驱出.** 克里姆验证批量的全无。 当 服务器拒绝一个无效事件, 管道会驱逐该事件 (通过 `onError`并交付剩下的——一个糟糕的事件无法承受 99个好东西被打倒了.
-   **服务器无意识.** `await flush()` 处理器返回前( 或手) 给 `waitUntil`) (中文(简体) ). 闲置的冲浪计时器是 `unref`"d,所以它从来没有持有 节点进程打开 .

## 缓冲摄入

```ts
import { Ingestion } from "@creem_io/ingestion";

const ingestion = Ingestion({
  apiKey: process.env.CREEM_API_KEY!,
  onError: (error) => console.error("[creem]", error.code, error.message),
  onWarnings: (warnings) => console.warn("[creem]", warnings),
});

// In your request handler — synchronous, cannot fail the request:
ingestion.enqueue({
  name: "tokens_used",
  externalCustomerId: userId, // or { customerId: "cust_..." }
  properties: { tokens: 512, model: "gpt-4o" },
});

// Serverless teardown / graceful shutdown:
await ingestion.flush();
```

每次活动都给客户取名 **一个** 方式 : `customerId` (克里姆语) 编号)或 `externalCustomerId` (你的身份证,登记为 `external_id` 编辑 客户API.

## 直接摄入

当您需要回复( 并准备自行处理错误) :

```ts
const result = await ingestion.ingest([
  { name: "tokens_used", customerId: "cust_abc", properties: { tokens: 512 } },
]);
// { accepted: 1, eventIds: ["..."], warnings?: [...] }
```

无事件 `eventId` 在发送前先弄一个,所以重试 呼叫.. 或者通过一个 `client` 用 SDK 的后置配置 —— 重放 同一身份证,不能两次开票.

`warnings` 你告诉我吧,当一个事件被接受的时候 没有计数器可以听到事件名称, 只有存档的计数匹配, 或者 时间戳在最后的计费期内.

## 战略

策略将您已经使用的客户端包裹并自动计量 。 这个 链将策略绑定在一个事件名称上; `client(customer)` 返回新鲜 每个客户包裹客户(战略是无国籍的——一例服务) 同时期客户安全:

```ts
const metered = ingestion
  .strategy(new SomeStrategy(/* ... */))
  .cost((emission) => Number(emission.properties.tokens) * 0.000002)
  .ingest("llm-usage");

const client = metered.client({ externalCustomerId: userId });
// use `client` normally — every call enqueues a usage event
```

排放事件包含战略的原始测量值 `properties`附加时 sDK 拥有的保留密钥 : `strategy` (捕获机制)和 `_cost` (当 `.cost()` 解析器随附). 从键开始 `_` 为: 为 SDK 写入值保留.

解析器在电话里运行 如果抛出, 事件就会被放弃 并通过 `onError` 作为 `resolver_failed` - 它从不扔进 打电话给你 计量.

### 维塞尔 AI SDK

一次一次包一个语言模型 `generateText` 编号 : `streamText` 电话是 计数器——代号计数器、模型和供应商,没有按呼号编码。 已导入 从 `/ai-sdk` 子路径,所以其类型仅在使用时加载(AI SDK 6+) 编号 : `LanguageModelV3`\+ 键`V4`:

```ts
import { openai } from "@ai-sdk/openai";
import { generateText } from "ai";
import { AiSdkStrategy } from "@creem_io/ingestion/ai-sdk";

const metered = ingestion
  .strategy(new AiSdkStrategy(openai("gpt-4o")))
  .ingest("llm-usage");

const model = metered.client({ externalCustomerId: userId });
const result = await generateText({ model, prompt });
// → event: { input_tokens, output_tokens, cached_input_tokens,
//            total_tokens, model, vendor, _llm, strategy }
```

水流从水流中流出 `finish` 因为它经过.. 消耗一流就足够了 没有什么是缓冲或双读的 A 类 流出在其前已取消 `finish` 部分账单什么也没有.

### 定时执行

最便宜的策略:工作单位时间,计费期限. 仅 成功处决——投掷处决传播其错误 没有帐单 :

```ts
import { DeltaTimeStrategy } from "@creem_io/ingestion";

const metered = ingestion
  .strategy(new DeltaTimeStrategy())
  .ingest("compute-time");

const timed = metered.client({ customerId });
const output = await timed(() => renderVideo(input));
// → event: { delta_time_ms, strategy }
```

进一步的战略(原始 LLM 提供者客户端、流/字节、, OpenTeleometry) 基于相同的 `IngestionStrategy` 导出的基准类 在这里.

## 配置

| 选项 | 默认 | 含义 |
| --- | --- | --- |
| `apiKey` | —— 说 | 带有 Creim API 密钥 `events:write` 范围 |
| `serverURL` | 生产 | 譬如说. `https://test-api.creem.io` 用于测试模式 |
| `client` | —— 说 | 带来自己配置的 `Creem` SDK 实例 |
| `maxBatchSize` | `100` | 每个请求的事件(服务器上限) |
| `flushIntervalMs` | `5000` | 部分批量冲出前的闲置时间 |
| `maxQueueSize` | `10000` | 缓冲绑定; 溢出通过 `onError` |
| `maxRetries` | `5` | 第一次尝试后每批重试(最多6次交货;30多分后退) |
| `onError` | —— 说 | 每一次送货失败,都不要扔,扔钩被吞下 |
| `onWarnings` | —— 说 | 警告 202 |

## 常见问题

### @creem\_io/ingestion 是什么？

Creim使用摄入工具包——缓冲、安全、无阻事件交付和可插入计量战略

### 如何安装 @creem\_io/ingestion？

在项目目录运行 npm install @creem\_io/ingestion，或使用 pnpm add / yarn add / bun add。

### @creem\_io/ingestion 支持 TypeScript 吗？

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

### @creem\_io/ingestion 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @creem\_io/ingestion 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @creem\_io/ingestion 可以商用吗？

@creem\_io/ingestion 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @creem\_io/ingestion 的下载量有多少？

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

### @creem\_io/ingestion 还在维护吗？

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