# hevlayer 中文文档

规范地址：https://npmcn.com/package/hevlayer/

版本：0\.8\.0
npm 元数据更新时间：2026-11-03T20:01:12.723Z
中文译文更新时间：2026-11-03T20:16:38.731Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/hevlayer
原文对照：https://npmcn.com/package/hevlayer/?lang=original

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

- 包体积（解压后）：205 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2026-07-16T12:28:23.677Z
- 最新版本发布：2026-11-03T20:01:12.557Z
- 已发布版本数：10（近 12 个月 10 个）

## 中文简介

用于hevlayer网关的TypeScript客户端

## 安装

```sh
npm install hevlayer
```

也可以使用：`pnpm add hevlayer`、`yarn add hevlayer`、`bun add hevlayer`

## README

# hevlayer TypeScript客户端

生成的 `scripts/sdk-harness generate --lang typescript` 从 `apps/layer-gateway/openapi.yaml`。

客户端是Node-first，使用全局 `fetch`，没有运行时 依赖项，并公开单个基于承诺的 `Hevlayer` 类。

## 快速入门

```ts
import { Hevlayer } from "hevlayer";

const client = new Hevlayer({
  baseUrl: process.env.LAYER_GATEWAY_URL,
  apiKey: process.env.LAYER_GATEWAY_API_KEY,
});

const response = await client.queryNamespace(
  "products",
  { vector: [0.1, 0.2, 0.3], top_k: 5, include_attributes: true },
  {
    searchQuery: "wireless headphones",
    tags: ["app:hev-shop", "route:search", "page:first"],
    withPerf: true,
  },
);

console.log(response.perf.latencyMs, response.perf.cacheStatus);
console.log(response.data.rows);
```

## 生成操作

-   `activateRecordVersion`
-   `aggregateLatest`
-   `authenticateKey`
-   `batchQueryNamespace`
-   `branchNamespace`
-   `claimDocuments`
-   `claimUdfItems`
-   `compareUdfCandidate`
-   `completeUdfItems`
-   `copyNamespace`
-   `createCheckpoint`
-   `createPipeline`
-   `createScan`
-   `createSnapshot`
-   `createUdf`
-   `createUdfCandidate`
-   `deleteKey`
-   `deleteNamespace`
-   `deletePipeline`
-   `deleteScan`
-   `deleteUdf`
-   `discardUdfCandidate`
-   `discoverUdf`
-   `evaluateTurbopufferRecall`
-   `explainTurbopufferQuery`
-   `failUdfItems`
-   `fetchDocument`
-   `fetchDocuments`
-   `getBlob`
-   `getCheckpoint`
-   `getCostRateCard`
-   `getCostSnapshot`
-   `getCostTimeseries`
-   `getKey`
-   `getLicense`
-   `getMetricCatalogEntry`
-   `getNamespaceCapabilities`
-   `getNamespaceMetadata`
-   `getNamespaceSnapshot`
-   `getPipelineDocumentChunks`
-   `getPipelineStatus`
-   `getRecordVersion`
-   `getScan`
-   `getScanResults`
-   `getSnapshotJob`
-   `getSnapshotPolicy`
-   `getTurbopufferNamespaceSchema`
-   `getTurbopufferV1NamespaceMetadata`
-   `getUdf`
-   `getUdfCandidate`
-   `getUdfStatus`
-   `getVectorstore`
-   `getVectorStoreCapabilities`
-   `getWarehouse`
-   `getWarmJob`
-   `heartbeatDocuments`
-   `heartbeatUdfItems`
-   `hintCacheWarm`
-   `importNamespace`
-   `initNamespace`
-   `listCheckpoints`
-   `listClickstream`
-   `listKeys`
-   `listMetricsCatalog`
-   `listNamespaceHistory`
-   `listNamespaces`
-   `listPipelines`
-   `listRecordActivations`
-   `listRecordVersions`
-   `listScans`
-   `listSearchHistory`
-   `listSnapshotActivity`
-   `listSnapshotJobs`
-   `listTurbopufferNamespaces`
-   `listUdfs`
-   `listVectorstores`
-   `listWarehouses`
-   `listWarmJobs`
-   `lookupUdfSiblings`
-   `mintKey`
-   `pauseUdf`
-   `promoteUdfCandidate`
-   `putBlob`
-   `putPipelineDocumentChunks`
-   `putPipelineDocumentRows`
-   `putPipelineDocumentVectors`
-   `putPipelineRows`
-   `putSnapshotPolicy`
-   `query`
-   `queryAgent`
-   `queryMetrics`
-   `queryMetricsApiV1`
-   `queryMetricsRange`
-   `queryMetricsRangeApiV1`
-   `queryNamespace`
-   `queryTurbopufferNamespace`
-   `resetFailedUdf`
-   `resumeUdf`
-   `revokeKey`
-   `scanSourceRows`
-   `searchNamespace`
-   `setDocumentsStage`
-   `updateTurbopufferNamespaceMetadata`
-   `updateTurbopufferNamespaceSchema`
-   `upsertUdf`
-   `warmCache`
-   `writeNamespace`

## 常见问题

### hevlayer 是什么？

用于hevlayer网关的TypeScript客户端

### 如何安装 hevlayer？

在项目目录运行 npm install hevlayer，或使用 pnpm add / yarn add / bun add。

### hevlayer 支持 TypeScript 吗？

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

### hevlayer 支持 ESM 还是 CommonJS？

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

### hevlayer 需要什么版本的 Node\.js？

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

### hevlayer 可以商用吗？

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

### hevlayer 还在维护吗？

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