hume 0.15.12 → 0.15.13

package/reference.md

@@ -228,7 +228,7 @@ await client.tts.synthesizeFileStreaming({
 </dl>
 </details>
 
-<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJsonStreaming</a>({ ...params }) -> core.Stream<Hume.TtsOutput></code></summary>
+<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJsonStreaming</a>({ ...params }) -> core.Stream&lt;Hume.TtsOutput&gt;</code></summary>
 <dl>
 <dd>
 
@@ -304,7 +304,7 @@ for await (const item of response) {
 </dl>
 </details>
 
-<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">convertVoiceJson</a>({ ...params }) -> core.Stream<Hume.TtsOutput></code></summary>
+<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">convertVoiceJson</a>({ ...params }) -> core.Stream&lt;Hume.TtsOutput&gt;</code></summary>
 <dl>
 <dd>
 
@@ -357,7 +357,7 @@ for await (const item of response) {
 </details>
 
 ## Tts Voices
-<details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">list</a>({ ...params }) -> core.Page<Hume.ReturnVoice, Hume.ReturnPagedVoices></code></summary>
+<details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Hume.ReturnVoice, Hume.ReturnPagedVoices&gt;</code></summary>
 <dl>
 <dd>
 
@@ -369,7 +369,7 @@ for await (const item of response) {
 <dl>
 <dd>
 
-Lists voices you have saved in your account, or voices from the [Voice Library](https://app.hume.ai/voices).
+Lists voices you have saved in your account, or voices from the [Voice Library](https://app.hume.ai/tts/voice-library).
 </dd>
 </dl>
 </dd>
@@ -644,10 +644,24 @@ await client.empathicVoice.controlPlane.send("chat_id", {
 </details>
 
 ## EmpathicVoice ChatGroups
-<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> core.Page<Hume.ReturnChatGroup, Hume.ReturnPagedChatGroups></code></summary>
+<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> core.Page&lt;Hume.ReturnChatGroup, Hume.ReturnPagedChatGroups&gt;</code></summary>
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Fetches a paginated list of **Chat Groups**.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -719,6 +733,20 @@ const response = page.response;
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -748,7 +776,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a chat. Formatted as a UUID.
+**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -780,6 +808,20 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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).
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -809,7 +851,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a chat. Formatted as a UUID.
+**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -837,10 +879,24 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
 </dl>
 </details>
 
-<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroupEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent, Hume.ReturnChatGroupPagedEvents></code></summary>
+<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroupEvents</a>(id, { ...params }) -> core.Page&lt;Hume.ReturnChatEvent, Hume.ReturnChatGroupPagedEvents&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+Fetches a paginated list of **Chat** events associated with a **Chat Group**.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -886,7 +942,7 @@ const response = page.response;
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a chat. Formatted as a UUID.
+**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -915,10 +971,24 @@ const response = page.response;
 </details>
 
 ## EmpathicVoice Chats
-<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat, Hume.ReturnPagedChats></code></summary>
+<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page&lt;Hume.ReturnChat, Hume.ReturnPagedChats&gt;</code></summary>
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Fetches a paginated list of **Chats**.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -984,10 +1054,24 @@ const response = page.response;
 </dl>
 </details>
 
-<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChatEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent, Hume.ReturnChatPagedEvents></code></summary>
+<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChatEvents</a>(id, { ...params }) -> core.Page&lt;Hume.ReturnChatEvent, Hume.ReturnChatPagedEvents&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
 <dl>
 <dd>
 
+<dl>
+<dd>
+
+Fetches a paginated list of **Chat** events.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1033,7 +1117,7 @@ const response = page.response;
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a chat. Formatted as a UUID.
+**id:** `string` — Identifier for a Chat. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -1065,6 +1149,20 @@ const response = page.response;
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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).
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1090,7 +1188,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a chat. Formatted as a UUID.
+**id:** `string` — Identifier for a Chat. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -1111,10 +1209,26 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
 </details>
 
 ## EmpathicVoice Configs
-<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> core.Page<Hume.ReturnConfig, Hume.ReturnPagedConfigs></code></summary>
+<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> core.Page&lt;Hume.ReturnConfig, Hume.ReturnPagedConfigs&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+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).
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1182,6 +1296,22 @@ const response = page.response;
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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).
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1257,10 +1387,26 @@ await client.empathicVoice.configs.createConfig({
 </dl>
 </details>
 
-<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigVersions</a>(id, { ...params }) -> core.Page<Hume.ReturnConfig, Hume.ReturnPagedConfigs></code></summary>
+<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigVersions</a>(id, { ...params }) -> core.Page&lt;Hume.ReturnConfig, Hume.ReturnPagedConfigs&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
 <dl>
 <dd>
 
+<dl>
+<dd>
+
+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).
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1298,7 +1444,7 @@ const response = page.response;
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a config. Formatted as a UUID.
+**id:** `string` — Identifier for a Config. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -1330,6 +1476,22 @@ const response = page.response;
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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).
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1388,7 +1550,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a config. Formatted as a UUID.
+**id:** `string` — Identifier for a Config. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -1420,6 +1582,22 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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).
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1445,7 +1623,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a config. Formatted as a UUID.
+**id:** `string` — Identifier for a Config. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -1469,6 +1647,22 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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).
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1496,7 +1690,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a config. Formatted as a UUID.
+**id:** `string` — Identifier for a Config. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -1528,6 +1722,22 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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).
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1553,7 +1763,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a config. Formatted as a UUID.
+**id:** `string` — Identifier for a Config. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -1561,7 +1771,13 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
 <dl>
 <dd>
 
-**version:** `number` — Version number for a config. Version numbers should be integers.
+**version:** `number` 
+
+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.
     
 </dd>
 </dl>
@@ -1585,6 +1801,22 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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).
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1610,7 +1842,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a config. Formatted as a UUID.
+**id:** `string` — Identifier for a Config. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -1618,7 +1850,13 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
 <dl>
 <dd>
 
-**version:** `number` — Version number for a config. Version numbers should be integers.
+**version:** `number` 
+
+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.
     
 </dd>
 </dl>
@@ -1642,6 +1880,22 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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).
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1669,7 +1923,7 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a config. Formatted as a UUID.
+**id:** `string` — Identifier for a Config. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -1677,7 +1931,13 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
 <dl>
 <dd>
 
