# @deepnote/runtime-core 中文文档

规范地址：https://npmcn.com/package/%40deepnote/runtime-core/

版本：0\.8\.0
npm 元数据更新时间：2026-11-05T11:42:33.035Z
中文译文更新时间：2026-11-11T21:39:12.667Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：219 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.14\.0
- 运行依赖：12 个
- 首次发布：2026-02-12T14:34:18.031Z
- 最新版本发布：2026-11-05T11:42:32.832Z
- 近 30 天下载量：3248（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 9 个）

## 中文简介

执行Deepnote项目的核心运行时间

## 安装

```sh
npm install @deepnote/runtime-core
```

也可以使用：`pnpm add @deepnote/runtime-core`、`yarn add @deepnote/runtime-core`、`bun add @deepnote/runtime-core`

## README

# @deepnote/runtime-core (英语)

执行Deepnote项目的核心运行时间.

该项目正在积极开发之中,尚未准备使用。 期待打破变化.

## 安装

```bash
npm install @deepnote/runtime-core
```

## 先决条件

需要22.14.0节点或以后。 代理块使用AI SDK 7及其匹配的提供商包.

你一定有过 `deepnote-toolkit` 与 `server` 额外安装在您的 Python 环境中 :

```bash
pip install "deepnote-toolkit[server]"
```

## 使用量

```typescript
import { ExecutionEngine } from "@deepnote/runtime-core";

const engine = new ExecutionEngine({
  // Python executable, venv directory, or command in PATH (for example: 'python3')
  pythonEnv: "python",
  workingDirectory: "/path/to/project",
});

try {
  await engine.start();

  const summary = await engine.runFile("./my-project.deepnote", {
    onBlockStart: (block, index, total) => {
      console.log(`Running [${index + 1}/${total}] ${block.type}...`);
    },
    onBlockDone: (result) => {
      console.log(result.success ? "ok" : "failed");
    },
  });

  console.log(
    `Executed ${summary.executedBlocks}/${summary.totalBlocks} blocks in ${summary.totalDurationMs}ms`,
  );
} finally {
  await engine.stop();
}
```

## 运行时间配置

`ExecutionEngine` 接受:

-   `pythonEnv: string` - Python 可执行性或用于发射的环境路径 `deepnote-toolkit`
-   `workingDirectory: string` - 执行工作目录
-   `serverPort?: number` - 可选服务器端口(省略时自动指定)

## 执行选项

`runFile(filePath, options)` 财务报告和审定财务报表 `runProject(file, options)` 支持:

-   笔记本/块过滤 : `notebookName`, (中文(简体) ), `blockId`, (中文(简体) ), `blockIds`
-   执行前输入注入 : `inputs`
-   代理块意识数据库集成元数据: `integrations`
-   代理块的取消 : `signal` ——代码和SQL块仍然运行到完成,中止的代理被报告为失败块而不是拒绝
-   回调 : `onBlockStart`, (中文(简体) ), `onBlockDone`, (中文(简体) ), `onOutput`, (中文(简体) ), `onAgentEvent`, (中文(简体) ), `onServerStarting`, (中文(简体) ), `onServerReady`

## 代理块提供者

设定 `metadata.deepnote_agent_model` 给模范身份证明 从名称开始 `claude-` 选择Anthropic; 其他名称选择 OpenAI 。 用于本地运行, 使用 `provider:model` 明确选择提供者, 例如 `anthropic:auto` 或者说 `openai-compatible:llama4`。 。 。 .

没有供应商前缀, `auto` 或省略的模型选择 OpenAI。 一个明确的模型覆盖 提供方的模型环境变量;否则将使用以下变量或默认值.

| 提供者 | 默认模式 | API 密钥 | 模型覆盖 |
| --- | --- | --- | --- |
| `openai` | [`gpt-6.1-sol`](https://developers.openai.com/api/docs/models/gpt-6.1-sol) | `OPENAI_API_KEY` | `OPENAI_MODEL` |
| `anthropic` | [`claude-opus-5-5`](https://platform.claude.com/docs/en/models/opus-5-5/overview) | `ANTHROPIC_API_KEY` | `ANTHROPIC_MODEL` |
| `openai-compatible` | 必须设定 | `DEEPNOTE_AGENT_API_KEY` | `DEEPNOTE_AGENT_MODEL` |

来电通过者 `apiKey` 自己可以查找一个提供者返回到的变量 `getAgentApiKeyEnvVar(parseAgentModel(spec).providerId)`。 。 。 .

### 自定义终点

使用 `OPENAI_BASE_URL` (包括 `/v1`)或(或) `ANTHROPIC_BASE_URL` (有无) `/v1`以覆盖 a 供应商的终点。 这个 `openai` 提供者总是使用响应 API,所以它的终点必须 支持这个计划.

其他端点,如OpenRouter、Ollama和LiteLLM,使用 `openai-compatible` 供养. 这个 使用 Chat 补全并需要一个密钥, 结束点(`DEEPNOTE_AGENT_BASE_URL`),和一个模型 支持工具调用。 在块或使用中设置模型 `openai-compatible:auto` 与 `DEEPNOTE_AGENT_MODEL`。使用端点的型号ID;例如OpenRouter, `openai-compatible:anthropic/claude-opus-5.5`。 。 。 .

### 与云分享笔记本

使用 `auto` 或一个没有提供者前缀的支持型号ID,例如 `claude-opus-5-5`, (中文(简体) ), `claude-sonnet-5-5`, (中文(简体) ), `gpt-6-sol`,或 `gpt-6-luna`。不支持的名称,包括提供者前缀, 使用工作空间设置.

`auto` 使用 Cloud 中的工作空间设置和本地上方的默认值。 本地密钥和端点 不配置云.

## 结果形状

执行方法返回 `ExecutionSummary`数字 :

-   `totalBlocks`
-   `executedBlocks`
-   `failedBlocks`
-   `totalDurationMs`

## 常见问题

### @deepnote/runtime-core 是什么？

执行Deepnote项目的核心运行时间

### 如何安装 @deepnote/runtime-core？

在项目目录运行 npm install @deepnote/runtime-core，或使用 pnpm add / yarn add / bun add。

### @deepnote/runtime-core 支持 TypeScript 吗？

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

### @deepnote/runtime-core 支持 ESM 还是 CommonJS？

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

### @deepnote/runtime-core 需要什么版本的 Node\.js？

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

### @deepnote/runtime-core 可以商用吗？

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

### @deepnote/runtime-core 的下载量有多少？

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

### @deepnote/runtime-core 还在维护吗？

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

