Infactory Ts

🚀 Infactory TypeScript SDK Documentation

This documentation provides a comprehensive guide on using the Infactory TypeScript SDK, including installation, basic usage, error handling, and more.

📦 Installation

Install via npm

npm install infactory-ts

🚀 Quick Start

import { InfactoryClient } from 'infactory-ts';

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

async function main() {
  // Create a new project
  const project = await client.projects.create();
  console.log('Project ID:', project.id);

  // Upload a data file
  const uploadedFile = await client.files.upload('path/to/your/data.csv');
  console.log('File uploaded successfully, ID:', uploadedFile.id);

  // Execute a query
  const queryResult = await client.queries.execute({
    id: '123',
    parameters: {
      key: 'value'
    }
  });
  console.log('Query result:', queryResult.data);
}

💻 Usage Examples

Basic Usage

import { InfactoryClient } from 'infactory-ts';

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

async function main() {
  // Create a new project
  const project = await client.projects.create();
  console.log('Project ID:', project.id);

  // Upload a data file
  const uploadedFile = await client.files.upload('path/to/your/data.csv');
  console.log('File uploaded successfully, ID:', uploadedFile.id);

  // Execute a query
  const queryResult = await client.queries.execute({
    id: '123',
    parameters: {
      key: 'value'
    }
  });
  console.log('Query result:', queryResult.data);
}

Error Handling

try {
  // Execute an API call
} catch (error) {
  if (error instanceof InfactoryError) {
    switch (error.code) {
      case 401:
        console.error('Authentication failed. Please check if your API key is valid.');
        break;
      case 403:
        console.error('You do not have permission to access this resource.');
        break;
      case 404:
        console.error('The requested resource was not found.');
        break;
      default:
        console.error(`An error occurred, status code: ${error.status}`);
    }
  } else {
    console.error('Unknown error:', error.message);
  }
}

Stream Response Handling

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

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

  // Get the stream response
  const result = await client.queries.execute({
    id: '123',
    stream: true
  });

  if (isReadableStream(result)) {
    // Convert the stream to a regular API response
    const apiResponse = await processStreamToApiResponse(result);
    return apiResponse.data;
  } else {
    // Handle the regular response
    return result.data;
  }
}

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

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

  // Get the real-time stream response
  const result = await client.queries.execute({
    id: '123',
    stream: true
  });

  if (isReadableStream(result)) {
    // Process the event stream
    for await (const event of streamEvents(result)) {
      switch (event.type) {
        case 'data':
          console.log('Received data:', event.data);
          break;
        case 'thinking':
          console.log('AI is thinking:', event.content);
          break;
        case 'completion':
          console.log('Reception completed:', event.content);
          break;
        case 'error':
          console.error('Stream processing error:', event.error);
          break;
      }
    }
  } else {
    // Handle the regular response
    return result.data;
  }
}

📚 Documentation Reference

• Infactory API Documentation
• TypeScript Official Documentation

If you need more help, please contact the support team or refer to the community forum.