first commit

.gitignore/.gitignore

@@ -1 +1,2 @@
-foo.bar
+*.tar.gz
+*.pyc

README

@@ -0,0 +1,8 @@
+
+rasa run actions
+
+rasa run --credentials ./credentials.yml  --enable-api --auth-token XYZ123 --model ./models --endpoints ./endpoints.yml --cors "*"
+
+python3 server.py
+
+Open localhost:8080 in browser.

actions/actions.py

@@ -0,0 +1,195 @@
+# This files contains your custom actions which can be used to run
+# custom Python code.
+#
+# See this guide on how to implement these action:
+# https://rasa.com/docs/rasa/custom-actions
+
+
+# This is a simple example for a custom action which utters "Hello World!"
+
+# from typing import Any, Text, Dict, List
+#
+# from rasa_sdk import Action, Tracker
+# from rasa_sdk.executor import CollectingDispatcher
+#
+#
+# class ActionHelloWorld(Action):
+#
+#     def name(self) -> Text:
+#         return "action_hello_world"
+#
+#     def run(self, dispatcher: CollectingDispatcher,
+#             tracker: Tracker,
+#             domain: Dict[Text, Any]) -> List[Dict[Text, Any]]:
+#
+#         dispatcher.utter_message(text="Hello World!")
+#
+#         return []
+
+from typing import Any, Text, Dict, List
+import json
+import requests
+import sqlite3
+import textwrap
+
+
+from rasa_sdk import Action, Tracker
+from rasa_sdk.events import UserUtteranceReverted
+from rasa_sdk.executor import CollectingDispatcher
+
+class ActionDefaultFallback(Action):
+    """Executes the fallback action and goes back to the previous state
+    of the dialogue"""
+
+    con = None
+
+    def name(self) -> Text:
+        con = sqlite3.connect("./reviews.db")
+        self.cur = con.cursor()
+        return "zir_action_fallback"
+
+    async def run(
+        self,
+        dispatcher: CollectingDispatcher,
+        tracker: Tracker,
+        domain: Dict[Text, Any],
+    ) -> List[Dict[Text, Any]]:
+
+        number_results = 3
+        data_dict = {
+            "query": [
+                {
+                    "query": tracker.latest_message["text"],
+                    "num_results": number_results,
+                    "corpus_key": [
+                        {
+                            "customer_id": "1526022105",
+                            "corpus_id": 40
+                        }
+                    ]
+                }
+            ]
+        }
+        header = {
+            "customer-id": "1526022105",
+            "x-api-key": "zqt_WvU_2atFHgqYxxT2sQswwIUgogI8K3QeWs0oqA"
+        }
+        payload = json.dumps(data_dict)
+        response = requests.post(f"https://h.serving.zir-ai.io:443/v1/query",
+                                 data=payload,
+                                 verify=True,
+                                 headers=header,
+                                 timeout=10)
+        parsed = json.loads(response.text)
+        first_resp = parsed["responseSet"][0]["response"][0]
+        last_resp = parsed["responseSet"][0]["response"][-1]
+        textQuery = []
+        print(last_resp["score"])
+        print(first_resp["score"])
+        if last_resp["score"] < 0.3 or first_resp["score"] < 0.3:
+            textQuery.append("I'm sorry, I can't help you.")
+        else:
+            textQuery = print_responses(parsed["responseSet"][0], self.cur)
+            # items = [d['text'] for d in parsed["responseSet"][0]["response"]]
+            textQuery.insert(0, "\n" )
+            textQuery.insert(0, "This is what i found in the reviews:" )
+        textQuery = "\n".join(textQuery)
+        dispatcher.utter_message(text=textQuery)
+        # Revert user message which led to fallback.
+        return [UserUtteranceReverted()]
+
+
+def print_responses(response_set, sqlite_cursor):
+    """Print responses to the console."""
+    textList = []
+    for result in response_set["response"]:
+        doc = response_set["document"][result["documentIndex"]]
+        query = f"""
+            SELECT title, date, hotel, review FROM reviews
+                WHERE doc_id="{doc["id"]}"
+        """
+        for row in sqlite_cursor.execute(query):
+            title, date, hotel, fulltext = row
+            textList.append("**" + title + "**")
+            if is_title(result):
+                textList.append(f"{head(fulltext)}")
+            else:
+                t = result["text"]
+                textList.append(f"{highlight(fulltext, t)}")
+            textList.append("*" + f"{hotel_name(hotel)} reviewed on {date}" + "*")
+            textList.append("\n")
+            break
+    return textList
+
+def hotel_name(hotel):
+    """Returns a human-readable name for a hotel."""
+    if hotel == "sheraton_fisherman_s_wharf_hotel":
+        return "Sheraton Fisherman's Wharf Hotel"
+    if hotel == "the_westin_st_francis":
+        return "The Westin St. Francis San Francisco on Union Square"
+    if hotel == "best_western_tuscan_inn_fisherman_s_wharf_a_kimpton_hotel":
+        return "Best Western Fishermans Wharf"
+    return hotel
+
+
+def highlight(fulltext, snippet):
+    """Return a result snippet with context, suitable for terminal display."""
+    if snippet in fulltext:
+        start = fulltext.index(snippet)
+        end = start + len(snippet)
+
+        lines = textwrap.wrap(fulltext)
+        start_line = 0
+        end_line = len(lines)
+        pos = 0
+
+        # Figure out which lines to display, and insert ANSI
+        # code to highlight the actual snippet.
+        for x, line in enumerate(lines):
+            next_pos = pos + len(line)
+
+            color_start = pos <= start < next_pos
+            color_end = pos <= end < next_pos
+
+            if color_start and color_end:
+                start_line = end_line = x
+                ips = start - pos - x   # insertion point
+                ipe = end - pos - x     # insertion point
+                lines[x] = line[:ips] + "**" + line[ips:ipe] + \
+                    "**" + line[ipe:]
+            elif color_start:
+                start_line = x
+                ip = start - pos - x    # insertion point
+                lines[x] = line[:ip] + "**" + line[ip:]
+            elif color_end:
+                end_line = x
+                ip = end - pos - x    # insertion point
+                lines[x] = line[:ip] + "**" + line[ip:]
+
+            pos = next_pos
+
+        # Widen the line selection to include a bit of context.
+        if start_line > 0:
+            start_line -= 1
+        end_line += 2
+        return prettify('\n'.join(lines[start_line:end_line]))
+    return prettify(snippet)
+
+
+def head(fulltext):
+    """Returns the first three lines of the review."""
+    lines = textwrap.wrap(fulltext)
+    return prettify('\n'.join(lines[0:3]) + '...')
+
+
+def is_title(result):
+    """Returns true if the result is a title match."""
+    for metadatum in result["metadata"]:
+        if metadatum["name"] == "is_title":
+            return metadatum["value"] == "true"
+    return False
+
+
+def prettify(text):
+    """Clean up the text to make it more suitable for display."""
+    return text.replace("&amp;", "&").replace("&quot;", "\"")

