Endpoints API 工具包

环境设置

安装依赖：

bash
cd scripts && npm install

在项目根目录创建 .env 文件配置凭证：

ENDPOINTSAPIURL=https://endpoints.work
ENDPOINTSAPIKEY=epyourapikeyhere

前置条件：拥有 API 密钥的 Endpoints 账户。从 API 密钥页面 生成您的 API 密钥。

快速入门

通过从 scripts/src/index.ts 导入来执行函数：

typescript
import { listEndpoints, scanText, getStats } from ./scripts/src/index.js;

const categories = await listEndpoints();
const result = await scanText(与 John 讨论第一季度目标的会议, meeting tracker);
const stats = await getStats();

或直接使用 tsx 运行：

bash
npx tsx scripts/src/index.ts

工作流程模式

每次分析遵循三个阶段：

1. 分析

2. 自动保存

• - 命名结果：{清理后的名称}.json
• 自动生成：YYYYMMDDHHMMSS_{操作}.json

3. 总结

高级函数

独立 API 函数

如需精细控制，可导入特定函数。完整列表（含参数、类型和示例）请参见 references/api-reference.md。

端点函数

扫描函数

项目函数

文件函数

计费函数

数据结构

实时 JSON 模式

端点使用实时 JSON 模式记录文档历史：

typescript
{
endpoint: { path, category, slug },
metadata: {
oldMetadata: { ... }, // 历史项目
newMetadata: { ... } // 近期项目
}
}

元数据项目

每个项目包含：

• - 8 字符 ID - 唯一标识符（例如 abc12345）
• summary - AI 生成的描述
• entities - 提取的实体（人物、公司、日期）
• filePath - 上传文件的 S3 URL
• fileType - MIME 类型
• originalText - 源文本

错误处理

示例

列出和检查

typescript
// 获取所有端点
const { categories } = await listEndpoints();
console.log(找到 ${categories.length} 个类别);

// 检查特定端点
const details = await getEndpoint(/job-tracker/january);
console.log(项目总数：${details.totalItems});

扫描文档

typescript
// 扫描文本内容
const result = await scanText(
来自 Acme Corp 的 John Smith 关于第一季度合同续签的邮件,
business contacts
);
console.log(创建的端点：${result.endpoint.path});

// 扫描 PDF 文件
const fileResult = await scanFile(./invoice.pdf, invoice tracker);
console.log(提取了 ${fileResult.entriesAdded} 个项目);

查看使用情况

typescript
const stats = await getStats();
console.log(解析次数：${stats.parsesUsed}/${stats.parsesLimit});
console.log(存储空间：${stats.storageUsed} 字节);