diff --git a/.mock/definition/empathic-voice/__package__.yml b/.mock/definition/empathic-voice/__package__.yml index e52dd1c..fd61727 100644 --- a/.mock/definition/empathic-voice/__package__.yml +++ b/.mock/definition/empathic-voice/__package__.yml @@ -954,7 +954,7 @@ types: This will either be the name of a previously created Custom Voice or one of our 7 base voices: `ITO`, `KORA`, `DACHER`, `AURA`, `FINN`, `WHIMSY`, or `STELLA`. - custom_voice: ReturnCustomVoice + custom_voice: optional source: openapi: stenographer-openapi.json ReturnPagedUserDefinedTools: diff --git a/package.json b/package.json index dd32a7b..52a667e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "hume", - "version": "0.9.0", + "version": "0.9.1", "private": false, "repository": "https://github.com/HumeAI/hume-typescript-sdk", "main": "./index.js", diff --git a/reference.md b/reference.md index 49e2709..8d764bb 100644 --- a/reference.md +++ b/reference.md @@ -1,8 +1,8 @@ # Reference -## EmpathicVoice Tools +## ExpressionMeasurement Batch -
client.empathicVoice.tools.listTools({ ...params }) -> core.Page +
client.expressionMeasurement.batch.listJobs({ ...params }) -> Hume.UnionJob[]
@@ -14,9 +14,7 @@
-Fetches a paginated list of **Tools**. - -Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI. +Sort and filter jobs.
@@ -32,10 +30,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
```typescript -await client.empathicVoice.tools.listTools({ - pageNumber: 0, - pageSize: 2, -}); +await client.expressionMeasurement.batch.listJobs(); ```
@@ -51,7 +46,7 @@ await client.empathicVoice.tools.listTools({
-**request:** `Hume.empathicVoice.ToolsListToolsRequest` +**request:** `Hume.expressionMeasurement.batch.BatchListJobsRequest`
@@ -59,7 +54,7 @@ await client.empathicVoice.tools.listTools({
-**requestOptions:** `Tools.RequestOptions` +**requestOptions:** `Batch.RequestOptions`
@@ -70,7 +65,7 @@ await client.empathicVoice.tools.listTools({
-
client.empathicVoice.tools.createTool({ ...params }) -> Hume.ReturnUserDefinedTool | undefined +
client.expressionMeasurement.batch.startInferenceJob({ ...params }) -> Hume.JobId
@@ -82,9 +77,7 @@ await client.empathicVoice.tools.listTools({
-Creates a **Tool** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config). - -Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI. +Start a new measurement inference job.
@@ -100,13 +93,9 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
```typescript -await client.empathicVoice.tools.createTool({ - 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"] }', - versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.", - description: "This tool is for getting the current weather.", - fallbackContent: "Unable to fetch current weather.", +await client.expressionMeasurement.batch.startInferenceJob({ + urls: ["https://hume-tutorials.s3.amazonaws.com/faces.zip"], + notify: true, }); ``` @@ -123,7 +112,7 @@ await client.empathicVoice.tools.createTool({
-**request:** `Hume.empathicVoice.PostedUserDefinedTool` +**request:** `Hume.InferenceBaseRequest`
@@ -131,7 +120,7 @@ await client.empathicVoice.tools.createTool({
-**requestOptions:** `Tools.RequestOptions` +**requestOptions:** `Batch.RequestOptions`
@@ -142,7 +131,7 @@ await client.empathicVoice.tools.createTool({
-
client.empathicVoice.tools.listToolVersions(id, { ...params }) -> Hume.ReturnPagedUserDefinedTools +
client.expressionMeasurement.batch.getJobDetails(id) -> Hume.UnionJob
@@ -154,9 +143,7 @@ await client.empathicVoice.tools.createTool({
-Fetches a list of a **Tool's** versions. - -Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI. +Get the request details and state of a given job.
@@ -172,7 +159,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
```typescript -await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea"); +await client.expressionMeasurement.batch.getJobDetails("job_id"); ```
@@ -188,15 +175,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
-**id:** `string` — Identifier for a Tool. Formatted as a UUID. - -
-
- -
-
- -**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest` +**id:** `string` — The unique identifier for the job.
@@ -204,7 +183,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
-**requestOptions:** `Tools.RequestOptions` +**requestOptions:** `Batch.RequestOptions`
@@ -215,7 +194,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
-
client.empathicVoice.tools.createToolVersion(id, { ...params }) -> Hume.ReturnUserDefinedTool | undefined +
client.expressionMeasurement.batch.getJobPredictions(id) -> Hume.UnionPredictResult[]
@@ -227,9 +206,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
-Updates a **Tool** by creating a new version of the **Tool**. - -Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI. +Get the JSON predictions of a completed inference job.
@@ -245,13 +222,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
```typescript -await client.empathicVoice.tools.createToolVersion("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"] }', - versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.", - fallbackContent: "Unable to fetch current weather.", - description: "This tool is for getting the current weather.", -}); +await client.expressionMeasurement.batch.getJobPredictions("job_id"); ```
@@ -267,15 +238,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
-**id:** `string` — Identifier for a Tool. Formatted as a UUID. - -
-
- -
-
- -**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion` +**id:** `string` — The unique identifier for the job.
@@ -283,7 +246,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
-**requestOptions:** `Tools.RequestOptions` +**requestOptions:** `Batch.RequestOptions`
@@ -294,7 +257,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
-
client.empathicVoice.tools.deleteTool(id) -> void +
client.expressionMeasurement.batch.getJobArtifacts(id) -> stream.Readable
@@ -306,9 +269,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
-Deletes a **Tool** and its versions. - -Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI. +Get the artifacts ZIP of a completed inference job.
@@ -324,7 +285,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
```typescript -await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea"); +await client.expressionMeasurement.batch.getJobArtifacts("string"); ```
@@ -340,7 +301,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
-**id:** `string` — Identifier for a Tool. Formatted as a UUID. +**id:** `string` — The unique identifier for the job.
@@ -348,7 +309,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
-**requestOptions:** `Tools.RequestOptions` +**requestOptions:** `Batch.RequestOptions`
@@ -359,7 +320,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
-
client.empathicVoice.tools.updateToolName(id, { ...params }) -> string +
client.expressionMeasurement.batch.startInferenceJobFromLocalFile(file, { ...params }) -> Hume.JobId
@@ -371,9 +332,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
-Updates the name of a **Tool**. - -Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI. +Start a new batch inference job.
@@ -389,9 +348,10 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
```typescript -await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", { - name: "get_current_temperature", -}); +await client.expressionMeasurement.batch.startInferenceJobFromLocalFile( + [fs.createReadStream("/path/to/your/file")], + {} +); ```
@@ -407,7 +367,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
-**id:** `string` — Identifier for a Tool. Formatted as a UUID. +**file:** `File[] | fs.ReadStream[] | Blob[]`
@@ -415,7 +375,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
-**request:** `Hume.empathicVoice.PostedUserDefinedToolName` +**request:** `Hume.expressionMeasurement.batch.BatchStartInferenceJobFromLocalFileRequest`
@@ -423,7 +383,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
-**requestOptions:** `Tools.RequestOptions` +**requestOptions:** `Batch.RequestOptions`
@@ -434,7 +394,9 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
-
client.empathicVoice.tools.getToolVersion(id, version) -> Hume.ReturnUserDefinedTool | undefined +## EmpathicVoice Tools + +
client.empathicVoice.tools.listTools({ ...params }) -> core.Page
@@ -446,7 +408,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
-Fetches a specified version of a **Tool**. +Fetches a paginated list of **Tools**. Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI. @@ -464,7 +426,10 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
```typescript -await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1); +await client.empathicVoice.tools.listTools({ + pageNumber: 0, + pageSize: 2, +}); ```
@@ -480,21 +445,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
-**id:** `string` — Identifier for a Tool. Formatted as a UUID. - -
-
- -
-
- -**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. +**request:** `Hume.empathicVoice.ToolsListToolsRequest`
@@ -513,7 +464,7 @@ Version numbers are integer values representing different iterations of the Tool
-
client.empathicVoice.tools.deleteToolVersion(id, version) -> void +
client.empathicVoice.tools.createTool({ ...params }) -> Hume.ReturnUserDefinedTool | undefined
@@ -525,7 +476,7 @@ Version numbers are integer values representing different iterations of the Tool
-Deletes a specified version of a **Tool**. +Creates a **Tool** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config). Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI. @@ -543,7 +494,14 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
```typescript -await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1); +await client.empathicVoice.tools.createTool({ + 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"] }', + versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.", + description: "This tool is for getting the current weather.", + fallbackContent: "Unable to fetch current weather.", +}); ```
@@ -559,21 +517,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
-**id:** `string` — Identifier for a Tool. Formatted as a UUID. - -
-
- -
-
- -**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. +**request:** `Hume.empathicVoice.PostedUserDefinedTool`
@@ -592,7 +536,7 @@ Version numbers are integer values representing different iterations of the Tool
-
client.empathicVoice.tools.updateToolDescription(id, version, { ...params }) -> Hume.ReturnUserDefinedTool | undefined +
client.empathicVoice.tools.listToolVersions(id, { ...params }) -> Hume.ReturnPagedUserDefinedTools
@@ -604,7 +548,7 @@ Version numbers are integer values representing different iterations of the Tool
-Updates the description of a specified **Tool** version. +Fetches a list of a **Tool's** versions. Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI. @@ -622,10 +566,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
```typescript -await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, { - versionDescription: - "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.", -}); +await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea"); ```
@@ -649,21 +590,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
-**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. - -
-
- -
-
- -**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription` +**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
@@ -682,9 +609,7 @@ Version numbers are integer values representing different iterations of the Tool
-## EmpathicVoice Prompts - -
client.empathicVoice.prompts.listPrompts({ ...params }) -> core.Page +
client.empathicVoice.tools.createToolVersion(id, { ...params }) -> Hume.ReturnUserDefinedTool | undefined
@@ -696,9 +621,9 @@ Version numbers are integer values representing different iterations of the Tool
-Fetches a paginated list of **Prompts**. +Updates a **Tool** by creating a new version of the **Tool**. -See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. +Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
@@ -714,9 +639,12 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
```typescript -await client.empathicVoice.prompts.listPrompts({ - pageNumber: 0, - pageSize: 2, +await client.empathicVoice.tools.createToolVersion("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"] }', + versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.", + fallbackContent: "Unable to fetch current weather.", + description: "This tool is for getting the current weather.", }); ``` @@ -733,7 +661,7 @@ await client.empathicVoice.prompts.listPrompts({
-**request:** `Hume.empathicVoice.PromptsListPromptsRequest` +**id:** `string` — Identifier for a Tool. Formatted as a UUID.
@@ -741,7 +669,15 @@ await client.empathicVoice.prompts.listPrompts({
-**requestOptions:** `Prompts.RequestOptions` +**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion` + +
+
+ +
+
+ +**requestOptions:** `Tools.RequestOptions`
@@ -752,7 +688,7 @@ await client.empathicVoice.prompts.listPrompts({
-
client.empathicVoice.prompts.createPrompt({ ...params }) -> Hume.ReturnPrompt | undefined +
client.empathicVoice.tools.deleteTool(id) -> void
@@ -764,9 +700,9 @@ await client.empathicVoice.prompts.listPrompts({
-Creates a **Prompt** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config). +Deletes a **Tool** and its versions. -See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. +Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
@@ -782,10 +718,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
```typescript -await client.empathicVoice.prompts.createPrompt({ - 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.", -}); +await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea"); ```
@@ -801,7 +734,7 @@ await client.empathicVoice.prompts.createPrompt({
-**request:** `Hume.empathicVoice.PostedPrompt` +**id:** `string` — Identifier for a Tool. Formatted as a UUID.
@@ -809,7 +742,7 @@ await client.empathicVoice.prompts.createPrompt({
-**requestOptions:** `Prompts.RequestOptions` +**requestOptions:** `Tools.RequestOptions`
@@ -820,7 +753,7 @@ await client.empathicVoice.prompts.createPrompt({
-
client.empathicVoice.prompts.listPromptVersions(id, { ...params }) -> Hume.ReturnPagedPrompts +
client.empathicVoice.tools.updateToolName(id, { ...params }) -> string
@@ -832,9 +765,9 @@ await client.empathicVoice.prompts.createPrompt({
-Fetches a list of a **Prompt's** versions. +Updates the name of a **Tool**. -See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. +Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
@@ -850,7 +783,9 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
```typescript -await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5"); +await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", { + name: "get_current_temperature", +}); ```
@@ -866,7 +801,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
-**id:** `string` — Identifier for a Prompt. Formatted as a UUID. +**id:** `string` — Identifier for a Tool. Formatted as a UUID.
@@ -874,7 +809,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
-**request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest` +**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
@@ -882,7 +817,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
-**requestOptions:** `Prompts.RequestOptions` +**requestOptions:** `Tools.RequestOptions`
@@ -893,7 +828,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
-
client.empathicVoice.prompts.createPromptVerison(id, { ...params }) -> Hume.ReturnPrompt | undefined +
client.empathicVoice.tools.getToolVersion(id, version) -> Hume.ReturnUserDefinedTool | undefined
@@ -905,9 +840,9 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
-Updates a **Prompt** by creating a new version of the **Prompt**. +Fetches a specified version of a **Tool**. -See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. +Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
@@ -923,10 +858,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
```typescript -await client.empathicVoice.prompts.createPromptVerison("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.", - versionDescription: "This is an updated version of the Weather Assistant Prompt.", -}); +await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1); ```
@@ -942,7 +874,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
-**id:** `string` — Identifier for a Prompt. Formatted as a UUID. +**id:** `string` — Identifier for a Tool. Formatted as a UUID.
@@ -950,7 +882,13 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
-**request:** `Hume.empathicVoice.PostedPromptVersion` +**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.
@@ -958,7 +896,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
-**requestOptions:** `Prompts.RequestOptions` +**requestOptions:** `Tools.RequestOptions`
@@ -969,7 +907,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
-
client.empathicVoice.prompts.deletePrompt(id) -> void +
client.empathicVoice.tools.deleteToolVersion(id, version) -> void
@@ -981,9 +919,9 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
-Deletes a **Prompt** and its versions. +Deletes a specified version of a **Tool**. -See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. +Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
@@ -999,7 +937,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
```typescript -await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5"); +await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1); ```
@@ -1015,7 +953,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
-**id:** `string` — Identifier for a Prompt. Formatted as a UUID. +**id:** `string` — Identifier for a Tool. Formatted as a UUID.
@@ -1023,7 +961,21 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
-**requestOptions:** `Prompts.RequestOptions` +**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. + +
+
+ +
+
+ +**requestOptions:** `Tools.RequestOptions`
@@ -1034,7 +986,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
-
client.empathicVoice.prompts.updatePromptName(id, { ...params }) -> string +
client.empathicVoice.tools.updateToolDescription(id, version, { ...params }) -> Hume.ReturnUserDefinedTool | undefined
@@ -1046,9 +998,9 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
-Updates the name of a **Prompt**. +Updates the description of a specified **Tool** version. -See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. +Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
@@ -1064,8 +1016,9 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
```typescript -await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", { - name: "Updated Weather Assistant Prompt Name", +await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, { + versionDescription: + "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.", }); ``` @@ -1082,7 +1035,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
-**id:** `string` — Identifier for a Prompt. Formatted as a UUID. +**id:** `string` — Identifier for a Tool. Formatted as a UUID.
@@ -1090,7 +1043,13 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
-**request:** `Hume.empathicVoice.PostedPromptName` +**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.
@@ -1098,7 +1057,15 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
-**requestOptions:** `Prompts.RequestOptions` +**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription` + +
+
+ +
+
+ +**requestOptions:** `Tools.RequestOptions`
@@ -1109,7 +1076,9 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
-
client.empathicVoice.prompts.getPromptVersion(id, version) -> Hume.ReturnPrompt | undefined +## EmpathicVoice Prompts + +
client.empathicVoice.prompts.listPrompts({ ...params }) -> core.Page
@@ -1121,7 +1090,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
-Fetches a specified version of a **Prompt**. +Fetches a paginated list of **Prompts**. See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. @@ -1139,7 +1108,10 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
```typescript -await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0); +await client.empathicVoice.prompts.listPrompts({ + pageNumber: 0, + pageSize: 2, +}); ```
@@ -1155,21 +1127,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
-**id:** `string` — Identifier for a Prompt. Formatted as a UUID. - -
-
- -
-
- -**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. +**request:** `Hume.empathicVoice.PromptsListPromptsRequest`
@@ -1188,7 +1146,7 @@ Version numbers are integer values representing different iterations of the Prom
-
client.empathicVoice.prompts.deletePromptVersion(id, version) -> void +
client.empathicVoice.prompts.createPrompt({ ...params }) -> Hume.ReturnPrompt | undefined
@@ -1200,7 +1158,7 @@ Version numbers are integer values representing different iterations of the Prom
-Deletes a specified version of a **Prompt**. +Creates a **Prompt** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config). See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. @@ -1218,7 +1176,10 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
```typescript -await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1); +await client.empathicVoice.prompts.createPrompt({ + 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.", +}); ```
@@ -1234,21 +1195,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
-**id:** `string` — Identifier for a Prompt. Formatted as a UUID. - -
-
- -
-
- -**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. +**request:** `Hume.empathicVoice.PostedPrompt`
@@ -1267,7 +1214,7 @@ Version numbers are integer values representing different iterations of the Prom
-
client.empathicVoice.prompts.updatePromptDescription(id, version, { ...params }) -> Hume.ReturnPrompt | undefined +
client.empathicVoice.prompts.listPromptVersions(id, { ...params }) -> Hume.ReturnPagedPrompts
@@ -1279,7 +1226,7 @@ Version numbers are integer values representing different iterations of the Prom
-Updates the description of a **Prompt**. +Fetches a list of a **Prompt's** versions. See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. @@ -1297,9 +1244,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
```typescript -await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, { - versionDescription: "This is an updated version_description.", -}); +await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5"); ```
@@ -1323,21 +1268,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
-**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. - -
-
- -
-
- -**request:** `Hume.empathicVoice.PostedPromptVersionDescription` +**request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
@@ -1356,9 +1287,7 @@ Version numbers are integer values representing different iterations of the Prom
-## EmpathicVoice CustomVoices - -
client.empathicVoice.customVoices.listCustomVoices({ ...params }) -> Hume.ReturnPagedCustomVoices +
client.empathicVoice.prompts.createPromptVerison(id, { ...params }) -> Hume.ReturnPrompt | undefined
@@ -1370,9 +1299,9 @@ Version numbers are integer values representing different iterations of the Prom
-Fetches a paginated list of **Custom Voices**. +Updates a **Prompt** by creating a new version of the **Prompt**. -Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice. +See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
@@ -1388,7 +1317,10 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
```typescript -await client.empathicVoice.customVoices.listCustomVoices(); +await client.empathicVoice.prompts.createPromptVerison("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.", + versionDescription: "This is an updated version of the Weather Assistant Prompt.", +}); ```
@@ -1404,7 +1336,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
-**request:** `Hume.empathicVoice.CustomVoicesListCustomVoicesRequest` +**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
@@ -1412,7 +1344,15 @@ await client.empathicVoice.customVoices.listCustomVoices();
-**requestOptions:** `CustomVoices.RequestOptions` +**request:** `Hume.empathicVoice.PostedPromptVersion` + +
+
+ +
+
+ +**requestOptions:** `Prompts.RequestOptions`
@@ -1423,7 +1363,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
-
client.empathicVoice.customVoices.createCustomVoice({ ...params }) -> Hume.ReturnCustomVoice +
client.empathicVoice.prompts.deletePrompt(id) -> void
@@ -1435,9 +1375,9 @@ await client.empathicVoice.customVoices.listCustomVoices();
-Creates a **Custom Voice** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config). +Deletes a **Prompt** and its versions. -Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice. +See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
@@ -1453,11 +1393,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
```typescript -await client.empathicVoice.customVoices.createCustomVoice({ - name: "name", - baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito, - parameterModel: "20240715-4parameter", -}); +await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5"); ```
@@ -1473,7 +1409,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
-**request:** `Hume.PostedCustomVoice` +**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
@@ -1481,7 +1417,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
-**requestOptions:** `CustomVoices.RequestOptions` +**requestOptions:** `Prompts.RequestOptions`
@@ -1492,7 +1428,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
-
client.empathicVoice.customVoices.getCustomVoice(id) -> Hume.ReturnCustomVoice +
client.empathicVoice.prompts.updatePromptName(id, { ...params }) -> string
@@ -1504,9 +1440,9 @@ await client.empathicVoice.customVoices.createCustomVoice({
-Fetches a specific **Custom Voice** by ID. +Updates the name of a **Prompt**. -Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice. +See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
@@ -1522,7 +1458,9 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
```typescript -await client.empathicVoice.customVoices.getCustomVoice("id"); +await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", { + name: "Updated Weather Assistant Prompt Name", +}); ```
@@ -1538,7 +1476,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
-**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID. +**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
@@ -1546,7 +1484,15 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
-**requestOptions:** `CustomVoices.RequestOptions` +**request:** `Hume.empathicVoice.PostedPromptName` + +
+
+ +
+
+ +**requestOptions:** `Prompts.RequestOptions`
@@ -1557,7 +1503,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
-
client.empathicVoice.customVoices.createCustomVoiceVersion(id, { ...params }) -> Hume.ReturnCustomVoice +
client.empathicVoice.prompts.getPromptVersion(id, version) -> Hume.ReturnPrompt | undefined
@@ -1569,9 +1515,9 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
-Updates a **Custom Voice** by creating a new version of the **Custom Voice**. +Fetches a specified version of a **Prompt**. -Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice. +See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
@@ -1587,11 +1533,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
```typescript -await client.empathicVoice.customVoices.createCustomVoiceVersion("id", { - name: "name", - baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito, - parameterModel: "20240715-4parameter", -}); +await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0); ```
@@ -1607,7 +1549,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
-**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID. +**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
@@ -1615,7 +1557,13 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
-**request:** `Hume.PostedCustomVoice` +**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.
@@ -1623,7 +1571,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
-**requestOptions:** `CustomVoices.RequestOptions` +**requestOptions:** `Prompts.RequestOptions`
@@ -1634,7 +1582,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
-
client.empathicVoice.customVoices.deleteCustomVoice(id) -> void +
client.empathicVoice.prompts.deletePromptVersion(id, version) -> void
@@ -1646,9 +1594,9 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
-Deletes a **Custom Voice** and its versions. +Deletes a specified version of a **Prompt**. -Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice. +See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
@@ -1664,7 +1612,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
```typescript -await client.empathicVoice.customVoices.deleteCustomVoice("id"); +await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1); ```
@@ -1680,7 +1628,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
-**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID. +**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
@@ -1688,10 +1636,24 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
-**requestOptions:** `CustomVoices.RequestOptions` +**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. -
-
+ +
+ +
+
+ +**requestOptions:** `Prompts.RequestOptions` + +
+
@@ -1699,7 +1661,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
-
client.empathicVoice.customVoices.updateCustomVoiceName(id, { ...params }) -> string +
client.empathicVoice.prompts.updatePromptDescription(id, version, { ...params }) -> Hume.ReturnPrompt | undefined
@@ -1711,9 +1673,9 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
-Updates the name of a **Custom Voice**. +Updates the description of a **Prompt**. -Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice. +See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
@@ -1729,8 +1691,8 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
```typescript -await client.empathicVoice.customVoices.updateCustomVoiceName("string", { - name: "string", +await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, { + versionDescription: "This is an updated version_description.", }); ``` @@ -1747,7 +1709,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
-**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID. +**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
@@ -1755,7 +1717,13 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
-**request:** `Hume.empathicVoice.PostedCustomVoiceName` +**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.
@@ -1763,7 +1731,15 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
-**requestOptions:** `CustomVoices.RequestOptions` +**request:** `Hume.empathicVoice.PostedPromptVersionDescription` + +
+
+ +
+
+ +**requestOptions:** `Prompts.RequestOptions`
@@ -1774,9 +1750,9 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
-## EmpathicVoice Configs +## EmpathicVoice CustomVoices -
client.empathicVoice.configs.listConfigs({ ...params }) -> Hume.ReturnPagedConfigs +
client.empathicVoice.customVoices.listCustomVoices({ ...params }) -> Hume.ReturnPagedCustomVoices
@@ -1788,9 +1764,9 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
-Fetches a paginated list of **Configs**. +Fetches a paginated list of **Custom Voices**. -For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration). +Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
@@ -1806,10 +1782,7 @@ For more details on configuration options and how to configure EVI, see our [con
```typescript -await client.empathicVoice.configs.listConfigs({ - pageNumber: 0, - pageSize: 1, -}); +await client.empathicVoice.customVoices.listCustomVoices(); ```
@@ -1825,7 +1798,7 @@ await client.empathicVoice.configs.listConfigs({
-**request:** `Hume.empathicVoice.ConfigsListConfigsRequest` +**request:** `Hume.empathicVoice.CustomVoicesListCustomVoicesRequest`
@@ -1833,7 +1806,7 @@ await client.empathicVoice.configs.listConfigs({
-**requestOptions:** `Configs.RequestOptions` +**requestOptions:** `CustomVoices.RequestOptions`
@@ -1844,7 +1817,7 @@ await client.empathicVoice.configs.listConfigs({
-
client.empathicVoice.configs.createConfig({ ...params }) -> Hume.ReturnConfig +
client.empathicVoice.customVoices.createCustomVoice({ ...params }) -> Hume.ReturnCustomVoice
@@ -1856,9 +1829,9 @@ await client.empathicVoice.configs.listConfigs({
-Creates a **Config** which can be applied to EVI. +Creates a **Custom Voice** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config). -For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration). +Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
@@ -1874,36 +1847,10 @@ For more details on configuration options and how to configure EVI, see our [con
```typescript -await client.empathicVoice.configs.createConfig({ - name: "Weather Assistant Config", - prompt: { - id: "af699d45-2985-42cc-91b9-af9e5da3bac5", - version: 0, - }, - eviVersion: "2", - voice: { - provider: "HUME_AI", - name: "SAMPLE VOICE", - }, - languageModel: { - modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic, - modelResource: "claude-3-5-sonnet-20240620", - temperature: 1, - }, - eventMessages: { - onNewChat: { - enabled: false, - text: "", - }, - onInactivityTimeout: { - enabled: false, - text: "", - }, - onMaxDurationTimeout: { - enabled: false, - text: "", - }, - }, +await client.empathicVoice.customVoices.createCustomVoice({ + name: "name", + baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito, + parameterModel: "20240715-4parameter", }); ``` @@ -1920,7 +1867,7 @@ await client.empathicVoice.configs.createConfig({
-**request:** `Hume.empathicVoice.PostedConfig` +**request:** `Hume.PostedCustomVoice`
@@ -1928,7 +1875,7 @@ await client.empathicVoice.configs.createConfig({
-**requestOptions:** `Configs.RequestOptions` +**requestOptions:** `CustomVoices.RequestOptions`
@@ -1939,7 +1886,7 @@ await client.empathicVoice.configs.createConfig({
-
client.empathicVoice.configs.listConfigVersions(id, { ...params }) -> Hume.ReturnPagedConfigs +
client.empathicVoice.customVoices.getCustomVoice(id) -> Hume.ReturnCustomVoice
@@ -1951,9 +1898,9 @@ await client.empathicVoice.configs.createConfig({
-Fetches a list of a **Config's** versions. +Fetches a specific **Custom Voice** by ID. -For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration). +Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
@@ -1969,7 +1916,7 @@ For more details on configuration options and how to configure EVI, see our [con
```typescript -await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3"); +await client.empathicVoice.customVoices.getCustomVoice("id"); ```
@@ -1985,15 +1932,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
-**id:** `string` — Identifier for a Config. Formatted as a UUID. - -
-
- -
-
- -**request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest` +**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
@@ -2001,7 +1940,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
-**requestOptions:** `Configs.RequestOptions` +**requestOptions:** `CustomVoices.RequestOptions`
@@ -2012,7 +1951,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
-
client.empathicVoice.configs.createConfigVersion(id, { ...params }) -> Hume.ReturnConfig +
client.empathicVoice.customVoices.createCustomVoiceVersion(id, { ...params }) -> Hume.ReturnCustomVoice
@@ -2024,9 +1963,9 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
-Updates a **Config** by creating a new version of the **Config**. +Updates a **Custom Voice** by creating a new version of the **Custom Voice**. -For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration). +Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
@@ -2042,39 +1981,10 @@ For more details on configuration options and how to configure EVI, see our [con
```typescript -await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", { - versionDescription: "This is an updated version of the Weather Assistant Config.", - eviVersion: "2", - prompt: { - id: "af699d45-2985-42cc-91b9-af9e5da3bac5", - version: 0, - }, - voice: { - provider: "HUME_AI", - name: "ITO", - }, - languageModel: { - modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic, - modelResource: "claude-3-5-sonnet-20240620", - temperature: 1, - }, - ellmModel: { - allowShortResponses: true, - }, - eventMessages: { - onNewChat: { - enabled: false, - text: "", - }, - onInactivityTimeout: { - enabled: false, - text: "", - }, - onMaxDurationTimeout: { - enabled: false, - text: "", - }, - }, +await client.empathicVoice.customVoices.createCustomVoiceVersion("id", { + name: "name", + baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito, + parameterModel: "20240715-4parameter", }); ``` @@ -2091,7 +2001,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
-**id:** `string` — Identifier for a Config. Formatted as a UUID. +**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
@@ -2099,7 +2009,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
-**request:** `Hume.empathicVoice.PostedConfigVersion` +**request:** `Hume.PostedCustomVoice`
@@ -2107,7 +2017,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
-**requestOptions:** `Configs.RequestOptions` +**requestOptions:** `CustomVoices.RequestOptions`
@@ -2118,7 +2028,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
-
client.empathicVoice.configs.deleteConfig(id) -> void +
client.empathicVoice.customVoices.deleteCustomVoice(id) -> void
@@ -2130,9 +2040,9 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
-Deletes a **Config** and its versions. +Deletes a **Custom Voice** and its versions. -For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration). +Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
@@ -2148,7 +2058,7 @@ For more details on configuration options and how to configure EVI, see our [con
```typescript -await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3"); +await client.empathicVoice.customVoices.deleteCustomVoice("id"); ```
@@ -2164,7 +2074,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
-**id:** `string` — Identifier for a Config. Formatted as a UUID. +**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
@@ -2172,7 +2082,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
-**requestOptions:** `Configs.RequestOptions` +**requestOptions:** `CustomVoices.RequestOptions`
@@ -2183,7 +2093,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
-
client.empathicVoice.configs.updateConfigName(id, { ...params }) -> string +
client.empathicVoice.customVoices.updateCustomVoiceName(id, { ...params }) -> string
@@ -2195,9 +2105,9 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
-Updates the name of a **Config**. +Updates the name of a **Custom Voice**. -For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration). +Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
@@ -2213,8 +2123,8 @@ For more details on configuration options and how to configure EVI, see our [con
```typescript -await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", { - name: "Updated Weather Assistant Config Name", +await client.empathicVoice.customVoices.updateCustomVoiceName("string", { + name: "string", }); ``` @@ -2231,7 +2141,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
-**id:** `string` — Identifier for a Config. Formatted as a UUID. +**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
@@ -2239,7 +2149,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
-**request:** `Hume.empathicVoice.PostedConfigName` +**request:** `Hume.empathicVoice.PostedCustomVoiceName`
@@ -2247,7 +2157,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
-**requestOptions:** `Configs.RequestOptions` +**requestOptions:** `CustomVoices.RequestOptions`
@@ -2258,7 +2168,9 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
-
client.empathicVoice.configs.getConfigVersion(id, version) -> Hume.ReturnConfig +## EmpathicVoice Configs + +
client.empathicVoice.configs.listConfigs({ ...params }) -> Hume.ReturnPagedConfigs
@@ -2270,7 +2182,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
-Fetches a specified version of a **Config**. +Fetches a paginated list of **Configs**. For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration). @@ -2288,7 +2200,10 @@ For more details on configuration options and how to configure EVI, see our [con
```typescript -await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1); +await client.empathicVoice.configs.listConfigs({ + pageNumber: 0, + pageSize: 1, +}); ```
@@ -2304,21 +2219,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
-**id:** `string` — Identifier for a Config. Formatted as a UUID. - -
-
- -
-
- -**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. +**request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
@@ -2337,7 +2238,7 @@ Version numbers are integer values representing different iterations of the Conf
-
client.empathicVoice.configs.deleteConfigVersion(id, version) -> void +
client.empathicVoice.configs.createConfig({ ...params }) -> Hume.ReturnConfig
@@ -2349,7 +2250,7 @@ Version numbers are integer values representing different iterations of the Conf
-Deletes a specified version of a **Config**. +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/empathic-voice-interface-evi/configuration). @@ -2367,7 +2268,37 @@ For more details on configuration options and how to configure EVI, see our [con
```typescript -await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1); +await client.empathicVoice.configs.createConfig({ + name: "Weather Assistant Config", + prompt: { + id: "af699d45-2985-42cc-91b9-af9e5da3bac5", + version: 0, + }, + eviVersion: "2", + voice: { + provider: "HUME_AI", + name: "SAMPLE VOICE", + }, + languageModel: { + modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic, + modelResource: "claude-3-5-sonnet-20240620", + temperature: 1, + }, + eventMessages: { + onNewChat: { + enabled: false, + text: "", + }, + onInactivityTimeout: { + enabled: false, + text: "", + }, + onMaxDurationTimeout: { + enabled: false, + text: "", + }, + }, +}); ```
@@ -2383,21 +2314,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
-**id:** `string` — Identifier for a Config. Formatted as a UUID. - -
-
- -
-
- -**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. +**request:** `Hume.empathicVoice.PostedConfig`
@@ -2416,7 +2333,7 @@ Version numbers are integer values representing different iterations of the Conf
-
client.empathicVoice.configs.updateConfigDescription(id, version, { ...params }) -> Hume.ReturnConfig +
client.empathicVoice.configs.listConfigVersions(id, { ...params }) -> Hume.ReturnPagedConfigs
@@ -2428,7 +2345,7 @@ Version numbers are integer values representing different iterations of the Conf
-Updates the description of a **Config**. +Fetches a list of a **Config's** versions. For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration). @@ -2446,9 +2363,7 @@ For more details on configuration options and how to configure EVI, see our [con
```typescript -await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, { - versionDescription: "This is an updated version_description.", -}); +await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3"); ```
@@ -2472,21 +2387,7 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
-**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. - -
-
- -
-
- -**request:** `Hume.empathicVoice.PostedConfigVersionDescription` +**request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
@@ -2505,9 +2406,7 @@ Version numbers are integer values representing different iterations of the Conf
-## EmpathicVoice Chats - -
client.empathicVoice.chats.listChats({ ...params }) -> core.Page +
client.empathicVoice.configs.createConfigVersion(id, { ...params }) -> Hume.ReturnConfig
@@ -2519,14 +2418,66 @@ Version numbers are integer values representing different iterations of the Conf
-Fetches a paginated list of **Chats**. +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/empathic-voice-interface-evi/configuration). + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", { + versionDescription: "This is an updated version of the Weather Assistant Config.", + eviVersion: "2", + prompt: { + id: "af699d45-2985-42cc-91b9-af9e5da3bac5", + version: 0, + }, + voice: { + provider: "HUME_AI", + name: "ITO", + }, + languageModel: { + modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic, + modelResource: "claude-3-5-sonnet-20240620", + temperature: 1, + }, + ellmModel: { + allowShortResponses: true, + }, + eventMessages: { + onNewChat: { + enabled: false, + text: "", + }, + onInactivityTimeout: { + enabled: false, + text: "", + }, + onMaxDurationTimeout: { + enabled: false, + text: "", + }, + }, +}); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -2534,28 +2485,15 @@ Fetches a paginated list of **Chats**.
-```typescript -await client.empathicVoice.chats.listChats({ - pageNumber: 0, - pageSize: 1, - ascendingOrder: true, -}); -``` +**id:** `string` — Identifier for a Config. Formatted as a UUID.
-
-
- -#### ⚙️ Parameters - -
-
-**request:** `Hume.empathicVoice.ChatsListChatsRequest` +**request:** `Hume.empathicVoice.PostedConfigVersion`
@@ -2563,7 +2501,7 @@ await client.empathicVoice.chats.listChats({
-**requestOptions:** `Chats.RequestOptions` +**requestOptions:** `Configs.RequestOptions`
@@ -2574,7 +2512,7 @@ await client.empathicVoice.chats.listChats({
-
client.empathicVoice.chats.listChatEvents(id, { ...params }) -> core.Page +
client.empathicVoice.configs.deleteConfig(id) -> void
@@ -2586,7 +2524,9 @@ await client.empathicVoice.chats.listChats({
-Fetches a paginated list of **Chat** events. +Deletes a **Config** and its versions. + +For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
@@ -2602,11 +2542,7 @@ Fetches a paginated list of **Chat** events.
```typescript -await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", { - pageNumber: 0, - pageSize: 3, - ascendingOrder: true, -}); +await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3"); ```
@@ -2622,15 +2558,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
-**id:** `string` — Identifier for a Chat. Formatted as a UUID. - -
-
- -
-
- -**request:** `Hume.empathicVoice.ChatsListChatEventsRequest` +**id:** `string` — Identifier for a Config. Formatted as a UUID.
@@ -2638,7 +2566,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
-**requestOptions:** `Chats.RequestOptions` +**requestOptions:** `Configs.RequestOptions`
@@ -2649,9 +2577,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
-## EmpathicVoice ChatGroups - -
client.empathicVoice.chatGroups.listChatGroups({ ...params }) -> Hume.ReturnPagedChatGroups +
client.empathicVoice.configs.updateConfigName(id, { ...params }) -> string
@@ -2663,7 +2589,9 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
-Fetches a paginated list of **Chat Groups**. +Updates the name of a **Config**. + +For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
@@ -2679,11 +2607,8 @@ Fetches a paginated list of **Chat Groups**.
```typescript -await client.empathicVoice.chatGroups.listChatGroups({ - pageNumber: 0, - pageSize: 1, - ascendingOrder: true, - configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3", +await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", { + name: "Updated Weather Assistant Config Name", }); ``` @@ -2700,7 +2625,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
-**request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest` +**id:** `string` — Identifier for a Config. Formatted as a UUID.
@@ -2708,7 +2633,15 @@ await client.empathicVoice.chatGroups.listChatGroups({
-**requestOptions:** `ChatGroups.RequestOptions` +**request:** `Hume.empathicVoice.PostedConfigName` + +
+
+ +
+
+ +**requestOptions:** `Configs.RequestOptions`
@@ -2719,7 +2652,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
-
client.empathicVoice.chatGroups.getChatGroup(id, { ...params }) -> Hume.ReturnChatGroupPagedChats +
client.empathicVoice.configs.getConfigVersion(id, version) -> Hume.ReturnConfig
@@ -2731,7 +2664,9 @@ await client.empathicVoice.chatGroups.listChatGroups({
-Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**. +Fetches a specified version of a **Config**. + +For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
@@ -2747,11 +2682,7 @@ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associate
```typescript -await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", { - pageNumber: 0, - pageSize: 1, - ascendingOrder: true, -}); +await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1); ```
@@ -2767,7 +2698,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
-**id:** `string` — Identifier for a Chat Group. Formatted as a UUID. +**id:** `string` — Identifier for a Config. Formatted as a UUID.
@@ -2775,7 +2706,13 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
-**request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest` +**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.
@@ -2783,7 +2720,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
-**requestOptions:** `ChatGroups.RequestOptions` +**requestOptions:** `Configs.RequestOptions`
@@ -2794,7 +2731,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
-
client.empathicVoice.chatGroups.listChatGroupEvents(id, { ...params }) -> Hume.ReturnChatGroupPagedEvents +
client.empathicVoice.configs.deleteConfigVersion(id, version) -> void
@@ -2806,7 +2743,9 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
-Fetches a paginated list of **Chat** events associated with a **Chat Group**. +Deletes a specified version of a **Config**. + +For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
@@ -2822,11 +2761,7 @@ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
```typescript -await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", { - pageNumber: 0, - pageSize: 3, - ascendingOrder: true, -}); +await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1); ```
@@ -2842,7 +2777,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
-**id:** `string` — Identifier for a Chat Group. Formatted as a UUID. +**id:** `string` — Identifier for a Config. Formatted as a UUID.
@@ -2850,7 +2785,13 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
-**request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest` +**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.
@@ -2858,7 +2799,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
-**requestOptions:** `ChatGroups.RequestOptions` +**requestOptions:** `Configs.RequestOptions`
@@ -2869,9 +2810,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
-## ExpressionMeasurement Batch - -
client.expressionMeasurement.batch.listJobs({ ...params }) -> Hume.UnionJob[] +
client.empathicVoice.configs.updateConfigDescription(id, version, { ...params }) -> Hume.ReturnConfig
@@ -2883,7 +2822,9 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
-Sort and filter jobs. +Updates the description of a **Config**. + +For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
@@ -2899,7 +2840,9 @@ Sort and filter jobs.
```typescript -await client.expressionMeasurement.batch.listJobs(); +await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, { + versionDescription: "This is an updated version_description.", +}); ```
@@ -2915,7 +2858,7 @@ await client.expressionMeasurement.batch.listJobs();
-**request:** `Hume.expressionMeasurement.batch.BatchListJobsRequest` +**id:** `string` — Identifier for a Config. Formatted as a UUID.
@@ -2923,7 +2866,29 @@ await client.expressionMeasurement.batch.listJobs();
-**requestOptions:** `Batch.RequestOptions` +**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. + +
+
+ +
+
+ +**request:** `Hume.empathicVoice.PostedConfigVersionDescription` + +
+
+ +
+
+ +**requestOptions:** `Configs.RequestOptions`
@@ -2934,7 +2899,9 @@ await client.expressionMeasurement.batch.listJobs();
-
client.expressionMeasurement.batch.startInferenceJob({ ...params }) -> Hume.JobId +## EmpathicVoice Chats + +
client.empathicVoice.chats.listChats({ ...params }) -> core.Page
@@ -2946,7 +2913,7 @@ await client.expressionMeasurement.batch.listJobs();
-Start a new measurement inference job. +Fetches a paginated list of **Chats**.
@@ -2962,9 +2929,10 @@ Start a new measurement inference job.
```typescript -await client.expressionMeasurement.batch.startInferenceJob({ - urls: ["https://hume-tutorials.s3.amazonaws.com/faces.zip"], - notify: true, +await client.empathicVoice.chats.listChats({ + pageNumber: 0, + pageSize: 1, + ascendingOrder: true, }); ``` @@ -2981,7 +2949,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
-**request:** `Hume.InferenceBaseRequest` +**request:** `Hume.empathicVoice.ChatsListChatsRequest`
@@ -2989,7 +2957,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
-**requestOptions:** `Batch.RequestOptions` +**requestOptions:** `Chats.RequestOptions`
@@ -3000,7 +2968,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
-
client.expressionMeasurement.batch.getJobDetails(id) -> Hume.UnionJob +
client.empathicVoice.chats.listChatEvents(id, { ...params }) -> core.Page
@@ -3012,7 +2980,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
-Get the request details and state of a given job. +Fetches a paginated list of **Chat** events.
@@ -3028,7 +2996,11 @@ Get the request details and state of a given job.
```typescript -await client.expressionMeasurement.batch.getJobDetails("job_id"); +await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", { + pageNumber: 0, + pageSize: 3, + ascendingOrder: true, +}); ```
@@ -3044,7 +3016,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
-**id:** `string` — The unique identifier for the job. +**id:** `string` — Identifier for a Chat. Formatted as a UUID.
@@ -3052,7 +3024,15 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
-**requestOptions:** `Batch.RequestOptions` +**request:** `Hume.empathicVoice.ChatsListChatEventsRequest` + +
+
+ +
+
+ +**requestOptions:** `Chats.RequestOptions`
@@ -3063,7 +3043,9 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
-
client.expressionMeasurement.batch.getJobPredictions(id) -> Hume.UnionPredictResult[] +## EmpathicVoice ChatGroups + +
client.empathicVoice.chatGroups.listChatGroups({ ...params }) -> Hume.ReturnPagedChatGroups
@@ -3075,7 +3057,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
-Get the JSON predictions of a completed inference job. +Fetches a paginated list of **Chat Groups**.
@@ -3091,7 +3073,12 @@ Get the JSON predictions of a completed inference job.
```typescript -await client.expressionMeasurement.batch.getJobPredictions("job_id"); +await client.empathicVoice.chatGroups.listChatGroups({ + pageNumber: 0, + pageSize: 1, + ascendingOrder: true, + configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3", +}); ```
@@ -3107,7 +3094,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
-**id:** `string` — The unique identifier for the job. +**request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
@@ -3115,7 +3102,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
-**requestOptions:** `Batch.RequestOptions` +**requestOptions:** `ChatGroups.RequestOptions`
@@ -3126,7 +3113,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
-
client.expressionMeasurement.batch.getJobArtifacts(id) -> stream.Readable +
client.empathicVoice.chatGroups.getChatGroup(id, { ...params }) -> Hume.ReturnChatGroupPagedChats
@@ -3138,7 +3125,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
-Get the artifacts ZIP of a completed inference job. +Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
@@ -3154,7 +3141,11 @@ Get the artifacts ZIP of a completed inference job.
```typescript -await client.expressionMeasurement.batch.getJobArtifacts("string"); +await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", { + pageNumber: 0, + pageSize: 1, + ascendingOrder: true, +}); ```
@@ -3170,7 +3161,7 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
-**id:** `string` — The unique identifier for the job. +**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
@@ -3178,7 +3169,15 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
-**requestOptions:** `Batch.RequestOptions` +**request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest` + +
+
+ +
+
+ +**requestOptions:** `ChatGroups.RequestOptions`
@@ -3189,7 +3188,7 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
-
client.expressionMeasurement.batch.startInferenceJobFromLocalFile(file, { ...params }) -> Hume.JobId +
client.empathicVoice.chatGroups.listChatGroupEvents(id, { ...params }) -> Hume.ReturnChatGroupPagedEvents
@@ -3201,7 +3200,7 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
-Start a new batch inference job. +Fetches a paginated list of **Chat** events associated with a **Chat Group**.
@@ -3217,10 +3216,11 @@ Start a new batch inference job.
```typescript -await client.expressionMeasurement.batch.startInferenceJobFromLocalFile( - [fs.createReadStream("/path/to/your/file")], - {} -); +await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", { + pageNumber: 0, + pageSize: 3, + ascendingOrder: true, +}); ```
@@ -3236,7 +3236,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
-**file:** `File[] | fs.ReadStream[] | Blob[]` +**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
@@ -3244,7 +3244,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
-**request:** `Hume.expressionMeasurement.batch.BatchStartInferenceJobFromLocalFileRequest` +**request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
@@ -3252,7 +3252,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
-**requestOptions:** `Batch.RequestOptions` +**requestOptions:** `ChatGroups.RequestOptions`
diff --git a/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts b/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts index 4f8c59e..ffd419b 100644 --- a/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts +++ b/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts @@ -76,8 +76,8 @@ export class ChatGroups { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -176,8 +176,8 @@ export class ChatGroups { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -276,8 +276,8 @@ export class ChatGroups { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), diff --git a/src/api/resources/empathicVoice/resources/chats/client/Client.ts b/src/api/resources/empathicVoice/resources/chats/client/Client.ts index a05733f..72e1e4a 100644 --- a/src/api/resources/empathicVoice/resources/chats/client/Client.ts +++ b/src/api/resources/empathicVoice/resources/chats/client/Client.ts @@ -71,8 +71,8 @@ export class Chats { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -180,8 +180,8 @@ export class Chats { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), diff --git a/src/api/resources/empathicVoice/resources/configs/client/Client.ts b/src/api/resources/empathicVoice/resources/configs/client/Client.ts index d177c3c..d7593a3 100644 --- a/src/api/resources/empathicVoice/resources/configs/client/Client.ts +++ b/src/api/resources/empathicVoice/resources/configs/client/Client.ts @@ -76,8 +76,8 @@ export class Configs { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -188,8 +188,8 @@ export class Configs { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -286,8 +286,8 @@ export class Configs { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -403,8 +403,8 @@ export class Configs { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -484,8 +484,8 @@ export class Configs { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -564,8 +564,8 @@ export class Configs { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -648,8 +648,8 @@ export class Configs { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -735,8 +735,8 @@ export class Configs { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -821,8 +821,8 @@ export class Configs { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), diff --git a/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts b/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts index 85c1378..7154669 100644 --- a/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts +++ b/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts @@ -69,8 +69,8 @@ export class CustomVoices { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -155,8 +155,8 @@ export class CustomVoices { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -237,8 +237,8 @@ export class CustomVoices { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -324,8 +324,8 @@ export class CustomVoices { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -403,8 +403,8 @@ export class CustomVoices { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -483,8 +483,8 @@ export class CustomVoices { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), diff --git a/src/api/resources/empathicVoice/resources/prompts/client/Client.ts b/src/api/resources/empathicVoice/resources/prompts/client/Client.ts index 6977c31..ac8fb57 100644 --- a/src/api/resources/empathicVoice/resources/prompts/client/Client.ts +++ b/src/api/resources/empathicVoice/resources/prompts/client/Client.ts @@ -75,8 +75,8 @@ export class Prompts { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -169,8 +169,8 @@ export class Prompts { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -267,8 +267,8 @@ export class Prompts { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -354,8 +354,8 @@ export class Prompts { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -435,8 +435,8 @@ export class Prompts { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -515,8 +515,8 @@ export class Prompts { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -599,8 +599,8 @@ export class Prompts { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -686,8 +686,8 @@ export class Prompts { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -772,8 +772,8 @@ export class Prompts { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), diff --git a/src/api/resources/empathicVoice/resources/tools/client/Client.ts b/src/api/resources/empathicVoice/resources/tools/client/Client.ts index c063263..0e1b599 100644 --- a/src/api/resources/empathicVoice/resources/tools/client/Client.ts +++ b/src/api/resources/empathicVoice/resources/tools/client/Client.ts @@ -75,8 +75,8 @@ export class Tools { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -175,8 +175,8 @@ export class Tools { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -275,8 +275,8 @@ export class Tools { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -364,8 +364,8 @@ export class Tools { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -445,8 +445,8 @@ export class Tools { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -525,8 +525,8 @@ export class Tools { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -611,8 +611,8 @@ export class Tools { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -694,8 +694,8 @@ export class Tools { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -780,8 +780,8 @@ export class Tools { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), diff --git a/src/api/resources/empathicVoice/types/ReturnVoice.ts b/src/api/resources/empathicVoice/types/ReturnVoice.ts index b2368f0..b49b2a8 100644 --- a/src/api/resources/empathicVoice/types/ReturnVoice.ts +++ b/src/api/resources/empathicVoice/types/ReturnVoice.ts @@ -16,5 +16,5 @@ export interface ReturnVoice { * This will either be the name of a previously created Custom Voice or one of our 7 base voices: `ITO`, `KORA`, `DACHER`, `AURA`, `FINN`, `WHIMSY`, or `STELLA`. */ name?: string; - customVoice: Hume.empathicVoice.ReturnCustomVoice; + customVoice?: Hume.empathicVoice.ReturnCustomVoice; } diff --git a/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts b/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts index c72634b..fee323b 100644 --- a/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts +++ b/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts @@ -84,8 +84,8 @@ export class Batch { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -153,8 +153,8 @@ export class Batch { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -221,8 +221,8 @@ export class Batch { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -286,8 +286,8 @@ export class Batch { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -342,8 +342,8 @@ export class Batch { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -415,8 +415,8 @@ export class Batch { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.8.11", - "User-Agent": "hume/0.8.11", + "X-Fern-SDK-Version": "0.9.1", + "User-Agent": "hume/0.9.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), diff --git a/src/api/resources/index.ts b/src/api/resources/index.ts index 6a44d0f..15ed9ec 100644 --- a/src/api/resources/index.ts +++ b/src/api/resources/index.ts @@ -1,2 +1,2 @@ -export * as empathicVoice from "./empathicVoice"; export * as expressionMeasurement from "./expressionMeasurement"; +export * as empathicVoice from "./empathicVoice"; diff --git a/src/serialization/resources/empathicVoice/types/ReturnVoice.ts b/src/serialization/resources/empathicVoice/types/ReturnVoice.ts index a091892..097307c 100644 --- a/src/serialization/resources/empathicVoice/types/ReturnVoice.ts +++ b/src/serialization/resources/empathicVoice/types/ReturnVoice.ts @@ -13,13 +13,13 @@ export const ReturnVoice: core.serialization.ObjectSchema< > = core.serialization.object({ provider: core.serialization.stringLiteral("HUME_AI"), name: core.serialization.string().optional(), - customVoice: core.serialization.property("custom_voice", ReturnCustomVoice), + customVoice: core.serialization.property("custom_voice", ReturnCustomVoice.optional()), }); export declare namespace ReturnVoice { interface Raw { provider: "HUME_AI"; name?: string | null; - custom_voice: ReturnCustomVoice.Raw; + custom_voice?: ReturnCustomVoice.Raw | null; } } diff --git a/src/serialization/resources/index.ts b/src/serialization/resources/index.ts index 6a44d0f..15ed9ec 100644 --- a/src/serialization/resources/index.ts +++ b/src/serialization/resources/index.ts @@ -1,2 +1,2 @@ -export * as empathicVoice from "./empathicVoice"; export * as expressionMeasurement from "./expressionMeasurement"; +export * as empathicVoice from "./empathicVoice"; diff --git a/src/version.ts b/src/version.ts index 2b00a52..9ba59d6 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const SDK_VERSION = "0.8.11"; +export const SDK_VERSION = "0.9.1"; diff --git a/yarn.lock b/yarn.lock index 333bc4d..112abd2 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1121,9 +1121,9 @@ camelcase@^6.2.0: integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA== caniuse-lite@^1.0.30001663: - version "1.0.30001664" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001664.tgz#d588d75c9682d3301956b05a3749652a80677df4" - integrity sha512-AmE7k4dXiNKQipgn7a2xg558IRqPN3jMQY/rOsbxDhrd0tyChwbITBfiwtnqz8bi2M5mIWbxAYBvk7W7QBUS2g== + version "1.0.30001666" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001666.tgz#112d77e80f1762f62a1b71ba92164e0cb3f3dd13" + integrity sha512-gD14ICmoV5ZZM1OdzPWmpx+q4GyefaK06zi8hmfHV5xe4/2nOQX3+Dw5o+fSqOws2xVwL9j+anOPFwHzdEdV4g== chalk@^2.4.2: version "2.4.2" @@ -1334,9 +1334,9 @@ domexception@^4.0.0: webidl-conversions "^7.0.0" electron-to-chromium@^1.5.28: - version "1.5.30" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.30.tgz#5b264b489cfe0c3dd71097c164d795444834e7c7" - integrity sha512-sXI35EBN4lYxzc/pIGorlymYNzDBOqkSlVRe6MkgBsW/hW1tpC/HDJ2fjG7XnjakzfLEuvdmux0Mjs6jHq4UOA== + version "1.5.31" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.31.tgz#b1478418769dec72ea70d9fdf147a81491857f10" + integrity sha512-QcDoBbQeYt0+3CWcK/rEbuHvwpbT/8SV9T3OSgs6cX1FlcUAkgrkqbg9zLnDrMM/rLamzQwal4LYFCiWk861Tg== emittery@^0.13.1: version "0.13.1"