Fix Some Query Params Not Getting Appended

deepgram/clients/abstract_async_client.py

@@ -7,6 +7,7 @@
 
 from ..options import DeepgramClientOptions
 from .errors import DeepgramError, DeepgramApiError, DeepgramUnknownApiError
+from .helpers import append_query_params
 
 
 class AbstractAsyncRestClient:
@@ -57,13 +58,17 @@ async def patch(self, url: str, options=None, **kwargs):
             "PATCH", url, params=options, headers=self.config.headers, **kwargs
         )
 
-    async def delete(self, url: str):
-        return await self._handle_request("DELETE", url, headers=self.config.headers)
+    async def delete(self, url: str, options=None):
+        return await self._handle_request("DELETE", url, params=options, headers=self.config.headers)
+
+    async def _handle_request(self, method, url, params, headers, **kwargs):
+        new_url = url
+        if params is not None:
+            new_url = append_query_params(new_url, params)
 
-    async def _handle_request(self, method, url, **kwargs):
         try:
             with httpx.Client() as client:
-                response = client.request(method, url, **kwargs)
+                response = client.request(method, new_url, headers=headers, **kwargs)
                 response.raise_for_status()
                 return response.text
         except httpx._exceptions.HTTPError as e:

deepgram/clients/abstract_sync_client.py

@@ -5,6 +5,7 @@
 import httpx
 import json
 
+from .helpers import append_query_params
 from ..options import DeepgramClientOptions
 from .errors import DeepgramError, DeepgramApiError, DeepgramUnknownApiError
 
@@ -56,15 +57,20 @@ def patch(self, url: str, options=None, timeout=None, **kwargs):
             "PATCH", url, params=options, headers=self.config.headers, timeout=timeout, **kwargs
         )
 
-    def delete(self, url: str, timeout=None):
-        return self._handle_request("DELETE", url, headers=self.config.headers, timeout=timeout)
+    def delete(self, url: str, options=None, timeout=None):
+        return self._handle_request("DELETE", url, params=options, headers=self.config.headers, timeout=timeout)
+
+    def _handle_request(self, method, url, params, headers, timeout, **kwargs):
+        new_url = url
+        if params is not None:
+            new_url = append_query_params(url, params)
 
-    def _handle_request(self, method, url, timeout, **kwargs):
         if timeout is None:
             timeout = httpx.Timeout(10.0, connect=10.0)
+
         try:
             with httpx.Client(timeout=timeout) as client:
-                response = client.request(method, url, **kwargs)
+                response = client.request(method, new_url, headers=headers, **kwargs)
                 response.raise_for_status()
                 return response.text
         except httpx._exceptions.HTTPError as e:

deepgram/clients/helpers.py

@@ -0,0 +1,24 @@
+# Copyright 2023 Deepgram SDK contributors. All Rights Reserved.
+# Use of this source code is governed by a MIT license that can be found in the LICENSE file.
+# SPDX-License-Identifier: MIT
+
+from urllib.parse import urlparse, urlunparse, parse_qs, urlencode
+
+def append_query_params(url, params):
+    parsed_url = urlparse(url)
+    query_params = parse_qs(parsed_url.query)
+
+    for key, value in params.items():
+        if value is None:
+            continue
+        if isinstance(value, bool):
+            value = str(value).lower()
+        if isinstance(value, list):
+            for item in value:
+                query_params[key] = query_params.get(key, []) + [str(item)]
+        else:
+            query_params[key] = [str(value)]
+
+    updated_query_string = urlencode(query_params, doseq=True)
+    updated_url = parsed_url._replace(query=updated_query_string).geturl()
+    return updated_url

deepgram/clients/prerecorded/v1/async_client.py

@@ -2,6 +2,7 @@
 # Use of this source code is governed by a MIT license that can be found in the LICENSE file.
 # SPDX-License-Identifier: MIT
 
+import json
 import logging, verboselogs
 
 from ...abstract_async_client import AbstractAsyncRestClient
@@ -51,7 +52,7 @@ async def transcribe_url(
     ) -> PrerecordedResponse:
         self.logger.debug("PreRecordedClient.transcribe_url ENTER")
 
