Perigon 类型脚本 SDK
类型脚本客户端 佩里贡 API
用于Perigon API的全型TypeScript SDK. 获取新闻文章,AI摘要,实体数据,以及更多与完全类型安全相关的内容.
* 特性
- 类型安全 - 用 IntelliSense 支持完整类型脚本
- 通用 - 在Node.js、浏览器、Deno和边缘运行时间工作
- 零依赖关系 -轻量级核心,带回你自己的取回器
- 自动生成 – 总是与最新的 API 同步
* 安装
npm install @goperigon/perigon-ts
# yarn add @goperigon/perigon-ts
# pnpm add @goperigon/perigon-ts
# bun add @goperigon/perigon-ts
QQ 快速启动
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数字 :
# Environment variable (recommended)
export PERIGON_API_KEY="your_api_key_here"
// Or pass directly
const perigon = new V1Api(
new Configuration({
apiKey: "your_api_key_here",
}),
);
请求 https://api.perigon.io 默认。 把他们送到别的地方,比如通过代理,通过 basePath: "https://your-host" 改为 Configuration。 。 。 .
终点
新闻文章( E)
const { articles, numResults } = await perigon.searchArticles({
q: "technology AND startups",
source: ["techcrunch.com"],
from: new Date("2024-01-01"),
size: 10,
});
searchArticles- 搜索新闻文章,通过关键词、来源、日期等进行高级过滤vectorSearchArticles- 使用 AI 驱动矢量搜索查找类似的文章
实体
const { results } = await perigon.searchCompanies({ name: "Apple", size: 5 });
searchCompanies- 找到拥有详细商业信息、财务和元数据的公司searchPeople- 通过新闻和媒体寻找知名人士和公众人物searchJournalists- 按姓名、出版物或专长发现记者和记者getJournalistById- 为特定记者获得全面的简介数据
内容发现
const { results } = await perigon.searchStories({
q: "climate change",
size: 5,
});
searchStories- 查找相关文章集群和趋势故事线索searchTopics- 浏览结构化主题分类和内容分类searchSources- 发现新闻来源、出版物和媒体
AI 特性
const { summary } = await perigon.searchSummarizer({
q: "renewable energy",
summaryBody: {
prompt: "Summarize the main developments in renewable energy.",
maxArticleCount: 10,
},
});
searchSummarizer- 从关于任何专题的多篇文章中生成AI强势摘要
知识库
const { results } = await perigon.searchWikipedia({
q: "machine learning",
size: 10,
});
searchWikipedia– 搜索维基百科文章并进行全文匹配和过滤vectorSearchWikipedia– 使用矢量相似度查找与维基百科相关的内容
未宣布参数
宣告的请求参数被验证; TypeScript 拒绝未宣布的参数. 要发送查询参数, API 接受, 但这个 SDK 版本尚未声明, 请通过 extraParams数字 :
const { results } = await perigon.searchStories({
q: "climate change",
extraParams: { someNewFilter: "value" },
});
extraParams 接受字符串、数字、布尔斯、单一日期以及字符串、数字或布尔斯等数组; null 财务报告和审定财务报表 undefined 数值被省略。 这些值覆盖了同名已声明的参数,而不检查已声明参数的类型. 绕过类型(如从JavaScript)的未声明的顶级密钥被丢弃.
QQ 错误处理
所有错误延伸 ResponseError 包含 status 打开 body 属性 :
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);
}
许可证
麻省理工学院