Remove sliding_window, add granularity for language (#41)

Author: gregorybchris

hume/_batch/hume_batch_client.py

@@ -151,15 +151,15 @@ def submit_prosody(
     def submit_language(
         self,
         urls: List[str],
-        sliding_window: Optional[bool] = None,
+        granularity: Optional[str] = None,
         identify_speakers: Optional[bool] = None,
     ) -> BatchJob:
         """Submit a new job for language emotion.
 
         Args:
             urls (List[str]): URLs to process.
-            sliding_window (Optional[float]): Whether to generate predictions for each word in the text or
-                for the entire text in aggregate.
+            granularity (Optional[str]): The granularity at which to generate predictions.
+                Values are `word`, `sentence`, or `passage`. Default value is `word`.
             identify_speakers (Optional[bool]): Whether to return identifiers for speakers over time.
                 If true, unique identifiers will be assigned to spoken words to differentiate different speakers.
                 If false, all speakers will be tagged with an "unknown" ID.
@@ -171,7 +171,7 @@ def submit_language(
             BatchJob: Batch job.
         """
         config = LanguageConfig(
-            sliding_window=sliding_window,
+            granularity=granularity,
             identify_speakers=identify_speakers,
         )
         return self._submit(urls, [config])

hume/_common/config/language_config.py

@@ -11,19 +11,19 @@ class LanguageConfig(JobConfigBase["LanguageConfig"]):
     def __init__(
         self,
         *,
-        sliding_window: Optional[float] = None,
+        granularity: Optional[str] = None,
         identify_speakers: Optional[bool] = None,
     ):
         """Construct a `LanguageConfig`.
 
         Args:
-            sliding_window (Optional[float]): Whether to generate predictions for each word in the text or
-                for the entire text in aggregate.
+            granularity (Optional[str]): The granularity at which to generate predictions.
+                Values are `word`, `sentence`, or `passage`. Default value is `word`.
             identify_speakers (Optional[bool]): Whether to return identifiers for speakers over time.
                 If true, unique identifiers will be assigned to spoken words to differentiate different speakers.
                 If false, all speakers will be tagged with an "unknown" ID.
         """
-        self.sliding_window = sliding_window
+        self.granularity = granularity
         self.identify_speakers = identify_speakers
 
     @classmethod
@@ -42,7 +42,7 @@ def serialize(self) -> Dict[str, Any]:
             Dict[str, Any]: Serialized `LanguageConfig` object.
         """
         return {
-            "sliding_window": self.sliding_window,
+            "granularity": self.granularity,
             "identify_speakers": self.identify_speakers,
         }
 
@@ -57,6 +57,6 @@ def deserialize(cls, request_dict: Dict[str, Any]) -> "LanguageConfig":
             LanguageConfig: Deserialized `LanguageConfig` object.
         """
         return cls(
-            sliding_window=request_dict.get("sliding_window"),
+            granularity=request_dict.get("granularity"),
             identify_speakers=request_dict.get("identify_speakers"),
         )

pyproject.toml

@@ -25,7 +25,7 @@ license = "Proprietary"
 name = "hume"
 readme = "README.md"
 repository = "https://github.com/HumeAI/hume-python-sdk"
-version = "0.1.6"
+version = "0.1.7"
 
 [tool.poetry.dependencies]
 python = ">=3.8.1,<4"

tests/batch/test_batch_client.py

@@ -74,15 +74,15 @@ def test_language(self, batch_client: HumeBatchClient):
         mock_url = "mock-url"
         job = batch_client.submit_language(
             [mock_url],
-            sliding_window=False,
+            granularity="word",
             identify_speakers=True,
         )
         assert isinstance(job, BatchJob)
         assert job.id == "mock-job-id"
         batch_client.start_job.assert_called_once_with({
             "models": {
                 "language": {
-                    "sliding_window": False,
+                    "granularity": "word",
                     "identify_speakers": True,
                 },
             },

tests/stream/conftest.py

@@ -42,7 +42,7 @@ async def mock_send(message: str) -> None:
             "models": {
                 "language": {
                     "identify_speakers": None,
-                    "sliding_window": None,
+                    "granularity": None,
                 },
             },
         }