ruTS-API

API для работы с библиотекой ruTS

REST API

`GET` `/version/`

Версия библиотеки.

Пример ответа:

{
  "ruts": "0.8.0"
}

`GET` `/about/`

Описание проекта.

Пример ответа:

{
  "name": "ruts",
  "version": "0.8.0",
  "summary": "Russian Texts Statistics",
  "home_page": "https://github.com/SergeyShk/ruTS",
  "license": "MIT",
  "keywords": [
    "NLP,natural,language,processing,CL,computational,linguistics,text,analytics,russian"
  ],
  "author": "Шкарин Сергей",
  "author_email": "kouki.sergey@gmail.com"
}

`POST` `/extract/sents/`

Извлечение предложений из текста.

Пример запроса:

{
  "text": "Да. Времена изменились. Дети больше не слушаются своих родителей, и каждый пишет книги.",
  "min_len": 5,
  "max_len": 0
}

Аргументы:

Аргумент	Тип	Описание
`text`	str	Текст, для которого извлекаются предложения
`min_len`	int	Минимальная длина извлекаемого предложения
`max_len`	int	Максимальная длина извлекаемого предложения

Пример ответа:

[
  "Времена изменились.",
  "Дети больше не слушаются своих родителей, и каждый пишет книги."
]

`POST` `/extract/words/`

Извлечение слов из текста.

Пример запроса:

{
  "text": "Живет свободно только тот, кто находит радость в исполнении своего долга.",
  "filter_punct": true,
  "filter_nums": false,
  "use_lexemes": true,
  "stopwords": [
    "кто",
    "в",
    "тот"
  ],
  "lowercase": true,
  "ngram_range": [
    2,
    2
  ],
  "min_len": 0,
  "max_len": 0,
  "most_common": 0
}

Аргументы:

Аргумент	Тип	Описание
`text`	str	Текст, для которого извлекаются слова
`filter_punct`	bool	Фильтровать знаки препинания
`filter_nums`	bool	Фильтровать числа
`use_lexemes`	bool	Использовать леммы слов
`stopwords`	list[str]	Список стоп-слов
`lowercase`	bool	Конвертировать слова в нижний регистр
`ngram_range`	tuple[int, int]	Нижняя и верхняя граница размера N-грамм
`min_len`	int	Минимальная длина извлекаемого слова
`max_len`	int	Максимальная длина извлекаемого слова
`most_common`	int	Количество топ-слов

Пример ответа:

[
  "жить_свободно",
  "свободно_только",
  "только_находить",
  "находить_радость",
  "радость_исполнение",
  "исполнение_свой",
  "свой_долг"
]

`POST` `/bs/`

Вычисление основных статистик текста.

Пример запроса:

{
  "text": "Живет свободно только тот, кто находит радость в исполнении своего долга.",
  "normalize": false,
  "stat": ""
}

Аргументы:

Аргумент	Тип	Описание
`text`	str	Текст, для которого вычисляются статистики
`normalize`	bool	Вычислять нормализованные статистики
`stat`	str	Наименование конкретной статистики

Пример ответа:

{
  "c_letters": {
    "1": 1,
    "3": 2,
    "5": 2,
    "6": 2,
    "7": 2,
    "8": 1,
    "10": 1
  },
  "c_syllables": {
    "0": 1,
    "1": 2,
    "2": 4,
    "3": 3,
    "5": 1
  },
  "n_sents": 1,
  "n_words": 11,
  "n_unique_words": 11,
  "n_long_words": 6,
  "n_complex_words": 1,
  "n_simple_words": 9,
  "n_monosyllable_words": 2,
  "n_polysyllable_words": 8,
  "n_chars": 73,
  "n_letters": 61,
  "n_spaces": 10,
  "n_syllables": 24,
  "n_punctuations": 2
}

`POST` `/ms/`

Вычисление морфологических статистик текста.

Пример запроса:

{
  "text": "Живет свободно только тот, кто находит радость в исполнении своего долга.",
  "filter_none": true,
  "stats": [
    "pos",
    "case"
  ]
}

Аргументы:

Аргумент	Тип	Описание
`text`	str	Текст, для которого вычисляются статистики
`filter_none`	bool	Фильтровать пустые значения
`stats`	list[str]	Кортеж выбранных статистик

