# @exalabs/ai-sdk 中文文档

规范地址：https://npmcn.com/package/%40exalabs/ai-sdk/

版本：2\.1\.0
npm 元数据更新时间：2026-08-03T21:09:33.409Z
中文译文更新时间：2026-11-14T03:04:37.141Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40exalabs/ai-sdk
原文对照：https://npmcn.com/package/%40exalabs/ai-sdk/?lang=original
项目主页：https://exa.ai/
源码仓库：https://github.com/exa-labs/ai-sdk

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

- 包体积（解压后）：31.5 kB，11 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：ai ^6\.0\.0
- 首次发布：2025-11-10T18:14:28.423Z
- 最新版本发布：2026-06-05T20:20:32.042Z
- 近 30 天下载量：174734（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 4 个）

## 中文简介

Exa Vercel AI SDK的网络搜索工具

## 安装

```sh
npm install @exalabs/ai-sdk
```

也可以使用：`pnpm add @exalabs/ai-sdk`、`yarn add @exalabs/ai-sdk`、`bun add @exalabs/ai-sdk`

## README

# Exa AI SDK (英语)

Exa是一个Websearch API. 仅在几行代码中将 Exa Websearch 工具添加到您的 LLMS 中 。 提供你的AI应用程序 网络搜索的卡比利人。 由Vercel与AI SDK合作.

## 目录

-   [安装](https://npmcn.com/package/%40exalabs/ai-sdk/#readme-installation)
-   [快速启动](https://npmcn.com/package/%40exalabs/ai-sdk/#readme-quick-start)
-   [设置](https://npmcn.com/package/%40exalabs/ai-sdk/#readme-setup)
-   [示例](https://npmcn.com/package/%40exalabs/ai-sdk/#readme-example)
-   [所有选项](https://npmcn.com/package/%40exalabs/ai-sdk/#readme-all-options)
-   [类型脚本支持](https://npmcn.com/package/%40exalabs/ai-sdk/#readme-typescript-support)
-   [链接](https://npmcn.com/package/%40exalabs/ai-sdk/#readme-links)
-   [许可证](https://npmcn.com/package/%40exalabs/ai-sdk/#readme-license)

## 安装

```bash
npm install @exalabs/ai-sdk
```

## 快速启动

```typescript
import { generateText, stepCountIs } from "ai";
import { webSearch } from "@exalabs/ai-sdk";
import { openai } from "@ai-sdk/openai";

const { text } = await generateText({
  model: openai('gpt-5-nano'),
  prompt: 'Tell me the latest developments in AI',
  system: "Only use web search once per turn. Answer based on the information you have.",
  tools: {
    webSearch: webSearch(),
  },
  stopWhen: stepCountIs(3),
});

console.log(text);
```

从中获取您的 API 密钥 [Exa 板盘](https://dashboard.exa.ai/api-keys)。 。 。 .

**使用时的默认 `webSearch()`数字 :**

-   类型 : `auto` (最佳搜索结果)
-   结果: `10`
-   文本 : `3000 characters per result`
-   活爬行 : `fallback` (必要时更新内容)

## 设置

1.  从中获取您的 API 密钥 [Exa 板盘](https://dashboard.exa.ai/api-keys)
2.  把它加进你的 `.env` 文件 :

```bash
EXA_API_KEY=your-api-key-here
```

就这样! 包会自动读取.

## 示例

以下是一个综合了最有用的搜索设置的全功能实例:

```typescript
const { text } = await generateText({
  model: openai('gpt-5-nano'),
  prompt: 'Find the top AI companies in Europe founded after 2018',
  tools: {
    webSearch: webSearch({
      type: "auto",                           // intelligent hybrid search
      numResults: 6,                          // return up to 6 results
      category: "company",                    // focus on companies
      contents: {
        text: { maxCharacters: 1000 },        // get up to 1000 chars per result
        livecrawl: "preferred",               // always get fresh content if possible
        summary: true,                        // return an AI-generated summary for each result
      },
    }),
  },
  stopWhen: stepCountIs(5),
});

console.log(text);
```

## 所有选项

```typescript
webSearch({
  // Search settings
  type: "auto",           // "auto", "keyword", "neural", "fast", "deep"
  category: "news",       // "company", "research paper", "news", "pdf", 
                          // "github", "personal site", "linkedin profile", "financial report"
  numResults: 10,
  
  // Filter by domain
  includeDomains: ["linkedin.com", "github.com"],
  excludeDomains: ["wikipedia.com"],
  
  // Filter by date (ISO 8601)
  startPublishedDate: "2025-01-01T00:00:00.000Z",
  endPublishedDate: "2025-12-31T23:59:59.999Z",
  startCrawlDate: "2025-01-01T00:00:00.000Z",
  endCrawlDate: "2025-12-31T23:59:59.999Z",
  
  // Filter by text
  includeText: ["AI"],    // Must contain
  excludeText: ["spam"],  // Must not contain
  
  // Location
  userLocation: "US",     // Two-letter country code
  
  // Content options
  contents: {
    text: {
      maxCharacters: 1000,
      includeHtmlTags: false,
    },
    summary: {
      query: "Main points",
    },
    livecrawl: "fallback",     // "never", "fallback", "always", "preferred"
    livecrawlTimeout: 10000,
    subpages: 5,
    subpageTarget: "about",
    extras: {
      links: 5,
      imageLinks: 3,
    },
  },
})
```

## 类型脚本支持

完整类型脚本类型包括:

```typescript
import { webSearch, ExaSearchConfig, ExaSearchResult } from "@exalabs/ai-sdk";

const config: ExaSearchConfig = {
  numResults: 10,
  type: "auto",
};

const search = webSearch(config);
```

## 链接

-   [GitHub 仓库](https://github.com/exa-labs/ai-sdk) 查看 npm 包的源代码
-   [尝试 npm 软件包](https://www.npmjs.com/package/@exalabs/ai-sdk) - 在npm上查看
-   [Vercel AI SDK 烹饪本](https://ai-sdk.dev/cookbook/node/web-search-agent#exa) - 以Exa为主角的网络搜索代理实例
-   [API 发光板](https://dashboard.exa.ai/) - 在仪表盘上试试Exa API
-   [获取您的 API 密钥](https://dashboard.exa.ai/api-keys) - 拿你的API钥匙
-   [文档](https://docs.exa.ai/) - Exa API文档
-   [Exa 网址](https://exa.ai/) - 了解更多埃克萨

## 许可证

麻省理工学院

## 常见问题

### @exalabs/ai-sdk 是什么？

Exa Vercel AI SDK的网络搜索工具

### 如何安装 @exalabs/ai-sdk？

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

### @exalabs/ai-sdk 支持 TypeScript 吗？

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

### @exalabs/ai-sdk 支持 ESM 还是 CommonJS？

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

### @exalabs/ai-sdk 可以商用吗？

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

### @exalabs/ai-sdk 的下载量有多少？

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

### @exalabs/ai-sdk 还在维护吗？

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

