Merge branch 'develop' into feat/precision-2

Author: hbredin

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## Version 0.1.1 (2025-06-04)
+
+- Allow arbitrary kwargs in `diarize`, `identify` and `voiceprint`
+
 ## Version 0.1.0 (2025-03-14)
 
 - *Hello world!*

README.md

@@ -6,16 +6,15 @@
     <h1>Official pyannoteAI Python SDK </h1>
 </div>
 
-
 ## Installation
 
 ```bash
-$ pip install pyannoteai.sdk
+$ pip install pyannoteai-sdk
 ```
 
 Then head over to [`dashboard.pyannote.ai`](https://dashboard.pyannote.ai) and create an API key.
 
-## Speaker diarization 
+## Speaker diarization
 
 ```python
 # instantiate client

src/pyannoteai/sdk/client.py

@@ -331,6 +331,7 @@ def diarize(
         turn_level_confidence: bool = False,
         exclusive: bool = False,
         model: str = "precision-2",
+        **kwargs,
     ) -> str:
         """Initiate a diarization job on the pyannoteAI web API
 
@@ -354,6 +355,8 @@ def diarize(
             Defaults to False
         exclusive: bool, optional
             Defaults to False
+        **kwargs : optional
+            Extra arguments to send in the body of the request.
 
         Returns
         -------
@@ -375,6 +378,8 @@ def diarize(
             "turn_level_confidence": turn_level_confidence,
             "exclusive": exclusive,
         }
+        # add extra arguments to the request body
+        json.update(kwargs)
 
         response = self._authenticated_post("/diarize", json=json)
         data = response.json()
@@ -384,6 +389,7 @@ def voiceprint(
         self,
         media_url: str,
         model: str = "precision-2",
+        **kwargs,
     ) -> str:
         """Initiate a voiceprint job on the pyannoteAI web API
 
@@ -394,6 +400,8 @@ def voiceprint(
             any other public URL pointing to an audio file.
         model : str, optional
             Defaults to "precision-2".
+        **kwargs : optional
+            Extra arguments to send in the body of the request.
 
         Returns
         -------
@@ -406,6 +414,8 @@ def voiceprint(
         """
 
         json = {"url": media_url, "model": model}
+        # add extra arguments to the request body
+        json.update(kwargs)
 
         response = self._authenticated_post("/voiceprint", json=json)
         data = response.json()
@@ -424,6 +434,7 @@ def identify(
         confidence: bool = False,
         turn_level_confidence: bool = False,
         exclusive: bool = False,
+        **kwargs,
     ) -> str:
         """Initiate an identification job on the pyannoteAI web API
 
@@ -450,6 +461,8 @@ def identify(
             Maximum number of speakers. Has no effect when `num_speakers` is provided.
         confidence : bool, optional
             Defaults to False
+        **kwargs : optional
+            Extra arguments to send in the body of the request.
 
         Returns
         -------
@@ -479,6 +492,8 @@ def identify(
                 "threshold": matching_threshold,
             },
         }
+        # add extra arguments to the request body
+        json.update(kwargs)
 
         response = self._authenticated_post("/identify", json=json)
         data = response.json()