Skip to content

1. Домашнє завдання №1

Jump to bottom
sininni edited this page May 17, 2021 · 23 revisions

Table of Contents

Опис проблеми

Головна проблема, яку ми вирішуємо, — це складність прийняття рішення щодо вибору книги. Оскільки для успішного вибору потрібно прочитати безліч відгуків на різних вебсайтах, переглянути відеоогляди. Через брак єдиного місця, де зібрана актуальна та корисна інформація про книжки, користувачу потрібно вручну преключатись між різними вебсайтами, і на кожному з них пробувати знайти щось, що допоможе їм у прийнятті правильного рішення.

Ми пропонуємо вирішення цієї проблеми - вебсайт для надання корисної інформації про книгу.

Користувач зможе увести назву книги, і у відповідь отримати позитивні та негативні відгуки з платформи Goodreads відібрані за допомогою власного алгоритму,рейтинг книги, тираж, доступні переклади, посилання на YouTube відеоогляди, тощо.

Для отримання найкорисніших відгуків ми беремо сотні відгуків із сайту Goodreads та аналізуємо їх за допомогою системи обробки природної мови NLP(Natural language Processing).

Вимога на систему

Спонсор проекту (Project Sponsor)

  • Устим Ганик
Бізнес потреба (Business Need)
  • створення зручної системи для пошуку інформації про потрібний твір
  • автоматичний збір даних одразу з кількох джерел
  • полегшення формування рішення для користувача на рахунок твору (легко робити висновки про популярність книги, визнання)
  • можливість отримання посилань на відгуки про твір у різних форматах та від різних людей (текст/відео, звичайні люди/книжкові блогери/знаменитості)
  • можливість отримання найрелевантніших відгуків з GoodReads
Бізнес вимоги (Business Requirements)
  • накопичує дані про книги
  • забезпечує каталог творів
  • дозволяє користувачу шукати інформацію в каталозі, пов’язану з необхідною книгою за її назвою чи описом, та переглядати отримані дані:
  + рейтинг книги та кількість оглядів на Amazon та GoodReads
  + посилання на відео огляди книги на YouTube*
  + рекомендації від відомих людей*
  + наявність у книги нагород та їх перелік* 
  + кількість іноземних перекладів*

* - за наявності

Питання та обмеження (Special Issues or Constraints)

  • реченець розробки – 17 травня 2021 року
  • усі функції застосунку працюватимуть виключно для англійської мови

Опис функціональних можливостей API

Goodreads API

Щоб знайти якомога більше корисної інформації щодо книги ми будемо користуватись інформацією великої онлайн бібліотеки GoodReads для цього нам потрібне використання Goodreads API. Дане API має широкий функціонал, який більш детальніше представлений нижче. Функціональні можливості Goodreads API :

  • Отримати ID книги яке використовується в Goodreads API за рахунок ISBN (International Standard Book Number) .
  • За допомогою цього ID можна доступитись до всієї інформації щодо книги : Повна назва, автор, кількість сторінок, відгуки про книгу.
  • За допомогою цього ID можна доступитись до всієї інформації щодо автора : повне ім’я автора, кількість робіт, перелік написаних книжок.
  • За допомогою ID користувача або його користувацьким ім’ям можна дізнатись : про його профіль, про книжки які він придбав, відгуки на прочитані книги.

YouTube Data API v3

Для роботи з відео-хостингом YouTube, зокрема для пошуку оглядів книг, ми плануємо використовувати YouTube Data API v3. Документація цього API доступна за посиланням.

YouTube Data API v3 вводить типи ресурсів, з якими користувач API може взаємодіяти. Деякі типи ресурсів:

  • activity,
  • caption,
  • channel,
  • video,
  • comment,
  • search,
  • subscription.
API може надавати такі методи для взаємодії з цими ресурсами:
  • list,
  • insert,
  • update,
  • delete та ін.
Для кожного доступного методу кожного ресурсу є свій ENDPOINT та тип HTTP-запиту. Для роботи з API потрібен API ключ, який можна отримати у Google Developer Console. Також, деякі запити (наприклад, для видалення відео) потребують OAuth 2.0 token для авторизації, але він нам скоріш за все не знадобиться.

YouTube Data API v3 обмежує кількість запитів. Кожен запит до API коштує щонайменше один quota unit. Для звичайного безкоштовного користування надається 10000 quota unit’ів на день. Пошуковий запит (метод list ресурсу search) коштує 100 quota unit’ів. Отже, щодня можна здійснити не більше ніж 100 запитів пошуку.

Скоріш за все нам знадобляться наступні методи та ресурси:

  • метод list ресурсу search - здійснює пошук за рядком
  • метод list ресурсу video - дозволяє отримати інформацію (назва, опис, теги та ін.) про відео.

Сценарій роботи колективу

Організація спільної роботи

Нами буде використано метод «Спільного репозитарію». Кожен з членів команди розробників має доступ та права на внесення змін у репозитарій. Для розмежування версій та змін використовуються гілки (branches).

Розподіл задач

  • web-page – розробка веб сторінки для отримання інформації про книгу за її назвою – Устим.
  • опрацювання Goodreads API – обробка даних, та виведення потрібної для користувача інформації – Дмитро, Богдан.
  • опрацювання YouTube API – пошук оглядів на книгу за її назвою – Богдан.
  • NLP – обробка певної вибірки відгуків до книги та відображення найкорисніших для користувача – Дарина, Надя.
Clone this wiki locally