Personal Assistant

English:

The Personal Assistant puts together diferent tools for Natural Language Understanding and manages the negotiation between diferent people.

For examples of use case in english using Slack, see the videos from the links below.

https://www.youtube.com/watch?v=b4FkjeTk4yI https://youtu.be/kf88aMDhzOA

Portuguese:

O Personal Assistant reúne diferentes ferramentas de reconhecimento de linguagem natural e realiza a negociação entre diferentes pessoas para marcar um compromisso!

Para ver exemplos de casos de uso em português no Slack, veja os vídeos dos links abaixo.

https://www.youtube.com/watch?v=_MivRI66NpY&t=3s https://youtu.be/VyQszjScvt4

Getting Started

Install the used packages with Pipenv

See used packages in Pipfile. To install pipenv see: https://github.com/pypa/pipenv

To create a project environment with python 3.7 use:

pipenv --python 3.7

Enter the pipenv shell with:

pipenv shell

To install the packages from the Pipfile use:

pipenv install

Create de DB with PostgreSQL

Download PostgreSQL (10.7). [https://www.postgresql.org]

At the root folder, execute:

psql -f db/create_database.sql

External services

- Watson Assistant

External services will also require specific keys. Right now, that's just for "Watson Assistant".

- Natural Language Tool Kit (NLTK)

The corpora being used are:

• omw
• wordnet
• wordnet_ic
• punkt
• stopwords

To download them use (as described on https://www.nltk.org/data.html):

$ python3
>>> import nltk
>>> nltk.download(<corpus_name>)

- spaCy

To download the spacy model being used currently, use (as described on https://spacy.io/models/en):

python -m spacy download en_core_web_sm

- CoGroo

To pull the CoGroo submodule with git, see http://openmetric.org/til/programming/git-pull-with-submodule/.

To run CoGroo locally, clone it from https://github.com/gpassero/cogroo4py and at its root folder, run:

java -jar cogroo4py.jar

Run the tests using pytest

To run the tests from the pipenv shell use:

python -m pytest -v tests/<module_test>/<name_test>.py 

To run a single test from within a module use:

python -m pytest -v tests/<module_test>/<name_test>.py -k "<single_test>" 

About the Deploy

Deployment is currently being done on Heroku. To see Heroku's logs use:

heroku logs --tail

To access Heroku's database use:

heroku pg:psql

Authors

• Mateus R. Vendramini
• Ricardo C. C. Imagure

See also the list of contributors who participated in this project.

License

Acknowledgments

• Helped by:
  • Bruno Tinen
• Oriented by:
  • Marcos R. P. Barreto
• Also helped by the work from:
  • Erich Natsubori Sato
  • Nicolas Silverio Figueiredo