Documentation

Getting Started

Welcome to TextifyAI Schematics documentation. This guide will help you get started with implementing our text annotation solutions in your projects.

Installation

You can install TextifyAI Schematics using npm or yarn:

Basic Configuration

After installation, you'll need to configure the TextifyAI client with your API key:

// Using npm
npm install textifyai-schematics

// Using yarn
yarn add textifyai-schematics

API Reference

The TextifyAI Schematics API provides a comprehensive set of endpoints for text annotation, entity extraction, and document processing.

Authentication

All API requests require authentication using your API key. Include your API key in the headers of each request:

Rate Limits

The API is rate-limited to 1000 requests per minute per API key. If you exceed this limit, you'll receive a 429 Too Many Requests response.

// Initialize the TextifyAI client
const textify = new TextifyAI({
  apiKey: 'your-api-key',
  region: 'us-west-2'
});

Annotation Guides

TextifyAI Schematics provides powerful tools for annotating text data. This section explains the different annotation types and how to use them effectively.

Entity Annotation

Entity annotation allows you to identify and classify named entities in text, such as people, organizations, locations, dates, and more.

Relationship Annotation

Relationship annotation enables you to define connections between entities in your text data.

// Create an annotation task
const task = await textify.createAnnotationTask({
  name: 'Customer Support Tickets',
  documentType: 'support-ticket',
  annotators: ['user-id-1', 'user-id-2']
});

Schema Configuration

TextifyAI Schematics uses schemas to define the structure of your annotations. This section explains how to create and customize annotation schemas.

Creating a Schema

Schemas define the types of annotations that can be applied to your documents. A schema consists of entity types, relation types, and attributes.

Custom Attributes

You can define custom attributes for your entity and relation types to capture additional information.

// Define a custom annotation schema
const schema = {
  entityTypes: [
    { name: 'Person', color: '#FF5733' },
    { name: 'Organization', color: '#33FF57' }
  ],
  relationTypes: [
    { name: 'WorksFor', color: '#3357FF' }
  ]
};

Team Management

TextifyAI Schematics provides tools for managing teams of annotators and reviewers. This section explains how to create and manage teams, assign tasks, and track progress.

Creating Teams

You can create teams to organize your annotators and reviewers. Teams can be assigned to specific projects or annotation tasks.

Task Assignment

You can assign annotation tasks to specific teams or individual annotators. Tasks can be assigned manually or automatically based on workload and availability.

Advanced Settings

TextifyAI Schematics provides advanced settings for customizing the annotation experience and integrating with other systems.

Webhooks

You can configure webhooks to receive notifications when annotations are created, updated, or completed.

Custom UI Integration

TextifyAI Schematics can be integrated into your existing applications using our JavaScript SDK.

// Configure a webhook
await textify.configureWebhook({
  url: 'https://your-app.com/webhooks/textifyai',
  events: ['annotation.created', 'annotation.updated'],
  secret: 'your-webhook-secret'
});