Пример ответа:

{
  "pos": {
    "VERB": 2,
    "ADVB": 2,
    "ADJF": 2,
    "NPRO": 1,
    "NOUN": 3,
    "PREP": 1
  },
  "case": {
    "nomn": 2,
    "accs": 1,
    "loct": 1,
    "gent": 2
  }
}

`POST` `/ms/explain/`

Разбор текста по морфологическим статистикам.

Пример запроса:

{
  "text": "Живет свободно только тот, кто находит радость в исполнении своего долга.",
  "filter_none": true,
  "stats": ["pos"]
}

Аргументы:

Аргумент	Тип	Описание
`text`	str	Текст, для которого вычисляются статистики
`filter_none`	bool	Фильтровать пустые значения
`stats`	list[str]	Кортеж выбранных статистик

Пример ответа:

[
  [
    "Живет",
    {"pos": "VERB"}
  ],
  [
    "свободно",
    {"pos": "ADVB"}
  ],
  [
    "только",
    {"pos": "ADVB"}
  ],
  [
    "тот",
    {"pos": "ADJF"}
  ],
  [
    "кто",
    {"pos": "NPRO"}
  ],
  [
    "находит",
    {"pos": "VERB"}
  ],
  [
    "радость",
    {"pos": "NOUN"}
  ],
  [
    "в",
    {"pos": "PREP"}
  ],
  [
    "исполнении",
    {"pos": "NOUN"}
  ],
  [
    "своего",
    {"pos": "ADJF"}
  ],
  [
    "долга",
    {"pos": "NOUN"}
  ]
]

`POST` `/ds/`

Вычисление метрик лексического разнообразия текста.

Пример запроса:

{
  "text": "Живет свободно только тот, кто находит радость в исполнении своего долга.",
  "stat": ""
}

Аргументы:

Аргумент	Тип	Описание
`text`	str	Текст, для которого вычисляются метрики
`stat`	bool	Наименование конкретной метрики

Пример ответа:

{
  "ttr": 1,
  "rttr": 3.3166247903554,
  "cttr": 2.345207879911715,
  "httr": 1,
  "sttr": 1,
  "mttr": 0,
  "dttr": 0,
  "mattr": 1,
  "msttr": 1,
  "mtld": 0,
  "mamtld": 1,
  "hdd": -1,
  "simpson_index": 0,
  "hapax_index": 0
}

`POST` `/rs/`

Вычисление метрик удобочитаемости текста.

Пример запроса:

{
  "text": "Живет свободно только тот, кто находит радость в исполнении своего долга.",
  "stat": ""
}

Аргументы:

Аргумент	Тип	Описание
`text`	str	Текст, для которого вычисляются метрики
`stat`	bool	Наименование конкретной метрики

Пример ответа:

{
  "flesch_kincaid_grade": 4.727272727272727,
  "flesch_reading_easy": 61.40772727272727,
  "coleman_liau_index": 6.7600454545454625,
  "smog_index": 8.891153770860452,
  "automated_readability_index": 6.7600454545454625,
  "lix": 65.54545454545455
}

`POST` `/datasets/scl/`

Корпус советских хрестоматий по литературе.

Пример запроса:

{
  "grade": 1,
  "book": "",
  "year": 1963,
  "category": "Зима",
  "text_type": "",
  "subject": "",
  "author": "",
  "min_len": 0,
  "max_len": 300,
  "limit": 5,
  "with_header": false
}

Аргументы:

Аргумент	Тип	Описание
`grade`	int	Уровень сложности текстов
`book`	str	Наименование книги
`year`	int	Год издания книги
`category`	str	Категория текстов
`text_type`	str	Тип текстов
`subject`	str	Наименование текстов
`author`	str	Автор текстов
`min_len`	int	Минимальная длина текста (в символах)
`max_len`	int	Максимальная длина текста (в символах)
`limit`	int	Количество текстов
`with_header`	bool	Выводить заголовок

Пример ответа:

