Infactory TypeScript SDK

基本能力

产品定位

Infactory TypeScript SDK 是一个用于与 Infactory AI 平台交互的开发工具，旨在帮助开发者通过编程方式管理和操作平台上的数据和项目。

核心功能

1. 项目管理：创建和管理项目。
2. 团队管理：管理团队和团队成员。
3. 用户认证：用户管理和 API 密钥管理。
4. 数据源连接：连接和管理数据源。
5. 查询程序：创建、运行和发布查询。
6. API 部署：部署和管理 API 端点。
7. 错误处理：提供一致的错误处理策略。
8. 流式响应处理：支持处理流式 API 响应。

适用场景

1. 数据分析：通过查询程序分析数据。
2. 自动化任务：自动化管理项目和团队。
3. API 集成：将 Infactory 功能集成到其他应用中。
4. 数据上传：上传和管理数据源。

工具列表

1. Command Line Tools：用于运行示例文件和端到端测试。
2. Jest：测试框架，支持单元测试、集成测试和模拟测试。
3. ts-jest：为 Jest 提供 TypeScript 支持。
4. MSW：用于 API 模拟测试。

常见问题解答

1. 如何获取 API 密钥：从 Infactory Workshop 获取。
2. 如何处理流式响应：使用 isReadableStream 和 processStreamToApiResponse 工具。
3. 如何运行测试：使用 npm run test 运行所有测试。

使用教程

使用依赖

1. 安装 Node.js 和 npm。
2. 确保已安装 TypeScript。

安装教程

npm install @infactory/infactory-ts

配置

1. 从 Infactory Workshop 获取 API 密钥。
2. 初始化客户端：

import { InfactoryClient } from '@infactory/infactory-ts';
const client = new InfactoryClient({
  apiKey: 'your-api-key-here',
});

调试方式

1. 运行示例文件：

npm run example

1. 运行端到端测试：

npm run e2e-test

1. 检查环境变量是否已正确设置。

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。