Skip to content

🌿 Fern Regeneration -- April 18, 2025 #282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 18, 2025
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
12 changes: 12 additions & 0 deletions .mock/definition/tts/__package__.yml
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,14 @@ types:
When setting to `false`, avoid including utterances with long `text`,
as this can result in distorted output.
default: true
strip_headers:
type: optional<boolean>
docs: >-
If enabled, the audio for all the chunks of a generation, once
concatenated together, will constitute a single audio file. Otherwise,
if disabled, each chunk's audio will be its own audio file, each with
its own headers (if applicable).
default: false
utterances:
docs: >-
A list of **Utterances** to be converted to speech output.
Expand Down Expand Up @@ -374,6 +382,10 @@ types:
[/v0/tts/stream/json](/reference/text-to-speech-tts/synthesize-json-streaming),
[/v0/tts/stream/file](/reference/text-to-speech-tts/synthesize-file-streaming)).

- Ensure only a single generation is requested
([num_generations](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.num_generations)
must be `1` or omitted).

- With `instant_mode` enabled, **requests incur a 10% higher cost**
due to increased compute and resource requirements.
default: false
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "hume"
version = "0.8.1"
version = "0.8.2"
description = "A Python SDK for Hume AI"
readme = "README.md"
authors = []
Expand Down
36 changes: 36 additions & 0 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,20 @@ This setting affects how the `snippets` array is structured in the response, whi
<dl>
<dd>

**strip_headers:** `typing.Optional[bool]` — If enabled, the audio for all the chunks of a generation, once concatenated together, will constitute a single audio file. Otherwise, if disabled, each chunk's audio will be its own audio file, each with its own headers (if applicable).

</dd>
</dl>

<dl>
<dd>

**instant_mode:** `typing.Optional[bool]`

Enables ultra-low latency streaming, significantly reducing the time until the first audio chunk is received. Recommended for real-time applications requiring immediate audio playback. For further details, see our documentation on [instant mode](/docs/text-to-speech-tts/overview#ultra-low-latency-streaming-instant-mode).
- Dynamic voice generation is not supported with this mode; a predefined [voice](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.utterances.voice) must be specified in your request.
- This mode is only supported for streaming endpoints (e.g., [/v0/tts/stream/json](/reference/text-to-speech-tts/synthesize-json-streaming), [/v0/tts/stream/file](/reference/text-to-speech-tts/synthesize-file-streaming)).
- Ensure only a single generation is requested ([num_generations](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.num_generations) must be `1` or omitted).
- With `instant_mode` enabled, **requests incur a 10% higher cost** due to increased compute and resource requirements.

</dd>
Expand Down Expand Up @@ -260,11 +269,20 @@ This setting affects how the `snippets` array is structured in the response, whi
<dl>
<dd>

**strip_headers:** `typing.Optional[bool]` — If enabled, the audio for all the chunks of a generation, once concatenated together, will constitute a single audio file. Otherwise, if disabled, each chunk's audio will be its own audio file, each with its own headers (if applicable).

</dd>
</dl>

<dl>
<dd>

**instant_mode:** `typing.Optional[bool]`

Enables ultra-low latency streaming, significantly reducing the time until the first audio chunk is received. Recommended for real-time applications requiring immediate audio playback. For further details, see our documentation on [instant mode](/docs/text-to-speech-tts/overview#ultra-low-latency-streaming-instant-mode).
- Dynamic voice generation is not supported with this mode; a predefined [voice](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.utterances.voice) must be specified in your request.
- This mode is only supported for streaming endpoints (e.g., [/v0/tts/stream/json](/reference/text-to-speech-tts/synthesize-json-streaming), [/v0/tts/stream/file](/reference/text-to-speech-tts/synthesize-file-streaming)).
- Ensure only a single generation is requested ([num_generations](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.num_generations) must be `1` or omitted).
- With `instant_mode` enabled, **requests incur a 10% higher cost** due to increased compute and resource requirements.

</dd>
Expand Down Expand Up @@ -398,11 +416,20 @@ This setting affects how the `snippets` array is structured in the response, whi
<dl>
<dd>

**strip_headers:** `typing.Optional[bool]` — If enabled, the audio for all the chunks of a generation, once concatenated together, will constitute a single audio file. Otherwise, if disabled, each chunk's audio will be its own audio file, each with its own headers (if applicable).

</dd>
</dl>

<dl>
<dd>

**instant_mode:** `typing.Optional[bool]`

Enables ultra-low latency streaming, significantly reducing the time until the first audio chunk is received. Recommended for real-time applications requiring immediate audio playback. For further details, see our documentation on [instant mode](/docs/text-to-speech-tts/overview#ultra-low-latency-streaming-instant-mode).
- Dynamic voice generation is not supported with this mode; a predefined [voice](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.utterances.voice) must be specified in your request.
- This mode is only supported for streaming endpoints (e.g., [/v0/tts/stream/json](/reference/text-to-speech-tts/synthesize-json-streaming), [/v0/tts/stream/file](/reference/text-to-speech-tts/synthesize-file-streaming)).
- Ensure only a single generation is requested ([num_generations](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.num_generations) must be `1` or omitted).
- With `instant_mode` enabled, **requests incur a 10% higher cost** due to increased compute and resource requirements.

</dd>
Expand Down Expand Up @@ -544,11 +571,20 @@ This setting affects how the `snippets` array is structured in the response, whi
<dl>
<dd>

**strip_headers:** `typing.Optional[bool]` — If enabled, the audio for all the chunks of a generation, once concatenated together, will constitute a single audio file. Otherwise, if disabled, each chunk's audio will be its own audio file, each with its own headers (if applicable).

</dd>
</dl>

<dl>
<dd>

**instant_mode:** `typing.Optional[bool]`

Enables ultra-low latency streaming, significantly reducing the time until the first audio chunk is received. Recommended for real-time applications requiring immediate audio playback. For further details, see our documentation on [instant mode](/docs/text-to-speech-tts/overview#ultra-low-latency-streaming-instant-mode).
- Dynamic voice generation is not supported with this mode; a predefined [voice](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.utterances.voice) must be specified in your request.
- This mode is only supported for streaming endpoints (e.g., [/v0/tts/stream/json](/reference/text-to-speech-tts/synthesize-json-streaming), [/v0/tts/stream/file](/reference/text-to-speech-tts/synthesize-file-streaming)).
- Ensure only a single generation is requested ([num_generations](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.num_generations) must be `1` or omitted).
- With `instant_mode` enabled, **requests incur a 10% higher cost** due to increased compute and resource requirements.

</dd>
Expand Down
Loading
Loading