config.yml

@@ -0,0 +1,39 @@
+# Configuration for Rasa NLU.
+# https://rasa.com/docs/rasa/nlu/components/
+language: en
+
+pipeline:
+# # No configuration for the NLU pipeline was provided. The following default pipeline was used to train your model.
+# # If you'd like to customize it, uncomment and adjust the pipeline.
+# # See https://rasa.com/docs/rasa/tuning-your-model for more information.
+  - name: SpacyNLP
+  - name: SpacyTokenizer
+  - name: SpacyFeaturizer
+  - name: RegexFeaturizer
+  - name: LexicalSyntacticFeaturizer
+  - name: CountVectorsFeaturizer
+  - name: CountVectorsFeaturizer
+    analyzer: "char_wb"
+    min_ngram: 1
+    max_ngram: 4
+  - name: DIETClassifier
+    epochs: 100
+  - name: EntitySynonymMapper
+  - name: ResponseSelector
+    epochs: 100
+  - name: FallbackClassifier
+    threshold: 0.6
+    ambiguity_threshold: 0.1
+
+# Configuration for Rasa Core.
+# https://rasa.com/docs/rasa/core/policies/
+policies:
+# # No configuration for policies was provided. The following default policies were used to train your model.
+# # If you'd like to customize them, uncomment and adjust the policies.
+# # See https://rasa.com/docs/rasa/policies for more information.
+#   - name: MemoizationPolicy
+#   - name: RulePolicy
+#   - name: TEDPolicy
+#     max_history: 5
+#     epochs: 100
+#     constrain_similarities: true

