TextFrame

 

Анализатор контента одна из ключевых возможностей TextFrame, поэтому хотелось бы рассказать о том, как на практике использовать его.

Запрос к анализатору контента.

POST https://textframe.ru/tframe/api/v1/analyse

Authorization: Bearer <your_token>

Формат тела запроса

{
    "requestId": "your id",
    "title": "content title",
    "content": "content body",
    "isHTML": false
}

Параметры

ПараметраТипОписание
requestIdstringИдентификатор запроса
titlestringЗаголовок текста, если он есть
contentstringТекст
isHTMLbooleanФлаг того, что текст в HTML формате

HTTP коды ответа:

  • 200 – запрос успешно отработал.
  • 400 – некорректный запрос.
  • 401 – ошибка авторизации. Токен доступа не задан или его значение некорректно.
  • 403 – доступ запрещен. Возвращается если срок действия токена истек или он был отозван)
  • 429 – превышен лимит запросов

Формат тела ответа

{
    "success": true,
    "version": "1.1.0/202503181939",
    "requestId": "your id",
    "data": {
        "readingTime"꞉ {
            "hours"꞉ 0,
            "minutes"꞉ 3
        },
        "slang": false,
        "language": "ru",
        "categories": [
            {
                "name": "category1",
                "weight": 0.7613700837294343
            },
            {
                "name": "category2",
                "weight": 0.5438754800346736
            },
            {
                "name": "category3",
                "weight": 0.48296356841721455
            }
        ],
        "keywords": ["keyword1", "keyword2", "keyword3"],
        "people": ["person1", "person2"],
        "brand": [ "brand1", "brand2"],
        "countries": [ "country1", "country2"],
        "geo"꞉ [
            {"name"꞉ "location1"},
            {"name"꞉ "location2"},
            {"name"꞉ "location3"}
        ]
    }
}

Параметры:

ПараметрТипОписание
successbooleanФлаг успешности операции
versionstringВерсия ядра анализатора контента
requestIdstringИдентификатор запроса (совпадает с исходным, если он был задан)
data.readingTimeobjectВремя на прочтение (складывается из суммы часов и минут)
data.readingTime.hoursintЧасы на прочтение
data.readingTime.minutesintМинуты не прочтение
data.slangbooleanФлаг наличия нецензурной лексики в контенте
data.languagestringКод языка текста (таблица ниже).
data.categoriesarrayВектор категорий с весами
data.keywordsarrayМассив ключевых слов, если удалось его определить
data.peoplearrayСписок людей, наиболее часто упоминаемых в тексте
data.brandarrayСписок брендов и организацией, наиболее часто встречающихся в тексте
data.countryarrayСписок стран, наиболее часто встречающихся в тексте
data.geoarrayСписок географических мест, наиболее часто встречающихся в тексте
data.geo.[N].namestringНазвание локации

Таблица поддерживаемых языков

КодОписание
??Язык не был определен
arАрабский язык
deНемецкий язык
elГреческий язык
enАнглийский язык
esИспанский язык
frФранцузский язык
hyАрмянский язык
itИтальянский язык
kaГрузинский язык
ruРусский язык