Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 40 additions & 8 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ client.auth.v1.tokens.grant()
<dl>
<dd>

**ttl_seconds:** `typing.Optional[int]` — Time to live in seconds for the token. Defaults to 30 seconds.
**ttl_seconds:** `typing.Optional[float]` — Time to live in seconds for the token. Defaults to 30 seconds.

</dd>
</dl>
Expand Down Expand Up @@ -468,6 +468,14 @@ client.listen.v1.media.transcribe_url(
<dl>
<dd>

**mip_opt_out:** `typing.Optional[bool]` — Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand Down Expand Up @@ -816,6 +824,14 @@ client.listen.v1.media.transcribe_file()
<dl>
<dd>

**mip_opt_out:** `typing.Optional[bool]` — Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand Down Expand Up @@ -1086,15 +1102,15 @@ client.manage.v1.projects.get(
<dl>
<dd>

**limit:** `typing.Optional[int]` — Number of results to return per page. Default 10. Range [1,1000]
**limit:** `typing.Optional[float]` — Number of results to return per page. Default 10. Range [1,1000]

</dd>
</dl>

<dl>
<dd>

**page:** `typing.Optional[int]` — Navigate and return the results to retrieve specific portions of information of the response
**page:** `typing.Optional[float]` — Navigate and return the results to retrieve specific portions of information of the response

</dd>
</dl>
Expand Down Expand Up @@ -2033,15 +2049,15 @@ client.manage.v1.projects.requests.list(
<dl>
<dd>

**limit:** `typing.Optional[int]` — Number of results to return per page. Default 10. Range [1,1000]
**limit:** `typing.Optional[float]` — Number of results to return per page. Default 10. Range [1,1000]

</dd>
</dl>

<dl>
<dd>

**page:** `typing.Optional[int]` — Navigate and return the results to retrieve specific portions of information of the response
**page:** `typing.Optional[float]` — Navigate and return the results to retrieve specific portions of information of the response

</dd>
</dl>
Expand Down Expand Up @@ -2959,7 +2975,7 @@ client.manage.v1.projects.billing.purchases.list(
<dl>
<dd>

**limit:** `typing.Optional[int]` — Number of results to return per page. Default 10. Range [1,1000]
**limit:** `typing.Optional[float]` — Number of results to return per page. Default 10. Range [1,1000]

</dd>
</dl>
Expand Down Expand Up @@ -3998,6 +4014,14 @@ client.read.v1.text.analyze(
<dl>
<dd>

**tag:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Label your requests for the purpose of identification during usage reporting

</dd>
</dl>

<dl>
<dd>

**topics:** `typing.Optional[bool]` — Detect topics throughout a transcript or text

</dd>
Expand Down Expand Up @@ -4477,7 +4501,15 @@ client.speak.v1.audio.generate(
<dl>
<dd>

**bit_rate:** `typing.Optional[int]` — The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type.
**tag:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Label your requests for the purpose of identification during usage reporting

</dd>
</dl>

<dl>
<dd>

**bit_rate:** `typing.Optional[float]` — The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type.

</dd>
</dl>
Expand Down Expand Up @@ -4509,7 +4541,7 @@ client.speak.v1.audio.generate(
<dl>
<dd>

**sample_rate:** `typing.Optional[int]` — Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable
**sample_rate:** `typing.Optional[float]` — Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable

</dd>
</dl>
Expand Down
3 changes: 0 additions & 3 deletions src/deepgram/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@
ListenV1Encoding,
ListenV1Endpointing,
ListenV1Extra,
ListenV1FillerWords,
ListenV1InterimResults,
ListenV1Keyterm,
ListenV1Keywords,
Expand Down Expand Up @@ -458,7 +457,6 @@
"ListenV1Encoding": ".types",
"ListenV1Endpointing": ".types",
"ListenV1Extra": ".types",
"ListenV1FillerWords": ".types",
"ListenV1InterimResults": ".types",
"ListenV1Keyterm": ".types",
"ListenV1Keywords": ".types",
Expand Down Expand Up @@ -792,7 +790,6 @@ def __dir__():
"ListenV1Encoding",
"ListenV1Endpointing",
"ListenV1Extra",
"ListenV1FillerWords",
"ListenV1InterimResults",
"ListenV1Keyterm",
"ListenV1Keywords",
Expand Down
8 changes: 4 additions & 4 deletions src/deepgram/auth/v1/tokens/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ def with_raw_response(self) -> RawTokensClient:
return self._raw_client

def grant(
self, *, ttl_seconds: typing.Optional[int] = OMIT, request_options: typing.Optional[RequestOptions] = None
self, *, ttl_seconds: typing.Optional[float] = OMIT, request_options: typing.Optional[RequestOptions] = None
) -> GrantV1Response:
"""
Generates a temporary JSON Web Token (JWT) with a 30-second (by default) TTL and usage::write permission for core voice APIs, requiring an API key with Member or higher authorization. Tokens created with this endpoint will not work with the Manage APIs.
Parameters
----------
ttl_seconds : typing.Optional[int]
ttl_seconds : typing.Optional[float]
Time to live in seconds for the token. Defaults to 30 seconds.
request_options : typing.Optional[RequestOptions]
Expand Down Expand Up @@ -74,14 +74,14 @@ def with_raw_response(self) -> AsyncRawTokensClient:
return self._raw_client

async def grant(
self, *, ttl_seconds: typing.Optional[int] = OMIT, request_options: typing.Optional[RequestOptions] = None
self, *, ttl_seconds: typing.Optional[float] = OMIT, request_options: typing.Optional[RequestOptions] = None
) -> GrantV1Response:
"""
Generates a temporary JSON Web Token (JWT) with a 30-second (by default) TTL and usage::write permission for core voice APIs, requiring an API key with Member or higher authorization. Tokens created with this endpoint will not work with the Manage APIs.
Parameters
----------
ttl_seconds : typing.Optional[int]
ttl_seconds : typing.Optional[float]
Time to live in seconds for the token. Defaults to 30 seconds.
request_options : typing.Optional[RequestOptions]
Expand Down
8 changes: 4 additions & 4 deletions src/deepgram/auth/v1/tokens/raw_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ def __init__(self, *, client_wrapper: SyncClientWrapper):
self._client_wrapper = client_wrapper

def grant(
self, *, ttl_seconds: typing.Optional[int] = OMIT, request_options: typing.Optional[RequestOptions] = None
self, *, ttl_seconds: typing.Optional[float] = OMIT, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[GrantV1Response]:
"""
Generates a temporary JSON Web Token (JWT) with a 30-second (by default) TTL and usage::write permission for core voice APIs, requiring an API key with Member or higher authorization. Tokens created with this endpoint will not work with the Manage APIs.

Parameters
----------
ttl_seconds : typing.Optional[int]
ttl_seconds : typing.Optional[float]
Time to live in seconds for the token. Defaults to 30 seconds.

request_options : typing.Optional[RequestOptions]
Expand Down Expand Up @@ -83,14 +83,14 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._client_wrapper = client_wrapper

async def grant(
self, *, ttl_seconds: typing.Optional[int] = OMIT, request_options: typing.Optional[RequestOptions] = None
self, *, ttl_seconds: typing.Optional[float] = OMIT, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[GrantV1Response]:
"""
Generates a temporary JSON Web Token (JWT) with a 30-second (by default) TTL and usage::write permission for core voice APIs, requiring an API key with Member or higher authorization. Tokens created with this endpoint will not work with the Manage APIs.

Parameters
----------
ttl_seconds : typing.Optional[int]
ttl_seconds : typing.Optional[float]
Time to live in seconds for the token. Defaults to 30 seconds.

request_options : typing.Optional[RequestOptions]
Expand Down
10 changes: 0 additions & 10 deletions src/deepgram/listen/v1/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ def connect(
encoding: typing.Optional[str] = None,
endpointing: typing.Optional[str] = None,
extra: typing.Optional[str] = None,
filler_words: typing.Optional[str] = None,
interim_results: typing.Optional[str] = None,
keyterm: typing.Optional[str] = None,
keywords: typing.Optional[str] = None,
Expand Down Expand Up @@ -96,8 +95,6 @@ def connect(

extra : typing.Optional[str]

filler_words : typing.Optional[str]

interim_results : typing.Optional[str]

keyterm : typing.Optional[str]
Expand Down Expand Up @@ -167,8 +164,6 @@ def connect(
query_params = query_params.add("endpointing", endpointing)
if extra is not None:
query_params = query_params.add("extra", extra)
if filler_words is not None:
query_params = query_params.add("filler_words", filler_words)
if interim_results is not None:
query_params = query_params.add("interim_results", interim_results)
if keyterm is not None:
Expand Down Expand Up @@ -268,7 +263,6 @@ async def connect(
encoding: typing.Optional[str] = None,
endpointing: typing.Optional[str] = None,
extra: typing.Optional[str] = None,
filler_words: typing.Optional[str] = None,
interim_results: typing.Optional[str] = None,
keyterm: typing.Optional[str] = None,
keywords: typing.Optional[str] = None,
Expand Down Expand Up @@ -312,8 +306,6 @@ async def connect(

extra : typing.Optional[str]

filler_words : typing.Optional[str]

interim_results : typing.Optional[str]

keyterm : typing.Optional[str]
Expand Down Expand Up @@ -383,8 +375,6 @@ async def connect(
query_params = query_params.add("endpointing", endpointing)
if extra is not None:
query_params = query_params.add("extra", extra)
if filler_words is not None:
query_params = query_params.add("filler_words", filler_words)
if interim_results is not None:
query_params = query_params.add("interim_results", interim_results)
if keyterm is not None:
Expand Down
20 changes: 20 additions & 0 deletions src/deepgram/listen/v1/media/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ def transcribe_url(
utterances: typing.Optional[bool] = None,
utt_split: typing.Optional[float] = None,
version: typing.Optional[MediaTranscribeRequestVersion] = None,
mip_opt_out: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> MediaTranscribeResponse:
"""
Expand Down Expand Up @@ -186,6 +187,9 @@ def transcribe_url(
version : typing.Optional[MediaTranscribeRequestVersion]
Version of an AI model to use

mip_opt_out : typing.Optional[bool]
Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip

request_options : typing.Optional[RequestOptions]
Request-specific configuration.

Expand Down Expand Up @@ -242,6 +246,7 @@ def transcribe_url(
utterances=utterances,
utt_split=utt_split,
version=version,
mip_opt_out=mip_opt_out,
request_options=request_options,
)
return _response.data
Expand Down Expand Up @@ -285,6 +290,7 @@ def transcribe_file(
utterances: typing.Optional[bool] = None,
utt_split: typing.Optional[float] = None,
version: typing.Optional[MediaTranscribeRequestVersion] = None,
mip_opt_out: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> MediaTranscribeResponse:
"""
Expand Down Expand Up @@ -399,6 +405,9 @@ def transcribe_file(
version : typing.Optional[MediaTranscribeRequestVersion]
Version of an AI model to use

mip_opt_out : typing.Optional[bool]
Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip

request_options : typing.Optional[RequestOptions]
Request-specific configuration.

Expand Down Expand Up @@ -453,6 +462,7 @@ def transcribe_file(
utterances=utterances,
utt_split=utt_split,
version=version,
mip_opt_out=mip_opt_out,
request_options=request_options,
)
return _response.data
Expand Down Expand Up @@ -512,6 +522,7 @@ async def transcribe_url(
utterances: typing.Optional[bool] = None,
utt_split: typing.Optional[float] = None,
version: typing.Optional[MediaTranscribeRequestVersion] = None,
mip_opt_out: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> MediaTranscribeResponse:
"""
Expand Down Expand Up @@ -626,6 +637,9 @@ async def transcribe_url(
version : typing.Optional[MediaTranscribeRequestVersion]
Version of an AI model to use

mip_opt_out : typing.Optional[bool]
Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip

request_options : typing.Optional[RequestOptions]
Request-specific configuration.

Expand Down Expand Up @@ -690,6 +704,7 @@ async def main() -> None:
utterances=utterances,
utt_split=utt_split,
version=version,
mip_opt_out=mip_opt_out,
request_options=request_options,
)
return _response.data
Expand Down Expand Up @@ -733,6 +748,7 @@ async def transcribe_file(
utterances: typing.Optional[bool] = None,
utt_split: typing.Optional[float] = None,
version: typing.Optional[MediaTranscribeRequestVersion] = None,
mip_opt_out: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> MediaTranscribeResponse:
"""
Expand Down Expand Up @@ -847,6 +863,9 @@ async def transcribe_file(
version : typing.Optional[MediaTranscribeRequestVersion]
Version of an AI model to use

mip_opt_out : typing.Optional[bool]
Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip

request_options : typing.Optional[RequestOptions]
Request-specific configuration.

Expand Down Expand Up @@ -909,6 +928,7 @@ async def main() -> None:
utterances=utterances,
utt_split=utt_split,
version=version,
mip_opt_out=mip_opt_out,
request_options=request_options,
)
return _response.data
Loading
Loading