credentials.yml

@@ -0,0 +1,33 @@
+# This file contains the credentials for the voice & chat platforms
+# which your bot is using.
+# https://rasa.com/docs/rasa/messaging-and-voice-channels
+
+rest:
+#  # you don't need to provide anything here - this channel doesn't
+#  # require any credentials
+
+
+#facebook:
+#  verify: "<verify>"
+#  secret: "<your secret>"
+#  page-access-token: "<your page access token>"
+
+#slack:
+#  slack_token: "<your slack token>"
+#  slack_channel: "<the slack channel>"
+#  slack_signing_secret: "<your slack signing secret>"
+
+#socketio:
+#  user_message_evt: <event name for user message>
+#  bot_message_evt: <event name for bot messages>
+#  session_persistence: <true/false>
+
+#mattermost:
+#  url: "https://<mattermost instance>/api/v4"
+#  token: "<bot token>"
+#  webhook_url: "<callback URL>"
+
+# This entry is needed if you are using Rasa X. The entry represents credentials
+# for the Rasa X "channel", i.e. Talk to your bot and Share with guest testers.
+rasa:
+  url: "http://localhost:5002/api"

data/nlu.yml

@@ -0,0 +1,100 @@
+version: "2.0"
+
+nlu:
+- intent: greet
+  examples: |
+    - hey
+    - hello
+    - hi
+    - hello there
+    - good morning
+    - good evening
+    - moin
+    - hey there
+    - let's go
+    - hey dude
+    - goodmorning
+    - goodevening
+    - good afternoon
+
+- intent: goodbye
+  examples: |
+    - good afternoon
+    - cu
+    - good by
+    - cee you later
+    - good night
+    - bye
+    - goodbye
+    - have a nice day
+    - see you around
+    - bye bye
+    - see you later
+
+- intent: affirm
+  examples: |
+    - yes
+    - y
+    - indeed
+    - of course
+    - that sounds good
+    - correct
+
+- intent: deny
+  examples: |
+    - no
+    - n
+    - never
+    - I don't think so
+    - don't like that
+    - no way
+    - not really
+
+- intent: ask_location
+  examples: |
+    - Where is the hotel? 
+    - The hotel is where? 
+    - In which city is the hotel? 
+
+- intent: jumeirah_living
+  examples: |
+    - What is Jumeirah Living?
+    - Is Jumeirah Living a package?
+    - What can yo tell of Jumeirah Living?
+    - Jumeirah Living?
+    - Jumeirah?
+
+- intent: jumeirah_one
+  examples: |
+    - What is Jumeirah One?
+    - Is Jumeirah One a package?
+    - What can yo tell of Jumeirah One?
+    - Jumeirah One?
+    - Jumeirah?
+
+- intent: lost_and_found
+  examples: |
+    - What is your policy on list and found items?
+    - I lost something, can it be returned?
+    - Luggage lost
+    - Lost my phone.
+    - Return a lost items?
+
+- intent: jumeirah
+  examples: |
+    - What is Jumeirah?
+    - Is Jumeirah a hotel or a brand?
+
+- intent: reservations
+  examples: |
+    - How many rooms do you have?
+    - i want to reserve rooms
+    - Rooms available
+    - Book a room
+    - Need a place to stay for the night
+
+- intent: out_of_scope
+  examples: |
+    - I want to order food
+    - What is 2 + 2?
+    - Who's the US President?

data/rules.yml

@@ -0,0 +1,18 @@
+version: "2.0"
+
+rules:
+
+- rule: Say goodbye anytime the user says goodbye
+  steps:
+  - intent: goodbye
+  - action: utter_goodbye
+
+- rule: Ask the user to rephrase whenever they send a message with low NLU confidence
+  steps:
+  - intent: nlu_fallback
+  - action: zir_action_fallback
+    
+- rule: out of scope
+  steps:
+  - intent: out_of_scope
+  - action: zir_action_fallback

data/stories.yml