[
  "Снежок порхает, кружится, на улицах бело, и превратились лужицы в прозрачное стекло.\nВ саду, где пели зяблики, сегодня — посмотри,— как розовые яблоки, на ветках снегири.",
  "Что за звёздочки сквозные на пальто и на платке, все сквозные, вырезные а возьмёшь — вода в руке?\nВ огне не горит, в воде не тонет.\nСкатерть бела, всё поле одела.",
  "Голый и холодный шумит лес.\nПлохо осенью в лесу белякам-зайцам.\nСквозь деревья далеко видна зимняя заячья шубка.\nПушистым снегом накрылись деревья, побелели лесные полянки.\nОбрадовались беляки-зайцы. Теперь никто не увидит их белую зимнюю шубку.",
  "Скоком-боком, боком-скоком ходит галка мимо окон.\nВетром вся взъерошена, снегом запорошена.",
  "Лучше всех в лесу лежебоке-медведю. С осени приготовил запасливый Мишка берлогу. Наломал мягких еловых веточек-лапок, надрал пахучей смолистой коры.\nТепло и уютно в медвежьей лесной квартире. Лежит Мишка, с боку на бок переворачивается. Не слышно ему, как подошёл к берлоге осторожный охотник."
]

`POST` `/datasets/sw/`

Полное собрание сочинений И.В. Сталина.

Пример запроса:

{
  "volume": 14,
  "year": 1937,
  "text_type": "Письмо",
  "is_translation": false,
  "source": "Книга \"Иосиф Сталин в объятиях семьи\"",
  "subject": "",
  "topic": "",
  "min_len": 0,
  "max_len": 300,
  "limit": 5,
  "with_header": true
}

Аргументы:

Аргумент	Тип	Описание
`volume`	int	Номер тома
`year`	int	Год издания книги
`text_type`	str	Тип текстов
`is_translation`	bool	Признак перевода
`source`	str	Первоначальный источник текстов
`subject`	str	Наименование текстов
`topic`	str	Наименование подраздела текстов
`min_len`	int	Минимальная длина текста (в символах)
`max_len`	int	Максимальная длина текста (в символах)
`limit`	int	Количество текстов
`with_header`	bool	Выводить заголовок

Пример ответа:

[
  {
    "volume": 14,
    "year": 1937,
    "type": "Письмо",
    "is_translation": false,
    "source": "Книга \"Иосиф Сталин в объятиях семьи\"",
    "subject": "Письмо матери (май 1937 года)",
    "topic": "",
    "text": "Маме – моей – привет!\nПрисылаю тебе шаль, жакетку и лекарства.\nЛекарства сперва покажи врачу, а потом прими их, потому что дозировку лекарства должен определять врач.\nЖиви тысячу лет, мама – моя!\nЯ здоров.\nТвой сын Coco.\nДети кланяются тебе.",
    "file": "/home/sergio/.cache/pypoetry/virtualenvs/ruts-api-vSgLUIMC-py3.8/lib/python3.8/site-packages/ruts_data/texts/stalin_works/volume_14/61"
  },
  {
    "volume": 14,
    "year": 1937,
    "type": "Письмо",
    "is_translation": false,
    "source": "Книга \"Иосиф Сталин в объятиях семьи\"",
    "subject": "Письмо матери 10 марта 1937 года",
    "topic": "",
    "text": "Маме – моей привет!\nКак живет, как чувствует себя мама – моя? Передают, что ты здорова и бодра. Правда это? Если это правда, то я бесконечно рад этому. Наш род, видимо, крепкий род.\nЯ здоров.\nМои дети тоже чувствуют себя хорошо.\nЖелаю здоровья, живи долгие годы, мама – моя.\nТвой Coco.\n10. III.37 г.",
    "file": "/home/sergio/.cache/pypoetry/virtualenvs/ruts-api-vSgLUIMC-py3.8/lib/python3.8/site-packages/ruts_data/texts/stalin_works/volume_14/59"
  }
]

SergeyShk/ruTS-API

ruTS-API

REST API

GET /version/

GET /about/

POST /extract/sents/

POST /extract/words/

POST /bs/

POST /ms/

POST /ms/explain/

POST /ds/

POST /rs/

POST /datasets/scl/

POST /datasets/sw/

`GET` `/version/`

`GET` `/about/`

`POST` `/extract/sents/`

`POST` `/extract/words/`

`POST` `/bs/`

`POST` `/ms/`

`POST` `/ms/explain/`

`POST` `/ds/`

`POST` `/rs/`

`POST` `/datasets/scl/`

`POST` `/datasets/sw/`