PRED-2194 Use old reasonCodesPredictions route to support 4.3.x installs (#147)

* PRED-2194 use old reasonCodesPredictions route to support 4.3.x installs
* ensure that deployment aware routes use predictionExplanations
* cut official 1.15.3

Author: pprett

CHANGES.rst

@@ -1,3 +1,10 @@
+1.15.3 (2019 Jan 7)
+===================
+
+Bugfixes
+--------
+* Added support for ``--max_prediction_explanations`` on DataRobot 4.3.x .
+
 1.15.2  (2018 Dec 17)
 =====================
 
@@ -17,7 +24,7 @@ Enhancements
 
 Enhancements
 ------------
-* Added new argument ``-max_prediction_explanations`` that allows batch scoring with predictions explanations and adds ``explanation_N_feature`` and ``explanation_N_strength`` to each row in output document (where ``N ∈ (1, max_prediction_explanations)`` )
+* Added new argument ``--max_prediction_explanations`` that allows batch scoring with predictions explanations and adds ``explanation_N_feature`` and ``explanation_N_strength`` to each row in output document (where ``N ∈ (1, max_prediction_explanations)`` )
 
 1.14.2 (2018 Nov 14)
 ====================

datarobot_batch_scoring/__init__.py

@@ -1 +1 @@
-__version__ = '1.15.2'
+__version__ = '1.15.3'

datarobot_batch_scoring/api_response_handlers/pred_api_v10.py

@@ -71,16 +71,24 @@ def format_data(result, batch, **opts):
             written_fields = out_fields[1:]
             comb = [row[1:] for row in pred]
 
-    if 'predictionExplanations' in single_row:
-        num_reason_codes = len(single_row['predictionExplanations'])
+    prediction_explanations_keys = ('predictionExplanations', 'reasonCodes',
+                                    None)
+
+    def _find_prediction_explanations_key():
+        return [key for key in prediction_explanations_keys
+                if key in single_row or key is None][0]
+
+    prediction_explanations_key = _find_prediction_explanations_key()
+    if prediction_explanations_key:
+        num_reason_codes = len(single_row[prediction_explanations_key])
         for num in range(1, num_reason_codes + 1):
             written_fields += [
                 'explanation_{0}_feature'.format(num),
                 'explanation_{0}_strength'.format(num)
             ]
         for in_row, out_row in zip(result, comb):
             reason_codes = []
-            for raw_reason_code in in_row['predictionExplanations']:
+            for raw_reason_code in in_row[prediction_explanations_key]:
                 reason_codes += [
                     raw_reason_code['feature'],
                     raw_reason_code['strength']

datarobot_batch_scoring/batch_scoring.py

@@ -133,8 +133,15 @@ def run_batch_predictions(base_url, base_headers, user, pwd,
             endpoint = base_url + '/'.join((pid, lid))
 
         if max_prediction_explanations:
-            endpoint += '/predictionExplanations?maxCodes=' + \
-                        str(max_prediction_explanations)
+            if deployment_id is not None:
+                # Deployment routes only support predictionExplanations.
+                endpoint += '/predictionExplanations?maxCodes='
+            else:
+                # For non-deployment routes we use the old reasonCodesRoutes
+                # to support 4.3.x releases.
+                endpoint += '/reasonCodesPredictions?maxCodes='
+
+            endpoint += str(max_prediction_explanations)
         else:
             if deployment_id is not None:
                 endpoint += '/predictions'

tests/liveserver_fixtures.py

@@ -190,6 +190,8 @@ def post_auth():
     @app.route('/predApi/v1.0/<pid>/<lid>/predict', methods=["POST"])
     @app.route('/predApi/v1.0/<pid>/<lid>/predictionExplanations',
                methods=["POST"])
+    @app.route('/predApi/v1.0/<pid>/<lid>/reasonCodesPredictions',
+               methods=["POST"])
     @app.route('/api/v1/<pid>/<lid>/predict', methods=["POST"])
     def predict_sinc(pid, lid):
         return _predict(lid)
@@ -205,6 +207,8 @@ def predict_deployment_aware(deployment_id):
     @app.route('/predApi/v1.0/<import_id>/predict', methods=["POST"])
     @app.route('/predApi/v1.0/<import_id>/predictionExplanations',
                methods=["POST"])
+    @app.route('/predApi/v1.0/<import_id>/reasonCodesPredictions',
+               methods=["POST"])
     @app.route('/api/v1/<import_id>/predict', methods=["POST"])
     def predict_transferable(import_id):
         return _predict(import_id)