Sistema de Recomendação Híbrido

Sistema de recomendação híbrido implementado utilizando a estrutura de WebService RESTful. Esse sistema é o resultado do trabalho de conclusão de curso de Sistemas de Informação do IFES - Campus Cachoeiro de Itapemirim no ano de 2020/2021.

Arquitetura do sistema

O sistema foi desenvolvido no formato de API RESTful, onde os dados são transmitidos e enviados no formato JSON. O sistema pode ser utilizado em conjunto com outras aplicações clientes para manuseio e visualização dos dados. Inicialmente o sistema foi pensado para utilização na seguinte arquitetura:

Os outros componentes da arquitetura podem ser acessados pelos seguintes repositórios:

• Cliente de Recomendação
• Cliente Administrativo

Além disso, existe também alguns clientes de recomendação específicos:

• Cliente de Recomendação de Músicas

Funcionalidades

O principal intuito do sistema é oferecer um serviço de recomendação genérico que oferece os seguintes tipos de recomendação:

• Filtragem Colaborativa
• Filtragem Baseada em Conteúdo
• Filtragem Híbrida (Ponderada e Mista)

Com os dados devidamente cadastrados (mostrados nos tópicos abaixo), é possível realizar o processo de recomendação passando os seguintes parâmetros:

• Precisão das notas de recomendação (escala decimal de 0 a 5 caracteres)
• Nota de corte (Para definição do ponte de corte das notas)
• Tipo de algoritmo e abordagem utilizada.

Abordagens de Recomendação

O sistema prove algumas formas para geração da recomendação. Essas abordagens possibilitam formas de geração da recomendação utilizando recursos voltados para melhor performance, como concorrência e uso de matrizes de recomendação offline.

OBS: Vale ressaltar que a recomendação offline só estará disponível após a realização de recomendações normais (processadas em tempo de requisição) e a concorrência só estará disponível para as recomendações híbridas.

Documentação

Requisições da API

As requisições da API estão documentadas no Postman para consulta, elas podem ser encontradas no seguinte link:

Documentação da API

Diagrama de classes

Segue abaixo a representação das classes do sistema na linguagem UML:

Utilização Básica do sistema

Requisitos básicos

Para utilização do sistema é necessário possuir o ambiente de desenvolvimento JAVA na versão 14 instalado em sua máquina, juntamente de um banco de dados (por padrão é utilizado o PostgreSQL na versão 12).

Instalação do sistema

Para uso do sistema basta clonar esse repositório com o seguinte comando:

git clone [email protected]:herikLorencao/srh-backend.git

Além disso, é necessário a criação de um base de dados no banco com o nome srh para o registro dos dados do sistema.

Após esses passos, basta executar a aplicação usando uma IDE de preferência ou o próprio Maven.

OBS: Na primeira execução do projeto no arquivo resources/application-dev.properties deixe a opção spring.jpa.hibernate.ddl-auto com o valor create para cadastro dos itens iniciais para uso da API. Para as outras execuções deixe a opção como update para que a base de dados não seja perdida.

Configuração e cadastro dos dados

Para a realização da recomendação é necessário o cadastro de alguns dados, em um fluxo simplificado, o cadastro pode ser feito seguindo a seguinte ordem:

• Cadastro do projeto
• Cadastro dos usuários
• Cadastro dos itens
• Vínculo dos usuários ao projeto
• Avaliação de itens por parte dos usuários
• Processo de recomendação

Dados de acesso a API

Para conexão básica na API e obtenção dos tokens JWT já estão disponíveis dois usuários por padrão na plataforma. Os dados abaixo pode ser usados para geração do token:

• Perfil administrador:

{
  "login": "admin",
  "password": "123456"
}

• Perfil de recomendação

{
  "login": "client",
  "password": "123456"
}