Merge pull request #1733 from therealdeadly/sort-score-array-http-api

WIP: sort the scores array in server.py

CHANGELOG.rst

@@ -21,6 +21,8 @@ Changed
 -------
 - starter packs are now tested in parallel with the unittests,
   and only on master and branches ending in ``.x`` (i.e. new version releases)
+- ``scores`` array returned by the ``/conversations/{sender_id}/predict``
+  endpoint is now sorted according to the actions' scores.
 
 Removed
 -------

docs/_static/spec/server.yml

@@ -343,10 +343,11 @@ paths:
       - Tracker
       summary: Predict the next action
       description: >-
-        Runs the conversations tracker through the models
-        policies to predict the next action. The action is
-        not executed, just returned. The state of the tracker
-        is not modified.
+        Runs the conversations tracker through the model's
+        policies to predict the scores of all actions present
+        in the model's domain. Actions are returned in the
+        'scores' array, sorted on their 'score' values.
+        The state of the tracker is not modified.
       operationId: predictAction
       parameters:
       - $ref: '#/components/parameters/senderId'

rasa_core/server.py

@@ -407,6 +407,9 @@ def predict(sender_id):
         try:
             # Fetches the appropriate bot response in a json format
             responses = agent.predict_next(sender_id)
+            responses['scores'] = sorted(responses['scores'],
+                                         key = lambda k: (-k['score'],
+                                                          k['action']))
             return jsonify(responses)
 
         except Exception as e:

rasa_core/training/interactive.py

@@ -602,13 +602,10 @@ def _request_action_from_user(
 
     _print_history(sender_id, endpoint)
 
-    sorted_actions = sorted(predictions,
-                            key=lambda k: (-k['score'], k['action']))
-
     choices = [{"name": "{:03.2f} {:40}".format(a.get("score"),
                                                 a.get("action")),
                 "value": a.get("action")}
-               for a in sorted_actions]
+               for a in predictions]
 
     choices = ([{"name": "<create new action>", "value": OTHER_ACTION}] +
                choices)

tests/test_server.py

@@ -207,6 +207,20 @@ def test_predict(http_app, app):
     assert response.status_code == 200
 
 
+def test_sorted_predict(http_app, app):
+    client = RasaCoreClient(EndpointConfig(http_app))
+    cid = str(uuid.uuid1())
+    for event in test_events[:3]:
+        client.append_event_to_tracker(cid, event)
+    response = app.post("http://dummy/conversations/{}/predict".format(cid))
+    content = response.get_json()
+    scores = content["scores"]
+    sorted_scores = sorted(scores,
+                           key = lambda k: (-k['score'],
+                                            k['action']))
+    assert scores == sorted_scores
+
+
 def test_evaluate(app):
     with io.open(DEFAULT_STORIES_FILE, 'r') as f:
         stories = f.read()