# Обзор

В этом справочнике описываются веб-методы RESTful для взаимодействия с API Tisane с использованием стандартных протоколов HTTP и JSON.

Version: 4.8.0.0

## Servers

Публичное облако Tisane
```
https://api.tisane.ai
```

## Security

### Tisane-API-Key

Ключ подписки API (первичный или вторичный) с [портала разработчиков Tisane](https://dev.tisane.ai/profile)

Type: apiKey
In: header
Name: Ocp-Apim-Subscription-Key

## Download OpenAPI description

[Обзор](https://docs.tisane.ai/_bundle/@l10n/ru/apis/tisane-api-short.yaml)

## NLU / NLP Methods

Это методы, которые фактически выполняют анализ и преобразование входного текста.

### Анализ текста

 - [POST /parse](https://docs.tisane.ai/ru/apis/tisane-api-short/nlu-nlp-methods/parse.md): Метод анализирует входные данные и обнаруживает проблемный контент, фрагменты тональности, сущности, темы, структуру фраз, части речи, стоп-слова и многое другое.

### Список всех доступных языков

 - [GET /languages](https://docs.tisane.ai/ru/apis/tisane-api-short/nlu-nlp-methods/languages.md): Получить список поддерживаемых языков.
Ответ включает в себя следующие атрибуты:
* id — идентификатор языка.
* name — нативное имя.
* englishName — английское имя.
* nativeEncoding — кодировка языка.
* preferredFont — рекомендуемый шрифт для отображения.
* latin — использует ли язык латиницу.
* rightToLeft — используется ли в языке письмо справа налево (например, арабский, иврит, персидский).

### Очистка текста

 - [POST /helper/extract_text](https://docs.tisane.ai/ru/apis/tisane-api-short/nlu-nlp-methods/extract_text.md): Служебный метод удаления JavaScript, CSS-тегов, JSON и другой разметки, возвращающий чистый декодированный текст. Тело запроса включает содержимое разметки, из которого будет извлечен текст. Note: Примечание: этот метод не обрабатывает двоичный контент.

### Сравнение именованных сущностей

 - [POST /compare/entities](https://docs.tisane.ai/ru/apis/tisane-api-short/nlu-nlp-methods/compareentities.md): Сравнивает две составные именованные сущности и выявляет различия.
Текст запроса должен включать:
* language1 (строка) — тег IETF для языка первой сущности.
* entity1 (строка) — первая сущность.
* language2 (строка) — тег IETF для языка второй сущности.
* entity2 (строка) - вторая сущность.
* type (строка) — тип сущности (в настоящее время поддерживается только _person_).

Дополнительная информация: Именованные сущности в руководстве по ответам API Tisane
Ответ содержит:
* result (строка) — результат сравнения:
* no_single_entity — одна или обе сущности недействительны.
* same — сущности идентичны (порядок имен может отличаться).
* different — сущности различаются, подробности приводятся в differs.
* differences (массив строк) — выводит список обнаруженных различий:

  * given_name - другое имя

  * surname - другая фамилия

  * title (например, господин, госпожа) - другое звание (или титул)

  * social_role (например, ученые степени) - другая общественная роль

  * suffix - другая приставка (например, старший, младший)

  * variation - различия в правописании или стиле

### Семантическое сходство

 - [POST /similarity](https://docs.tisane.ai/ru/apis/tisane-api-short/nlu-nlp-methods/similarity.md): Рассчитать семантическое сходство между двумя фрагментами текста, как на одном языке, так и на разных языках.

Текст запроса должен содержать:
* content1 (строка) - первый фрагмент текста.
* language1 (строка) — код языка IETF для content1.
* content2 (строка) - второй фрагмент текста для сравнения.
* language2 (строка) — код языка IETF для content2.
* settings (объект) - дополнительные настройки согласно спецификациям. Дополнительная информация: Руководство по настройке и настройке API Tisane.

Ответ представляет собой число от 0 до 1, обозначающее степень схожести представленных фрагментов текста.

### Определить язык

 - [POST /detectLanguage](https://docs.tisane.ai/ru/apis/tisane-api-short/nlu-nlp-methods/detectlanguage.md): Определяет языки, используемые в предоставленном текстовом фрагменте, и возвращает разбивку по смещениям.

Текст запроса должен включать:
* content (строка) - фрагмент текста для анализа.
* languages (строка, необязательно) — разделенный вертикальной чертой список кодов языков для использования в качестве подсказок.
* delimiter (строка, необязательно) - регулярное выражение для сегментации фрагмента; по умолчанию фрагмент не сегментируется.

Ответ представляет собой структуру JSON, содержащую languages, которая обеспечивает разбивку кодов языков.

### Преобразовать или перевести текст

 - [POST /transform](https://docs.tisane.ai/ru/apis/tisane-api-short/nlu-nlp-methods/transform.md): Этот метод переводит заданный текст.
Текст запроса должен включать следующие элементы:
 from (строка) - Стандартный тег IETF для исходного языка. Используйте  или набор кодов языка, разделенных вертикальной чертой, для вызова автоопределения.
* to (строка) - Стандартный тег IETF для целевого языка. Если исходный и целевой языки одинаковы, будет применено перефразирование.
* content (строка) — текстовое содержимое для перевода.
* settings (объект) - дополнительные настройки перевода.

Дополнительная информация: Руководство по настройке и кастомизации API Tisane
Ответом является преобразованный текст.

## Language Model Direct Access

Методы извлечения и проверки записей из языковых моделей.

### Список склоняемых форм

 - [GET /lm/inflections](https://docs.tisane.ai/ru/apis/tisane-api-short/language-model-direct-access/inflections.md): Возвращает флективные формы указанной лексемы в пределах заданного семейства языков.