@@ -0,0 +1,38 @@
+version: "2.0"
+
+stories:
+
+- story: faq question
+  steps:
+   - intent: greet
+   - action: utter_greet
+   - intent: reservations
+   - action: utter_reservation
+
+- story: faq jum liv
+  steps:
+   - intent: greet
+   - action: utter_greet
+   - intent: jumeirah_living
+   - action: utter_jum_liv
+     
+- story: faq jum one
+  steps:
+   - intent: greet
+   - action: utter_greet
+   - intent: jumeirah_one
+   - action: utter_jum_one
+     
+- story: faq jum
+  steps:
+   - intent: greet
+   - action: utter_greet
+   - intent: jumeirah
+   - action: utter_jum
+     
+- story: faq lost
+  steps:
+   - intent: greet
+   - action: utter_greet
+   - intent: lost_and_found
+   - action: utter_lost_found

domain.yml

@@ -0,0 +1,55 @@
+version: "2.0"
+
+intents:
+  - greet
+  - goodbye
+  - affirm
+  - deny
+  - jumeirah_living
+  - jumeirah_one
+  - lost_and_found
+  - jumeirah
+  - reservations
+  - ask_location
+
+responses:
+  utter_please_rephrase:
+  - text: Sorry I didn't get that. Can you rephrase?
+    
+  utter_greet:
+  - text: "Hey! How are you?"
+
+  utter_cheer_up:
+  - text: "Here is something to cheer you up:"
+    image: "https://i.imgur.com/nGF1K8f.jpg"
+
+  utter_did_that_help:
+  - text: "Did that help you?"
+
+  utter_happy:
+  - text: "Great, carry on!"
+
+  utter_goodbye:
+  - text: "Bye"
+    
+  utter_reservation:
+  - text: "Please go to 'Check Rates & Book Now' section of the hotel you have a reservation for. You will find and an area called 'Cancellations and Amendments'. For all other amendments and cancellations, email or call our Reservations Office."
+
+  utter_jum_liv:
+  - text: "Jumeirah Living is our luxury brand of residences and serviced apartments. Whether for short, mid-term or extended stays, Jumeirah Living will offer innovative yet personal lifestyle experiences unique to each guest, resident and owner, with a strong emphasis on effortless living."
+
+  utter_jum_one:
+  - text: "Jumeirah One is Jumeirah’s loyalty programme designed to recognise and reward loyal guests of Jumeirah. Guests can enjoy more of life’s pleasures with privileged access to an exclusive global lifestyle."
+    
+  utter_lost_found:
+  - text: "Should any guests lose personal belongings whilst staying at a Jumeirah Hotel or Resort in Dubai, if recovered, the item will be recorded as 'found' by that particular property. Each property keeps detailed records of all 'found' items and will store these for a maximum of three months. After this period, in line with the directives of the General Department of Criminal Investigation in Dubai, all unclaimed items will be handed over to the nearest Police Station. These 'found' items will then be kept at the police warehouse for a further three months after which they will be auctioned, and any funds raised given to charity.Should hotel guests need to locate any item after the initial three month period expires, they are requested to contact the hotel who will assist in coordinating with the police station where the found items are handed over. The police will then advise the necessary procedures to locate any item."
+      
+  utter_jum:
+  - text: "Jumeirah is a world-class international hotel and hospitality company which currently manages hotels in  Abu Dhabi, Bahrain, Dubai, Frankfurt, Kuwait, London, Maldives, Mallorca and Shanghai. Please view our Portfolio for more information."
+    
+session_config:
+  session_expiration_time: 60
+  carry_over_slots_to_new_session: true
+
+actions:
+  - zir_action_fallback

endpoints.yml

@@ -0,0 +1,42 @@
+# This file contains the different endpoints your bot can use.
+
+# Server where the models are pulled from.
+# https://rasa.com/docs/rasa/model-storage#fetching-models-from-a-server
+
+#models:
+#  url: http://my-server.com/models/default_core@latest
+#  wait_time_between_pulls:  10   # [optional](default: 100)
+
+# Server which runs your custom actions.
+# https://rasa.com/docs/rasa/custom-actions
+
+action_endpoint:
+ url: "http://0.0.0.0:5055/webhook"
+
+# Tracker store which is used to store the conversations.
+# By default the conversations are stored in memory.
+# https://rasa.com/docs/rasa/tracker-stores
+
+#tracker_store:
+#    type: redis
+#    url: <host of the redis instance, e.g. localhost>
+#    port: <port of your redis instance, usually 6379>
+#    db: <number of your database within redis, e.g. 0>
+#    password: <password used for authentication>
+#    use_ssl: <whether or not the communication is encrypted, default false>
+
+#tracker_store:
+#    type: mongod
+#    url: <url to your mongo instance, e.g. mongodb://localhost:27017>
+#    db: <name of the db within your mongo instance, e.g. rasa>
+#    username: <username used for authentication>
+#    password: <password used for authentication>
+
+# Event broker which all conversation events should be streamed to.
+# https://rasa.com/docs/rasa/event-brokers
+
+#event_broker:
+#  url: localhost
+#  username: username
+#  password: password
+#  queue: queue

