🚀 Infactory TypeScript SDK 使用文档

本 SDK 为开发者提供了便捷的方式来使用 Infactory 的相关服务，涵盖项目创建、数据文件上传、查询执行等功能，同时支持错误处理和流响应处理。

🚀 快速开始

以下是使用 Infactory TypeScript SDK 的基本流程示例：

import { InfactoryClient } from 'infactory-ts';

const client = new InfactoryClient({
  apiKey: 'your-api-key-here'
});

async function main() {
  // 创建新项目
  const project = await client.projects.create();
  console.log('项目 ID:', project.id);

  // 上传数据文件
  const uploadedFile = await client.files.upload('path/to/your/data.csv');
  console.log('文件上传成功，ID:', uploadedFile.id);

  // 执行查询
  const queryResult = await client.queries.execute({
    id: '123',
    parameters: {
      key: 'value'
    }
  });
  console.log('查询结果:', queryResult.data);
}

📦 安装指南

通过 npm 安装

npm install infactory-ts

💻 使用示例

基础用法

上述快速开始部分的代码展示了 SDK 的基础使用方法，包括创建项目、上传文件和执行查询。

错误处理

响应错误示例

try {
  // 执行 API 调用
} catch (error) {
  if (error instanceof InfactoryError) {
    switch (error.code) {
      case 401:
        console.error('身份验证失败，请检查 API 密钥是否有效。');
        break;
      case 403:
        console.error('没有权限访问该资源。');
        break;
      case 404:
        console.error('请求的资源未找到。');
        break;
      default:
        console.error(`发生错误，状态码: ${error.status}`);
    }
  } else {
    console.error('未知错误:', error.message);
  }
}

流响应处理

基本流处理

import { InfactoryClient, isReadableStream, processStreamToApiResponse } from 'infactory-ts';

async function handleBasicStreamingResponse() {
  const client = new InfactoryClient({ apiKey: 'your-api-key-here' });

  // 获取流响应
  const result = await client.queries.execute({
    id: '123',
    stream: true
  });

  if (isReadableStream(result)) {
    // 将流转换为常规 API 响应
    const apiResponse = await processStreamToApiResponse(result);
    return apiResponse.data;
  } else {
    // 处理常规响应
    return result.data;
  }
}

实时事件处理

import {
  InfactoryClient,
  isReadableStream,
  streamEvents
} from 'infactory-ts';

async function handleEventStreamingResponse() {
  const client = new InfactoryClient({ apiKey: 'your-api-key-here' });

  // 获取实时流响应
  const result = await client.queries.execute({
    id: '123',
    stream: true
  });

  if (isReadableStream(result)) {
    // 处理事件流
    for await (const event of streamEvents(result)) {
      switch (event.type) {
        case 'data':
          console.log('接收数据:', event.data);
          break;
        case 'thinking':
          console.log('AI 正在思考:', event.content);
          break;
        case 'completion':
          console.log('完成接收:', event.content);
          break;
        case 'error':
          console.error('流处理错误:', event.error);
          break;
      }
    }
  } else {
    // 处理常规响应
    return result.data;
  }
}

完整示例

基本示例

查看 example.ts 文件，包含 SDK 的基本使用示例。

端到端测试

查看 infactory-e2e-test.ts 文件，了解从项目创建、数据上传到查询执行的完整流程。

🛠️ 开发与测试

本地开发

git clone https://github.com/your-repo/infactory-ts.git
cd infactory-ts
npm install

运行测试

npm test

📚 文档参考

• Infactory API 文档
• TypeScript 官方文档

如需更多帮助，请联系支持团队或查阅社区论坛。