# @context-dot-dev/convex 中文文档

规范地址：https://npmcn.com/package/%40context-dot-dev/convex/

版本：1\.0\.1
npm 元数据更新时间：2026-07-01T03:48:00.167Z
中文译文更新时间：2026-11-10T16:49:40.810Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.3 MB，49 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：convex \>=1\.42\.0
- 首次发布：2026-07-01T02:57:00.304Z
- 最新版本发布：2026-07-01T03:47:59.905Z
- 近 30 天下载量：12086（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

从 Convex 函数调用 Convex 的 Convex 组件 .

## 安装

```sh
npm install @context-dot-dev/convex
```

也可以使用：`pnpm add @context-dot-dev/convex`、`yarn add @context-dot-dev/convex`、`bun add @context-dot-dev/convex`

## README

[![Convex Component](https://www.convex.dev/components/badge/context-dot-dev/convex)](https://www.convex.dev/components/context-dot-dev/convex)

# 上下文.dev Convex 组件

打电话 [背景情况.dev](https://context.dev/) API 从您的 Convex 动作。 此组件将 Contex.dev REST API 与已键入的助手和孤立的组件动作相接- 没有数据存储在 Convex 中 .

## 先决条件

-   一个 Convex app ([开始](https://docs.convex.dev/get-started)(中文(简体) )
-   A 类 [背景.dev API 密钥](https://context.dev/)

## 安装

```sh
npm install @context-dot-dev/convex
```

## 设置

将组件添加到您的 Convex app 配置中,并通过组件 env 连接您的 API 密钥 :

```ts
import contextDev from "@context-dot-dev/convex/convex.config.js";
import { defineApp } from "convex/server";
import { v } from "convex/values";

const app = defineApp({
  env: {
    CONTEXT_DEV_API_KEY: v.string(),
  },
});

app.use(contextDev, {
  env: {
    CONTEXT_DEV_API_KEY: app.env.CONTEXT_DEV_API_KEY,
  },
});

export default app;
```

设定 `CONTEXT_DEV_API_KEY` 在您的对流部署中:

```sh
npx convex env set CONTEXT_DEV_API_KEY your_api_key_here
npx convex dev
```

## 使用量

### 已键入帮助客户端( 建议)

创建共享客户端并从您的动作中调用 :

```ts
import { ContextDev } from "@context-dot-dev/convex";
import { v } from "convex/values";

import { components } from "./_generated/api.js";
import { action } from "./_generated/server.js";

const contextDev = new ContextDev(components.contextDev);

export const brand = action({
  args: { domain: v.string() },
  handler: async (ctx, args) => {
    return await contextDev.retrieveBrand(ctx, {
      params: { domain: args.domain },
    });
  },
});

export const scrapeMarkdown = action({
  args: { url: v.string() },
  handler: async (ctx, args) => {
    return await contextDev.scrapeMarkdown(ctx, {
      params: { url: args.url },
    });
  },
});
```

### 直接组成部分行动

也可以直接调用组件动作 `ctx.runAction`数字 :

```ts
import { v } from "convex/values";

import { components } from "./_generated/api.js";
import { action } from "./_generated/server.js";

export const brand = action({
  args: { domain: v.string() },
  handler: async (ctx, args) => {
    return await ctx.runAction(components.contextDev.brand.retrieve, {
      params: { domain: args.domain },
    });
  },
});
```

## API 参考

获得终点 `params`后端点 `body` 也可以采取 `params` 当操作定义了查询参数时。 回复在恢复功能前被验证为JSON.

### 帮助方法

| 方法 | 说明 |
| --- | --- |
| `scrapeHtml` | 搜索一个 URL并返回原始 HTML |
| `scrapeMarkdown` | 搜索一个 URL 并返回 Markdown |
| `scrapeImages` | 从页面中提取图像引用 |
| `crawlSitemap` | 抓取一个域站点地图 |
| `crawl` | 抓取一个网站并返回 Markdown 页面 |
| `extract` | 从 JSON 计划提取结构化数据 |
| `search` | 以可选过滤器搜索网页并提取 Markdown |
| `competitors` | 找到一个域的直接竞争者 |
| `styleguide` | 提取颜色、打字和设计系统细节 |
| `fonts` | 提取字体使用和字体资产链接 |
| `screenshot` | 抓取网站截图 |
| `retrieveBrand` | 按域检索完整品牌数据 |
| `retrieveBrandByName` | 按公司名称检索品牌数据 |
| `retrieveBrandByEmail` | 从企业电子邮件获取品牌数据 |
| `retrieveBrandByTicker` | 按股票计价器检索品牌数据 |
| `retrieveBrandByIsin` | 由 ISIN 检索品牌数据 |
| `identifyBrandFromTransaction` | 从交易文本中识别一个品牌 |
| `retrieveSimplifiedBrand` | 获取更小的品牌有效载荷 |
| `prefetchBrand` | 按域排序品牌预选 |
| `prefetchBrandByEmail` | 通过电子邮件排队品牌预选 |
| `retrievePerson` | 从支持的标识符获取个人简介 |
| `retrieveNaics` | 将公司分类为NAICS代码 |
| `retrieveSic` | 将公司分类为 SIC 代码 |
| `aiQuery` | 从网站上提取自定义的 AI 数据点 |
| `extractProduct` | 从产品页 URL 提取产品数据 |
| `extractProducts` | 从域或 URL 中提取产品列表 |

### 构成部分行动小组

原始组成部分行动可在下列项下提供:

-   `components.contextDev.brand`
-   `components.contextDev.web`
-   `components.contextDev.ai`
-   `components.contextDev.industry`
-   `components.contextDev.people`

从上下文推断出参数和响应类型.dev OpenAPI spec, 因此您的编辑器将自动完成 `params` 财务报告和审定财务报表 `body` 字段.

## 缓存

这一构成部分在Convex的数据中没有持久性。 上下文.dev 缓存通过 API 参数控制,例如 `maxAgeMs` 个人请求.

## 学多点

-   [背景. dev 文档](https://docs.context.dev/)
-   [对流组件](https://docs.convex.dev/components)

## 常见问题

### @context-dot-dev/convex 是什么？

从 Convex 函数调用 Convex 的 Convex 组件 \.

### 如何安装 @context-dot-dev/convex？

在项目目录运行 npm install @context-dot-dev/convex，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：convex（\>=1\.42\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @context-dot-dev/convex 支持 TypeScript 吗？

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

### @context-dot-dev/convex 支持 ESM 还是 CommonJS？

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

### @context-dot-dev/convex 可以商用吗？

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

### @context-dot-dev/convex 的下载量有多少？

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

### @context-dot-dev/convex 还在维护吗？

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