refactor: riseapi mode response format (#1585)

Author: IgnatovFedor

deeppavlov/models/api_requester/api_requester.py

@@ -33,14 +33,16 @@ class ApiRequester(Component):
 
     Attributes:
         url: url of the API.
-        out: count of expected returned values.
+        out_count: count of expected returned values.
         param_names: list of parameter names for API requests.
         debatchify: if True, single instances will be sent to the API endpoint instead of batches.
     """
 
-    def __init__(self, url: str, out: [int, list], param_names: [list, tuple] = (), debatchify: bool = False,
+    def __init__(self, url: str, out: [int, list], param_names: [list, tuple] = None, debatchify: bool = False,
                  *args, **kwargs):
         self.url = url
+        if param_names is None:
+            param_names = kwargs.get('in', ())
         self.param_names = param_names
         self.out_count = out if isinstance(out, int) else len(out)
         self.debatchify = debatchify
@@ -70,13 +72,11 @@ async def collect():
 
             loop = asyncio.get_event_loop()
             response = loop.run_until_complete(collect())
-
+            if self.out_count > 1:
+                response = list(zip(*response))
         else:
             response = requests.post(self.url, json=data).json()
 
-        if self.out_count > 1:
-            response = list(zip(*response))
-
         return response
 
     async def get_async_response(self, data: dict, batch_size: int) -> AsyncIterable:

deeppavlov/utils/server/server.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 import asyncio
+import os
 from collections import namedtuple
 from logging import getLogger
 from pathlib import Path
@@ -44,6 +45,13 @@
 log = getLogger(__name__)
 dialog_logger = DialogLogger(logger_name='rest_api')
 
+COMPATIBILITY_MODE = os.getenv('COMPATIBILITY_MODE', False)
+
+if COMPATIBILITY_MODE is not False:
+    log.warning('DeepPavlov riseapi mode will use the old model response data format used up and including 1.0.0rc1.\n'
+                'COMPATIBILITY_MODE will be removed in the DeepPavlov 1.2.0.\n'
+                'Please, update your client code according to the new format.')
+
 app = FastAPI()
 
 app.add_middleware(
@@ -144,9 +152,13 @@ def interact(model: Chainer, payload: Dict[str, Optional[List]]) -> List:
     model_args = [arg or [None] * batch_size for arg in model_args]
 
     prediction = model(*model_args)
-    if len(model.out_params) == 1:
-        prediction = [prediction]
-    prediction = list(zip(*prediction))
+
+    # TODO: remove in 1.2.0
+    if COMPATIBILITY_MODE is not False:
+        if len(model.out_params) == 1:
+            prediction = [prediction]
+        prediction = list(zip(*prediction))
+
     result = jsonify_data(prediction)
     dialog_logger.log_out(result)
     return result
@@ -204,8 +216,13 @@ async def probe(item: Batch) -> List[str]:
         return await loop.run_in_executor(None, test_interact, model, item.dict())
 
     @app.get('/api', summary='Model argument names')
-    async def api() -> List[str]:
-        return model_args_names
+    async def api() -> Dict[str, List[str]]:
+        if COMPATIBILITY_MODE is not False:
+            return model_args_names
+        return {
+            'in': model.in_x,
+            'out': model.out_params
+        }
 
     uvicorn.run(app, host=host, port=port, log_config=log_config, ssl_version=ssl_config.version,
                 ssl_keyfile=ssl_config.keyfile, ssl_certfile=ssl_config.certfile, timeout_keep_alive=20)

docs/integrations/rest_api.rst

@@ -24,6 +24,13 @@ The command will print the used host and port. Default web service properties
 (host, port, POST request arguments) can be modified via changing
 ``deeppavlov/utils/settings/server_config.json`` file.
 
+.. warning::
+
+    Starting from the 1.0.0rc2 model response format in riseapi mode matches :class:`~deeppavlov.core.common.chainer.Chainer`
+    response format. To start model with the old format, give the ``COMPATIBILITY_MODE`` environment variable any
+    non-empty value (e.g. ``COMPATIBILITY_MODE=true python -m deeppavlov riseapi ...``).
+    ``COMPATIBILITY_MODE`` will be removed in DeepPavlov 1.2.0.
+
 API routes
 ----------
 
@@ -40,8 +47,8 @@ server will send a response ``["Test passed"]`` if it is working. Requests to
 
 /api
 """"
-To get model argument names send GET request to ``<host>:<port>/api``. Server
-will return list with argument names.
+To get model argument and response names send GET request to ``<host>:<port>/api``. Server
+will return dict with model input and output names.
 
 .. _rest_api_docs:
 

tests/test_quick_start.py

@@ -444,7 +444,7 @@ def infer_api(config_path):
             response_code = get_response.status_code
             assert response_code == 200, f"GET /api request returned error code {response_code} with {config_path}"
 
-            model_args_names = get_response.json()
+            model_args_names = get_response.json()['in']
             post_payload = dict()
             for arg_name in model_args_names:
                 arg_value = ' '.join(['qwerty'] * 10)