Merge pull request #81 from lappis-unb/devel

0.4.2

README.md

@@ -17,7 +17,7 @@ Este projeto teve como base a [Tais](http://github.com/lappis-unb/tais).
 
 O usuário interage com a Boilerplate via RocketChat ou Telegram, que manda as mensagens para o Rasa NLU através de
 conectores, onde ele identifica a *intent*, e responde pelo Rasa Core, de acordo com as *stories* e *actions*.  
-As *models* utilizadas para a conversação foram geradas pelo módulo *trainer* e depois transferidas para o bot, estes 
+As *models* utilizadas para a conversação foram geradas pelo módulo *trainer* e depois transferidas para o bot, estes
 modelos podem ser versionados e evoluídos entre bots.  
 Os notebooks avaliam o funcionamento de acordo com o formato das *intents* e *stories*.
 O elasticsearch coleta os dados da conversa e armazena para a análise feita pelo kibana, que gera gráficos para
@@ -147,8 +147,16 @@ sudo docker-compose run --rm coach make train-online
 
 ## Analytics
 
+Para a análise dos dados das conversas com o usuário, utilize o kibana, e veja como os usuários estão interagindo com o bot, os principais assuntos, média de usuários e outras informações da análise de dados.
+As mensagens são inseridas no *cluster* do Elastic Search utilizando o *broker* RabbitMQ.
+
 ### Setup
 
+
+#### Setup ElasticSearch
+
+Para subir o ambiente do ElasticSearch rode os seguintes comandos:
+
 ```
 sudo docker-compose up -d elasticsearch
 sudo docker-compose run --rm -v $PWD/analytics:/analytics bot python /analytics/setup_elastic.py
@@ -161,6 +169,7 @@ ENVIRONMENT_NAME=localhost
 BOT_VERSION=last-commit-hash
 ```
 
+
 #### Setup RabbitMQ
 
 Inicie o serviço do servidor do RabbitMQ:
@@ -221,14 +230,30 @@ BROKER_PASSWORD=admin
 QUEUE_NAME=bot_messages
 ```
 
-### Visualização
+
+#### Visualizações (Kibana)
+
+O Kibana nos auxilia com uma interface para visualizar os dados armazenados nos índices do ElasticSearch.
 
 ```
 sudo docker-compose up -d kibana
 ```
 
 Você pode acessar o kibana no `locahost:5601`
 
+
+#### Para visualização dos Dashboards padrão
+
+Já estão disponíveis dois **dashboards** para a análise de algumas [métricas importante](https://github.com/lappis-unb/tais/wiki/Estudo-sobre-metricas-para-bots) para o desenvolvimento e monitoramento de chatbots.
+
+Para usar estes _templates_ execute os seguintes passos:
+
+* Suba o container do **Kibana** e acesse `http://locahost:5601`;
+* Na interface, acesse `Management` e clique em `Saved Objects`;
+* Clique em `Import`;
+* Utilize o arquivo `export.json` na pasta `analytics/elasticsearch/` do projeto.
+
+
 ## Testando Fluxos de Conversa
 
 É possível testar os fluxos de conversação utilizando o [Evaluation do Rasa Core](https://github.com/lappis-unb/tais/wiki/Testes-Automatizados). Para testá-los no seu bot basta adicionar um arquivo dentro do diretório `bot/e2e/` com as histórias a serem testadas. Essas histórias devem ser descritas normalmente, porém com exemplos de frases para cada uma das *Intents* sendo testadas, segundo o formato abaixo:
@@ -281,7 +306,7 @@ sudo docker-compose up -d bot
 
 # Como conseguir ajuda
 
-Parte da documentação técnica do framework da Tais está disponível na 
+Parte da documentação técnica do framework da Tais está disponível na
 [wiki do repositório](https://github.com/lappis-unb/tais/wiki). Caso não encontre sua resposta, abra uma issue
 com a tag `duvida` que tentaremos responder o mais rápido possível.
 

bot/e2e/e2e_stories.md

@@ -7,13 +7,59 @@
 ## end-to-end story 2
 * cumprimentar: oi
    - utter_cumprimentar
-* time: qual o melhor time do brasil
+* time: que time vc torce?
    - utter_time
-* despedir: Tchau
+* negar: não
    - utter_despedir
 
 ## end-to-end story 3
 * cumprimentar: oi
    - utter_cumprimentar
+* bff: quem é seu best friend?
+   - utter_bff
+* negar: não
+   - utter_despedir
+
+## end-to-end story 4
+* tudo_bem: tudo bem?
+   - utter_tudo_bem
+* negar: não
+   - utter_despedir
+
+## end-to-end story 5
+* cumprimentar: Oi
+   - utter_cumprimentar
 * license: posso copiar voce
-   - utter_license
+   - utter_license
+* diga_mais: como funciona?
+   - utter_diga_mais
+* despedir: até mais
+   - utter_despedir
+
+## end-to-end story 6
+* playlist: me indica uma música?
+   - utter_playlist
+* negar: não
+   - utter_despedir
+
+## end-to-end story 7
+* comida: qual comida você me sugere?
+   - utter_comida
+* negar: não
+   - utter_despedir
+
+## end-to-end story 8
+* cumprimentar: Oi
+   - utter_cumprimentar
+* de_onde_voce_eh: de onde você é?
+   - utter_de_onde_voce_eh
+* relationship: Gosta de alguém?
+   - utter_relationship
+* negar: não
+   - utter_despedir
+
+## end-to-end story 9
+* risada: risos
+   - utter_risada
+* negar: não
+   - utter_despedir