-        if options is not None and "callback" in options:
+        if options is not None and options.callback is not None:
             self.logger.debug("PreRecordedClient.transcribe_url LEAVE")
             return await self.transcribe_url_callback(
                 source, options["callback"], options, endpoint
@@ -68,7 +69,12 @@ async def transcribe_url(
         self.logger.info("url: %s", url)
         self.logger.info("source: %s", source)
         self.logger.info("options: %s", options)
-        res = PrerecordedResponse.from_json(await self.post(url, options, json=body))
+        if isinstance(options, PrerecordedOptions):
+            self.logger.info("PrerecordedOptions switching class -> json")
+            options = json.loads(options.to_json())
+        result = await self.post(url, options=options, json=body)
+        self.logger.info("json: %s", result)
+        res = PrerecordedResponse.from_json(result)
         self.logger.verbose("result: %s", res)
         self.logger.notice("transcribe_url succeeded")
         self.logger.debug("PreRecordedClient.transcribe_url LEAVE")
@@ -115,9 +121,12 @@ async def transcribe_url_callback(
         self.logger.info("url: %s", url)
         self.logger.info("source: %s", source)
         self.logger.info("options: %s", options)
-        json = await self.post(url, options, json=body)
-        self.logger.info("json: %s", json)
-        res = AsyncPrerecordedResponse.from_json(json)
+        if isinstance(options, PrerecordedOptions):
+            self.logger.info("PrerecordedOptions switching class -> json")
+            options = json.loads(options.to_json())
+        result = await self.post(url, options=options, json=body)
+        self.logger.info("json: %s", result)
+        res = AsyncPrerecordedResponse.from_json(result)
         self.logger.verbose("result: %s", res)
         self.logger.notice("transcribe_url_callback succeeded")
         self.logger.debug("PreRecordedClient.transcribe_url_callback LEAVE")
@@ -149,7 +158,7 @@ async def transcribe_file(
     ) -> PrerecordedResponse:
         self.logger.debug("PreRecordedClient.transcribe_file ENTER")
 
-        if options is not None and "callback" in options:
+        if options is not None and options.callback is not None:
             self.logger.debug("PreRecordedClient.transcribe_file LEAVE")
             return await self.transcribe_file_callback(
                 source, options["callback"], options, endpoint
@@ -167,9 +176,12 @@ async def transcribe_file(
 
         self.logger.info("url: %s", url)
         self.logger.info("options: %s", options)
-        json = await self.post(url, options, content=body)
-        self.logger.info("json: %s", json)
-        res = PrerecordedResponse.from_json(json)
+        if isinstance(options, PrerecordedOptions):
+            self.logger.info("PrerecordedOptions switching class -> json")
+            options = json.loads(options.to_json())
+        result = await self.post(url, options=options, content=body)
+        self.logger.info("json: %s", result)
+        res = PrerecordedResponse.from_json(result)
         self.logger.verbose("result: %s", res)
         self.logger.notice("transcribe_file succeeded")
         self.logger.debug("PreRecordedClient.transcribe_file LEAVE")
@@ -217,9 +229,12 @@ async def transcribe_file_callback(
 
         self.logger.info("url: %s", url)
         self.logger.info("options: %s", options)
-        json = await self.post(url, options, json=body)
-        self.logger.info("json: %s", json)
-        res = AsyncPrerecordedResponse.from_json(json)
+        if isinstance(options, PrerecordedOptions):
+            self.logger.info("PrerecordedOptions switching class -> json")
+            options = json.loads(options.to_json())
+        result = await self.post(url, options=options, json=body)
+        self.logger.info("json: %s", result)
+        res = AsyncPrerecordedResponse.from_json(result)
         self.logger.verbose("result: %s", res)
         self.logger.notice("transcribe_file_callback succeeded")
         self.logger.debug("PreRecordedClient.transcribe_file_callback LEAVE")

deepgram/clients/prerecorded/v1/client.py

@@ -4,7 +4,7 @@
 
 import httpx
 import logging, verboselogs
-import inspect
+import json
 
 from ...abstract_sync_client import AbstractSyncRestClient
 from ..errors import DeepgramTypeError
@@ -53,12 +53,14 @@ def transcribe_url(
         endpoint: str = "v1/listen",
     ) -> PrerecordedResponse:
         self.logger.debug("PreRecordedClient.transcribe_url ENTER")
-        url = f"{self.config.url}/{endpoint}"
-        if options is not None and "callback" in options:
+
+        if options is not None and options.callback is not None:
             self.logger.debug("PreRecordedClient.transcribe_url LEAVE")
             return self.transcribe_url_callback(
                 source, options["callback"], options, endpoint
             )
+
+        url = f"{self.config.url}/{endpoint}"
         if is_url_source(source):
             body = source
         else:
@@ -71,8 +73,10 @@ def transcribe_url(
         self.logger.info("options: %s", options)
         if isinstance(options, PrerecordedOptions):
             self.logger.info("PrerecordedOptions switching class -> json")
-            options = options.to_json()
-        res = PrerecordedResponse.from_json(self.post(url, options, json=body, timeout=timeout))
+            options = json.loads(options.to_json())
+        result = self.post(url, options=options, json=body, timeout=timeout)
+        self.logger.info("json: %s", result)
+        res = PrerecordedResponse.from_json(result)
         self.logger.verbose("result: %s", res)
         self.logger.notice("transcribe_url succeeded")
         self.logger.debug("PreRecordedClient.transcribe_url LEAVE")
@@ -122,10 +126,10 @@ def transcribe_url_callback(
         self.logger.info("options: %s", options)
         if isinstance(options, PrerecordedOptions):
             self.logger.info("PrerecordedOptions switching class -> json")
-            options = options.to_json()
-        json = self.post(url, options, json=body, timeout=timeout)
-        self.logger.info("json: %s", json)
-        res = AsyncPrerecordedResponse.from_json(json)
+            options = json.loads(options.to_json())
+        result = self.post(url, options=options, json=body, timeout=timeout)
+        self.logger.info("json: %s", result)
+        res = AsyncPrerecordedResponse.from_json(result)
         self.logger.verbose("result: %s", res)
         self.logger.notice("transcribe_url_callback succeeded")
         self.logger.debug("PreRecordedClient.transcribe_url_callback LEAVE")
@@ -158,6 +162,12 @@ def transcribe_file(
     ) -> PrerecordedResponse:
         self.logger.debug("PreRecordedClient.transcribe_file ENTER")
 
+        if options is not None and options.callback is not None:
+            self.logger.debug("PreRecordedClient.transcribe_file LEAVE")
+            return self.transcribe_file_callback(
+                source, options["callback"], options, endpoint
+            )
+
         url = f"{self.config.url}/{endpoint}"
         if is_buffer_source(source):
             body = source["buffer"]
@@ -172,10 +182,10 @@ def transcribe_file(
         self.logger.info("options: %s", options)
         if isinstance(options, PrerecordedOptions):
             self.logger.info("PrerecordedOptions switching class -> json")
-            options = options.to_json()
-        json = self.post(url, options, content=body, timeout=timeout)
-        self.logger.info("json: %s", json)
-        res = PrerecordedResponse.from_json(json)
+            options = json.loads(options.to_json())
+        result = self.post(url, options=options, content=body, timeout=timeout)
+        self.logger.info("json: %s", result)
+        res = PrerecordedResponse.from_json(result)
         self.logger.verbose("result: %s", res)
         self.logger.notice("transcribe_file succeeded")
         self.logger.debug("PreRecordedClient.transcribe_file LEAVE")
@@ -226,10 +236,10 @@ def transcribe_file_callback(
         self.logger.info("options: %s", options)
         if isinstance(options, PrerecordedOptions):
             self.logger.info("PrerecordedOptions switching class -> json")
-            options = options.to_json()
-        json = self.post(url, options, json=body, timeout=timeout)
-        self.logger.info("json: %s", json)
-        res = AsyncPrerecordedResponse.from_json(json)
+            options = json.loads(options.to_json())
+        result = self.post(url, options=options, json=body, timeout=timeout)
+        self.logger.info("json: %s", result)
+        res = AsyncPrerecordedResponse.from_json(result)
         self.logger.verbose("result: %s", res)
         self.logger.notice("transcribe_file_callback succeeded")
         self.logger.debug("PreRecordedClient.transcribe_file_callback LEAVE")

examples/manage/async_invitations/main.py

@@ -15,7 +15,7 @@
 API_KEY = os.getenv("DG_API_KEY")
 
 # Create a Deepgram client using the API key
-deepgram: DeepgramClient = DeepgramClient(API_KEY)
+deepgram = DeepgramClient()
 
 
 async def main():

examples/manage/balances/main.py

@@ -12,11 +12,11 @@
 load_dotenv()
 
 # Create a Deepgram client using the API key
-config: DeepgramClientOptions = DeepgramClientOptions(
+config = DeepgramClientOptions(
     verbose=logging.SPAM,
 )
 
-deepgram: DeepgramClient = DeepgramClient("", config)
+deepgram = DeepgramClient("", config)
 
 
 def main():

examples/manage/invitations/main.py

@@ -11,7 +11,7 @@
 load_dotenv()
 
 # Create a Deepgram client using the API key
-deepgram: DeepgramClient = DeepgramClient()
+deepgram = DeepgramClient()
 
 
 def main():
@@ -39,7 +39,7 @@ def main():
                 print(f"GetInvites() - Name: {invite.email}, Amount: {invite.scope}")
 
         # send invite
-        options: InviteOptions = {"email": "[email protected]", "scope": "member"}
+        options = InviteOptions(email="[email protected]", scope="member")
 
         getResp = deepgram.manage.v("1").send_invite_options(myId, options)
         print(f"SendInvite() - Msg: {getResp.message}")

examples/manage/keys/main.py

@@ -11,7 +11,7 @@
 load_dotenv()
 
 # Create a Deepgram client using the API key
-deepgram: DeepgramClient = DeepgramClient()
+deepgram = DeepgramClient()
 
 
 def main():

examples/manage/members/main.py

@@ -14,7 +14,7 @@
 DELETE_MEMBER_BY_EMAIL = "[email protected]"
 
 # Create a Deepgram client using the API key
-deepgram: DeepgramClient = DeepgramClient()
+deepgram = DeepgramClient()
 
 
 def main():

examples/manage/projects/main.py

@@ -14,7 +14,7 @@
 DELETE_PROJECT_BY_NAME = os.getenv("DG_DELETE_PROJECT_BY_NAME")
 
 # Create a Deepgram client using the API key
-deepgram: DeepgramClient = DeepgramClient()
+deepgram = DeepgramClient()
 
 
 def main():

examples/manage/scopes/main.py

@@ -14,7 +14,7 @@
 MEMBER_BY_EMAIL = "[email protected]"
 
 # Create a Deepgram client using the API key
-deepgram: DeepgramClient = DeepgramClient()
+deepgram = DeepgramClient()
 
 
 def main():

examples/manage/usage/main.py

@@ -16,7 +16,7 @@
 load_dotenv()
 
 # Create a Deepgram client using the API key
-deepgram: DeepgramClient = DeepgramClient()
+deepgram = DeepgramClient()
 
 
 def main():

examples/prerecorded/async_url/main.py

@@ -15,11 +15,11 @@
     "url": "https://static.deepgram.com/examples/Bueller-Life-moves-pretty-fast.wav"
 }
 
-options: PrerecordedOptions = {
-    "model": "nova",
-    "smart_format": "true",
-    "summarize": "v2",
-}
+options = PrerecordedOptions(
+    model="nova",
+    smart_format=True,
+    summarize="v2",
+)
 
 # STEP 1 Create a Deepgram client using the API key (optional - add config options)
 deepgram = DeepgramClient(API_KEY)

examples/prerecorded/file/main.py

@@ -24,8 +24,10 @@
 
 options = PrerecordedOptions(
     model="nova",
-    smart_format="true",
-    summarize="v2",
+    smart_format=True,
+    utterances=True,
+    punctuate=True,
+    diarize=True,
 )
 
 # STEP 1 Create a Deepgram client using the API key (optional - add config options)