README-RU.md

neurojs

Неофициальная библиотека для взаимодействия с Yandex Neuro API, которая поддерживает работу с JavaScript, TypeScript, а так же имеет некоторые встроенные типы для Typebox.

Warning

Библиотека создана исключительно в исследовательских целях и не предназначена для коммерческого использования. Все права на оригинальное программное обеспечение принадлежат их правообладателям. Библиотека не связана с оригинальными правообладателями

Функционал

На данный момент, библиотека поддерживает работу с:

• суммаризацией видео с YouTube
• получением ссылок на суммаризацию статей (оф. апи, требует API-ключ)

Необходимый функционал для 1.0.0:

• Поддержка суммаризации видео с YouTube
• Поддержка суммаризации статей и текста
• Создание и добавление поддержки neuro-worker (аналог vot-worker для этого апи)

Установка

Warning

Чтобы библиотека работала с Node.js или с браузером вам нужно выполнить дополнительную настройку. Все примеры можно увидеть здесь

Установка библиотеки с помощью Bun:

bun install @toil/neurojs

Установка библиотеки с помощью Node:

npm install @toil/neurojs

Начало работы

Для начала работы с API необходимо создать NeuroClient. Это можно сделать с помощью пары строчек представленных ниже.

Стандартный клиент:

const client = new NeuroClient();
const result = await client.summarizeVideo({
  url: "...",
  language: "en",
});

Больше примеров кода вы можете увидеть здесь

Сборка

Для сборки необходимо наличие:

• Bun
• Protoc (если собираете с обновлением .proto файла)

Не забудьте установить зависимости:

bun install

Запустите сборку:

bun build:all

Сборка без обновления proto и генерации документации:

bun build:skip-proto

Тесты

Библиотека имеет минимальное покрытие тестами для проверки ее работоспособности.

Запустить тесты:

bun test