01

Быстрый старт

Все операции версии v1 принимают POST с Content-Type: application/json. Для простого анализа передайте source, для URL дополнительно укажите sourceType.

curl -X POST https://textanalysis.tools/api/v1/word-frequency \
  -H "Content-Type: application/json" \
  -d '{"source":"text analysis text","language":"en","keepStopwords":true}'

02

Доступные операции

POST /api/v1/analyze

Bag of Words-анализ одного источника

POST /api/v1/compare

Сравнение двух источников

POST /api/v1/word-frequency

Ограниченный словарь частотности с метаданными обрезки

POST /api/v1/keyword-density

Плотность слов и фраз

POST /api/v1/ngram-analyzer

N-граммы длиной от 1 до 10

POST /api/v1/bag-of-words

Вектор Bag of Words

POST /api/v1/tf-idf

TF-IDF для 2–10 документов

POST /api/v1/similarity

Косинусное сходство BoW или TF-IDF

Табличные операции принимают limit и offset и возвращают totalRows, returnedRows, nextOffset, hasMore и truncated — передавайте nextOffset в следующий запрос, пока он не станет null. Для плотности limit по умолчанию равен 2 000, а до 100 запрошенных фраз сохраняются отдельно. В TF-IDF и сходстве с method: tf-idf пагинация относится к idfTable и использует idfOffset и nextIdfOffset. Сравнение возвращает две упорядоченные таблицы — изменений слов и биграмм — с общими limit, offset и курсором.

03

Источники, языки и настройки

Источник может быть вставленным текстом или публичным HTTP/HTTPS URL. Поддерживаются en, ru, uk, es и auto. Ограничения и точные схемы описаны в OpenAPI.

{
  "sourceType": "text",
  "source": "Your UTF-8 text",
  "language": "auto",
  "keepStopwords": false
}

04

Хранение и ограничения

API не создаёт аккаунт и не хранит текст после обработки. Ограничение частоты защищает публичный сервис; большие или недоступные страницы возвращают структурированную ошибку.

05

Ошибки

HTTPЗначение
400Некорректный JSON или параметры
413Источник, совокупная нагрузка или результат слишком велики
422Текст нельзя проанализировать или удалённый ресурс недоступен
429Превышено ограничение запросов

NPM · LOCAL-FIRST

Нужен локальный режим?

CLI обрабатывает файлы и stdin на вашем компьютере и использует те же методы анализа.

Открыть документацию CLI