1.9.x to main

tests/test.json

@@ -36,7 +36,7 @@
                                     "speech_length_words": []
                                 }
                             ],
-                            "vocal_acoustic_summary": [
+                            "vocal_acoustics_simple_summary": [
                                 {
                                     "f0_mean": [],
                                     "f0_stdev": []

tests/test_diarize.py

@@ -0,0 +1,64 @@
+from unittest.mock import patch
+
+from willisapi_client.services.diarize.willisdiarize import (
+    willis_diarize,
+)
+from willisapi_client.logging_setup import logger as logger
+import logging
+
+
+class TestDiarizeFunction:
+    def setup(self):
+        self.key = "dummy"
+        self.file_path = "file.json"
+
+    @patch(
+        "willisapi_client.services.diarize.diarize_utils.DiarizeUtils.decode_response"
+    )
+    @patch(
+        "willisapi_client.services.diarize.diarize_utils.DiarizeUtils.request_diarize"
+    )
+    @patch(
+        "willisapi_client.services.diarize.diarize_utils.DiarizeUtils.read_json_file"
+    )
+    @patch(
+        "willisapi_client.services.diarize.diarize_utils.DiarizeUtils.is_valid_file_path"
+    )
+    def test_willis_diarize_function_success(
+        self, mock_file_path, mock_json, mock_api_res, mock_decoded_res, caplog
+    ):
+        mock_file_path.return_value = True
+        mock_json.return_value = {"Correct Transcription"}
+        mock_api_res.return_value = {
+            "status_code": 200,
+            "data": "Encoded Response",
+        }
+        mock_decoded_res.return_value = {"Correct Transcription"}
+        with caplog.at_level(logging.INFO):
+            res = willis_diarize(self.key, self.file_path)
+
+        assert res == {"Correct Transcription"}
+
+    @patch(
+        "willisapi_client.services.diarize.diarize_utils.DiarizeUtils.request_diarize"
+    )
+    @patch(
+        "willisapi_client.services.diarize.diarize_utils.DiarizeUtils.read_json_file"
+    )
+    @patch(
+        "willisapi_client.services.diarize.diarize_utils.DiarizeUtils.is_valid_file_path"
+    )
+    def test_willis_diarize_function_invalid_json(
+        self, mock_file_path, mock_json, mock_api_res, caplog
+    ):
+        mock_file_path.return_value = False
+        mock_json.return_value = {}
+        mock_api_res.return_value = {
+            "status_code": 200,
+            "data": "Encoded Response",
+        }
+
+        with caplog.at_level(logging.INFO):
+            res = willis_diarize(self.key, self.file_path)
+
+        assert "Input file type is incorrect. We only accept JSON files" in caplog.text

tests/test_diarize_call_remaining.py

@@ -0,0 +1,42 @@
+from unittest.mock import patch
+
+from willisapi_client.services.diarize.willisdiarize_call_remaining import (
+    willis_diarize_call_remaining,
+)
+from willisapi_client.logging_setup import logger as logger
+import logging
+
+
+class TestDiarizeCallsFunction:
+    def setup(self):
+        self.key = "dummy"
+
+    @patch(
+        "willisapi_client.services.diarize.diarize_utils.DiarizeUtils.request_call_remaining"
+    )
+    def test_willisdiarize_remaining_calls_failed(self, mocked_data, caplog):
+        mocked_data.return_value = {}
+        with caplog.at_level(logging.INFO):
+            willis_diarize_call_remaining(self.key)
+        assert "" in caplog.text
+
+    @patch(
+        "willisapi_client.services.diarize.diarize_utils.DiarizeUtils.request_call_remaining"
+    )
+    def test_willisdiarize_remaining_calls_missing_auth(self, mocked_data, caplog):
+        mocked_data.return_value = {"status_code": 401, "message": "message"}
+        with caplog.at_level(logging.INFO):
+            willis_diarize_call_remaining(self.key)
+        assert "message" in caplog.text
+
+    @patch(
+        "willisapi_client.services.diarize.diarize_utils.DiarizeUtils.request_call_remaining"
+    )
+    def test_willisdiarize_remaining_calls_success(self, mocked_data, caplog):
+        mocked_data.return_value = {
+            "status_code": 401,
+            "message": "Your account has 10 WillisDiarize API calls remaining.",
+        }
+        with caplog.at_level(logging.INFO):
+            willis_diarize_call_remaining(self.key)
+        assert "Your account has 10 WillisDiarize API calls remaining." in caplog.text

willisapi_client/__init__.py

@@ -5,6 +5,14 @@
     login,
     upload,
     download,
+    willis_diarize_call_remaining,
+    willis_diarize,
 )
 
-__all__ = ["login", "upload", "download"]
+__all__ = [
+    "login",
+    "upload",
+    "download",
+    "willis_diarize_call_remaining",
+    "willis_diarize",
+]

willisapi_client/__version__.py

@@ -1,7 +1,8 @@
 """Version details for willisapi_client
 """
+
 __client__ = "willisapi_client"
-__latestVersion__ = "1.8"
+__latestVersion__ = "1.9"
 __url__ = "https://github.com/bklynhlth/willsiapi_client"
 __short_description__ = "A Python client for willisapi"
 __content_type__ = "text/markdown"

willisapi_client/services/api.py

@@ -4,3 +4,7 @@
 from willisapi_client.services.auth import login
 from willisapi_client.services.upload import upload
 from willisapi_client.services.download import download
+from willisapi_client.services.diarize import (
+    willis_diarize_call_remaining,
+    willis_diarize,
+)

willisapi_client/services/diarize/__init__.py

@@ -0,0 +1,7 @@
+# website:   https://www.brooklyn.health
+from willisapi_client.services.diarize.willisdiarize_call_remaining import (
+    willis_diarize_call_remaining,
+)
+from willisapi_client.services.diarize.willisdiarize import willis_diarize
+
+__all__ = ["willis_diarize_call_remaining", "willis_diarize"]

willisapi_client/services/diarize/diarize_utils.py

@@ -0,0 +1,99 @@
+import requests
+import json
+import time
+import random
+import os
+import gzip
+import base64
+from willisapi_client.logging_setup import logger as logger
+
+
+class DiarizeUtils:
+    def is_valid_file_path(file_path: str):
+        return file_path.endswith(".json") and os.path.exists(file_path)
+
+    def read_json_file(file_path: str):
+        data = None
+        try:
+            with open(file_path) as f:
+                json_data = json.load(f)
+            data = dict(json_data=json_data)
+        except json.decoder.JSONDecodeError:
+            logger.info("No data found in the file or JSON is invalid.")
+            logger.info("Failed!")
+        return data
+
+    def decode_response(encoded_response):
+        return json.loads(gzip.decompress(base64.b64decode(encoded_response)))
+
+    def request_diarize(url, data, headers, try_number):
+        """
+        ------------------------------------------------------------------------------------------------------
+        Class: DiarizeUtils
+
+        Function: request_diarize
+
+        Description: This is an internal diarize function which makes a GET API call to brooklyn.health API server
+
+        Parameters:
+        ----------
+        url: The URL of the API endpoint.
+        headers: The headers to be sent in the request.
+        try_number: The number of times the function has been tried.
+
+        Returns:
+        ----------
+        json: The JSON response from the API server.
+        ------------------------------------------------------------------------------------------------------
+        """
+        try:
+            response = requests.post(url, json=data, headers=headers)
+            res_json = response.json()
+        except (
+            requests.exceptions.ConnectionError,
+            json.decoder.JSONDecodeError,
+        ) as ex:
+            if try_number == 3:
+                raise
+            time.sleep(random.random() * 2)
+            return DiarizeUtils.request_diarize(
+                url, data, headers, try_number=try_number + 1
+            )
+        else:
+            return res_json
+
+    def request_call_remaining(url, headers, try_number):
+        """
+        ------------------------------------------------------------------------------------------------------
+        Class: DiarizeUtils
+
+        Function: request_call_remaining
+
+        Description: This is an internal diarize function which makes a GET API call to brooklyn.health API server
+
+        Parameters:
+        ----------
+        url: The URL of the API endpoint.
+        headers: The headers to be sent in the request.
+        try_number: The number of times the function has been tried.
+
+        Returns:
+        ----------
+        json: The JSON response from the API server.
+        ------------------------------------------------------------------------------------------------------
+        """
+        try:
+            response = requests.get(url, headers=headers)
+            res_json = response.json()
+        except (
+            requests.exceptions.ConnectionError,
+            json.decoder.JSONDecodeError,
+        ) as ex:
+            if try_number == 3:
+                raise
+            time.sleep(random.random() * 2)
+            return DiarizeUtils.request_call_remaining(
+                url, headers, try_number=try_number + 1
+            )
+        else:
+            return res_json

willisapi_client/services/diarize/willisdiarize.py

@@ -0,0 +1,52 @@
+from http import HTTPStatus
+
+from willisapi_client.willisapi_client import WillisapiClient
+from willisapi_client.logging_setup import logger as logger
+from willisapi_client.services.diarize.diarize_utils import DiarizeUtils
+
+
+def willis_diarize(key: str, file_path: str, **kwargs):
+    """
+    ---------------------------------------------------------------------------------------------------
+    Function: willis_diarize
+
+    Description: This function makes call to WillisDiarize Model
+
+    Parameters:
+    ----------
+    key: AWS access id token (str)
+    file_path: String
+
+    Returns:
+    ----------
+    json: JSON
+    ---------------------------------------------------------------------------------------------------
+    """
+
+    logger.info("Passing through WillisDiarize...")
+    wc = WillisapiClient(env=kwargs.get("env"))
+    url = wc.get_diarize()
+    headers = wc.get_headers()
+    headers["Authorization"] = key
+    corrected_transcript = None
+
+    if not DiarizeUtils.is_valid_file_path(file_path):
+        logger.info("Input file type is incorrect. We only accept JSON files.")
+        logger.info("Failed!")
+        return corrected_transcript
+
+    data = DiarizeUtils.read_json_file(file_path)
+
+    if not data:
+        return corrected_transcript
+
+    response = DiarizeUtils.request_diarize(url, data, headers, try_number=1)
+    if response["status_code"] != HTTPStatus.OK:
+        logger.info(response["message"])
+        logger.info("Failed!")
+    else:
+        logger.info("Returning processed JSON...")
+        encoded_response = response["data"]
+        corrected_transcript = DiarizeUtils.decode_response(encoded_response)
+        logger.info("Done!")
+    return corrected_transcript

willisapi_client/services/diarize/willisdiarize_call_remaining.py

@@ -0,0 +1,28 @@
+from http import HTTPStatus
+
+from willisapi_client.willisapi_client import WillisapiClient
+from willisapi_client.logging_setup import logger as logger
+from willisapi_client.services.diarize.diarize_utils import DiarizeUtils
+
+
+def willis_diarize_call_remaining(key: str, **kwargs):
+    """
+    ---------------------------------------------------------------------------------------------------
+    Function: willis_diarize_call_remaining
+
+    Description: This function returns the number of remaining calls for willisdiarize
+
+    Parameters:
+    ----------
+    key: AWS access id token (str)
+    ---------------------------------------------------------------------------------------------------
+    """
+
+    wc = WillisapiClient(env=kwargs.get("env"))
+    url = wc.get_diarize_remaining_calls_url()
+    headers = wc.get_headers()
+    headers["Authorization"] = key
+
+    response = DiarizeUtils.request_call_remaining(url, headers, try_number=1)
+    if response:
+        logger.info(response["message"])

willisapi_client/services/download/download_utils.py

@@ -7,7 +7,7 @@
 from http import HTTPStatus
 
 
-vocal_acoustic_summary = "vocal_acoustics_summary"
+vocal_acoustics_simple_summary = "vocal_acoustics_simple_summary"
 speech_characteristics_summary = "speech_characteristics_summary"
 rater_qa_summary = "rater_qa_summary"
 
@@ -164,7 +164,7 @@ def _get_summary_df_from_json(response, pt, rec, workflow_tag):
             and measures_dict[workflow_tag]
             and workflow_tag
             in [
-                vocal_acoustic_summary,
+                vocal_acoustics_simple_summary,
                 speech_characteristics_summary,
                 rater_qa_summary,
             ]
@@ -239,9 +239,9 @@ def generate_response_df(data) -> Tuple[pd.DataFrame, str]:
                         columns=DownloadUtils._get_defined_columns(),
                     )
 
-                    vocal_acoustics_summary_df = (
+                    vocal_acoustics_simple_summary_df = (
                         DownloadUtils._get_summary_df_from_json(
-                            data, pt, rec, vocal_acoustic_summary
+                            data, pt, rec, vocal_acoustics_simple_summary
                         )
                     )
                     speech_characteristics_summary_df = (
@@ -255,7 +255,7 @@ def generate_response_df(data) -> Tuple[pd.DataFrame, str]:
                     df = pd.concat(
                         [
                             main_df,
-                            vocal_acoustics_summary_df,
+                            vocal_acoustics_simple_summary_df,
                             speech_characteristics_summary_df,
                             rater_qa_summary_df,
                         ],

willisapi_client/services/upload/csv_validation.py

@@ -53,7 +53,7 @@ def __init__(self, file_path: str):
         }
         self.gender_field = ["M", "F"]
         self.workflow_tags = [
-            "vocal_acoustics",
+            "vocal_acoustics_simple",
             "speech_characteristics",
             "speech_transcription_aws",
             "voice_and_speech",
@@ -71,6 +71,8 @@ def __init__(self, file_path: str):
             "scale_",
             "speech_characteristics_",
             "rater_qa_",
+            "scale_wd_",
+            "rater_qa_wd_",
         ]
         self.collect_time_format = r"^\d{4}-\d{2}-\d{2}$"
         self.df = None