-**version:** `number` — Version number for a config. Version numbers should be integers.
+**version:** `number` 
+
+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.
     
 </dd>
 </dl>
@@ -1706,10 +1966,26 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
 </details>
 
 ## EmpathicVoice Prompts
-<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<(Hume.ReturnPrompt | undefined), Hume.ReturnPagedPrompts></code></summary>
+<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page&lt;(Hume.ReturnPrompt | undefined), Hume.ReturnPagedPrompts&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
 <dl>
 <dd>
 
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1777,6 +2053,22 @@ const response = page.response;
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1829,6 +2121,22 @@ await client.empathicVoice.prompts.createPrompt({
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1886,6 +2194,22 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1914,7 +2238,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a prompt. Formatted as a UUID.
+**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -1946,6 +2270,22 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1971,7 +2311,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a prompt. Formatted as a UUID.
+**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -1995,6 +2335,22 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2022,7 +2378,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a prompt. Formatted as a UUID.
+**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -2054,6 +2410,22 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2079,7 +2451,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a prompt. Formatted as a UUID.
+**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -2087,7 +2459,13 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
 <dl>
 <dd>
 
-**version:** `number` — Version number for a prompt. Version numbers should be integers.
+**version:** `number` 
+
+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.
     
 </dd>
 </dl>
@@ -2111,6 +2489,22 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2136,7 +2530,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a prompt. Formatted as a UUID.
+**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -2144,7 +2538,13 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
 <dl>
 <dd>
 
-**version:** `number` — Version number for a prompt. Version numbers should be integers.
+**version:** `number` 
+
+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.
     
 </dd>
 </dl>
@@ -2168,6 +2568,22 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2195,7 +2611,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a prompt. Formatted as a UUID.
+**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -2203,7 +2619,13 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
 <dl>
 <dd>
 
-**version:** `number` — Version number for a prompt. Version numbers should be integers.
+**version:** `number` 
+
+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.
     
 </dd>
 </dl>
@@ -2232,10 +2654,26 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
 </details>
 
 ## EmpathicVoice Tools
-<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> core.Page<(Hume.ReturnUserDefinedTool | undefined), Hume.ReturnPagedUserDefinedTools></code></summary>
+<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> core.Page&lt;(Hume.ReturnUserDefinedTool | undefined), Hume.ReturnPagedUserDefinedTools&gt;</code></summary>
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2303,6 +2741,22 @@ const response = page.response;
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2354,10 +2808,26 @@ await client.empathicVoice.tools.createTool({
 </dl>
 </details>
 
-<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listToolVersions</a>(id, { ...params }) -> core.Page<(Hume.ReturnUserDefinedTool | undefined), Hume.ReturnPagedUserDefinedTools></code></summary>
+<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listToolVersions</a>(id, { ...params }) -> core.Page&lt;(Hume.ReturnUserDefinedTool | undefined), Hume.ReturnPagedUserDefinedTools&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
 <dl>
 <dd>
 
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2427,6 +2897,22 @@ const response = page.response;
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2457,7 +2943,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a tool. Formatted as a UUID.
+**id:** `string` — Identifier for a Tool. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -2489,6 +2975,22 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2514,7 +3016,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a tool. Formatted as a UUID.
+**id:** `string` — Identifier for a Tool. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -2538,6 +3040,22 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2565,7 +3083,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a tool. Formatted as a UUID.
+**id:** `string` — Identifier for a Tool. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -2597,6 +3115,22 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2622,7 +3156,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a tool. Formatted as a UUID.
+**id:** `string` — Identifier for a Tool. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -2630,7 +3164,13 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
 <dl>
 <dd>
 
-**version:** `number` — Version number for a tool. Version numbers should be integers.
+**version:** `number` 
+
+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.
     
 </dd>
 </dl>
@@ -2654,6 +3194,22 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2679,7 +3235,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a tool. Formatted as a UUID.
+**id:** `string` — Identifier for a Tool. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -2687,7 +3243,13 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
 <dl>
 <dd>
 
-**version:** `number` — Version number for a tool. Version numbers should be integers.
+**version:** `number` 
+
+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.
     
 </dd>
 </dl>
@@ -2711,6 +3273,22 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2738,7 +3316,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
 <dl>
 <dd>
 
-**id:** `string` — Identifier for a tool. Formatted as a UUID.
+**id:** `string` — Identifier for a Tool. Formatted as a UUID.
     
 </dd>
 </dl>
@@ -2746,7 +3324,13 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
 <dl>
 <dd>
 
-**version:** `number` — Version number for a tool. Version numbers should be integers.
+**version:** `number` 
+
+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.
     
 </dd>
 </dl>