From a7a2cff0319db54a64c06171db4f3687c7f43009 Mon Sep 17 00:00:00 2001
From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com>
Date: Fri, 27 Feb 2026 16:01:50 +0000
Subject: [PATCH] SDK regeneration
---
.fern/metadata.json | 6 +-
poetry.lock | 20 +-
pyproject.toml | 2 +-
reference.md | 5105 -----------------
src/hume/base_client.py | 47 +-
src/hume/core/__init__.py | 18 +-
src/hume/core/client_wrapper.py | 19 +-
src/hume/core/custom_pagination.py | 152 -
src/hume/core/http_client.py | 195 +-
src/hume/core/logging.py | 107 +
src/hume/core/pydantic_utilities.py | 33 +-
src/hume/empathic_voice/__init__.py | 3 +
src/hume/empathic_voice/chat_groups/client.py | 16 +-
src/hume/empathic_voice/chats/client.py | 8 +-
src/hume/empathic_voice/configs/client.py | 36 +-
src/hume/empathic_voice/prompts/client.py | 65 +-
src/hume/empathic_voice/prompts/raw_client.py | 26 +
src/hume/empathic_voice/tools/client.py | 28 +-
src/hume/empathic_voice/types/__init__.py | 3 +
.../types/language_model_type.py | 5 +
.../types/model_provider_enum.py | 1 +
.../types/posted_config_prompt_spec.py | 2 +
.../empathic_voice/types/posted_ellm_model.py | 4 +-
.../types/prompt_expansion_spec.py | 28 +
.../types/return_chat_event_type.py | 14 +-
.../empathic_voice/types/return_ellm_model.py | 4 +-
.../empathic_voice/types/return_prompt.py | 2 +
src/hume/tts/voices/client.py | 4 +-
tests/conftest.py | 37 +-
tests/wire/conftest.py | 34 +-
tests/wire/test_empathicVoice_chatGroups.py | 21 +-
tests/wire/test_empathicVoice_chats.py | 10 +-
tests/wire/test_empathicVoice_configs.py | 36 +-
tests/wire/test_empathicVoice_prompts.py | 32 +-
tests/wire/test_empathicVoice_tools.py | 30 +-
tests/wire/test_tts.py | 2 +-
tests/wire/test_tts_voices.py | 2 +-
wiremock/wiremock-mappings.json | 2 +-
38 files changed, 613 insertions(+), 5546 deletions(-)
delete mode 100644 reference.md
delete mode 100644 src/hume/core/custom_pagination.py
create mode 100644 src/hume/core/logging.py
create mode 100644 src/hume/empathic_voice/types/prompt_expansion_spec.py
diff --git a/.fern/metadata.json b/.fern/metadata.json
index a30eb0cb..a78d8e44 100644
--- a/.fern/metadata.json
+++ b/.fern/metadata.json
@@ -1,7 +1,7 @@
{
- "cliVersion": "3.70.0",
+ "cliVersion": "3.90.2",
"generatorName": "fernapi/fern-python-sdk",
- "generatorVersion": "4.55.3",
+ "generatorVersion": "4.60.1",
"generatorConfig": {
"should_generate_websocket_clients": true,
"pyproject_python_version": ">=3.9,<4",
@@ -64,5 +64,5 @@
}
]
},
- "sdkVersion": "0.13.8"
+ "sdkVersion": "0.13.9"
}
\ No newline at end of file
diff --git a/poetry.lock b/poetry.lock
index f40bffbe..8cadfe66 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -241,13 +241,13 @@ css = ["tinycss2 (>=1.1.0,<1.5)"]
[[package]]
name = "certifi"
-version = "2026.1.4"
+version = "2026.2.25"
description = "Python package for providing Mozilla's CA Bundle."
optional = false
python-versions = ">=3.7"
files = [
- {file = "certifi-2026.1.4-py3-none-any.whl", hash = "sha256:9943707519e4add1115f44c2bc244f782c0249876bf51b6599fee1ffbedd685c"},
- {file = "certifi-2026.1.4.tar.gz", hash = "sha256:ac726dd470482006e014ad384921ed6438c457018f4b3d204aea4281258b2120"},
+ {file = "certifi-2026.2.25-py3-none-any.whl", hash = "sha256:027692e4402ad994f1c42e52a4997a9763c646b73e4096e4d5d6db8af1d6f0fa"},
+ {file = "certifi-2026.2.25.tar.gz", hash = "sha256:e887ab5cee78ea814d3472169153c2d12cd43b14bd03329a39a9c6e2e80bfba7"},
]
[[package]]
@@ -1298,13 +1298,13 @@ test = ["jupyter-server (>=2.0.0)", "pytest (>=7.0)", "pytest-jupyter[server] (>
[[package]]
name = "jupyterlab"
-version = "4.5.3"
+version = "4.5.5"
description = "JupyterLab computational environment"
optional = true
python-versions = ">=3.9"
files = [
- {file = "jupyterlab-4.5.3-py3-none-any.whl", hash = "sha256:63c9f3a48de72ba00df766ad6eed416394f5bb883829f11eeff0872302520ba7"},
- {file = "jupyterlab-4.5.3.tar.gz", hash = "sha256:4a159f71067cb38e4a82e86a42de8e7e926f384d7f2291964f282282096d27e8"},
+ {file = "jupyterlab-4.5.5-py3-none-any.whl", hash = "sha256:a35694a40a8e7f2e82f387472af24e61b22adcce87b5a8ab97a5d9c486202a6d"},
+ {file = "jupyterlab-4.5.5.tar.gz", hash = "sha256:eac620698c59eb810e1729909be418d9373d18137cac66637141abba613b3fda"},
]
[package.dependencies]
@@ -1746,18 +1746,18 @@ files = [
[[package]]
name = "notebook"
-version = "7.5.3"
+version = "7.5.4"
description = "Jupyter Notebook - A web-based notebook environment for interactive computing"
optional = true
python-versions = ">=3.9"
files = [
- {file = "notebook-7.5.3-py3-none-any.whl", hash = "sha256:c997bfa1a2a9eb58c9bbb7e77d50428befb1033dd6f02c482922e96851d67354"},
- {file = "notebook-7.5.3.tar.gz", hash = "sha256:393ceb269cf9fdb02a3be607a57d7bd5c2c14604f1818a17dbeb38e04f98cbfa"},
+ {file = "notebook-7.5.4-py3-none-any.whl", hash = "sha256:860e31782b3d3a25ca0819ff039f5cf77845d1bf30c78ef9528b88b25e0a9850"},
+ {file = "notebook-7.5.4.tar.gz", hash = "sha256:b928b2ba22cb63aa83df2e0e76fe3697950a0c1c4a41b84ebccf1972b1bb5771"},
]
[package.dependencies]
jupyter-server = ">=2.4.0,<3"
-jupyterlab = ">=4.5.3,<4.6"
+jupyterlab = ">=4.5.5,<4.6"
jupyterlab-server = ">=2.28.0,<3"
notebook-shim = ">=0.2,<0.3"
tornado = ">=6.2.0"
diff --git a/pyproject.toml b/pyproject.toml
index 9cb33ec1..69deb566 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ dynamic = ["version"]
[tool.poetry]
name = "hume"
-version = "0.13.8"
+version = "0.13.9"
description = "A Python SDK for Hume AI"
readme = "README.md"
authors = []
diff --git a/reference.md b/reference.md
deleted file mode 100644
index 9b22384f..00000000
--- a/reference.md
+++ /dev/null
@@ -1,5105 +0,0 @@
-# Reference
-## Tts
-client.tts.synthesize_json(...) -> AsyncHttpResponse[ReturnTts]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Synthesizes one or more input texts into speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
-
-The response includes the base64-encoded audio and metadata in JSON format.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-from hume.tts import FormatMp3, PostedContextWithUtterances, PostedUtterance
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.tts.synthesize_json(
- context=PostedContextWithUtterances(
- utterances=[
- PostedUtterance(
- text="How can people see beauty so differently?",
- description="A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question.",
- )
- ],
- ),
- format=FormatMp3(),
- num_generations=1,
- utterances=[
- PostedUtterance(
- text="Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
- description="Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality.",
- )
- ],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**utterances:** `typing.Sequence[PostedUtterance]`
-
-A list of **Utterances** to be converted to speech output.
-
-An **Utterance** is a unit of input for [Octave](/docs/text-to-speech-tts/overview), and includes input `text`, an optional `description` to serve as the prompt for how the speech should be delivered, an optional `voice` specification, and additional controls to guide delivery for `speed` and `trailing_silence`.
-
-
-
-
-
--
-
-**context:** `typing.Optional[PostedContext]` — Utterances to use as context for generating consistent speech style and prosody across multiple requests. These will not be converted to speech output.
-
-
-
-
-
--
-
-**format:** `typing.Optional[Format]` — Specifies the output audio file format.
-
-
-
-
-
--
-
-**include_timestamp_types:** `typing.Optional[typing.Sequence[TimestampType]]` — The set of timestamp types to include in the response. Only supported for Octave 2 requests.
-
-
-
-
-
--
-
-**num_generations:** `typing.Optional[int]`
-
-Number of audio generations to produce from the input utterances.
-
-Using `num_generations` enables faster processing than issuing multiple sequential requests. Additionally, specifying `num_generations` allows prosody continuation across all generations without repeating context, ensuring each generation sounds slightly different while maintaining contextual consistency.
-
-
-
-
-
--
-
-**split_utterances:** `typing.Optional[bool]`
-
-Controls how audio output is segmented in the response.
-
-- When **enabled** (`true`), input utterances are automatically split into natural-sounding speech segments.
-
-- When **disabled** (`false`), the response maintains a strict one-to-one mapping between input utterances and output snippets.
-
-This setting affects how the `snippets` array is structured in the response, which may be important for applications that need to track the relationship between input text and generated audio segments. When setting to `false`, avoid including utterances with long `text`, as this can result in distorted output.
-
-
-
-
-
--
-
-**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).
-
-
-
-
-
--
-
-**version:** `typing.Optional[OctaveVersion]`
-
-Selects the Octave model version used to synthesize speech for this request. If you omit this field, Hume automatically routes the request to the most appropriate model. Setting a specific version ensures stable and repeatable behavior across requests.
-
-Use `2` to opt into the latest Octave capabilities. When you specify version `2`, you must also provide a `voice`. Requests that set `version: 2` without a voice will be rejected.
-
-For a comparison of Octave versions, see the [Octave versions](/docs/text-to-speech-tts/overview#octave-versions) section in the TTS overview.
-
-
-
-
-
--
-
-**instant_mode:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.tts.synthesize_file(...) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[bytes]]]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Synthesizes one or more input texts into speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
-
-The response contains the generated audio file in the requested format.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-from hume.tts import FormatMp3, PostedContextWithGenerationId, PostedUtterance
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.tts.synthesize_file(
- context=PostedContextWithGenerationId(
- generation_id="09ad914d-8e7f-40f8-a279-e34f07f7dab2",
- ),
- format=FormatMp3(),
- num_generations=1,
- utterances=[
- PostedUtterance(
- text="Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
- description="Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality.",
- )
- ],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**utterances:** `typing.Sequence[PostedUtterance]`
-
-A list of **Utterances** to be converted to speech output.
-
-An **Utterance** is a unit of input for [Octave](/docs/text-to-speech-tts/overview), and includes input `text`, an optional `description` to serve as the prompt for how the speech should be delivered, an optional `voice` specification, and additional controls to guide delivery for `speed` and `trailing_silence`.
-
-
-
-
-
--
-
-**context:** `typing.Optional[PostedContext]` — Utterances to use as context for generating consistent speech style and prosody across multiple requests. These will not be converted to speech output.
-
-
-
-
-
--
-
-**format:** `typing.Optional[Format]` — Specifies the output audio file format.
-
-
-
-
-
--
-
-**include_timestamp_types:** `typing.Optional[typing.Sequence[TimestampType]]` — The set of timestamp types to include in the response. Only supported for Octave 2 requests.
-
-
-
-
-
--
-
-**num_generations:** `typing.Optional[int]`
-
-Number of audio generations to produce from the input utterances.
-
-Using `num_generations` enables faster processing than issuing multiple sequential requests. Additionally, specifying `num_generations` allows prosody continuation across all generations without repeating context, ensuring each generation sounds slightly different while maintaining contextual consistency.
-
-
-
-
-
--
-
-**split_utterances:** `typing.Optional[bool]`
-
-Controls how audio output is segmented in the response.
-
-- When **enabled** (`true`), input utterances are automatically split into natural-sounding speech segments.
-
-- When **disabled** (`false`), the response maintains a strict one-to-one mapping between input utterances and output snippets.
-
-This setting affects how the `snippets` array is structured in the response, which may be important for applications that need to track the relationship between input text and generated audio segments. When setting to `false`, avoid including utterances with long `text`, as this can result in distorted output.
-
-
-
-
-
--
-
-**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).
-
-
-
-
-
--
-
-**version:** `typing.Optional[OctaveVersion]`
-
-Selects the Octave model version used to synthesize speech for this request. If you omit this field, Hume automatically routes the request to the most appropriate model. Setting a specific version ensures stable and repeatable behavior across requests.
-
-Use `2` to opt into the latest Octave capabilities. When you specify version `2`, you must also provide a `voice`. Requests that set `version: 2` without a voice will be rejected.
-
-For a comparison of Octave versions, see the [Octave versions](/docs/text-to-speech-tts/overview#octave-versions) section in the TTS overview.
-
-
-
-
-
--
-
-**instant_mode:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
-
-
-
-
-
-
-
-
-
-client.tts.synthesize_file_streaming(...) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[bytes]]]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-from hume.tts import PostedUtterance, PostedUtteranceVoiceWithName
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.tts.synthesize_file_streaming(
- utterances=[
- PostedUtterance(
- text="Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
- voice=PostedUtteranceVoiceWithName(
- name="Male English Actor",
- provider="HUME_AI",
- ),
- )
- ],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**utterances:** `typing.Sequence[PostedUtterance]`
-
-A list of **Utterances** to be converted to speech output.
-
-An **Utterance** is a unit of input for [Octave](/docs/text-to-speech-tts/overview), and includes input `text`, an optional `description` to serve as the prompt for how the speech should be delivered, an optional `voice` specification, and additional controls to guide delivery for `speed` and `trailing_silence`.
-
-
-
-
-
--
-
-**context:** `typing.Optional[PostedContext]` — Utterances to use as context for generating consistent speech style and prosody across multiple requests. These will not be converted to speech output.
-
-
-
-
-
--
-
-**format:** `typing.Optional[Format]` — Specifies the output audio file format.
-
-
-
-
-
--
-
-**include_timestamp_types:** `typing.Optional[typing.Sequence[TimestampType]]` — The set of timestamp types to include in the response. Only supported for Octave 2 requests.
-
-
-
-
-
--
-
-**num_generations:** `typing.Optional[int]`
-
-Number of audio generations to produce from the input utterances.
-
-Using `num_generations` enables faster processing than issuing multiple sequential requests. Additionally, specifying `num_generations` allows prosody continuation across all generations without repeating context, ensuring each generation sounds slightly different while maintaining contextual consistency.
-
-
-
-
-
--
-
-**split_utterances:** `typing.Optional[bool]`
-
-Controls how audio output is segmented in the response.
-
-- When **enabled** (`true`), input utterances are automatically split into natural-sounding speech segments.
-
-- When **disabled** (`false`), the response maintains a strict one-to-one mapping between input utterances and output snippets.
-
-This setting affects how the `snippets` array is structured in the response, which may be important for applications that need to track the relationship between input text and generated audio segments. When setting to `false`, avoid including utterances with long `text`, as this can result in distorted output.
-
-
-
-
-
--
-
-**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).
-
-
-
-
-
--
-
-**version:** `typing.Optional[OctaveVersion]`
-
-Selects the Octave model version used to synthesize speech for this request. If you omit this field, Hume automatically routes the request to the most appropriate model. Setting a specific version ensures stable and repeatable behavior across requests.
-
-Use `2` to opt into the latest Octave capabilities. When you specify version `2`, you must also provide a `voice`. Requests that set `version: 2` without a voice will be rejected.
-
-For a comparison of Octave versions, see the [Octave versions](/docs/text-to-speech-tts/overview#octave-versions) section in the TTS overview.
-
-
-
-
-
--
-
-**instant_mode:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
-
-
-
-
-
-
-
-
-
-client.tts.synthesize_json_streaming(...) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[TtsOutput]]]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
-
-The response is a stream of JSON objects including audio encoded in base64.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-from hume.tts import PostedUtterance, PostedUtteranceVoiceWithName
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-response = client.tts.synthesize_json_streaming(
- utterances=[
- PostedUtterance(
- text="Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
- voice=PostedUtteranceVoiceWithName(
- name="Male English Actor",
- provider="HUME_AI",
- ),
- )
- ],
-)
-for chunk in response.data:
- yield chunk
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**utterances:** `typing.Sequence[PostedUtterance]`
-
-A list of **Utterances** to be converted to speech output.
-
-An **Utterance** is a unit of input for [Octave](/docs/text-to-speech-tts/overview), and includes input `text`, an optional `description` to serve as the prompt for how the speech should be delivered, an optional `voice` specification, and additional controls to guide delivery for `speed` and `trailing_silence`.
-
-
-
-
-
--
-
-**context:** `typing.Optional[PostedContext]` — Utterances to use as context for generating consistent speech style and prosody across multiple requests. These will not be converted to speech output.
-
-
-
-
-
--
-
-**format:** `typing.Optional[Format]` — Specifies the output audio file format.
-
-
-
-
-
--
-
-**include_timestamp_types:** `typing.Optional[typing.Sequence[TimestampType]]` — The set of timestamp types to include in the response. Only supported for Octave 2 requests.
-
-
-
-
-
--
-
-**num_generations:** `typing.Optional[int]`
-
-Number of audio generations to produce from the input utterances.
-
-Using `num_generations` enables faster processing than issuing multiple sequential requests. Additionally, specifying `num_generations` allows prosody continuation across all generations without repeating context, ensuring each generation sounds slightly different while maintaining contextual consistency.
-
-
-
-
-
--
-
-**split_utterances:** `typing.Optional[bool]`
-
-Controls how audio output is segmented in the response.
-
-- When **enabled** (`true`), input utterances are automatically split into natural-sounding speech segments.
-
-- When **disabled** (`false`), the response maintains a strict one-to-one mapping between input utterances and output snippets.
-
-This setting affects how the `snippets` array is structured in the response, which may be important for applications that need to track the relationship between input text and generated audio segments. When setting to `false`, avoid including utterances with long `text`, as this can result in distorted output.
-
-
-
-
-
--
-
-**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).
-
-
-
-
-
--
-
-**version:** `typing.Optional[OctaveVersion]`
-
-Selects the Octave model version used to synthesize speech for this request. If you omit this field, Hume automatically routes the request to the most appropriate model. Setting a specific version ensures stable and repeatable behavior across requests.
-
-Use `2` to opt into the latest Octave capabilities. When you specify version `2`, you must also provide a `voice`. Requests that set `version: 2` without a voice will be rejected.
-
-For a comparison of Octave versions, see the [Octave versions](/docs/text-to-speech-tts/overview#octave-versions) section in the TTS overview.
-
-
-
-
-
--
-
-**instant_mode:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.tts.convert_voice_json(...) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[TtsOutput]]]
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-response = client.tts.convert_voice_json()
-for chunk in response.data:
- yield chunk
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**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).
-
-
-
-
-
--
-
-**audio:** `from __future__ import annotations
-
-typing.Optional[core.File]` — See core.File for more documentation
-
-
-
-
-
--
-
-**context:** `typing.Optional[PostedContext]` — Utterances to use as context for generating consistent speech style and prosody across multiple requests. These will not be converted to speech output.
-
-
-
-
-
--
-
-**voice:** `typing.Optional[PostedUtteranceVoice]`
-
-
-
-
-
--
-
-**format:** `typing.Optional[Format]` — Specifies the output audio file format.
-
-
-
-
-
--
-
-**include_timestamp_types:** `typing.Optional[typing.List[TimestampType]]` — The set of timestamp types to include in the response. When used in multipart/form-data, specify each value using bracket notation: `include_timestamp_types[0]=word&include_timestamp_types[1]=phoneme`. Only supported for Octave 2 requests.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.tts.voices.list(...) -> AsyncPager[ReturnVoice, ReturnPagedVoices]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Lists voices you have saved in your account, or voices from the [Voice Library](https://app.hume.ai/tts/voice-library).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-response = client.tts.voices.list(
- provider="CUSTOM_VOICE",
-)
-for item in response:
- yield item
-# alternatively, you can paginate page-by-page
-for page in response.iter_pages():
- yield page
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**provider:** `VoiceProvider`
-
-Specify the voice provider to filter voices returned by the endpoint:
-
-- **`HUME_AI`**: Lists preset, shared voices from Hume's [Voice Library](https://app.hume.ai/tts/voice-library).
-- **`CUSTOM_VOICE`**: Lists custom voices created and saved to your account.
-
-
-
-
-
--
-
-**page_number:** `typing.Optional[int]`
-
-Specifies the page number to retrieve, enabling pagination.
-
-This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]`
-
-Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
-
-For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
-
-
-
-
-
--
-
-**ascending_order:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**filter_tag:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.tts.voices.create(...) -> AsyncHttpResponse[ReturnVoice]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Saves a new custom voice to your account using the specified TTS generation ID.
-
-Once saved, this voice can be reused in subsequent TTS requests, ensuring consistent speech style and prosody. For more details on voice creation, see the [Voices Guide](/docs/text-to-speech-tts/voices).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.tts.voices.create(
- generation_id="795c949a-1510-4a80-9646-7d0863b023ab",
- name="David Hume",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**generation_id:** `str` — A unique ID associated with this TTS generation that can be used as context for generating consistent speech style and prosody across multiple requests.
-
-
-
-
-
--
-
-**name:** `str` — The name of a **Voice**.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.tts.voices.delete(...) -> AsyncHttpResponse[None]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes a previously generated custom voice.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.tts.voices.delete(
- name="David Hume",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str` — Name of the voice to delete
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.control_plane.send(...) -> AsyncHttpResponse[None]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Send a message to a specific chat.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-from hume.empathic_voice import SessionSettings
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.control_plane.send(
- chat_id="chat_id",
- request=SessionSettings(),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**chat_id:** `str`
-
-
-
-
-
--
-
-**request:** `ControlPlanePublishEvent`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.chat_groups.list_chat_groups(...) -> AsyncPager[ReturnChatGroup, ReturnPagedChatGroups]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a paginated list of **Chat Groups**.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-response = client.empathic_voice.chat_groups.list_chat_groups(
- page_number=0,
- page_size=1,
- ascending_order=True,
- config_id="1b60e1a0-cc59-424a-8d2c-189d354db3f3",
-)
-for item in response:
- yield item
-# alternatively, you can paginate page-by-page
-for page in response.iter_pages():
- yield page
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**page_number:** `typing.Optional[int]`
-
-Specifies the page number to retrieve, enabling pagination.
-
-This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]`
-
-Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
-
-For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
-
-
-
-
-
--
-
-**ascending_order:** `typing.Optional[bool]` — Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true.
-
-
-
-
-
--
-
-**config_id:** `typing.Optional[str]`
-
-The unique identifier for an EVI configuration.
-
-Filter Chat Groups to only include Chats that used this `config_id` in their most recent Chat.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.chat_groups.get_chat_group(...) -> AsyncHttpResponse[ReturnChatGroupPagedChats]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.chat_groups.get_chat_group(
- id="697056f0-6c7e-487d-9bd8-9c19df79f05f",
- page_number=0,
- page_size=1,
- ascending_order=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Chat Group. Formatted as a UUID.
-
-
-
-
-
--
-
-**status:** `typing.Optional[str]` — Chat status to apply to the chat. String from the ChatStatus enum.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]`
-
-Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
-
-For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
-
-
-
-
-
--
-
-**page_number:** `typing.Optional[int]`
-
-Specifies the page number to retrieve, enabling pagination.
-
-This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
-
-
-
-
-
--
-
-**ascending_order:** `typing.Optional[bool]` — Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.chat_groups.get_audio(...) -> AsyncHttpResponse[ReturnChatGroupPagedAudioReconstructions]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a paginated list of audio for each **Chat** within the specified **Chat Group**. For more details, see our guide on audio reconstruction [here](/docs/speech-to-speech-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.chat_groups.get_audio(
- id="369846cf-6ad5-404d-905e-a8acb5cdfc78",
- page_number=0,
- page_size=10,
- ascending_order=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Chat Group. Formatted as a UUID.
-
-
-
-
-
--
-
-**page_number:** `typing.Optional[int]`
-
-Specifies the page number to retrieve, enabling pagination.
-
-This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]`
-
-Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
-
-For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
-
-
-
-
-
--
-
-**ascending_order:** `typing.Optional[bool]` — Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.chat_groups.list_chat_group_events(...) -> AsyncPager[ReturnChatEvent, ReturnChatGroupPagedEvents]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a paginated list of **Chat** events associated with a **Chat Group**.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-response = client.empathic_voice.chat_groups.list_chat_group_events(
- id="697056f0-6c7e-487d-9bd8-9c19df79f05f",
- page_number=0,
- page_size=3,
- ascending_order=True,
-)
-for item in response:
- yield item
-# alternatively, you can paginate page-by-page
-for page in response.iter_pages():
- yield page
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Chat Group. Formatted as a UUID.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]`
-
-Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
-
-For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
-
-
-
-
-
--
-
-**page_number:** `typing.Optional[int]`
-
-Specifies the page number to retrieve, enabling pagination.
-
-This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
-
-
-
-
-
--
-
-**ascending_order:** `typing.Optional[bool]` — Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.chats.list_chats(...) -> AsyncPager[ReturnChat, ReturnPagedChats]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a paginated list of **Chats**.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-response = client.empathic_voice.chats.list_chats(
- page_number=0,
- page_size=1,
- ascending_order=True,
-)
-for item in response:
- yield item
-# alternatively, you can paginate page-by-page
-for page in response.iter_pages():
- yield page
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**page_number:** `typing.Optional[int]`
-
-Specifies the page number to retrieve, enabling pagination.
-
-This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]`
-
-Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
-
-For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
-
-
-
-
-
--
-
-**ascending_order:** `typing.Optional[bool]` — Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true.
-
-
-
-
-
--
-
-**config_id:** `typing.Optional[str]` — Filter to only include chats that used this config.
-
-
-
-
-
--
-
-**status:** `typing.Optional[str]` — Chat status to apply to the chat. String from the ChatStatus enum.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.chats.list_chat_events(...) -> AsyncPager[ReturnChatEvent, ReturnChatPagedEvents]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a paginated list of **Chat** events.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-response = client.empathic_voice.chats.list_chat_events(
- id="470a49f6-1dec-4afe-8b61-035d3b2d63b0",
- page_number=0,
- page_size=3,
- ascending_order=True,
-)
-for item in response:
- yield item
-# alternatively, you can paginate page-by-page
-for page in response.iter_pages():
- yield page
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Chat. Formatted as a UUID.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]`
-
-Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
-
-For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
-
-
-
-
-
--
-
-**page_number:** `typing.Optional[int]`
-
-Specifies the page number to retrieve, enabling pagination.
-
-This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
-
-
-
-
-
--
-
-**ascending_order:** `typing.Optional[bool]` — Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.chats.get_audio(...) -> AsyncHttpResponse[ReturnChatAudioReconstruction]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches the audio of a previous **Chat**. For more details, see our guide on audio reconstruction [here](/docs/speech-to-speech-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.chats.get_audio(
- id="470a49f6-1dec-4afe-8b61-035d3b2d63b0",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Chat. Formatted as a UUID.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.configs.list_configs(...) -> AsyncPager[ReturnConfig, ReturnPagedConfigs]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a paginated list of **Configs**.
-
-For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-response = client.empathic_voice.configs.list_configs(
- page_number=0,
- page_size=1,
-)
-for item in response:
- yield item
-# alternatively, you can paginate page-by-page
-for page in response.iter_pages():
- yield page
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**page_number:** `typing.Optional[int]`
-
-Specifies the page number to retrieve, enabling pagination.
-
-This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]`
-
-Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
-
-For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
-
-
-
-
-
--
-
-**restrict_to_most_recent:** `typing.Optional[bool]` — By default, `restrict_to_most_recent` is set to true, returning only the latest version of each config. To include all versions of each config in the list, set `restrict_to_most_recent` to false.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` — Filter to only include configs with this name.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.configs.create_config(...) -> AsyncHttpResponse[ReturnConfig]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a **Config** which can be applied to EVI.
-
-For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-from hume.empathic_voice import (
- PostedConfigPromptSpec,
- PostedEventMessageSpec,
- PostedEventMessageSpecs,
- PostedLanguageModel,
- VoiceName,
-)
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.configs.create_config(
- name="Weather Assistant Config",
- prompt=PostedConfigPromptSpec(
- id="af699d45-2985-42cc-91b9-af9e5da3bac5",
- version=0,
- ),
- evi_version="3",
- voice=VoiceName(
- provider="HUME_AI",
- name="Ava Song",
- ),
- language_model=PostedLanguageModel(
- model_provider="ANTHROPIC",
- model_resource="claude-3-7-sonnet-latest",
- temperature=1.0,
- ),
- event_messages=PostedEventMessageSpecs(
- on_new_chat=PostedEventMessageSpec(
- enabled=False,
- text="",
- ),
- on_inactivity_timeout=PostedEventMessageSpec(
- enabled=False,
- text="",
- ),
- on_max_duration_timeout=PostedEventMessageSpec(
- enabled=False,
- text="",
- ),
- ),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**evi_version:** `str` — EVI version to use. Only versions `3` and `4-mini` are supported.
-
-
-
-
-
--
-
-**name:** `str` — Name applied to all versions of a particular Config.
-
-
-
-
-
--
-
-**builtin_tools:** `typing.Optional[typing.Sequence[typing.Optional[PostedBuiltinTool]]]` — Built-in tool specification for a Config.
-
-
-
-
-
--
-
-**ellm_model:** `typing.Optional[PostedEllmModel]`
-
-
-
-
-
--
-
-**event_messages:** `typing.Optional[PostedEventMessageSpecs]`
-
-
-
-
-
--
-
-**language_model:** `typing.Optional[PostedLanguageModel]`
-
-
-
-
-
--
-
-**nudges:** `typing.Optional[PostedNudgeSpec]`
-
-
-
-
-
--
-
-**prompt:** `typing.Optional[PostedConfigPromptSpec]`
-
-
-
-
-
--
-
-**timeouts:** `typing.Optional[PostedTimeoutSpecs]`
-
-
-
-
-
--
-
-**tools:** `typing.Optional[typing.Sequence[typing.Optional[PostedUserDefinedToolSpec]]]` — Tool specification for a Config.
-
-
-
-
-
--
-
-**version_description:** `typing.Optional[str]` — An optional description of the Config version.
-
-
-
-
-
--
-
-**voice:** `typing.Optional[VoiceRef]` — A voice specification associated with this Config.
-
-
-
-
-
--
-
-**webhooks:** `typing.Optional[typing.Sequence[typing.Optional[PostedWebhookSpec]]]` — Webhook config specifications for each subscriber.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.configs.list_config_versions(...) -> AsyncPager[ReturnConfig, ReturnPagedConfigs]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a list of a **Config's** versions.
-
-For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-response = client.empathic_voice.configs.list_config_versions(
- id="1b60e1a0-cc59-424a-8d2c-189d354db3f3",
-)
-for item in response:
- yield item
-# alternatively, you can paginate page-by-page
-for page in response.iter_pages():
- yield page
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Config. Formatted as a UUID.
-
-
-
-
-
--
-
-**page_number:** `typing.Optional[int]`
-
-Specifies the page number to retrieve, enabling pagination.
-
-This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]`
-
-Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
-
-For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
-
-
-
-
-
--
-
-**restrict_to_most_recent:** `typing.Optional[bool]` — By default, `restrict_to_most_recent` is set to true, returning only the latest version of each config. To include all versions of each config in the list, set `restrict_to_most_recent` to false.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.configs.create_config_version(...) -> AsyncHttpResponse[ReturnConfig]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates a **Config** by creating a new version of the **Config**.
-
-For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-from hume.empathic_voice import (
- PostedConfigPromptSpec,
- PostedEllmModel,
- PostedEventMessageSpec,
- PostedEventMessageSpecs,
- PostedLanguageModel,
- VoiceName,
-)
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.configs.create_config_version(
- id="1b60e1a0-cc59-424a-8d2c-189d354db3f3",
- version_description="This is an updated version of the Weather Assistant Config.",
- evi_version="3",
- prompt=PostedConfigPromptSpec(
- id="af699d45-2985-42cc-91b9-af9e5da3bac5",
- version=0,
- ),
- voice=VoiceName(
- provider="HUME_AI",
- name="Ava Song",
- ),
- language_model=PostedLanguageModel(
- model_provider="ANTHROPIC",
- model_resource="claude-3-7-sonnet-latest",
- temperature=1.0,
- ),
- ellm_model=PostedEllmModel(
- allow_short_responses=True,
- ),
- event_messages=PostedEventMessageSpecs(
- on_new_chat=PostedEventMessageSpec(
- enabled=False,
- text="",
- ),
- on_inactivity_timeout=PostedEventMessageSpec(
- enabled=False,
- text="",
- ),
- on_max_duration_timeout=PostedEventMessageSpec(
- enabled=False,
- text="",
- ),
- ),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Config. Formatted as a UUID.
-
-
-
-
-
--
-
-**evi_version:** `str` — EVI version to use. Only versions `3` and `4-mini` are supported.
-
-
-
-
-
--
-
-**builtin_tools:** `typing.Optional[typing.Sequence[typing.Optional[PostedBuiltinTool]]]` — Built-in tool specification for a Config.
-
-
-
-
-
--
-
-**ellm_model:** `typing.Optional[PostedEllmModel]`
-
-
-
-
-
--
-
-**event_messages:** `typing.Optional[PostedEventMessageSpecs]`
-
-
-
-
-
--
-
-**language_model:** `typing.Optional[PostedLanguageModel]`
-
-
-
-
-
--
-
-**nudges:** `typing.Optional[PostedNudgeSpec]`
-
-
-
-
-
--
-
-**prompt:** `typing.Optional[PostedConfigPromptSpec]`
-
-
-
-
-
--
-
-**timeouts:** `typing.Optional[PostedTimeoutSpecs]`
-
-
-
-
-
--
-
-**tools:** `typing.Optional[typing.Sequence[typing.Optional[PostedUserDefinedToolSpec]]]` — Tool specification for a Config.
-
-
-
-
-
--
-
-**version_description:** `typing.Optional[str]` — An optional description of the Config version.
-
-
-
-
-
--
-
-**voice:** `typing.Optional[VoiceRef]`
-
-
-
-
-
--
-
-**webhooks:** `typing.Optional[typing.Sequence[typing.Optional[PostedWebhookSpec]]]` — Webhook config specifications for each subscriber.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.configs.delete_config(...) -> AsyncHttpResponse[None]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes a **Config** and its versions.
-
-For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.configs.delete_config(
- id="1b60e1a0-cc59-424a-8d2c-189d354db3f3",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Config. Formatted as a UUID.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.configs.update_config_name(...) -> AsyncHttpResponse[str]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates the name of a **Config**.
-
-For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.configs.update_config_name(
- id="1b60e1a0-cc59-424a-8d2c-189d354db3f3",
- name="Updated Weather Assistant Config Name",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Config. Formatted as a UUID.
-
-
-
-
-
--
-
-**name:** `str` — Name applied to all versions of a particular Config.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.configs.get_config_version(...) -> AsyncHttpResponse[ReturnConfig]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a specified version of a **Config**.
-
-For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.configs.get_config_version(
- id="1b60e1a0-cc59-424a-8d2c-189d354db3f3",
- version=1,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Config. Formatted as a UUID.
-
-
-
-
-
--
-
-**version:** `int`
-
-Version number for a Config.
-
-Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
-
-Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.configs.delete_config_version(...) -> AsyncHttpResponse[None]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes a specified version of a **Config**.
-
-For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.configs.delete_config_version(
- id="1b60e1a0-cc59-424a-8d2c-189d354db3f3",
- version=1,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Config. Formatted as a UUID.
-
-
-
-
-
--
-
-**version:** `int`
-
-Version number for a Config.
-
-Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
-
-Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.configs.update_config_description(...) -> AsyncHttpResponse[ReturnConfig]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates the description of a **Config**.
-
-For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.configs.update_config_description(
- id="1b60e1a0-cc59-424a-8d2c-189d354db3f3",
- version=1,
- version_description="This is an updated version_description.",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Config. Formatted as a UUID.
-
-
-
-
-
--
-
-**version:** `int`
-
-Version number for a Config.
-
-Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
-
-Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
-
-
-
-
-
--
-
-**version_description:** `typing.Optional[str]` — An optional description of the Config version.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.prompts.list_prompts(...) -> AsyncPager[typing.Optional[ReturnPrompt], ReturnPagedPrompts]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a paginated list of **Prompts**.
-
-See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-response = client.empathic_voice.prompts.list_prompts(
- page_number=0,
- page_size=2,
-)
-for item in response:
- yield item
-# alternatively, you can paginate page-by-page
-for page in response.iter_pages():
- yield page
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**page_number:** `typing.Optional[int]`
-
-Specifies the page number to retrieve, enabling pagination.
-
-This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]`
-
-Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
-
-For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
-
-
-
-
-
--
-
-**restrict_to_most_recent:** `typing.Optional[bool]` — By default, `restrict_to_most_recent` is set to true, returning only the latest version of each prompt. To include all versions of each prompt in the list, set `restrict_to_most_recent` to false.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` — Filter to only include prompts with name.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.prompts.create_prompt(...) -> AsyncHttpResponse[typing.Optional[ReturnPrompt]]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a **Prompt** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
-
-See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.prompts.create_prompt(
- name="Weather Assistant Prompt",
- text="You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str` — Name applied to all versions of a particular Prompt.
-
-
-
-
-
--
-
-**text:** `str`
-
-Instructions used to shape EVI's behavior, responses, and style.
-
-You can use the Prompt to define a specific goal or role for EVI, specifying how it should act or what it should focus on during the conversation. For example, EVI can be instructed to act as a customer support representative, a fitness coach, or a travel advisor, each with its own set of behaviors and response styles. For help writing a system prompt, see our [Prompting Guide](/docs/speech-to-speech-evi/guides/prompting).
-
-
-
-
-
--
-
-**version_description:** `typing.Optional[str]` — An optional description of the Prompt version.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.prompts.list_prompt_versions(...) -> AsyncHttpResponse[ReturnPagedPrompts]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a list of a **Prompt's** versions.
-
-See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.prompts.list_prompt_versions(
- id="af699d45-2985-42cc-91b9-af9e5da3bac5",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**page_number:** `typing.Optional[int]`
-
-Specifies the page number to retrieve, enabling pagination.
-
-This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]`
-
-Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
-
-For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
-
-
-
-
-
--
-
-**restrict_to_most_recent:** `typing.Optional[bool]` — By default, `restrict_to_most_recent` is set to true, returning only the latest version of each prompt. To include all versions of each prompt in the list, set `restrict_to_most_recent` to false.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.prompts.create_prompt_version(...) -> AsyncHttpResponse[typing.Optional[ReturnPrompt]]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates a **Prompt** by creating a new version of the **Prompt**.
-
-See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.prompts.create_prompt_version(
- id="af699d45-2985-42cc-91b9-af9e5da3bac5",
- text="You are an updated version of an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.",
- version_description="This is an updated version of the Weather Assistant Prompt.",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Prompt. Formatted as a UUID.
-
-
-
-
-
--
-
-**text:** `str`
-
-Instructions used to shape EVI's behavior, responses, and style.
-
-You can use the Prompt to define a specific goal or role for EVI, specifying how it should act or what it should focus on during the conversation. For example, EVI can be instructed to act as a customer support representative, a fitness coach, or a travel advisor, each with its own set of behaviors and response styles. For help writing a system prompt, see our [Prompting Guide](/docs/speech-to-speech-evi/guides/prompting).
-
-
-
-
-
--
-
-**version_description:** `typing.Optional[str]` — An optional description of the Prompt version.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.prompts.delete_prompt(...) -> AsyncHttpResponse[None]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes a **Prompt** and its versions.
-
-See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.prompts.delete_prompt(
- id="af699d45-2985-42cc-91b9-af9e5da3bac5",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Prompt. Formatted as a UUID.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.prompts.update_prompt_name(...) -> AsyncHttpResponse[str]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates the name of a **Prompt**.
-
-See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.prompts.update_prompt_name(
- id="af699d45-2985-42cc-91b9-af9e5da3bac5",
- name="Updated Weather Assistant Prompt Name",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Prompt. Formatted as a UUID.
-
-
-
-
-
--
-
-**name:** `str` — Name applied to all versions of a particular Prompt.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.prompts.get_prompt_version(...) -> AsyncHttpResponse[typing.Optional[ReturnPrompt]]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a specified version of a **Prompt**.
-
-See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.prompts.get_prompt_version(
- id="af699d45-2985-42cc-91b9-af9e5da3bac5",
- version=0,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Prompt. Formatted as a UUID.
-
-
-
-
-
--
-
-**version:** `int`
-
-Version number for a Prompt.
-
-Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
-
-Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.prompts.delete_prompt_version(...) -> AsyncHttpResponse[None]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes a specified version of a **Prompt**.
-
-See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.prompts.delete_prompt_version(
- id="af699d45-2985-42cc-91b9-af9e5da3bac5",
- version=1,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Prompt. Formatted as a UUID.
-
-
-
-
-
--
-
-**version:** `int`
-
-Version number for a Prompt.
-
-Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
-
-Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.prompts.update_prompt_description(...) -> AsyncHttpResponse[typing.Optional[ReturnPrompt]]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates the description of a **Prompt**.
-
-See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.prompts.update_prompt_description(
- id="af699d45-2985-42cc-91b9-af9e5da3bac5",
- version=1,
- version_description="This is an updated version_description.",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Prompt. Formatted as a UUID.
-
-
-
-
-
--
-
-**version:** `int`
-
-Version number for a Prompt.
-
-Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
-
-Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
-
-
-
-
-
--
-
-**version_description:** `typing.Optional[str]` — An optional description of the Prompt version.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.tools.list_tools(...) -> AsyncPager[typing.Optional[ReturnUserDefinedTool], ReturnPagedUserDefinedTools]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a paginated list of **Tools**.
-
-Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-response = client.empathic_voice.tools.list_tools(
- page_number=0,
- page_size=2,
-)
-for item in response:
- yield item
-# alternatively, you can paginate page-by-page
-for page in response.iter_pages():
- yield page
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**page_number:** `typing.Optional[int]`
-
-Specifies the page number to retrieve, enabling pagination.
-
-This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]`
-
-Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
-
-For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
-
-
-
-
-
--
-
-**restrict_to_most_recent:** `typing.Optional[bool]` — By default, `restrict_to_most_recent` is set to true, returning only the latest version of each tool. To include all versions of each tool in the list, set `restrict_to_most_recent` to false.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` — Filter to only include tools with name.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.tools.create_tool(...) -> AsyncHttpResponse[typing.Optional[ReturnUserDefinedTool]]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
-
-Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.tools.create_tool(
- name="get_current_weather",
- parameters='{ "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA" }, "format": { "type": "string", "enum": ["celsius", "fahrenheit"], "description": "The temperature unit to use. Infer this from the users location." } }, "required": ["location", "format"] }',
- version_description="Fetches current weather and uses celsius or fahrenheit based on location of user.",
- description="This tool is for getting the current weather.",
- fallback_content="Unable to fetch current weather.",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str`
-
-Name of the built-in tool to use. Hume supports the following built-in tools:
-
-- **web_search:** enables EVI to search the web for up-to-date information when applicable.
-- **hang_up:** closes the WebSocket connection when appropriate (e.g., after detecting a farewell in the conversation).
-
-For more information, see our guide on [using built-in tools](/docs/speech-to-speech-evi/features/tool-use#using-built-in-tools).
-
-
-
-
-
--
-
-**parameters:** `str`
-
-Stringified JSON defining the parameters used by this version of the Tool.
-
-These parameters define the inputs needed for the Tool's execution, including the expected data type and description for each input field. Structured as a stringified JSON schema, this format ensures the Tool receives data in the expected format.
-
-
-
-
-
--
-
-**description:** `typing.Optional[str]` — An optional description of what the Tool does, used by the supplemental LLM to choose when and how to call the function.
-
-
-
-
-
--
-
-**fallback_content:** `typing.Optional[str]` — Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors.
-
-
-
-
-
--
-
-**version_description:** `typing.Optional[str]` — An optional description of the Tool version.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.tools.list_tool_versions(...) -> AsyncPager[typing.Optional[ReturnUserDefinedTool], ReturnPagedUserDefinedTools]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a list of a **Tool's** versions.
-
-Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-response = client.empathic_voice.tools.list_tool_versions(
- id="00183a3f-79ba-413d-9f3b-609864268bea",
-)
-for item in response:
- yield item
-# alternatively, you can paginate page-by-page
-for page in response.iter_pages():
- yield page
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**page_number:** `typing.Optional[int]`
-
-Specifies the page number to retrieve, enabling pagination.
-
-This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]`
-
-Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
-
-For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
-
-
-
-
-
--
-
-**restrict_to_most_recent:** `typing.Optional[bool]` — By default, `restrict_to_most_recent` is set to true, returning only the latest version of each tool. To include all versions of each tool in the list, set `restrict_to_most_recent` to false.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.tools.create_tool_version(...) -> AsyncHttpResponse[typing.Optional[ReturnUserDefinedTool]]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates a **Tool** by creating a new version of the **Tool**.
-
-Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.tools.create_tool_version(
- id="00183a3f-79ba-413d-9f3b-609864268bea",
- parameters='{ "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA" }, "format": { "type": "string", "enum": ["celsius", "fahrenheit", "kelvin"], "description": "The temperature unit to use. Infer this from the users location." } }, "required": ["location", "format"] }',
- version_description="Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
- fallback_content="Unable to fetch current weather.",
- description="This tool is for getting the current weather.",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Tool. Formatted as a UUID.
-
-
-
-
-
--
-
-**parameters:** `str`
-
-Stringified JSON defining the parameters used by this version of the Tool.
-
-These parameters define the inputs needed for the Tool's execution, including the expected data type and description for each input field. Structured as a stringified JSON schema, this format ensures the Tool receives data in the expected format.
-
-
-
-
-
--
-
-**description:** `typing.Optional[str]` — An optional description of what the Tool does, used by the supplemental LLM to choose when and how to call the function.
-
-
-
-
-
--
-
-**fallback_content:** `typing.Optional[str]` — Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors.
-
-
-
-
-
--
-
-**version_description:** `typing.Optional[str]` — An optional description of the Tool version.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.tools.delete_tool(...) -> AsyncHttpResponse[None]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes a **Tool** and its versions.
-
-Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.tools.delete_tool(
- id="00183a3f-79ba-413d-9f3b-609864268bea",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Tool. Formatted as a UUID.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.tools.update_tool_name(...) -> AsyncHttpResponse[str]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates the name of a **Tool**.
-
-Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.tools.update_tool_name(
- id="00183a3f-79ba-413d-9f3b-609864268bea",
- name="get_current_temperature",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Tool. Formatted as a UUID.
-
-
-
-
-
--
-
-**name:** `str`
-
-Name of the built-in tool to use. Hume supports the following built-in tools:
-
-- **web_search:** enables EVI to search the web for up-to-date information when applicable.
-- **hang_up:** closes the WebSocket connection when appropriate (e.g., after detecting a farewell in the conversation).
-
-For more information, see our guide on [using built-in tools](/docs/speech-to-speech-evi/features/tool-use#using-built-in-tools).
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.tools.get_tool_version(...) -> AsyncHttpResponse[typing.Optional[ReturnUserDefinedTool]]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Fetches a specified version of a **Tool**.
-
-Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.tools.get_tool_version(
- id="00183a3f-79ba-413d-9f3b-609864268bea",
- version=1,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Tool. Formatted as a UUID.
-
-
-
-
-
--
-
-**version:** `int`
-
-Version number for a Tool.
-
-Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
-
-Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.tools.delete_tool_version(...) -> AsyncHttpResponse[None]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes a specified version of a **Tool**.
-
-Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.tools.delete_tool_version(
- id="00183a3f-79ba-413d-9f3b-609864268bea",
- version=1,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Tool. Formatted as a UUID.
-
-
-
-
-
--
-
-**version:** `int`
-
-Version number for a Tool.
-
-Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
-
-Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.empathic_voice.tools.update_tool_description(...) -> AsyncHttpResponse[typing.Optional[ReturnUserDefinedTool]]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates the description of a specified **Tool** version.
-
-Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.empathic_voice.tools.update_tool_description(
- id="00183a3f-79ba-413d-9f3b-609864268bea",
- version=1,
- version_description="Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — Identifier for a Tool. Formatted as a UUID.
-
-
-
-
-
--
-
-**version:** `int`
-
-Version number for a Tool.
-
-Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
-
-Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
-
-
-
-
-
--
-
-**version_description:** `typing.Optional[str]` — An optional description of the Tool version.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.expression_measurement.batch.list_jobs(...) -> AsyncHttpResponse[typing.List[UnionJob]]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Sort and filter jobs.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.expression_measurement.batch.list_jobs()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**limit:** `typing.Optional[int]` — The maximum number of jobs to include in the response.
-
-
-
-
-
--
-
-**status:** `typing.Optional[typing.Union[Status, typing.Sequence[Status]]]`
-
-Include only jobs of this status in the response. There are four possible statuses:
-
-- `QUEUED`: The job has been received and is waiting to be processed.
-
-- `IN_PROGRESS`: The job is currently being processed.
-
-- `COMPLETED`: The job has finished processing.
-
-- `FAILED`: The job encountered an error and could not be completed successfully.
-
-
-
-
-
--
-
-**when:** `typing.Optional[When]` — Specify whether to include jobs created before or after a given `timestamp_ms`.
-
-
-
-
-
--
-
-**timestamp_ms:** `typing.Optional[int]`
-
-Provide a timestamp in milliseconds to filter jobs.
-
- When combined with the `when` parameter, you can filter jobs before or after the given timestamp. Defaults to the current Unix timestamp if one is not provided.
-
-
-
-
-
--
-
-**sort_by:** `typing.Optional[SortBy]`
-
-Specify which timestamp to sort the jobs by.
-
-- `created`: Sort jobs by the time of creation, indicated by `created_timestamp_ms`.
-
-- `started`: Sort jobs by the time processing started, indicated by `started_timestamp_ms`.
-
-- `ended`: Sort jobs by the time processing ended, indicated by `ended_timestamp_ms`.
-
-
-
-
-
--
-
-**direction:** `typing.Optional[Direction]`
-
-Specify the order in which to sort the jobs. Defaults to descending order.
-
-- `asc`: Sort in ascending order (chronological, with the oldest records first).
-
-- `desc`: Sort in descending order (reverse-chronological, with the newest records first).
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.expression_measurement.batch.start_inference_job(...) -> AsyncHttpResponse[str]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Start a new measurement inference job.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.expression_measurement.batch.start_inference_job(
- urls=["https://hume-tutorials.s3.amazonaws.com/faces.zip"],
- notify=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**models:** `typing.Optional[Models]`
-
-Specify the models to use for inference.
-
-If this field is not explicitly set, then all models will run by default.
-
-
-
-
-
--
-
-**transcription:** `typing.Optional[Transcription]`
-
-
-
-
-
--
-
-**urls:** `typing.Optional[typing.Sequence[str]]`
-
-URLs to the media files to be processed. Each must be a valid public URL to a media file (see recommended input filetypes) or an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files.
-
-If you wish to supply more than 100 URLs, consider providing them as an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`).
-
-
-
-
-
--
-
-**text:** `typing.Optional[typing.Sequence[str]]` — Text supplied directly to our Emotional Language and NER models for analysis.
-
-
-
-
-
--
-
-**callback_url:** `typing.Optional[str]` — If provided, a `POST` request will be made to the URL with the generated predictions on completion or the error message on failure.
-
-
-
-
-
--
-
-**notify:** `typing.Optional[bool]` — Whether to send an email notification to the user upon job completion/failure.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.expression_measurement.batch.get_job_details(...) -> AsyncHttpResponse[UnionJob]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get the request details and state of a given job.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.expression_measurement.batch.get_job_details(
- id="job_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — The unique identifier for the job.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.expression_measurement.batch.get_job_predictions(...) -> AsyncHttpResponse[typing.List[UnionPredictResult]]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get the JSON predictions of a completed inference job.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.expression_measurement.batch.get_job_predictions(
- id="job_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — The unique identifier for the job.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.expression_measurement.batch.start_inference_job_from_local_file(...) -> AsyncHttpResponse[str]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Start a new batch inference job.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from hume import HumeClient
-
-client = HumeClient(
- api_key="YOUR_API_KEY",
-)
-client.expression_measurement.batch.start_inference_job_from_local_file()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**file:** `from __future__ import annotations
-
-typing.List[core.File]` — See core.File for more documentation
-
-
-
-
-
--
-
-**json:** `typing.Optional[InferenceBaseRequest]` — Stringified JSON object containing the inference job configuration.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-