requirements.txt

@@ -0,0 +1,2 @@
+sqlite3
+textwrap

server.py

@@ -0,0 +1,13 @@
+import http.server
+import socketserver
+import os
+
+PORT = 8080
+
+web_dir = os.path.join(os.path.dirname(__file__), 'web')
+os.chdir(web_dir)
+
+Handler = http.server.SimpleHTTPRequestHandler
+httpd = socketserver.TCPServer(("0.0.0.0", PORT), Handler)
+print("serving at port", PORT)
+httpd.serve_forever()

tests/test_stories.yml

@@ -0,0 +1,91 @@
+#### This file contains tests to evaluate that your bot behaves as expected.
+#### If you want to learn more, please see the docs: https://rasa.com/docs/rasa/testing-your-assistant
+
+stories:
+- story: happy path 1
+  steps:
+  - user: |
+      hello there!
+    intent: greet
+  - action: utter_greet
+  - user: |
+      amazing
+    intent: mood_great
+  - action: utter_happy
+
+- story: happy path 2
+  steps:
+  - user: |
+      hello there!
+    intent: greet
+  - action: utter_greet
+  - user: |
+      amazing
+    intent: mood_great
+  - action: utter_happy
+  - user: |
+      bye-bye!
+    intent: goodbye
+  - action: utter_goodbye
+
+- story: sad path 1
+  steps:
+  - user: |
+      hello
+    intent: greet
+  - action: utter_greet
+  - user: |
+      not good
+    intent: mood_unhappy
+  - action: utter_cheer_up
+  - action: utter_did_that_help
+  - user: |
+      yes
+    intent: affirm
+  - action: utter_happy
+
+- story: sad path 2
+  steps:
+  - user: |
+      hello
+    intent: greet
+  - action: utter_greet
+  - user: |
+      not good
+    intent: mood_unhappy
+  - action: utter_cheer_up
+  - action: utter_did_that_help
+  - user: |
+      not really
+    intent: deny
+  - action: utter_goodbye
+
+- story: sad path 3
+  steps:
+  - user: |
+      hi
+    intent: greet
+  - action: utter_greet
+  - user: |
+      very terrible
+    intent: mood_unhappy
+  - action: utter_cheer_up
+  - action: utter_did_that_help
+  - user: |
+      no
+    intent: deny
+  - action: utter_goodbye
+
+- story: say goodbye
+  steps:
+  - user: |
+      bye-bye!
+    intent: goodbye
+  - action: utter_goodbye
+
+- story: bot challenge
+  steps:
+  - user: |
+      are you a bot?
+    intent: bot_challenge
+  - action: utter_iamabot

web/index.html

@@ -0,0 +1,21 @@
+<head>
+    <link rel="stylesheet"
+        href="https://npm-scalableminds.s3.eu-central-1.amazonaws.com/@scalableminds/chatroom@master/dist/Chatroom.css" />
+</head>
+
+<body>
+    <div class="chat-container"></div>
+
+    <script
+        src="https://npm-scalableminds.s3.eu-central-1.amazonaws.com/@scalableminds/chatroom@master/dist/Chatroom.js" />
+    </script>
+    <script type="text/javascript">
+        var chatroom = new window.Chatroom({
+            host: "http://35.80.14.146:5005",
+            title: "Kendra, powered by Rasa and ZIR AI",
+            container: document.querySelector(".chat-container"),
+            welcomeMessage: "Hello, my name is Kendra, and I'll be happy to assist with your questions about Burj Al Arab Jumeirah. How may I help you"
+        });
+        chatroom.openChat();
+    </script>
+</body>