# @beparallel/langchain-ts 中文文档

规范地址：https://npmcn.com/package/%40beparallel/langchain-ts/

版本：1\.1\.1
npm 元数据更新时间：2026-10-06T08:09:14.961Z
中文译文更新时间：2026-11-07T22:52:45.644Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40beparallel/langchain-ts
原文对照：https://npmcn.com/package/%40beparallel/langchain-ts/?lang=original

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

- 包体积（解压后）：101 kB，51 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：10 个
- 首次发布：2025-05-15T22:09:46.297Z
- 最新版本发布：2026-04-07T14:40:52.425Z
- 近 30 天下载量：2839（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 5 个）

## 中文简介

提取 Langchain 提示并生成 TypeScript 类型 .

## 安装

```sh
npm install @beparallel/langchain-ts
```

也可以使用：`pnpm add @beparallel/langchain-ts`、`yarn add @beparallel/langchain-ts`、`bun add @beparallel/langchain-ts`

## README

# @ bial/ langchain - ts

吸引提示的 CLI 工具 [兰斯密斯枢纽](https://smith.langchain.com/) 并生成 TypeScript 类型和可选 JSON 导出供离线使用.

## 特征

-   **类型生成** -- 从快速输入/输出中生成 TypeScript 接口、 enums 和 Zod 计划
-   **快速导出** -- 将全部快速内容序列化到 JSON 文件, 这样您就可以不拨打就将其卸载 `pull()` 运行时间
-   **过滤** - 窄结果到特定提示的名称,或覆盖 Hub 标记
-   **可编译旗帜** -- 使用 `--file` 财务报告和审定财务报表 `--export-dir` 独立或一起运行

## 安装

安装软件包 :

```bash
pnpm i @beparallel/langchain-ts
```

## 配置

添加以下环境变量(例如: `.env` 文件名 :

| 变量 | 需求 | 说明 |
| --- | --- | --- |
| `LANGCHAIN_API_KEY` | 对 | 您的 LangSmith API 密钥 |
| `LANGCHAIN_TAG` | 对 | 要拉起的Hub标签(例如:. `latest`, (中文(简体) ), `staging`(中文(简体) ) |

```bash
LANGCHAIN_API_KEY=your_api_key
LANGCHAIN_TAG=your_tag
```

## 使用量

至少其中一个 `--file` 或者说 `--export-dir` 需要时间.

### CLI 旗帜

| 旗帜 | 说明 |
| --- | --- |
| `--file=PATH` | 生成类型脚本文件的输出路径 |
| `--export-dir=DIR` | 按时速写入 JSON 文件的目录 |
| `--name=NAME` | 按名称过滤提示( 部分匹配) |
| `--tag=TAG` | 覆盖 `LANGCHAIN_TAG` 环境变量 |

### 实例

```bash
# Generate types only
npx langchain-types --file=./prompt.types.ts

# Export prompts as JSON only
npx langchain-types --export-dir=./prompts/

# Both at once
npx langchain-types --file=./prompt.types.ts --export-dir=./prompts/

# Filter to a single prompt
npx langchain-types --file=./prompt.types.ts --name=my-prompt
```

### package.json 脚本

一个典型的设置 [dotenv-cli (英语)](https://www.npmjs.com/package/dotenv-cli) 以装入 env vars :

```json
{
  "scripts": {
    "prompt:generate": "dotenv -f .env run -- npx langchain-types --file=./types/prompts.ts",
    "prompt:export": "dotenv -f .env run -- npx langchain-types --export-dir=./prompts/",
    "prompt:all": "dotenv -f .env run -- npx langchain-types --file=./types/prompts.ts --export-dir=./prompts/"
  }
}
```

### 如何快速导出

这个 `--export-dir` 旗叫兰彩 `toJSON()` 每个 `ChatPromptTemplate` 然后将结果写到 `<dir>/<tag>/<prompt-name>.json`,由标签组织。 例如,与 `--export-dir=./prompts/ --tag=staging`数字 :

```
prompts/
  staging/
    my-prompt.json
    another-prompt.json
```

这些文件包含完整的序列化表示(消息模板,输入变量,输出计划)并可以被加载到LangChain's `load()` 解区域化——不需要向枢纽呼叫网络.

## 程序化 API

软件包还导出用于您自己的脚本的函数 :

```typescript
import { extractPrompts, generateTypes, exportPrompts } from '@beparallel/langchain-ts'

const prompts = await extractPrompts({
  langchainApiKey: process.env.LANGCHAIN_API_KEY!,
  langchainTag: 'latest',
})

generateTypes(prompts, './prompt.types.ts')
exportPrompts(prompts, './prompts/', 'latest')
```

## 捐款

### 设置

```bash
pnpm i
```

### 环境

```bash
export LANGCHAIN_API_KEY=your_api_key
export LANGCHAIN_TAG=your_tag
```

### 本地运行

```bash
pnpm prompt:generate
```

### 测试

```bash
pnpm test
```

### 释放

通过GitHub Actions自动发布. 当a `v*` tag被推出,工作流程运行测试,构建,发布到npm,并创建一个带有自动生成的注释的GitHub发布.

```bash
# Bump version (patch, minor, or major) -- this updates package.json and creates a git tag
npm version patch   # 1.1.0 -> 1.1.1
npm version minor   # 1.1.0 -> 1.2.0
npm version major   # 1.1.0 -> 2.0.0

# Push the commit and tag to trigger the publish workflow
git push --follow-tags
```

先决条件:回购需要 `NPM_TOKEN` 配置于 GitHub 密件( 设置 > 密件和变量 > 动作) .

## 更改日志

### 1.1.0 国家

-   添加 `--export-dir` 将提示序列化为 JSON 文件的 CLI 旗帜, 供下线使用
-   制作 `--file` 可选( 至少其中之一) `--file` 或者说 `--export-dir` (现在需要)
-   添加 `exportPrompts()` 向方案 API
-   在 CLI 输入点清除已死代码

### 1.0.0 (单位:千美元)

-   升级到 LangChain v1 ()`@langchain/core` ^1.x, (英语), `langchain` ^1.x) (中文(简体) )

### 0.3.0 (中文(简体) )

-   将依赖升级到最新版本
-   重构解析器模块以使用命名导入 `pull` 从 `langchain/hub`

### 6.2.8 国家

-   添加 `--name` 按名称过滤提示的旗帜( 部分匹配)
-   添加 `--tag` 上方的旗帜 `LANGCHAIN_TAG` 从命令行

### 0.2.0 (中文(简体) )

-   添加 ESLint、 Jest 和 Pretier 配置
-   引入大小写转换的功能
-   添加剖析器和类型生成模块的单元测试

### 0.1.0 (中文(简体) )

-   初步释放
-   用于提取 LangSmith 枢纽提示并生成 TypeScript 类型的 CLI
-   Enum, 接口, 和 Zod 的 schema 生成来自 leader JSON schemas

## 许可证

这个项目根据麻省理工学院的许可证获得许可。 见 [自由主义](https://npmcn.com/package/%40beparallel/langchain-ts/LICENSE) 详细文件.

## 常见问题

### @beparallel/langchain-ts 是什么？

提取 Langchain 提示并生成 TypeScript 类型 \.

### 如何安装 @beparallel/langchain-ts？

在项目目录运行 npm install @beparallel/langchain-ts，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 langchain-types，可以用 npx langchain-types 直接运行。

### @beparallel/langchain-ts 支持 TypeScript 吗？

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

### @beparallel/langchain-ts 支持 ESM 还是 CommonJS？

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

### @beparallel/langchain-ts 可以商用吗？

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

### @beparallel/langchain-ts 的下载量有多少？

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

### @beparallel/langchain-ts 还在维护吗？

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