# @goperigon/perigon-ts 中文文档

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

版本：6\.1\.0
npm 元数据更新时间：2026-11-16T08:03:56.536Z
中文译文更新时间：2026-11-17T07:03:26.959Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40goperigon/perigon-ts
原文对照：https://npmcn.com/package/%40goperigon/perigon-ts/?lang=original
源码仓库：https://github.com/goperigon/perigon-ts

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

- 包体积（解压后）：1.8 MB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：undici \>=5
- 首次发布：2025-05-01T23:23:01.547Z
- 最新版本发布：2026-11-16T08:03:56.312Z
- 近 30 天下载量：5389（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：27（近 12 个月 9 个）

## 中文简介

Perigon API 的打字客户端

## 安装

```sh
npm install @goperigon/perigon-ts
```

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

## README

![Perigon logo](https://perigon.io/favicon.ico)

# Perigon 类型脚本 SDK

类型脚本客户端 **佩里贡 API**

 [![npm version](https://img.shields.io/npm/v/@goperigon/perigon-ts?style=for-the-badge)](https://www.npmjs.com/package/@goperigon/perigon-ts)[![tests status](https://img.shields.io/github/actions/workflow/status/goperigon/perigon-ts/test.yml?label=tests%20%E2%9C%85&style=for-the-badge) ](https://github.com/goperigon/perigon-ts/actions/workflows/test.yml)[![documentation](https://img.shields.io/badge/docs-perigon.io-informational?style=for-the-badge&logo=readthedocs) ](https://docs.perigon.io/)[![license](https://img.shields.io/github/license/goperigon/perigon-ts?style=for-the-badge)](https://npmcn.com/package/%40goperigon/perigon-ts/LICENSE)

用于Perigon API的全型TypeScript SDK. 获取新闻文章,AI摘要,实体数据,以及更多与完全类型安全相关的内容.

-   [\* 特性](https://npmcn.com/package/%40goperigon/perigon-ts/#readme--features)
-   [\* 安装](https://npmcn.com/package/%40goperigon/perigon-ts/#readme--installation)
-   [QQ 快速启动](https://npmcn.com/package/%40goperigon/perigon-ts/#readme--quick-start)
-   [认证](https://npmcn.com/package/%40goperigon/perigon-ts/#readme--authentication)
-   [终点](https://npmcn.com/package/%40goperigon/perigon-ts/#readme--endpoints)
-   [未宣布参数](https://npmcn.com/package/%40goperigon/perigon-ts/#readme--undeclared-parameters)
-   [QQ 错误处理](https://npmcn.com/package/%40goperigon/perigon-ts/#readme--error-handling)
-   [许可证](https://npmcn.com/package/%40goperigon/perigon-ts/#readme--license)

## \* 特性

-   **类型安全** - 用 IntelliSense 支持完整类型脚本
-   **通用** - 在Node.js、浏览器、Deno和边缘运行时间工作
-   **零依赖关系** -轻量级核心,带回你自己的取回器
-   **自动生成** – 总是与最新的 API 同步

## \* 安装

```bash
npm install @goperigon/perigon-ts
# yarn add @goperigon/perigon-ts
# pnpm add @goperigon/perigon-ts
# bun add @goperigon/perigon-ts
```

## QQ 快速启动

```ts
import { Configuration, V1Api } from "@goperigon/perigon-ts";

const perigon = new V1Api(
  new Configuration({
    apiKey: process.env.PERIGON_API_KEY,
  }),
);

try {
  const { articles } = await perigon.searchArticles({
    q: "artificial intelligence",
    size: 5,
  });
  console.log(`Found ${articles.length} articles`);
} catch (error) {
  console.error("API Error:", error.message);
}
```

## 认证

获取您的 API 密钥 [近地点.io](https://perigon.io/)数字 :

```bash
# Environment variable (recommended)
export PERIGON_API_KEY="your_api_key_here"
```

```ts
// Or pass directly
const perigon = new V1Api(
  new Configuration({
    apiKey: "your_api_key_here",
  }),
);
```

请求 `https://api.perigon.io` 默认。 把他们送到别的地方,比如通过代理,通过 `basePath: "https://your-host"` 改为 `Configuration`。 。 。 .

## 终点

### 新闻文章( E)

```ts
const { articles, numResults } = await perigon.searchArticles({
  q: "technology AND startups",
  source: ["techcrunch.com"],
  from: new Date("2024-01-01"),
  size: 10,
});
```

-   [`searchArticles`](https://dev.perigon.io/reference?endpoint=11) - 搜索新闻文章,通过关键词、来源、日期等进行高级过滤
-   [`vectorSearchArticles`](https://dev.perigon.io/reference?endpoint=10) - 使用 AI 驱动矢量搜索查找类似的文章

### 实体

```ts
const { results } = await perigon.searchCompanies({ name: "Apple", size: 5 });
```

-   [`searchCompanies`](https://dev.perigon.io/reference?endpoint=2) - 找到拥有详细商业信息、财务和元数据的公司
-   [`searchPeople`](https://dev.perigon.io/reference?endpoint=5) - 通过新闻和媒体寻找知名人士和公众人物
-   [`searchJournalists`](https://dev.perigon.io/reference?endpoint=3) - 按姓名、出版物或专长发现记者和记者
-   [`getJournalistById`](https://dev.perigon.io/reference?endpoint=4) - 为特定记者获得全面的简介数据

### 内容发现

```ts
const { results } = await perigon.searchStories({
  q: "climate change",
  size: 5,
});
```

-   [`searchStories`](https://dev.perigon.io/reference?endpoint=7) - 查找相关文章集群和趋势故事线索
-   [`searchTopics`](https://dev.perigon.io/reference?endpoint=9) - 浏览结构化主题分类和内容分类
-   [`searchSources`](https://dev.perigon.io/reference?endpoint=6) - 发现新闻来源、出版物和媒体

### AI 特性

```ts
const { summary } = await perigon.searchSummarizer({
  q: "renewable energy",
  summaryBody: {
    prompt: "Summarize the main developments in renewable energy.",
    maxArticleCount: 10,
  },
});
```

-   [`searchSummarizer`](https://dev.perigon.io/reference?endpoint=8) - 从关于任何专题的多篇文章中生成AI强势摘要

### 知识库

```ts
const { results } = await perigon.searchWikipedia({
  q: "machine learning",
  size: 10,
});
```

-   [`searchWikipedia`](https://dev.perigon.io/reference?endpoint=13) – 搜索维基百科文章并进行全文匹配和过滤
-   [`vectorSearchWikipedia`](https://dev.perigon.io/reference?endpoint=12) – 使用矢量相似度查找与维基百科相关的内容

## 未宣布参数

宣告的请求参数被验证; TypeScript 拒绝未宣布的参数. 要发送查询参数, API 接受, 但这个 SDK 版本尚未声明, 请通过 `extraParams`数字 :

```ts
const { results } = await perigon.searchStories({
  q: "climate change",
  extraParams: { someNewFilter: "value" },
});
```

`extraParams` 接受字符串、数字、布尔斯、单一日期以及字符串、数字或布尔斯等数组; `null` 财务报告和审定财务报表 `undefined` 数值被省略。 这些值覆盖了同名已声明的参数,而不检查已声明参数的类型. 绕过类型(如从JavaScript)的未声明的顶级密钥被丢弃.

## QQ 错误处理

所有错误延伸 `ResponseError` 包含 `status` 打开 `body` 属性 :

```ts
try {
  const result = await perigon.searchArticles({ q: "test" });
} catch (error) {
  if (error.status === 401) console.error("Invalid API key");
  else if (error.status === 429) console.error("Rate limit exceeded");
  else console.error("API Error:", error.message);
}
```

## 许可证

麻省理工学院

## 常见问题

### @goperigon/perigon-ts 是什么？

Perigon API 的打字客户端

### 如何安装 @goperigon/perigon-ts？

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

### @goperigon/perigon-ts 支持 TypeScript 吗？

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

### @goperigon/perigon-ts 支持 ESM 还是 CommonJS？

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

### @goperigon/perigon-ts 可以商用吗？

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

### @goperigon/perigon-ts 的下载量有多少？

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

### @goperigon/perigon-ts 还在维护吗？

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

