From edbd3c340a09ecc470afa78129f20ad107476b74 Mon Sep 17 00:00:00 2001 From: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Date: Thu, 24 Oct 2024 19:56:41 +0000 Subject: [PATCH] SDK regeneration --- .mock/definition/api.yml | 12 +- .../definition/empathic-voice/__package__.yml | 5513 +++++++++-------- .mock/definition/empathic-voice/chat.yml | 286 +- .../definition/empathic-voice/chatGroups.yml | 1087 ++-- .mock/definition/empathic-voice/chats.yml | 939 +-- .mock/definition/empathic-voice/configs.yml | 1784 +++--- .../empathic-voice/customVoices.yml | 489 +- .mock/definition/empathic-voice/prompts.yml | 1049 ++-- .mock/definition/empathic-voice/tools.yml | 1176 ++-- .../batch/__package__.yml | 3516 +++++------ .../stream/__package__.yml | 971 +-- .mock/fern.config.json | 6 +- package.json | 2 +- reference.md | 1180 ++-- .../resources/chatGroups/client/Client.ts | 106 +- .../requests/ChatGroupsGetAudioRequest.ts | 26 + .../chatGroups/client/requests/index.ts | 1 + .../resources/chats/client/Client.ts | 85 +- .../resources/configs/client/Client.ts | 36 +- .../requests/ConfigsListConfigsRequest.ts | 2 +- .../resources/customVoices/client/Client.ts | 33 +- .../CustomVoicesListCustomVoicesRequest.ts | 2 +- .../client/requests/PostedCustomVoiceName.ts | 6 - .../resources/prompts/client/Client.ts | 36 +- .../requests/PromptsListPromptsRequest.ts | 4 +- .../resources/tools/client/Client.ts | 36 +- .../client/requests/ToolsListToolsRequest.ts | 2 +- .../empathicVoice/types/AudioOutput.ts | 2 +- .../empathicVoice/types/ExtendedVoiceArgs.ts | 11 - .../empathicVoice/types/PostedCustomVoice.ts | 4 +- .../types/PostedCustomVoiceBaseVoice.ts | 5 +- .../types/PostedCustomVoiceParameters.ts | 60 +- .../empathicVoice/types/PostedVoice.ts | 2 +- .../empathicVoice/types/ReturnCustomVoice.ts | 4 +- .../types/ReturnCustomVoiceBaseVoice.ts | 5 +- .../types/ReturnCustomVoiceParameters.ts | 60 +- .../empathicVoice/types/ReturnVoice.ts | 2 +- .../empathicVoice/types/UserInput.ts | 4 +- .../empathicVoice/types/VoiceArgs.ts | 15 - .../empathicVoice/types/VoiceNameEnum.ts | 4 +- .../resources/empathicVoice/types/index.ts | 2 - .../resources/batch/client/Client.ts | 24 +- src/api/resources/index.ts | 2 +- .../empathicVoice/types/ExtendedVoiceArgs.ts | 25 - .../empathicVoice/types/PostedCustomVoice.ts | 4 +- .../types/PostedCustomVoiceBaseVoice.ts | 4 +- .../types/PostedCustomVoiceParameters.ts | 22 +- .../empathicVoice/types/ReturnCustomVoice.ts | 4 +- .../types/ReturnCustomVoiceBaseVoice.ts | 4 +- .../types/ReturnCustomVoiceParameters.ts | 22 +- .../empathicVoice/types/VoiceArgs.ts | 33 - .../empathicVoice/types/VoiceNameEnum.ts | 4 +- .../resources/empathicVoice/types/index.ts | 2 - src/serialization/resources/index.ts | 2 +- src/version.ts | 2 +- yarn.lock | 370 +- 56 files changed, 9774 insertions(+), 9315 deletions(-) create mode 100644 src/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.ts delete mode 100644 src/api/resources/empathicVoice/types/ExtendedVoiceArgs.ts delete mode 100644 src/api/resources/empathicVoice/types/VoiceArgs.ts delete mode 100644 src/serialization/resources/empathicVoice/types/ExtendedVoiceArgs.ts delete mode 100644 src/serialization/resources/empathicVoice/types/VoiceArgs.ts diff --git a/.mock/definition/api.yml b/.mock/definition/api.yml index 79b95836..783e8844 100644 --- a/.mock/definition/api.yml +++ b/.mock/definition/api.yml @@ -1,12 +1,12 @@ name: api error-discrimination: - strategy: status-code + strategy: status-code default-environment: Production environments: - Production: https://api.hume.ai + Production: https://api.hume.ai auth: HeaderAuthScheme auth-schemes: - HeaderAuthScheme: - name: apiKey - header: X-Hume-Api-Key - type: optional + HeaderAuthScheme: + header: X-Hume-Api-Key + type: optional + name: apiKey diff --git a/.mock/definition/empathic-voice/__package__.yml b/.mock/definition/empathic-voice/__package__.yml index fd617273..a967a3cd 100644 --- a/.mock/definition/empathic-voice/__package__.yml +++ b/.mock/definition/empathic-voice/__package__.yml @@ -1,2778 +1,2885 @@ errors: - BadRequestError: - status-code: 400 - type: ErrorResponse - docs: Bad Request + BadRequestError: + status-code: 400 + type: ErrorResponse + docs: Bad Request + examples: + - value: {} types: - ErrorResponse: - properties: - error: optional - message: optional - source: - openapi: stenographer-openapi.json - ReturnUserDefinedToolToolType: - enum: - - BUILTIN - - FUNCTION - docs: >- - Type of Tool. Either `BUILTIN` for natively implemented tools, like web - search, or `FUNCTION` for user-defined tools. - source: - openapi: stenographer-openapi.json - ReturnUserDefinedToolVersionType: - enum: - - FIXED - - LATEST - docs: >- - Versioning method for a Tool. Either `FIXED` for using a fixed version - number or `LATEST` for auto-updating to the latest version. - source: - openapi: stenographer-openapi.json - ReturnUserDefinedTool: - docs: A specific tool version returned from the server - properties: - tool_type: - type: ReturnUserDefinedToolToolType - docs: >- - Type of Tool. Either `BUILTIN` for natively implemented tools, like - web search, or `FUNCTION` for user-defined tools. - id: - type: string - docs: Identifier for a Tool. Formatted as a UUID. - version: - type: integer - docs: >- - Version number for a Tool. - - - Tools, Configs, Custom Voices, and Prompts are versioned. This - versioning system supports iterative development, allowing you to - progressively refine tools and revert to previous versions if needed. - - - Version numbers are integer values representing different iterations - of the Tool. Each update to the Tool increments its version number. - version_type: - type: ReturnUserDefinedToolVersionType - docs: >- - Versioning method for a Tool. Either `FIXED` for using a fixed version - number or `LATEST` for auto-updating to the latest version. - version_description: - type: optional - docs: An optional description of the Tool version. - name: - type: string - docs: Name applied to all versions of a particular Tool. - created_on: - type: long - docs: >- - Time at which the Tool was created. Measured in seconds since the Unix - epoch. - modified_on: - type: long - docs: >- - Time at which the Tool was last modified. Measured in seconds since - the Unix epoch. - fallback_content: - type: optional - docs: >- - Optional text passed to the supplemental LLM in place of the tool call - result. The LLM then uses this text to generate a response back to the - user, ensuring continuity in the conversation if the Tool errors. - description: - type: optional - docs: >- - An optional description of what the Tool does, used by the - supplemental LLM to choose when and how to call the function. - parameters: - type: string - docs: >- - Stringified JSON defining the parameters used by this version of the - Tool. - - - These parameters define the inputs needed for the Tool’s execution, - including the expected data type and description for each input field. - Structured as a stringified JSON schema, this format ensures the tool - receives data in the expected format. - source: - openapi: stenographer-openapi.json - ReturnPromptVersionType: - enum: - - FIXED - - LATEST - docs: >- - Versioning method for a Prompt. Either `FIXED` for using a fixed version - number or `LATEST` for auto-updating to the latest version. - source: - openapi: stenographer-openapi.json - ReturnPrompt: - docs: A Prompt associated with this Config. - properties: - id: - type: string - docs: Identifier for a Prompt. Formatted as a UUID. - version: - type: integer - docs: >- - Version number for a Prompt. - - - Prompts, Configs, Custom Voices, and Tools are versioned. This - versioning system supports iterative development, allowing you to - progressively refine prompts and revert to previous versions if - needed. - - - Version numbers are integer values representing different iterations - of the Prompt. Each update to the Prompt increments its version - number. - version_type: - type: ReturnPromptVersionType - docs: >- - Versioning method for a Prompt. Either `FIXED` for using a fixed - version number or `LATEST` for auto-updating to the latest version. - version_description: - type: optional - docs: An optional description of the Prompt version. - name: - type: string - docs: Name applied to all versions of a particular Prompt. - created_on: - type: long - docs: >- - Time at which the Prompt was created. Measured in seconds since the - Unix epoch. - modified_on: - type: long - docs: >- - Time at which the Prompt was last modified. Measured in seconds since - the Unix epoch. - text: - type: string - docs: >- - Instructions used to shape EVI’s behavior, responses, and style. - - - You can use the Prompt to define a specific goal or role for EVI, - specifying how it should act or what it should focus on during the - conversation. For example, EVI can be instructed to act as a customer - support representative, a fitness coach, or a travel advisor, each - with its own set of behaviors and response styles. - - - For help writing a system prompt, see our [Prompting - Guide](/docs/empathic-voice-interface-evi/prompting). - source: - openapi: stenographer-openapi.json - PostedCustomVoiceBaseVoice: - enum: - - ITO - - KORA - - DACHER - - AURA - - FINN - - STELLA - - WHIMSY + ErrorResponse: + properties: + error: optional + message: optional + source: + openapi: stenographer-openapi.json + ReturnUserDefinedToolToolType: + enum: + - BUILTIN + - FUNCTION + docs: >- + Type of Tool. Either `BUILTIN` for natively implemented tools, like web + search, or `FUNCTION` for user-defined tools. + source: + openapi: stenographer-openapi.json + ReturnUserDefinedToolVersionType: + enum: + - FIXED + - LATEST + docs: >- + Versioning method for a Tool. Either `FIXED` for using a fixed version + number or `LATEST` for auto-updating to the latest version. + source: + openapi: stenographer-openapi.json + ReturnUserDefinedTool: + docs: A specific tool version returned from the server + properties: + tool_type: + type: ReturnUserDefinedToolToolType + docs: >- + Type of Tool. Either `BUILTIN` for natively implemented tools, like + web search, or `FUNCTION` for user-defined tools. + id: + type: string + docs: Identifier for a Tool. Formatted as a UUID. + version: + type: integer + docs: >- + Version number for a Tool. + + + Tools, Configs, Custom Voices, and Prompts are versioned. This + versioning system supports iterative development, allowing you to + progressively refine tools and revert to previous versions if needed. + + + Version numbers are integer values representing different iterations + of the Tool. Each update to the Tool increments its version number. + version_type: + type: ReturnUserDefinedToolVersionType + docs: >- + Versioning method for a Tool. Either `FIXED` for using a fixed version + number or `LATEST` for auto-updating to the latest version. + version_description: + type: optional + docs: An optional description of the Tool version. + name: + type: string + docs: Name applied to all versions of a particular Tool. + created_on: + type: long + docs: >- + Time at which the Tool was created. Measured in seconds since the Unix + epoch. + modified_on: + type: long + docs: >- + Time at which the Tool was last modified. Measured in seconds since + the Unix epoch. + fallback_content: + type: optional + docs: >- + Optional text passed to the supplemental LLM in place of the tool call + result. The LLM then uses this text to generate a response back to the + user, ensuring continuity in the conversation if the Tool errors. + description: + type: optional + docs: >- + An optional description of what the Tool does, used by the + supplemental LLM to choose when and how to call the function. + parameters: + type: string + docs: >- + Stringified JSON defining the parameters used by this version of the + Tool. + + + These parameters define the inputs needed for the Tool’s execution, + including the expected data type and description for each input field. + Structured as a stringified JSON schema, this format ensures the tool + receives data in the expected format. + source: + openapi: stenographer-openapi.json + ReturnPromptVersionType: + enum: + - FIXED + - LATEST + docs: >- + Versioning method for a Prompt. Either `FIXED` for using a fixed version + number or `LATEST` for auto-updating to the latest version. + source: + openapi: stenographer-openapi.json + ReturnPrompt: + docs: A Prompt associated with this Config. + properties: + id: + type: string + docs: Identifier for a Prompt. Formatted as a UUID. + version: + type: integer + docs: >- + Version number for a Prompt. + + + Prompts, Configs, Custom Voices, and Tools are versioned. This + versioning system supports iterative development, allowing you to + progressively refine prompts and revert to previous versions if + needed. + + + Version numbers are integer values representing different iterations + of the Prompt. Each update to the Prompt increments its version + number. + version_type: + type: ReturnPromptVersionType + docs: >- + Versioning method for a Prompt. Either `FIXED` for using a fixed + version number or `LATEST` for auto-updating to the latest version. + version_description: + type: optional + docs: An optional description of the Prompt version. + name: + type: string + docs: Name applied to all versions of a particular Prompt. + created_on: + type: long + docs: >- + Time at which the Prompt was created. Measured in seconds since the + Unix epoch. + modified_on: + type: long + docs: >- + Time at which the Prompt was last modified. Measured in seconds since + the Unix epoch. + text: + type: string + docs: >- + Instructions used to shape EVI’s behavior, responses, and style. + + + You can use the Prompt to define a specific goal or role for EVI, + specifying how it should act or what it should focus on during the + conversation. For example, EVI can be instructed to act as a customer + support representative, a fitness coach, or a travel advisor, each + with its own set of behaviors and response styles. + + + For help writing a system prompt, see our [Prompting + Guide](/docs/empathic-voice-interface-evi/prompting). + source: + openapi: stenographer-openapi.json + PostedCustomVoiceBaseVoice: + enum: + - ITO + - KORA + - DACHER + - AURA + - FINN + - WHIMSY + - STELLA + - SUNNY + docs: Specifies the base voice used to create the Custom Voice. + source: + openapi: stenographer-openapi.json + PostedCustomVoiceParameters: + docs: >- + The specified attributes of a Custom Voice. + + + If no parameters are specified then all attributes will be set to their + defaults, meaning no modfications will be made to the base voice. + properties: + gender: + type: optional + docs: >- + The vocalization of gender, ranging between more masculine and more + feminine. + + + The default value is `0`, with a minimum of `-100` (more masculine) + and a maximum of `100` (more feminine). A value of `0` leaves this + parameter unchanged from the base voice. + articulation: + type: optional + docs: >- + The clarity of the voice, ranging between mumbled and articulate. + + + The default value is `0`, with a minimum of `-100` (mumbled) and a + maximum of `100` (articulate). A value of `0` leaves this parameter + unchanged from the base voice. + assertiveness: + type: optional + docs: >- + The firmness of the voice, ranging between whiny and bold. + + + The default value is `0`, with a minimum of `-100` (whiny) and a + maximum of `100` (bold). A value of `0` leaves this parameter + unchanged from the base voice. + buoyancy: + type: optional + docs: >- + The density of the voice, ranging between deflated and buoyant. + + + The default value is `0`, with a minimum of `-100` (deflated) and a + maximum of `100` (buoyant). A value of `0` leaves this parameter + unchanged from the base voice. + confidence: + type: optional + docs: >- + The assuredness of the voice, ranging between shy and confident. + + + The default value is `0`, with a minimum of `-100` (shy) and a maximum + of `100` (confident). A value of `0` leaves this parameter unchanged + from the base voice. + enthusiasm: + type: optional + docs: >- + The excitement within the voice, ranging between calm and + enthusiastic. + + + The default value is `0`, with a minimum of `-100` (calm) and a + maximum of `100` (enthusiastic). A value of `0` leaves this parameter + unchanged from the base voice. + nasality: + type: optional + docs: >- + The openness of the voice, ranging between clear and nasal. + + + The default value is `0`, with a minimum of `-100` (clear) and a + maximum of `100` (nasal). A value of `0` leaves this parameter + unchanged from the base voice. + relaxedness: + type: optional + docs: >- + The stress within the voice, ranging between tense and relaxed. + + + The default value is `0`, with a minimum of `-100` (tense) and a + maximum of `100` (relaxed). A value of `0` leaves this parameter + unchanged from the base voice. + smoothness: + type: optional + docs: >- + The texture of the voice, ranging between smooth and staccato. + + + The default value is `0`, with a minimum of `-100` (smooth) and a + maximum of `100` (staccato). A value of `0` leaves this parameter + unchanged from the base voice. + tepidity: + type: optional + docs: >- + The liveliness behind the voice, ranging between tepid and vigorous. + + + The default value is `0`, with a minimum of `-100` (tepid) and a + maximum of `100` (vigorous). A value of `0` leaves this parameter + unchanged from the base voice. + tightness: + type: optional + docs: >- + The containment of the voice, ranging between tight and breathy. + + + The default value is `0`, with a minimum of `-100` (tight) and a + maximum of `100` (breathy). A value of `0` leaves this parameter + unchanged from the base voice. + source: + openapi: stenographer-openapi.json + PostedCustomVoice: + docs: >- + A Custom Voice specification to be associated with this Config. + + + If a Custom Voice specification is not provided then the + [name](/reference/empathic-voice-interface-evi/configs/create-config#request.body.voice.name) + of a base voice or previously created Custom Voice must be provided. + + See our [Voices guide](/docs/empathic-voice-interface-evi/voices) for a tutorial on how to craft a Custom Voice. + properties: + name: + type: string + docs: >- + The name of the Custom Voice. Maximum length of 75 characters. Will be + converted to all-uppercase. (e.g., "sample voice" becomes "SAMPLE + VOICE") + base_voice: + type: PostedCustomVoiceBaseVoice docs: Specifies the base voice used to create the Custom Voice. - source: - openapi: stenographer-openapi.json - PostedCustomVoiceParameters: - docs: >- - The specified attributes of a Custom Voice. - - - If no parameters are specified then all attributes will be set to their - defaults, meaning no modfications will be made to the base voice. - properties: - gender: - type: optional - docs: >- - The vocalization of gender, ranging between masculine and feminine. - - - The default value is `0`, with a minimum of `-100` (more masculine) - and a maximum of `100` (more feminine). A value of `0` leaves this - parameter unchanged from the base voice. - huskiness: - type: optional - docs: >- - The texture of the voice, ranging between bright and husky. - - - The default value is `0`, with a minimum of `-100` (brighter) and a - maximum of `100` (huskier). A value of `0` leaves this parameter - unchanged from the base voice. - nasality: - type: optional - docs: >- - The openness of the voice, ranging between resonant and nasal. - - - The default value is `0`, with a minimum of `-100` (more resonant) and - a maximum of `100` (more nasal). A value of `0` leaves this parameter - unchanged from the base voice. - pitch: - type: optional - docs: >- - The frequency of the voice, ranging between low and high. - - - The default value is `0`, with a minimum of `-100` (lower) and a - maximum of `100` (higher). A value of `0` leaves this parameter - unchanged from the base voice. - source: - openapi: stenographer-openapi.json - PostedCustomVoice: - docs: >- - A Custom Voice specification to be associated with this Config. - - - If a Custom Voice specification is not provided then the - [name](/reference/empathic-voice-interface-evi/configs/create-config#request.body.voice.name) - of a base voice or previously created Custom Voice must be provided. - - See our [Voices guide](/docs/empathic-voice-interface-evi/voices) for a tutorial on how to craft a Custom Voice. - properties: - name: - type: string - docs: >- - The name of the Custom Voice. Maximum length of 75 characters. Will be - converted to all-uppercase. (e.g., "sample voice" becomes "SAMPLE - VOICE") - base_voice: - type: PostedCustomVoiceBaseVoice - docs: Specifies the base voice used to create the Custom Voice. - parameter_model: - type: literal<"20240715-4parameter"> - docs: >- - The name of the parameter model used to define which attributes are - used by the `parameters` field. Currently, only `20240715-4parameter` - is supported as the parameter model. - parameters: - type: optional - docs: >- - The specified attributes of a Custom Voice. - - - If no parameters are specified then all attributes will be set to - their defaults, meaning no modfications will be made to the base - voice. - source: - openapi: stenographer-openapi.json - ReturnCustomVoiceBaseVoice: - enum: - - ITO - - KORA - - DACHER - - AURA - - FINN - - STELLA - - WHIMSY + parameter_model: + type: literal<"20241004-11parameter"> + docs: >- + The name of the parameter model used to define which attributes are + used by the `parameters` field. Currently, only `20241004-11parameter` + is supported as the parameter model. + parameters: + type: optional + docs: >- + The specified attributes of a Custom Voice. + + + If no parameters are specified then all attributes will be set to + their defaults, meaning no modfications will be made to the base + voice. + source: + openapi: stenographer-openapi.json + ReturnCustomVoiceBaseVoice: + enum: + - ITO + - KORA + - DACHER + - AURA + - FINN + - WHIMSY + - STELLA + - SUNNY + docs: The base voice used to create the Custom Voice. + source: + openapi: stenographer-openapi.json + ReturnCustomVoiceParameters: + docs: >- + The specified attributes of a Custom Voice. If a parameter's value is `0` + (default), it will not be included in the response. + properties: + gender: + type: optional + docs: >- + The vocalization of gender, ranging between more masculine and more + feminine. + + + The default value is `0`, with a minimum of `-100` (more masculine) + and a maximum of `100` (more feminine). A value of `0` leaves this + parameter unchanged from the base voice. + articulation: + type: optional + docs: >- + The clarity of the voice, ranging between mumbled and articulate. + + + The default value is `0`, with a minimum of `-100` (mumbled) and a + maximum of `100` (articulate). A value of `0` leaves this parameter + unchanged from the base voice. + assertiveness: + type: optional + docs: >- + The firmness of the voice, ranging between whiny and bold. + + + The default value is `0`, with a minimum of `-100` (whiny) and a + maximum of `100` (bold). A value of `0` leaves this parameter + unchanged from the base voice. + buoyancy: + type: optional + docs: >- + The density of the voice, ranging between deflated and buoyant. + + + The default value is `0`, with a minimum of `-100` (deflated) and a + maximum of `100` (buoyant). A value of `0` leaves this parameter + unchanged from the base voice. + confidence: + type: optional + docs: >- + The assuredness of the voice, ranging between shy and confident. + + + The default value is `0`, with a minimum of `-100` (shy) and a maximum + of `100` (confident). A value of `0` leaves this parameter unchanged + from the base voice. + enthusiasm: + type: optional + docs: >- + The excitement within the voice, ranging between calm and + enthusiastic. + + + The default value is `0`, with a minimum of `-100` (calm) and a + maximum of `100` (enthusiastic). A value of `0` leaves this parameter + unchanged from the base voice. + nasality: + type: optional + docs: >- + The openness of the voice, ranging between clear and nasal. + + + The default value is `0`, with a minimum of `-100` (clear) and a + maximum of `100` (nasal). A value of `0` leaves this parameter + unchanged from the base voice. + relaxedness: + type: optional + docs: >- + The stress within the voice, ranging between tense and relaxed. + + + The default value is `0`, with a minimum of `-100` (tense) and a + maximum of `100` (relaxed). A value of `0` leaves this parameter + unchanged from the base voice. + smoothness: + type: optional + docs: >- + The texture of the voice, ranging between smooth and staccato. + + + The default value is `0`, with a minimum of `-100` (smooth) and a + maximum of `100` (staccato). A value of `0` leaves this parameter + unchanged from the base voice. + tepidity: + type: optional + docs: >- + The liveliness behind the voice, ranging between tepid and vigorous. + + + The default value is `0`, with a minimum of `-100` (tepid) and a + maximum of `100` (vigorous). A value of `0` leaves this parameter + unchanged from the base voice. + tightness: + type: optional + docs: >- + The containment of the voice, ranging between tight and breathy. + + + The default value is `0`, with a minimum of `-100` (tight) and a + maximum of `100` (breathy). A value of `0` leaves this parameter + unchanged from the base voice. + source: + openapi: stenographer-openapi.json + ReturnCustomVoice: + docs: A Custom Voice specification associated with this Config. + properties: + id: + type: string + docs: Identifier for a Custom Voice. Formatted as a UUID. + version: + type: integer + docs: >- + Version number for a Custom Voice. + + + Custom Voices, Prompts, Configs, 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 Custom Voice. Each update to the Custom Voice increments its + version number. + name: + type: string + docs: The name of the Custom Voice. Maximum length of 75 characters. + created_on: + type: long + docs: >- + Time at which the Custom Voice was created. Measured in seconds since + the Unix epoch. + modified_on: + type: long + docs: >- + Time at which the Custom Voice was last modified. Measured in seconds + since the Unix epoch. + base_voice: + type: ReturnCustomVoiceBaseVoice docs: The base voice used to create the Custom Voice. - source: - openapi: stenographer-openapi.json - ReturnCustomVoiceParameters: - docs: >- - The specified attributes of a Custom Voice. If a parameter's value is `0` - (default), it will not be included in the response. - properties: - gender: - type: optional - docs: >- - The vocalization of gender, ranging between masculine and feminine. - - - The default value is `0`, with a minimum of `-100` (more masculine) - and a maximum of `100` (more feminine). A value of `0` leaves this - parameter unchanged from the base voice. - huskiness: - type: optional - docs: >- - The texture of the voice, ranging between bright and husky. - - - The default value is `0`, with a minimum of `-100` (brighter) and a - maximum of `100` (huskier). A value of `0` leaves this parameter - unchanged from the base voice. - nasality: - type: optional - docs: >- - The openness of the voice, ranging between resonant and nasal. - - - The default value is `0`, with a minimum of `-100` (more resonant) and - a maximum of `100` (more nasal). A value of `0` leaves this parameter - unchanged from the base voice. - pitch: - type: optional - docs: >- - The frequency of the voice, ranging between low and high. - - - The default value is `0`, with a minimum of `-100` (lower) and a - maximum of `100` (higher). A value of `0` leaves this parameter - unchanged from the base voice. - source: - openapi: stenographer-openapi.json - ReturnCustomVoice: - docs: A Custom Voice specification associated with this Config. - properties: - id: - type: string - docs: Identifier for a Custom Voice. Formatted as a UUID. - version: - type: integer - docs: >- - Version number for a Custom Voice. - - - Custom Voices, Prompts, Configs, 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 Custom Voice. Each update to the Custom Voice increments its - version number. - name: - type: string - docs: The name of the Custom Voice. Maximum length of 75 characters. - created_on: - type: long - docs: >- - Time at which the Custom Voice was created. Measured in seconds since - the Unix epoch. - modified_on: - type: long - docs: >- - Time at which the Custom Voice was last modified. Measured in seconds - since the Unix epoch. - base_voice: - type: ReturnCustomVoiceBaseVoice - docs: The base voice used to create the Custom Voice. - parameter_model: - type: literal<"20240715-4parameter"> - docs: >- - The name of the parameter model used to define which attributes are - used by the `parameters` field. Currently, only `20240715-4parameter` - is supported as the parameter model. - parameters: - type: ReturnCustomVoiceParameters - docs: >- - The specified attributes of a Custom Voice. If a parameter's value is - `0` (default), it will not be included in the response. - source: - openapi: stenographer-openapi.json - PostedBuiltinToolName: - enum: - - web_search - - hang_up - docs: >- - Name of the built-in tool to use. Hume supports the following built-in - tools: - - - - **web_search:** enables EVI to search the web for up-to-date information - when applicable. - - - **hang_up:** closes the WebSocket connection when appropriate (e.g., - after detecting a farewell in the conversation). - - - For more information, see our guide on [using built-in - tools](/docs/empathic-voice-interface-evi/tool-use#using-built-in-tools). - source: - openapi: stenographer-openapi.json - PostedBuiltinTool: - docs: A configuration of a built-in tool to be posted to the server - properties: - name: - type: PostedBuiltinToolName - docs: >- - Name of the built-in tool to use. Hume supports the following built-in - tools: - - - - **web_search:** enables EVI to search the web for up-to-date - information when applicable. - - - **hang_up:** closes the WebSocket connection when appropriate (e.g., - after detecting a farewell in the conversation). - - - For more information, see our guide on [using built-in - tools](/docs/empathic-voice-interface-evi/tool-use#using-built-in-tools). - fallback_content: - type: optional - docs: >- - Optional text passed to the supplemental LLM in place of the tool call - result. The LLM then uses this text to generate a response back to the - user, ensuring continuity in the conversation if the Tool errors. - source: - openapi: stenographer-openapi.json - PostedConfigPromptSpec: - docs: >- - Identifies which prompt to use in a a config OR how to create a new prompt - to use in the config - properties: - id: - type: optional - docs: Identifier for a Prompt. Formatted as a UUID. - version: - type: optional - docs: >- - Version number for a Prompt. Version numbers should be integers. The - combination of configId and version number is unique. - text: - type: optional - docs: Text used to create a new prompt for a particular config. - source: - openapi: stenographer-openapi.json - PostedEllmModel: - docs: A eLLM model configuration to be posted to the server - properties: - allow_short_responses: - type: optional - docs: |- - Boolean indicating if the eLLM is allowed to generate short responses. - - If omitted, short responses from the eLLM are enabled by default. - source: - openapi: stenographer-openapi.json - PostedEventMessageSpec: - docs: Settings for a specific event_message to be posted to the server - properties: - enabled: - type: boolean - docs: >- - Boolean indicating if this event message is enabled. - - - If set to `true`, a message will be sent when the circumstances for - the specific event are met. - text: - type: optional - docs: >- - Text to use as the event message when the corresponding event occurs. - If no text is specified, EVI will generate an appropriate message - based on its current context and the system prompt. - source: - openapi: stenographer-openapi.json - PostedEventMessageSpecs: - docs: >- - Collection of event messages returned by the server. - - - Event messages are sent by the server when specific events occur during a - chat session. These messages are used to configure behaviors for EVI, such - as controlling how EVI starts a new conversation. - properties: - on_new_chat: - type: optional - docs: >- - Specifies the initial message EVI provides when a new chat is started, - such as a greeting or welcome message. - on_inactivity_timeout: - type: optional - docs: >- - Specifies the message EVI provides when the chat is about to be - disconnected due to a user inactivity timeout, such as a message - mentioning a lack of user input for a period of time. - - - Enabling an inactivity message allows developers to use this message - event for "checking in" with the user if they are not responding to - see if they are still active. - - - If the user does not respond in the number of seconds specified in the - `inactivity_timeout` field, then EVI will say the message and the user - has 15 seconds to respond. If they respond in time, the conversation - will continue; if not, the conversation will end. - - - However, if the inactivity message is not enabled, then reaching the - inactivity timeout will immediately end the connection. - on_max_duration_timeout: - type: optional - docs: >- - Specifies the message EVI provides when the chat is disconnected due - to reaching the maximum chat duration, such as a message mentioning - the time limit for the chat has been reached. - source: - openapi: stenographer-openapi.json - PostedLanguageModelModelProvider: - enum: - - OPEN_AI - - CUSTOM_LANGUAGE_MODEL - - ANTHROPIC - - FIREWORKS - - GROQ - - GOOGLE + parameter_model: + type: literal<"20241004-11parameter"> + docs: >- + The name of the parameter model used to define which attributes are + used by the `parameters` field. Currently, only `20241004-11parameter` + is supported as the parameter model. + parameters: + type: ReturnCustomVoiceParameters + docs: >- + The specified attributes of a Custom Voice. If a parameter's value is + `0` (default), it will not be included in the response. + source: + openapi: stenographer-openapi.json + PostedBuiltinToolName: + enum: + - web_search + - hang_up + docs: >- + Name of the built-in tool to use. Hume supports the following built-in + tools: + + + - **web_search:** enables EVI to search the web for up-to-date information + when applicable. + + - **hang_up:** closes the WebSocket connection when appropriate (e.g., + after detecting a farewell in the conversation). + + + For more information, see our guide on [using built-in + tools](/docs/empathic-voice-interface-evi/tool-use#using-built-in-tools). + source: + openapi: stenographer-openapi.json + PostedBuiltinTool: + docs: A configuration of a built-in tool to be posted to the server + properties: + name: + type: PostedBuiltinToolName + docs: >- + Name of the built-in tool to use. Hume supports the following built-in + tools: + + + - **web_search:** enables EVI to search the web for up-to-date + information when applicable. + + - **hang_up:** closes the WebSocket connection when appropriate (e.g., + after detecting a farewell in the conversation). + + + For more information, see our guide on [using built-in + tools](/docs/empathic-voice-interface-evi/tool-use#using-built-in-tools). + fallback_content: + type: optional + docs: >- + Optional text passed to the supplemental LLM in place of the tool call + result. The LLM then uses this text to generate a response back to the + user, ensuring continuity in the conversation if the Tool errors. + source: + openapi: stenographer-openapi.json + PostedConfigPromptSpec: + docs: >- + Identifies which prompt to use in a a config OR how to create a new prompt + to use in the config + properties: + id: + type: optional + docs: Identifier for a Prompt. Formatted as a UUID. + version: + type: optional + docs: >- + Version number for a Prompt. Version numbers should be integers. The + combination of configId and version number is unique. + text: + type: optional + docs: Text used to create a new prompt for a particular config. + source: + openapi: stenographer-openapi.json + PostedEllmModel: + docs: A eLLM model configuration to be posted to the server + properties: + allow_short_responses: + type: optional + docs: |- + Boolean indicating if the eLLM is allowed to generate short responses. + + If omitted, short responses from the eLLM are enabled by default. + source: + openapi: stenographer-openapi.json + PostedEventMessageSpec: + docs: Settings for a specific event_message to be posted to the server + properties: + enabled: + type: boolean + docs: >- + Boolean indicating if this event message is enabled. + + + If set to `true`, a message will be sent when the circumstances for + the specific event are met. + text: + type: optional + docs: >- + Text to use as the event message when the corresponding event occurs. + If no text is specified, EVI will generate an appropriate message + based on its current context and the system prompt. + source: + openapi: stenographer-openapi.json + PostedEventMessageSpecs: + docs: >- + Collection of event messages returned by the server. + + + Event messages are sent by the server when specific events occur during a + chat session. These messages are used to configure behaviors for EVI, such + as controlling how EVI starts a new conversation. + properties: + on_new_chat: + type: optional + docs: >- + Specifies the initial message EVI provides when a new chat is started, + such as a greeting or welcome message. + on_inactivity_timeout: + type: optional + docs: >- + Specifies the message EVI provides when the chat is about to be + disconnected due to a user inactivity timeout, such as a message + mentioning a lack of user input for a period of time. + + + Enabling an inactivity message allows developers to use this message + event for "checking in" with the user if they are not responding to + see if they are still active. + + + If the user does not respond in the number of seconds specified in the + `inactivity_timeout` field, then EVI will say the message and the user + has 15 seconds to respond. If they respond in time, the conversation + will continue; if not, the conversation will end. + + + However, if the inactivity message is not enabled, then reaching the + inactivity timeout will immediately end the connection. + on_max_duration_timeout: + type: optional + docs: >- + Specifies the message EVI provides when the chat is disconnected due + to reaching the maximum chat duration, such as a message mentioning + the time limit for the chat has been reached. + source: + openapi: stenographer-openapi.json + PostedLanguageModelModelProvider: + enum: + - OPEN_AI + - CUSTOM_LANGUAGE_MODEL + - ANTHROPIC + - FIREWORKS + - GROQ + - GOOGLE + docs: The provider of the supplemental language model. + source: + openapi: stenographer-openapi.json + PostedLanguageModel: + docs: A LanguageModel to be posted to the server + properties: + model_provider: + type: optional docs: The provider of the supplemental language model. - source: - openapi: stenographer-openapi.json - PostedLanguageModel: - docs: A LanguageModel to be posted to the server - properties: - model_provider: - type: optional - docs: The provider of the supplemental language model. - model_resource: - type: optional - docs: String that specifies the language model to use with `model_provider`. - temperature: - type: optional - docs: >- - The model temperature, with values between 0 to 1 (inclusive). - - - Controls the randomness of the LLM’s output, with values closer to 0 - yielding focused, deterministic responses and values closer to 1 - producing more creative, diverse responses. - source: - openapi: stenographer-openapi.json - PostedTimeoutSpec: - docs: Settings for a specific timeout to be posted to the server - properties: - enabled: - type: boolean - docs: Boolean indicating if this event message is enabled. - duration_secs: - type: optional - docs: Duration in seconds for the timeout. - source: - openapi: stenographer-openapi.json - PostedTimeoutSpecsInactivity: - docs: >- - Specifies the duration of user inactivity (in seconds) after which the EVI - WebSocket connection will be automatically disconnected. Default is 600 - seconds (10 minutes). - - - Accepts a minimum value of 1 second and a maximum value of 1,800 seconds. - properties: - enabled: - type: boolean - docs: >- - Boolean indicating if this timeout is enabled. - - - If set to false, EVI will not timeout due to a specified duration of - user inactivity being reached. However, the conversation will - eventually disconnect after 1,800 seconds (30 minutes), which is the - maximum WebSocket duration limit for EVI. - duration_secs: - type: optional - docs: >- - Duration in seconds for the timeout (e.g. 600 seconds represents 10 - minutes). - source: - openapi: stenographer-openapi.json - PostedTimeoutSpecsMaxDuration: - docs: >- - Specifies the maximum allowed duration (in seconds) for an EVI WebSocket - connection before it is automatically disconnected. Default is 1,800 - seconds (30 minutes). - - - Accepts a minimum value of 1 second and a maximum value of 1,800 seconds. - properties: - enabled: - type: boolean - docs: >- - Boolean indicating if this timeout is enabled. - - - If set to false, EVI will not timeout due to a specified maximum - duration being reached. However, the conversation will eventually - disconnect after 1,800 seconds (30 minutes), which is the maximum - WebSocket duration limit for EVI. - duration_secs: - type: optional - docs: >- - Duration in seconds for the timeout (e.g. 600 seconds represents 10 - minutes). - source: - openapi: stenographer-openapi.json - PostedTimeoutSpecs: - docs: >- - Collection of timeout specifications returned by the server. - - - Timeouts are sent by the server when specific time-based events occur - during a chat session. These specifications set the inactivity timeout and - the maximum duration an EVI WebSocket connection can stay open before it - is automatically disconnected. - properties: - inactivity: - type: optional - docs: >- - Specifies the duration of user inactivity (in seconds) after which the - EVI WebSocket connection will be automatically disconnected. Default - is 600 seconds (10 minutes). - - - Accepts a minimum value of 1 second and a maximum value of 1,800 - seconds. - max_duration: - type: optional - docs: >- - Specifies the maximum allowed duration (in seconds) for an EVI - WebSocket connection before it is automatically disconnected. Default - is 1,800 seconds (30 minutes). - - - Accepts a minimum value of 1 second and a maximum value of 1,800 - seconds. - source: - openapi: stenographer-openapi.json - PostedUserDefinedToolSpec: - docs: A specific tool identifier to be posted to the server - properties: - id: - type: string - docs: Identifier for a Tool. Formatted as a UUID. - version: - type: optional - docs: >- - 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. - source: - openapi: stenographer-openapi.json - PostedVoice: - docs: A Voice specification posted to the server - properties: - provider: - type: literal<"HUME_AI"> - docs: >- - The provider of the voice to use. Currently, only `HUME_AI` is - supported as the voice provider. - name: - type: optional - docs: >- - Specifies the name of the voice to use. - - - This can be either the name of a previously created Custom Voice or - one of our 7 base voices: `ITO`, `KORA`, `DACHER`, `AURA`, `FINN`, - `WHIMSY`, or `STELLA`. - - - The name will be automatically converted to uppercase (e.g., "Ito" - becomes "ITO"). If a name is not specified, then a [Custom - Voice](/reference/empathic-voice-interface-evi/configs/create-config#request.body.voice.custom_voice) - specification must be provided. - custom_voice: optional - source: - openapi: stenographer-openapi.json - ReturnBuiltinToolToolType: - enum: - - BUILTIN - - FUNCTION - docs: >- - Type of Tool. Either `BUILTIN` for natively implemented tools, like web - search, or `FUNCTION` for user-defined tools. - source: - openapi: stenographer-openapi.json - ReturnBuiltinTool: - docs: A specific builtin tool version returned from the server - properties: - tool_type: - type: ReturnBuiltinToolToolType - docs: >- - Type of Tool. Either `BUILTIN` for natively implemented tools, like - web search, or `FUNCTION` for user-defined tools. - name: - type: string - docs: Name applied to all versions of a particular Tool. - fallback_content: - type: optional - docs: >- - Optional text passed to the supplemental LLM in place of the tool call - result. The LLM then uses this text to generate a response back to the - user, ensuring continuity in the conversation if the Tool errors. - source: - openapi: stenographer-openapi.json - ReturnConfig: - docs: A specific config version returned from the server - properties: - id: - type: optional - docs: Identifier for a Config. Formatted as a UUID. - version: - type: optional - docs: >- - 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. - evi_version: - type: optional - docs: >- - Specifies the EVI version to use. Use `"1"` for version 1, or `"2"` - for the latest enhanced version. For a detailed comparison of the two - versions, refer to our - [guide](/docs/empathic-voice-interface-evi/evi-2). - version_description: - type: optional - docs: An optional description of the Config version. - name: - type: optional - docs: Name applied to all versions of a particular Config. - created_on: - type: optional - docs: >- - Time at which the Config was created. Measured in seconds since the - Unix epoch. - modified_on: - type: optional - docs: >- - Time at which the Config was last modified. Measured in seconds since - the Unix epoch. - prompt: optional - voice: - type: optional - docs: A voice specification associated with this Config. - language_model: - type: optional - docs: >- - The supplemental language model associated with this Config. - - - This model is used to generate longer, more detailed responses from - EVI. Choosing an appropriate supplemental language model for your use - case is crucial for generating fast, high-quality responses from EVI. - ellm_model: - type: optional - docs: >- - The eLLM setup associated with this Config. - - - Hume's eLLM (empathic Large Language Model) is a multimodal language - model that takes into account both expression measures and language. - The eLLM generates short, empathic language responses and guides - text-to-speech (TTS) prosody. - tools: - type: optional>> - docs: List of user-defined tools associated with this Config. - builtin_tools: - type: optional>> - docs: List of built-in tools associated with this Config. - event_messages: optional - timeouts: optional - source: - openapi: stenographer-openapi.json - ReturnEllmModel: - docs: A specific eLLM Model configuration - properties: - allow_short_responses: - type: boolean - docs: |- - Boolean indicating if the eLLM is allowed to generate short responses. - - If omitted, short responses from the eLLM are enabled by default. - source: - openapi: stenographer-openapi.json - ReturnEventMessageSpec: - docs: A specific event message configuration to be returned from the server - properties: - enabled: - type: boolean - docs: >- - Boolean indicating if this event message is enabled. - - - If set to `true`, a message will be sent when the circumstances for - the specific event are met. - text: - type: optional - docs: >- - Text to use as the event message when the corresponding event occurs. - If no text is specified, EVI will generate an appropriate message - based on its current context and the system prompt. - source: - openapi: stenographer-openapi.json - ReturnEventMessageSpecs: - docs: >- - Collection of event messages returned by the server. - - - Event messages are sent by the server when specific events occur during a - chat session. These messages are used to configure behaviors for EVI, such - as controlling how EVI starts a new conversation. - properties: - on_new_chat: - type: optional - docs: >- - Specifies the initial message EVI provides when a new chat is started, - such as a greeting or welcome message. - on_inactivity_timeout: - type: optional - docs: >- - Specifies the message EVI provides when the chat is about to be - disconnected due to a user inactivity timeout, such as a message - mentioning a lack of user input for a period of time. - - - Enabling an inactivity message allows developers to use this message - event for "checking in" with the user if they are not responding to - see if they are still active. - - - If the user does not respond in the number of seconds specified in the - `inactivity_timeout` field, then EVI will say the message and the user - has 15 seconds to respond. If they respond in time, the conversation - will continue; if not, the conversation will end. - - - However, if the inactivity message is not enabled, then reaching the - inactivity timeout will immediately end the connection. - on_max_duration_timeout: - type: optional - docs: >- - Specifies the message EVI provides when the chat is disconnected due - to reaching the maximum chat duration, such as a message mentioning - the time limit for the chat has been reached. - source: - openapi: stenographer-openapi.json - ReturnLanguageModelModelProvider: - enum: - - OPEN_AI - - CUSTOM_LANGUAGE_MODEL - - ANTHROPIC - - FIREWORKS - - GROQ - - GOOGLE + model_resource: + type: optional + docs: String that specifies the language model to use with `model_provider`. + temperature: + type: optional + docs: >- + The model temperature, with values between 0 to 1 (inclusive). + + + Controls the randomness of the LLM’s output, with values closer to 0 + yielding focused, deterministic responses and values closer to 1 + producing more creative, diverse responses. + source: + openapi: stenographer-openapi.json + PostedTimeoutSpec: + docs: Settings for a specific timeout to be posted to the server + properties: + enabled: + type: boolean + docs: Boolean indicating if this event message is enabled. + duration_secs: + type: optional + docs: Duration in seconds for the timeout. + source: + openapi: stenographer-openapi.json + PostedTimeoutSpecsInactivity: + docs: >- + Specifies the duration of user inactivity (in seconds) after which the EVI + WebSocket connection will be automatically disconnected. Default is 600 + seconds (10 minutes). + + + Accepts a minimum value of 1 second and a maximum value of 1,800 seconds. + properties: + enabled: + type: boolean + docs: >- + Boolean indicating if this timeout is enabled. + + + If set to false, EVI will not timeout due to a specified duration of + user inactivity being reached. However, the conversation will + eventually disconnect after 1,800 seconds (30 minutes), which is the + maximum WebSocket duration limit for EVI. + duration_secs: + type: optional + docs: >- + Duration in seconds for the timeout (e.g. 600 seconds represents 10 + minutes). + source: + openapi: stenographer-openapi.json + PostedTimeoutSpecsMaxDuration: + docs: >- + Specifies the maximum allowed duration (in seconds) for an EVI WebSocket + connection before it is automatically disconnected. Default is 1,800 + seconds (30 minutes). + + + Accepts a minimum value of 1 second and a maximum value of 1,800 seconds. + properties: + enabled: + type: boolean + docs: >- + Boolean indicating if this timeout is enabled. + + + If set to false, EVI will not timeout due to a specified maximum + duration being reached. However, the conversation will eventually + disconnect after 1,800 seconds (30 minutes), which is the maximum + WebSocket duration limit for EVI. + duration_secs: + type: optional + docs: >- + Duration in seconds for the timeout (e.g. 600 seconds represents 10 + minutes). + source: + openapi: stenographer-openapi.json + PostedTimeoutSpecs: + docs: >- + Collection of timeout specifications returned by the server. + + + Timeouts are sent by the server when specific time-based events occur + during a chat session. These specifications set the inactivity timeout and + the maximum duration an EVI WebSocket connection can stay open before it + is automatically disconnected. + properties: + inactivity: + type: optional + docs: >- + Specifies the duration of user inactivity (in seconds) after which the + EVI WebSocket connection will be automatically disconnected. Default + is 600 seconds (10 minutes). + + + Accepts a minimum value of 1 second and a maximum value of 1,800 + seconds. + max_duration: + type: optional + docs: >- + Specifies the maximum allowed duration (in seconds) for an EVI + WebSocket connection before it is automatically disconnected. Default + is 1,800 seconds (30 minutes). + + + Accepts a minimum value of 1 second and a maximum value of 1,800 + seconds. + source: + openapi: stenographer-openapi.json + PostedUserDefinedToolSpec: + docs: A specific tool identifier to be posted to the server + properties: + id: + type: string + docs: Identifier for a Tool. Formatted as a UUID. + version: + type: optional + docs: >- + 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. + source: + openapi: stenographer-openapi.json + PostedVoice: + docs: A Voice specification posted to the server + properties: + provider: + type: literal<"HUME_AI"> + docs: >- + The provider of the voice to use. Currently, only `HUME_AI` is + supported as the voice provider. + name: + type: optional + docs: >- + Specifies the name of the voice to use. + + + This can be either the name of a previously created Custom Voice or + one of our 8 base voices: `ITO`, `KORA`, `DACHER`, `AURA`, `FINN`, + `WHIMSY`, `STELLA`, or `SUNNY`. + + + The name will be automatically converted to uppercase (e.g., "Ito" + becomes "ITO"). If a name is not specified, then a [Custom + Voice](/reference/empathic-voice-interface-evi/configs/create-config#request.body.voice.custom_voice) + specification must be provided. + custom_voice: optional + source: + openapi: stenographer-openapi.json + ReturnBuiltinToolToolType: + enum: + - BUILTIN + - FUNCTION + docs: >- + Type of Tool. Either `BUILTIN` for natively implemented tools, like web + search, or `FUNCTION` for user-defined tools. + source: + openapi: stenographer-openapi.json + ReturnBuiltinTool: + docs: A specific builtin tool version returned from the server + properties: + tool_type: + type: ReturnBuiltinToolToolType + docs: >- + Type of Tool. Either `BUILTIN` for natively implemented tools, like + web search, or `FUNCTION` for user-defined tools. + name: + type: string + docs: Name applied to all versions of a particular Tool. + fallback_content: + type: optional + docs: >- + Optional text passed to the supplemental LLM in place of the tool call + result. The LLM then uses this text to generate a response back to the + user, ensuring continuity in the conversation if the Tool errors. + source: + openapi: stenographer-openapi.json + ReturnConfig: + docs: A specific config version returned from the server + properties: + id: + type: optional + docs: Identifier for a Config. Formatted as a UUID. + version: + type: optional + docs: >- + 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. + evi_version: + type: optional + docs: >- + Specifies the EVI version to use. Use `"1"` for version 1, or `"2"` + for the latest enhanced version. For a detailed comparison of the two + versions, refer to our + [guide](/docs/empathic-voice-interface-evi/evi-2). + version_description: + type: optional + docs: An optional description of the Config version. + name: + type: optional + docs: Name applied to all versions of a particular Config. + created_on: + type: optional + docs: >- + Time at which the Config was created. Measured in seconds since the + Unix epoch. + modified_on: + type: optional + docs: >- + Time at which the Config was last modified. Measured in seconds since + the Unix epoch. + prompt: optional + voice: + type: optional + docs: A voice specification associated with this Config. + language_model: + type: optional + docs: >- + The supplemental language model associated with this Config. + + + This model is used to generate longer, more detailed responses from + EVI. Choosing an appropriate supplemental language model for your use + case is crucial for generating fast, high-quality responses from EVI. + ellm_model: + type: optional + docs: >- + The eLLM setup associated with this Config. + + + Hume's eLLM (empathic Large Language Model) is a multimodal language + model that takes into account both expression measures and language. + The eLLM generates short, empathic language responses and guides + text-to-speech (TTS) prosody. + tools: + type: optional>> + docs: List of user-defined tools associated with this Config. + builtin_tools: + type: optional>> + docs: List of built-in tools associated with this Config. + event_messages: optional + timeouts: optional + source: + openapi: stenographer-openapi.json + ReturnEllmModel: + docs: A specific eLLM Model configuration + properties: + allow_short_responses: + type: boolean + docs: |- + Boolean indicating if the eLLM is allowed to generate short responses. + + If omitted, short responses from the eLLM are enabled by default. + source: + openapi: stenographer-openapi.json + ReturnEventMessageSpec: + docs: A specific event message configuration to be returned from the server + properties: + enabled: + type: boolean + docs: >- + Boolean indicating if this event message is enabled. + + + If set to `true`, a message will be sent when the circumstances for + the specific event are met. + text: + type: optional + docs: >- + Text to use as the event message when the corresponding event occurs. + If no text is specified, EVI will generate an appropriate message + based on its current context and the system prompt. + source: + openapi: stenographer-openapi.json + ReturnEventMessageSpecs: + docs: >- + Collection of event messages returned by the server. + + + Event messages are sent by the server when specific events occur during a + chat session. These messages are used to configure behaviors for EVI, such + as controlling how EVI starts a new conversation. + properties: + on_new_chat: + type: optional + docs: >- + Specifies the initial message EVI provides when a new chat is started, + such as a greeting or welcome message. + on_inactivity_timeout: + type: optional + docs: >- + Specifies the message EVI provides when the chat is about to be + disconnected due to a user inactivity timeout, such as a message + mentioning a lack of user input for a period of time. + + + Enabling an inactivity message allows developers to use this message + event for "checking in" with the user if they are not responding to + see if they are still active. + + + If the user does not respond in the number of seconds specified in the + `inactivity_timeout` field, then EVI will say the message and the user + has 15 seconds to respond. If they respond in time, the conversation + will continue; if not, the conversation will end. + + + However, if the inactivity message is not enabled, then reaching the + inactivity timeout will immediately end the connection. + on_max_duration_timeout: + type: optional + docs: >- + Specifies the message EVI provides when the chat is disconnected due + to reaching the maximum chat duration, such as a message mentioning + the time limit for the chat has been reached. + source: + openapi: stenographer-openapi.json + ReturnLanguageModelModelProvider: + enum: + - OPEN_AI + - CUSTOM_LANGUAGE_MODEL + - ANTHROPIC + - FIREWORKS + - GROQ + - GOOGLE + docs: The provider of the supplemental language model. + source: + openapi: stenographer-openapi.json + ReturnLanguageModel: + docs: A specific LanguageModel + properties: + model_provider: + type: optional docs: The provider of the supplemental language model. - source: - openapi: stenographer-openapi.json - ReturnLanguageModel: - docs: A specific LanguageModel - properties: - model_provider: - type: optional - docs: The provider of the supplemental language model. - model_resource: - type: optional - docs: String that specifies the language model to use with `model_provider`. - temperature: - type: optional - docs: >- - The model temperature, with values between 0 to 1 (inclusive). - - - Controls the randomness of the LLM’s output, with values closer to 0 - yielding focused, deterministic responses and values closer to 1 - producing more creative, diverse responses. - source: - openapi: stenographer-openapi.json - ReturnTimeoutSpec: - docs: A specific timeout configuration to be returned from the server - properties: - enabled: - type: boolean - docs: >- - Boolean indicating if this timeout is enabled. - - - If set to false, EVI will not timeout due to a specified duration - being reached. However, the conversation will eventually disconnect - after 1,800 seconds (30 minutes), which is the maximum WebSocket - duration limit for EVI. - duration_secs: - type: optional - docs: >- - Duration in seconds for the timeout (e.g. 600 seconds represents 10 - minutes). - source: - openapi: stenographer-openapi.json - ReturnTimeoutSpecs: - docs: >- - Collection of timeout specifications returned by the server. - - - Timeouts are sent by the server when specific time-based events occur - during a chat session. These specifications set the inactivity timeout and - the maximum duration an EVI WebSocket connection can stay open before it - is automatically disconnected. - properties: - inactivity: - type: ReturnTimeoutSpec - docs: >- - Specifies the duration of user inactivity (in seconds) after which the - EVI WebSocket connection will be automatically disconnected. Default - is 600 seconds (10 minutes). - - - Accepts a minimum value of 1 second and a maximum value of 1,800 - seconds. - max_duration: - type: ReturnTimeoutSpec - docs: >- - Specifies the maximum allowed duration (in seconds) for an EVI - WebSocket connection before it is automatically disconnected. Default - is 1,800 seconds (30 minutes). - - - Accepts a minimum value of 1 second and a maximum value of 1,800 - seconds. - source: - openapi: stenographer-openapi.json - ReturnVoice: - docs: A specific voice specification - properties: - provider: - type: literal<"HUME_AI"> - docs: >- - The provider of the voice to use. Currently, only `HUME_AI` is - supported as the voice provider. - name: - type: optional - docs: >- - The name of the specified voice. - - - 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: optional - source: - openapi: stenographer-openapi.json - ReturnPagedUserDefinedTools: - docs: A paginated list of user defined tool versions returned from the server - properties: - page_number: - type: integer - docs: >- - The page number of the returned list. - - - This value corresponds to the `page_number` parameter specified in the - request. Pagination uses zero-based indexing. - page_size: - type: integer - docs: >- - The maximum number of items returned per page. - - - This value corresponds to the `page_size` parameter specified in the - request. - total_pages: - type: integer - docs: The total number of pages in the collection. - tools_page: - docs: >- - List of tools returned for the specified `page_number` and - `page_size`. - type: list> - source: - openapi: stenographer-openapi.json - ReturnPagedPrompts: - docs: A paginated list of prompt versions returned from the server - properties: - page_number: - type: integer - docs: >- - The page number of the returned list. - - - This value corresponds to the `page_number` parameter specified in the - request. Pagination uses zero-based indexing. - page_size: - type: integer - docs: >- - The maximum number of items returned per page. - - - This value corresponds to the `page_size` parameter specified in the - request. - total_pages: - type: integer - docs: The total number of pages in the collection. - prompts_page: - docs: >- - List of prompts returned for the specified `page_number` and - `page_size`. - type: list> - source: - openapi: stenographer-openapi.json - ReturnPagedCustomVoices: - docs: A paginated list of custom voices returned from the server - properties: - page_number: - type: integer - docs: >- - The page number of the returned list. - - - This value corresponds to the `page_number` parameter specified in the - request. Pagination uses zero-based indexing. - page_size: - type: integer - docs: >- - The maximum number of items returned per page. - - - This value corresponds to the `page_size` parameter specified in the - request. - total_pages: - type: integer - docs: The total number of pages in the collection. - custom_voices_page: - docs: List of Custom Voices for the specified `page_number` and `page_size`. - type: list - source: - openapi: stenographer-openapi.json - ReturnPagedConfigs: - docs: A paginated list of config versions returned from the server - properties: - page_number: - type: optional - docs: >- - The page number of the returned list. - - - This value corresponds to the `page_number` parameter specified in the - request. Pagination uses zero-based indexing. - page_size: - type: optional - docs: >- - The maximum number of items returned per page. - - - This value corresponds to the `page_size` parameter specified in the - request. - total_pages: - type: integer - docs: The total number of pages in the collection. - configs_page: - type: optional> - docs: >- - List of configs returned for the specified `page_number` and - `page_size`. - source: - openapi: stenographer-openapi.json - ReturnChatStatus: - enum: - - ACTIVE - - USER_ENDED - - USER_TIMEOUT - - MAX_DURATION_TIMEOUT - - INACTIVITY_TIMEOUT - - ERROR - docs: >- - Indicates the current state of the chat. There are six possible statuses: - - - - `ACTIVE`: The chat is currently active and ongoing. - - - - `USER_ENDED`: The chat was manually ended by the user. - - - - `USER_TIMEOUT`: The chat ended due to a user-defined timeout. - - - - `MAX_DURATION_TIMEOUT`: The chat ended because it reached the maximum - allowed duration. - - - - `INACTIVITY_TIMEOUT`: The chat ended due to an inactivity timeout. - - - - `ERROR`: The chat ended unexpectedly due to an error. - source: - openapi: stenographer-openapi.json - ReturnChat: - docs: A description of chat and its status - properties: - id: - type: string - docs: Identifier for a Chat. Formatted as a UUID. - chat_group_id: - type: string - docs: >- - Identifier for the Chat Group. Any chat resumed from this Chat will - have the same `chat_group_id`. Formatted as a UUID. - status: - type: ReturnChatStatus - docs: >- - Indicates the current state of the chat. There are six possible - statuses: - - - - `ACTIVE`: The chat is currently active and ongoing. - - - - `USER_ENDED`: The chat was manually ended by the user. - - - - `USER_TIMEOUT`: The chat ended due to a user-defined timeout. - - - - `MAX_DURATION_TIMEOUT`: The chat ended because it reached the - maximum allowed duration. - - - - `INACTIVITY_TIMEOUT`: The chat ended due to an inactivity timeout. - - - - `ERROR`: The chat ended unexpectedly due to an error. - start_timestamp: - type: long - docs: >- - Time at which the Chat started. Measured in seconds since the Unix - epoch. - end_timestamp: - type: optional - docs: >- - Time at which the Chat ended. Measured in seconds since the Unix - epoch. - event_count: - type: optional - docs: The total number of events currently in this chat. - metadata: - type: optional - docs: Stringified JSON with additional metadata about the chat. - config: optional - source: - openapi: stenographer-openapi.json - ReturnConfigSpec: - docs: The Config associated with this Chat. - properties: - id: - type: string - docs: Identifier for a Config. Formatted as a UUID. - version: - type: optional - docs: >- - 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. + model_resource: + type: optional + docs: String that specifies the language model to use with `model_provider`. + temperature: + type: optional + docs: >- + The model temperature, with values between 0 to 1 (inclusive). + + + Controls the randomness of the LLM’s output, with values closer to 0 + yielding focused, deterministic responses and values closer to 1 + producing more creative, diverse responses. + source: + openapi: stenographer-openapi.json + ReturnTimeoutSpec: + docs: A specific timeout configuration to be returned from the server + properties: + enabled: + type: boolean + docs: >- + Boolean indicating if this timeout is enabled. + + + If set to false, EVI will not timeout due to a specified duration + being reached. However, the conversation will eventually disconnect + after 1,800 seconds (30 minutes), which is the maximum WebSocket + duration limit for EVI. + duration_secs: + type: optional + docs: >- + Duration in seconds for the timeout (e.g. 600 seconds represents 10 + minutes). + source: + openapi: stenographer-openapi.json + ReturnTimeoutSpecs: + docs: >- + Collection of timeout specifications returned by the server. + + + Timeouts are sent by the server when specific time-based events occur + during a chat session. These specifications set the inactivity timeout and + the maximum duration an EVI WebSocket connection can stay open before it + is automatically disconnected. + properties: + inactivity: + type: ReturnTimeoutSpec + docs: >- + Specifies the duration of user inactivity (in seconds) after which the + EVI WebSocket connection will be automatically disconnected. Default + is 600 seconds (10 minutes). + + + Accepts a minimum value of 1 second and a maximum value of 1,800 + seconds. + max_duration: + type: ReturnTimeoutSpec + docs: >- + Specifies the maximum allowed duration (in seconds) for an EVI + WebSocket connection before it is automatically disconnected. Default + is 1,800 seconds (30 minutes). + + + Accepts a minimum value of 1 second and a maximum value of 1,800 + seconds. + source: + openapi: stenographer-openapi.json + ReturnVoice: + docs: A specific voice specification + properties: + provider: + type: literal<"HUME_AI"> + docs: >- + The provider of the voice to use. Currently, only `HUME_AI` is + supported as the voice provider. + name: + type: optional + docs: >- + The name of the specified voice. + + + This will either be the name of a previously created Custom Voice or + one of our 8 base voices: `ITO`, `KORA`, `DACHER`, `AURA`, `FINN`, + `WHIMSY`, `STELLA`, or `SUNNY`. + custom_voice: optional + source: + openapi: stenographer-openapi.json + ReturnPagedUserDefinedTools: + docs: A paginated list of user defined tool versions returned from the server + properties: + page_number: + type: integer + docs: >- + The page number of the returned list. + + + This value corresponds to the `page_number` parameter specified in the + request. Pagination uses zero-based indexing. + page_size: + type: integer + docs: >- + The maximum number of items returned per page. + + + This value corresponds to the `page_size` parameter specified in the + request. + total_pages: + type: integer + docs: The total number of pages in the collection. + tools_page: + docs: >- + List of tools returned for the specified `page_number` and + `page_size`. + type: list> + source: + openapi: stenographer-openapi.json + ReturnPagedPrompts: + docs: A paginated list of prompt versions returned from the server + properties: + page_number: + type: integer + docs: >- + The page number of the returned list. + + + This value corresponds to the `page_number` parameter specified in the + request. Pagination uses zero-based indexing. + page_size: + type: integer + docs: >- + The maximum number of items returned per page. + + + This value corresponds to the `page_size` parameter specified in the + request. + total_pages: + type: integer + docs: The total number of pages in the collection. + prompts_page: + docs: >- + List of prompts returned for the specified `page_number` and + `page_size`. + type: list> + source: + openapi: stenographer-openapi.json + ReturnPagedCustomVoices: + docs: A paginated list of custom voices returned from the server + properties: + page_number: + type: integer + docs: >- + The page number of the returned list. + + + This value corresponds to the `page_number` parameter specified in the + request. Pagination uses zero-based indexing. + page_size: + type: integer + docs: >- + The maximum number of items returned per page. + + + This value corresponds to the `page_size` parameter specified in the + request. + total_pages: + type: integer + docs: The total number of pages in the collection. + custom_voices_page: + docs: List of Custom Voices for the specified `page_number` and `page_size`. + type: list + source: + openapi: stenographer-openapi.json + ReturnPagedConfigs: + docs: A paginated list of config versions returned from the server + properties: + page_number: + type: optional + docs: >- + The page number of the returned list. + + + This value corresponds to the `page_number` parameter specified in the + request. Pagination uses zero-based indexing. + page_size: + type: optional + docs: >- + The maximum number of items returned per page. + + + This value corresponds to the `page_size` parameter specified in the + request. + total_pages: + type: integer + docs: The total number of pages in the collection. + configs_page: + type: optional> + docs: >- + List of configs returned for the specified `page_number` and + `page_size`. + source: + openapi: stenographer-openapi.json + ReturnChatStatus: + enum: + - ACTIVE + - USER_ENDED + - USER_TIMEOUT + - MAX_DURATION_TIMEOUT + - INACTIVITY_TIMEOUT + - ERROR + docs: >- + Indicates the current state of the chat. There are six possible statuses: + + - `ACTIVE`: The chat is currently active and ongoing. - Version numbers are integer values representing different iterations - of the Config. Each update to the Config increments its version - number. - source: - openapi: stenographer-openapi.json - ReturnPagedChatsPaginationDirection: - enum: - - ASC - - DESC + + - `USER_ENDED`: The chat was manually ended by the user. + + + - `USER_TIMEOUT`: The chat ended due to a user-defined timeout. + + + - `MAX_DURATION_TIMEOUT`: The chat ended because it reached the maximum + allowed duration. + + + - `INACTIVITY_TIMEOUT`: The chat ended due to an inactivity timeout. + + + - `ERROR`: The chat ended unexpectedly due to an error. + source: + openapi: stenographer-openapi.json + ReturnChat: + docs: A description of chat and its status + properties: + id: + type: string + docs: Identifier for a Chat. Formatted as a UUID. + chat_group_id: + type: string + docs: >- + Identifier for the Chat Group. Any chat resumed from this Chat will + have the same `chat_group_id`. Formatted as a UUID. + status: + type: ReturnChatStatus + docs: >- + Indicates the current state of the chat. There are six possible + statuses: + + + - `ACTIVE`: The chat is currently active and ongoing. + + + - `USER_ENDED`: The chat was manually ended by the user. + + + - `USER_TIMEOUT`: The chat ended due to a user-defined timeout. + + + - `MAX_DURATION_TIMEOUT`: The chat ended because it reached the + maximum allowed duration. + + + - `INACTIVITY_TIMEOUT`: The chat ended due to an inactivity timeout. + + + - `ERROR`: The chat ended unexpectedly due to an error. + start_timestamp: + type: long + docs: >- + Time at which the Chat started. Measured in seconds since the Unix + epoch. + end_timestamp: + type: optional + docs: >- + Time at which the Chat ended. Measured in seconds since the Unix + epoch. + event_count: + type: optional + docs: The total number of events currently in this chat. + metadata: + type: optional + docs: Stringified JSON with additional metadata about the chat. + config: optional + source: + openapi: stenographer-openapi.json + ReturnConfigSpec: + docs: The Config associated with this Chat. + properties: + id: + type: string + docs: Identifier for a Config. Formatted as a UUID. + version: + type: optional + docs: >- + 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. + source: + openapi: stenographer-openapi.json + ReturnPagedChatsPaginationDirection: + enum: + - ASC + - DESC + docs: >- + Indicates the order in which the paginated results are presented, based on + their creation date. + + + It shows `ASC` for ascending order (chronological, with the oldest records + first) or `DESC` for descending order (reverse-chronological, with the + newest records first). This value corresponds to the `ascending_order` + query parameter used in the request. + source: + openapi: stenographer-openapi.json + ReturnPagedChats: + docs: A paginated list of chats returned from the server + properties: + page_number: + type: integer docs: >- - Indicates the order in which the paginated results are presented, based on - their creation date. + The page number of the returned list. - It shows `ASC` for ascending order (chronological, with the oldest records - first) or `DESC` for descending order (reverse-chronological, with the - newest records first). This value corresponds to the `ascending_order` - query parameter used in the request. - source: - openapi: stenographer-openapi.json - ReturnPagedChats: - docs: A paginated list of chats returned from the server - properties: - page_number: - type: integer - docs: >- - The page number of the returned list. - - - This value corresponds to the `page_number` parameter specified in the - request. Pagination uses zero-based indexing. - page_size: - type: integer - docs: >- - The maximum number of items returned per page. - - - This value corresponds to the `page_size` parameter specified in the - request. - total_pages: - type: integer - docs: The total number of pages in the collection. - pagination_direction: - type: ReturnPagedChatsPaginationDirection - docs: >- - Indicates the order in which the paginated results are presented, - based on their creation date. + This value corresponds to the `page_number` parameter specified in the + request. Pagination uses zero-based indexing. + page_size: + type: integer + docs: >- + The maximum number of items returned per page. + + + This value corresponds to the `page_size` parameter specified in the + request. + total_pages: + type: integer + docs: The total number of pages in the collection. + pagination_direction: + type: ReturnPagedChatsPaginationDirection + docs: >- + Indicates the order in which the paginated results are presented, + based on their creation date. - It shows `ASC` for ascending order (chronological, with the oldest - records first) or `DESC` for descending order (reverse-chronological, - with the newest records first). This value corresponds to the - `ascending_order` query parameter used in the request. - chats_page: - docs: >- - List of Chats and their metadata returned for the specified - `page_number` and `page_size`. - type: list - source: - openapi: stenographer-openapi.json - ReturnChatEventRole: - enum: - - USER - - AGENT - - SYSTEM - - TOOL + It shows `ASC` for ascending order (chronological, with the oldest + records first) or `DESC` for descending order (reverse-chronological, + with the newest records first). This value corresponds to the + `ascending_order` query parameter used in the request. + chats_page: docs: >- - The role of the entity which generated the Chat Event. There are four - possible values: + List of Chats and their metadata returned for the specified + `page_number` and `page_size`. + type: list + source: + openapi: stenographer-openapi.json + ReturnChatEventRole: + enum: + - USER + - AGENT + - SYSTEM + - TOOL + docs: >- + The role of the entity which generated the Chat Event. There are four + possible values: + + + - `USER`: The user, capable of sending user messages and interruptions. + + + - `AGENT`: The assistant, capable of sending agent messages. + + + - `SYSTEM`: The backend server, capable of transmitting errors. + + + - `TOOL`: The function calling mechanism. + source: + openapi: stenographer-openapi.json + ReturnChatEventType: + enum: + - SYSTEM_PROMPT + - USER_MESSAGE + - USER_INTERRUPTION + - AGENT_MESSAGE + - FUNCTION_CALL + - FUNCTION_CALL_RESPONSE + docs: >- + Type of Chat Event. There are six possible values: + + - `SYSTEM_PROMPT`: Contains the system prompt for use in the session. - - `USER`: The user, capable of sending user messages and interruptions. + - `USER_MESSAGE`: Contains the message sent by the user. - - `AGENT`: The assistant, capable of sending agent messages. + - `USER_INTERRUPTION`: Contains an interruption made by the user while the + agent is speaking. - - `SYSTEM`: The backend server, capable of transmitting errors. + - `AGENT_MESSAGE`: Contains the assistant’s message, generated by Hume’s + eLLM and supplemental LLM. - - `TOOL`: The function calling mechanism. - source: - openapi: stenographer-openapi.json - ReturnChatEventType: - enum: - - SYSTEM_PROMPT - - USER_MESSAGE - - USER_INTERRUPTION - - AGENT_MESSAGE - - FUNCTION_CALL - - FUNCTION_CALL_RESPONSE + + - `FUNCTION_CALL`: Contains the invocation of a tool. + + + - `FUNCTION_CALL_RESPONSE`: Contains the tool response. + source: + openapi: stenographer-openapi.json + ReturnChatEvent: + docs: A description of a single event in a chat returned from the server + properties: + id: + type: string + docs: Identifier for a Chat Event. Formatted as a UUID. + chat_id: + type: string + docs: Identifier for the Chat this event occurred in. Formatted as a UUID. + timestamp: + type: long + docs: >- + Time at which the Chat Event occurred. Measured in seconds since the + Unix epoch. + role: + type: ReturnChatEventRole docs: >- - Type of Chat Event. There are six possible values: + The role of the entity which generated the Chat Event. There are four + possible values: - - `SYSTEM_PROMPT`: Contains the system prompt for use in the session. + - `USER`: The user, capable of sending user messages and + interruptions. - - `USER_MESSAGE`: Contains the message sent by the user. + - `AGENT`: The assistant, capable of sending agent messages. - - `USER_INTERRUPTION`: Contains an interruption made by the user while the - agent is speaking. + - `SYSTEM`: The backend server, capable of transmitting errors. - - `AGENT_MESSAGE`: Contains the assistant’s message, generated by Hume’s - eLLM and supplemental LLM. + - `TOOL`: The function calling mechanism. + type: + type: ReturnChatEventType + docs: >- + Type of Chat Event. There are six possible values: - - `FUNCTION_CALL`: Contains the invocation of a tool. + - `SYSTEM_PROMPT`: Contains the system prompt for use in the session. - - `FUNCTION_CALL_RESPONSE`: Contains the tool response. - source: - openapi: stenographer-openapi.json - ReturnChatEvent: - docs: A description of a single event in a chat returned from the server - properties: - id: - type: string - docs: Identifier for a Chat Event. Formatted as a UUID. - chat_id: - type: string - docs: Identifier for the Chat this event occurred in. Formatted as a UUID. - timestamp: - type: long - docs: >- - Time at which the Chat Event occurred. Measured in seconds since the - Unix epoch. - role: - type: ReturnChatEventRole - docs: >- - The role of the entity which generated the Chat Event. There are four - possible values: + - `USER_MESSAGE`: Contains the message sent by the user. - - `USER`: The user, capable of sending user messages and - interruptions. + - `USER_INTERRUPTION`: Contains an interruption made by the user while + the agent is speaking. - - `AGENT`: The assistant, capable of sending agent messages. + - `AGENT_MESSAGE`: Contains the assistant’s message, generated by + Hume’s eLLM and supplemental LLM. - - `SYSTEM`: The backend server, capable of transmitting errors. + - `FUNCTION_CALL`: Contains the invocation of a tool. - - `TOOL`: The function calling mechanism. - type: - type: ReturnChatEventType - docs: >- - Type of Chat Event. There are six possible values: + - `FUNCTION_CALL_RESPONSE`: Contains the tool response. + message_text: + type: optional + docs: >- + The text of the Chat Event. This field contains the message content + for each event type listed in the `type` field. + emotion_features: + type: optional + docs: >- + Stringified JSON containing the prosody model inference results. + + + EVI uses the prosody model to measure 48 expressions related to speech + and vocal characteristics. These results contain a detailed emotional + and tonal analysis of the audio. Scores typically range from 0 to 1, + with higher values indicating a stronger confidence level in the + measured attribute. + metadata: + type: optional + docs: Stringified JSON with additional metadata about the chat event. + source: + openapi: stenographer-openapi.json + ReturnChatPagedEventsStatus: + enum: + - ACTIVE + - USER_ENDED + - USER_TIMEOUT + - MAX_DURATION_TIMEOUT + - INACTIVITY_TIMEOUT + - ERROR + docs: >- + Indicates the current state of the chat. There are six possible statuses: + + + - `ACTIVE`: The chat is currently active and ongoing. + + + - `USER_ENDED`: The chat was manually ended by the user. + + + - `USER_TIMEOUT`: The chat ended due to a user-defined timeout. + + + - `MAX_DURATION_TIMEOUT`: The chat ended because it reached the maximum + allowed duration. + + + - `INACTIVITY_TIMEOUT`: The chat ended due to an inactivity timeout. + + + - `ERROR`: The chat ended unexpectedly due to an error. + source: + openapi: stenographer-openapi.json + ReturnChatPagedEventsPaginationDirection: + enum: + - ASC + - DESC + docs: >- + Indicates the order in which the paginated results are presented, based on + their creation date. + + + It shows `ASC` for ascending order (chronological, with the oldest records + first) or `DESC` for descending order (reverse-chronological, with the + newest records first). This value corresponds to the `ascending_order` + query parameter used in the request. + source: + openapi: stenographer-openapi.json + ReturnChatPagedEvents: + docs: >- + A description of chat status with a paginated list of chat events returned + from the server + properties: + id: + type: string + docs: Identifier for a Chat. Formatted as a UUID. + chat_group_id: + type: string + docs: >- + Identifier for the Chat Group. Any chat resumed from this Chat will + have the same `chat_group_id`. Formatted as a UUID. + status: + type: ReturnChatPagedEventsStatus + docs: >- + Indicates the current state of the chat. There are six possible + statuses: - - `SYSTEM_PROMPT`: Contains the system prompt for use in the session. + - `ACTIVE`: The chat is currently active and ongoing. - - `USER_MESSAGE`: Contains the message sent by the user. + - `USER_ENDED`: The chat was manually ended by the user. - - `USER_INTERRUPTION`: Contains an interruption made by the user while - the agent is speaking. + - `USER_TIMEOUT`: The chat ended due to a user-defined timeout. - - `AGENT_MESSAGE`: Contains the assistant’s message, generated by - Hume’s eLLM and supplemental LLM. + - `MAX_DURATION_TIMEOUT`: The chat ended because it reached the + maximum allowed duration. - - `FUNCTION_CALL`: Contains the invocation of a tool. + - `INACTIVITY_TIMEOUT`: The chat ended due to an inactivity timeout. - - `FUNCTION_CALL_RESPONSE`: Contains the tool response. - message_text: - type: optional - docs: >- - The text of the Chat Event. This field contains the message content - for each event type listed in the `type` field. - emotion_features: - type: optional - docs: >- - Stringified JSON containing the prosody model inference results. + - `ERROR`: The chat ended unexpectedly due to an error. + start_timestamp: + type: long + docs: >- + Time at which the Chat started. Measured in seconds since the Unix + epoch. + end_timestamp: + type: optional + docs: >- + Time at which the Chat ended. Measured in seconds since the Unix + epoch. + pagination_direction: + type: ReturnChatPagedEventsPaginationDirection + docs: >- + Indicates the order in which the paginated results are presented, + based on their creation date. + + + It shows `ASC` for ascending order (chronological, with the oldest + records first) or `DESC` for descending order (reverse-chronological, + with the newest records first). This value corresponds to the + `ascending_order` query parameter used in the request. + events_page: + docs: List of Chat Events for the specified `page_number` and `page_size`. + type: list + metadata: + type: optional + docs: Stringified JSON with additional metadata about the chat. + page_number: + type: integer + docs: >- + The page number of the returned list. - EVI uses the prosody model to measure 48 expressions related to speech - and vocal characteristics. These results contain a detailed emotional - and tonal analysis of the audio. Scores typically range from 0 to 1, - with higher values indicating a stronger confidence level in the - measured attribute. - metadata: - type: optional - docs: Stringified JSON with additional metadata about the chat event. - source: - openapi: stenographer-openapi.json - ReturnChatPagedEventsStatus: - enum: - - ACTIVE - - USER_ENDED - - USER_TIMEOUT - - MAX_DURATION_TIMEOUT - - INACTIVITY_TIMEOUT - - ERROR + This value corresponds to the `page_number` parameter specified in the + request. Pagination uses zero-based indexing. + page_size: + type: integer docs: >- - Indicates the current state of the chat. There are six possible statuses: + The maximum number of items returned per page. + + + This value corresponds to the `page_size` parameter specified in the + request. + total_pages: + type: integer + docs: The total number of pages in the collection. + config: optional + source: + openapi: stenographer-openapi.json + ReturnActiveChatCount: + docs: A description of current chat chat sessions for a user + properties: + timestamp: + type: long + docs: >- + The timestamp for when chat status was measured. Formatted as a Unix + epoch milliseconds. + total_user_active_chats: + type: integer + docs: The total number of active chats for this user. + max_allowed_active_chats: + type: optional + docs: The maximum number of concurrent active chats for this user. + more_active_chats_allowed: + type: boolean + docs: Boolean indicating if the user is allowed to start more chats. + per_tag: + type: optional>> + docs: Optional List of chat counts per tag. + source: + openapi: stenographer-openapi.json + ReturnActiveChatCountPerTag: + docs: A description of current chat chat sessions per tag + properties: + tag: + type: string + docs: User tag applied to a chat. + total_tag_active_chats: + type: integer + docs: The total number of active chats for this user with the specified tag. + source: + openapi: stenographer-openapi.json + ReturnChatGroup: + docs: A description of chat_group and its status + properties: + id: + type: string + docs: >- + Identifier for the Chat Group. Any Chat resumed from this Chat Group + will have the same `chat_group_id`. Formatted as a UUID. + first_start_timestamp: + type: long + docs: >- + Time at which the first Chat in this Chat Group was created. Measured + in seconds since the Unix epoch. + most_recent_start_timestamp: + type: long + docs: >- + Time at which the most recent Chat in this Chat Group was created. + Measured in seconds since the Unix epoch. + most_recent_chat_id: + type: optional + docs: >- + The `chat_id` of the most recent Chat in this Chat Group. Formatted as + a UUID. + num_chats: + type: integer + docs: The total number of Chats in this Chat Group. + active: + type: optional + docs: >- + Denotes whether there is an active Chat associated with this Chat + Group. + source: + openapi: stenographer-openapi.json + ReturnPagedChatGroupsPaginationDirection: + enum: + - ASC + - DESC + docs: >- + Indicates the order in which the paginated results are presented, based on + their creation date. + + + It shows `ASC` for ascending order (chronological, with the oldest records + first) or `DESC` for descending order (reverse-chronological, with the + newest records first). This value corresponds to the `ascending_order` + query parameter used in the request. + source: + openapi: stenographer-openapi.json + ReturnPagedChatGroups: + docs: A paginated list of chat_groups returned from the server + properties: + page_number: + type: integer + docs: >- + The page number of the returned list. - - `ACTIVE`: The chat is currently active and ongoing. + This value corresponds to the `page_number` parameter specified in the + request. Pagination uses zero-based indexing. + page_size: + type: integer + docs: >- + The maximum number of items returned per page. - - `USER_ENDED`: The chat was manually ended by the user. + This value corresponds to the `page_size` parameter specified in the + request. + total_pages: + type: integer + docs: The total number of pages in the collection. + pagination_direction: + type: ReturnPagedChatGroupsPaginationDirection + docs: >- + Indicates the order in which the paginated results are presented, + based on their creation date. - - `USER_TIMEOUT`: The chat ended due to a user-defined timeout. + It shows `ASC` for ascending order (chronological, with the oldest + records first) or `DESC` for descending order (reverse-chronological, + with the newest records first). This value corresponds to the + `ascending_order` query parameter used in the request. + chat_groups_page: + docs: >- + List of Chat Groups and their metadata returned for the specified + `page_number` and `page_size`. + type: list + source: + openapi: stenographer-openapi.json + ReturnChatGroupPagedChatsPaginationDirection: + enum: + - ASC + - DESC + docs: >- + Indicates the order in which the paginated results are presented, based on + their creation date. + + + It shows `ASC` for ascending order (chronological, with the oldest records + first) or `DESC` for descending order (reverse-chronological, with the + newest records first). This value corresponds to the `ascending_order` + query parameter used in the request. + source: + openapi: stenographer-openapi.json + ReturnChatGroupPagedChats: + docs: >- + A description of chat_group and its status with a paginated list of each + chat in the chat_group + properties: + id: + type: string + docs: >- + Identifier for the Chat Group. Any Chat resumed from this Chat Group + will have the same `chat_group_id`. Formatted as a UUID. + first_start_timestamp: + type: long + docs: >- + Time at which the first Chat in this Chat Group was created. Measured + in seconds since the Unix epoch. + most_recent_start_timestamp: + type: long + docs: >- + Time at which the most recent Chat in this Chat Group was created. + Measured in seconds since the Unix epoch. + num_chats: + type: integer + docs: The total number of Chats associated with this Chat Group. + page_number: + type: integer + docs: >- + The page number of the returned list. - - `MAX_DURATION_TIMEOUT`: The chat ended because it reached the maximum - allowed duration. + This value corresponds to the `page_number` parameter specified in the + request. Pagination uses zero-based indexing. + page_size: + type: integer + docs: >- + The maximum number of items returned per page. - - `INACTIVITY_TIMEOUT`: The chat ended due to an inactivity timeout. + This value corresponds to the `page_size` parameter specified in the + request. + total_pages: + type: integer + docs: The total number of pages in the collection. + pagination_direction: + type: ReturnChatGroupPagedChatsPaginationDirection + docs: >- + Indicates the order in which the paginated results are presented, + based on their creation date. + + + It shows `ASC` for ascending order (chronological, with the oldest + records first) or `DESC` for descending order (reverse-chronological, + with the newest records first). This value corresponds to the + `ascending_order` query parameter used in the request. + chats_page: + docs: List of Chats for the specified `page_number` and `page_size`. + type: list + active: + type: optional + docs: >- + Denotes whether there is an active Chat associated with this Chat + Group. + source: + openapi: stenographer-openapi.json + ReturnChatGroupPagedEventsPaginationDirection: + enum: + - ASC + - DESC + docs: >- + Indicates the order in which the paginated results are presented, based on + their creation date. + + + It shows `ASC` for ascending order (chronological, with the oldest records + first) or `DESC` for descending order (reverse-chronological, with the + newest records first). This value corresponds to the `ascending_order` + query parameter used in the request. + source: + openapi: stenographer-openapi.json + ReturnChatGroupPagedEvents: + docs: >- + A paginated list of chat events that occurred across chats in this + chat_group from the server + properties: + id: + type: string + docs: >- + Identifier for the Chat Group. Any Chat resumed from this Chat Group + will have the same `chat_group_id`. Formatted as a UUID. + page_number: + type: integer + docs: >- + The page number of the returned list. - - `ERROR`: The chat ended unexpectedly due to an error. - source: - openapi: stenographer-openapi.json - ReturnChatPagedEventsPaginationDirection: - enum: - - ASC - - DESC + This value corresponds to the `page_number` parameter specified in the + request. Pagination uses zero-based indexing. + page_size: + type: integer docs: >- - Indicates the order in which the paginated results are presented, based on - their creation date. + The maximum number of items returned per page. - It shows `ASC` for ascending order (chronological, with the oldest records - first) or `DESC` for descending order (reverse-chronological, with the - newest records first). This value corresponds to the `ascending_order` - query parameter used in the request. - source: - openapi: stenographer-openapi.json - ReturnChatPagedEvents: + This value corresponds to the `page_size` parameter specified in the + request. + total_pages: + type: integer + docs: The total number of pages in the collection. + pagination_direction: + type: ReturnChatGroupPagedEventsPaginationDirection + docs: >- + Indicates the order in which the paginated results are presented, + based on their creation date. + + + It shows `ASC` for ascending order (chronological, with the oldest + records first) or `DESC` for descending order (reverse-chronological, + with the newest records first). This value corresponds to the + `ascending_order` query parameter used in the request. + events_page: + docs: List of Chat Events for the specified `page_number` and `page_size`. + type: list + source: + openapi: stenographer-openapi.json + PostedPromptSpec: + docs: A Prompt associated with this Config. + properties: + version: optional + source: + openapi: stenographer-openapi.json + AssistantInput: + docs: When provided, the input is spoken by EVI. + properties: + type: + type: literal<"assistant_input"> docs: >- - A description of chat status with a paginated list of chat events returned - from the server - properties: - id: - type: string - docs: Identifier for a Chat. Formatted as a UUID. - chat_group_id: - type: string - docs: >- - Identifier for the Chat Group. Any chat resumed from this Chat will - have the same `chat_group_id`. Formatted as a UUID. - status: - type: ReturnChatPagedEventsStatus - docs: >- - Indicates the current state of the chat. There are six possible - statuses: - - - - `ACTIVE`: The chat is currently active and ongoing. - - - - `USER_ENDED`: The chat was manually ended by the user. - - - - `USER_TIMEOUT`: The chat ended due to a user-defined timeout. - - - - `MAX_DURATION_TIMEOUT`: The chat ended because it reached the - maximum allowed duration. - - - - `INACTIVITY_TIMEOUT`: The chat ended due to an inactivity timeout. - - - - `ERROR`: The chat ended unexpectedly due to an error. - start_timestamp: - type: long - docs: >- - Time at which the Chat started. Measured in seconds since the Unix - epoch. - end_timestamp: - type: optional - docs: >- - Time at which the Chat ended. Measured in seconds since the Unix - epoch. - pagination_direction: - type: ReturnChatPagedEventsPaginationDirection - docs: >- - Indicates the order in which the paginated results are presented, - based on their creation date. - - - It shows `ASC` for ascending order (chronological, with the oldest - records first) or `DESC` for descending order (reverse-chronological, - with the newest records first). This value corresponds to the - `ascending_order` query parameter used in the request. - events_page: - docs: List of Chat Events for the specified `page_number` and `page_size`. - type: list - metadata: - type: optional - docs: Stringified JSON with additional metadata about the chat. - page_number: - type: integer - docs: >- - The page number of the returned list. - - - This value corresponds to the `page_number` parameter specified in the - request. Pagination uses zero-based indexing. - page_size: - type: integer - docs: >- - The maximum number of items returned per page. - - - This value corresponds to the `page_size` parameter specified in the - request. - total_pages: - type: integer - docs: The total number of pages in the collection. - config: optional - source: - openapi: stenographer-openapi.json - ReturnActiveChatCount: - docs: A description of current chat chat sessions for a user - properties: - timestamp: - type: long - docs: >- - The timestamp for when chat status was measured. Formatted as a Unix - epoch milliseconds. - total_user_active_chats: - type: integer - docs: The total number of active chats for this user. - max_allowed_active_chats: - type: optional - docs: The maximum number of concurrent active chats for this user. - more_active_chats_allowed: - type: boolean - docs: Boolean indicating if the user is allowed to start more chats. - per_tag: - type: optional>> - docs: Optional List of chat counts per tag. - source: - openapi: stenographer-openapi.json - ReturnActiveChatCountPerTag: - docs: A description of current chat chat sessions per tag - properties: - tag: - type: string - docs: User tag applied to a chat. - total_tag_active_chats: - type: integer - docs: The total number of active chats for this user with the specified tag. - source: - openapi: stenographer-openapi.json - ReturnChatGroup: - docs: A description of chat_group and its status - properties: - id: - type: string - docs: >- - Identifier for the Chat Group. Any Chat resumed from this Chat Group - will have the same `chat_group_id`. Formatted as a UUID. - first_start_timestamp: - type: long - docs: >- - Time at which the first Chat in this Chat Group was created. Measured - in seconds since the Unix epoch. - most_recent_start_timestamp: - type: long - docs: >- - Time at which the most recent Chat in this Chat Group was created. - Measured in seconds since the Unix epoch. - most_recent_chat_id: - type: optional - docs: >- - The `chat_id` of the most recent Chat in this Chat Group. Formatted as - a UUID. - num_chats: - type: integer - docs: The total number of Chats in this Chat Group. - active: - type: optional - docs: >- - Denotes whether there is an active Chat associated with this Chat - Group. - source: - openapi: stenographer-openapi.json - ReturnPagedChatGroupsPaginationDirection: - enum: - - ASC - - DESC - docs: >- - Indicates the order in which the paginated results are presented, based on - their creation date. - - - It shows `ASC` for ascending order (chronological, with the oldest records - first) or `DESC` for descending order (reverse-chronological, with the - newest records first). This value corresponds to the `ascending_order` - query parameter used in the request. - source: - openapi: stenographer-openapi.json - ReturnPagedChatGroups: - docs: A paginated list of chat_groups returned from the server - properties: - page_number: - type: integer - docs: >- - The page number of the returned list. - - - This value corresponds to the `page_number` parameter specified in the - request. Pagination uses zero-based indexing. - page_size: - type: integer - docs: >- - The maximum number of items returned per page. - - - This value corresponds to the `page_size` parameter specified in the - request. - total_pages: - type: integer - docs: The total number of pages in the collection. - pagination_direction: - type: ReturnPagedChatGroupsPaginationDirection - docs: >- - Indicates the order in which the paginated results are presented, - based on their creation date. - - - It shows `ASC` for ascending order (chronological, with the oldest - records first) or `DESC` for descending order (reverse-chronological, - with the newest records first). This value corresponds to the - `ascending_order` query parameter used in the request. - chat_groups_page: - docs: >- - List of Chat Groups and their metadata returned for the specified - `page_number` and `page_size`. - type: list - source: - openapi: stenographer-openapi.json - ReturnChatGroupPagedChatsPaginationDirection: - enum: - - ASC - - DESC - docs: >- - Indicates the order in which the paginated results are presented, based on - their creation date. - - - It shows `ASC` for ascending order (chronological, with the oldest records - first) or `DESC` for descending order (reverse-chronological, with the - newest records first). This value corresponds to the `ascending_order` - query parameter used in the request. - source: - openapi: stenographer-openapi.json - ReturnChatGroupPagedChats: - docs: >- - A description of chat_group and its status with a paginated list of each - chat in the chat_group - properties: - id: - type: string - docs: >- - Identifier for the Chat Group. Any Chat resumed from this Chat Group - will have the same `chat_group_id`. Formatted as a UUID. - first_start_timestamp: - type: long - docs: >- - Time at which the first Chat in this Chat Group was created. Measured - in seconds since the Unix epoch. - most_recent_start_timestamp: - type: long - docs: >- - Time at which the most recent Chat in this Chat Group was created. - Measured in seconds since the Unix epoch. - num_chats: - type: integer - docs: The total number of Chats associated with this Chat Group. - page_number: - type: integer - docs: >- - The page number of the returned list. - - - This value corresponds to the `page_number` parameter specified in the - request. Pagination uses zero-based indexing. - page_size: - type: integer - docs: >- - The maximum number of items returned per page. - - - This value corresponds to the `page_size` parameter specified in the - request. - total_pages: - type: integer - docs: The total number of pages in the collection. - pagination_direction: - type: ReturnChatGroupPagedChatsPaginationDirection - docs: >- - Indicates the order in which the paginated results are presented, - based on their creation date. - - - It shows `ASC` for ascending order (chronological, with the oldest - records first) or `DESC` for descending order (reverse-chronological, - with the newest records first). This value corresponds to the - `ascending_order` query parameter used in the request. - chats_page: - docs: List of Chats for the specified `page_number` and `page_size`. - type: list - active: - type: optional - docs: >- - Denotes whether there is an active Chat associated with this Chat - Group. - source: - openapi: stenographer-openapi.json - ReturnChatGroupPagedEventsPaginationDirection: - enum: - - ASC - - DESC - docs: >- - Indicates the order in which the paginated results are presented, based on - their creation date. - - - It shows `ASC` for ascending order (chronological, with the oldest records - first) or `DESC` for descending order (reverse-chronological, with the - newest records first). This value corresponds to the `ascending_order` - query parameter used in the request. - source: - openapi: stenographer-openapi.json - ReturnChatGroupPagedEvents: - docs: >- - A paginated list of chat events that occurred across chats in this - chat_group from the server - properties: - id: - type: string - docs: >- - Identifier for the Chat Group. Any Chat resumed from this Chat Group - will have the same `chat_group_id`. Formatted as a UUID. - page_number: - type: integer - docs: >- - The page number of the returned list. - - - This value corresponds to the `page_number` parameter specified in the - request. Pagination uses zero-based indexing. - page_size: - type: integer - docs: >- - The maximum number of items returned per page. - - - This value corresponds to the `page_size` parameter specified in the - request. - total_pages: - type: integer - docs: The total number of pages in the collection. - pagination_direction: - type: ReturnChatGroupPagedEventsPaginationDirection - docs: >- - Indicates the order in which the paginated results are presented, - based on their creation date. - - - It shows `ASC` for ascending order (chronological, with the oldest - records first) or `DESC` for descending order (reverse-chronological, - with the newest records first). This value corresponds to the - `ascending_order` query parameter used in the request. - events_page: - docs: List of Chat Events for the specified `page_number` and `page_size`. - type: list - source: - openapi: stenographer-openapi.json - PostedPromptSpec: - docs: A Prompt associated with this Config. - properties: - version: optional - source: - openapi: stenographer-openapi.json - AssistantInput: - docs: When provided, the input is spoken by EVI. - properties: - type: - type: literal<"assistant_input"> - docs: >- - The type of message sent through the socket; must be `assistant_input` - for our server to correctly identify and process it as an Assistant - Input message. - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - text: - type: string - docs: >- - Assistant text to synthesize into spoken audio and insert into the - conversation. - - - EVI uses this text to generate spoken audio using our proprietary - expressive text-to-speech model. Our model adds appropriate emotional - inflections and tones to the text based on the user’s expressions and - the context of the conversation. The synthesized audio is streamed - back to the user as an [Assistant - Message](/reference/empathic-voice-interface-evi/chat/chat#receive.Assistant%20Message.type). - source: - openapi: assistant-asyncapi.json - AudioConfiguration: - properties: - encoding: - type: Encoding - docs: Encoding format of the audio input, such as `linear16`. - channels: - type: integer - docs: Number of audio channels. - sample_rate: - type: integer - docs: >- - Audio sample rate. Number of samples per second in the audio input, - measured in Hertz. - source: - openapi: assistant-asyncapi.json - AudioInput: - docs: When provided, the input is audio. - properties: - type: - type: literal<"audio_input"> - docs: >- - The type of message sent through the socket; must be `audio_input` for - our server to correctly identify and process it as an Audio Input - message. - - - This message is used for sending audio input data to EVI for - processing and expression measurement. Audio data should be sent as a - continuous stream, encoded in Base64. - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - data: - type: string - docs: >- - Base64 encoded audio input to insert into the conversation. - - - The content of an Audio Input message is treated as the user’s speech - to EVI and must be streamed continuously. Pre-recorded audio files are - not supported. - - - For optimal transcription quality, the audio data should be - transmitted in small chunks. - - - Hume recommends streaming audio with a buffer window of 20 - milliseconds (ms), or 100 milliseconds (ms) for web applications. - source: - openapi: assistant-asyncapi.json - BuiltInTool: - enum: - - web_search - - hang_up - docs: >- - Name of the built-in tool. Set to `web_search` to equip EVI with the - built-in Web Search tool. - source: - openapi: assistant-asyncapi.json - BuiltinToolConfig: - properties: - name: - type: BuiltInTool - fallback_content: - type: optional - docs: >- - Optional text passed to the supplemental LLM if the tool call fails. - The LLM then uses this text to generate a response back to the user, - ensuring continuity in the conversation. - source: - openapi: assistant-asyncapi.json - Context: - properties: - type: - type: optional - docs: >- - The persistence level of the injected context. Specifies how long the - injected context will remain active in the session. - - - There are three possible context types: - - - - **Persistent**: The context is appended to all user messages for the - duration of the session. - - - - **Temporary**: The context is appended only to the next user - message. - - - **Editable**: The original context is updated to reflect the new context. - - If the type is not specified, it will default to `temporary`. - text: - type: string - docs: >- - The context to be injected into the conversation. Helps inform the - LLM's response by providing relevant information about the ongoing - conversation. - - - This text will be appended to the end of user messages based on the - chosen persistence level. For example, if you want to remind EVI of - its role as a helpful weather assistant, the context you insert will - be appended to the end of user messages as `{Context: You are a - helpful weather assistant}`. - source: - openapi: assistant-asyncapi.json - ContextType: - enum: - - editable - - persistent - - temporary - source: - openapi: assistant-asyncapi.json - Encoding: - type: literal<"linear16"> - ErrorLevel: - type: literal<"warn"> - PauseAssistantMessage: - docs: >- - Pause responses from EVI. Chat history is still saved and sent after - resuming. - properties: - type: - type: literal<"pause_assistant_message"> - docs: >- - The type of message sent through the socket; must be - `pause_assistant_message` for our server to correctly identify and - process it as a Pause Assistant message. - - - Once this message is sent, EVI will not respond until a [Resume - Assistant - message](/reference/empathic-voice-interface-evi/chat/chat#send.Resume%20Assistant%20Message.type) - is sent. When paused, EVI won’t respond, but transcriptions of your - audio inputs will still be recorded. - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - source: - openapi: assistant-asyncapi.json - ResumeAssistantMessage: - docs: >- - Resume responses from EVI. Chat history sent while paused will now be - sent. - properties: - type: - type: literal<"resume_assistant_message"> - docs: >- - The type of message sent through the socket; must be - `resume_assistant_message` for our server to correctly identify and - process it as a Resume Assistant message. - - - Upon resuming, if any audio input was sent during the pause, EVI will - retain context from all messages sent but only respond to the last - user message. (e.g., If you ask EVI two questions while paused and - then send a `resume_assistant_message`, EVI will respond to the second - question and have added the first question to its conversation - context.) - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - source: - openapi: assistant-asyncapi.json - SessionSettings: - docs: Settings for this chat session. - properties: - type: - type: literal<"session_settings"> - docs: >- - The type of message sent through the socket; must be - `session_settings` for our server to correctly identify and process it - as a Session Settings message. - - - Session settings are temporary and apply only to the current Chat - session. These settings can be adjusted dynamically based on the - requirements of each session to ensure optimal performance and user - experience. - - - For more information, please refer to the [Session Settings - section](/docs/empathic-voice-interface-evi/configuration#session-settings) - on the EVI Configuration page. - custom_session_id: - type: optional - docs: >- - Unique identifier for the session. Used to manage conversational - state, correlate frontend and backend data, and persist conversations - across EVI sessions. - - - If included, the response sent from Hume to your backend will include - this ID. This allows you to correlate frontend users with their - incoming messages. - - - It is recommended to pass a `custom_session_id` if you are using a - Custom Language Model. Please see our guide to [using a custom - language - model](/docs/empathic-voice-interface-evi/custom-language-model) with - EVI to learn more. - system_prompt: - type: optional - docs: >- - Instructions used to shape EVI’s behavior, responses, and style for - the session. - - - When included in a Session Settings message, the provided Prompt - overrides the existing one specified in the EVI configuration. If no - Prompt was defined in the configuration, this Prompt will be the one - used for the session. - - - You can use the Prompt to define a specific goal or role for EVI, - specifying how it should act or what it should focus on during the - conversation. For example, EVI can be instructed to act as a customer - support representative, a fitness coach, or a travel advisor, each - with its own set of behaviors and response styles. - - - For help writing a system prompt, see our [Prompting - Guide](/docs/empathic-voice-interface-evi/prompting). - context: - type: optional - docs: >- - Allows developers to inject additional context into the conversation, - which is appended to the end of user messages for the session. - - - When included in a Session Settings message, the provided context can - be used to remind the LLM of its role in every user message, prevent - it from forgetting important details, or add new relevant information - to the conversation. - - - Set to `null` to disable context injection. - audio: - type: optional - docs: >- - Configuration details for the audio input used during the session. - Ensures the audio is being correctly set up for processing. - - - This optional field is only required when the audio input is encoded - in PCM Linear 16 (16-bit, little-endian, signed PCM WAV data). For - detailed instructions on how to configure session settings for PCM - Linear 16 audio, please refer to the [Session Settings - section](/docs/empathic-voice-interface-evi/configuration#session-settings) - on the EVI Configuration page. - language_model_api_key: - type: optional - docs: >- - Third party API key for the supplemental language model. - - - When provided, EVI will use this key instead of Hume’s API key for the - supplemental LLM. This allows you to bypass rate limits and utilize - your own API key as needed. - tools: - type: optional> - docs: >- - List of user-defined tools to enable for the session. - - - Tools are resources used by EVI to perform various tasks, such as - searching the web or calling external APIs. Built-in tools, like web - search, are natively integrated, while user-defined tools are created - and invoked by the user. To learn more, see our [Tool Use - Guide](/docs/empathic-voice-interface-evi/tool-use). - builtin_tools: - type: optional> - docs: >- - List of built-in tools to enable for the session. - - - Tools are resources used by EVI to perform various tasks, such as - searching the web or calling external APIs. Built-in tools, like web - search, are natively integrated, while user-defined tools are created - and invoked by the user. To learn more, see our [Tool Use - Guide](/docs/empathic-voice-interface-evi/tool-use). - - - Currently, the only built-in tool Hume provides is **Web Search**. - When enabled, Web Search equips EVI with the ability to search the web - for up-to-date information. - metadata: - type: optional> - variables: - type: optional> - docs: Dynamic values that can be used to populate EVI prompts. - source: - openapi: assistant-asyncapi.json - Tool: - properties: - type: - type: ToolType - docs: Type of tool. Set to `function` for user-defined tools. - name: - type: string - docs: Name of the user-defined tool to be enabled. - parameters: - type: string - docs: >- - Parameters of the tool. Is a stringified JSON schema. - - - These parameters define the inputs needed for the tool’s execution, - including the expected data type and description for each input field. - Structured as a JSON schema, this format ensures the tool receives - data in the expected format. - description: - type: optional - docs: >- - An optional description of what the tool does, used by the - supplemental LLM to choose when and how to call the function. - fallback_content: - type: optional - docs: >- - Optional text passed to the supplemental LLM if the tool call fails. - The LLM then uses this text to generate a response back to the user, - ensuring continuity in the conversation. - source: - openapi: assistant-asyncapi.json - ToolErrorMessage: - docs: When provided, the output is a function call error. - properties: - type: - type: literal<"tool_error"> - docs: >- - The type of message sent through the socket; for a Tool Error message, - this must be `tool_error`. - - - Upon receiving a [Tool Call - message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type) - and failing to invoke the function, this message is sent to notify EVI - of the tool's failure. - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - tool_type: - type: optional - docs: >- - Type of tool called. Either `builtin` for natively implemented tools, - like web search, or `function` for user-defined tools. - tool_call_id: - type: string - docs: >- - The unique identifier for a specific tool call instance. - - - This ID is used to track the request and response of a particular tool - invocation, ensuring that the Tool Error message is linked to the - appropriate tool call request. The specified `tool_call_id` must match - the one received in the [Tool Call - message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type). - content: - type: optional - docs: >- - Optional text passed to the supplemental LLM in place of the tool call - result. The LLM then uses this text to generate a response back to the - user, ensuring continuity in the conversation if the tool errors. - error: - type: string - docs: Error message from the tool call, not exposed to the LLM or user. - code: - type: optional - docs: Error code. Identifies the type of error encountered. - level: - type: optional - docs: >- - Indicates the severity of an error; for a Tool Error message, this - must be `warn` to signal an unexpected event. - source: - openapi: assistant-asyncapi.json - ToolResponseMessage: - docs: When provided, the output is a function call response. - properties: - type: - type: literal<"tool_response"> - docs: >- - The type of message sent through the socket; for a Tool Response - message, this must be `tool_response`. - - - Upon receiving a [Tool Call - message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type) - and successfully invoking the function, this message is sent to convey - the result of the function call back to EVI. - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - tool_call_id: - type: string - docs: >- - The unique identifier for a specific tool call instance. - - - This ID is used to track the request and response of a particular tool - invocation, ensuring that the correct response is linked to the - appropriate request. The specified `tool_call_id` must match the one - received in the [Tool Call - message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.tool_call_id). - content: - type: string - docs: >- - Return value of the tool call. Contains the output generated by the - tool to pass back to EVI. - tool_name: - type: optional - docs: >- - Name of the tool. - - - Include this optional field to help the supplemental LLM identify - which tool generated the response. The specified `tool_name` must - match the one received in the [Tool Call - message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type). - tool_type: - type: optional - docs: >- - Type of tool called. Either `builtin` for natively implemented tools, - like web search, or `function` for user-defined tools. - source: - openapi: assistant-asyncapi.json - ToolType: - enum: - - builtin - - function - source: - openapi: assistant-asyncapi.json - UserInput: - docs: User text to insert into the conversation. - properties: - type: - type: literal<"user_input"> - docs: >- - The type of message sent through the socket; must be `user_input` for - our server to correctly identify and process it as a User Input - message. - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - text: - type: string - docs: >- - User text to insert into the conversation. Text sent through a User - Input message is treated as the user’s speech to EVI. EVI processes - this input and provides a corresponding response. - - - Expression measurement results are not available for User Input - messages, as the prosody model relies on audio input and cannot - process text alone. - source: - openapi: assistant-asyncapi.json - AssistantEnd: - docs: When provided, the output is an assistant end message. - properties: - type: - type: literal<"assistant_end"> - docs: >- - The type of message sent through the socket; for an Assistant End - message, this must be `assistant_end`. - - - This message indicates the conclusion of the assistant’s response, - signaling that the assistant has finished speaking for the current - conversational turn. - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - source: - openapi: assistant-asyncapi.json - AssistantMessage: - docs: When provided, the output is an assistant message. - properties: - type: - type: literal<"assistant_message"> - docs: >- - The type of message sent through the socket; for an Assistant Message, - this must be `assistant_message`. - - - This message contains both a transcript of the assistant’s response - and the expression measurement predictions of the assistant’s audio - output. - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - id: - type: optional - docs: >- - ID of the assistant message. Allows the Assistant Message to be - tracked and referenced. - message: - type: ChatMessage - docs: Transcript of the message. - models: - type: Inference - docs: Inference model results. - from_text: - type: boolean - docs: >- - Indicates if this message was inserted into the conversation as text - from an [Assistant Input - message](/reference/empathic-voice-interface-evi/chat/chat#send.Assistant%20Input.text). - source: - openapi: assistant-asyncapi.json - AudioOutput: - docs: When provided, the output is audio. - properties: - type: - type: literal<"audio_output"> - docs: >- - The type of message sent through the socket; for an Audio Output - message, this must be `audio_output`. - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - id: - type: string - docs: >- - ID of the audio output. Allows the Audio Output message to be tracked - and referenced. - index: - type: integer - docs: Index of the chunk of audio relative to the whole audio segment. - data: - type: string - docs: >- - Base64 encoded audio output. This encoded audio is transmitted to the - client, where it can be decoded and played back as part of the user - interaction. - source: - openapi: assistant-asyncapi.json - ChatMessageToolResult: - discriminated: false + The type of message sent through the socket; must be `assistant_input` + for our server to correctly identify and process it as an Assistant + Input message. + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + text: + type: string + docs: >- + Assistant text to synthesize into spoken audio and insert into the + conversation. + + + EVI uses this text to generate spoken audio using our proprietary + expressive text-to-speech model. Our model adds appropriate emotional + inflections and tones to the text based on the user’s expressions and + the context of the conversation. The synthesized audio is streamed + back to the user as an [Assistant + Message](/reference/empathic-voice-interface-evi/chat/chat#receive.Assistant%20Message.type). + source: + openapi: assistant-asyncapi.json + AudioConfiguration: + properties: + encoding: + type: Encoding + docs: Encoding format of the audio input, such as `linear16`. + channels: + type: integer + docs: Number of audio channels. + sample_rate: + type: integer + docs: >- + Audio sample rate. Number of samples per second in the audio input, + measured in Hertz. + source: + openapi: assistant-asyncapi.json + AudioInput: + docs: When provided, the input is audio. + properties: + type: + type: literal<"audio_input"> + docs: >- + The type of message sent through the socket; must be `audio_input` for + our server to correctly identify and process it as an Audio Input + message. + + + This message is used for sending audio input data to EVI for + processing and expression measurement. Audio data should be sent as a + continuous stream, encoded in Base64. + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + data: + type: string + docs: >- + Base64 encoded audio input to insert into the conversation. + + + The content of an Audio Input message is treated as the user’s speech + to EVI and must be streamed continuously. Pre-recorded audio files are + not supported. + + + For optimal transcription quality, the audio data should be + transmitted in small chunks. + + + Hume recommends streaming audio with a buffer window of 20 + milliseconds (ms), or 100 milliseconds (ms) for web applications. + source: + openapi: assistant-asyncapi.json + BuiltInTool: + enum: + - web_search + - hang_up + docs: >- + Name of the built-in tool. Set to `web_search` to equip EVI with the + built-in Web Search tool. + source: + openapi: assistant-asyncapi.json + BuiltinToolConfig: + properties: + name: + type: BuiltInTool + fallback_content: + type: optional + docs: >- + Optional text passed to the supplemental LLM if the tool call fails. + The LLM then uses this text to generate a response back to the user, + ensuring continuity in the conversation. + source: + openapi: assistant-asyncapi.json + Context: + properties: + type: + type: optional + docs: >- + The persistence level of the injected context. Specifies how long the + injected context will remain active in the session. + + + There are three possible context types: + + + - **Persistent**: The context is appended to all user messages for the + duration of the session. + + + - **Temporary**: The context is appended only to the next user + message. + + - **Editable**: The original context is updated to reflect the new context. + + If the type is not specified, it will default to `temporary`. + text: + type: string + docs: >- + The context to be injected into the conversation. Helps inform the + LLM's response by providing relevant information about the ongoing + conversation. + + + This text will be appended to the end of user messages based on the + chosen persistence level. For example, if you want to remind EVI of + its role as a helpful weather assistant, the context you insert will + be appended to the end of user messages as `{Context: You are a + helpful weather assistant}`. + source: + openapi: assistant-asyncapi.json + ContextType: + enum: + - editable + - persistent + - temporary + source: + openapi: assistant-asyncapi.json + Encoding: + type: literal<"linear16"> + ErrorLevel: + type: literal<"warn"> + PauseAssistantMessage: + docs: >- + Pause responses from EVI. Chat history is still saved and sent after + resuming. + properties: + type: + type: literal<"pause_assistant_message"> + docs: >- + The type of message sent through the socket; must be + `pause_assistant_message` for our server to correctly identify and + process it as a Pause Assistant message. + + + Once this message is sent, EVI will not respond until a [Resume + Assistant + message](/reference/empathic-voice-interface-evi/chat/chat#send.Resume%20Assistant%20Message.type) + is sent. When paused, EVI won’t respond, but transcriptions of your + audio inputs will still be recorded. + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + source: + openapi: assistant-asyncapi.json + ResumeAssistantMessage: + docs: >- + Resume responses from EVI. Chat history sent while paused will now be + sent. + properties: + type: + type: literal<"resume_assistant_message"> + docs: >- + The type of message sent through the socket; must be + `resume_assistant_message` for our server to correctly identify and + process it as a Resume Assistant message. + + + Upon resuming, if any audio input was sent during the pause, EVI will + retain context from all messages sent but only respond to the last + user message. (e.g., If you ask EVI two questions while paused and + then send a `resume_assistant_message`, EVI will respond to the second + question and have added the first question to its conversation + context.) + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + source: + openapi: assistant-asyncapi.json + SessionSettings: + docs: Settings for this chat session. + properties: + type: + type: literal<"session_settings"> + docs: >- + The type of message sent through the socket; must be + `session_settings` for our server to correctly identify and process it + as a Session Settings message. + + + Session settings are temporary and apply only to the current Chat + session. These settings can be adjusted dynamically based on the + requirements of each session to ensure optimal performance and user + experience. + + + For more information, please refer to the [Session Settings + section](/docs/empathic-voice-interface-evi/configuration#session-settings) + on the EVI Configuration page. + custom_session_id: + type: optional + docs: >- + Unique identifier for the session. Used to manage conversational + state, correlate frontend and backend data, and persist conversations + across EVI sessions. + + + If included, the response sent from Hume to your backend will include + this ID. This allows you to correlate frontend users with their + incoming messages. + + + It is recommended to pass a `custom_session_id` if you are using a + Custom Language Model. Please see our guide to [using a custom + language + model](/docs/empathic-voice-interface-evi/custom-language-model) with + EVI to learn more. + system_prompt: + type: optional + docs: >- + Instructions used to shape EVI’s behavior, responses, and style for + the session. + + + When included in a Session Settings message, the provided Prompt + overrides the existing one specified in the EVI configuration. If no + Prompt was defined in the configuration, this Prompt will be the one + used for the session. + + + You can use the Prompt to define a specific goal or role for EVI, + specifying how it should act or what it should focus on during the + conversation. For example, EVI can be instructed to act as a customer + support representative, a fitness coach, or a travel advisor, each + with its own set of behaviors and response styles. + + + For help writing a system prompt, see our [Prompting + Guide](/docs/empathic-voice-interface-evi/prompting). + context: + type: optional + docs: >- + Allows developers to inject additional context into the conversation, + which is appended to the end of user messages for the session. + + + When included in a Session Settings message, the provided context can + be used to remind the LLM of its role in every user message, prevent + it from forgetting important details, or add new relevant information + to the conversation. + + + Set to `null` to disable context injection. + audio: + type: optional + docs: >- + Configuration details for the audio input used during the session. + Ensures the audio is being correctly set up for processing. + + + This optional field is only required when the audio input is encoded + in PCM Linear 16 (16-bit, little-endian, signed PCM WAV data). For + detailed instructions on how to configure session settings for PCM + Linear 16 audio, please refer to the [Session Settings + section](/docs/empathic-voice-interface-evi/configuration#session-settings) + on the EVI Configuration page. + language_model_api_key: + type: optional + docs: >- + Third party API key for the supplemental language model. + + + When provided, EVI will use this key instead of Hume’s API key for the + supplemental LLM. This allows you to bypass rate limits and utilize + your own API key as needed. + tools: + type: optional> + docs: >- + List of user-defined tools to enable for the session. + + + Tools are resources used by EVI to perform various tasks, such as + searching the web or calling external APIs. Built-in tools, like web + search, are natively integrated, while user-defined tools are created + and invoked by the user. To learn more, see our [Tool Use + Guide](/docs/empathic-voice-interface-evi/tool-use). + builtin_tools: + type: optional> + docs: >- + List of built-in tools to enable for the session. + + + Tools are resources used by EVI to perform various tasks, such as + searching the web or calling external APIs. Built-in tools, like web + search, are natively integrated, while user-defined tools are created + and invoked by the user. To learn more, see our [Tool Use + Guide](/docs/empathic-voice-interface-evi/tool-use). + + + Currently, the only built-in tool Hume provides is **Web Search**. + When enabled, Web Search equips EVI with the ability to search the web + for up-to-date information. + metadata: + type: optional> + variables: + type: optional> + docs: Dynamic values that can be used to populate EVI prompts. + source: + openapi: assistant-asyncapi.json + Tool: + properties: + type: + type: ToolType + docs: Type of tool. Set to `function` for user-defined tools. + name: + type: string + docs: Name of the user-defined tool to be enabled. + parameters: + type: string + docs: >- + Parameters of the tool. Is a stringified JSON schema. + + + These parameters define the inputs needed for the tool’s execution, + including the expected data type and description for each input field. + Structured as a JSON schema, this format ensures the tool receives + data in the expected format. + description: + type: optional + docs: >- + An optional description of what the tool does, used by the + supplemental LLM to choose when and how to call the function. + fallback_content: + type: optional + docs: >- + Optional text passed to the supplemental LLM if the tool call fails. + The LLM then uses this text to generate a response back to the user, + ensuring continuity in the conversation. + source: + openapi: assistant-asyncapi.json + ToolErrorMessage: + docs: When provided, the output is a function call error. + properties: + type: + type: literal<"tool_error"> + docs: >- + The type of message sent through the socket; for a Tool Error message, + this must be `tool_error`. + + + Upon receiving a [Tool Call + message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type) + and failing to invoke the function, this message is sent to notify EVI + of the tool's failure. + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + tool_type: + type: optional + docs: >- + Type of tool called. Either `builtin` for natively implemented tools, + like web search, or `function` for user-defined tools. + tool_call_id: + type: string + docs: >- + The unique identifier for a specific tool call instance. + + + This ID is used to track the request and response of a particular tool + invocation, ensuring that the Tool Error message is linked to the + appropriate tool call request. The specified `tool_call_id` must match + the one received in the [Tool Call + message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type). + content: + type: optional + docs: >- + Optional text passed to the supplemental LLM in place of the tool call + result. The LLM then uses this text to generate a response back to the + user, ensuring continuity in the conversation if the tool errors. + error: + type: string + docs: Error message from the tool call, not exposed to the LLM or user. + code: + type: optional + docs: Error code. Identifies the type of error encountered. + level: + type: optional + docs: >- + Indicates the severity of an error; for a Tool Error message, this + must be `warn` to signal an unexpected event. + source: + openapi: assistant-asyncapi.json + ToolResponseMessage: + docs: When provided, the output is a function call response. + properties: + type: + type: literal<"tool_response"> + docs: >- + The type of message sent through the socket; for a Tool Response + message, this must be `tool_response`. + + + Upon receiving a [Tool Call + message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type) + and successfully invoking the function, this message is sent to convey + the result of the function call back to EVI. + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + tool_call_id: + type: string + docs: >- + The unique identifier for a specific tool call instance. + + + This ID is used to track the request and response of a particular tool + invocation, ensuring that the correct response is linked to the + appropriate request. The specified `tool_call_id` must match the one + received in the [Tool Call + message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.tool_call_id). + content: + type: string + docs: >- + Return value of the tool call. Contains the output generated by the + tool to pass back to EVI. + tool_name: + type: optional + docs: >- + Name of the tool. + + + Include this optional field to help the supplemental LLM identify + which tool generated the response. The specified `tool_name` must + match the one received in the [Tool Call + message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type). + tool_type: + type: optional + docs: >- + Type of tool called. Either `builtin` for natively implemented tools, + like web search, or `function` for user-defined tools. + source: + openapi: assistant-asyncapi.json + ToolType: + enum: + - builtin + - function + source: + openapi: assistant-asyncapi.json + UserInput: + docs: >- + User text to insert into the conversation. Text sent through a User Input + message is treated as the user’s speech to EVI. EVI processes this input + and provides a corresponding response. + + + Expression measurement results are not available for User Input messages, + as the prosody model relies on audio input and cannot process text alone. + properties: + type: + type: literal<"user_input"> + docs: >- + The type of message sent through the socket; must be `user_input` for + our server to correctly identify and process it as a User Input + message. + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + text: + type: string + docs: >- + User text to insert into the conversation. Text sent through a User + Input message is treated as the user’s speech to EVI. EVI processes + this input and provides a corresponding response. + + + Expression measurement results are not available for User Input + messages, as the prosody model relies on audio input and cannot + process text alone. + source: + openapi: assistant-asyncapi.json + AssistantEnd: + docs: When provided, the output is an assistant end message. + properties: + type: + type: literal<"assistant_end"> + docs: >- + The type of message sent through the socket; for an Assistant End + message, this must be `assistant_end`. + + + This message indicates the conclusion of the assistant’s response, + signaling that the assistant has finished speaking for the current + conversational turn. + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + source: + openapi: assistant-asyncapi.json + AssistantMessage: + docs: When provided, the output is an assistant message. + properties: + type: + type: literal<"assistant_message"> + docs: >- + The type of message sent through the socket; for an Assistant Message, + this must be `assistant_message`. + + + This message contains both a transcript of the assistant’s response + and the expression measurement predictions of the assistant’s audio + output. + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + id: + type: optional + docs: >- + ID of the assistant message. Allows the Assistant Message to be + tracked and referenced. + message: + type: ChatMessage + docs: Transcript of the message. + models: + type: Inference + docs: Inference model results. + from_text: + type: boolean + docs: >- + Indicates if this message was inserted into the conversation as text + from an [Assistant Input + message](/reference/empathic-voice-interface-evi/chat/chat#send.Assistant%20Input.text). + source: + openapi: assistant-asyncapi.json + AudioOutput: + docs: >- + The type of message sent through the socket; for an Audio Output message, + this must be `audio_output`. + properties: + type: + type: literal<"audio_output"> + docs: >- + The type of message sent through the socket; for an Audio Output + message, this must be `audio_output`. + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + id: + type: string + docs: >- + ID of the audio output. Allows the Audio Output message to be tracked + and referenced. + index: + type: integer + docs: Index of the chunk of audio relative to the whole audio segment. + data: + type: string + docs: >- + Base64 encoded audio output. This encoded audio is transmitted to the + client, where it can be decoded and played back as part of the user + interaction. + source: + openapi: assistant-asyncapi.json + ChatMessageToolResult: + discriminated: false + docs: Function call response from client. + union: + - type: ToolResponseMessage + - type: ToolErrorMessage + source: + openapi: assistant-asyncapi.json + ChatMessage: + properties: + role: + type: Role + docs: Role of who is providing the message. + content: + type: optional + docs: Transcript of the message. + tool_call: + type: optional + docs: Function call name and arguments. + tool_result: + type: optional docs: Function call response from client. - union: - - type: ToolResponseMessage - - type: ToolErrorMessage - source: - openapi: assistant-asyncapi.json - ChatMessage: - properties: - role: - type: Role - docs: Role of who is providing the message. - content: - type: optional - docs: Transcript of the message. - tool_call: - type: optional - docs: Function call name and arguments. - tool_result: - type: optional - docs: Function call response from client. - source: - openapi: assistant-asyncapi.json - ChatMetadata: - docs: When provided, the output is a chat metadata message. - properties: - type: - type: literal<"chat_metadata"> - docs: >- - The type of message sent through the socket; for a Chat Metadata - message, this must be `chat_metadata`. - - - The Chat Metadata message is the first message you receive after - establishing a connection with EVI and contains important identifiers - for the current Chat session. - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - chat_group_id: - type: string - docs: >- - ID of the Chat Group. - - - Used to resume a Chat when passed in the - [resumed_chat_group_id](/reference/empathic-voice-interface-evi/chat/chat#request.query.resumed_chat_group_id) - query parameter of a subsequent connection request. This allows EVI to - continue the conversation from where it left off within the Chat - Group. - - - Learn more about [supporting chat - resumability](/docs/empathic-voice-interface-evi/faq#does-evi-support-chat-resumability) - from the EVI FAQ. - chat_id: - type: string - docs: >- - ID of the Chat session. Allows the Chat session to be tracked and - referenced. - request_id: - type: optional - docs: ID of the initiating request. - source: - openapi: assistant-asyncapi.json - EmotionScores: - properties: - Admiration: double - Adoration: double - Aesthetic Appreciation: double - Amusement: double - Anger: double - Anxiety: double - Awe: double - Awkwardness: double - Boredom: double - Calmness: double - Concentration: double - Confusion: double - Contemplation: double - Contempt: double - Contentment: double - Craving: double - Desire: double - Determination: double - Disappointment: double - Disgust: double - Distress: double - Doubt: double - Ecstasy: double - Embarrassment: double - Empathic Pain: double - Entrancement: double - Envy: double - Excitement: double - Fear: double - Guilt: double - Horror: double - Interest: double - Joy: double - Love: double - Nostalgia: double - Pain: double - Pride: double - Realization: double - Relief: double - Romance: double - Sadness: double - Satisfaction: double - Shame: double - Surprise (negative): double - Surprise (positive): double - Sympathy: double - Tiredness: double - Triumph: double - source: - openapi: assistant-asyncapi.json - WebSocketError: - docs: When provided, the output is an error message. - properties: - type: - type: literal<"error"> - docs: >- - The type of message sent through the socket; for a Web Socket Error - message, this must be `error`. - - - This message indicates a disruption in the WebSocket connection, such - as an unexpected disconnection, protocol error, or data transmission - issue. - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - code: - type: string - docs: Error code. Identifies the type of error encountered. - slug: - type: string - docs: >- - Short, human-readable identifier and description for the error. See a - complete list of error slugs on the [Errors - page](/docs/resources/errors). - message: - type: string - docs: Detailed description of the error. - source: - openapi: assistant-asyncapi.json - Inference: - properties: - prosody: - type: optional - docs: >- - Prosody model inference results. - - - EVI uses the prosody model to measure 48 emotions related to speech - and vocal characteristics within a given expression. - source: - openapi: assistant-asyncapi.json - MillisecondInterval: - properties: - begin: - type: integer - docs: Start time of the interval in milliseconds. - end: - type: integer - docs: End time of the interval in milliseconds. - source: - openapi: assistant-asyncapi.json - ProsodyInference: - properties: - scores: - type: EmotionScores - docs: >- - The confidence scores for 48 emotions within the detected expression - of an audio sample. - - - Scores typically range from 0 to 1, with higher values indicating a - stronger confidence level in the measured attribute. - - - See our guide on [interpreting expression measurement - results](/docs/expression-measurement/faq#how-do-i-interpret-my-results) - to learn more. - source: - openapi: assistant-asyncapi.json - Role: - enum: - - assistant - - system - - user - - all - - tool - source: - openapi: assistant-asyncapi.json - ToolCallMessage: - docs: When provided, the output is a tool call. - properties: - name: - type: string - docs: Name of the tool called. - parameters: - type: string - docs: >- - Parameters of the tool. - - - These parameters define the inputs needed for the tool’s execution, - including the expected data type and description for each input field. - Structured as a stringified JSON schema, this format ensures the tool - receives data in the expected format. - tool_call_id: - type: string - docs: >- - The unique identifier for a specific tool call instance. - - - This ID is used to track the request and response of a particular tool - invocation, ensuring that the correct response is linked to the - appropriate request. - type: - type: literal<"tool_call"> - docs: >- - The type of message sent through the socket; for a Tool Call message, - this must be `tool_call`. - - - This message indicates that the supplemental LLM has detected a need - to invoke the specified tool. - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - tool_type: - type: optional - docs: >- - Type of tool called. Either `builtin` for natively implemented tools, - like web search, or `function` for user-defined tools. - response_required: - type: boolean - docs: >- - Indicates whether a response to the tool call is required from the - developer, either in the form of a [Tool Response - message](/reference/empathic-voice-interface-evi/chat/chat#send.Tool%20Response%20Message.type) - or a [Tool Error - message](/reference/empathic-voice-interface-evi/chat/chat#send.Tool%20Error%20Message.type). - source: - openapi: assistant-asyncapi.json - UserInterruption: - docs: When provided, the output is an interruption. - properties: - type: - type: literal<"user_interruption"> - docs: >- - The type of message sent through the socket; for a User Interruption - message, this must be `user_interruption`. - - - This message indicates the user has interrupted the assistant’s - response. EVI detects the interruption in real-time and sends this - message to signal the interruption event. This message allows the - system to stop the current audio playback, clear the audio queue, and - prepare to handle new user input. - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - time: - type: integer - docs: Unix timestamp of the detected user interruption. - source: - openapi: assistant-asyncapi.json - UserMessage: - docs: When provided, the output is a user message. - properties: - type: - type: literal<"user_message"> - docs: >- - The type of message sent through the socket; for a User Message, this - must be `user_message`. - - - This message contains both a transcript of the user’s input and the - expression measurement predictions if the input was sent as an [Audio - Input - message](/reference/empathic-voice-interface-evi/chat/chat#send.Audio%20Input.type). - Expression measurement predictions are not provided for a [User Input - message](/reference/empathic-voice-interface-evi/chat/chat#send.User%20Input.type), - as the prosody model relies on audio input and cannot process text - alone. - custom_session_id: - type: optional - docs: >- - Used to manage conversational state, correlate frontend and backend - data, and persist conversations across EVI sessions. - message: - type: ChatMessage - docs: Transcript of the message. - models: - type: Inference - docs: Inference model results. - time: - type: MillisecondInterval - docs: Start and End time of user message. - from_text: - type: boolean - docs: >- - Indicates if this message was inserted into the conversation as text - from a [User - Input](/reference/empathic-voice-interface-evi/chat/chat#send.User%20Input.text) - message. - source: - openapi: assistant-asyncapi.json - JsonMessage: - discriminated: false - union: - - type: AssistantEnd - - type: AssistantMessage - - type: ChatMetadata - - type: WebSocketError - - type: UserInterruption - - type: UserMessage - - type: ToolCallMessage - - type: ToolResponseMessage - - type: ToolErrorMessage - source: - openapi: assistant-asyncapi.json - TtsInput: - properties: - type: optional> - source: - openapi: assistant-asyncapi.json - TextInput: - properties: - type: optional> - source: - openapi: assistant-asyncapi.json - FunctionCallResponseInput: - properties: - type: optional> - source: - openapi: assistant-asyncapi.json - ExtendedVoiceArgs: - properties: - text: string - use_s2a: - type: optional - default: true - voice_args: - type: VoiceArgs - source: - openapi: assistant-openapi.json - HTTPValidationError: - properties: - detail: - type: optional> - source: - openapi: assistant-openapi.json - ValidationErrorLocItem: - discriminated: false - union: - - string - - integer - source: - openapi: assistant-openapi.json - ValidationError: - properties: - loc: - type: list - msg: string - type: string - source: - openapi: assistant-openapi.json - VoiceArgs: - properties: - voice: - type: optional - speech_rate_multiplier: - type: optional - default: 1 - validation: - min: 0.5 - max: 2 - baseline: - type: optional - default: false - reconstruct: - type: optional - default: false - additive: - type: optional - default: false - drift: - type: optional - default: true - use_v2: - type: optional - default: true - source: - openapi: assistant-openapi.json - VoiceNameEnum: - enum: - - ITO - - KORA - - DACHER - - AURA - - FINN - - SIENNA - - WILLOW - - SCOUT - - WHIMSY - - ACE - - JUNO - - STELLA - - HIRO - source: - openapi: assistant-openapi.json + source: + openapi: assistant-asyncapi.json + ChatMetadata: + docs: When provided, the output is a chat metadata message. + properties: + type: + type: literal<"chat_metadata"> + docs: >- + The type of message sent through the socket; for a Chat Metadata + message, this must be `chat_metadata`. + + + The Chat Metadata message is the first message you receive after + establishing a connection with EVI and contains important identifiers + for the current Chat session. + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + chat_group_id: + type: string + docs: >- + ID of the Chat Group. + + + Used to resume a Chat when passed in the + [resumed_chat_group_id](/reference/empathic-voice-interface-evi/chat/chat#request.query.resumed_chat_group_id) + query parameter of a subsequent connection request. This allows EVI to + continue the conversation from where it left off within the Chat + Group. + + + Learn more about [supporting chat + resumability](/docs/empathic-voice-interface-evi/faq#does-evi-support-chat-resumability) + from the EVI FAQ. + chat_id: + type: string + docs: >- + ID of the Chat session. Allows the Chat session to be tracked and + referenced. + request_id: + type: optional + docs: ID of the initiating request. + source: + openapi: assistant-asyncapi.json + EmotionScores: + properties: + Admiration: double + Adoration: double + Aesthetic Appreciation: double + Amusement: double + Anger: double + Anxiety: double + Awe: double + Awkwardness: double + Boredom: double + Calmness: double + Concentration: double + Confusion: double + Contemplation: double + Contempt: double + Contentment: double + Craving: double + Desire: double + Determination: double + Disappointment: double + Disgust: double + Distress: double + Doubt: double + Ecstasy: double + Embarrassment: double + Empathic Pain: double + Entrancement: double + Envy: double + Excitement: double + Fear: double + Guilt: double + Horror: double + Interest: double + Joy: double + Love: double + Nostalgia: double + Pain: double + Pride: double + Realization: double + Relief: double + Romance: double + Sadness: double + Satisfaction: double + Shame: double + Surprise (negative): double + Surprise (positive): double + Sympathy: double + Tiredness: double + Triumph: double + source: + openapi: assistant-asyncapi.json + WebSocketError: + docs: When provided, the output is an error message. + properties: + type: + type: literal<"error"> + docs: >- + The type of message sent through the socket; for a Web Socket Error + message, this must be `error`. + + + This message indicates a disruption in the WebSocket connection, such + as an unexpected disconnection, protocol error, or data transmission + issue. + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + code: + type: string + docs: Error code. Identifies the type of error encountered. + slug: + type: string + docs: >- + Short, human-readable identifier and description for the error. See a + complete list of error slugs on the [Errors + page](/docs/resources/errors). + message: + type: string + docs: Detailed description of the error. + source: + openapi: assistant-asyncapi.json + Inference: + properties: + prosody: + type: optional + docs: >- + Prosody model inference results. + + + EVI uses the prosody model to measure 48 emotions related to speech + and vocal characteristics within a given expression. + source: + openapi: assistant-asyncapi.json + MillisecondInterval: + properties: + begin: + type: integer + docs: Start time of the interval in milliseconds. + end: + type: integer + docs: End time of the interval in milliseconds. + source: + openapi: assistant-asyncapi.json + ProsodyInference: + properties: + scores: + type: EmotionScores + docs: >- + The confidence scores for 48 emotions within the detected expression + of an audio sample. + + + Scores typically range from 0 to 1, with higher values indicating a + stronger confidence level in the measured attribute. + + + See our guide on [interpreting expression measurement + results](/docs/expression-measurement/faq#how-do-i-interpret-my-results) + to learn more. + source: + openapi: assistant-asyncapi.json + Role: + enum: + - assistant + - system + - user + - all + - tool + source: + openapi: assistant-asyncapi.json + ToolCallMessage: + docs: When provided, the output is a tool call. + properties: + name: + type: string + docs: Name of the tool called. + parameters: + type: string + docs: >- + Parameters of the tool. + + + These parameters define the inputs needed for the tool’s execution, + including the expected data type and description for each input field. + Structured as a stringified JSON schema, this format ensures the tool + receives data in the expected format. + tool_call_id: + type: string + docs: >- + The unique identifier for a specific tool call instance. + + + This ID is used to track the request and response of a particular tool + invocation, ensuring that the correct response is linked to the + appropriate request. + type: + type: literal<"tool_call"> + docs: >- + The type of message sent through the socket; for a Tool Call message, + this must be `tool_call`. + + + This message indicates that the supplemental LLM has detected a need + to invoke the specified tool. + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + tool_type: + type: optional + docs: >- + Type of tool called. Either `builtin` for natively implemented tools, + like web search, or `function` for user-defined tools. + response_required: + type: boolean + docs: >- + Indicates whether a response to the tool call is required from the + developer, either in the form of a [Tool Response + message](/reference/empathic-voice-interface-evi/chat/chat#send.Tool%20Response%20Message.type) + or a [Tool Error + message](/reference/empathic-voice-interface-evi/chat/chat#send.Tool%20Error%20Message.type). + source: + openapi: assistant-asyncapi.json + UserInterruption: + docs: When provided, the output is an interruption. + properties: + type: + type: literal<"user_interruption"> + docs: >- + The type of message sent through the socket; for a User Interruption + message, this must be `user_interruption`. + + + This message indicates the user has interrupted the assistant’s + response. EVI detects the interruption in real-time and sends this + message to signal the interruption event. This message allows the + system to stop the current audio playback, clear the audio queue, and + prepare to handle new user input. + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + time: + type: integer + docs: Unix timestamp of the detected user interruption. + source: + openapi: assistant-asyncapi.json + UserMessage: + docs: When provided, the output is a user message. + properties: + type: + type: literal<"user_message"> + docs: >- + The type of message sent through the socket; for a User Message, this + must be `user_message`. + + + This message contains both a transcript of the user’s input and the + expression measurement predictions if the input was sent as an [Audio + Input + message](/reference/empathic-voice-interface-evi/chat/chat#send.Audio%20Input.type). + Expression measurement predictions are not provided for a [User Input + message](/reference/empathic-voice-interface-evi/chat/chat#send.User%20Input.type), + as the prosody model relies on audio input and cannot process text + alone. + custom_session_id: + type: optional + docs: >- + Used to manage conversational state, correlate frontend and backend + data, and persist conversations across EVI sessions. + message: + type: ChatMessage + docs: Transcript of the message. + models: + type: Inference + docs: Inference model results. + time: + type: MillisecondInterval + docs: Start and End time of user message. + from_text: + type: boolean + docs: >- + Indicates if this message was inserted into the conversation as text + from a [User + Input](/reference/empathic-voice-interface-evi/chat/chat#send.User%20Input.text) + message. + source: + openapi: assistant-asyncapi.json + JsonMessage: + discriminated: false + union: + - type: AssistantEnd + - type: AssistantMessage + - type: ChatMetadata + - type: WebSocketError + - type: UserInterruption + - type: UserMessage + - type: ToolCallMessage + - type: ToolResponseMessage + - type: ToolErrorMessage + source: + openapi: assistant-asyncapi.json + TtsInput: + properties: + type: optional> + source: + openapi: assistant-asyncapi.json + TextInput: + properties: + type: optional> + source: + openapi: assistant-asyncapi.json + FunctionCallResponseInput: + properties: + type: optional> + source: + openapi: assistant-asyncapi.json + HTTPValidationError: + properties: + detail: + type: optional> + source: + openapi: assistant-openapi.json + ValidationErrorLocItem: + discriminated: false + union: + - string + - integer + source: + openapi: assistant-openapi.json + ValidationError: + properties: + loc: + type: list + msg: string + type: string + source: + openapi: assistant-openapi.json + VoiceNameEnum: + enum: + - ITO + - KORA + - DACHER + - AURA + - FINN + - SIENNA + - WILLOW + - SCOUT + - WHIMSY + - ACE + - JUNO + - STELLA + - HIRO + - SUNNY + source: + openapi: assistant-openapi.json diff --git a/.mock/definition/empathic-voice/chat.yml b/.mock/definition/empathic-voice/chat.yml index d9fab0bc..143a85c8 100644 --- a/.mock/definition/empathic-voice/chat.yml +++ b/.mock/definition/empathic-voice/chat.yml @@ -1,146 +1,146 @@ channel: - path: /v0/evi/chat - auth: false - query-parameters: - config_id: - type: optional - docs: >- - The unique identifier for an EVI configuration. - - - Include this ID in your connection request to equip EVI with the Prompt, - Language Model, Voice, and Tools associated with the specified - configuration. If omitted, EVI will apply [default configuration - settings](/docs/empathic-voice-interface-evi/configuration#default-configuration). - - - For help obtaining this ID, see our [Configuration - Guide](/docs/empathic-voice-interface-evi/configuration). - config_version: - type: optional - docs: >- - The version number of the EVI configuration specified by the - `config_id`. - - - Configs, as well as Prompts and Tools, are versioned. This versioning - system supports iterative development, allowing you to progressively - refine configurations and revert to previous versions if needed. - - - Include this parameter to apply a specific version of an EVI - configuration. If omitted, the latest version will be applied. - resumed_chat_group_id: - type: optional - docs: >- - The unique identifier for a Chat Group. Use this field to preserve - context from a previous Chat session. - - - A Chat represents a single session from opening to closing a WebSocket - connection. In contrast, a Chat Group is a series of resumed Chats that - collectively represent a single conversation spanning multiple sessions. - Each Chat includes a Chat Group ID, which is used to preserve the - context of previous Chat sessions when starting a new one. - - - Including the Chat Group ID in the `resumed_chat_group_id` query - parameter is useful for seamlessly resuming a Chat after unexpected - network disconnections and for picking up conversations exactly where - you left off at a later time. This ensures preserved context across - multiple sessions. - - - There are three ways to obtain the Chat Group ID: - - - - [Chat - Metadata](/reference/empathic-voice-interface-evi/chat/chat#receive.Chat%20Metadata.type): - Upon establishing a WebSocket connection with EVI, the user receives a - Chat Metadata message. This message contains a `chat_group_id`, which - can be used to resume conversations within this chat group in future - sessions. - - - - [List Chats - endpoint](/reference/empathic-voice-interface-evi/chats/list-chats): Use - the GET `/v0/evi/chats` endpoint to obtain the Chat Group ID of - individual Chat sessions. This endpoint lists all available Chat - sessions and their associated Chat Group ID. - - - - [List Chat Groups - endpoint](/reference/empathic-voice-interface-evi/chat-groups/list-chat-groups): - Use the GET `/v0/evi/chat_groups` endpoint to obtain the Chat Group IDs - of all Chat Groups associated with an API key. This endpoint returns a - list of all available chat groups. - access_token: - type: optional - docs: >- - Access token used for authenticating the client. If not provided, an - `api_key` must be provided to authenticate. - - - The access token is generated using both an API key and a Secret key, - which provides an additional layer of security compared to using just an - API key. - - - For more details, refer to the [Authentication Strategies - Guide](/docs/introduction/api-key#authentication-strategies). - api_key: - type: optional - docs: >- - API key used for authenticating the client. If not provided, an - `access_token` must be provided to authenticate. - - - For more details, refer to the [Authentication Strategies - Guide](/docs/introduction/api-key#authentication-strategies). - messages: - subscribe: - origin: server - body: SubscribeEvent - publish: - origin: client - body: PublishEvent - examples: - - messages: - - type: publish - body: - type: audio_input - data: data - - type: subscribe - body: - type: assistant_end + path: /v0/evi/chat + auth: false + query-parameters: + config_id: + type: optional + docs: >- + The unique identifier for an EVI configuration. + + + Include this ID in your connection request to equip EVI with the Prompt, + Language Model, Voice, and Tools associated with the specified + configuration. If omitted, EVI will apply [default configuration + settings](/docs/empathic-voice-interface-evi/configuration#default-configuration). + + + For help obtaining this ID, see our [Configuration + Guide](/docs/empathic-voice-interface-evi/configuration). + config_version: + type: optional + docs: >- + The version number of the EVI configuration specified by the + `config_id`. + + + Configs, as well as Prompts and Tools, are versioned. This versioning + system supports iterative development, allowing you to progressively + refine configurations and revert to previous versions if needed. + + + Include this parameter to apply a specific version of an EVI + configuration. If omitted, the latest version will be applied. + resumed_chat_group_id: + type: optional + docs: >- + The unique identifier for a Chat Group. Use this field to preserve + context from a previous Chat session. + + + A Chat represents a single session from opening to closing a WebSocket + connection. In contrast, a Chat Group is a series of resumed Chats that + collectively represent a single conversation spanning multiple sessions. + Each Chat includes a Chat Group ID, which is used to preserve the + context of previous Chat sessions when starting a new one. + + + Including the Chat Group ID in the `resumed_chat_group_id` query + parameter is useful for seamlessly resuming a Chat after unexpected + network disconnections and for picking up conversations exactly where + you left off at a later time. This ensures preserved context across + multiple sessions. + + + There are three ways to obtain the Chat Group ID: + + + - [Chat + Metadata](/reference/empathic-voice-interface-evi/chat/chat#receive.Chat%20Metadata.type): + Upon establishing a WebSocket connection with EVI, the user receives a + Chat Metadata message. This message contains a `chat_group_id`, which + can be used to resume conversations within this chat group in future + sessions. + + + - [List Chats + endpoint](/reference/empathic-voice-interface-evi/chats/list-chats): Use + the GET `/v0/evi/chats` endpoint to obtain the Chat Group ID of + individual Chat sessions. This endpoint lists all available Chat + sessions and their associated Chat Group ID. + + + - [List Chat Groups + endpoint](/reference/empathic-voice-interface-evi/chat-groups/list-chat-groups): + Use the GET `/v0/evi/chat_groups` endpoint to obtain the Chat Group IDs + of all Chat Groups associated with an API key. This endpoint returns a + list of all available chat groups. + access_token: + type: optional + docs: >- + Access token used for authenticating the client. If not provided, an + `api_key` must be provided to authenticate. + + + The access token is generated using both an API key and a Secret key, + which provides an additional layer of security compared to using just an + API key. + + + For more details, refer to the [Authentication Strategies + Guide](/docs/introduction/api-key#authentication-strategies). + api_key: + type: optional + docs: >- + API key used for authenticating the client. If not provided, an + `access_token` must be provided to authenticate. + + + For more details, refer to the [Authentication Strategies + Guide](/docs/introduction/api-key#authentication-strategies). + messages: + subscribe: + origin: server + body: SubscribeEvent + publish: + origin: client + body: PublishEvent + examples: + - messages: + - type: publish + body: + type: audio_input + data: data + - type: subscribe + body: + type: assistant_end imports: - root: __package__.yml + root: __package__.yml types: - SubscribeEvent: - discriminated: false - union: - - type: root.AssistantEnd - - type: root.AssistantMessage - - type: root.AudioOutput - - type: root.ChatMetadata - - type: root.WebSocketError - - type: root.UserInterruption - - type: root.UserMessage - - type: root.ToolCallMessage - - type: root.ToolResponseMessage - - type: root.ToolErrorMessage - source: - openapi: assistant-asyncapi.json - PublishEvent: - discriminated: false - union: - - type: root.AudioInput - - type: root.SessionSettings - - type: root.UserInput - - type: root.AssistantInput - - type: root.ToolResponseMessage - - type: root.ToolErrorMessage - - type: root.PauseAssistantMessage - - type: root.ResumeAssistantMessage - source: - openapi: assistant-asyncapi.json + SubscribeEvent: + discriminated: false + union: + - type: root.AssistantEnd + - type: root.AssistantMessage + - type: root.AudioOutput + - type: root.ChatMetadata + - type: root.WebSocketError + - type: root.UserInterruption + - type: root.UserMessage + - type: root.ToolCallMessage + - type: root.ToolResponseMessage + - type: root.ToolErrorMessage + source: + openapi: assistant-asyncapi.json + PublishEvent: + discriminated: false + union: + - type: root.AudioInput + - type: root.SessionSettings + - type: root.UserInput + - type: root.AssistantInput + - type: root.ToolResponseMessage + - type: root.ToolErrorMessage + - type: root.PauseAssistantMessage + - type: root.ResumeAssistantMessage + source: + openapi: assistant-asyncapi.json diff --git a/.mock/definition/empathic-voice/chatGroups.yml b/.mock/definition/empathic-voice/chatGroups.yml index 98bc4960..81454a0e 100644 --- a/.mock/definition/empathic-voice/chatGroups.yml +++ b/.mock/definition/empathic-voice/chatGroups.yml @@ -1,526 +1,597 @@ imports: - root: __package__.yml + root: __package__.yml service: - auth: false - base-path: "" - endpoints: - list-chat-groups: - path: /v0/evi/chat_groups - method: GET - auth: true - docs: Fetches a paginated list of **Chat Groups**. - display-name: List chat_groups - request: - name: ChatGroupsListChatGroupsRequest - query-parameters: - page_number: - type: optional - docs: >- - Specifies the page number to retrieve, enabling pagination. + auth: false + base-path: '' + endpoints: + list-chat-groups: + path: /v0/evi/chat_groups + method: GET + auth: true + docs: Fetches a paginated list of **Chat Groups**. + display-name: List chat_groups + request: + name: ChatGroupsListChatGroupsRequest + query-parameters: + page_number: + type: optional + docs: >- + Specifies the page number to retrieve, enabling pagination. - This parameter uses zero-based indexing. For example, setting - `page_number` to 0 retrieves the first page of results (items 0-9 - if `page_size` is 10), setting `page_number` to 1 retrieves the - second page (items 10-19), and so on. Defaults to 0, which - retrieves the first page. - page_size: - type: optional - docs: >- - Specifies the maximum number of results to include per page, - enabling pagination. The value must be between 1 and 100, - inclusive. + This parameter uses zero-based indexing. For example, setting + `page_number` to 0 retrieves the first page of results (items 0-9 + if `page_size` is 10), setting `page_number` to 1 retrieves the + second page (items 10-19), and so on. Defaults to 0, which + retrieves the first page. + page_size: + type: optional + docs: >- + Specifies the maximum number of results to include per page, + enabling pagination. The value must be between 1 and 100, + inclusive. - For example, if `page_size` is set to 10, each page will include - up to 10 items. Defaults to 10. - ascending_order: - type: optional - docs: >- - Specifies the sorting order of the results based on their creation - date. Set to true for ascending order (chronological, with the - oldest records first) and false for descending order - (reverse-chronological, with the newest records first). Defaults - to true. - config_id: - type: optional - docs: >- - The unique identifier for an EVI configuration. + For example, if `page_size` is set to 10, each page will include + up to 10 items. Defaults to 10. + ascending_order: + type: optional + docs: >- + Specifies the sorting order of the results based on their creation + date. Set to true for ascending order (chronological, with the + oldest records first) and false for descending order + (reverse-chronological, with the newest records first). Defaults + to true. + config_id: + type: optional + docs: >- + The unique identifier for an EVI configuration. - Filter Chat Groups to only include Chats that used this - `config_id` in their most recent Chat. - response: - docs: Success - type: root.ReturnPagedChatGroups - errors: - - root.BadRequestError - examples: - - query-parameters: - page_number: 0 - page_size: 1 - ascending_order: true - config_id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 - response: - body: - page_number: 0 - page_size: 1 - total_pages: 1 - pagination_direction: ASC - chat_groups_page: - - id: 697056f0-6c7e-487d-9bd8-9c19df79f05f - first_start_timestamp: 1721844196397 - most_recent_start_timestamp: 1721861821717 - active: false - most_recent_chat_id: dfdbdd4d-0ddf-418b-8fc4-80a266579d36 - num_chats: 5 - get-chat-group: - path: /v0/evi/chat_groups/{id} - method: GET - auth: true + Filter Chat Groups to only include Chats that used this + `config_id` in their most recent Chat. + response: + docs: Success + type: root.ReturnPagedChatGroups + errors: + - root.BadRequestError + examples: + - query-parameters: + page_number: 0 + page_size: 1 + ascending_order: true + config_id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + response: + body: + page_number: 0 + page_size: 1 + total_pages: 1 + pagination_direction: ASC + chat_groups_page: + - id: 697056f0-6c7e-487d-9bd8-9c19df79f05f + first_start_timestamp: 1721844196397 + most_recent_start_timestamp: 1721861821717 + active: false + most_recent_chat_id: dfdbdd4d-0ddf-418b-8fc4-80a266579d36 + num_chats: 5 + get-chat-group: + path: /v0/evi/chat_groups/{id} + method: GET + auth: true + docs: >- + Fetches a **ChatGroup** by ID, including a paginated list of **Chats** + associated with the **ChatGroup**. + path-parameters: + id: + type: string + docs: Identifier for a Chat Group. Formatted as a UUID. + display-name: Get chat_group + request: + name: ChatGroupsGetChatGroupRequest + query-parameters: + page_size: + type: optional docs: >- - Fetches a **ChatGroup** by ID, including a paginated list of **Chats** - associated with the **ChatGroup**. - path-parameters: - id: - type: string - docs: Identifier for a Chat Group. Formatted as a UUID. - display-name: Get chat_group - request: - name: ChatGroupsGetChatGroupRequest - query-parameters: - page_size: - type: optional - docs: >- - Specifies the maximum number of results to include per page, - enabling pagination. The value must be between 1 and 100, - inclusive. + Specifies the maximum number of results to include per page, + enabling pagination. The value must be between 1 and 100, + inclusive. - For example, if `page_size` is set to 10, each page will include - up to 10 items. Defaults to 10. - page_number: - type: optional - docs: >- - Specifies the page number to retrieve, enabling pagination. + For example, if `page_size` is set to 10, each page will include + up to 10 items. Defaults to 10. + page_number: + type: optional + docs: >- + Specifies the page number to retrieve, enabling pagination. - This parameter uses zero-based indexing. For example, setting - `page_number` to 0 retrieves the first page of results (items 0-9 - if `page_size` is 10), setting `page_number` to 1 retrieves the - second page (items 10-19), and so on. Defaults to 0, which - retrieves the first page. - ascending_order: - type: optional - docs: >- - Specifies the sorting order of the results based on their creation - date. Set to true for ascending order (chronological, with the - oldest records first) and false for descending order - (reverse-chronological, with the newest records first). Defaults - to true. - response: - docs: Success - type: root.ReturnChatGroupPagedChats - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 697056f0-6c7e-487d-9bd8-9c19df79f05f - query-parameters: - page_number: 0 - page_size: 1 - ascending_order: true - response: - body: - id: 369846cf-6ad5-404d-905e-a8acb5cdfc78 - first_start_timestamp: 1712334213647 - most_recent_start_timestamp: 1712334213647 - num_chats: 1 - page_number: 0 - page_size: 1 - total_pages: 1 - pagination_direction: ASC - chats_page: - - id: 6375d4f8-cd3e-4d6b-b13b-ace66b7c8aaa - chat_group_id: 369846cf-6ad5-404d-905e-a8acb5cdfc78 - status: USER_ENDED - start_timestamp: 1712334213647 - end_timestamp: 1712334332571 - event_count: 0 - active: false - list-chat-group-events: - path: /v0/evi/chat_groups/{id}/events - method: GET - auth: true + This parameter uses zero-based indexing. For example, setting + `page_number` to 0 retrieves the first page of results (items 0-9 + if `page_size` is 10), setting `page_number` to 1 retrieves the + second page (items 10-19), and so on. Defaults to 0, which + retrieves the first page. + ascending_order: + type: optional + docs: >- + Specifies the sorting order of the results based on their creation + date. Set to true for ascending order (chronological, with the + oldest records first) and false for descending order + (reverse-chronological, with the newest records first). Defaults + to true. + response: + docs: Success + type: root.ReturnChatGroupPagedChats + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 697056f0-6c7e-487d-9bd8-9c19df79f05f + query-parameters: + page_number: 0 + page_size: 1 + ascending_order: true + response: + body: + id: 369846cf-6ad5-404d-905e-a8acb5cdfc78 + first_start_timestamp: 1712334213647 + most_recent_start_timestamp: 1712334213647 + num_chats: 1 + page_number: 0 + page_size: 1 + total_pages: 1 + pagination_direction: ASC + chats_page: + - id: 6375d4f8-cd3e-4d6b-b13b-ace66b7c8aaa + chat_group_id: 369846cf-6ad5-404d-905e-a8acb5cdfc78 + status: USER_ENDED + start_timestamp: 1712334213647 + end_timestamp: 1712334332571 + event_count: 0 + active: false + list-chat-group-events: + path: /v0/evi/chat_groups/{id}/events + method: GET + auth: true + docs: >- + Fetches a paginated list of **Chat** events associated with a **Chat + Group**. + path-parameters: + id: + type: string + docs: Identifier for a Chat Group. Formatted as a UUID. + display-name: List chat events from a specific chat_group + request: + name: ChatGroupsListChatGroupEventsRequest + query-parameters: + page_size: + type: optional docs: >- - Fetches a paginated list of **Chat** events associated with a **Chat - Group**. - path-parameters: - id: - type: string - docs: Identifier for a Chat Group. Formatted as a UUID. - display-name: List chat events from a specific chat_group - request: - name: ChatGroupsListChatGroupEventsRequest - query-parameters: - page_size: - type: optional - docs: >- - Specifies the maximum number of results to include per page, - enabling pagination. The value must be between 1 and 100, - inclusive. + Specifies the maximum number of results to include per page, + enabling pagination. The value must be between 1 and 100, + inclusive. - For example, if `page_size` is set to 10, each page will include - up to 10 items. Defaults to 10. - page_number: - type: optional - docs: >- - Specifies the page number to retrieve, enabling pagination. + For example, if `page_size` is set to 10, each page will include + up to 10 items. Defaults to 10. + page_number: + type: optional + docs: >- + Specifies the page number to retrieve, enabling pagination. - This parameter uses zero-based indexing. For example, setting - `page_number` to 0 retrieves the first page of results (items 0-9 - if `page_size` is 10), setting `page_number` to 1 retrieves the - second page (items 10-19), and so on. Defaults to 0, which - retrieves the first page. - ascending_order: - type: optional - docs: >- - Specifies the sorting order of the results based on their creation - date. Set to true for ascending order (chronological, with the - oldest records first) and false for descending order - (reverse-chronological, with the newest records first). Defaults - to true. - response: - docs: Success - type: root.ReturnChatGroupPagedEvents - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 697056f0-6c7e-487d-9bd8-9c19df79f05f - query-parameters: - page_number: 0 - page_size: 3 - ascending_order: true - response: - body: - id: 697056f0-6c7e-487d-9bd8-9c19df79f05f - page_number: 0 - page_size: 3 - total_pages: 1 - pagination_direction: ASC - events_page: - - id: 5d44bdbb-49a3-40fb-871d-32bf7e76efe7 - chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 - timestamp: 1716244940762 - role: SYSTEM - type: SYSTEM_PROMPT - message_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. - emotion_features: "" - metadata: "" - - id: 5976ddf6-d093-4bb9-ba60-8f6c25832dde - chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 - timestamp: 1716244956278 - role: USER - type: USER_MESSAGE - message_text: Hello. - emotion_features: >- - {"Admiration": 0.09906005859375, "Adoration": - 0.12213134765625, "Aesthetic Appreciation": - 0.05035400390625, "Amusement": 0.16552734375, "Anger": - 0.0037384033203125, "Anxiety": 0.010101318359375, "Awe": - 0.058197021484375, "Awkwardness": 0.10552978515625, - "Boredom": 0.1141357421875, "Calmness": 0.115234375, - "Concentration": 0.00444793701171875, "Confusion": - 0.0343017578125, "Contemplation": 0.00812530517578125, - "Contempt": 0.009002685546875, "Contentment": - 0.087158203125, "Craving": 0.00818634033203125, "Desire": - 0.018310546875, "Determination": 0.003238677978515625, - "Disappointment": 0.024169921875, "Disgust": - 0.00702667236328125, "Distress": 0.00936126708984375, - "Doubt": 0.00632476806640625, "Ecstasy": 0.0293731689453125, - "Embarrassment": 0.01800537109375, "Empathic Pain": - 0.0088348388671875, "Entrancement": 0.013397216796875, - "Envy": 0.02557373046875, "Excitement": 0.12109375, "Fear": - 0.004413604736328125, "Guilt": 0.016571044921875, "Horror": - 0.00274658203125, "Interest": 0.2142333984375, "Joy": - 0.29638671875, "Love": 0.16015625, "Nostalgia": - 0.007843017578125, "Pain": 0.007160186767578125, "Pride": - 0.00508880615234375, "Realization": 0.054229736328125, - "Relief": 0.048736572265625, "Romance": 0.026397705078125, - "Sadness": 0.0265350341796875, "Satisfaction": - 0.051361083984375, "Shame": 0.00974273681640625, "Surprise - (negative)": 0.0218963623046875, "Surprise (positive)": - 0.216064453125, "Sympathy": 0.021728515625, "Tiredness": - 0.0173797607421875, "Triumph": 0.004520416259765625} - metadata: >- - {"segments": [{"content": "Hello.", "embedding": - [0.6181640625, 0.1763916015625, -30.921875, 1.2705078125, - 0.927734375, 0.63720703125, 2.865234375, 0.1080322265625, - 0.2978515625, 1.0107421875, 1.34375, 0.74560546875, - 0.416259765625, 0.99462890625, -0.333740234375, - 0.361083984375, -1.388671875, 1.0107421875, 1.3173828125, - 0.55615234375, 0.541015625, -0.1837158203125, 1.697265625, - 0.228515625, 2.087890625, -0.311767578125, - 0.053680419921875, 1.3349609375, 0.95068359375, - 0.00441741943359375, 0.705078125, 1.8916015625, - -0.939453125, 0.93701171875, -0.28955078125, 1.513671875, - 0.5595703125, 1.0126953125, -0.1624755859375, 1.4072265625, - -0.28857421875, -0.4560546875, -0.1500244140625, - -0.1102294921875, -0.222412109375, 0.8779296875, - 1.275390625, 1.6689453125, 0.80712890625, -0.34814453125, - -0.325439453125, 0.412841796875, 0.81689453125, - 0.55126953125, 1.671875, 0.6611328125, 0.7451171875, - 1.50390625, 1.0224609375, -1.671875, 0.7373046875, - 2.1328125, 2.166015625, 0.41015625, -0.127685546875, - 1.9345703125, -4.2734375, 0.332275390625, 0.26171875, - 0.76708984375, 0.2685546875, 0.468017578125, 1.208984375, - -1.517578125, 1.083984375, 0.84814453125, 1.0244140625, - -0.0072174072265625, 1.34375, 1.0712890625, 1.517578125, - -0.52001953125, 0.59228515625, 0.8154296875, -0.951171875, - -0.07757568359375, 1.3330078125, 1.125, 0.61181640625, - 1.494140625, 0.357421875, 1.1796875, 1.482421875, 0.8046875, - 0.1536865234375, 1.8076171875, 0.68115234375, -15.171875, - 1.2294921875, 0.319091796875, 0.499755859375, 1.5771484375, - 0.94677734375, -0.2490234375, 0.88525390625, 3.47265625, - 0.75927734375, 0.71044921875, 1.2333984375, 1.4169921875, - -0.56640625, -1.8095703125, 1.37109375, 0.428955078125, - 1.89453125, -0.39013671875, 0.1734619140625, 1.5595703125, - -1.2294921875, 2.552734375, 0.58349609375, 0.2156982421875, - -0.00984954833984375, -0.6865234375, -0.0272979736328125, - -0.2264404296875, 2.853515625, 1.3896484375, 0.52978515625, - 0.783203125, 3.0390625, 0.75537109375, 0.219970703125, - 0.384521484375, 0.385986328125, 2.0546875, - -0.10443115234375, 1.5146484375, 1.4296875, 1.9716796875, - 1.1318359375, 0.31591796875, 0.338623046875, 1.654296875, - -0.88037109375, -0.21484375, 1.45703125, 1.0380859375, - -0.52294921875, -0.47802734375, 0.1650390625, 1.2392578125, - -1.138671875, 0.56787109375, 1.318359375, 0.4287109375, - 0.1981201171875, 2.4375, 0.281005859375, 0.89404296875, - -0.1552734375, 0.6474609375, -0.08331298828125, - 0.00740814208984375, -0.045501708984375, -0.578125, - 2.02734375, 0.59228515625, 0.35693359375, 1.2919921875, - 1.22265625, 1.0537109375, 0.145263671875, 1.05859375, - -0.369140625, 0.207275390625, 0.78857421875, 0.599609375, - 0.99072265625, 0.24462890625, 1.26953125, 0.08404541015625, - 1.349609375, 0.73291015625, 1.3212890625, 0.388916015625, - 1.0869140625, 0.9931640625, -1.5673828125, 0.0462646484375, - 0.650390625, 0.253662109375, 0.58251953125, 1.8134765625, - 0.8642578125, 2.591796875, 0.7314453125, 0.85986328125, - 0.5615234375, 0.9296875, 0.04144287109375, 1.66015625, - 1.99609375, 1.171875, 1.181640625, 1.5126953125, - 0.0224456787109375, 0.58349609375, -1.4931640625, - 0.81884765625, 0.732421875, -0.6455078125, -0.62451171875, - 1.7802734375, 0.01526641845703125, -0.423095703125, - 0.461669921875, 4.87890625, 1.2392578125, -0.6953125, - 0.6689453125, 0.62451171875, -1.521484375, 1.7685546875, - 0.810546875, 0.65478515625, 0.26123046875, 1.6396484375, - 0.87548828125, 1.7353515625, 2.046875, 1.5634765625, - 0.69384765625, 1.375, 0.8916015625, 1.0107421875, - 0.1304931640625, 2.009765625, 0.06402587890625, - -0.08428955078125, 0.04351806640625, -1.7529296875, - 2.02734375, 3.521484375, 0.404541015625, 1.6337890625, - -0.276611328125, 0.8837890625, -0.1287841796875, - 0.91064453125, 0.8193359375, 0.701171875, 0.036529541015625, - 1.26171875, 1.0478515625, -0.1422119140625, 1.0634765625, - 0.61083984375, 1.3505859375, 1.208984375, 0.57275390625, - 1.3623046875, 2.267578125, 0.484375, 0.9150390625, - 0.56787109375, -0.70068359375, 0.27587890625, - -0.70654296875, 0.8466796875, 0.57568359375, 1.6162109375, - 0.87939453125, 2.248046875, -0.5458984375, 1.7744140625, - 1.328125, 1.232421875, 0.6806640625, 0.9365234375, - 1.052734375, -1.08984375, 1.8330078125, -0.4033203125, - 1.0673828125, 0.297607421875, 1.5703125, 1.67578125, - 1.34765625, 2.8203125, 2.025390625, -0.48583984375, - 0.7626953125, 0.01007843017578125, 1.435546875, - 0.007205963134765625, 0.05157470703125, -0.9853515625, - 0.26708984375, 1.16796875, 1.2041015625, 1.99609375, - -0.07916259765625, 1.244140625, -0.32080078125, - 0.6748046875, 0.419921875, 1.3212890625, 1.291015625, - 0.599609375, 0.0550537109375, 0.9599609375, 0.93505859375, - 0.111083984375, 1.302734375, 0.0833740234375, 2.244140625, - 1.25390625, 1.6015625, 0.58349609375, 1.7568359375, - -0.263427734375, -0.019866943359375, -0.24658203125, - -0.1871337890625, 0.927734375, 0.62255859375, - 0.275146484375, 0.79541015625, 1.1796875, 1.1767578125, - -0.26123046875, -0.268310546875, 1.8994140625, 1.318359375, - 2.1875, 0.2469482421875, 1.41015625, 0.03973388671875, - 1.2685546875, 1.1025390625, 0.9560546875, 0.865234375, - -1.92578125, 1.154296875, 0.389892578125, 1.130859375, - 0.95947265625, 0.72314453125, 2.244140625, - 0.048553466796875, 0.626953125, 0.42919921875, - 0.82275390625, 0.311767578125, -0.320556640625, - 0.01041412353515625, 0.1483154296875, 0.10809326171875, - -0.3173828125, 1.1337890625, -0.8642578125, 1.4033203125, - 0.048828125, 1.1787109375, 0.98779296875, 1.818359375, - 1.1552734375, 0.6015625, 1.2392578125, -1.2685546875, - 0.39208984375, 0.83251953125, 0.224365234375, - 0.0019989013671875, 0.87548828125, 1.6572265625, - 1.107421875, 0.434814453125, 1.8251953125, 0.442626953125, - 1.2587890625, 0.09320068359375, -0.896484375, 1.8017578125, - 1.451171875, -0.0755615234375, 0.6083984375, 2.06640625, - 0.673828125, -0.33740234375, 0.192138671875, 0.21435546875, - 0.80224609375, -1.490234375, 0.9501953125, 0.86083984375, - -0.40283203125, 4.109375, 2.533203125, 1.2529296875, - 0.8271484375, 0.225830078125, 1.0478515625, -1.9755859375, - 0.841796875, 0.392822265625, 0.525390625, 0.33935546875, - -0.79443359375, 0.71630859375, 0.97998046875, - -0.175537109375, 0.97705078125, 1.705078125, 0.29638671875, - 0.68359375, 0.54150390625, 0.435791015625, 0.99755859375, - -0.369140625, 1.009765625, -0.140380859375, 0.426513671875, - 0.189697265625, 1.8193359375, 1.1201171875, -0.5009765625, - -0.331298828125, 0.759765625, -0.09442138671875, 0.74609375, - -1.947265625, 1.3544921875, -3.935546875, 2.544921875, - 1.359375, 0.1363525390625, 0.79296875, 0.79931640625, - -0.3466796875, 1.1396484375, -0.33447265625, 2.0078125, - -0.241455078125, 0.6318359375, 0.365234375, 0.296142578125, - 0.830078125, 1.0458984375, 0.5830078125, 0.61572265625, - 14.0703125, -2.0078125, -0.381591796875, 1.228515625, - 0.08282470703125, -0.67822265625, -0.04339599609375, - 0.397216796875, 0.1656494140625, 0.137451171875, - 0.244873046875, 1.1611328125, -1.3818359375, 0.8447265625, - 1.171875, 0.36328125, 0.252685546875, 0.1197509765625, - 0.232177734375, -0.020172119140625, 0.64404296875, - -0.01100921630859375, -1.9267578125, 0.222412109375, - 0.56005859375, 1.3046875, 1.1630859375, 1.197265625, - 1.02734375, 1.6806640625, -0.043731689453125, 1.4697265625, - 0.81201171875, 1.5390625, 1.240234375, -0.7353515625, - 1.828125, 1.115234375, 1.931640625, -0.517578125, - 0.77880859375, 1.0546875, 0.95361328125, 3.42578125, - 0.0160369873046875, 0.875, 0.56005859375, 1.2421875, - 1.986328125, 1.4814453125, 0.0948486328125, 1.115234375, - 0.00665283203125, 2.09375, 0.3544921875, -0.52783203125, - 1.2099609375, 0.45068359375, 0.65625, 0.1112060546875, - 1.0751953125, -0.9521484375, -0.30029296875, 1.4462890625, - 2.046875, 3.212890625, 1.68359375, 1.07421875, - -0.5263671875, 0.74560546875, 1.37890625, 0.15283203125, - 0.2440185546875, 0.62646484375, -0.1280517578125, - 0.7646484375, -0.515625, -0.35693359375, 1.2958984375, - 0.96923828125, 0.58935546875, 1.3701171875, 1.0673828125, - 0.2337646484375, 0.93115234375, 0.66357421875, 6.0, - 1.1025390625, -0.51708984375, -0.38330078125, 0.7197265625, - 0.246826171875, -0.45166015625, 1.9521484375, 0.5546875, - 0.08807373046875, 0.18505859375, 0.8857421875, - -0.57177734375, 0.251708984375, 0.234375, 2.57421875, - 0.9599609375, 0.5029296875, 0.10382080078125, - 0.08331298828125, 0.66748046875, -0.349609375, 1.287109375, - 0.259765625, 2.015625, 2.828125, -0.3095703125, - -0.164306640625, -0.3408203125, 0.486572265625, - 0.8466796875, 1.9130859375, 0.09088134765625, 0.66552734375, - 0.00972747802734375, -0.83154296875, 1.755859375, - 0.654296875, 0.173828125, 0.27587890625, -0.47607421875, - -0.264404296875, 0.7529296875, 0.6533203125, 0.7275390625, - 0.499755859375, 0.833984375, -0.44775390625, -0.05078125, - -0.454833984375, 0.75439453125, 0.68505859375, - 0.210693359375, -0.283935546875, -0.53564453125, - 0.96826171875, 0.861328125, -3.33984375, -0.26171875, - 0.77734375, 0.26513671875, -0.14111328125, -0.042236328125, - -0.84814453125, 0.2137451171875, 0.94921875, 0.65185546875, - -0.5380859375, 0.1529541015625, -0.360595703125, - -0.0333251953125, -0.69189453125, 0.8974609375, 0.7109375, - 0.81494140625, -0.259521484375, 1.1904296875, 0.62158203125, - 1.345703125, 0.89404296875, 0.70556640625, 1.0673828125, - 1.392578125, 0.5068359375, 0.962890625, 0.736328125, - 1.55078125, 0.50390625, -0.398681640625, 2.361328125, - 0.345947265625, -0.61962890625, 0.330078125, 0.75439453125, - -0.673828125, -0.2379150390625, 1.5673828125, 1.369140625, - 0.1119384765625, -0.1834716796875, 1.4599609375, - -0.77587890625, 0.5556640625, 0.09954833984375, - 0.0285186767578125, 0.58935546875, -0.501953125, - 0.212890625, 0.02679443359375, 0.1715087890625, - 0.03466796875, -0.564453125, 2.029296875, 2.45703125, - -0.72216796875, 2.138671875, 0.50830078125, - -0.09356689453125, 0.230224609375, 1.6943359375, - 1.5126953125, 0.39453125, 0.411376953125, 1.07421875, - -0.8046875, 0.51416015625, 0.2271728515625, -0.283447265625, - 0.38427734375, 0.73388671875, 0.6962890625, 1.4990234375, - 0.02813720703125, 0.40478515625, 1.2451171875, 1.1162109375, - -5.5703125, 0.76171875, 0.322021484375, 1.0361328125, - 1.197265625, 0.1163330078125, 0.2425537109375, 1.5595703125, - 1.5791015625, -0.0921630859375, 0.484619140625, - 1.9052734375, 5.31640625, 1.6337890625, 0.95947265625, - -0.1751708984375, 0.466552734375, 0.8330078125, 1.03125, - 0.2044677734375, 0.31298828125, -1.1220703125, 0.5517578125, - 0.93505859375, 0.45166015625, 1.951171875, 0.65478515625, - 1.30859375, 1.0859375, 0.56494140625, 2.322265625, - 0.242919921875, 1.81640625, -0.469970703125, -0.841796875, - 0.90869140625, 1.5361328125, 0.923828125, 1.0595703125, - 0.356689453125, -0.46142578125, 2.134765625, 1.3037109375, - -0.32373046875, -9.2265625, 0.4521484375, 0.88037109375, - -0.53955078125, 0.96484375, 0.7705078125, 0.84521484375, - 1.580078125, -0.1448974609375, 0.7607421875, 1.0166015625, - -0.086669921875, 1.611328125, 0.05938720703125, 0.5078125, - 0.8427734375, 2.431640625, 0.66357421875, 3.203125, - 0.132080078125, 0.461181640625, 0.779296875, 1.9482421875, - 1.8720703125, 0.845703125, -1.3837890625, -0.138916015625, - 0.35546875, 0.2457275390625, 0.75341796875, 1.828125, - 1.4169921875, 0.60791015625, 1.0068359375, 1.109375, - 0.484130859375, -0.302001953125, 0.4951171875, 0.802734375, - 1.9482421875, 0.916015625, 0.1646728515625, 2.599609375, - 1.7177734375, -0.2374267578125, 0.98046875, 0.39306640625, - -1.1396484375, 1.6533203125, 0.375244140625], "scores": - [0.09906005859375, 0.12213134765625, 0.05035400390625, - 0.16552734375, 0.0037384033203125, 0.010101318359375, - 0.058197021484375, 0.10552978515625, 0.1141357421875, - 0.115234375, 0.00444793701171875, 0.00812530517578125, - 0.0343017578125, 0.009002685546875, 0.087158203125, - 0.00818634033203125, 0.003238677978515625, 0.024169921875, - 0.00702667236328125, 0.00936126708984375, - 0.00632476806640625, 0.0293731689453125, 0.01800537109375, - 0.0088348388671875, 0.013397216796875, 0.02557373046875, - 0.12109375, 0.004413604736328125, 0.016571044921875, - 0.00274658203125, 0.2142333984375, 0.29638671875, - 0.16015625, 0.007843017578125, 0.007160186767578125, - 0.00508880615234375, 0.054229736328125, 0.048736572265625, - 0.026397705078125, 0.0265350341796875, 0.051361083984375, - 0.018310546875, 0.00974273681640625, 0.0218963623046875, - 0.216064453125, 0.021728515625, 0.0173797607421875, - 0.004520416259765625], "stoks": [52, 52, 52, 52, 52, 41, 41, - 374, 303, 303, 303, 427], "time": {"begin_ms": 640, - "end_ms": 1140}}]} - - id: 7645a0d1-2e64-410d-83a8-b96040432e9a - chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 - timestamp: 1716244957031 - role: AGENT - type: AGENT_MESSAGE - message_text: Hello! - emotion_features: >- - {"Admiration": 0.044921875, "Adoration": 0.0253753662109375, - "Aesthetic Appreciation": 0.03265380859375, "Amusement": - 0.118408203125, "Anger": 0.06719970703125, "Anxiety": - 0.0411376953125, "Awe": 0.03802490234375, "Awkwardness": - 0.056549072265625, "Boredom": 0.04217529296875, "Calmness": - 0.08709716796875, "Concentration": 0.070556640625, - "Confusion": 0.06964111328125, "Contemplation": - 0.0343017578125, "Contempt": 0.037689208984375, - "Contentment": 0.059417724609375, "Craving": - 0.01132965087890625, "Desire": 0.01406097412109375, - "Determination": 0.1143798828125, "Disappointment": - 0.051177978515625, "Disgust": 0.028594970703125, "Distress": - 0.054901123046875, "Doubt": 0.04638671875, "Ecstasy": - 0.0258026123046875, "Embarrassment": 0.0222015380859375, - "Empathic Pain": 0.015777587890625, "Entrancement": - 0.0160980224609375, "Envy": 0.0163421630859375, - "Excitement": 0.129638671875, "Fear": 0.03125, "Guilt": - 0.01483917236328125, "Horror": 0.0194549560546875, - "Interest": 0.1341552734375, "Joy": 0.0738525390625, "Love": - 0.0216522216796875, "Nostalgia": 0.0210418701171875, "Pain": - 0.020721435546875, "Pride": 0.05499267578125, "Realization": - 0.0728759765625, "Relief": 0.04052734375, "Romance": - 0.0129241943359375, "Sadness": 0.0254669189453125, - "Satisfaction": 0.07159423828125, "Shame": 0.01495361328125, - "Surprise (negative)": 0.05560302734375, "Surprise - (positive)": 0.07965087890625, "Sympathy": - 0.022247314453125, "Tiredness": 0.0194549560546875, - "Triumph": 0.04107666015625} - metadata: "" - source: - openapi: stenographer-openapi.json + This parameter uses zero-based indexing. For example, setting + `page_number` to 0 retrieves the first page of results (items 0-9 + if `page_size` is 10), setting `page_number` to 1 retrieves the + second page (items 10-19), and so on. Defaults to 0, which + retrieves the first page. + ascending_order: + type: optional + docs: >- + Specifies the sorting order of the results based on their creation + date. Set to true for ascending order (chronological, with the + oldest records first) and false for descending order + (reverse-chronological, with the newest records first). Defaults + to true. + response: + docs: Success + type: root.ReturnChatGroupPagedEvents + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 697056f0-6c7e-487d-9bd8-9c19df79f05f + query-parameters: + page_number: 0 + page_size: 3 + ascending_order: true + response: + body: + id: 697056f0-6c7e-487d-9bd8-9c19df79f05f + page_number: 0 + page_size: 3 + total_pages: 1 + pagination_direction: ASC + events_page: + - id: 5d44bdbb-49a3-40fb-871d-32bf7e76efe7 + chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 + timestamp: 1716244940762 + role: SYSTEM + type: SYSTEM_PROMPT + message_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. + emotion_features: '' + metadata: '' + - id: 5976ddf6-d093-4bb9-ba60-8f6c25832dde + chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 + timestamp: 1716244956278 + role: USER + type: USER_MESSAGE + message_text: Hello. + emotion_features: >- + {"Admiration": 0.09906005859375, "Adoration": + 0.12213134765625, "Aesthetic Appreciation": + 0.05035400390625, "Amusement": 0.16552734375, "Anger": + 0.0037384033203125, "Anxiety": 0.010101318359375, "Awe": + 0.058197021484375, "Awkwardness": 0.10552978515625, + "Boredom": 0.1141357421875, "Calmness": 0.115234375, + "Concentration": 0.00444793701171875, "Confusion": + 0.0343017578125, "Contemplation": 0.00812530517578125, + "Contempt": 0.009002685546875, "Contentment": + 0.087158203125, "Craving": 0.00818634033203125, "Desire": + 0.018310546875, "Determination": 0.003238677978515625, + "Disappointment": 0.024169921875, "Disgust": + 0.00702667236328125, "Distress": 0.00936126708984375, + "Doubt": 0.00632476806640625, "Ecstasy": 0.0293731689453125, + "Embarrassment": 0.01800537109375, "Empathic Pain": + 0.0088348388671875, "Entrancement": 0.013397216796875, + "Envy": 0.02557373046875, "Excitement": 0.12109375, "Fear": + 0.004413604736328125, "Guilt": 0.016571044921875, "Horror": + 0.00274658203125, "Interest": 0.2142333984375, "Joy": + 0.29638671875, "Love": 0.16015625, "Nostalgia": + 0.007843017578125, "Pain": 0.007160186767578125, "Pride": + 0.00508880615234375, "Realization": 0.054229736328125, + "Relief": 0.048736572265625, "Romance": 0.026397705078125, + "Sadness": 0.0265350341796875, "Satisfaction": + 0.051361083984375, "Shame": 0.00974273681640625, "Surprise + (negative)": 0.0218963623046875, "Surprise (positive)": + 0.216064453125, "Sympathy": 0.021728515625, "Tiredness": + 0.0173797607421875, "Triumph": 0.004520416259765625} + metadata: >- + {"segments": [{"content": "Hello.", "embedding": + [0.6181640625, 0.1763916015625, -30.921875, 1.2705078125, + 0.927734375, 0.63720703125, 2.865234375, 0.1080322265625, + 0.2978515625, 1.0107421875, 1.34375, 0.74560546875, + 0.416259765625, 0.99462890625, -0.333740234375, + 0.361083984375, -1.388671875, 1.0107421875, 1.3173828125, + 0.55615234375, 0.541015625, -0.1837158203125, 1.697265625, + 0.228515625, 2.087890625, -0.311767578125, + 0.053680419921875, 1.3349609375, 0.95068359375, + 0.00441741943359375, 0.705078125, 1.8916015625, + -0.939453125, 0.93701171875, -0.28955078125, 1.513671875, + 0.5595703125, 1.0126953125, -0.1624755859375, 1.4072265625, + -0.28857421875, -0.4560546875, -0.1500244140625, + -0.1102294921875, -0.222412109375, 0.8779296875, + 1.275390625, 1.6689453125, 0.80712890625, -0.34814453125, + -0.325439453125, 0.412841796875, 0.81689453125, + 0.55126953125, 1.671875, 0.6611328125, 0.7451171875, + 1.50390625, 1.0224609375, -1.671875, 0.7373046875, + 2.1328125, 2.166015625, 0.41015625, -0.127685546875, + 1.9345703125, -4.2734375, 0.332275390625, 0.26171875, + 0.76708984375, 0.2685546875, 0.468017578125, 1.208984375, + -1.517578125, 1.083984375, 0.84814453125, 1.0244140625, + -0.0072174072265625, 1.34375, 1.0712890625, 1.517578125, + -0.52001953125, 0.59228515625, 0.8154296875, -0.951171875, + -0.07757568359375, 1.3330078125, 1.125, 0.61181640625, + 1.494140625, 0.357421875, 1.1796875, 1.482421875, 0.8046875, + 0.1536865234375, 1.8076171875, 0.68115234375, -15.171875, + 1.2294921875, 0.319091796875, 0.499755859375, 1.5771484375, + 0.94677734375, -0.2490234375, 0.88525390625, 3.47265625, + 0.75927734375, 0.71044921875, 1.2333984375, 1.4169921875, + -0.56640625, -1.8095703125, 1.37109375, 0.428955078125, + 1.89453125, -0.39013671875, 0.1734619140625, 1.5595703125, + -1.2294921875, 2.552734375, 0.58349609375, 0.2156982421875, + -0.00984954833984375, -0.6865234375, -0.0272979736328125, + -0.2264404296875, 2.853515625, 1.3896484375, 0.52978515625, + 0.783203125, 3.0390625, 0.75537109375, 0.219970703125, + 0.384521484375, 0.385986328125, 2.0546875, + -0.10443115234375, 1.5146484375, 1.4296875, 1.9716796875, + 1.1318359375, 0.31591796875, 0.338623046875, 1.654296875, + -0.88037109375, -0.21484375, 1.45703125, 1.0380859375, + -0.52294921875, -0.47802734375, 0.1650390625, 1.2392578125, + -1.138671875, 0.56787109375, 1.318359375, 0.4287109375, + 0.1981201171875, 2.4375, 0.281005859375, 0.89404296875, + -0.1552734375, 0.6474609375, -0.08331298828125, + 0.00740814208984375, -0.045501708984375, -0.578125, + 2.02734375, 0.59228515625, 0.35693359375, 1.2919921875, + 1.22265625, 1.0537109375, 0.145263671875, 1.05859375, + -0.369140625, 0.207275390625, 0.78857421875, 0.599609375, + 0.99072265625, 0.24462890625, 1.26953125, 0.08404541015625, + 1.349609375, 0.73291015625, 1.3212890625, 0.388916015625, + 1.0869140625, 0.9931640625, -1.5673828125, 0.0462646484375, + 0.650390625, 0.253662109375, 0.58251953125, 1.8134765625, + 0.8642578125, 2.591796875, 0.7314453125, 0.85986328125, + 0.5615234375, 0.9296875, 0.04144287109375, 1.66015625, + 1.99609375, 1.171875, 1.181640625, 1.5126953125, + 0.0224456787109375, 0.58349609375, -1.4931640625, + 0.81884765625, 0.732421875, -0.6455078125, -0.62451171875, + 1.7802734375, 0.01526641845703125, -0.423095703125, + 0.461669921875, 4.87890625, 1.2392578125, -0.6953125, + 0.6689453125, 0.62451171875, -1.521484375, 1.7685546875, + 0.810546875, 0.65478515625, 0.26123046875, 1.6396484375, + 0.87548828125, 1.7353515625, 2.046875, 1.5634765625, + 0.69384765625, 1.375, 0.8916015625, 1.0107421875, + 0.1304931640625, 2.009765625, 0.06402587890625, + -0.08428955078125, 0.04351806640625, -1.7529296875, + 2.02734375, 3.521484375, 0.404541015625, 1.6337890625, + -0.276611328125, 0.8837890625, -0.1287841796875, + 0.91064453125, 0.8193359375, 0.701171875, 0.036529541015625, + 1.26171875, 1.0478515625, -0.1422119140625, 1.0634765625, + 0.61083984375, 1.3505859375, 1.208984375, 0.57275390625, + 1.3623046875, 2.267578125, 0.484375, 0.9150390625, + 0.56787109375, -0.70068359375, 0.27587890625, + -0.70654296875, 0.8466796875, 0.57568359375, 1.6162109375, + 0.87939453125, 2.248046875, -0.5458984375, 1.7744140625, + 1.328125, 1.232421875, 0.6806640625, 0.9365234375, + 1.052734375, -1.08984375, 1.8330078125, -0.4033203125, + 1.0673828125, 0.297607421875, 1.5703125, 1.67578125, + 1.34765625, 2.8203125, 2.025390625, -0.48583984375, + 0.7626953125, 0.01007843017578125, 1.435546875, + 0.007205963134765625, 0.05157470703125, -0.9853515625, + 0.26708984375, 1.16796875, 1.2041015625, 1.99609375, + -0.07916259765625, 1.244140625, -0.32080078125, + 0.6748046875, 0.419921875, 1.3212890625, 1.291015625, + 0.599609375, 0.0550537109375, 0.9599609375, 0.93505859375, + 0.111083984375, 1.302734375, 0.0833740234375, 2.244140625, + 1.25390625, 1.6015625, 0.58349609375, 1.7568359375, + -0.263427734375, -0.019866943359375, -0.24658203125, + -0.1871337890625, 0.927734375, 0.62255859375, + 0.275146484375, 0.79541015625, 1.1796875, 1.1767578125, + -0.26123046875, -0.268310546875, 1.8994140625, 1.318359375, + 2.1875, 0.2469482421875, 1.41015625, 0.03973388671875, + 1.2685546875, 1.1025390625, 0.9560546875, 0.865234375, + -1.92578125, 1.154296875, 0.389892578125, 1.130859375, + 0.95947265625, 0.72314453125, 2.244140625, + 0.048553466796875, 0.626953125, 0.42919921875, + 0.82275390625, 0.311767578125, -0.320556640625, + 0.01041412353515625, 0.1483154296875, 0.10809326171875, + -0.3173828125, 1.1337890625, -0.8642578125, 1.4033203125, + 0.048828125, 1.1787109375, 0.98779296875, 1.818359375, + 1.1552734375, 0.6015625, 1.2392578125, -1.2685546875, + 0.39208984375, 0.83251953125, 0.224365234375, + 0.0019989013671875, 0.87548828125, 1.6572265625, + 1.107421875, 0.434814453125, 1.8251953125, 0.442626953125, + 1.2587890625, 0.09320068359375, -0.896484375, 1.8017578125, + 1.451171875, -0.0755615234375, 0.6083984375, 2.06640625, + 0.673828125, -0.33740234375, 0.192138671875, 0.21435546875, + 0.80224609375, -1.490234375, 0.9501953125, 0.86083984375, + -0.40283203125, 4.109375, 2.533203125, 1.2529296875, + 0.8271484375, 0.225830078125, 1.0478515625, -1.9755859375, + 0.841796875, 0.392822265625, 0.525390625, 0.33935546875, + -0.79443359375, 0.71630859375, 0.97998046875, + -0.175537109375, 0.97705078125, 1.705078125, 0.29638671875, + 0.68359375, 0.54150390625, 0.435791015625, 0.99755859375, + -0.369140625, 1.009765625, -0.140380859375, 0.426513671875, + 0.189697265625, 1.8193359375, 1.1201171875, -0.5009765625, + -0.331298828125, 0.759765625, -0.09442138671875, 0.74609375, + -1.947265625, 1.3544921875, -3.935546875, 2.544921875, + 1.359375, 0.1363525390625, 0.79296875, 0.79931640625, + -0.3466796875, 1.1396484375, -0.33447265625, 2.0078125, + -0.241455078125, 0.6318359375, 0.365234375, 0.296142578125, + 0.830078125, 1.0458984375, 0.5830078125, 0.61572265625, + 14.0703125, -2.0078125, -0.381591796875, 1.228515625, + 0.08282470703125, -0.67822265625, -0.04339599609375, + 0.397216796875, 0.1656494140625, 0.137451171875, + 0.244873046875, 1.1611328125, -1.3818359375, 0.8447265625, + 1.171875, 0.36328125, 0.252685546875, 0.1197509765625, + 0.232177734375, -0.020172119140625, 0.64404296875, + -0.01100921630859375, -1.9267578125, 0.222412109375, + 0.56005859375, 1.3046875, 1.1630859375, 1.197265625, + 1.02734375, 1.6806640625, -0.043731689453125, 1.4697265625, + 0.81201171875, 1.5390625, 1.240234375, -0.7353515625, + 1.828125, 1.115234375, 1.931640625, -0.517578125, + 0.77880859375, 1.0546875, 0.95361328125, 3.42578125, + 0.0160369873046875, 0.875, 0.56005859375, 1.2421875, + 1.986328125, 1.4814453125, 0.0948486328125, 1.115234375, + 0.00665283203125, 2.09375, 0.3544921875, -0.52783203125, + 1.2099609375, 0.45068359375, 0.65625, 0.1112060546875, + 1.0751953125, -0.9521484375, -0.30029296875, 1.4462890625, + 2.046875, 3.212890625, 1.68359375, 1.07421875, + -0.5263671875, 0.74560546875, 1.37890625, 0.15283203125, + 0.2440185546875, 0.62646484375, -0.1280517578125, + 0.7646484375, -0.515625, -0.35693359375, 1.2958984375, + 0.96923828125, 0.58935546875, 1.3701171875, 1.0673828125, + 0.2337646484375, 0.93115234375, 0.66357421875, 6.0, + 1.1025390625, -0.51708984375, -0.38330078125, 0.7197265625, + 0.246826171875, -0.45166015625, 1.9521484375, 0.5546875, + 0.08807373046875, 0.18505859375, 0.8857421875, + -0.57177734375, 0.251708984375, 0.234375, 2.57421875, + 0.9599609375, 0.5029296875, 0.10382080078125, + 0.08331298828125, 0.66748046875, -0.349609375, 1.287109375, + 0.259765625, 2.015625, 2.828125, -0.3095703125, + -0.164306640625, -0.3408203125, 0.486572265625, + 0.8466796875, 1.9130859375, 0.09088134765625, 0.66552734375, + 0.00972747802734375, -0.83154296875, 1.755859375, + 0.654296875, 0.173828125, 0.27587890625, -0.47607421875, + -0.264404296875, 0.7529296875, 0.6533203125, 0.7275390625, + 0.499755859375, 0.833984375, -0.44775390625, -0.05078125, + -0.454833984375, 0.75439453125, 0.68505859375, + 0.210693359375, -0.283935546875, -0.53564453125, + 0.96826171875, 0.861328125, -3.33984375, -0.26171875, + 0.77734375, 0.26513671875, -0.14111328125, -0.042236328125, + -0.84814453125, 0.2137451171875, 0.94921875, 0.65185546875, + -0.5380859375, 0.1529541015625, -0.360595703125, + -0.0333251953125, -0.69189453125, 0.8974609375, 0.7109375, + 0.81494140625, -0.259521484375, 1.1904296875, 0.62158203125, + 1.345703125, 0.89404296875, 0.70556640625, 1.0673828125, + 1.392578125, 0.5068359375, 0.962890625, 0.736328125, + 1.55078125, 0.50390625, -0.398681640625, 2.361328125, + 0.345947265625, -0.61962890625, 0.330078125, 0.75439453125, + -0.673828125, -0.2379150390625, 1.5673828125, 1.369140625, + 0.1119384765625, -0.1834716796875, 1.4599609375, + -0.77587890625, 0.5556640625, 0.09954833984375, + 0.0285186767578125, 0.58935546875, -0.501953125, + 0.212890625, 0.02679443359375, 0.1715087890625, + 0.03466796875, -0.564453125, 2.029296875, 2.45703125, + -0.72216796875, 2.138671875, 0.50830078125, + -0.09356689453125, 0.230224609375, 1.6943359375, + 1.5126953125, 0.39453125, 0.411376953125, 1.07421875, + -0.8046875, 0.51416015625, 0.2271728515625, -0.283447265625, + 0.38427734375, 0.73388671875, 0.6962890625, 1.4990234375, + 0.02813720703125, 0.40478515625, 1.2451171875, 1.1162109375, + -5.5703125, 0.76171875, 0.322021484375, 1.0361328125, + 1.197265625, 0.1163330078125, 0.2425537109375, 1.5595703125, + 1.5791015625, -0.0921630859375, 0.484619140625, + 1.9052734375, 5.31640625, 1.6337890625, 0.95947265625, + -0.1751708984375, 0.466552734375, 0.8330078125, 1.03125, + 0.2044677734375, 0.31298828125, -1.1220703125, 0.5517578125, + 0.93505859375, 0.45166015625, 1.951171875, 0.65478515625, + 1.30859375, 1.0859375, 0.56494140625, 2.322265625, + 0.242919921875, 1.81640625, -0.469970703125, -0.841796875, + 0.90869140625, 1.5361328125, 0.923828125, 1.0595703125, + 0.356689453125, -0.46142578125, 2.134765625, 1.3037109375, + -0.32373046875, -9.2265625, 0.4521484375, 0.88037109375, + -0.53955078125, 0.96484375, 0.7705078125, 0.84521484375, + 1.580078125, -0.1448974609375, 0.7607421875, 1.0166015625, + -0.086669921875, 1.611328125, 0.05938720703125, 0.5078125, + 0.8427734375, 2.431640625, 0.66357421875, 3.203125, + 0.132080078125, 0.461181640625, 0.779296875, 1.9482421875, + 1.8720703125, 0.845703125, -1.3837890625, -0.138916015625, + 0.35546875, 0.2457275390625, 0.75341796875, 1.828125, + 1.4169921875, 0.60791015625, 1.0068359375, 1.109375, + 0.484130859375, -0.302001953125, 0.4951171875, 0.802734375, + 1.9482421875, 0.916015625, 0.1646728515625, 2.599609375, + 1.7177734375, -0.2374267578125, 0.98046875, 0.39306640625, + -1.1396484375, 1.6533203125, 0.375244140625], "scores": + [0.09906005859375, 0.12213134765625, 0.05035400390625, + 0.16552734375, 0.0037384033203125, 0.010101318359375, + 0.058197021484375, 0.10552978515625, 0.1141357421875, + 0.115234375, 0.00444793701171875, 0.00812530517578125, + 0.0343017578125, 0.009002685546875, 0.087158203125, + 0.00818634033203125, 0.003238677978515625, 0.024169921875, + 0.00702667236328125, 0.00936126708984375, + 0.00632476806640625, 0.0293731689453125, 0.01800537109375, + 0.0088348388671875, 0.013397216796875, 0.02557373046875, + 0.12109375, 0.004413604736328125, 0.016571044921875, + 0.00274658203125, 0.2142333984375, 0.29638671875, + 0.16015625, 0.007843017578125, 0.007160186767578125, + 0.00508880615234375, 0.054229736328125, 0.048736572265625, + 0.026397705078125, 0.0265350341796875, 0.051361083984375, + 0.018310546875, 0.00974273681640625, 0.0218963623046875, + 0.216064453125, 0.021728515625, 0.0173797607421875, + 0.004520416259765625], "stoks": [52, 52, 52, 52, 52, 41, 41, + 374, 303, 303, 303, 427], "time": {"begin_ms": 640, + "end_ms": 1140}}]} + - id: 7645a0d1-2e64-410d-83a8-b96040432e9a + chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 + timestamp: 1716244957031 + role: AGENT + type: AGENT_MESSAGE + message_text: Hello! + emotion_features: >- + {"Admiration": 0.044921875, "Adoration": 0.0253753662109375, + "Aesthetic Appreciation": 0.03265380859375, "Amusement": + 0.118408203125, "Anger": 0.06719970703125, "Anxiety": + 0.0411376953125, "Awe": 0.03802490234375, "Awkwardness": + 0.056549072265625, "Boredom": 0.04217529296875, "Calmness": + 0.08709716796875, "Concentration": 0.070556640625, + "Confusion": 0.06964111328125, "Contemplation": + 0.0343017578125, "Contempt": 0.037689208984375, + "Contentment": 0.059417724609375, "Craving": + 0.01132965087890625, "Desire": 0.01406097412109375, + "Determination": 0.1143798828125, "Disappointment": + 0.051177978515625, "Disgust": 0.028594970703125, "Distress": + 0.054901123046875, "Doubt": 0.04638671875, "Ecstasy": + 0.0258026123046875, "Embarrassment": 0.0222015380859375, + "Empathic Pain": 0.015777587890625, "Entrancement": + 0.0160980224609375, "Envy": 0.0163421630859375, + "Excitement": 0.129638671875, "Fear": 0.03125, "Guilt": + 0.01483917236328125, "Horror": 0.0194549560546875, + "Interest": 0.1341552734375, "Joy": 0.0738525390625, "Love": + 0.0216522216796875, "Nostalgia": 0.0210418701171875, "Pain": + 0.020721435546875, "Pride": 0.05499267578125, "Realization": + 0.0728759765625, "Relief": 0.04052734375, "Romance": + 0.0129241943359375, "Sadness": 0.0254669189453125, + "Satisfaction": 0.07159423828125, "Shame": 0.01495361328125, + "Surprise (negative)": 0.05560302734375, "Surprise + (positive)": 0.07965087890625, "Sympathy": + 0.022247314453125, "Tiredness": 0.0194549560546875, + "Triumph": 0.04107666015625} + metadata: '' + get-audio: + path: /v0/evi/chat_groups/{id}/audio + method: GET + auth: true + path-parameters: + id: + type: string + docs: Identifier for a chat. Formatted as a UUID. + display-name: Get chat group audio + request: + name: ChatGroupsGetAudioRequest + query-parameters: + page_number: + type: optional + docs: >- + Specifies the page number to retrieve, enabling pagination. + + + This parameter uses zero-based indexing. For example, setting + `page_number` to 0 retrieves the first page of results (items 0-9 + if `page_size` is 10), setting `page_number` to 1 retrieves the + second page (items 10-19), and so on. Defaults to 0, which + retrieves the first page. + page_size: + type: optional + docs: >- + Specifies the maximum number of results to include per page, + enabling pagination. The value must be between 1 and 100, + inclusive. + + + For example, if `page_size` is set to 10, each page will include + up to 10 items. Defaults to 10. + ascending_order: + type: optional + docs: >- + Boolean to indicate if the results should be paginated in + chronological order or reverse-chronological order. Defaults to + true. + response: + docs: Success + type: root.ReturnChatPagedEvents + errors: + - root.BadRequestError + examples: + - path-parameters: + id: id + response: + body: + id: id + chat_group_id: chat_group_id + status: ACTIVE + start_timestamp: 1000000 + end_timestamp: 1000000 + pagination_direction: ASC + events_page: + - id: id + chat_id: chat_id + timestamp: 1000000 + role: USER + type: SYSTEM_PROMPT + message_text: message_text + emotion_features: emotion_features + metadata: metadata + metadata: metadata + page_number: 1 + page_size: 1 + total_pages: 1 + config: + id: id + version: 1 + source: + openapi: stenographer-openapi.json diff --git a/.mock/definition/empathic-voice/chats.yml b/.mock/definition/empathic-voice/chats.yml index 1486a279..800d80f6 100644 --- a/.mock/definition/empathic-voice/chats.yml +++ b/.mock/definition/empathic-voice/chats.yml @@ -1,459 +1,500 @@ imports: - root: __package__.yml + root: __package__.yml service: - auth: false - base-path: "" - endpoints: - list-chats: - path: /v0/evi/chats - method: GET - auth: true - docs: Fetches a paginated list of **Chats**. - pagination: - offset: $request.page_number - results: $response.chats_page - display-name: List chats - request: - name: ChatsListChatsRequest - query-parameters: - page_number: - type: optional - docs: >- - Specifies the page number to retrieve, enabling pagination. + auth: false + base-path: '' + endpoints: + list-chats: + path: /v0/evi/chats + method: GET + auth: true + docs: Fetches a paginated list of **Chats**. + pagination: + offset: $request.page_number + results: $response.chats_page + display-name: List chats + request: + name: ChatsListChatsRequest + query-parameters: + page_number: + type: optional + docs: >- + Specifies the page number to retrieve, enabling pagination. - This parameter uses zero-based indexing. For example, setting - `page_number` to 0 retrieves the first page of results (items 0-9 - if `page_size` is 10), setting `page_number` to 1 retrieves the - second page (items 10-19), and so on. Defaults to 0, which - retrieves the first page. - page_size: - type: optional - docs: >- - Specifies the maximum number of results to include per page, - enabling pagination. The value must be between 1 and 100, - inclusive. + This parameter uses zero-based indexing. For example, setting + `page_number` to 0 retrieves the first page of results (items 0-9 + if `page_size` is 10), setting `page_number` to 1 retrieves the + second page (items 10-19), and so on. Defaults to 0, which + retrieves the first page. + page_size: + type: optional + docs: >- + Specifies the maximum number of results to include per page, + enabling pagination. The value must be between 1 and 100, + inclusive. - For example, if `page_size` is set to 10, each page will include - up to 10 items. Defaults to 10. - ascending_order: - type: optional - docs: >- - Specifies the sorting order of the results based on their creation - date. Set to true for ascending order (chronological, with the - oldest records first) and false for descending order - (reverse-chronological, with the newest records first). Defaults - to true. - response: - docs: Success - type: root.ReturnPagedChats - errors: - - root.BadRequestError - examples: - - query-parameters: - page_number: 0 - page_size: 1 - ascending_order: true - response: - body: - page_number: 0 - page_size: 1 - total_pages: 1 - pagination_direction: ASC - chats_page: - - id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 - chat_group_id: 9fc18597-3567-42d5-94d6-935bde84bf2f - status: USER_ENDED - start_timestamp: 1716244940648 - end_timestamp: 1716244958546 - event_count: 3 - metadata: "" - config: - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 - version: 0 - list-chat-events: - path: /v0/evi/chats/{id} - method: GET - auth: true - docs: Fetches a paginated list of **Chat** events. - pagination: - offset: $request.page_number - results: $response.events_page - path-parameters: - id: - type: string - docs: Identifier for a Chat. Formatted as a UUID. - display-name: List chat events - request: - name: ChatsListChatEventsRequest - query-parameters: - page_size: - type: optional - docs: >- - Specifies the maximum number of results to include per page, - enabling pagination. The value must be between 1 and 100, - inclusive. + For example, if `page_size` is set to 10, each page will include + up to 10 items. Defaults to 10. + ascending_order: + type: optional + docs: >- + Specifies the sorting order of the results based on their creation + date. Set to true for ascending order (chronological, with the + oldest records first) and false for descending order + (reverse-chronological, with the newest records first). Defaults + to true. + response: + docs: Success + type: root.ReturnPagedChats + errors: + - root.BadRequestError + examples: + - query-parameters: + page_number: 0 + page_size: 1 + ascending_order: true + response: + body: + page_number: 0 + page_size: 1 + total_pages: 1 + pagination_direction: ASC + chats_page: + - id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 + chat_group_id: 9fc18597-3567-42d5-94d6-935bde84bf2f + status: USER_ENDED + start_timestamp: 1716244940648 + end_timestamp: 1716244958546 + event_count: 3 + metadata: '' + config: + id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + version: 0 + list-chat-events: + path: /v0/evi/chats/{id} + method: GET + auth: true + docs: Fetches a paginated list of **Chat** events. + pagination: + offset: $request.page_number + results: $response.events_page + path-parameters: + id: + type: string + docs: Identifier for a Chat. Formatted as a UUID. + display-name: List chat events + request: + name: ChatsListChatEventsRequest + query-parameters: + page_size: + type: optional + docs: >- + Specifies the maximum number of results to include per page, + enabling pagination. The value must be between 1 and 100, + inclusive. - For example, if `page_size` is set to 10, each page will include - up to 10 items. Defaults to 10. - page_number: - type: optional - docs: >- - Specifies the page number to retrieve, enabling pagination. + For example, if `page_size` is set to 10, each page will include + up to 10 items. Defaults to 10. + page_number: + type: optional + docs: >- + Specifies the page number to retrieve, enabling pagination. - This parameter uses zero-based indexing. For example, setting - `page_number` to 0 retrieves the first page of results (items 0-9 - if `page_size` is 10), setting `page_number` to 1 retrieves the - second page (items 10-19), and so on. Defaults to 0, which - retrieves the first page. - ascending_order: - type: optional - docs: >- - Specifies the sorting order of the results based on their creation - date. Set to true for ascending order (chronological, with the - oldest records first) and false for descending order - (reverse-chronological, with the newest records first). Defaults - to true. - response: - docs: Success - type: root.ReturnChatPagedEvents - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 - query-parameters: - page_number: 0 - page_size: 3 - ascending_order: true - response: - body: - id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 - chat_group_id: 9fc18597-3567-42d5-94d6-935bde84bf2f - status: USER_ENDED - start_timestamp: 1716244940648 - pagination_direction: ASC - events_page: - - id: 5d44bdbb-49a3-40fb-871d-32bf7e76efe7 - chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 - timestamp: 1716244940762 - role: SYSTEM - type: SYSTEM_PROMPT - message_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. - emotion_features: "" - metadata: "" - - id: 5976ddf6-d093-4bb9-ba60-8f6c25832dde - chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 - timestamp: 1716244956278 - role: USER - type: USER_MESSAGE - message_text: Hello. - emotion_features: >- - {"Admiration": 0.09906005859375, "Adoration": - 0.12213134765625, "Aesthetic Appreciation": - 0.05035400390625, "Amusement": 0.16552734375, "Anger": - 0.0037384033203125, "Anxiety": 0.010101318359375, "Awe": - 0.058197021484375, "Awkwardness": 0.10552978515625, - "Boredom": 0.1141357421875, "Calmness": 0.115234375, - "Concentration": 0.00444793701171875, "Confusion": - 0.0343017578125, "Contemplation": 0.00812530517578125, - "Contempt": 0.009002685546875, "Contentment": - 0.087158203125, "Craving": 0.00818634033203125, "Desire": - 0.018310546875, "Determination": 0.003238677978515625, - "Disappointment": 0.024169921875, "Disgust": - 0.00702667236328125, "Distress": 0.00936126708984375, - "Doubt": 0.00632476806640625, "Ecstasy": 0.0293731689453125, - "Embarrassment": 0.01800537109375, "Empathic Pain": - 0.0088348388671875, "Entrancement": 0.013397216796875, - "Envy": 0.02557373046875, "Excitement": 0.12109375, "Fear": - 0.004413604736328125, "Guilt": 0.016571044921875, "Horror": - 0.00274658203125, "Interest": 0.2142333984375, "Joy": - 0.29638671875, "Love": 0.16015625, "Nostalgia": - 0.007843017578125, "Pain": 0.007160186767578125, "Pride": - 0.00508880615234375, "Realization": 0.054229736328125, - "Relief": 0.048736572265625, "Romance": 0.026397705078125, - "Sadness": 0.0265350341796875, "Satisfaction": - 0.051361083984375, "Shame": 0.00974273681640625, "Surprise - (negative)": 0.0218963623046875, "Surprise (positive)": - 0.216064453125, "Sympathy": 0.021728515625, "Tiredness": - 0.0173797607421875, "Triumph": 0.004520416259765625} - metadata: >- - {"segments": [{"content": "Hello.", "embedding": - [0.6181640625, 0.1763916015625, -30.921875, 1.2705078125, - 0.927734375, 0.63720703125, 2.865234375, 0.1080322265625, - 0.2978515625, 1.0107421875, 1.34375, 0.74560546875, - 0.416259765625, 0.99462890625, -0.333740234375, - 0.361083984375, -1.388671875, 1.0107421875, 1.3173828125, - 0.55615234375, 0.541015625, -0.1837158203125, 1.697265625, - 0.228515625, 2.087890625, -0.311767578125, - 0.053680419921875, 1.3349609375, 0.95068359375, - 0.00441741943359375, 0.705078125, 1.8916015625, - -0.939453125, 0.93701171875, -0.28955078125, 1.513671875, - 0.5595703125, 1.0126953125, -0.1624755859375, 1.4072265625, - -0.28857421875, -0.4560546875, -0.1500244140625, - -0.1102294921875, -0.222412109375, 0.8779296875, - 1.275390625, 1.6689453125, 0.80712890625, -0.34814453125, - -0.325439453125, 0.412841796875, 0.81689453125, - 0.55126953125, 1.671875, 0.6611328125, 0.7451171875, - 1.50390625, 1.0224609375, -1.671875, 0.7373046875, - 2.1328125, 2.166015625, 0.41015625, -0.127685546875, - 1.9345703125, -4.2734375, 0.332275390625, 0.26171875, - 0.76708984375, 0.2685546875, 0.468017578125, 1.208984375, - -1.517578125, 1.083984375, 0.84814453125, 1.0244140625, - -0.0072174072265625, 1.34375, 1.0712890625, 1.517578125, - -0.52001953125, 0.59228515625, 0.8154296875, -0.951171875, - -0.07757568359375, 1.3330078125, 1.125, 0.61181640625, - 1.494140625, 0.357421875, 1.1796875, 1.482421875, 0.8046875, - 0.1536865234375, 1.8076171875, 0.68115234375, -15.171875, - 1.2294921875, 0.319091796875, 0.499755859375, 1.5771484375, - 0.94677734375, -0.2490234375, 0.88525390625, 3.47265625, - 0.75927734375, 0.71044921875, 1.2333984375, 1.4169921875, - -0.56640625, -1.8095703125, 1.37109375, 0.428955078125, - 1.89453125, -0.39013671875, 0.1734619140625, 1.5595703125, - -1.2294921875, 2.552734375, 0.58349609375, 0.2156982421875, - -0.00984954833984375, -0.6865234375, -0.0272979736328125, - -0.2264404296875, 2.853515625, 1.3896484375, 0.52978515625, - 0.783203125, 3.0390625, 0.75537109375, 0.219970703125, - 0.384521484375, 0.385986328125, 2.0546875, - -0.10443115234375, 1.5146484375, 1.4296875, 1.9716796875, - 1.1318359375, 0.31591796875, 0.338623046875, 1.654296875, - -0.88037109375, -0.21484375, 1.45703125, 1.0380859375, - -0.52294921875, -0.47802734375, 0.1650390625, 1.2392578125, - -1.138671875, 0.56787109375, 1.318359375, 0.4287109375, - 0.1981201171875, 2.4375, 0.281005859375, 0.89404296875, - -0.1552734375, 0.6474609375, -0.08331298828125, - 0.00740814208984375, -0.045501708984375, -0.578125, - 2.02734375, 0.59228515625, 0.35693359375, 1.2919921875, - 1.22265625, 1.0537109375, 0.145263671875, 1.05859375, - -0.369140625, 0.207275390625, 0.78857421875, 0.599609375, - 0.99072265625, 0.24462890625, 1.26953125, 0.08404541015625, - 1.349609375, 0.73291015625, 1.3212890625, 0.388916015625, - 1.0869140625, 0.9931640625, -1.5673828125, 0.0462646484375, - 0.650390625, 0.253662109375, 0.58251953125, 1.8134765625, - 0.8642578125, 2.591796875, 0.7314453125, 0.85986328125, - 0.5615234375, 0.9296875, 0.04144287109375, 1.66015625, - 1.99609375, 1.171875, 1.181640625, 1.5126953125, - 0.0224456787109375, 0.58349609375, -1.4931640625, - 0.81884765625, 0.732421875, -0.6455078125, -0.62451171875, - 1.7802734375, 0.01526641845703125, -0.423095703125, - 0.461669921875, 4.87890625, 1.2392578125, -0.6953125, - 0.6689453125, 0.62451171875, -1.521484375, 1.7685546875, - 0.810546875, 0.65478515625, 0.26123046875, 1.6396484375, - 0.87548828125, 1.7353515625, 2.046875, 1.5634765625, - 0.69384765625, 1.375, 0.8916015625, 1.0107421875, - 0.1304931640625, 2.009765625, 0.06402587890625, - -0.08428955078125, 0.04351806640625, -1.7529296875, - 2.02734375, 3.521484375, 0.404541015625, 1.6337890625, - -0.276611328125, 0.8837890625, -0.1287841796875, - 0.91064453125, 0.8193359375, 0.701171875, 0.036529541015625, - 1.26171875, 1.0478515625, -0.1422119140625, 1.0634765625, - 0.61083984375, 1.3505859375, 1.208984375, 0.57275390625, - 1.3623046875, 2.267578125, 0.484375, 0.9150390625, - 0.56787109375, -0.70068359375, 0.27587890625, - -0.70654296875, 0.8466796875, 0.57568359375, 1.6162109375, - 0.87939453125, 2.248046875, -0.5458984375, 1.7744140625, - 1.328125, 1.232421875, 0.6806640625, 0.9365234375, - 1.052734375, -1.08984375, 1.8330078125, -0.4033203125, - 1.0673828125, 0.297607421875, 1.5703125, 1.67578125, - 1.34765625, 2.8203125, 2.025390625, -0.48583984375, - 0.7626953125, 0.01007843017578125, 1.435546875, - 0.007205963134765625, 0.05157470703125, -0.9853515625, - 0.26708984375, 1.16796875, 1.2041015625, 1.99609375, - -0.07916259765625, 1.244140625, -0.32080078125, - 0.6748046875, 0.419921875, 1.3212890625, 1.291015625, - 0.599609375, 0.0550537109375, 0.9599609375, 0.93505859375, - 0.111083984375, 1.302734375, 0.0833740234375, 2.244140625, - 1.25390625, 1.6015625, 0.58349609375, 1.7568359375, - -0.263427734375, -0.019866943359375, -0.24658203125, - -0.1871337890625, 0.927734375, 0.62255859375, - 0.275146484375, 0.79541015625, 1.1796875, 1.1767578125, - -0.26123046875, -0.268310546875, 1.8994140625, 1.318359375, - 2.1875, 0.2469482421875, 1.41015625, 0.03973388671875, - 1.2685546875, 1.1025390625, 0.9560546875, 0.865234375, - -1.92578125, 1.154296875, 0.389892578125, 1.130859375, - 0.95947265625, 0.72314453125, 2.244140625, - 0.048553466796875, 0.626953125, 0.42919921875, - 0.82275390625, 0.311767578125, -0.320556640625, - 0.01041412353515625, 0.1483154296875, 0.10809326171875, - -0.3173828125, 1.1337890625, -0.8642578125, 1.4033203125, - 0.048828125, 1.1787109375, 0.98779296875, 1.818359375, - 1.1552734375, 0.6015625, 1.2392578125, -1.2685546875, - 0.39208984375, 0.83251953125, 0.224365234375, - 0.0019989013671875, 0.87548828125, 1.6572265625, - 1.107421875, 0.434814453125, 1.8251953125, 0.442626953125, - 1.2587890625, 0.09320068359375, -0.896484375, 1.8017578125, - 1.451171875, -0.0755615234375, 0.6083984375, 2.06640625, - 0.673828125, -0.33740234375, 0.192138671875, 0.21435546875, - 0.80224609375, -1.490234375, 0.9501953125, 0.86083984375, - -0.40283203125, 4.109375, 2.533203125, 1.2529296875, - 0.8271484375, 0.225830078125, 1.0478515625, -1.9755859375, - 0.841796875, 0.392822265625, 0.525390625, 0.33935546875, - -0.79443359375, 0.71630859375, 0.97998046875, - -0.175537109375, 0.97705078125, 1.705078125, 0.29638671875, - 0.68359375, 0.54150390625, 0.435791015625, 0.99755859375, - -0.369140625, 1.009765625, -0.140380859375, 0.426513671875, - 0.189697265625, 1.8193359375, 1.1201171875, -0.5009765625, - -0.331298828125, 0.759765625, -0.09442138671875, 0.74609375, - -1.947265625, 1.3544921875, -3.935546875, 2.544921875, - 1.359375, 0.1363525390625, 0.79296875, 0.79931640625, - -0.3466796875, 1.1396484375, -0.33447265625, 2.0078125, - -0.241455078125, 0.6318359375, 0.365234375, 0.296142578125, - 0.830078125, 1.0458984375, 0.5830078125, 0.61572265625, - 14.0703125, -2.0078125, -0.381591796875, 1.228515625, - 0.08282470703125, -0.67822265625, -0.04339599609375, - 0.397216796875, 0.1656494140625, 0.137451171875, - 0.244873046875, 1.1611328125, -1.3818359375, 0.8447265625, - 1.171875, 0.36328125, 0.252685546875, 0.1197509765625, - 0.232177734375, -0.020172119140625, 0.64404296875, - -0.01100921630859375, -1.9267578125, 0.222412109375, - 0.56005859375, 1.3046875, 1.1630859375, 1.197265625, - 1.02734375, 1.6806640625, -0.043731689453125, 1.4697265625, - 0.81201171875, 1.5390625, 1.240234375, -0.7353515625, - 1.828125, 1.115234375, 1.931640625, -0.517578125, - 0.77880859375, 1.0546875, 0.95361328125, 3.42578125, - 0.0160369873046875, 0.875, 0.56005859375, 1.2421875, - 1.986328125, 1.4814453125, 0.0948486328125, 1.115234375, - 0.00665283203125, 2.09375, 0.3544921875, -0.52783203125, - 1.2099609375, 0.45068359375, 0.65625, 0.1112060546875, - 1.0751953125, -0.9521484375, -0.30029296875, 1.4462890625, - 2.046875, 3.212890625, 1.68359375, 1.07421875, - -0.5263671875, 0.74560546875, 1.37890625, 0.15283203125, - 0.2440185546875, 0.62646484375, -0.1280517578125, - 0.7646484375, -0.515625, -0.35693359375, 1.2958984375, - 0.96923828125, 0.58935546875, 1.3701171875, 1.0673828125, - 0.2337646484375, 0.93115234375, 0.66357421875, 6.0, - 1.1025390625, -0.51708984375, -0.38330078125, 0.7197265625, - 0.246826171875, -0.45166015625, 1.9521484375, 0.5546875, - 0.08807373046875, 0.18505859375, 0.8857421875, - -0.57177734375, 0.251708984375, 0.234375, 2.57421875, - 0.9599609375, 0.5029296875, 0.10382080078125, - 0.08331298828125, 0.66748046875, -0.349609375, 1.287109375, - 0.259765625, 2.015625, 2.828125, -0.3095703125, - -0.164306640625, -0.3408203125, 0.486572265625, - 0.8466796875, 1.9130859375, 0.09088134765625, 0.66552734375, - 0.00972747802734375, -0.83154296875, 1.755859375, - 0.654296875, 0.173828125, 0.27587890625, -0.47607421875, - -0.264404296875, 0.7529296875, 0.6533203125, 0.7275390625, - 0.499755859375, 0.833984375, -0.44775390625, -0.05078125, - -0.454833984375, 0.75439453125, 0.68505859375, - 0.210693359375, -0.283935546875, -0.53564453125, - 0.96826171875, 0.861328125, -3.33984375, -0.26171875, - 0.77734375, 0.26513671875, -0.14111328125, -0.042236328125, - -0.84814453125, 0.2137451171875, 0.94921875, 0.65185546875, - -0.5380859375, 0.1529541015625, -0.360595703125, - -0.0333251953125, -0.69189453125, 0.8974609375, 0.7109375, - 0.81494140625, -0.259521484375, 1.1904296875, 0.62158203125, - 1.345703125, 0.89404296875, 0.70556640625, 1.0673828125, - 1.392578125, 0.5068359375, 0.962890625, 0.736328125, - 1.55078125, 0.50390625, -0.398681640625, 2.361328125, - 0.345947265625, -0.61962890625, 0.330078125, 0.75439453125, - -0.673828125, -0.2379150390625, 1.5673828125, 1.369140625, - 0.1119384765625, -0.1834716796875, 1.4599609375, - -0.77587890625, 0.5556640625, 0.09954833984375, - 0.0285186767578125, 0.58935546875, -0.501953125, - 0.212890625, 0.02679443359375, 0.1715087890625, - 0.03466796875, -0.564453125, 2.029296875, 2.45703125, - -0.72216796875, 2.138671875, 0.50830078125, - -0.09356689453125, 0.230224609375, 1.6943359375, - 1.5126953125, 0.39453125, 0.411376953125, 1.07421875, - -0.8046875, 0.51416015625, 0.2271728515625, -0.283447265625, - 0.38427734375, 0.73388671875, 0.6962890625, 1.4990234375, - 0.02813720703125, 0.40478515625, 1.2451171875, 1.1162109375, - -5.5703125, 0.76171875, 0.322021484375, 1.0361328125, - 1.197265625, 0.1163330078125, 0.2425537109375, 1.5595703125, - 1.5791015625, -0.0921630859375, 0.484619140625, - 1.9052734375, 5.31640625, 1.6337890625, 0.95947265625, - -0.1751708984375, 0.466552734375, 0.8330078125, 1.03125, - 0.2044677734375, 0.31298828125, -1.1220703125, 0.5517578125, - 0.93505859375, 0.45166015625, 1.951171875, 0.65478515625, - 1.30859375, 1.0859375, 0.56494140625, 2.322265625, - 0.242919921875, 1.81640625, -0.469970703125, -0.841796875, - 0.90869140625, 1.5361328125, 0.923828125, 1.0595703125, - 0.356689453125, -0.46142578125, 2.134765625, 1.3037109375, - -0.32373046875, -9.2265625, 0.4521484375, 0.88037109375, - -0.53955078125, 0.96484375, 0.7705078125, 0.84521484375, - 1.580078125, -0.1448974609375, 0.7607421875, 1.0166015625, - -0.086669921875, 1.611328125, 0.05938720703125, 0.5078125, - 0.8427734375, 2.431640625, 0.66357421875, 3.203125, - 0.132080078125, 0.461181640625, 0.779296875, 1.9482421875, - 1.8720703125, 0.845703125, -1.3837890625, -0.138916015625, - 0.35546875, 0.2457275390625, 0.75341796875, 1.828125, - 1.4169921875, 0.60791015625, 1.0068359375, 1.109375, - 0.484130859375, -0.302001953125, 0.4951171875, 0.802734375, - 1.9482421875, 0.916015625, 0.1646728515625, 2.599609375, - 1.7177734375, -0.2374267578125, 0.98046875, 0.39306640625, - -1.1396484375, 1.6533203125, 0.375244140625], "scores": - [0.09906005859375, 0.12213134765625, 0.05035400390625, - 0.16552734375, 0.0037384033203125, 0.010101318359375, - 0.058197021484375, 0.10552978515625, 0.1141357421875, - 0.115234375, 0.00444793701171875, 0.00812530517578125, - 0.0343017578125, 0.009002685546875, 0.087158203125, - 0.00818634033203125, 0.003238677978515625, 0.024169921875, - 0.00702667236328125, 0.00936126708984375, - 0.00632476806640625, 0.0293731689453125, 0.01800537109375, - 0.0088348388671875, 0.013397216796875, 0.02557373046875, - 0.12109375, 0.004413604736328125, 0.016571044921875, - 0.00274658203125, 0.2142333984375, 0.29638671875, - 0.16015625, 0.007843017578125, 0.007160186767578125, - 0.00508880615234375, 0.054229736328125, 0.048736572265625, - 0.026397705078125, 0.0265350341796875, 0.051361083984375, - 0.018310546875, 0.00974273681640625, 0.0218963623046875, - 0.216064453125, 0.021728515625, 0.0173797607421875, - 0.004520416259765625], "stoks": [52, 52, 52, 52, 52, 41, 41, - 374, 303, 303, 303, 427], "time": {"begin_ms": 640, - "end_ms": 1140}}]} - - id: 7645a0d1-2e64-410d-83a8-b96040432e9a - chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 - timestamp: 1716244957031 - role: AGENT - type: AGENT_MESSAGE - message_text: Hello! - emotion_features: >- - {"Admiration": 0.044921875, "Adoration": 0.0253753662109375, - "Aesthetic Appreciation": 0.03265380859375, "Amusement": - 0.118408203125, "Anger": 0.06719970703125, "Anxiety": - 0.0411376953125, "Awe": 0.03802490234375, "Awkwardness": - 0.056549072265625, "Boredom": 0.04217529296875, "Calmness": - 0.08709716796875, "Concentration": 0.070556640625, - "Confusion": 0.06964111328125, "Contemplation": - 0.0343017578125, "Contempt": 0.037689208984375, - "Contentment": 0.059417724609375, "Craving": - 0.01132965087890625, "Desire": 0.01406097412109375, - "Determination": 0.1143798828125, "Disappointment": - 0.051177978515625, "Disgust": 0.028594970703125, "Distress": - 0.054901123046875, "Doubt": 0.04638671875, "Ecstasy": - 0.0258026123046875, "Embarrassment": 0.0222015380859375, - "Empathic Pain": 0.015777587890625, "Entrancement": - 0.0160980224609375, "Envy": 0.0163421630859375, - "Excitement": 0.129638671875, "Fear": 0.03125, "Guilt": - 0.01483917236328125, "Horror": 0.0194549560546875, - "Interest": 0.1341552734375, "Joy": 0.0738525390625, "Love": - 0.0216522216796875, "Nostalgia": 0.0210418701171875, "Pain": - 0.020721435546875, "Pride": 0.05499267578125, "Realization": - 0.0728759765625, "Relief": 0.04052734375, "Romance": - 0.0129241943359375, "Sadness": 0.0254669189453125, - "Satisfaction": 0.07159423828125, "Shame": 0.01495361328125, - "Surprise (negative)": 0.05560302734375, "Surprise - (positive)": 0.07965087890625, "Sympathy": - 0.022247314453125, "Tiredness": 0.0194549560546875, - "Triumph": 0.04107666015625} - metadata: "" - page_number: 0 - page_size: 3 - total_pages: 1 - end_timestamp: 1716244958546 - metadata: "" - config: - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 - version: 0 - source: - openapi: stenographer-openapi.json + This parameter uses zero-based indexing. For example, setting + `page_number` to 0 retrieves the first page of results (items 0-9 + if `page_size` is 10), setting `page_number` to 1 retrieves the + second page (items 10-19), and so on. Defaults to 0, which + retrieves the first page. + ascending_order: + type: optional + docs: >- + Specifies the sorting order of the results based on their creation + date. Set to true for ascending order (chronological, with the + oldest records first) and false for descending order + (reverse-chronological, with the newest records first). Defaults + to true. + response: + docs: Success + type: root.ReturnChatPagedEvents + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 + query-parameters: + page_number: 0 + page_size: 3 + ascending_order: true + response: + body: + id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 + chat_group_id: 9fc18597-3567-42d5-94d6-935bde84bf2f + status: USER_ENDED + start_timestamp: 1716244940648 + pagination_direction: ASC + events_page: + - id: 5d44bdbb-49a3-40fb-871d-32bf7e76efe7 + chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 + timestamp: 1716244940762 + role: SYSTEM + type: SYSTEM_PROMPT + message_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. + emotion_features: '' + metadata: '' + - id: 5976ddf6-d093-4bb9-ba60-8f6c25832dde + chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 + timestamp: 1716244956278 + role: USER + type: USER_MESSAGE + message_text: Hello. + emotion_features: >- + {"Admiration": 0.09906005859375, "Adoration": + 0.12213134765625, "Aesthetic Appreciation": + 0.05035400390625, "Amusement": 0.16552734375, "Anger": + 0.0037384033203125, "Anxiety": 0.010101318359375, "Awe": + 0.058197021484375, "Awkwardness": 0.10552978515625, + "Boredom": 0.1141357421875, "Calmness": 0.115234375, + "Concentration": 0.00444793701171875, "Confusion": + 0.0343017578125, "Contemplation": 0.00812530517578125, + "Contempt": 0.009002685546875, "Contentment": + 0.087158203125, "Craving": 0.00818634033203125, "Desire": + 0.018310546875, "Determination": 0.003238677978515625, + "Disappointment": 0.024169921875, "Disgust": + 0.00702667236328125, "Distress": 0.00936126708984375, + "Doubt": 0.00632476806640625, "Ecstasy": 0.0293731689453125, + "Embarrassment": 0.01800537109375, "Empathic Pain": + 0.0088348388671875, "Entrancement": 0.013397216796875, + "Envy": 0.02557373046875, "Excitement": 0.12109375, "Fear": + 0.004413604736328125, "Guilt": 0.016571044921875, "Horror": + 0.00274658203125, "Interest": 0.2142333984375, "Joy": + 0.29638671875, "Love": 0.16015625, "Nostalgia": + 0.007843017578125, "Pain": 0.007160186767578125, "Pride": + 0.00508880615234375, "Realization": 0.054229736328125, + "Relief": 0.048736572265625, "Romance": 0.026397705078125, + "Sadness": 0.0265350341796875, "Satisfaction": + 0.051361083984375, "Shame": 0.00974273681640625, "Surprise + (negative)": 0.0218963623046875, "Surprise (positive)": + 0.216064453125, "Sympathy": 0.021728515625, "Tiredness": + 0.0173797607421875, "Triumph": 0.004520416259765625} + metadata: >- + {"segments": [{"content": "Hello.", "embedding": + [0.6181640625, 0.1763916015625, -30.921875, 1.2705078125, + 0.927734375, 0.63720703125, 2.865234375, 0.1080322265625, + 0.2978515625, 1.0107421875, 1.34375, 0.74560546875, + 0.416259765625, 0.99462890625, -0.333740234375, + 0.361083984375, -1.388671875, 1.0107421875, 1.3173828125, + 0.55615234375, 0.541015625, -0.1837158203125, 1.697265625, + 0.228515625, 2.087890625, -0.311767578125, + 0.053680419921875, 1.3349609375, 0.95068359375, + 0.00441741943359375, 0.705078125, 1.8916015625, + -0.939453125, 0.93701171875, -0.28955078125, 1.513671875, + 0.5595703125, 1.0126953125, -0.1624755859375, 1.4072265625, + -0.28857421875, -0.4560546875, -0.1500244140625, + -0.1102294921875, -0.222412109375, 0.8779296875, + 1.275390625, 1.6689453125, 0.80712890625, -0.34814453125, + -0.325439453125, 0.412841796875, 0.81689453125, + 0.55126953125, 1.671875, 0.6611328125, 0.7451171875, + 1.50390625, 1.0224609375, -1.671875, 0.7373046875, + 2.1328125, 2.166015625, 0.41015625, -0.127685546875, + 1.9345703125, -4.2734375, 0.332275390625, 0.26171875, + 0.76708984375, 0.2685546875, 0.468017578125, 1.208984375, + -1.517578125, 1.083984375, 0.84814453125, 1.0244140625, + -0.0072174072265625, 1.34375, 1.0712890625, 1.517578125, + -0.52001953125, 0.59228515625, 0.8154296875, -0.951171875, + -0.07757568359375, 1.3330078125, 1.125, 0.61181640625, + 1.494140625, 0.357421875, 1.1796875, 1.482421875, 0.8046875, + 0.1536865234375, 1.8076171875, 0.68115234375, -15.171875, + 1.2294921875, 0.319091796875, 0.499755859375, 1.5771484375, + 0.94677734375, -0.2490234375, 0.88525390625, 3.47265625, + 0.75927734375, 0.71044921875, 1.2333984375, 1.4169921875, + -0.56640625, -1.8095703125, 1.37109375, 0.428955078125, + 1.89453125, -0.39013671875, 0.1734619140625, 1.5595703125, + -1.2294921875, 2.552734375, 0.58349609375, 0.2156982421875, + -0.00984954833984375, -0.6865234375, -0.0272979736328125, + -0.2264404296875, 2.853515625, 1.3896484375, 0.52978515625, + 0.783203125, 3.0390625, 0.75537109375, 0.219970703125, + 0.384521484375, 0.385986328125, 2.0546875, + -0.10443115234375, 1.5146484375, 1.4296875, 1.9716796875, + 1.1318359375, 0.31591796875, 0.338623046875, 1.654296875, + -0.88037109375, -0.21484375, 1.45703125, 1.0380859375, + -0.52294921875, -0.47802734375, 0.1650390625, 1.2392578125, + -1.138671875, 0.56787109375, 1.318359375, 0.4287109375, + 0.1981201171875, 2.4375, 0.281005859375, 0.89404296875, + -0.1552734375, 0.6474609375, -0.08331298828125, + 0.00740814208984375, -0.045501708984375, -0.578125, + 2.02734375, 0.59228515625, 0.35693359375, 1.2919921875, + 1.22265625, 1.0537109375, 0.145263671875, 1.05859375, + -0.369140625, 0.207275390625, 0.78857421875, 0.599609375, + 0.99072265625, 0.24462890625, 1.26953125, 0.08404541015625, + 1.349609375, 0.73291015625, 1.3212890625, 0.388916015625, + 1.0869140625, 0.9931640625, -1.5673828125, 0.0462646484375, + 0.650390625, 0.253662109375, 0.58251953125, 1.8134765625, + 0.8642578125, 2.591796875, 0.7314453125, 0.85986328125, + 0.5615234375, 0.9296875, 0.04144287109375, 1.66015625, + 1.99609375, 1.171875, 1.181640625, 1.5126953125, + 0.0224456787109375, 0.58349609375, -1.4931640625, + 0.81884765625, 0.732421875, -0.6455078125, -0.62451171875, + 1.7802734375, 0.01526641845703125, -0.423095703125, + 0.461669921875, 4.87890625, 1.2392578125, -0.6953125, + 0.6689453125, 0.62451171875, -1.521484375, 1.7685546875, + 0.810546875, 0.65478515625, 0.26123046875, 1.6396484375, + 0.87548828125, 1.7353515625, 2.046875, 1.5634765625, + 0.69384765625, 1.375, 0.8916015625, 1.0107421875, + 0.1304931640625, 2.009765625, 0.06402587890625, + -0.08428955078125, 0.04351806640625, -1.7529296875, + 2.02734375, 3.521484375, 0.404541015625, 1.6337890625, + -0.276611328125, 0.8837890625, -0.1287841796875, + 0.91064453125, 0.8193359375, 0.701171875, 0.036529541015625, + 1.26171875, 1.0478515625, -0.1422119140625, 1.0634765625, + 0.61083984375, 1.3505859375, 1.208984375, 0.57275390625, + 1.3623046875, 2.267578125, 0.484375, 0.9150390625, + 0.56787109375, -0.70068359375, 0.27587890625, + -0.70654296875, 0.8466796875, 0.57568359375, 1.6162109375, + 0.87939453125, 2.248046875, -0.5458984375, 1.7744140625, + 1.328125, 1.232421875, 0.6806640625, 0.9365234375, + 1.052734375, -1.08984375, 1.8330078125, -0.4033203125, + 1.0673828125, 0.297607421875, 1.5703125, 1.67578125, + 1.34765625, 2.8203125, 2.025390625, -0.48583984375, + 0.7626953125, 0.01007843017578125, 1.435546875, + 0.007205963134765625, 0.05157470703125, -0.9853515625, + 0.26708984375, 1.16796875, 1.2041015625, 1.99609375, + -0.07916259765625, 1.244140625, -0.32080078125, + 0.6748046875, 0.419921875, 1.3212890625, 1.291015625, + 0.599609375, 0.0550537109375, 0.9599609375, 0.93505859375, + 0.111083984375, 1.302734375, 0.0833740234375, 2.244140625, + 1.25390625, 1.6015625, 0.58349609375, 1.7568359375, + -0.263427734375, -0.019866943359375, -0.24658203125, + -0.1871337890625, 0.927734375, 0.62255859375, + 0.275146484375, 0.79541015625, 1.1796875, 1.1767578125, + -0.26123046875, -0.268310546875, 1.8994140625, 1.318359375, + 2.1875, 0.2469482421875, 1.41015625, 0.03973388671875, + 1.2685546875, 1.1025390625, 0.9560546875, 0.865234375, + -1.92578125, 1.154296875, 0.389892578125, 1.130859375, + 0.95947265625, 0.72314453125, 2.244140625, + 0.048553466796875, 0.626953125, 0.42919921875, + 0.82275390625, 0.311767578125, -0.320556640625, + 0.01041412353515625, 0.1483154296875, 0.10809326171875, + -0.3173828125, 1.1337890625, -0.8642578125, 1.4033203125, + 0.048828125, 1.1787109375, 0.98779296875, 1.818359375, + 1.1552734375, 0.6015625, 1.2392578125, -1.2685546875, + 0.39208984375, 0.83251953125, 0.224365234375, + 0.0019989013671875, 0.87548828125, 1.6572265625, + 1.107421875, 0.434814453125, 1.8251953125, 0.442626953125, + 1.2587890625, 0.09320068359375, -0.896484375, 1.8017578125, + 1.451171875, -0.0755615234375, 0.6083984375, 2.06640625, + 0.673828125, -0.33740234375, 0.192138671875, 0.21435546875, + 0.80224609375, -1.490234375, 0.9501953125, 0.86083984375, + -0.40283203125, 4.109375, 2.533203125, 1.2529296875, + 0.8271484375, 0.225830078125, 1.0478515625, -1.9755859375, + 0.841796875, 0.392822265625, 0.525390625, 0.33935546875, + -0.79443359375, 0.71630859375, 0.97998046875, + -0.175537109375, 0.97705078125, 1.705078125, 0.29638671875, + 0.68359375, 0.54150390625, 0.435791015625, 0.99755859375, + -0.369140625, 1.009765625, -0.140380859375, 0.426513671875, + 0.189697265625, 1.8193359375, 1.1201171875, -0.5009765625, + -0.331298828125, 0.759765625, -0.09442138671875, 0.74609375, + -1.947265625, 1.3544921875, -3.935546875, 2.544921875, + 1.359375, 0.1363525390625, 0.79296875, 0.79931640625, + -0.3466796875, 1.1396484375, -0.33447265625, 2.0078125, + -0.241455078125, 0.6318359375, 0.365234375, 0.296142578125, + 0.830078125, 1.0458984375, 0.5830078125, 0.61572265625, + 14.0703125, -2.0078125, -0.381591796875, 1.228515625, + 0.08282470703125, -0.67822265625, -0.04339599609375, + 0.397216796875, 0.1656494140625, 0.137451171875, + 0.244873046875, 1.1611328125, -1.3818359375, 0.8447265625, + 1.171875, 0.36328125, 0.252685546875, 0.1197509765625, + 0.232177734375, -0.020172119140625, 0.64404296875, + -0.01100921630859375, -1.9267578125, 0.222412109375, + 0.56005859375, 1.3046875, 1.1630859375, 1.197265625, + 1.02734375, 1.6806640625, -0.043731689453125, 1.4697265625, + 0.81201171875, 1.5390625, 1.240234375, -0.7353515625, + 1.828125, 1.115234375, 1.931640625, -0.517578125, + 0.77880859375, 1.0546875, 0.95361328125, 3.42578125, + 0.0160369873046875, 0.875, 0.56005859375, 1.2421875, + 1.986328125, 1.4814453125, 0.0948486328125, 1.115234375, + 0.00665283203125, 2.09375, 0.3544921875, -0.52783203125, + 1.2099609375, 0.45068359375, 0.65625, 0.1112060546875, + 1.0751953125, -0.9521484375, -0.30029296875, 1.4462890625, + 2.046875, 3.212890625, 1.68359375, 1.07421875, + -0.5263671875, 0.74560546875, 1.37890625, 0.15283203125, + 0.2440185546875, 0.62646484375, -0.1280517578125, + 0.7646484375, -0.515625, -0.35693359375, 1.2958984375, + 0.96923828125, 0.58935546875, 1.3701171875, 1.0673828125, + 0.2337646484375, 0.93115234375, 0.66357421875, 6.0, + 1.1025390625, -0.51708984375, -0.38330078125, 0.7197265625, + 0.246826171875, -0.45166015625, 1.9521484375, 0.5546875, + 0.08807373046875, 0.18505859375, 0.8857421875, + -0.57177734375, 0.251708984375, 0.234375, 2.57421875, + 0.9599609375, 0.5029296875, 0.10382080078125, + 0.08331298828125, 0.66748046875, -0.349609375, 1.287109375, + 0.259765625, 2.015625, 2.828125, -0.3095703125, + -0.164306640625, -0.3408203125, 0.486572265625, + 0.8466796875, 1.9130859375, 0.09088134765625, 0.66552734375, + 0.00972747802734375, -0.83154296875, 1.755859375, + 0.654296875, 0.173828125, 0.27587890625, -0.47607421875, + -0.264404296875, 0.7529296875, 0.6533203125, 0.7275390625, + 0.499755859375, 0.833984375, -0.44775390625, -0.05078125, + -0.454833984375, 0.75439453125, 0.68505859375, + 0.210693359375, -0.283935546875, -0.53564453125, + 0.96826171875, 0.861328125, -3.33984375, -0.26171875, + 0.77734375, 0.26513671875, -0.14111328125, -0.042236328125, + -0.84814453125, 0.2137451171875, 0.94921875, 0.65185546875, + -0.5380859375, 0.1529541015625, -0.360595703125, + -0.0333251953125, -0.69189453125, 0.8974609375, 0.7109375, + 0.81494140625, -0.259521484375, 1.1904296875, 0.62158203125, + 1.345703125, 0.89404296875, 0.70556640625, 1.0673828125, + 1.392578125, 0.5068359375, 0.962890625, 0.736328125, + 1.55078125, 0.50390625, -0.398681640625, 2.361328125, + 0.345947265625, -0.61962890625, 0.330078125, 0.75439453125, + -0.673828125, -0.2379150390625, 1.5673828125, 1.369140625, + 0.1119384765625, -0.1834716796875, 1.4599609375, + -0.77587890625, 0.5556640625, 0.09954833984375, + 0.0285186767578125, 0.58935546875, -0.501953125, + 0.212890625, 0.02679443359375, 0.1715087890625, + 0.03466796875, -0.564453125, 2.029296875, 2.45703125, + -0.72216796875, 2.138671875, 0.50830078125, + -0.09356689453125, 0.230224609375, 1.6943359375, + 1.5126953125, 0.39453125, 0.411376953125, 1.07421875, + -0.8046875, 0.51416015625, 0.2271728515625, -0.283447265625, + 0.38427734375, 0.73388671875, 0.6962890625, 1.4990234375, + 0.02813720703125, 0.40478515625, 1.2451171875, 1.1162109375, + -5.5703125, 0.76171875, 0.322021484375, 1.0361328125, + 1.197265625, 0.1163330078125, 0.2425537109375, 1.5595703125, + 1.5791015625, -0.0921630859375, 0.484619140625, + 1.9052734375, 5.31640625, 1.6337890625, 0.95947265625, + -0.1751708984375, 0.466552734375, 0.8330078125, 1.03125, + 0.2044677734375, 0.31298828125, -1.1220703125, 0.5517578125, + 0.93505859375, 0.45166015625, 1.951171875, 0.65478515625, + 1.30859375, 1.0859375, 0.56494140625, 2.322265625, + 0.242919921875, 1.81640625, -0.469970703125, -0.841796875, + 0.90869140625, 1.5361328125, 0.923828125, 1.0595703125, + 0.356689453125, -0.46142578125, 2.134765625, 1.3037109375, + -0.32373046875, -9.2265625, 0.4521484375, 0.88037109375, + -0.53955078125, 0.96484375, 0.7705078125, 0.84521484375, + 1.580078125, -0.1448974609375, 0.7607421875, 1.0166015625, + -0.086669921875, 1.611328125, 0.05938720703125, 0.5078125, + 0.8427734375, 2.431640625, 0.66357421875, 3.203125, + 0.132080078125, 0.461181640625, 0.779296875, 1.9482421875, + 1.8720703125, 0.845703125, -1.3837890625, -0.138916015625, + 0.35546875, 0.2457275390625, 0.75341796875, 1.828125, + 1.4169921875, 0.60791015625, 1.0068359375, 1.109375, + 0.484130859375, -0.302001953125, 0.4951171875, 0.802734375, + 1.9482421875, 0.916015625, 0.1646728515625, 2.599609375, + 1.7177734375, -0.2374267578125, 0.98046875, 0.39306640625, + -1.1396484375, 1.6533203125, 0.375244140625], "scores": + [0.09906005859375, 0.12213134765625, 0.05035400390625, + 0.16552734375, 0.0037384033203125, 0.010101318359375, + 0.058197021484375, 0.10552978515625, 0.1141357421875, + 0.115234375, 0.00444793701171875, 0.00812530517578125, + 0.0343017578125, 0.009002685546875, 0.087158203125, + 0.00818634033203125, 0.003238677978515625, 0.024169921875, + 0.00702667236328125, 0.00936126708984375, + 0.00632476806640625, 0.0293731689453125, 0.01800537109375, + 0.0088348388671875, 0.013397216796875, 0.02557373046875, + 0.12109375, 0.004413604736328125, 0.016571044921875, + 0.00274658203125, 0.2142333984375, 0.29638671875, + 0.16015625, 0.007843017578125, 0.007160186767578125, + 0.00508880615234375, 0.054229736328125, 0.048736572265625, + 0.026397705078125, 0.0265350341796875, 0.051361083984375, + 0.018310546875, 0.00974273681640625, 0.0218963623046875, + 0.216064453125, 0.021728515625, 0.0173797607421875, + 0.004520416259765625], "stoks": [52, 52, 52, 52, 52, 41, 41, + 374, 303, 303, 303, 427], "time": {"begin_ms": 640, + "end_ms": 1140}}]} + - id: 7645a0d1-2e64-410d-83a8-b96040432e9a + chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0 + timestamp: 1716244957031 + role: AGENT + type: AGENT_MESSAGE + message_text: Hello! + emotion_features: >- + {"Admiration": 0.044921875, "Adoration": 0.0253753662109375, + "Aesthetic Appreciation": 0.03265380859375, "Amusement": + 0.118408203125, "Anger": 0.06719970703125, "Anxiety": + 0.0411376953125, "Awe": 0.03802490234375, "Awkwardness": + 0.056549072265625, "Boredom": 0.04217529296875, "Calmness": + 0.08709716796875, "Concentration": 0.070556640625, + "Confusion": 0.06964111328125, "Contemplation": + 0.0343017578125, "Contempt": 0.037689208984375, + "Contentment": 0.059417724609375, "Craving": + 0.01132965087890625, "Desire": 0.01406097412109375, + "Determination": 0.1143798828125, "Disappointment": + 0.051177978515625, "Disgust": 0.028594970703125, "Distress": + 0.054901123046875, "Doubt": 0.04638671875, "Ecstasy": + 0.0258026123046875, "Embarrassment": 0.0222015380859375, + "Empathic Pain": 0.015777587890625, "Entrancement": + 0.0160980224609375, "Envy": 0.0163421630859375, + "Excitement": 0.129638671875, "Fear": 0.03125, "Guilt": + 0.01483917236328125, "Horror": 0.0194549560546875, + "Interest": 0.1341552734375, "Joy": 0.0738525390625, "Love": + 0.0216522216796875, "Nostalgia": 0.0210418701171875, "Pain": + 0.020721435546875, "Pride": 0.05499267578125, "Realization": + 0.0728759765625, "Relief": 0.04052734375, "Romance": + 0.0129241943359375, "Sadness": 0.0254669189453125, + "Satisfaction": 0.07159423828125, "Shame": 0.01495361328125, + "Surprise (negative)": 0.05560302734375, "Surprise + (positive)": 0.07965087890625, "Sympathy": + 0.022247314453125, "Tiredness": 0.0194549560546875, + "Triumph": 0.04107666015625} + metadata: '' + page_number: 0 + page_size: 3 + total_pages: 1 + end_timestamp: 1716244958546 + metadata: '' + config: + id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + version: 0 + get-audio: + path: /v0/evi/chats/{id}/audio + method: GET + auth: true + path-parameters: + id: + type: string + docs: Identifier for a chat. Formatted as a UUID. + display-name: Get chat audio + response: + docs: Success + type: root.ReturnChatPagedEvents + errors: + - root.BadRequestError + examples: + - path-parameters: + id: id + response: + body: + id: id + chat_group_id: chat_group_id + status: ACTIVE + start_timestamp: 1000000 + end_timestamp: 1000000 + pagination_direction: ASC + events_page: + - id: id + chat_id: chat_id + timestamp: 1000000 + role: USER + type: SYSTEM_PROMPT + message_text: message_text + emotion_features: emotion_features + metadata: metadata + metadata: metadata + page_number: 1 + page_size: 1 + total_pages: 1 + config: + id: id + version: 1 + source: + openapi: stenographer-openapi.json diff --git a/.mock/definition/empathic-voice/configs.yml b/.mock/definition/empathic-voice/configs.yml index 1b5bf279..efdefb3a 100644 --- a/.mock/definition/empathic-voice/configs.yml +++ b/.mock/definition/empathic-voice/configs.yml @@ -1,880 +1,922 @@ imports: - root: __package__.yml + root: __package__.yml service: - auth: false - base-path: "" - endpoints: - list-configs: - path: /v0/evi/configs - method: GET - auth: true + auth: false + base-path: '' + endpoints: + list-configs: + path: /v0/evi/configs + method: GET + auth: true + docs: >- + 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). + display-name: List configs + request: + name: ConfigsListConfigsRequest + query-parameters: + page_number: + type: optional docs: >- - 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). - display-name: List configs - request: - name: ConfigsListConfigsRequest - query-parameters: - page_number: - type: optional - docs: >- - Specifies the page number to retrieve, enabling pagination. - - - This parameter uses zero-based indexing. For example, setting - `page_number` to 0 retrieves the first page of results (items 0-9 - if `page_size` is 10), setting `page_number` to 1 retrieves the - second page (items 10-19), and so on. Defaults to 0, which - retrieves the first page. - page_size: - type: optional - docs: >- - Specifies the maximum number of results to include per page, - enabling pagination. The value must be between 1 and 100, - inclusive. - - - For example, if `page_size` is set to 10, each page will include - up to 10 items. Defaults to 10. - restrict_to_most_recent: - type: optional - docs: >- - By default, `restrict_to_most_recent` is set to true, returning - only the latest version of each config. To include all versions of - each config in the list, set `restrict_to_most_recent` to false. - name: - type: optional - docs: Filter to only include configs with this name. - response: - docs: Success - type: root.ReturnPagedConfigs - errors: - - root.BadRequestError - examples: - - query-parameters: - page_number: 0 - page_size: 1 - response: - body: - page_number: 0 - page_size: 1 - total_pages: 1 - configs_page: - - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 - version: 0 - version_description: "" - name: Weather Assistant Config - created_on: 1715267200693 - modified_on: 1715267200693 - evi_version: "2" - prompt: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 0 - version_type: FIXED - version_description: "" - name: Weather Assistant Prompt - created_on: 1715267200693 - modified_on: 1715267200693 - 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. - voice: - provider: HUME_AI - name: SAMPLE VOICE - custom_voice: - id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704 - version: 1 - name: SAMPLE VOICE - created_on: 1724704587367 - modified_on: 1725489961583 - base_voice: KORA - parameter_model: 20240715-4parameter - parameters: - gender: -7 - huskiness: -2 - nasality: -8 - pitch: -9 - language_model: - model_provider: ANTHROPIC - model_resource: claude-3-5-sonnet-20240620 - temperature: 1 - ellm_model: - allow_short_responses: false - tools: [] - builtin_tools: [] - event_messages: - on_new_chat: - enabled: false - text: "" - on_inactivity_timeout: - enabled: false - text: "" - on_max_duration_timeout: - enabled: false - text: "" - timeouts: - inactivity: - enabled: true - duration_secs: 600 - max_duration: - enabled: true - duration_secs: 1800 - create-config: - path: /v0/evi/configs - method: POST - auth: true - docs: >- - 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). - display-name: Create config - request: - name: PostedConfig - body: - properties: - evi_version: - type: string - docs: >- - Specifies the EVI version to use. Use `"1"` for version 1, or - `"2"` for the latest enhanced version. For a detailed comparison - of the two versions, refer to our - [guide](/docs/empathic-voice-interface-evi/evi-2). - name: - type: string - docs: Name applied to all versions of a particular Config. - version_description: - type: optional - docs: An optional description of the Config version. - prompt: optional - voice: - type: optional - docs: A voice specification associated with this Config. - language_model: - type: optional - docs: >- - The supplemental language model associated with this Config. - - - This model is used to generate longer, more detailed responses - from EVI. Choosing an appropriate supplemental language model - for your use case is crucial for generating fast, high-quality - responses from EVI. - ellm_model: - type: optional - docs: >- - The eLLM setup associated with this Config. - - - Hume's eLLM (empathic Large Language Model) is a multimodal - language model that takes into account both expression measures - and language. The eLLM generates short, empathic language - responses and guides text-to-speech (TTS) prosody. - tools: - type: optional>> - docs: List of user-defined tools associated with this Config. - builtin_tools: - type: optional>> - docs: List of built-in tools associated with this Config. - event_messages: optional - timeouts: optional - content-type: application/json - response: - docs: Created - type: root.ReturnConfig - errors: - - root.BadRequestError - examples: - - request: - name: Weather Assistant Config - prompt: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 0 - evi_version: "2" - voice: - provider: HUME_AI - name: SAMPLE VOICE - language_model: - model_provider: ANTHROPIC - model_resource: claude-3-5-sonnet-20240620 - temperature: 1 - event_messages: - on_new_chat: - enabled: false - text: "" - on_inactivity_timeout: - enabled: false - text: "" - on_max_duration_timeout: - enabled: false - text: "" - response: - body: - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 - version: 0 - version_description: "" - name: Weather Assistant Config - created_on: 1715275452390 - modified_on: 1715275452390 - evi_version: "2" - prompt: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 0 - version_type: FIXED - version_description: "" - name: Weather Assistant Prompt - created_on: 1715267200693 - modified_on: 1715267200693 - 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. - voice: - provider: HUME_AI - name: SAMPLE VOICE - custom_voice: - id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704 - version: 1 - name: SAMPLE VOICE - created_on: 1724704587367 - modified_on: 1725489961583 - base_voice: KORA - parameter_model: 20240715-4parameter - parameters: - gender: -7 - huskiness: -2 - nasality: -8 - pitch: -9 - language_model: - model_provider: ANTHROPIC - model_resource: claude-3-5-sonnet-20240620 - temperature: 1 - ellm_model: - allow_short_responses: false - tools: [] - builtin_tools: [] - event_messages: - on_new_chat: - enabled: false - text: "" - on_inactivity_timeout: - enabled: false - text: "" - on_max_duration_timeout: - enabled: false - text: "" - timeouts: - inactivity: - enabled: true - duration_secs: 600 - max_duration: - enabled: true - duration_secs: 1800 - list-config-versions: - path: /v0/evi/configs/{id} - method: GET - auth: true - docs: >- - 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). - path-parameters: - id: - type: string - docs: Identifier for a Config. Formatted as a UUID. - display-name: List config versions - request: - name: ConfigsListConfigVersionsRequest - query-parameters: - page_number: - type: optional - docs: >- - Specifies the page number to retrieve, enabling pagination. - - - This parameter uses zero-based indexing. For example, setting - `page_number` to 0 retrieves the first page of results (items 0-9 - if `page_size` is 10), setting `page_number` to 1 retrieves the - second page (items 10-19), and so on. Defaults to 0, which - retrieves the first page. - page_size: - type: optional - docs: >- - Specifies the maximum number of results to include per page, - enabling pagination. The value must be between 1 and 100, - inclusive. - - - For example, if `page_size` is set to 10, each page will include - up to 10 items. Defaults to 10. - restrict_to_most_recent: - type: optional - docs: >- - By default, `restrict_to_most_recent` is set to true, returning - only the latest version of each config. To include all versions of - each config in the list, set `restrict_to_most_recent` to false. - response: - docs: Success - type: root.ReturnPagedConfigs - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 - response: - body: - page_number: 0 - page_size: 10 - total_pages: 1 - configs_page: - - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 - version: 0 - version_description: "" - name: Weather Assistant Config - created_on: 1715275452390 - modified_on: 1715275452390 - evi_version: "2" - prompt: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 0 - version_type: FIXED - version_description: "" - name: Weather Assistant Prompt - created_on: 1715267200693 - modified_on: 1715267200693 - 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. - voice: - provider: HUME_AI - name: SAMPLE VOICE - custom_voice: - id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704 - version: 1 - name: SAMPLE VOICE - created_on: 1724704587367 - modified_on: 1725489961583 - base_voice: KORA - parameter_model: 20240715-4parameter - parameters: - gender: -7 - huskiness: -2 - nasality: -8 - pitch: -9 - language_model: - model_provider: ANTHROPIC - model_resource: claude-3-5-sonnet-20240620 - temperature: 1 - ellm_model: - allow_short_responses: false - tools: [] - builtin_tools: [] - event_messages: - on_new_chat: - enabled: false - text: "" - on_inactivity_timeout: - enabled: false - text: "" - on_max_duration_timeout: - enabled: false - text: "" - timeouts: - inactivity: - enabled: true - duration_secs: 600 - max_duration: - enabled: true - duration_secs: 1800 - create-config-version: - path: /v0/evi/configs/{id} - method: POST - auth: true - docs: >- - 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). - path-parameters: - id: - type: string - docs: Identifier for a Config. Formatted as a UUID. - display-name: Create config version - request: - name: PostedConfigVersion - body: - properties: - evi_version: - type: string - docs: The version of the EVI used with this config. - version_description: - type: optional - docs: An optional description of the Config version. - prompt: optional - voice: - type: optional - docs: A voice specification associated with this Config version. - language_model: - type: optional - docs: >- - The supplemental language model associated with this Config - version. - - - This model is used to generate longer, more detailed responses - from EVI. Choosing an appropriate supplemental language model - for your use case is crucial for generating fast, high-quality - responses from EVI. - ellm_model: - type: optional - docs: >- - The eLLM setup associated with this Config version. - - - Hume's eLLM (empathic Large Language Model) is a multimodal - language model that takes into account both expression measures - and language. The eLLM generates short, empathic language - responses and guides text-to-speech (TTS) prosody. - tools: - type: optional>> - docs: List of user-defined tools associated with this Config version. - builtin_tools: - type: optional>> - docs: List of built-in tools associated with this Config version. - event_messages: optional - timeouts: optional - content-type: application/json - response: - docs: Created - type: root.ReturnConfig - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 - request: - version_description: This is an updated version of the Weather Assistant Config. - evi_version: "2" - prompt: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 0 - voice: - provider: HUME_AI - name: ITO - language_model: - model_provider: ANTHROPIC - model_resource: claude-3-5-sonnet-20240620 - temperature: 1 - ellm_model: - allow_short_responses: true - event_messages: - on_new_chat: - enabled: false - text: "" - on_inactivity_timeout: - enabled: false - text: "" - on_max_duration_timeout: - enabled: false - text: "" - response: - body: - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 - version: 1 - version_description: This is an updated version of the Weather Assistant Config. - name: Weather Assistant Config - created_on: 1715275452390 - modified_on: 1722642242998 - evi_version: "2" - prompt: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 0 - version_type: FIXED - version_description: "" - name: Weather Assistant Prompt - created_on: 1715267200693 - modified_on: 1715267200693 - 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. - voice: - provider: HUME_AI - name: ITO - custom_voice: - id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704 - version: 1 - name: SAMPLE VOICE - created_on: 1724704587367 - modified_on: 1725489961583 - base_voice: KORA - parameter_model: 20240715-4parameter - parameters: - gender: -7 - huskiness: -2 - nasality: -8 - pitch: -9 - language_model: - model_provider: ANTHROPIC - model_resource: claude-3-5-sonnet-20240620 - temperature: 1 - ellm_model: - allow_short_responses: true - tools: [] - builtin_tools: [] - event_messages: - on_new_chat: - enabled: false - text: "" - on_inactivity_timeout: - enabled: false - text: "" - on_max_duration_timeout: - enabled: false - text: "" - timeouts: - inactivity: - enabled: true - duration_secs: 600 - max_duration: - enabled: true - duration_secs: 1800 - delete-config: - path: /v0/evi/configs/{id} - method: DELETE - auth: true - docs: >- - 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). - path-parameters: - id: - type: string - docs: Identifier for a Config. Formatted as a UUID. - display-name: Delete config - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 - update-config-name: - path: /v0/evi/configs/{id} - method: PATCH - auth: true + Specifies the page number to retrieve, enabling pagination. + + + This parameter uses zero-based indexing. For example, setting + `page_number` to 0 retrieves the first page of results (items 0-9 + if `page_size` is 10), setting `page_number` to 1 retrieves the + second page (items 10-19), and so on. Defaults to 0, which + retrieves the first page. + page_size: + type: optional docs: >- - 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). - path-parameters: - id: - type: string - docs: Identifier for a Config. Formatted as a UUID. - display-name: Update config name - request: - name: PostedConfigName - body: - properties: - name: - type: string - docs: Name applied to all versions of a particular Config. - content-type: application/json - response: - docs: Success - type: text - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 - request: - name: Updated Weather Assistant Config Name - get-config-version: - path: /v0/evi/configs/{id}/version/{version} - method: GET - auth: true + Specifies the maximum number of results to include per page, + enabling pagination. The value must be between 1 and 100, + inclusive. + + + For example, if `page_size` is set to 10, each page will include + up to 10 items. Defaults to 10. + restrict_to_most_recent: + type: optional docs: >- - 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). - path-parameters: - id: - type: string - docs: Identifier for a Config. Formatted as a UUID. - version: - type: integer - docs: >- - 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. - display-name: Get config version - response: - docs: Success - type: root.ReturnConfig - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + By default, `restrict_to_most_recent` is set to true, returning + only the latest version of each tool. To include all versions of + each tool in the list, set `restrict_to_most_recent` to false. + name: + type: optional + docs: Filter to only include configs with this name. + response: + docs: Success + type: root.ReturnPagedConfigs + errors: + - root.BadRequestError + examples: + - query-parameters: + page_number: 0 + page_size: 1 + response: + body: + page_number: 0 + page_size: 1 + total_pages: 1 + configs_page: + - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + version: 0 + version_description: '' + name: Weather Assistant Config + created_on: 1715267200693 + modified_on: 1715267200693 + evi_version: '2' + prompt: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 0 + version_type: FIXED + version_description: '' + name: Weather Assistant Prompt + created_on: 1715267200693 + modified_on: 1715267200693 + 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. + voice: + provider: HUME_AI + name: SAMPLE VOICE + custom_voice: + id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704 version: 1 - response: - body: - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 - version: 1 - version_description: "" - name: Weather Assistant Config - created_on: 1715275452390 - modified_on: 1715275452390 - evi_version: "2" - prompt: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 0 - version_type: FIXED - version_description: "" - name: Weather Assistant Prompt - created_on: 1715267200693 - modified_on: 1715267200693 - 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. - voice: - provider: HUME_AI - name: SAMPLE VOICE - custom_voice: - id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704 - version: 1 - name: SAMPLE VOICE - created_on: 1724704587367 - modified_on: 1725489961583 - base_voice: KORA - parameter_model: 20240715-4parameter - parameters: - gender: -7 - huskiness: -2 - nasality: -8 - pitch: -9 - language_model: - model_provider: ANTHROPIC - model_resource: claude-3-5-sonnet-20240620 - temperature: 1 - ellm_model: - allow_short_responses: false - tools: [] - builtin_tools: [] - event_messages: - on_new_chat: - enabled: false - text: "" - on_inactivity_timeout: - enabled: false - text: "" - on_max_duration_timeout: - enabled: false - text: "" - timeouts: - inactivity: - enabled: true - duration_secs: 600 - max_duration: - enabled: true - duration_secs: 1800 - delete-config-version: - path: /v0/evi/configs/{id}/version/{version} - method: DELETE - auth: true + name: SAMPLE VOICE + created_on: 1724704587367 + modified_on: 1725489961583 + base_voice: KORA + parameter_model: 20241004-11parameter + parameters: + gender: 0 + articulation: -10 + assertiveness: 20 + buoyancy: -30 + confidence: -40 + enthusiasm: 50 + nasality: 45 + relaxedness: -35 + smoothness: 25 + tepidity: 15 + tightness: 5 + language_model: + model_provider: ANTHROPIC + model_resource: claude-3-5-sonnet-20240620 + temperature: 1 + ellm_model: + allow_short_responses: false + tools: [] + builtin_tools: [] + event_messages: + on_new_chat: + enabled: false + text: '' + on_inactivity_timeout: + enabled: false + text: '' + on_max_duration_timeout: + enabled: false + text: '' + timeouts: + inactivity: + enabled: true + duration_secs: 600 + max_duration: + enabled: true + duration_secs: 1800 + create-config: + path: /v0/evi/configs + method: POST + auth: true + docs: >- + 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). + display-name: Create config + request: + name: PostedConfig + body: + properties: + evi_version: + type: string + docs: >- + Specifies the EVI version to use. Use `"1"` for version 1, or + `"2"` for the latest enhanced version. For a detailed comparison + of the two versions, refer to our + [guide](/docs/empathic-voice-interface-evi/evi-2). + name: + type: string + docs: Name applied to all versions of a particular Config. + version_description: + type: optional + docs: An optional description of the Config version. + prompt: optional + voice: + type: optional + docs: A voice specification associated with this Config. + language_model: + type: optional + docs: >- + The supplemental language model associated with this Config. + + + This model is used to generate longer, more detailed responses + from EVI. Choosing an appropriate supplemental language model + for your use case is crucial for generating fast, high-quality + responses from EVI. + ellm_model: + type: optional + docs: >- + The eLLM setup associated with this Config. + + + Hume's eLLM (empathic Large Language Model) is a multimodal + language model that takes into account both expression measures + and language. The eLLM generates short, empathic language + responses and guides text-to-speech (TTS) prosody. + tools: + type: optional>> + docs: List of user-defined tools associated with this Config. + builtin_tools: + type: optional>> + docs: List of built-in tools associated with this Config. + event_messages: optional + timeouts: optional + content-type: application/json + response: + docs: Created + type: root.ReturnConfig + errors: + - root.BadRequestError + examples: + - request: + name: Weather Assistant Config + prompt: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 0 + evi_version: '2' + voice: + provider: HUME_AI + name: SAMPLE VOICE + language_model: + model_provider: ANTHROPIC + model_resource: claude-3-5-sonnet-20240620 + temperature: 1 + event_messages: + on_new_chat: + enabled: false + text: '' + on_inactivity_timeout: + enabled: false + text: '' + on_max_duration_timeout: + enabled: false + text: '' + response: + body: + id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + version: 0 + version_description: '' + name: Weather Assistant Config + created_on: 1715275452390 + modified_on: 1715275452390 + evi_version: '2' + prompt: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 0 + version_type: FIXED + version_description: '' + name: Weather Assistant Prompt + created_on: 1715267200693 + modified_on: 1715267200693 + 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. + voice: + provider: HUME_AI + name: SAMPLE VOICE + custom_voice: + id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704 + version: 1 + name: SAMPLE VOICE + created_on: 1724704587367 + modified_on: 1725489961583 + base_voice: KORA + parameter_model: 20241004-11parameter + parameters: + gender: 0 + articulation: -10 + assertiveness: 20 + buoyancy: -30 + confidence: -40 + enthusiasm: 50 + nasality: 45 + relaxedness: -35 + smoothness: 25 + tepidity: 15 + tightness: 5 + language_model: + model_provider: ANTHROPIC + model_resource: claude-3-5-sonnet-20240620 + temperature: 1 + ellm_model: + allow_short_responses: false + tools: [] + builtin_tools: [] + event_messages: + on_new_chat: + enabled: false + text: '' + on_inactivity_timeout: + enabled: false + text: '' + on_max_duration_timeout: + enabled: false + text: '' + timeouts: + inactivity: + enabled: true + duration_secs: 600 + max_duration: + enabled: true + duration_secs: 1800 + list-config-versions: + path: /v0/evi/configs/{id} + method: GET + auth: true + docs: >- + 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). + path-parameters: + id: + type: string + docs: Identifier for a Config. Formatted as a UUID. + display-name: List config versions + request: + name: ConfigsListConfigVersionsRequest + query-parameters: + page_number: + type: optional docs: >- - 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). - path-parameters: - id: - type: string - docs: Identifier for a Config. Formatted as a UUID. - version: - type: integer - docs: >- - 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. - display-name: Delete config version - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 - version: 1 - update-config-description: - path: /v0/evi/configs/{id}/version/{version} - method: PATCH - auth: true + Specifies the page number to retrieve, enabling pagination. + + + This parameter uses zero-based indexing. For example, setting + `page_number` to 0 retrieves the first page of results (items 0-9 + if `page_size` is 10), setting `page_number` to 1 retrieves the + second page (items 10-19), and so on. Defaults to 0, which + retrieves the first page. + page_size: + type: optional + docs: >- + Specifies the maximum number of results to include per page, + enabling pagination. The value must be between 1 and 100, + inclusive. + + + For example, if `page_size` is set to 10, each page will include + up to 10 items. Defaults to 10. + restrict_to_most_recent: + type: optional docs: >- - 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). - path-parameters: - id: - type: string - docs: Identifier for a Config. Formatted as a UUID. - version: - type: integer - docs: >- - 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. - display-name: Update config description - request: - name: PostedConfigVersionDescription - body: - properties: - version_description: - type: optional - docs: An optional description of the Config version. - content-type: application/json - response: - docs: Success - type: root.ReturnConfig - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + By default, `restrict_to_most_recent` is set to true, returning + only the latest version of each config. To include all versions of + each config in the list, set `restrict_to_most_recent` to false. + response: + docs: Success + type: root.ReturnPagedConfigs + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + response: + body: + page_number: 0 + page_size: 10 + total_pages: 1 + configs_page: + - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + version: 0 + version_description: '' + name: Weather Assistant Config + created_on: 1715275452390 + modified_on: 1715275452390 + evi_version: '2' + prompt: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 0 + version_type: FIXED + version_description: '' + name: Weather Assistant Prompt + created_on: 1715267200693 + modified_on: 1715267200693 + 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. + voice: + provider: HUME_AI + name: SAMPLE VOICE + custom_voice: + id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704 version: 1 - request: - version_description: This is an updated version_description. - response: - body: - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 - version: 1 - version_description: This is an updated version_description. - name: Weather Assistant Config - created_on: 1715275452390 - modified_on: 1715275452390 - evi_version: "2" - prompt: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 0 - version_type: FIXED - version_description: "" - name: Weather Assistant Prompt - created_on: 1715267200693 - modified_on: 1715267200693 - 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. - voice: - provider: HUME_AI - name: SAMPLE VOICE - custom_voice: - id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704 - version: 1 - name: SAMPLE VOICE - created_on: 1724704587367 - modified_on: 1725489961583 - base_voice: KORA - parameter_model: 20240715-4parameter - parameters: - gender: -7 - huskiness: -2 - nasality: -8 - pitch: -9 - language_model: - model_provider: ANTHROPIC - model_resource: claude-3-5-sonnet-20240620 - temperature: 1 - ellm_model: - allow_short_responses: false - tools: [] - builtin_tools: [] - event_messages: - on_new_chat: - enabled: false - text: "" - on_inactivity_timeout: - enabled: false - text: "" - on_max_duration_timeout: - enabled: false - text: "" - timeouts: - inactivity: - enabled: true - duration_secs: 600 - max_duration: - enabled: true - duration_secs: 1800 - source: - openapi: stenographer-openapi.json + name: SAMPLE VOICE + created_on: 1724704587367 + modified_on: 1725489961583 + base_voice: KORA + parameter_model: 20241004-11parameter + parameters: + gender: 0 + articulation: -10 + assertiveness: 20 + buoyancy: -30 + confidence: -40 + enthusiasm: 50 + nasality: 45 + relaxedness: -35 + smoothness: 25 + tepidity: 15 + tightness: 5 + language_model: + model_provider: ANTHROPIC + model_resource: claude-3-5-sonnet-20240620 + temperature: 1 + ellm_model: + allow_short_responses: false + tools: [] + builtin_tools: [] + event_messages: + on_new_chat: + enabled: false + text: '' + on_inactivity_timeout: + enabled: false + text: '' + on_max_duration_timeout: + enabled: false + text: '' + timeouts: + inactivity: + enabled: true + duration_secs: 600 + max_duration: + enabled: true + duration_secs: 1800 + create-config-version: + path: /v0/evi/configs/{id} + method: POST + auth: true + docs: >- + 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). + path-parameters: + id: + type: string + docs: Identifier for a Config. Formatted as a UUID. + display-name: Create config version + request: + name: PostedConfigVersion + body: + properties: + evi_version: + type: string + docs: The version of the EVI used with this config. + version_description: + type: optional + docs: An optional description of the Config version. + prompt: optional + voice: + type: optional + docs: A voice specification associated with this Config version. + language_model: + type: optional + docs: >- + The supplemental language model associated with this Config + version. + + + This model is used to generate longer, more detailed responses + from EVI. Choosing an appropriate supplemental language model + for your use case is crucial for generating fast, high-quality + responses from EVI. + ellm_model: + type: optional + docs: >- + The eLLM setup associated with this Config version. + + + Hume's eLLM (empathic Large Language Model) is a multimodal + language model that takes into account both expression measures + and language. The eLLM generates short, empathic language + responses and guides text-to-speech (TTS) prosody. + tools: + type: optional>> + docs: List of user-defined tools associated with this Config version. + builtin_tools: + type: optional>> + docs: List of built-in tools associated with this Config version. + event_messages: optional + timeouts: optional + content-type: application/json + response: + docs: Created + type: root.ReturnConfig + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + request: + version_description: This is an updated version of the Weather Assistant Config. + evi_version: '2' + prompt: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 0 + voice: + provider: HUME_AI + name: ITO + language_model: + model_provider: ANTHROPIC + model_resource: claude-3-5-sonnet-20240620 + temperature: 1 + ellm_model: + allow_short_responses: true + event_messages: + on_new_chat: + enabled: false + text: '' + on_inactivity_timeout: + enabled: false + text: '' + on_max_duration_timeout: + enabled: false + text: '' + response: + body: + id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + version: 1 + version_description: This is an updated version of the Weather Assistant Config. + name: Weather Assistant Config + created_on: 1715275452390 + modified_on: 1722642242998 + evi_version: '2' + prompt: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 0 + version_type: FIXED + version_description: '' + name: Weather Assistant Prompt + created_on: 1715267200693 + modified_on: 1715267200693 + 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. + voice: + provider: HUME_AI + name: ITO + custom_voice: + id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704 + version: 1 + name: SAMPLE VOICE + created_on: 1724704587367 + modified_on: 1725489961583 + base_voice: KORA + parameter_model: 20241004-11parameter + parameters: + gender: 0 + articulation: -10 + assertiveness: 20 + buoyancy: -30 + confidence: -40 + enthusiasm: 50 + nasality: 45 + relaxedness: -35 + smoothness: 25 + tepidity: 15 + tightness: 5 + language_model: + model_provider: ANTHROPIC + model_resource: claude-3-5-sonnet-20240620 + temperature: 1 + ellm_model: + allow_short_responses: true + tools: [] + builtin_tools: [] + event_messages: + on_new_chat: + enabled: false + text: '' + on_inactivity_timeout: + enabled: false + text: '' + on_max_duration_timeout: + enabled: false + text: '' + timeouts: + inactivity: + enabled: true + duration_secs: 600 + max_duration: + enabled: true + duration_secs: 1800 + delete-config: + path: /v0/evi/configs/{id} + method: DELETE + auth: true + docs: >- + 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). + path-parameters: + id: + type: string + docs: Identifier for a Config. Formatted as a UUID. + display-name: Delete config + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + update-config-name: + path: /v0/evi/configs/{id} + method: PATCH + auth: true + docs: >- + 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). + path-parameters: + id: + type: string + docs: Identifier for a Config. Formatted as a UUID. + display-name: Update config name + request: + name: PostedConfigName + body: + properties: + name: + type: string + docs: Name applied to all versions of a particular Config. + content-type: application/json + response: + docs: Success + type: text + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + request: + name: Updated Weather Assistant Config Name + get-config-version: + path: /v0/evi/configs/{id}/version/{version} + method: GET + auth: true + docs: >- + 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). + path-parameters: + id: + type: string + docs: Identifier for a Config. Formatted as a UUID. + version: + type: integer + docs: >- + 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. + display-name: Get config version + response: + docs: Success + type: root.ReturnConfig + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + version: 1 + response: + body: + id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + version: 1 + version_description: '' + name: Weather Assistant Config + created_on: 1715275452390 + modified_on: 1715275452390 + evi_version: '2' + prompt: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 0 + version_type: FIXED + version_description: '' + name: Weather Assistant Prompt + created_on: 1715267200693 + modified_on: 1715267200693 + 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. + voice: + provider: HUME_AI + name: SAMPLE VOICE + custom_voice: + id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704 + version: 1 + name: SAMPLE VOICE + created_on: 1724704587367 + modified_on: 1725489961583 + base_voice: KORA + parameter_model: 20241004-11parameter + parameters: + gender: 0 + articulation: -10 + assertiveness: 20 + buoyancy: -30 + confidence: -40 + enthusiasm: 50 + nasality: 45 + relaxedness: -35 + smoothness: 25 + tepidity: 15 + tightness: 5 + language_model: + model_provider: ANTHROPIC + model_resource: claude-3-5-sonnet-20240620 + temperature: 1 + ellm_model: + allow_short_responses: false + tools: [] + builtin_tools: [] + event_messages: + on_new_chat: + enabled: false + text: '' + on_inactivity_timeout: + enabled: false + text: '' + on_max_duration_timeout: + enabled: false + text: '' + timeouts: + inactivity: + enabled: true + duration_secs: 600 + max_duration: + enabled: true + duration_secs: 1800 + delete-config-version: + path: /v0/evi/configs/{id}/version/{version} + method: DELETE + auth: true + docs: >- + 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). + path-parameters: + id: + type: string + docs: Identifier for a Config. Formatted as a UUID. + version: + type: integer + docs: >- + 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. + display-name: Delete config version + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + version: 1 + update-config-description: + path: /v0/evi/configs/{id}/version/{version} + method: PATCH + auth: true + docs: >- + 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). + path-parameters: + id: + type: string + docs: Identifier for a Config. Formatted as a UUID. + version: + type: integer + docs: >- + 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. + display-name: Update config description + request: + name: PostedConfigVersionDescription + body: + properties: + version_description: + type: optional + docs: An optional description of the Config version. + content-type: application/json + response: + docs: Success + type: root.ReturnConfig + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + version: 1 + request: + version_description: This is an updated version_description. + response: + body: + id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3 + version: 1 + version_description: This is an updated version_description. + name: Weather Assistant Config + created_on: 1715275452390 + modified_on: 1715275452390 + evi_version: '2' + prompt: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 0 + version_type: FIXED + version_description: '' + name: Weather Assistant Prompt + created_on: 1715267200693 + modified_on: 1715267200693 + 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. + voice: + provider: HUME_AI + name: SAMPLE VOICE + custom_voice: + id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704 + version: 1 + name: SAMPLE VOICE + created_on: 1724704587367 + modified_on: 1725489961583 + base_voice: KORA + parameter_model: 20241004-11parameter + parameters: + gender: 0 + articulation: -10 + assertiveness: 20 + buoyancy: -30 + confidence: -40 + enthusiasm: 50 + nasality: 45 + relaxedness: -35 + smoothness: 25 + tepidity: 15 + tightness: 5 + language_model: + model_provider: ANTHROPIC + model_resource: claude-3-5-sonnet-20240620 + temperature: 1 + ellm_model: + allow_short_responses: false + tools: [] + builtin_tools: [] + event_messages: + on_new_chat: + enabled: false + text: '' + on_inactivity_timeout: + enabled: false + text: '' + on_max_duration_timeout: + enabled: false + text: '' + timeouts: + inactivity: + enabled: true + duration_secs: 600 + max_duration: + enabled: true + duration_secs: 1800 + source: + openapi: stenographer-openapi.json diff --git a/.mock/definition/empathic-voice/customVoices.yml b/.mock/definition/empathic-voice/customVoices.yml index a48799d8..9ec0bd61 100644 --- a/.mock/definition/empathic-voice/customVoices.yml +++ b/.mock/definition/empathic-voice/customVoices.yml @@ -1,238 +1,259 @@ imports: - root: __package__.yml + root: __package__.yml service: - auth: false - base-path: "" - endpoints: - list-custom-voices: - path: /v0/evi/custom_voices - method: GET - auth: true - docs: >- - Fetches a paginated list of **Custom Voices**. - - - Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) - for details on creating a custom voice. - display-name: List custom voices - request: - name: CustomVoicesListCustomVoicesRequest - query-parameters: - page_number: - type: optional - docs: >- - Specifies the page number to retrieve, enabling pagination. - - - This parameter uses zero-based indexing. For example, setting - `page_number` to 0 retrieves the first page of results (items 0-9 - if `page_size` is 10), setting `page_number` to 1 retrieves the - second page (items 10-19), and so on. Defaults to 0, which - retrieves the first page. - page_size: - type: optional - docs: >- - Specifies the maximum number of results to include per page, - enabling pagination. The value must be between 1 and 100, - inclusive. - - - For example, if `page_size` is set to 10, each page will include - up to 10 items. Defaults to 10. - name: - type: optional - docs: Filter to only include custom voices with this name. - response: - docs: Success - type: root.ReturnPagedCustomVoices - errors: - - root.BadRequestError - examples: - - response: - body: - page_number: 1 - page_size: 1 - total_pages: 1 - custom_voices_page: - - id: id - version: 1 - name: name - created_on: 1000000 - modified_on: 1000000 - base_voice: ITO - parameter_model: 20240715-4parameter - parameters: {} - create-custom-voice: - path: /v0/evi/custom_voices - method: POST - auth: true - docs: >- - Creates a **Custom Voice** that can be added to an [EVI - configuration](/reference/empathic-voice-interface-evi/configs/create-config). - - - Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) - for details on creating a custom voice. - display-name: Create custom voice - request: - body: root.PostedCustomVoice - content-type: application/json - response: - docs: Created - type: root.ReturnCustomVoice - errors: - - root.BadRequestError - examples: - - request: - name: name - base_voice: ITO - parameter_model: 20240715-4parameter - response: - body: - id: id - version: 1 - name: name - created_on: 1000000 - modified_on: 1000000 - base_voice: ITO - parameter_model: 20240715-4parameter - parameters: - gender: 1 - huskiness: 1 - nasality: 1 - pitch: 1 - get-custom-voice: - path: /v0/evi/custom_voices/{id} - method: GET - auth: true - docs: >- - Fetches a specific **Custom Voice** by ID. - - - Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) - for details on creating a custom voice. - path-parameters: - id: - type: string - docs: Identifier for a Custom Voice. Formatted as a UUID. - display-name: Get specific custom voice by ID - response: - docs: Success - type: root.ReturnCustomVoice - errors: - - root.BadRequestError - examples: - - path-parameters: - id: id - response: - body: - id: id - version: 1 - name: name - created_on: 1000000 - modified_on: 1000000 - base_voice: ITO - parameter_model: 20240715-4parameter - parameters: - gender: 1 - huskiness: 1 - nasality: 1 - pitch: 1 - create-custom-voice-version: - path: /v0/evi/custom_voices/{id} - method: POST - auth: true - docs: >- - Updates a **Custom Voice** by creating a new version of the **Custom - Voice**. - - - Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) - for details on creating a custom voice. - path-parameters: - id: - type: string - docs: Identifier for a Custom Voice. Formatted as a UUID. - display-name: Create new version of existing custom voice - request: - body: root.PostedCustomVoice - content-type: application/json - response: - docs: Created - type: root.ReturnCustomVoice - errors: - - root.BadRequestError - examples: - - path-parameters: - id: id - request: - name: name - base_voice: ITO - parameter_model: 20240715-4parameter - response: - body: - id: id - version: 1 - name: name - created_on: 1000000 - modified_on: 1000000 - base_voice: ITO - parameter_model: 20240715-4parameter - parameters: - gender: 1 - huskiness: 1 - nasality: 1 - pitch: 1 - delete-custom-voice: - path: /v0/evi/custom_voices/{id} - method: DELETE - auth: true + auth: false + base-path: '' + endpoints: + list-custom-voices: + path: /v0/evi/custom_voices + method: GET + auth: true + docs: >- + Fetches a paginated list of **Custom Voices**. + + + Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) + for details on creating a custom voice. + display-name: List custom voices + request: + name: CustomVoicesListCustomVoicesRequest + query-parameters: + page_number: + type: optional docs: >- - Deletes a **Custom Voice** and its versions. - - - Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) - for details on creating a custom voice. - path-parameters: - id: - type: string - docs: Identifier for a Custom Voice. Formatted as a UUID. - display-name: Delete a custom voice - errors: - - root.BadRequestError - examples: - - path-parameters: - id: id - update-custom-voice-name: - path: /v0/evi/custom_voices/{id} - method: PATCH - auth: true + Specifies the page number to retrieve, enabling pagination. + + + This parameter uses zero-based indexing. For example, setting + `page_number` to 0 retrieves the first page of results (items 0-9 + if `page_size` is 10), setting `page_number` to 1 retrieves the + second page (items 10-19), and so on. Defaults to 0, which + retrieves the first page. + page_size: + type: optional docs: >- - Updates the name of a **Custom Voice**. - - - Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) - for details on creating a custom voice. - path-parameters: - id: - type: string - docs: Identifier for a Custom Voice. Formatted as a UUID. - display-name: Update custom voice name - request: - name: PostedCustomVoiceName - body: - properties: - name: - type: string - docs: >- - The name of the Custom Voice. Maximum length of 75 characters. - Will be converted to all-uppercase. (e.g., "sample voice" - becomes "SAMPLE VOICE") - content-type: application/json - response: - docs: Success - type: text - errors: - - root.BadRequestError - source: - openapi: stenographer-openapi.json + Specifies the maximum number of results to include per page, + enabling pagination. The value must be between 1 and 100, + inclusive. + + + For example, if `page_size` is set to 10, each page will include + up to 10 items. Defaults to 10. + name: + type: optional + docs: Filter to only include custom voices with name. + response: + docs: Success + type: root.ReturnPagedCustomVoices + errors: + - root.BadRequestError + examples: + - response: + body: + page_number: 1 + page_size: 1 + total_pages: 1 + custom_voices_page: + - id: id + version: 1 + name: name + created_on: 1000000 + modified_on: 1000000 + base_voice: ITO + parameter_model: 20241004-11parameter + parameters: {} + create-custom-voice: + path: /v0/evi/custom_voices + method: POST + auth: true + docs: >- + Creates a **Custom Voice** that can be added to an [EVI + configuration](/reference/empathic-voice-interface-evi/configs/create-config). + + + Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) + for details on creating a custom voice. + display-name: Create custom voice + request: + body: root.PostedCustomVoice + content-type: application/json + response: + docs: Created + type: root.ReturnCustomVoice + errors: + - root.BadRequestError + examples: + - request: + name: name + base_voice: ITO + parameter_model: 20241004-11parameter + response: + body: + id: id + version: 1 + name: name + created_on: 1000000 + modified_on: 1000000 + base_voice: ITO + parameter_model: 20241004-11parameter + parameters: + gender: 1 + articulation: 1 + assertiveness: 1 + buoyancy: 1 + confidence: 1 + enthusiasm: 1 + nasality: 1 + relaxedness: 1 + smoothness: 1 + tepidity: 1 + tightness: 1 + get-custom-voice: + path: /v0/evi/custom_voices/{id} + method: GET + auth: true + docs: >- + Fetches a specific **Custom Voice** by ID. + + + Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) + for details on creating a custom voice. + path-parameters: + id: + type: string + docs: Identifier for a Custom Voice. Formatted as a UUID. + display-name: Get specific custom voice by ID + response: + docs: Success + type: root.ReturnCustomVoice + errors: + - root.BadRequestError + examples: + - path-parameters: + id: id + response: + body: + id: id + version: 1 + name: name + created_on: 1000000 + modified_on: 1000000 + base_voice: ITO + parameter_model: 20241004-11parameter + parameters: + gender: 1 + articulation: 1 + assertiveness: 1 + buoyancy: 1 + confidence: 1 + enthusiasm: 1 + nasality: 1 + relaxedness: 1 + smoothness: 1 + tepidity: 1 + tightness: 1 + create-custom-voice-version: + path: /v0/evi/custom_voices/{id} + method: POST + auth: true + docs: >- + Updates a **Custom Voice** by creating a new version of the **Custom + Voice**. + + + Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) + for details on creating a custom voice. + path-parameters: + id: + type: string + docs: Identifier for a Custom Voice. Formatted as a UUID. + display-name: Create new version of existing custom voice + request: + body: root.PostedCustomVoice + content-type: application/json + response: + docs: Created + type: root.ReturnCustomVoice + errors: + - root.BadRequestError + examples: + - path-parameters: + id: id + request: + name: name + base_voice: ITO + parameter_model: 20241004-11parameter + response: + body: + id: id + version: 1 + name: name + created_on: 1000000 + modified_on: 1000000 + base_voice: ITO + parameter_model: 20241004-11parameter + parameters: + gender: 1 + articulation: 1 + assertiveness: 1 + buoyancy: 1 + confidence: 1 + enthusiasm: 1 + nasality: 1 + relaxedness: 1 + smoothness: 1 + tepidity: 1 + tightness: 1 + delete-custom-voice: + path: /v0/evi/custom_voices/{id} + method: DELETE + auth: true + docs: >- + Deletes a **Custom Voice** and its versions. + + + Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) + for details on creating a custom voice. + path-parameters: + id: + type: string + docs: Identifier for a Custom Voice. Formatted as a UUID. + display-name: Delete a custom voice + errors: + - root.BadRequestError + examples: + - path-parameters: + id: id + update-custom-voice-name: + path: /v0/evi/custom_voices/{id} + method: PATCH + auth: true + docs: >- + Updates the name of a **Custom Voice**. + + + Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) + for details on creating a custom voice. + path-parameters: + id: + type: string + docs: Identifier for a Custom Voice. Formatted as a UUID. + display-name: Update custom voice name + request: + name: PostedCustomVoiceName + body: + properties: + name: + type: string + docs: >- + The name of the Custom Voice. Maximum length of 75 characters. + Will be converted to all-uppercase. (e.g., "sample voice" + becomes "SAMPLE VOICE") + content-type: application/json + response: + docs: Success + type: text + errors: + - root.BadRequestError + source: + openapi: stenographer-openapi.json diff --git a/.mock/definition/empathic-voice/prompts.yml b/.mock/definition/empathic-voice/prompts.yml index eb96396f..5808c38a 100644 --- a/.mock/definition/empathic-voice/prompts.yml +++ b/.mock/definition/empathic-voice/prompts.yml @@ -1,533 +1,530 @@ imports: - root: __package__.yml + root: __package__.yml service: - auth: false - base-path: "" - endpoints: - list-prompts: - path: /v0/evi/prompts - method: GET - auth: true + auth: false + base-path: '' + endpoints: + list-prompts: + path: /v0/evi/prompts + method: GET + auth: true + docs: >- + Fetches a paginated list of **Prompts**. + + + See our [prompting + guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on + crafting your system prompt. + pagination: + offset: $request.page_number + results: $response.prompts_page + display-name: List prompts + request: + name: PromptsListPromptsRequest + query-parameters: + page_number: + type: optional docs: >- - Fetches a paginated list of **Prompts**. - - - See our [prompting - guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on - crafting your system prompt. - pagination: - offset: $request.page_number - results: $response.prompts_page - display-name: List prompts - request: - name: PromptsListPromptsRequest - query-parameters: - page_number: - type: optional - docs: >- - Specifies the page number to retrieve, enabling pagination. - - - This parameter uses zero-based indexing. For example, setting - `page_number` to 0 retrieves the first page of results (items 0-9 - if `page_size` is 10), setting `page_number` to 1 retrieves the - second page (items 10-19), and so on. Defaults to 0, which - retrieves the first page. - page_size: - type: optional - docs: >- - Specifies the maximum number of results to include per page, - enabling pagination. The value must be between 1 and 100, - inclusive. - - - For example, if `page_size` is set to 10, each page will include - up to 10 items. Defaults to 10. - restrict_to_most_recent: - type: optional - docs: >- - By default, `restrict_to_most_recent` is set to true, returning - only the latest version of each prompt. To include all versions of - each prompt in the list, set `restrict_to_most_recent` to false. - name: - type: optional - docs: Filter to only include prompts with this name. - response: - docs: Success - type: root.ReturnPagedPrompts - errors: - - root.BadRequestError - examples: - - query-parameters: - page_number: 0 - page_size: 2 - response: - body: - page_number: 0 - page_size: 2 - total_pages: 1 - prompts_page: - - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 0 - version_type: FIXED - version_description: "" - name: Weather Assistant Prompt - created_on: 1715267200693 - modified_on: 1715267200693 - 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. - - id: 616b2b4c-a096-4445-9c23-64058b564fc2 - version: 0 - version_type: FIXED - version_description: "" - name: Web Search Assistant Prompt - created_on: 1715267200693 - modified_on: 1715267200693 - text: >- - You are an AI web search assistant designed to help - users find accurate and relevant information on the web. - Respond to user queries promptly, using the built-in web - search tool to retrieve up-to-date results. Present - information clearly and concisely, summarizing key points - where necessary. Use simple language and avoid technical - jargon. If needed, provide helpful tips for refining search - queries to obtain better results. - create-prompt: - path: /v0/evi/prompts - method: POST - auth: true - docs: >- - 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. - display-name: Create prompt - request: - name: PostedPrompt - body: - properties: - name: - type: string - docs: Name applied to all versions of a particular Prompt. - version_description: - type: optional - docs: An optional description of the Prompt version. - text: - type: string - docs: >- - Instructions used to shape EVI’s behavior, responses, and style. - - - You can use the Prompt to define a specific goal or role for - EVI, specifying how it should act or what it should focus on - during the conversation. For example, EVI can be instructed to - act as a customer support representative, a fitness coach, or a - travel advisor, each with its own set of behaviors and response - styles. - - - For help writing a system prompt, see our [Prompting - Guide](/docs/empathic-voice-interface-evi/prompting). - content-type: application/json - response: - docs: Created - type: optional - errors: - - root.BadRequestError - examples: - - request: - 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. - response: - body: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 0 - version_type: FIXED - name: Weather Assistant Prompt - created_on: 1722633247488 - modified_on: 1722633247488 - 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. - list-prompt-versions: - path: /v0/evi/prompts/{id} - method: GET - auth: true - docs: >- - 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. - path-parameters: - id: - type: string - docs: Identifier for a Prompt. Formatted as a UUID. - display-name: List prompt versions - request: - name: PromptsListPromptVersionsRequest - query-parameters: - page_number: - type: optional - docs: >- - Specifies the page number to retrieve, enabling pagination. - - - This parameter uses zero-based indexing. For example, setting - `page_number` to 0 retrieves the first page of results (items 0-9 - if `page_size` is 10), setting `page_number` to 1 retrieves the - second page (items 10-19), and so on. Defaults to 0, which - retrieves the first page. - page_size: - type: optional - docs: >- - Specifies the maximum number of results to include per page, - enabling pagination. The value must be between 1 and 100, - inclusive. - - - For example, if `page_size` is set to 10, each page will include - up to 10 items. Defaults to 10. - restrict_to_most_recent: - type: optional - docs: >- - By default, `restrict_to_most_recent` is set to true, returning - only the latest version of each prompt. To include all versions of - each prompt in the list, set `restrict_to_most_recent` to false. - response: - docs: Success - type: root.ReturnPagedPrompts - errors: - - root.BadRequestError - examples: - - path-parameters: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - response: - body: - page_number: 0 - page_size: 10 - total_pages: 1 - prompts_page: - - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 0 - version_type: FIXED - version_description: "" - name: Weather Assistant Prompt - created_on: 1722633247488 - modified_on: 1722633247488 - 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. - create-prompt-verison: - path: /v0/evi/prompts/{id} - method: POST - auth: true - docs: >- - Updates a **Prompt** by creating a new version of the **Prompt**. - - - See our [prompting - guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on - crafting your system prompt. - path-parameters: - id: - type: string - docs: Identifier for a Prompt. Formatted as a UUID. - display-name: Create prompt version - request: - name: PostedPromptVersion - body: - properties: - version_description: - type: optional - docs: An optional description of the Prompt version. - text: - type: string - docs: >- - Instructions used to shape EVI’s behavior, responses, and style - for this version of the Prompt. - - - You can use the Prompt to define a specific goal or role for - EVI, specifying how it should act or what it should focus on - during the conversation. For example, EVI can be instructed to - act as a customer support representative, a fitness coach, or a - travel advisor, each with its own set of behaviors and response - styles. - - - For help writing a system prompt, see our [Prompting - Guide](/docs/empathic-voice-interface-evi/prompting). - content-type: application/json - response: - docs: Created - type: optional - errors: - - root.BadRequestError - examples: - - path-parameters: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - request: - text: >- - You are an updated version of an AI weather assistant - providing users with accurate and up-to-date weather information. - Respond to user queries concisely and clearly. Use simple language - and avoid technical jargon. Provide temperature, precipitation, - wind conditions, and any weather alerts. Include helpful tips if - severe weather is expected. - version_description: This is an updated version of the Weather Assistant Prompt. - response: - body: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 1 - version_type: FIXED - version_description: This is an updated version of the Weather Assistant Prompt. - name: Weather Assistant Prompt - created_on: 1722633247488 - modified_on: 1722635140150 - 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. - delete-prompt: - path: /v0/evi/prompts/{id} - method: DELETE - auth: true - docs: >- - Deletes a **Prompt** and its versions. - - - See our [prompting - guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on - crafting your system prompt. - path-parameters: - id: - type: string - docs: Identifier for a Prompt. Formatted as a UUID. - display-name: Delete prompt - errors: - - root.BadRequestError - examples: - - path-parameters: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - update-prompt-name: - path: /v0/evi/prompts/{id} - method: PATCH - auth: true + Specifies the page number to retrieve, enabling pagination. + + + This parameter uses zero-based indexing. For example, setting + `page_number` to 0 retrieves the first page of results (items 0-9 + if `page_size` is 10), setting `page_number` to 1 retrieves the + second page (items 10-19), and so on. Defaults to 0, which + retrieves the first page. + page_size: + type: optional docs: >- - Updates the name of a **Prompt**. - - - See our [prompting - guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on - crafting your system prompt. - path-parameters: - id: - type: string - docs: Identifier for a Prompt. Formatted as a UUID. - display-name: Update prompt name - request: - name: PostedPromptName - body: - properties: - name: - type: string - docs: Name applied to all versions of a particular Prompt. - content-type: application/json - response: - docs: Success - type: text - errors: - - root.BadRequestError - examples: - - path-parameters: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - request: - name: Updated Weather Assistant Prompt Name - get-prompt-version: - path: /v0/evi/prompts/{id}/version/{version} - method: GET - auth: true + Specifies the maximum number of results to include per page, + enabling pagination. The value must be between 1 and 100, + inclusive. + + + For example, if `page_size` is set to 10, each page will include + up to 10 items. Defaults to 10. + restrict_to_most_recent: + type: optional + docs: Only include the most recent version of each prompt in the list. + name: + type: optional + docs: Filter to only include prompts with name. + response: + docs: Success + type: root.ReturnPagedPrompts + errors: + - root.BadRequestError + examples: + - query-parameters: + page_number: 0 + page_size: 2 + response: + body: + page_number: 0 + page_size: 2 + total_pages: 1 + prompts_page: + - id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 0 + version_type: FIXED + version_description: '' + name: Weather Assistant Prompt + created_on: 1715267200693 + modified_on: 1715267200693 + 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. + - id: 616b2b4c-a096-4445-9c23-64058b564fc2 + version: 0 + version_type: FIXED + version_description: '' + name: Web Search Assistant Prompt + created_on: 1715267200693 + modified_on: 1715267200693 + text: >- + You are an AI web search assistant designed to help + users find accurate and relevant information on the web. + Respond to user queries promptly, using the built-in web + search tool to retrieve up-to-date results. Present + information clearly and concisely, summarizing key points + where necessary. Use simple language and avoid technical + jargon. If needed, provide helpful tips for refining search + queries to obtain better results. + create-prompt: + path: /v0/evi/prompts + method: POST + auth: true + docs: >- + 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. + display-name: Create prompt + request: + name: PostedPrompt + body: + properties: + name: + type: string + docs: Name applied to all versions of a particular Prompt. + version_description: + type: optional + docs: An optional description of the Prompt version. + text: + type: string + docs: >- + Instructions used to shape EVI’s behavior, responses, and style. + + + You can use the Prompt to define a specific goal or role for + EVI, specifying how it should act or what it should focus on + during the conversation. For example, EVI can be instructed to + act as a customer support representative, a fitness coach, or a + travel advisor, each with its own set of behaviors and response + styles. + + + For help writing a system prompt, see our [Prompting + Guide](/docs/empathic-voice-interface-evi/prompting). + content-type: application/json + response: + docs: Created + type: optional + errors: + - root.BadRequestError + examples: + - request: + 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. + response: + body: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 0 + version_type: FIXED + name: Weather Assistant Prompt + created_on: 1722633247488 + modified_on: 1722633247488 + 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. + list-prompt-versions: + path: /v0/evi/prompts/{id} + method: GET + auth: true + docs: >- + 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. + path-parameters: + id: + type: string + docs: Identifier for a Prompt. Formatted as a UUID. + display-name: List prompt versions + request: + name: PromptsListPromptVersionsRequest + query-parameters: + page_number: + type: optional docs: >- - Fetches a specified version of a **Prompt**. - - - See our [prompting - guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on - crafting your system prompt. - path-parameters: - id: - type: string - docs: Identifier for a Prompt. Formatted as a UUID. - version: - type: integer - docs: >- - 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. - display-name: Get prompt version - response: - docs: Success - type: optional - errors: - - root.BadRequestError - examples: - - path-parameters: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 0 - response: - body: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 0 - version_type: FIXED - version_description: "" - name: Weather Assistant Prompt - created_on: 1722633247488 - modified_on: 1722633247488 - 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. - delete-prompt-version: - path: /v0/evi/prompts/{id}/version/{version} - method: DELETE - auth: true + Specifies the page number to retrieve, enabling pagination. + + + This parameter uses zero-based indexing. For example, setting + `page_number` to 0 retrieves the first page of results (items 0-9 + if `page_size` is 10), setting `page_number` to 1 retrieves the + second page (items 10-19), and so on. Defaults to 0, which + retrieves the first page. + page_size: + type: optional docs: >- - Deletes a specified version of a **Prompt**. - - - See our [prompting - guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on - crafting your system prompt. - path-parameters: - id: - type: string - docs: Identifier for a Prompt. Formatted as a UUID. - version: - type: integer - docs: >- - 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. - display-name: Delete prompt version - errors: - - root.BadRequestError - examples: - - path-parameters: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 1 - update-prompt-description: - path: /v0/evi/prompts/{id}/version/{version} - method: PATCH - auth: true + Specifies the maximum number of results to include per page, + enabling pagination. The value must be between 1 and 100, + inclusive. + + + For example, if `page_size` is set to 10, each page will include + up to 10 items. Defaults to 10. + restrict_to_most_recent: + type: optional docs: >- - Updates the description of a **Prompt**. - - - See our [prompting - guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on - crafting your system prompt. - path-parameters: - id: - type: string - docs: Identifier for a Prompt. Formatted as a UUID. - version: - type: integer - docs: >- - 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. - display-name: Update prompt description - request: - name: PostedPromptVersionDescription - body: - properties: - version_description: - type: optional - docs: An optional description of the Prompt version. - content-type: application/json - response: - docs: Success - type: optional - errors: - - root.BadRequestError - examples: - - path-parameters: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 1 - request: - version_description: This is an updated version_description. - response: - body: - id: af699d45-2985-42cc-91b9-af9e5da3bac5 - version: 1 - version_type: FIXED - version_description: This is an updated version_description. - name: string - created_on: 1722633247488 - modified_on: 1722634770585 - 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. - source: - openapi: stenographer-openapi.json + By default, `restrict_to_most_recent` is set to true, returning + only the latest version of each prompt. To include all versions of + each prompt in the list, set `restrict_to_most_recent` to false. + response: + docs: Success + type: root.ReturnPagedPrompts + errors: + - root.BadRequestError + examples: + - path-parameters: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + response: + body: + page_number: 0 + page_size: 10 + total_pages: 1 + prompts_page: + - id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 0 + version_type: FIXED + version_description: '' + name: Weather Assistant Prompt + created_on: 1722633247488 + modified_on: 1722633247488 + 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. + create-prompt-verison: + path: /v0/evi/prompts/{id} + method: POST + auth: true + docs: >- + Updates a **Prompt** by creating a new version of the **Prompt**. + + + See our [prompting + guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on + crafting your system prompt. + path-parameters: + id: + type: string + docs: Identifier for a Prompt. Formatted as a UUID. + display-name: Create prompt version + request: + name: PostedPromptVersion + body: + properties: + version_description: + type: optional + docs: An optional description of the Prompt version. + text: + type: string + docs: >- + Instructions used to shape EVI’s behavior, responses, and style + for this version of the Prompt. + + + You can use the Prompt to define a specific goal or role for + EVI, specifying how it should act or what it should focus on + during the conversation. For example, EVI can be instructed to + act as a customer support representative, a fitness coach, or a + travel advisor, each with its own set of behaviors and response + styles. + + + For help writing a system prompt, see our [Prompting + Guide](/docs/empathic-voice-interface-evi/prompting). + content-type: application/json + response: + docs: Created + type: optional + errors: + - root.BadRequestError + examples: + - path-parameters: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + request: + text: >- + You are an updated version of an AI weather assistant + providing users with accurate and up-to-date weather information. + Respond to user queries concisely and clearly. Use simple language + and avoid technical jargon. Provide temperature, precipitation, + wind conditions, and any weather alerts. Include helpful tips if + severe weather is expected. + version_description: This is an updated version of the Weather Assistant Prompt. + response: + body: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 1 + version_type: FIXED + version_description: This is an updated version of the Weather Assistant Prompt. + name: Weather Assistant Prompt + created_on: 1722633247488 + modified_on: 1722635140150 + 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. + delete-prompt: + path: /v0/evi/prompts/{id} + method: DELETE + auth: true + docs: >- + Deletes a **Prompt** and its versions. + + + See our [prompting + guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on + crafting your system prompt. + path-parameters: + id: + type: string + docs: Identifier for a Prompt. Formatted as a UUID. + display-name: Delete prompt + errors: + - root.BadRequestError + examples: + - path-parameters: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + update-prompt-name: + path: /v0/evi/prompts/{id} + method: PATCH + auth: true + docs: >- + Updates the name of a **Prompt**. + + + See our [prompting + guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on + crafting your system prompt. + path-parameters: + id: + type: string + docs: Identifier for a Prompt. Formatted as a UUID. + display-name: Update prompt name + request: + name: PostedPromptName + body: + properties: + name: + type: string + docs: Name applied to all versions of a particular Prompt. + content-type: application/json + response: + docs: Success + type: text + errors: + - root.BadRequestError + examples: + - path-parameters: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + request: + name: Updated Weather Assistant Prompt Name + get-prompt-version: + path: /v0/evi/prompts/{id}/version/{version} + method: GET + auth: true + docs: >- + Fetches a specified version of a **Prompt**. + + + See our [prompting + guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on + crafting your system prompt. + path-parameters: + id: + type: string + docs: Identifier for a Prompt. Formatted as a UUID. + version: + type: integer + docs: >- + 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. + display-name: Get prompt version + response: + docs: Success + type: optional + errors: + - root.BadRequestError + examples: + - path-parameters: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 0 + response: + body: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 0 + version_type: FIXED + version_description: '' + name: Weather Assistant Prompt + created_on: 1722633247488 + modified_on: 1722633247488 + 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. + delete-prompt-version: + path: /v0/evi/prompts/{id}/version/{version} + method: DELETE + auth: true + docs: >- + Deletes a specified version of a **Prompt**. + + + See our [prompting + guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on + crafting your system prompt. + path-parameters: + id: + type: string + docs: Identifier for a Prompt. Formatted as a UUID. + version: + type: integer + docs: >- + 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. + display-name: Delete prompt version + errors: + - root.BadRequestError + examples: + - path-parameters: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 1 + update-prompt-description: + path: /v0/evi/prompts/{id}/version/{version} + method: PATCH + auth: true + docs: >- + Updates the description of a **Prompt**. + + + See our [prompting + guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on + crafting your system prompt. + path-parameters: + id: + type: string + docs: Identifier for a Prompt. Formatted as a UUID. + version: + type: integer + docs: >- + 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. + display-name: Update prompt description + request: + name: PostedPromptVersionDescription + body: + properties: + version_description: + type: optional + docs: An optional description of the Prompt version. + content-type: application/json + response: + docs: Success + type: optional + errors: + - root.BadRequestError + examples: + - path-parameters: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 1 + request: + version_description: This is an updated version_description. + response: + body: + id: af699d45-2985-42cc-91b9-af9e5da3bac5 + version: 1 + version_type: FIXED + version_description: This is an updated version_description. + name: string + created_on: 1722633247488 + modified_on: 1722634770585 + 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. + source: + openapi: stenographer-openapi.json diff --git a/.mock/definition/empathic-voice/tools.yml b/.mock/definition/empathic-voice/tools.yml index 92807650..5aaec158 100644 --- a/.mock/definition/empathic-voice/tools.yml +++ b/.mock/definition/empathic-voice/tools.yml @@ -1,596 +1,596 @@ imports: - root: __package__.yml + root: __package__.yml service: - auth: false - base-path: "" - endpoints: - list-tools: - path: /v0/evi/tools - method: GET - auth: true + auth: false + base-path: '' + endpoints: + list-tools: + path: /v0/evi/tools + method: GET + auth: true + docs: >- + 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. + pagination: + offset: $request.page_number + results: $response.tools_page + display-name: List tools + request: + name: ToolsListToolsRequest + query-parameters: + page_number: + type: optional docs: >- - 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. - pagination: - offset: $request.page_number - results: $response.tools_page - display-name: List tools - request: - name: ToolsListToolsRequest - query-parameters: - page_number: - type: optional - docs: >- - Specifies the page number to retrieve, enabling pagination. - - - This parameter uses zero-based indexing. For example, setting - `page_number` to 0 retrieves the first page of results (items 0-9 - if `page_size` is 10), setting `page_number` to 1 retrieves the - second page (items 10-19), and so on. Defaults to 0, which - retrieves the first page. - page_size: - type: optional - docs: >- - Specifies the maximum number of results to include per page, - enabling pagination. The value must be between 1 and 100, - inclusive. - - - For example, if `page_size` is set to 10, each page will include - up to 10 items. Defaults to 10. - restrict_to_most_recent: - type: optional - docs: >- - By default, `restrict_to_most_recent` is set to true, returning - only the latest version of each tool. To include all versions of - each tool in the list, set `restrict_to_most_recent` to false. - name: - type: optional - docs: Filter to only include tools with this name. - response: - docs: Success - type: root.ReturnPagedUserDefinedTools - errors: - - root.BadRequestError - examples: - - query-parameters: - page_number: 0 - page_size: 2 - response: - body: - page_number: 0 - page_size: 2 - total_pages: 1 - tools_page: - - tool_type: FUNCTION - id: d20827af-5d8d-4f66-b6b9-ce2e3e1ea2b2 - version: 0 - version_type: FIXED - version_description: Fetches user's current location. - name: get_current_location - created_on: 1715267200693 - modified_on: 1715267200693 - fallback_content: Unable to fetch location. - description: Fetches user's current location. - parameters: >- - { "type": "object", "properties": { "location": { "type": - "string", "description": "The city and state, e.g. San - Francisco, CA" }}, "required": ["location"] } - - tool_type: FUNCTION - id: 4442f3ea-9038-40e3-a2ce-1522b7de770f - version: 0 - version_type: FIXED - version_description: >- - Fetches current weather and uses celsius or fahrenheit based - on location of user. - name: get_current_weather - created_on: 1715266126705 - modified_on: 1715266126705 - fallback_content: Unable to fetch location. - description: >- - Fetches current weather and uses celsius or fahrenheit based - on location of user. - 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"] } - create-tool: - path: /v0/evi/tools - method: POST - auth: true - docs: >- - 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. - display-name: Create tool - request: - name: PostedUserDefinedTool - body: - properties: - name: - type: string - docs: Name applied to all versions of a particular Tool. - version_description: - type: optional - docs: An optional description of the Tool version. - description: - type: optional - docs: >- - An optional description of what the Tool does, used by the - supplemental LLM to choose when and how to call the function. - parameters: - type: string - docs: >- - Stringified JSON defining the parameters used by this version of - the Tool. - - - These parameters define the inputs needed for the Tool’s - execution, including the expected data type and description for - each input field. Structured as a stringified JSON schema, this - format ensures the Tool receives data in the expected format. - fallback_content: - type: optional - docs: >- - Optional text passed to the supplemental LLM in place of the - tool call result. The LLM then uses this text to generate a - response back to the user, ensuring continuity in the - conversation if the Tool errors. - content-type: application/json - response: - docs: Created - type: optional - errors: - - root.BadRequestError - examples: - - request: - name: get_current_weather - parameters: >- - { "type": "object", "properties": { "location": { "type": - "string", "description": "The city and state, e.g. San Francisco, - CA" }, "format": { "type": "string", "enum": ["celsius", - "fahrenheit"], "description": "The temperature unit to use. Infer - this from the users location." } }, "required": ["location", - "format"] } - version_description: >- - Fetches current weather and uses celsius or fahrenheit based on - location of user. - description: This tool is for getting the current weather. - fallback_content: Unable to fetch current weather. - response: - body: - tool_type: FUNCTION - id: aa9b71c4-723c-47ff-9f83-1a1829e74376 - version: 0 - version_type: FIXED - version_description: >- - Fetches current weather and uses celsius or fahrenheit based on - location of user. - name: get_current_weather - created_on: 1715275452390 - modified_on: 1715275452390 - fallback_content: Unable to fetch current weather. - description: This tool is for getting the 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"] } - list-tool-versions: - path: /v0/evi/tools/{id} - method: GET - auth: true - docs: >- - 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. - path-parameters: - id: - type: string - docs: Identifier for a Tool. Formatted as a UUID. - display-name: List tool versions - request: - name: ToolsListToolVersionsRequest - query-parameters: - page_number: - type: optional - docs: >- - Specifies the page number to retrieve, enabling pagination. - - - This parameter uses zero-based indexing. For example, setting - `page_number` to 0 retrieves the first page of results (items 0-9 - if `page_size` is 10), setting `page_number` to 1 retrieves the - second page (items 10-19), and so on. Defaults to 0, which - retrieves the first page. - page_size: - type: optional - docs: >- - Specifies the maximum number of results to include per page, - enabling pagination. The value must be between 1 and 100, - inclusive. - - - For example, if `page_size` is set to 10, each page will include - up to 10 items. Defaults to 10. - restrict_to_most_recent: - type: optional - docs: >- - By default, `restrict_to_most_recent` is set to true, returning - only the latest version of each tool. To include all versions of - each tool in the list, set `restrict_to_most_recent` to false. - response: - docs: Success - type: root.ReturnPagedUserDefinedTools - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 00183a3f-79ba-413d-9f3b-609864268bea - response: - body: - page_number: 0 - page_size: 10 - total_pages: 1 - tools_page: - - tool_type: FUNCTION - id: 00183a3f-79ba-413d-9f3b-609864268bea - version: 1 - version_type: FIXED - version_description: >- - Fetches current weather and uses celsius, fahrenheit, or - kelvin based on location of user. - name: get_current_weather - created_on: 1715277014228 - modified_on: 1715277602313 - fallback_content: Unable to fetch current weather. - description: This tool is for getting the 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", "kelvin"], "description": "The - temperature unit to use. Infer this from the users - location." } }, "required": ["location", "format"] } - create-tool-version: - path: /v0/evi/tools/{id} - method: POST - auth: true - docs: >- - 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. - path-parameters: - id: - type: string - docs: Identifier for a Tool. Formatted as a UUID. - display-name: Create tool version - request: - name: PostedUserDefinedToolVersion - body: - properties: - version_description: - type: optional - docs: An optional description of the Tool version. - description: - type: optional - docs: >- - An optional description of what the Tool does, used by the - supplemental LLM to choose when and how to call the function. - parameters: - type: string - docs: >- - Stringified JSON defining the parameters used by this version of - the Tool. - - - These parameters define the inputs needed for the Tool’s - execution, including the expected data type and description for - each input field. Structured as a stringified JSON schema, this - format ensures the Tool receives data in the expected format. - fallback_content: - type: optional - docs: >- - Optional text passed to the supplemental LLM in place of the - tool call result. The LLM then uses this text to generate a - response back to the user, ensuring continuity in the - conversation if the Tool errors. - content-type: application/json - response: - docs: Created - type: optional - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 00183a3f-79ba-413d-9f3b-609864268bea - request: - parameters: >- - { "type": "object", "properties": { "location": { "type": - "string", "description": "The city and state, e.g. San Francisco, - CA" }, "format": { "type": "string", "enum": ["celsius", - "fahrenheit", "kelvin"], "description": "The temperature unit to - use. Infer this from the users location." } }, "required": - ["location", "format"] } - version_description: >- - Fetches current weather and uses celsius, fahrenheit, or kelvin - based on location of user. - fallback_content: Unable to fetch current weather. - description: This tool is for getting the current weather. - response: - body: - tool_type: FUNCTION - id: 00183a3f-79ba-413d-9f3b-609864268bea - version: 1 - version_type: FIXED - version_description: >- - Fetches current weather and uses celsius, fahrenheit, or kelvin - based on location of user. - name: get_current_weather - created_on: 1715277014228 - modified_on: 1715277602313 - fallback_content: Unable to fetch current weather. - description: This tool is for getting the 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", "kelvin"], "description": "The - temperature unit to use. Infer this from the users location." } - }, "required": ["location", "format"] } - delete-tool: - path: /v0/evi/tools/{id} - method: DELETE - auth: true + Specifies the page number to retrieve, enabling pagination. + + + This parameter uses zero-based indexing. For example, setting + `page_number` to 0 retrieves the first page of results (items 0-9 + if `page_size` is 10), setting `page_number` to 1 retrieves the + second page (items 10-19), and so on. Defaults to 0, which + retrieves the first page. + page_size: + type: optional docs: >- - 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. - path-parameters: - id: - type: string - docs: Identifier for a Tool. Formatted as a UUID. - display-name: Delete tool - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 00183a3f-79ba-413d-9f3b-609864268bea - update-tool-name: - path: /v0/evi/tools/{id} - method: PATCH - auth: true + Specifies the maximum number of results to include per page, + enabling pagination. The value must be between 1 and 100, + inclusive. + + + For example, if `page_size` is set to 10, each page will include + up to 10 items. Defaults to 10. + restrict_to_most_recent: + type: optional docs: >- - 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. - path-parameters: - id: - type: string - docs: Identifier for a Tool. Formatted as a UUID. - display-name: Update tool name - request: - name: PostedUserDefinedToolName - body: - properties: - name: - type: string - docs: Name applied to all versions of a particular Tool. - content-type: application/json - response: - docs: Success - type: text - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 00183a3f-79ba-413d-9f3b-609864268bea - request: - name: get_current_temperature - get-tool-version: - path: /v0/evi/tools/{id}/version/{version} - method: GET - auth: true + By default, `restrict_to_most_recent` is set to true, returning + only the latest version of each tool. To include all versions of + each tool in the list, set `restrict_to_most_recent` to false. + name: + type: optional + docs: Filter to only include tools with name. + response: + docs: Success + type: root.ReturnPagedUserDefinedTools + errors: + - root.BadRequestError + examples: + - query-parameters: + page_number: 0 + page_size: 2 + response: + body: + page_number: 0 + page_size: 2 + total_pages: 1 + tools_page: + - tool_type: FUNCTION + id: d20827af-5d8d-4f66-b6b9-ce2e3e1ea2b2 + version: 0 + version_type: FIXED + version_description: Fetches user's current location. + name: get_current_location + created_on: 1715267200693 + modified_on: 1715267200693 + fallback_content: Unable to fetch location. + description: Fetches user's current location. + parameters: >- + { "type": "object", "properties": { "location": { "type": + "string", "description": "The city and state, e.g. San + Francisco, CA" }}, "required": ["location"] } + - tool_type: FUNCTION + id: 4442f3ea-9038-40e3-a2ce-1522b7de770f + version: 0 + version_type: FIXED + version_description: >- + Fetches current weather and uses celsius or fahrenheit based + on location of user. + name: get_current_weather + created_on: 1715266126705 + modified_on: 1715266126705 + fallback_content: Unable to fetch location. + description: >- + Fetches current weather and uses celsius or fahrenheit based + on location of user. + 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"] } + create-tool: + path: /v0/evi/tools + method: POST + auth: true + docs: >- + 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. + display-name: Create tool + request: + name: PostedUserDefinedTool + body: + properties: + name: + type: string + docs: Name applied to all versions of a particular Tool. + version_description: + type: optional + docs: An optional description of the Tool version. + description: + type: optional + docs: >- + An optional description of what the Tool does, used by the + supplemental LLM to choose when and how to call the function. + parameters: + type: string + docs: >- + Stringified JSON defining the parameters used by this version of + the Tool. + + + These parameters define the inputs needed for the Tool’s + execution, including the expected data type and description for + each input field. Structured as a stringified JSON schema, this + format ensures the Tool receives data in the expected format. + fallback_content: + type: optional + docs: >- + Optional text passed to the supplemental LLM in place of the + tool call result. The LLM then uses this text to generate a + response back to the user, ensuring continuity in the + conversation if the Tool errors. + content-type: application/json + response: + docs: Created + type: optional + errors: + - root.BadRequestError + examples: + - request: + name: get_current_weather + parameters: >- + { "type": "object", "properties": { "location": { "type": + "string", "description": "The city and state, e.g. San Francisco, + CA" }, "format": { "type": "string", "enum": ["celsius", + "fahrenheit"], "description": "The temperature unit to use. Infer + this from the users location." } }, "required": ["location", + "format"] } + version_description: >- + Fetches current weather and uses celsius or fahrenheit based on + location of user. + description: This tool is for getting the current weather. + fallback_content: Unable to fetch current weather. + response: + body: + tool_type: FUNCTION + id: aa9b71c4-723c-47ff-9f83-1a1829e74376 + version: 0 + version_type: FIXED + version_description: >- + Fetches current weather and uses celsius or fahrenheit based on + location of user. + name: get_current_weather + created_on: 1715275452390 + modified_on: 1715275452390 + fallback_content: Unable to fetch current weather. + description: This tool is for getting the 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"] } + list-tool-versions: + path: /v0/evi/tools/{id} + method: GET + auth: true + docs: >- + 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. + path-parameters: + id: + type: string + docs: Identifier for a Tool. Formatted as a UUID. + display-name: List tool versions + request: + name: ToolsListToolVersionsRequest + query-parameters: + page_number: + type: optional docs: >- - Fetches a specified version 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. - path-parameters: - id: - type: string - docs: Identifier for a Tool. Formatted as a UUID. - version: - type: integer - docs: >- - 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. - display-name: Get tool version - response: - docs: Success - type: optional - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 00183a3f-79ba-413d-9f3b-609864268bea - version: 1 - response: - body: - tool_type: FUNCTION - id: 00183a3f-79ba-413d-9f3b-609864268bea - version: 1 - version_type: FIXED - version_description: >- - Fetches current weather and uses celsius, fahrenheit, or kelvin - based on location of user. - name: string - created_on: 1715277014228 - modified_on: 1715277602313 - fallback_content: Unable to fetch current weather. - description: This tool is for getting the 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", "kelvin"], "description": "The - temperature unit to use. Infer this from the users location." } - }, "required": ["location", "format"] } - delete-tool-version: - path: /v0/evi/tools/{id}/version/{version} - method: DELETE - auth: true + Specifies the page number to retrieve, enabling pagination. + + + This parameter uses zero-based indexing. For example, setting + `page_number` to 0 retrieves the first page of results (items 0-9 + if `page_size` is 10), setting `page_number` to 1 retrieves the + second page (items 10-19), and so on. Defaults to 0, which + retrieves the first page. + page_size: + type: optional docs: >- - Deletes a specified version 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. - path-parameters: - id: - type: string - docs: Identifier for a Tool. Formatted as a UUID. - version: - type: integer - docs: >- - 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. - display-name: Delete tool version - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 00183a3f-79ba-413d-9f3b-609864268bea - version: 1 - update-tool-description: - path: /v0/evi/tools/{id}/version/{version} - method: PATCH - auth: true + Specifies the maximum number of results to include per page, + enabling pagination. The value must be between 1 and 100, + inclusive. + + + For example, if `page_size` is set to 10, each page will include + up to 10 items. Defaults to 10. + restrict_to_most_recent: + type: optional docs: >- - Updates the description of a specified **Tool** version. - - - 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. - path-parameters: - id: - type: string - docs: Identifier for a Tool. Formatted as a UUID. - version: - type: integer - docs: >- - 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. - display-name: Update tool description - request: - name: PostedUserDefinedToolVersionDescription - body: - properties: - version_description: - type: optional - docs: An optional description of the Tool version. - content-type: application/json - response: - docs: Success - type: optional - errors: - - root.BadRequestError - examples: - - path-parameters: - id: 00183a3f-79ba-413d-9f3b-609864268bea - version: 1 - request: - version_description: >- - Fetches current temperature, precipitation, wind speed, AQI, and - other weather conditions. Uses Celsius, Fahrenheit, or kelvin - depending on user's region. - response: - body: - tool_type: FUNCTION - id: 00183a3f-79ba-413d-9f3b-609864268bea - version: 1 - version_type: FIXED - version_description: >- - Fetches current temperature, precipitation, wind speed, AQI, and - other weather conditions. Uses Celsius, Fahrenheit, or kelvin - depending on user's region. - name: string - created_on: 1715277014228 - modified_on: 1715277602313 - fallback_content: Unable to fetch current weather. - description: This tool is for getting the 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", "kelvin"], "description": "The - temperature unit to use. Infer this from the users location." } - }, "required": ["location", "format"] } - source: - openapi: stenographer-openapi.json + By default, `restrict_to_most_recent` is set to true, returning + only the latest version of each tool. To include all versions of + each tool in the list, set `restrict_to_most_recent` to false. + response: + docs: Success + type: root.ReturnPagedUserDefinedTools + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 00183a3f-79ba-413d-9f3b-609864268bea + response: + body: + page_number: 0 + page_size: 10 + total_pages: 1 + tools_page: + - tool_type: FUNCTION + id: 00183a3f-79ba-413d-9f3b-609864268bea + version: 1 + version_type: FIXED + version_description: >- + Fetches current weather and uses celsius, fahrenheit, or + kelvin based on location of user. + name: get_current_weather + created_on: 1715277014228 + modified_on: 1715277602313 + fallback_content: Unable to fetch current weather. + description: This tool is for getting the 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", "kelvin"], "description": "The + temperature unit to use. Infer this from the users + location." } }, "required": ["location", "format"] } + create-tool-version: + path: /v0/evi/tools/{id} + method: POST + auth: true + docs: >- + 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. + path-parameters: + id: + type: string + docs: Identifier for a Tool. Formatted as a UUID. + display-name: Create tool version + request: + name: PostedUserDefinedToolVersion + body: + properties: + version_description: + type: optional + docs: An optional description of the Tool version. + description: + type: optional + docs: >- + An optional description of what the Tool does, used by the + supplemental LLM to choose when and how to call the function. + parameters: + type: string + docs: >- + Stringified JSON defining the parameters used by this version of + the Tool. + + + These parameters define the inputs needed for the Tool’s + execution, including the expected data type and description for + each input field. Structured as a stringified JSON schema, this + format ensures the Tool receives data in the expected format. + fallback_content: + type: optional + docs: >- + Optional text passed to the supplemental LLM in place of the + tool call result. The LLM then uses this text to generate a + response back to the user, ensuring continuity in the + conversation if the Tool errors. + content-type: application/json + response: + docs: Created + type: optional + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 00183a3f-79ba-413d-9f3b-609864268bea + request: + parameters: >- + { "type": "object", "properties": { "location": { "type": + "string", "description": "The city and state, e.g. San Francisco, + CA" }, "format": { "type": "string", "enum": ["celsius", + "fahrenheit", "kelvin"], "description": "The temperature unit to + use. Infer this from the users location." } }, "required": + ["location", "format"] } + version_description: >- + Fetches current weather and uses celsius, fahrenheit, or kelvin + based on location of user. + fallback_content: Unable to fetch current weather. + description: This tool is for getting the current weather. + response: + body: + tool_type: FUNCTION + id: 00183a3f-79ba-413d-9f3b-609864268bea + version: 1 + version_type: FIXED + version_description: >- + Fetches current weather and uses celsius, fahrenheit, or kelvin + based on location of user. + name: get_current_weather + created_on: 1715277014228 + modified_on: 1715277602313 + fallback_content: Unable to fetch current weather. + description: This tool is for getting the 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", "kelvin"], "description": "The + temperature unit to use. Infer this from the users location." } + }, "required": ["location", "format"] } + delete-tool: + path: /v0/evi/tools/{id} + method: DELETE + auth: true + docs: >- + 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. + path-parameters: + id: + type: string + docs: Identifier for a Tool. Formatted as a UUID. + display-name: Delete tool + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 00183a3f-79ba-413d-9f3b-609864268bea + update-tool-name: + path: /v0/evi/tools/{id} + method: PATCH + auth: true + docs: >- + 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. + path-parameters: + id: + type: string + docs: Identifier for a Tool. Formatted as a UUID. + display-name: Update tool name + request: + name: PostedUserDefinedToolName + body: + properties: + name: + type: string + docs: Name applied to all versions of a particular Tool. + content-type: application/json + response: + docs: Success + type: text + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 00183a3f-79ba-413d-9f3b-609864268bea + request: + name: get_current_temperature + get-tool-version: + path: /v0/evi/tools/{id}/version/{version} + method: GET + auth: true + docs: >- + Fetches a specified version 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. + path-parameters: + id: + type: string + docs: Identifier for a Tool. Formatted as a UUID. + version: + type: integer + docs: >- + 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. + display-name: Get tool version + response: + docs: Success + type: optional + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 00183a3f-79ba-413d-9f3b-609864268bea + version: 1 + response: + body: + tool_type: FUNCTION + id: 00183a3f-79ba-413d-9f3b-609864268bea + version: 1 + version_type: FIXED + version_description: >- + Fetches current weather and uses celsius, fahrenheit, or kelvin + based on location of user. + name: string + created_on: 1715277014228 + modified_on: 1715277602313 + fallback_content: Unable to fetch current weather. + description: This tool is for getting the 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", "kelvin"], "description": "The + temperature unit to use. Infer this from the users location." } + }, "required": ["location", "format"] } + delete-tool-version: + path: /v0/evi/tools/{id}/version/{version} + method: DELETE + auth: true + docs: >- + Deletes a specified version 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. + path-parameters: + id: + type: string + docs: Identifier for a Tool. Formatted as a UUID. + version: + type: integer + docs: >- + 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. + display-name: Delete tool version + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 00183a3f-79ba-413d-9f3b-609864268bea + version: 1 + update-tool-description: + path: /v0/evi/tools/{id}/version/{version} + method: PATCH + auth: true + docs: >- + Updates the description of a specified **Tool** version. + + + 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. + path-parameters: + id: + type: string + docs: Identifier for a Tool. Formatted as a UUID. + version: + type: integer + docs: >- + 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. + display-name: Update tool description + request: + name: PostedUserDefinedToolVersionDescription + body: + properties: + version_description: + type: optional + docs: An optional description of the Tool version. + content-type: application/json + response: + docs: Success + type: optional + errors: + - root.BadRequestError + examples: + - path-parameters: + id: 00183a3f-79ba-413d-9f3b-609864268bea + version: 1 + request: + version_description: >- + Fetches current temperature, precipitation, wind speed, AQI, and + other weather conditions. Uses Celsius, Fahrenheit, or kelvin + depending on user's region. + response: + body: + tool_type: FUNCTION + id: 00183a3f-79ba-413d-9f3b-609864268bea + version: 1 + version_type: FIXED + version_description: >- + Fetches current temperature, precipitation, wind speed, AQI, and + other weather conditions. Uses Celsius, Fahrenheit, or kelvin + depending on user's region. + name: string + created_on: 1715277014228 + modified_on: 1715277602313 + fallback_content: Unable to fetch current weather. + description: This tool is for getting the 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", "kelvin"], "description": "The + temperature unit to use. Infer this from the users location." } + }, "required": ["location", "format"] } + source: + openapi: stenographer-openapi.json diff --git a/.mock/definition/expression-measurement/batch/__package__.yml b/.mock/definition/expression-measurement/batch/__package__.yml index 3e0f9318..53803c53 100644 --- a/.mock/definition/expression-measurement/batch/__package__.yml +++ b/.mock/definition/expression-measurement/batch/__package__.yml @@ -1,1768 +1,1768 @@ service: - auth: false - base-path: "" - endpoints: - list-jobs: - path: /v0/batch/jobs - method: GET - auth: true - docs: Sort and filter jobs. - display-name: List jobs - request: - name: BatchListJobsRequest - query-parameters: - limit: - type: optional - docs: The maximum number of jobs to include in the response. - status: - type: optional - allow-multiple: true - docs: >- - Include only jobs of this status in the response. There are four - possible statuses: - - - - `QUEUED`: The job has been received and is waiting to be - processed. - - - - `IN_PROGRESS`: The job is currently being processed. - - - - `COMPLETED`: The job has finished processing. - - - - `FAILED`: The job encountered an error and could not be - completed successfully. - when: - type: optional - docs: >- - Specify whether to include jobs created before or after a given - `timestamp_ms`. - timestamp_ms: - type: optional - docs: |- - Provide a timestamp in milliseconds to filter jobs. - - When combined with the `when` parameter, you can filter jobs before or after the given timestamp. Defaults to the current Unix timestamp if one is not provided. - sort_by: - type: optional - docs: >- - Specify which timestamp to sort the jobs by. - - - - `created`: Sort jobs by the time of creation, indicated by - `created_timestamp_ms`. - - - - `started`: Sort jobs by the time processing started, indicated - by `started_timestamp_ms`. - - - - `ended`: Sort jobs by the time processing ended, indicated by - `ended_timestamp_ms`. - direction: - type: optional - docs: >- - Specify the order in which to sort the jobs. Defaults to - descending order. - - - - `asc`: Sort in ascending order (chronological, with the oldest - records first). - - - - `desc`: Sort in descending order (reverse-chronological, with - the newest records first). - response: - docs: "" - type: list - examples: - - response: - body: - - job_id: job_id - request: - files: - - filename: filename - md5sum: md5sum - content_type: content_type - models: - burst: {} - face: - fps_pred: 3 - identify_faces: false - min_face_size: 60 - prob_threshold: 0.99 - save_faces: false - facemesh: {} - language: - granularity: word - identify_speakers: false - ner: - identify_speakers: false - prosody: - granularity: utterance - identify_speakers: false - notify: true - text: [] - urls: - - https://hume-tutorials.s3.amazonaws.com/faces.zip - state: - created_timestamp_ms: 1712587158717 - ended_timestamp_ms: 1712587159274 - num_errors: 0 - num_predictions: 10 - started_timestamp_ms: 1712587158800 - status: COMPLETED - type: INFERENCE - start-inference-job: - path: /v0/batch/jobs - method: POST - auth: true - docs: Start a new measurement inference job. - display-name: Start inference job - request: - body: InferenceBaseRequest - content-type: application/json - response: - docs: "" - type: JobId - property: job_id - examples: - - request: - urls: - - https://hume-tutorials.s3.amazonaws.com/faces.zip - notify: true - response: - body: - job_id: job_id - get-job-details: - path: /v0/batch/jobs/{id} - method: GET - auth: true - docs: Get the request details and state of a given job. - path-parameters: - id: - type: string - docs: The unique identifier for the job. - display-name: Get job details - response: - docs: "" - type: UnionJob - examples: - - name: Inference - path-parameters: - id: job_id - response: - body: - type: INFERENCE - job_id: job_id - request: - files: [] - models: - burst: {} - face: - fps_pred: 3 - identify_faces: false - min_face_size: 60 - prob_threshold: 0.99 - save_faces: false - facemesh: {} - language: - granularity: word - identify_speakers: false - ner: - identify_speakers: false - prosody: - granularity: utterance - identify_speakers: false - notify: true - text: [] - urls: - - https://hume-tutorials.s3.amazonaws.com/faces.zip - state: - created_timestamp_ms: 1712590457884 - ended_timestamp_ms: 1712590462252 - num_errors: 0 - num_predictions: 10 - started_timestamp_ms: 1712590457995 - status: COMPLETED - get-job-predictions: - path: /v0/batch/jobs/{id}/predictions - method: GET - auth: true - docs: Get the JSON predictions of a completed inference job. - path-parameters: - id: - type: string - docs: The unique identifier for the job. - display-name: Get job predictions - response: - docs: "" - type: list - examples: - - path-parameters: - id: job_id - response: - body: - - source: - type: url - url: https://hume-tutorials.s3.amazonaws.com/faces.zip - results: - predictions: - - file: faces/100.jpg - models: - face: - grouped_predictions: - - id: unknown - predictions: - - frame: 0 - time: 0 - prob: 0.9994111061096191 - box: - x: 1187.885986328125 - "y": 1397.697509765625 - w: 1401.668701171875 - h: 1961.424560546875 - emotions: - - name: Admiration - score: 0.10722749680280685 - - name: Adoration - score: 0.06395940482616425 - - name: Aesthetic Appreciation - score: 0.05811462551355362 - - name: Amusement - score: 0.14187128841876984 - - name: Anger - score: 0.02804684266448021 - - name: Anxiety - score: 0.2713485360145569 - - name: Awe - score: 0.33812594413757324 - - name: Awkwardness - score: 0.1745193600654602 - - name: Boredom - score: 0.23600080609321594 - - name: Calmness - score: 0.18988418579101562 - - name: Concentration - score: 0.44288986921310425 - - name: Confusion - score: 0.39346569776535034 - - name: Contemplation - score: 0.31002455949783325 - - name: Contempt - score: 0.048870109021663666 - - name: Contentment - score: 0.0579497292637825 - - name: Craving - score: 0.06544201076030731 - - name: Desire - score: 0.05526508390903473 - - name: Determination - score: 0.08590991795063019 - - name: Disappointment - score: 0.19508258998394012 - - name: Disgust - score: 0.031529419124126434 - - name: Distress - score: 0.23210826516151428 - - name: Doubt - score: 0.3284550905227661 - - name: Ecstasy - score: 0.040716782212257385 - - name: Embarrassment - score: 0.1467227339744568 - - name: Empathic Pain - score: 0.07633581757545471 - - name: Entrancement - score: 0.16245244443416595 - - name: Envy - score: 0.03267110139131546 - - name: Excitement - score: 0.10656816512346268 - - name: Fear - score: 0.3115977346897125 - - name: Guilt - score: 0.11615975946187973 - - name: Horror - score: 0.19795553386211395 - - name: Interest - score: 0.3136432468891144 - - name: Joy - score: 0.06285581737756729 - - name: Love - score: 0.06339752674102783 - - name: Nostalgia - score: 0.05866732448339462 - - name: Pain - score: 0.07684041559696198 - - name: Pride - score: 0.026822954416275024 - - name: Realization - score: 0.30000734329223633 - - name: Relief - score: 0.04414166510105133 - - name: Romance - score: 0.042728863656520844 - - name: Sadness - score: 0.14773206412792206 - - name: Satisfaction - score: 0.05902980640530586 - - name: Shame - score: 0.08103451132774353 - - name: Surprise (negative) - score: 0.25518184900283813 - - name: Surprise (positive) - score: 0.28845661878585815 - - name: Sympathy - score: 0.062488824129104614 - - name: Tiredness - score: 0.1559651643037796 - - name: Triumph - score: 0.01955239288508892 - errors: [] - get-job-artifacts: - path: /v0/batch/jobs/{id}/artifacts - method: GET - auth: true - docs: Get the artifacts ZIP of a completed inference job. - path-parameters: - id: - type: string - docs: The unique identifier for the job. - display-name: Get job artifacts - response: - docs: "" - type: file - start-inference-job-from-local-file: - path: /v0/batch/jobs - method: POST - auth: true - docs: Start a new batch inference job. - display-name: Start inference job from local file - request: - name: BatchStartInferenceJobFromLocalFileRequest - body: - properties: - json: - type: optional - docs: >- - Stringified JSON object containing the inference job - configuration. - file: - type: list - docs: >- - Local media files (see recommended input filetypes) to be - processed. - - - If you wish to supply more than 100 files, consider providing - them as an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`). - content-type: multipart/form-data - response: - docs: "" - type: JobId - property: job_id - examples: - - request: {} - response: - body: - job_id: job_id - source: - openapi: batch-files-openapi.yml -types: - Alternative: literal<"language_only"> - Bcp47Tag: - enum: - - zh - - da - - nl - - en - - value: en-AU - name: EnAu - - value: en-IN - name: EnIn - - value: en-NZ - name: EnNz - - value: en-GB - name: EnGb - - fr - - value: fr-CA - name: FrCa - - de - - hi - - value: hi-Latn - name: HiLatn - - id - - it - - ja - - ko - - "no" - - pl - - pt - - value: pt-BR - name: PtBr - - value: pt-PT - name: PtPt - - ru - - es - - value: es-419 - name: Es419 - - sv - - ta - - tr - - uk - source: - openapi: batch-openapi.json - BoundingBox: - docs: A bounding box around a face. - properties: - x: - type: double - docs: x-coordinate of bounding box top left corner. - "y": - type: double - docs: y-coordinate of bounding box top left corner. - w: - type: double - docs: Bounding box width. - h: - type: double - docs: Bounding box height. - source: - openapi: batch-openapi.json - BurstPrediction: - properties: - time: TimeInterval - emotions: - docs: A high-dimensional embedding in emotion space. - type: list - descriptions: - docs: Modality-specific descriptive features and their scores. - type: list - source: - openapi: batch-openapi.json - Classification: map - CompletedEmbeddingGeneration: - properties: - created_timestamp_ms: - type: long - docs: When this job was created (Unix timestamp in milliseconds). - started_timestamp_ms: - type: long - docs: When this job started (Unix timestamp in milliseconds). - ended_timestamp_ms: - type: long - docs: When this job ended (Unix timestamp in milliseconds). - source: - openapi: batch-openapi.json - CompletedInference: - properties: - created_timestamp_ms: - type: long - docs: When this job was created (Unix timestamp in milliseconds). - started_timestamp_ms: - type: long - docs: When this job started (Unix timestamp in milliseconds). - ended_timestamp_ms: - type: long - docs: When this job ended (Unix timestamp in milliseconds). - num_predictions: - type: uint64 - docs: The number of predictions that were generated by this job. - num_errors: - type: uint64 - docs: The number of errors that occurred while running this job. - source: - openapi: batch-openapi.json - CompletedTlInference: - properties: - created_timestamp_ms: - type: long - docs: When this job was created (Unix timestamp in milliseconds). - started_timestamp_ms: - type: long - docs: When this job started (Unix timestamp in milliseconds). - ended_timestamp_ms: - type: long - docs: When this job ended (Unix timestamp in milliseconds). - num_predictions: - type: uint64 - docs: The number of predictions that were generated by this job. - num_errors: - type: uint64 - docs: The number of errors that occurred while running this job. - source: - openapi: batch-openapi.json - CompletedTraining: - properties: - created_timestamp_ms: - type: long - docs: When this job was created (Unix timestamp in milliseconds). - started_timestamp_ms: - type: long - docs: When this job started (Unix timestamp in milliseconds). - ended_timestamp_ms: - type: long - docs: When this job ended (Unix timestamp in milliseconds). - custom_model: TrainingCustomModel - alternatives: optional> - source: - openapi: batch-openapi.json - CustomModelPrediction: - properties: - output: map - error: string - task_type: string - source: - openapi: batch-openapi.json - CustomModelRequest: - properties: - name: string - description: optional - tags: optional> - source: - openapi: batch-openapi.json - Dataset: - discriminated: false - union: - - DatasetId - - DatasetVersionId - source: - openapi: batch-openapi.json - DatasetId: - properties: - id: - type: string - validation: - format: uuid - source: - openapi: batch-openapi.json - DatasetVersionId: - properties: - version_id: - type: string - validation: - format: uuid - source: - openapi: batch-openapi.json - DescriptionsScore: - properties: - name: - type: string - docs: Name of the descriptive feature being expressed. - score: - type: float - docs: Embedding value for the descriptive feature being expressed. - source: - openapi: batch-openapi.json - Direction: - enum: - - asc - - desc - source: - openapi: batch-openapi.json - EmbeddingGenerationBaseRequest: - properties: - registry_file_details: - type: optional> - docs: File ID and File URL pairs for an asset registry file - source: - openapi: batch-openapi.json - EmotionScore: - properties: - name: - type: string - docs: Name of the emotion being expressed. - score: - type: float - docs: Embedding value for the emotion being expressed. - source: - openapi: batch-openapi.json - Error: - properties: - message: - type: string - docs: An error message. + auth: false + base-path: '' + endpoints: + list-jobs: + path: /v0/batch/jobs + method: GET + auth: true + docs: Sort and filter jobs. + display-name: List jobs + request: + name: BatchListJobsRequest + query-parameters: + limit: + type: optional + docs: The maximum number of jobs to include in the response. + status: + type: optional + allow-multiple: true + docs: >- + Include only jobs of this status in the response. There are four + possible statuses: + + + - `QUEUED`: The job has been received and is waiting to be + processed. + + + - `IN_PROGRESS`: The job is currently being processed. + + + - `COMPLETED`: The job has finished processing. + + + - `FAILED`: The job encountered an error and could not be + completed successfully. + when: + type: optional + docs: >- + Specify whether to include jobs created before or after a given + `timestamp_ms`. + timestamp_ms: + type: optional + docs: |- + Provide a timestamp in milliseconds to filter jobs. + + When combined with the `when` parameter, you can filter jobs before or after the given timestamp. Defaults to the current Unix timestamp if one is not provided. + sort_by: + type: optional + docs: >- + Specify which timestamp to sort the jobs by. + + + - `created`: Sort jobs by the time of creation, indicated by + `created_timestamp_ms`. + + + - `started`: Sort jobs by the time processing started, indicated + by `started_timestamp_ms`. + + + - `ended`: Sort jobs by the time processing ended, indicated by + `ended_timestamp_ms`. + direction: + type: optional + docs: >- + Specify the order in which to sort the jobs. Defaults to + descending order. + + + - `asc`: Sort in ascending order (chronological, with the oldest + records first). + + + - `desc`: Sort in descending order (reverse-chronological, with + the newest records first). + response: + docs: '' + type: list + examples: + - response: + body: + - job_id: job_id + request: + files: + - filename: filename + md5sum: md5sum + content_type: content_type + models: + burst: {} + face: + fps_pred: 3 + identify_faces: false + min_face_size: 60 + prob_threshold: 0.99 + save_faces: false + facemesh: {} + language: + granularity: word + identify_speakers: false + ner: + identify_speakers: false + prosody: + granularity: utterance + identify_speakers: false + notify: true + text: [] + urls: + - https://hume-tutorials.s3.amazonaws.com/faces.zip + state: + created_timestamp_ms: 1712587158717 + ended_timestamp_ms: 1712587159274 + num_errors: 0 + num_predictions: 10 + started_timestamp_ms: 1712587158800 + status: COMPLETED + type: INFERENCE + start-inference-job: + path: /v0/batch/jobs + method: POST + auth: true + docs: Start a new measurement inference job. + display-name: Start inference job + request: + body: InferenceBaseRequest + content-type: application/json + response: + docs: '' + type: JobId + property: job_id + examples: + - request: + urls: + - https://hume-tutorials.s3.amazonaws.com/faces.zip + notify: true + response: + body: + job_id: job_id + get-job-details: + path: /v0/batch/jobs/{id} + method: GET + auth: true + docs: Get the request details and state of a given job. + path-parameters: + id: + type: string + docs: The unique identifier for the job. + display-name: Get job details + response: + docs: '' + type: UnionJob + examples: + - name: Inference + path-parameters: + id: job_id + response: + body: + type: INFERENCE + job_id: job_id + request: + files: [] + models: + burst: {} + face: + fps_pred: 3 + identify_faces: false + min_face_size: 60 + prob_threshold: 0.99 + save_faces: false + facemesh: {} + language: + granularity: word + identify_speakers: false + ner: + identify_speakers: false + prosody: + granularity: utterance + identify_speakers: false + notify: true + text: [] + urls: + - https://hume-tutorials.s3.amazonaws.com/faces.zip + state: + created_timestamp_ms: 1712590457884 + ended_timestamp_ms: 1712590462252 + num_errors: 0 + num_predictions: 10 + started_timestamp_ms: 1712590457995 + status: COMPLETED + get-job-predictions: + path: /v0/batch/jobs/{id}/predictions + method: GET + auth: true + docs: Get the JSON predictions of a completed inference job. + path-parameters: + id: + type: string + docs: The unique identifier for the job. + display-name: Get job predictions + response: + docs: '' + type: list + examples: + - path-parameters: + id: job_id + response: + body: + - source: + type: url + url: https://hume-tutorials.s3.amazonaws.com/faces.zip + results: + predictions: + - file: faces/100.jpg + models: + face: + grouped_predictions: + - id: unknown + predictions: + - frame: 0 + time: 0 + prob: 0.9994111061096191 + box: + x: 1187.885986328125 + 'y': 1397.697509765625 + w: 1401.668701171875 + h: 1961.424560546875 + emotions: + - name: Admiration + score: 0.10722749680280685 + - name: Adoration + score: 0.06395940482616425 + - name: Aesthetic Appreciation + score: 0.05811462551355362 + - name: Amusement + score: 0.14187128841876984 + - name: Anger + score: 0.02804684266448021 + - name: Anxiety + score: 0.2713485360145569 + - name: Awe + score: 0.33812594413757324 + - name: Awkwardness + score: 0.1745193600654602 + - name: Boredom + score: 0.23600080609321594 + - name: Calmness + score: 0.18988418579101562 + - name: Concentration + score: 0.44288986921310425 + - name: Confusion + score: 0.39346569776535034 + - name: Contemplation + score: 0.31002455949783325 + - name: Contempt + score: 0.048870109021663666 + - name: Contentment + score: 0.0579497292637825 + - name: Craving + score: 0.06544201076030731 + - name: Desire + score: 0.05526508390903473 + - name: Determination + score: 0.08590991795063019 + - name: Disappointment + score: 0.19508258998394012 + - name: Disgust + score: 0.031529419124126434 + - name: Distress + score: 0.23210826516151428 + - name: Doubt + score: 0.3284550905227661 + - name: Ecstasy + score: 0.040716782212257385 + - name: Embarrassment + score: 0.1467227339744568 + - name: Empathic Pain + score: 0.07633581757545471 + - name: Entrancement + score: 0.16245244443416595 + - name: Envy + score: 0.03267110139131546 + - name: Excitement + score: 0.10656816512346268 + - name: Fear + score: 0.3115977346897125 + - name: Guilt + score: 0.11615975946187973 + - name: Horror + score: 0.19795553386211395 + - name: Interest + score: 0.3136432468891144 + - name: Joy + score: 0.06285581737756729 + - name: Love + score: 0.06339752674102783 + - name: Nostalgia + score: 0.05866732448339462 + - name: Pain + score: 0.07684041559696198 + - name: Pride + score: 0.026822954416275024 + - name: Realization + score: 0.30000734329223633 + - name: Relief + score: 0.04414166510105133 + - name: Romance + score: 0.042728863656520844 + - name: Sadness + score: 0.14773206412792206 + - name: Satisfaction + score: 0.05902980640530586 + - name: Shame + score: 0.08103451132774353 + - name: Surprise (negative) + score: 0.25518184900283813 + - name: Surprise (positive) + score: 0.28845661878585815 + - name: Sympathy + score: 0.062488824129104614 + - name: Tiredness + score: 0.1559651643037796 + - name: Triumph + score: 0.01955239288508892 + errors: [] + get-job-artifacts: + path: /v0/batch/jobs/{id}/artifacts + method: GET + auth: true + docs: Get the artifacts ZIP of a completed inference job. + path-parameters: + id: + type: string + docs: The unique identifier for the job. + display-name: Get job artifacts + response: + docs: '' + type: file + start-inference-job-from-local-file: + path: /v0/batch/jobs + method: POST + auth: true + docs: Start a new batch inference job. + display-name: Start inference job from local file + request: + name: BatchStartInferenceJobFromLocalFileRequest + body: + properties: + json: + type: optional + docs: >- + Stringified JSON object containing the inference job + configuration. file: - type: string - docs: A file path relative to the top level source URL or file. - source: - openapi: batch-openapi.json - EvaluationArgs: - properties: - validation: optional - source: - openapi: batch-openapi.json - Face: + type: list + docs: >- + Local media files (see recommended input filetypes) to be + processed. + + + If you wish to supply more than 100 files, consider providing + them as an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`). + content-type: multipart/form-data + response: + docs: '' + type: JobId + property: job_id + examples: + - request: {} + response: + body: + job_id: job_id + source: + openapi: batch-files-openapi.yml +types: + Alternative: literal<"language_only"> + Bcp47Tag: + enum: + - zh + - da + - nl + - en + - value: en-AU + name: EnAu + - value: en-IN + name: EnIn + - value: en-NZ + name: EnNz + - value: en-GB + name: EnGb + - fr + - value: fr-CA + name: FrCa + - de + - hi + - value: hi-Latn + name: HiLatn + - id + - it + - ja + - ko + - 'no' + - pl + - pt + - value: pt-BR + name: PtBr + - value: pt-PT + name: PtPt + - ru + - es + - value: es-419 + name: Es419 + - sv + - ta + - tr + - uk + source: + openapi: batch-openapi.json + BoundingBox: + docs: A bounding box around a face. + properties: + x: + type: double + docs: x-coordinate of bounding box top left corner. + 'y': + type: double + docs: y-coordinate of bounding box top left corner. + w: + type: double + docs: Bounding box width. + h: + type: double + docs: Bounding box height. + source: + openapi: batch-openapi.json + BurstPrediction: + properties: + time: TimeInterval + emotions: + docs: A high-dimensional embedding in emotion space. + type: list + descriptions: + docs: Modality-specific descriptive features and their scores. + type: list + source: + openapi: batch-openapi.json + Classification: map + CompletedEmbeddingGeneration: + properties: + created_timestamp_ms: + type: long + docs: When this job was created (Unix timestamp in milliseconds). + started_timestamp_ms: + type: long + docs: When this job started (Unix timestamp in milliseconds). + ended_timestamp_ms: + type: long + docs: When this job ended (Unix timestamp in milliseconds). + source: + openapi: batch-openapi.json + CompletedInference: + properties: + created_timestamp_ms: + type: long + docs: When this job was created (Unix timestamp in milliseconds). + started_timestamp_ms: + type: long + docs: When this job started (Unix timestamp in milliseconds). + ended_timestamp_ms: + type: long + docs: When this job ended (Unix timestamp in milliseconds). + num_predictions: + type: uint64 + docs: The number of predictions that were generated by this job. + num_errors: + type: uint64 + docs: The number of errors that occurred while running this job. + source: + openapi: batch-openapi.json + CompletedTlInference: + properties: + created_timestamp_ms: + type: long + docs: When this job was created (Unix timestamp in milliseconds). + started_timestamp_ms: + type: long + docs: When this job started (Unix timestamp in milliseconds). + ended_timestamp_ms: + type: long + docs: When this job ended (Unix timestamp in milliseconds). + num_predictions: + type: uint64 + docs: The number of predictions that were generated by this job. + num_errors: + type: uint64 + docs: The number of errors that occurred while running this job. + source: + openapi: batch-openapi.json + CompletedTraining: + properties: + created_timestamp_ms: + type: long + docs: When this job was created (Unix timestamp in milliseconds). + started_timestamp_ms: + type: long + docs: When this job started (Unix timestamp in milliseconds). + ended_timestamp_ms: + type: long + docs: When this job ended (Unix timestamp in milliseconds). + custom_model: TrainingCustomModel + alternatives: optional> + source: + openapi: batch-openapi.json + CustomModelPrediction: + properties: + output: map + error: string + task_type: string + source: + openapi: batch-openapi.json + CustomModelRequest: + properties: + name: string + description: optional + tags: optional> + source: + openapi: batch-openapi.json + Dataset: + discriminated: false + union: + - DatasetId + - DatasetVersionId + source: + openapi: batch-openapi.json + DatasetId: + properties: + id: + type: string + validation: + format: uuid + source: + openapi: batch-openapi.json + DatasetVersionId: + properties: + version_id: + type: string + validation: + format: uuid + source: + openapi: batch-openapi.json + DescriptionsScore: + properties: + name: + type: string + docs: Name of the descriptive feature being expressed. + score: + type: float + docs: Embedding value for the descriptive feature being expressed. + source: + openapi: batch-openapi.json + Direction: + enum: + - asc + - desc + source: + openapi: batch-openapi.json + EmbeddingGenerationBaseRequest: + properties: + registry_file_details: + type: optional> + docs: File ID and File URL pairs for an asset registry file + source: + openapi: batch-openapi.json + EmotionScore: + properties: + name: + type: string + docs: Name of the emotion being expressed. + score: + type: float + docs: Embedding value for the emotion being expressed. + source: + openapi: batch-openapi.json + Error: + properties: + message: + type: string + docs: An error message. + file: + type: string + docs: A file path relative to the top level source URL or file. + source: + openapi: batch-openapi.json + EvaluationArgs: + properties: + validation: optional + source: + openapi: batch-openapi.json + Face: + docs: >- + The Facial Emotional Expression model analyzes human facial expressions in + images and videos. Results will be provided per frame for video files. + + + Recommended input file types: `.png`, `.jpeg`, `.mp4` + properties: + fps_pred: + type: optional docs: >- - The Facial Emotional Expression model analyzes human facial expressions in - images and videos. Results will be provided per frame for video files. - - - Recommended input file types: `.png`, `.jpeg`, `.mp4` - properties: - fps_pred: - type: optional - docs: >- - Number of frames per second to process. Other frames will be omitted - from the response. Set to `0` to process every frame. - default: 3 - prob_threshold: - type: optional - docs: >- - Face detection probability threshold. Faces detected with a - probability less than this threshold will be omitted from the - response. - default: 0.99 - validation: - min: 0 - max: 1 - identify_faces: - type: optional - docs: >- - Whether to return identifiers for faces across frames. If `true`, - unique identifiers will be assigned to face bounding boxes to - differentiate different faces. If `false`, all faces will be tagged - with an `unknown` ID. - default: false - min_face_size: - type: optional - docs: >- - Minimum bounding box side length in pixels to treat as a face. Faces - detected with a bounding box side length in pixels less than this - threshold will be omitted from the response. - facs: optional - descriptions: optional - save_faces: - type: optional - docs: >- - Whether to extract and save the detected faces in the artifacts zip - created by each job. - default: false - source: - openapi: batch-openapi.json - FacePrediction: - properties: - frame: - type: uint64 - docs: Frame number - time: - type: double - docs: Time in seconds when face detection occurred. - prob: - type: double - docs: The predicted probability that a detected face was actually a face. - box: BoundingBox - emotions: - docs: A high-dimensional embedding in emotion space. - type: list - facs: - type: optional> - docs: FACS 2.0 features and their scores. - descriptions: - type: optional> - docs: Modality-specific descriptive features and their scores. - source: - openapi: batch-openapi.json - FacemeshPrediction: - properties: - emotions: - docs: A high-dimensional embedding in emotion space. - type: list - source: - openapi: batch-openapi.json - FacsScore: - properties: - name: - type: string - docs: Name of the FACS 2.0 feature being expressed. - score: - type: float - docs: Embedding value for the FACS 2.0 feature being expressed. - source: - openapi: batch-openapi.json - Failed: - properties: - created_timestamp_ms: - type: long - docs: When this job was created (Unix timestamp in milliseconds). - started_timestamp_ms: - type: long - docs: When this job started (Unix timestamp in milliseconds). - ended_timestamp_ms: - type: long - docs: When this job ended (Unix timestamp in milliseconds). - message: - type: string - docs: An error message. - source: - openapi: batch-openapi.json - File: - docs: The list of files submitted for analysis. - properties: - filename: - type: optional - docs: The name of the file. - content_type: - type: optional - docs: The content type of the file. - md5sum: - type: string - docs: The MD5 checksum of the file. - source: - openapi: batch-openapi.json - Granularity: - enum: - - word - - sentence - - utterance - - conversational_turn + Number of frames per second to process. Other frames will be omitted + from the response. Set to `0` to process every frame. + default: 3 + prob_threshold: + type: optional docs: >- - The granularity at which to generate predictions. The `granularity` field - is ignored if transcription is not enabled or if the `window` field has - been set. - - - - `word`: At the word level, our model provides a separate output for each - word, offering the most granular insight into emotional expression during - speech. - - - - `sentence`: At the sentence level of granularity, we annotate the - emotional tone of each spoken sentence with our Prosody and Emotional - Language models. - - - - `utterance`: Utterance-level granularity is between word- and - sentence-level. It takes into account natural pauses or breaks in speech, - providing more rapidly updated measures of emotional expression within a - flowing conversation. For text inputs, utterance-level granularity will - produce results identical to sentence-level granularity. - - - - `conversational_turn`: Conversational turn-level granularity provides a - distinct output for each change in speaker. It captures the full sequence - of words and sentences spoken uninterrupted by each person. This approach - provides a higher-level view of the emotional dynamics in a - multi-participant dialogue. For text inputs, specifying conversational - turn-level granularity for our Emotional Language model will produce - results for the entire passage. - source: - openapi: batch-openapi.json - GroupedPredictionsBurstPrediction: - properties: - id: - type: string - docs: >- - An automatically generated label to identify individuals in your media - file. Will be `unknown` if you have chosen to disable identification, - or if the model is unable to distinguish between individuals. - predictions: list - source: - openapi: batch-openapi.json - GroupedPredictionsFacePrediction: - properties: - id: - type: string - docs: >- - An automatically generated label to identify individuals in your media - file. Will be `unknown` if you have chosen to disable identification, - or if the model is unable to distinguish between individuals. - predictions: list - source: - openapi: batch-openapi.json - GroupedPredictionsFacemeshPrediction: - properties: - id: - type: string - docs: >- - An automatically generated label to identify individuals in your media - file. Will be `unknown` if you have chosen to disable identification, - or if the model is unable to distinguish between individuals. - predictions: list - source: - openapi: batch-openapi.json - GroupedPredictionsLanguagePrediction: - properties: - id: - type: string - docs: >- - An automatically generated label to identify individuals in your media - file. Will be `unknown` if you have chosen to disable identification, - or if the model is unable to distinguish between individuals. - predictions: list - source: - openapi: batch-openapi.json - GroupedPredictionsNerPrediction: - properties: - id: - type: string - docs: >- - An automatically generated label to identify individuals in your media - file. Will be `unknown` if you have chosen to disable identification, - or if the model is unable to distinguish between individuals. - predictions: list - source: - openapi: batch-openapi.json - GroupedPredictionsProsodyPrediction: - properties: - id: - type: string - docs: >- - An automatically generated label to identify individuals in your media - file. Will be `unknown` if you have chosen to disable identification, - or if the model is unable to distinguish between individuals. - predictions: list - source: - openapi: batch-openapi.json - InProgress: - properties: - created_timestamp_ms: - type: long - docs: When this job was created (Unix timestamp in milliseconds). - started_timestamp_ms: - type: long - docs: When this job started (Unix timestamp in milliseconds). - source: - openapi: batch-openapi.json - InferenceBaseRequest: - properties: - models: - type: optional - docs: >- - Specify the models to use for inference. - - - If this field is not explicitly set, then all models will run by - default. - transcription: optional - urls: - type: optional> - docs: >- - URLs to the media files to be processed. Each must be a valid public - URL to a media file (see recommended input filetypes) or an archive - (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files. - - - If you wish to supply more than 100 URLs, consider providing them as - an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`). - text: - type: optional> - docs: >- - Text supplied directly to our Emotional Language and NER models for - analysis. - callback_url: - type: optional - docs: >- - If provided, a `POST` request will be made to the URL with the - generated predictions on completion or the error message on failure. - notify: - type: optional - docs: >- - Whether to send an email notification to the user upon job - completion/failure. - default: false - source: - openapi: batch-openapi.json - InferencePrediction: - properties: - file: - type: string - docs: A file path relative to the top level source URL or file. - models: ModelsPredictions - source: - openapi: batch-openapi.json - InferenceRequest: - properties: - models: optional - transcription: optional - urls: - type: optional> - docs: >- - URLs to the media files to be processed. Each must be a valid public - URL to a media file (see recommended input filetypes) or an archive - (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files. - - - If you wish to supply more than 100 URLs, consider providing them as - an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`). - text: - type: optional> - docs: Text to supply directly to our language and NER models. - callback_url: - type: optional - docs: >- - If provided, a `POST` request will be made to the URL with the - generated predictions on completion or the error message on failure. - notify: - type: optional - docs: >- - Whether to send an email notification to the user upon job - completion/failure. - default: false - files: list - source: - openapi: batch-openapi.json - InferenceResults: - properties: - predictions: list - errors: list - source: - openapi: batch-openapi.json - InferenceSourcePredictResult: - properties: - source: Source - results: optional - error: - type: optional - docs: An error message. - source: - openapi: batch-openapi.json - JobEmbeddingGeneration: - properties: - job_id: - type: string - docs: The ID associated with this job. - validation: - format: uuid - user_id: - type: string - validation: - format: uuid - request: EmbeddingGenerationBaseRequest - state: StateEmbeddingGeneration - source: - openapi: batch-openapi.json - JobInference: - properties: - job_id: - type: string - docs: The ID associated with this job. - validation: - format: uuid - request: - type: InferenceRequest - docs: The request that initiated the job. - state: - type: StateInference - docs: The current state of the job. - source: - openapi: batch-openapi.json - JobTlInference: - properties: - job_id: - type: string - docs: The ID associated with this job. - validation: - format: uuid - user_id: - type: string - validation: - format: uuid - request: TlInferenceBaseRequest - state: StateTlInference - source: - openapi: batch-openapi.json - JobTraining: - properties: - job_id: - type: string - docs: The ID associated with this job. - validation: - format: uuid - user_id: - type: string - validation: - format: uuid - request: TrainingBaseRequest - state: StateTraining - source: - openapi: batch-openapi.json - JobId: - properties: - job_id: - type: string - docs: The ID of the started job. - validation: - format: uuid - source: - openapi: batch-files-openapi.yml - Language: + Face detection probability threshold. Faces detected with a + probability less than this threshold will be omitted from the + response. + default: 0.99 + validation: + min: 0 + max: 1 + identify_faces: + type: optional + docs: >- + Whether to return identifiers for faces across frames. If `true`, + unique identifiers will be assigned to face bounding boxes to + differentiate different faces. If `false`, all faces will be tagged + with an `unknown` ID. + default: false + min_face_size: + type: optional docs: >- - The Emotional Language model analyzes passages of text. This also supports - audio and video files by transcribing and then directly analyzing the - transcribed text. - - - Recommended input filetypes: `.txt`, `.mp3`, `.wav`, `.mp4` - properties: - granularity: optional - sentiment: optional - toxicity: optional - identify_speakers: - type: optional - docs: >- - Whether to return identifiers for speakers over time. If `true`, - unique identifiers will be assigned to spoken words to differentiate - different speakers. If `false`, all speakers will be tagged with an - `unknown` ID. - default: false - source: - openapi: batch-openapi.json - LanguagePrediction: - properties: - text: - type: string - docs: A segment of text (like a word or a sentence). - position: PositionInterval - time: optional - confidence: - type: optional - docs: >- - Value between `0.0` and `1.0` that indicates our transcription model's - relative confidence in this text. - speaker_confidence: - type: optional - docs: >- - Value between `0.0` and `1.0` that indicates our transcription model's - relative confidence that this text was spoken by this speaker. - emotions: - docs: A high-dimensional embedding in emotion space. - type: list - sentiment: - type: optional> - docs: >- - Sentiment predictions returned as a distribution. This model predicts - the probability that a given text could be interpreted as having each - sentiment level from `1` (negative) to `9` (positive). - - - Compared to returning one estimate of sentiment, this enables a more - nuanced analysis of a text's meaning. For example, a text with very - neutral sentiment would have an average rating of `5`. But also a text - that could be interpreted as having very positive sentiment or very - negative sentiment would also have an average rating of `5`. The - average sentiment is less informative than the distribution over - sentiment, so this API returns a value for each sentiment level. - toxicity: - type: optional> - docs: >- - Toxicity predictions returned as probabilities that the text can be - classified into the following categories: `toxic`, `severe_toxic`, - `obscene`, `threat`, `insult`, and `identity_hate`. - source: - openapi: batch-openapi.json - Models: - docs: The models used for inference. - properties: - face: optional - burst: optional - prosody: optional - language: optional - ner: optional - facemesh: optional - source: - openapi: batch-openapi.json - ModelsPredictions: - properties: - face: optional - burst: optional - prosody: optional - language: optional - ner: optional - facemesh: optional - source: - openapi: batch-openapi.json - Ner: + Minimum bounding box side length in pixels to treat as a face. Faces + detected with a bounding box side length in pixels less than this + threshold will be omitted from the response. + facs: optional + descriptions: optional + save_faces: + type: optional docs: >- - The NER (Named-entity Recognition) model identifies real-world objects and - concepts in passages of text. This also supports audio and video files by - transcribing and then directly analyzing the transcribed text. - - - Recommended input filetypes: `.txt`, `.mp3`, `.wav`, `.mp4` - properties: - identify_speakers: - type: optional - docs: >- - Whether to return identifiers for speakers over time. If `true`, - unique identifiers will be assigned to spoken words to differentiate - different speakers. If `false`, all speakers will be tagged with an - `unknown` ID. - default: false - source: - openapi: batch-openapi.json - NerPrediction: - properties: - entity: - type: string - docs: The recognized topic or entity. - position: PositionInterval - entity_confidence: - type: double - docs: Our NER model's relative confidence in the recognized topic or entity. - support: - type: double - docs: A measure of how often the entity is linked to by other entities. - uri: - type: string - docs: >- - A URL which provides more information about the recognized topic or - entity. - link_word: - type: string - docs: The specific word to which the emotion predictions are linked. - time: optional - confidence: - type: optional - docs: >- - Value between `0.0` and `1.0` that indicates our transcription model's - relative confidence in this text. - speaker_confidence: - type: optional - docs: >- - Value between `0.0` and `1.0` that indicates our transcription model's - relative confidence that this text was spoken by this speaker. - emotions: - docs: A high-dimensional embedding in emotion space. - type: list - source: - openapi: batch-openapi.json - "Null": - type: map - docs: No associated metadata for this model. Value will be `null`. - PositionInterval: + Whether to extract and save the detected faces in the artifacts zip + created by each job. + default: false + source: + openapi: batch-openapi.json + FacePrediction: + properties: + frame: + type: uint64 + docs: Frame number + time: + type: double + docs: Time in seconds when face detection occurred. + prob: + type: double + docs: The predicted probability that a detected face was actually a face. + box: BoundingBox + emotions: + docs: A high-dimensional embedding in emotion space. + type: list + facs: + type: optional> + docs: FACS 2.0 features and their scores. + descriptions: + type: optional> + docs: Modality-specific descriptive features and their scores. + source: + openapi: batch-openapi.json + FacemeshPrediction: + properties: + emotions: + docs: A high-dimensional embedding in emotion space. + type: list + source: + openapi: batch-openapi.json + FacsScore: + properties: + name: + type: string + docs: Name of the FACS 2.0 feature being expressed. + score: + type: float + docs: Embedding value for the FACS 2.0 feature being expressed. + source: + openapi: batch-openapi.json + Failed: + properties: + created_timestamp_ms: + type: long + docs: When this job was created (Unix timestamp in milliseconds). + started_timestamp_ms: + type: long + docs: When this job started (Unix timestamp in milliseconds). + ended_timestamp_ms: + type: long + docs: When this job ended (Unix timestamp in milliseconds). + message: + type: string + docs: An error message. + source: + openapi: batch-openapi.json + File: + docs: The list of files submitted for analysis. + properties: + filename: + type: optional + docs: The name of the file. + content_type: + type: optional + docs: The content type of the file. + md5sum: + type: string + docs: The MD5 checksum of the file. + source: + openapi: batch-openapi.json + Granularity: + enum: + - word + - sentence + - utterance + - conversational_turn + docs: >- + The granularity at which to generate predictions. The `granularity` field + is ignored if transcription is not enabled or if the `window` field has + been set. + + + - `word`: At the word level, our model provides a separate output for each + word, offering the most granular insight into emotional expression during + speech. + + + - `sentence`: At the sentence level of granularity, we annotate the + emotional tone of each spoken sentence with our Prosody and Emotional + Language models. + + + - `utterance`: Utterance-level granularity is between word- and + sentence-level. It takes into account natural pauses or breaks in speech, + providing more rapidly updated measures of emotional expression within a + flowing conversation. For text inputs, utterance-level granularity will + produce results identical to sentence-level granularity. + + + - `conversational_turn`: Conversational turn-level granularity provides a + distinct output for each change in speaker. It captures the full sequence + of words and sentences spoken uninterrupted by each person. This approach + provides a higher-level view of the emotional dynamics in a + multi-participant dialogue. For text inputs, specifying conversational + turn-level granularity for our Emotional Language model will produce + results for the entire passage. + source: + openapi: batch-openapi.json + GroupedPredictionsBurstPrediction: + properties: + id: + type: string docs: >- - Position of a segment of text within a larger document, measured in - characters. Uses zero-based indexing. The beginning index is inclusive and - the end index is exclusive. - properties: - begin: - type: uint64 - docs: The index of the first character in the text segment, inclusive. - end: - type: uint64 - docs: The index of the last character in the text segment, exclusive. - source: - openapi: batch-openapi.json - PredictionsOptionalNullBurstPrediction: - properties: - metadata: optional - grouped_predictions: list - source: - openapi: batch-openapi.json - PredictionsOptionalNullFacePrediction: - properties: - metadata: optional - grouped_predictions: list - source: - openapi: batch-openapi.json - PredictionsOptionalNullFacemeshPrediction: - properties: - metadata: optional - grouped_predictions: list - source: - openapi: batch-openapi.json - PredictionsOptionalTranscriptionMetadataLanguagePrediction: - properties: - metadata: optional - grouped_predictions: list - source: - openapi: batch-openapi.json - PredictionsOptionalTranscriptionMetadataNerPrediction: - properties: - metadata: optional - grouped_predictions: list - source: - openapi: batch-openapi.json - PredictionsOptionalTranscriptionMetadataProsodyPrediction: - properties: - metadata: optional - grouped_predictions: list - source: - openapi: batch-openapi.json - Prosody: + An automatically generated label to identify individuals in your media + file. Will be `unknown` if you have chosen to disable identification, + or if the model is unable to distinguish between individuals. + predictions: list + source: + openapi: batch-openapi.json + GroupedPredictionsFacePrediction: + properties: + id: + type: string docs: >- - The Speech Prosody model analyzes the intonation, stress, and rhythm of - spoken word. - - - Recommended input file types: `.wav`, `.mp3`, `.mp4` - properties: - granularity: optional - window: optional - identify_speakers: - type: optional - docs: >- - Whether to return identifiers for speakers over time. If `true`, - unique identifiers will be assigned to spoken words to differentiate - different speakers. If `false`, all speakers will be tagged with an - `unknown` ID. - default: false - source: - openapi: batch-openapi.json - ProsodyPrediction: - properties: - text: - type: optional - docs: A segment of text (like a word or a sentence). - time: TimeInterval - confidence: - type: optional - docs: >- - Value between `0.0` and `1.0` that indicates our transcription model's - relative confidence in this text. - speaker_confidence: - type: optional - docs: >- - Value between `0.0` and `1.0` that indicates our transcription model's - relative confidence that this text was spoken by this speaker. - emotions: - docs: A high-dimensional embedding in emotion space. - type: list - source: - openapi: batch-openapi.json - Queued: - properties: - created_timestamp_ms: - type: long - docs: When this job was created (Unix timestamp in milliseconds). - source: - openapi: batch-openapi.json - RegistryFileDetail: - properties: - file_id: - type: string - docs: File ID in the Asset Registry - file_url: - type: string - docs: URL to the file in the Asset Registry - source: - openapi: batch-openapi.json - Regression: map - SentimentScore: - properties: - name: - type: string - docs: Level of sentiment, ranging from `1` (negative) to `9` (positive) - score: - type: float - docs: Prediction for this level of sentiment - source: - openapi: batch-openapi.json - SortBy: - enum: - - created - - started - - ended - source: - openapi: batch-openapi.json - Source: - discriminant: type - base-properties: {} - union: - url: SourceUrl - file: SourceFile - text: SourceTextSource - source: - openapi: batch-openapi.json - SourceFile: - properties: {} - extends: - - File - source: - openapi: batch-openapi.json - SourceTextSource: - properties: {} - source: - openapi: batch-openapi.json - SourceUrl: - properties: {} - extends: - - Url - source: - openapi: batch-openapi.json - Url: - properties: - url: - type: string - docs: The URL of the source media file. - source: - openapi: batch-openapi.json - StateEmbeddingGeneration: - discriminant: status - base-properties: {} - union: - QUEUED: StateEmbeddingGenerationQueued - IN_PROGRESS: StateEmbeddingGenerationInProgress - COMPLETED: StateEmbeddingGenerationCompletedEmbeddingGeneration - FAILED: StateEmbeddingGenerationFailed - source: - openapi: batch-openapi.json - StateEmbeddingGenerationCompletedEmbeddingGeneration: - properties: {} - extends: - - CompletedEmbeddingGeneration - source: - openapi: batch-openapi.json - StateEmbeddingGenerationFailed: - properties: {} - extends: - - Failed - source: - openapi: batch-openapi.json - StateEmbeddingGenerationInProgress: - properties: {} - extends: - - InProgress - source: - openapi: batch-openapi.json - StateEmbeddingGenerationQueued: - properties: {} - extends: - - Queued - source: - openapi: batch-openapi.json - StateInference: - discriminant: status - base-properties: {} - union: - QUEUED: QueuedState - IN_PROGRESS: InProgressState - COMPLETED: CompletedState - FAILED: FailedState - source: - openapi: batch-openapi.json - CompletedState: - properties: {} - extends: - - CompletedInference - source: - openapi: batch-openapi.json - FailedState: - properties: {} - extends: - - Failed - source: - openapi: batch-openapi.json - InProgressState: - properties: {} - extends: - - InProgress - source: - openapi: batch-openapi.json - QueuedState: - properties: {} - extends: - - Queued - source: - openapi: batch-openapi.json - StateTlInference: - discriminant: status - base-properties: {} - union: - QUEUED: StateTlInferenceQueued - IN_PROGRESS: StateTlInferenceInProgress - COMPLETED: StateTlInferenceCompletedTlInference - FAILED: StateTlInferenceFailed - source: - openapi: batch-openapi.json - StateTlInferenceCompletedTlInference: - properties: {} - extends: - - CompletedTlInference - source: - openapi: batch-openapi.json - StateTlInferenceFailed: - properties: {} - extends: - - Failed - source: - openapi: batch-openapi.json - StateTlInferenceInProgress: - properties: {} - extends: - - InProgress - source: - openapi: batch-openapi.json - StateTlInferenceQueued: - properties: {} - extends: - - Queued - source: - openapi: batch-openapi.json - StateTraining: - discriminant: status - base-properties: {} - union: - QUEUED: StateTrainingQueued - IN_PROGRESS: StateTrainingInProgress - COMPLETED: StateTrainingCompletedTraining - FAILED: StateTrainingFailed - source: - openapi: batch-openapi.json - StateTrainingCompletedTraining: - properties: {} - extends: - - CompletedTraining - source: - openapi: batch-openapi.json - StateTrainingFailed: - properties: {} - extends: - - Failed - source: - openapi: batch-openapi.json - StateTrainingInProgress: - properties: {} - extends: - - InProgress - source: - openapi: batch-openapi.json - StateTrainingQueued: - properties: {} - extends: - - Queued - source: - openapi: batch-openapi.json - Status: - enum: - - QUEUED - - IN_PROGRESS - - COMPLETED - - FAILED - source: - openapi: batch-openapi.json - TlInferencePrediction: - properties: - file: - type: string - docs: A file path relative to the top level source URL or file. - file_type: string - custom_models: map - source: - openapi: batch-openapi.json - TlInferenceResults: - properties: - predictions: list - errors: list - source: - openapi: batch-openapi.json - TlInferenceSourcePredictResult: - properties: - source: Source - results: optional - error: - type: optional - docs: An error message. - source: - openapi: batch-openapi.json - Tag: - properties: - key: string - value: string - source: - openapi: batch-openapi.json - Target: - discriminated: false - union: - - long - - double - - string - source: - openapi: batch-openapi.json - Task: - discriminant: type - base-properties: {} - union: - classification: TaskClassification - regression: TaskRegression - source: - openapi: batch-openapi.json - TaskClassification: - properties: {} - source: - openapi: batch-openapi.json - TaskRegression: - properties: {} - source: - openapi: batch-openapi.json - TextSource: map - TimeInterval: - docs: A time range with a beginning and end, measured in seconds. - properties: - begin: - type: double - docs: Beginning of time range in seconds. - end: - type: double - docs: End of time range in seconds. - source: - openapi: batch-openapi.json - TlInferenceBaseRequest: - properties: - custom_model: CustomModel - urls: - type: optional> - docs: >- - URLs to the media files to be processed. Each must be a valid public - URL to a media file (see recommended input filetypes) or an archive - (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files. - - - If you wish to supply more than 100 URLs, consider providing them as - an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`). - callback_url: - type: optional - docs: >- - If provided, a `POST` request will be made to the URL with the - generated predictions on completion or the error message on failure. - notify: - type: optional - docs: >- - Whether to send an email notification to the user upon job - completion/failure. - default: false - source: - openapi: batch-openapi.json - CustomModel: - discriminated: false - union: - - CustomModelId - - CustomModelVersionId - source: - openapi: batch-openapi.json - CustomModelId: - properties: - id: string - source: - openapi: batch-openapi.json - CustomModelVersionId: - properties: - version_id: string - source: - openapi: batch-openapi.json - ToxicityScore: - properties: - name: - type: string - docs: Category of toxicity. - score: - type: float - docs: Prediction for this category of toxicity - source: - openapi: batch-openapi.json - TrainingBaseRequest: - properties: - custom_model: CustomModelRequest - dataset: Dataset - target_feature: - type: optional - default: label - task: optional - evaluation: optional - alternatives: optional> - callback_url: optional - notify: - type: optional - default: false - source: - openapi: batch-openapi.json - TrainingCustomModel: - properties: - id: string - version_id: optional - source: - openapi: batch-openapi.json - Transcription: - docs: |- - Transcription-related configuration options. - - To disable transcription, explicitly set this field to `null`. - properties: - language: - type: optional - docs: >- - By default, we use an automated language detection method for our - Speech Prosody, Language, and NER models. However, if you know what - language is being spoken in your media samples, you can specify it via - its BCP-47 tag and potentially obtain more accurate results. - - - You can specify any of the following languages: - - - Chinese: `zh` - - - Danish: `da` - - - Dutch: `nl` - - - English: `en` - - - English (Australia): `en-AU` - - - English (India): `en-IN` - - - English (New Zealand): `en-NZ` - - - English (United Kingdom): `en-GB` - - - French: `fr` - - - French (Canada): `fr-CA` - - - German: `de` - - - Hindi: `hi` - - - Hindi (Roman Script): `hi-Latn` - - - Indonesian: `id` - - - Italian: `it` - - - Japanese: `ja` - - - Korean: `ko` - - - Norwegian: `no` - - - Polish: `pl` - - - Portuguese: `pt` - - - Portuguese (Brazil): `pt-BR` - - - Portuguese (Portugal): `pt-PT` - - - Russian: `ru` - - - Spanish: `es` - - - Spanish (Latin America): `es-419` - - - Swedish: `sv` - - - Tamil: `ta` - - - Turkish: `tr` - - - Ukrainian: `uk` - identify_speakers: - type: optional - docs: >- - Whether to return identifiers for speakers over time. If `true`, - unique identifiers will be assigned to spoken words to differentiate - different speakers. If `false`, all speakers will be tagged with an - `unknown` ID. - default: false - confidence_threshold: - type: optional - docs: >- - Transcript confidence threshold. Transcripts generated with a - confidence less than this threshold will be considered invalid and not - used as an input for model inference. - default: 0.5 - validation: - min: 0 - max: 1 - source: - openapi: batch-openapi.json - TranscriptionMetadata: - docs: Transcription metadata for your media file. - properties: - confidence: - type: double - docs: >- - Value between `0.0` and `1.0` indicating our transcription model's - relative confidence in the transcription of your media file. - detected_language: optional - source: - openapi: batch-openapi.json - Type: - enum: - - EMBEDDING_GENERATION - - INFERENCE - - TL_INFERENCE - - TRAINING - source: - openapi: batch-openapi.json - Unconfigurable: - type: map + An automatically generated label to identify individuals in your media + file. Will be `unknown` if you have chosen to disable identification, + or if the model is unable to distinguish between individuals. + predictions: list + source: + openapi: batch-openapi.json + GroupedPredictionsFacemeshPrediction: + properties: + id: + type: string + docs: >- + An automatically generated label to identify individuals in your media + file. Will be `unknown` if you have chosen to disable identification, + or if the model is unable to distinguish between individuals. + predictions: list + source: + openapi: batch-openapi.json + GroupedPredictionsLanguagePrediction: + properties: + id: + type: string + docs: >- + An automatically generated label to identify individuals in your media + file. Will be `unknown` if you have chosen to disable identification, + or if the model is unable to distinguish between individuals. + predictions: list + source: + openapi: batch-openapi.json + GroupedPredictionsNerPrediction: + properties: + id: + type: string + docs: >- + An automatically generated label to identify individuals in your media + file. Will be `unknown` if you have chosen to disable identification, + or if the model is unable to distinguish between individuals. + predictions: list + source: + openapi: batch-openapi.json + GroupedPredictionsProsodyPrediction: + properties: + id: + type: string + docs: >- + An automatically generated label to identify individuals in your media + file. Will be `unknown` if you have chosen to disable identification, + or if the model is unable to distinguish between individuals. + predictions: list + source: + openapi: batch-openapi.json + InProgress: + properties: + created_timestamp_ms: + type: long + docs: When this job was created (Unix timestamp in milliseconds). + started_timestamp_ms: + type: long + docs: When this job started (Unix timestamp in milliseconds). + source: + openapi: batch-openapi.json + InferenceBaseRequest: + properties: + models: + type: optional docs: >- - To include predictions for this model type, set this field to `{}`. It is - currently not configurable further. - UnionJob: InferenceJob - EmbeddingGenerationJob: - properties: - type: string - extends: - - JobEmbeddingGeneration - source: - openapi: batch-openapi.json - InferenceJob: - properties: - type: - type: string - docs: >- - Denotes the job type. - - - Jobs created with the Expression Measurement API will have this field - set to `INFERENCE`. - extends: - - JobInference - source: - openapi: batch-openapi.json - CustomModelsInferenceJob: - properties: - type: string - extends: - - JobTlInference - source: - openapi: batch-openapi.json - CustomModelsTrainingJob: - properties: - type: string - extends: - - JobTraining - source: - openapi: batch-openapi.json - UnionPredictResult: InferenceSourcePredictResult - ValidationArgs: - properties: - positive_label: optional - source: - openapi: batch-openapi.json - When: - enum: - - created_before - - created_after - source: - openapi: batch-openapi.json - Window: + Specify the models to use for inference. + + + If this field is not explicitly set, then all models will run by + default. + transcription: optional + urls: + type: optional> docs: >- - Generate predictions based on time. - - - Setting the `window` field allows for a 'sliding window' approach, where a - fixed-size window moves across the audio or video file in defined steps. - This enables continuous analysis of prosody within subsets of the file, - providing dynamic and localized insights into emotional expression. - properties: - length: - type: optional - docs: The length of the sliding window. - default: 4 - validation: - min: 0.5 - step: - type: optional - docs: The step size of the sliding window. - default: 1 - validation: - min: 0.5 - source: - openapi: batch-openapi.json + URLs to the media files to be processed. Each must be a valid public + URL to a media file (see recommended input filetypes) or an archive + (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files. + + + If you wish to supply more than 100 URLs, consider providing them as + an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`). + text: + type: optional> + docs: >- + Text supplied directly to our Emotional Language and NER models for + analysis. + callback_url: + type: optional + docs: >- + If provided, a `POST` request will be made to the URL with the + generated predictions on completion or the error message on failure. + notify: + type: optional + docs: >- + Whether to send an email notification to the user upon job + completion/failure. + default: false + source: + openapi: batch-openapi.json + InferencePrediction: + properties: + file: + type: string + docs: A file path relative to the top level source URL or file. + models: ModelsPredictions + source: + openapi: batch-openapi.json + InferenceRequest: + properties: + models: optional + transcription: optional + urls: + type: optional> + docs: >- + URLs to the media files to be processed. Each must be a valid public + URL to a media file (see recommended input filetypes) or an archive + (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files. + + + If you wish to supply more than 100 URLs, consider providing them as + an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`). + text: + type: optional> + docs: Text to supply directly to our language and NER models. + callback_url: + type: optional + docs: >- + If provided, a `POST` request will be made to the URL with the + generated predictions on completion or the error message on failure. + notify: + type: optional + docs: >- + Whether to send an email notification to the user upon job + completion/failure. + default: false + files: list + source: + openapi: batch-openapi.json + InferenceResults: + properties: + predictions: list + errors: list + source: + openapi: batch-openapi.json + InferenceSourcePredictResult: + properties: + source: Source + results: optional + error: + type: optional + docs: An error message. + source: + openapi: batch-openapi.json + JobEmbeddingGeneration: + properties: + job_id: + type: string + docs: The ID associated with this job. + validation: + format: uuid + user_id: + type: string + validation: + format: uuid + request: EmbeddingGenerationBaseRequest + state: StateEmbeddingGeneration + source: + openapi: batch-openapi.json + JobInference: + properties: + job_id: + type: string + docs: The ID associated with this job. + validation: + format: uuid + request: + type: InferenceRequest + docs: The request that initiated the job. + state: + type: StateInference + docs: The current state of the job. + source: + openapi: batch-openapi.json + JobTlInference: + properties: + job_id: + type: string + docs: The ID associated with this job. + validation: + format: uuid + user_id: + type: string + validation: + format: uuid + request: TlInferenceBaseRequest + state: StateTlInference + source: + openapi: batch-openapi.json + JobTraining: + properties: + job_id: + type: string + docs: The ID associated with this job. + validation: + format: uuid + user_id: + type: string + validation: + format: uuid + request: TrainingBaseRequest + state: StateTraining + source: + openapi: batch-openapi.json + JobId: + properties: + job_id: + type: string + docs: The ID of the started job. + validation: + format: uuid + source: + openapi: batch-files-openapi.yml + Language: + docs: >- + The Emotional Language model analyzes passages of text. This also supports + audio and video files by transcribing and then directly analyzing the + transcribed text. + + + Recommended input filetypes: `.txt`, `.mp3`, `.wav`, `.mp4` + properties: + granularity: optional + sentiment: optional + toxicity: optional + identify_speakers: + type: optional + docs: >- + Whether to return identifiers for speakers over time. If `true`, + unique identifiers will be assigned to spoken words to differentiate + different speakers. If `false`, all speakers will be tagged with an + `unknown` ID. + default: false + source: + openapi: batch-openapi.json + LanguagePrediction: + properties: + text: + type: string + docs: A segment of text (like a word or a sentence). + position: PositionInterval + time: optional + confidence: + type: optional + docs: >- + Value between `0.0` and `1.0` that indicates our transcription model's + relative confidence in this text. + speaker_confidence: + type: optional + docs: >- + Value between `0.0` and `1.0` that indicates our transcription model's + relative confidence that this text was spoken by this speaker. + emotions: + docs: A high-dimensional embedding in emotion space. + type: list + sentiment: + type: optional> + docs: >- + Sentiment predictions returned as a distribution. This model predicts + the probability that a given text could be interpreted as having each + sentiment level from `1` (negative) to `9` (positive). + + + Compared to returning one estimate of sentiment, this enables a more + nuanced analysis of a text's meaning. For example, a text with very + neutral sentiment would have an average rating of `5`. But also a text + that could be interpreted as having very positive sentiment or very + negative sentiment would also have an average rating of `5`. The + average sentiment is less informative than the distribution over + sentiment, so this API returns a value for each sentiment level. + toxicity: + type: optional> + docs: >- + Toxicity predictions returned as probabilities that the text can be + classified into the following categories: `toxic`, `severe_toxic`, + `obscene`, `threat`, `insult`, and `identity_hate`. + source: + openapi: batch-openapi.json + Models: + docs: The models used for inference. + properties: + face: optional + burst: optional + prosody: optional + language: optional + ner: optional + facemesh: optional + source: + openapi: batch-openapi.json + ModelsPredictions: + properties: + face: optional + burst: optional + prosody: optional + language: optional + ner: optional + facemesh: optional + source: + openapi: batch-openapi.json + Ner: + docs: >- + The NER (Named-entity Recognition) model identifies real-world objects and + concepts in passages of text. This also supports audio and video files by + transcribing and then directly analyzing the transcribed text. + + + Recommended input filetypes: `.txt`, `.mp3`, `.wav`, `.mp4` + properties: + identify_speakers: + type: optional + docs: >- + Whether to return identifiers for speakers over time. If `true`, + unique identifiers will be assigned to spoken words to differentiate + different speakers. If `false`, all speakers will be tagged with an + `unknown` ID. + default: false + source: + openapi: batch-openapi.json + NerPrediction: + properties: + entity: + type: string + docs: The recognized topic or entity. + position: PositionInterval + entity_confidence: + type: double + docs: Our NER model's relative confidence in the recognized topic or entity. + support: + type: double + docs: A measure of how often the entity is linked to by other entities. + uri: + type: string + docs: >- + A URL which provides more information about the recognized topic or + entity. + link_word: + type: string + docs: The specific word to which the emotion predictions are linked. + time: optional + confidence: + type: optional + docs: >- + Value between `0.0` and `1.0` that indicates our transcription model's + relative confidence in this text. + speaker_confidence: + type: optional + docs: >- + Value between `0.0` and `1.0` that indicates our transcription model's + relative confidence that this text was spoken by this speaker. + emotions: + docs: A high-dimensional embedding in emotion space. + type: list + source: + openapi: batch-openapi.json + 'Null': + type: map + docs: No associated metadata for this model. Value will be `null`. + PositionInterval: + docs: >- + Position of a segment of text within a larger document, measured in + characters. Uses zero-based indexing. The beginning index is inclusive and + the end index is exclusive. + properties: + begin: + type: uint64 + docs: The index of the first character in the text segment, inclusive. + end: + type: uint64 + docs: The index of the last character in the text segment, exclusive. + source: + openapi: batch-openapi.json + PredictionsOptionalNullBurstPrediction: + properties: + metadata: optional + grouped_predictions: list + source: + openapi: batch-openapi.json + PredictionsOptionalNullFacePrediction: + properties: + metadata: optional + grouped_predictions: list + source: + openapi: batch-openapi.json + PredictionsOptionalNullFacemeshPrediction: + properties: + metadata: optional + grouped_predictions: list + source: + openapi: batch-openapi.json + PredictionsOptionalTranscriptionMetadataLanguagePrediction: + properties: + metadata: optional + grouped_predictions: list + source: + openapi: batch-openapi.json + PredictionsOptionalTranscriptionMetadataNerPrediction: + properties: + metadata: optional + grouped_predictions: list + source: + openapi: batch-openapi.json + PredictionsOptionalTranscriptionMetadataProsodyPrediction: + properties: + metadata: optional + grouped_predictions: list + source: + openapi: batch-openapi.json + Prosody: + docs: >- + The Speech Prosody model analyzes the intonation, stress, and rhythm of + spoken word. + + + Recommended input file types: `.wav`, `.mp3`, `.mp4` + properties: + granularity: optional + window: optional + identify_speakers: + type: optional + docs: >- + Whether to return identifiers for speakers over time. If `true`, + unique identifiers will be assigned to spoken words to differentiate + different speakers. If `false`, all speakers will be tagged with an + `unknown` ID. + default: false + source: + openapi: batch-openapi.json + ProsodyPrediction: + properties: + text: + type: optional + docs: A segment of text (like a word or a sentence). + time: TimeInterval + confidence: + type: optional + docs: >- + Value between `0.0` and `1.0` that indicates our transcription model's + relative confidence in this text. + speaker_confidence: + type: optional + docs: >- + Value between `0.0` and `1.0` that indicates our transcription model's + relative confidence that this text was spoken by this speaker. + emotions: + docs: A high-dimensional embedding in emotion space. + type: list + source: + openapi: batch-openapi.json + Queued: + properties: + created_timestamp_ms: + type: long + docs: When this job was created (Unix timestamp in milliseconds). + source: + openapi: batch-openapi.json + RegistryFileDetail: + properties: + file_id: + type: string + docs: File ID in the Asset Registry + file_url: + type: string + docs: URL to the file in the Asset Registry + source: + openapi: batch-openapi.json + Regression: map + SentimentScore: + properties: + name: + type: string + docs: Level of sentiment, ranging from `1` (negative) to `9` (positive) + score: + type: float + docs: Prediction for this level of sentiment + source: + openapi: batch-openapi.json + SortBy: + enum: + - created + - started + - ended + source: + openapi: batch-openapi.json + Source: + discriminant: type + base-properties: {} + union: + url: SourceUrl + file: SourceFile + text: SourceTextSource + source: + openapi: batch-openapi.json + SourceFile: + properties: {} + extends: + - File + source: + openapi: batch-openapi.json + SourceTextSource: + properties: {} + source: + openapi: batch-openapi.json + SourceUrl: + properties: {} + extends: + - Url + source: + openapi: batch-openapi.json + Url: + properties: + url: + type: string + docs: The URL of the source media file. + source: + openapi: batch-openapi.json + StateEmbeddingGeneration: + discriminant: status + base-properties: {} + union: + QUEUED: StateEmbeddingGenerationQueued + IN_PROGRESS: StateEmbeddingGenerationInProgress + COMPLETED: StateEmbeddingGenerationCompletedEmbeddingGeneration + FAILED: StateEmbeddingGenerationFailed + source: + openapi: batch-openapi.json + StateEmbeddingGenerationCompletedEmbeddingGeneration: + properties: {} + extends: + - CompletedEmbeddingGeneration + source: + openapi: batch-openapi.json + StateEmbeddingGenerationFailed: + properties: {} + extends: + - Failed + source: + openapi: batch-openapi.json + StateEmbeddingGenerationInProgress: + properties: {} + extends: + - InProgress + source: + openapi: batch-openapi.json + StateEmbeddingGenerationQueued: + properties: {} + extends: + - Queued + source: + openapi: batch-openapi.json + StateInference: + discriminant: status + base-properties: {} + union: + QUEUED: QueuedState + IN_PROGRESS: InProgressState + COMPLETED: CompletedState + FAILED: FailedState + source: + openapi: batch-openapi.json + CompletedState: + properties: {} + extends: + - CompletedInference + source: + openapi: batch-openapi.json + FailedState: + properties: {} + extends: + - Failed + source: + openapi: batch-openapi.json + InProgressState: + properties: {} + extends: + - InProgress + source: + openapi: batch-openapi.json + QueuedState: + properties: {} + extends: + - Queued + source: + openapi: batch-openapi.json + StateTlInference: + discriminant: status + base-properties: {} + union: + QUEUED: StateTlInferenceQueued + IN_PROGRESS: StateTlInferenceInProgress + COMPLETED: StateTlInferenceCompletedTlInference + FAILED: StateTlInferenceFailed + source: + openapi: batch-openapi.json + StateTlInferenceCompletedTlInference: + properties: {} + extends: + - CompletedTlInference + source: + openapi: batch-openapi.json + StateTlInferenceFailed: + properties: {} + extends: + - Failed + source: + openapi: batch-openapi.json + StateTlInferenceInProgress: + properties: {} + extends: + - InProgress + source: + openapi: batch-openapi.json + StateTlInferenceQueued: + properties: {} + extends: + - Queued + source: + openapi: batch-openapi.json + StateTraining: + discriminant: status + base-properties: {} + union: + QUEUED: StateTrainingQueued + IN_PROGRESS: StateTrainingInProgress + COMPLETED: StateTrainingCompletedTraining + FAILED: StateTrainingFailed + source: + openapi: batch-openapi.json + StateTrainingCompletedTraining: + properties: {} + extends: + - CompletedTraining + source: + openapi: batch-openapi.json + StateTrainingFailed: + properties: {} + extends: + - Failed + source: + openapi: batch-openapi.json + StateTrainingInProgress: + properties: {} + extends: + - InProgress + source: + openapi: batch-openapi.json + StateTrainingQueued: + properties: {} + extends: + - Queued + source: + openapi: batch-openapi.json + Status: + enum: + - QUEUED + - IN_PROGRESS + - COMPLETED + - FAILED + source: + openapi: batch-openapi.json + TlInferencePrediction: + properties: + file: + type: string + docs: A file path relative to the top level source URL or file. + file_type: string + custom_models: map + source: + openapi: batch-openapi.json + TlInferenceResults: + properties: + predictions: list + errors: list + source: + openapi: batch-openapi.json + TlInferenceSourcePredictResult: + properties: + source: Source + results: optional + error: + type: optional + docs: An error message. + source: + openapi: batch-openapi.json + Tag: + properties: + key: string + value: string + source: + openapi: batch-openapi.json + Target: + discriminated: false + union: + - long + - double + - string + source: + openapi: batch-openapi.json + Task: + discriminant: type + base-properties: {} + union: + classification: TaskClassification + regression: TaskRegression + source: + openapi: batch-openapi.json + TaskClassification: + properties: {} + source: + openapi: batch-openapi.json + TaskRegression: + properties: {} + source: + openapi: batch-openapi.json + TextSource: map + TimeInterval: + docs: A time range with a beginning and end, measured in seconds. + properties: + begin: + type: double + docs: Beginning of time range in seconds. + end: + type: double + docs: End of time range in seconds. + source: + openapi: batch-openapi.json + TlInferenceBaseRequest: + properties: + custom_model: CustomModel + urls: + type: optional> + docs: >- + URLs to the media files to be processed. Each must be a valid public + URL to a media file (see recommended input filetypes) or an archive + (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files. + + + If you wish to supply more than 100 URLs, consider providing them as + an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`). + callback_url: + type: optional + docs: >- + If provided, a `POST` request will be made to the URL with the + generated predictions on completion or the error message on failure. + notify: + type: optional + docs: >- + Whether to send an email notification to the user upon job + completion/failure. + default: false + source: + openapi: batch-openapi.json + CustomModel: + discriminated: false + union: + - CustomModelId + - CustomModelVersionId + source: + openapi: batch-openapi.json + CustomModelId: + properties: + id: string + source: + openapi: batch-openapi.json + CustomModelVersionId: + properties: + version_id: string + source: + openapi: batch-openapi.json + ToxicityScore: + properties: + name: + type: string + docs: Category of toxicity. + score: + type: float + docs: Prediction for this category of toxicity + source: + openapi: batch-openapi.json + TrainingBaseRequest: + properties: + custom_model: CustomModelRequest + dataset: Dataset + target_feature: + type: optional + default: label + task: optional + evaluation: optional + alternatives: optional> + callback_url: optional + notify: + type: optional + default: false + source: + openapi: batch-openapi.json + TrainingCustomModel: + properties: + id: string + version_id: optional + source: + openapi: batch-openapi.json + Transcription: + docs: |- + Transcription-related configuration options. + + To disable transcription, explicitly set this field to `null`. + properties: + language: + type: optional + docs: >- + By default, we use an automated language detection method for our + Speech Prosody, Language, and NER models. However, if you know what + language is being spoken in your media samples, you can specify it via + its BCP-47 tag and potentially obtain more accurate results. + + + You can specify any of the following languages: + + - Chinese: `zh` + + - Danish: `da` + + - Dutch: `nl` + + - English: `en` + + - English (Australia): `en-AU` + + - English (India): `en-IN` + + - English (New Zealand): `en-NZ` + + - English (United Kingdom): `en-GB` + + - French: `fr` + + - French (Canada): `fr-CA` + + - German: `de` + + - Hindi: `hi` + + - Hindi (Roman Script): `hi-Latn` + + - Indonesian: `id` + + - Italian: `it` + + - Japanese: `ja` + + - Korean: `ko` + + - Norwegian: `no` + + - Polish: `pl` + + - Portuguese: `pt` + + - Portuguese (Brazil): `pt-BR` + + - Portuguese (Portugal): `pt-PT` + + - Russian: `ru` + + - Spanish: `es` + + - Spanish (Latin America): `es-419` + + - Swedish: `sv` + + - Tamil: `ta` + + - Turkish: `tr` + + - Ukrainian: `uk` + identify_speakers: + type: optional + docs: >- + Whether to return identifiers for speakers over time. If `true`, + unique identifiers will be assigned to spoken words to differentiate + different speakers. If `false`, all speakers will be tagged with an + `unknown` ID. + default: false + confidence_threshold: + type: optional + docs: >- + Transcript confidence threshold. Transcripts generated with a + confidence less than this threshold will be considered invalid and not + used as an input for model inference. + default: 0.5 + validation: + min: 0 + max: 1 + source: + openapi: batch-openapi.json + TranscriptionMetadata: + docs: Transcription metadata for your media file. + properties: + confidence: + type: double + docs: >- + Value between `0.0` and `1.0` indicating our transcription model's + relative confidence in the transcription of your media file. + detected_language: optional + source: + openapi: batch-openapi.json + Type: + enum: + - EMBEDDING_GENERATION + - INFERENCE + - TL_INFERENCE + - TRAINING + source: + openapi: batch-openapi.json + Unconfigurable: + type: map + docs: >- + To include predictions for this model type, set this field to `{}`. It is + currently not configurable further. + UnionJob: InferenceJob + EmbeddingGenerationJob: + properties: + type: string + extends: + - JobEmbeddingGeneration + source: + openapi: batch-openapi.json + InferenceJob: + properties: + type: + type: string + docs: >- + Denotes the job type. + + + Jobs created with the Expression Measurement API will have this field + set to `INFERENCE`. + extends: + - JobInference + source: + openapi: batch-openapi.json + CustomModelsInferenceJob: + properties: + type: string + extends: + - JobTlInference + source: + openapi: batch-openapi.json + CustomModelsTrainingJob: + properties: + type: string + extends: + - JobTraining + source: + openapi: batch-openapi.json + UnionPredictResult: InferenceSourcePredictResult + ValidationArgs: + properties: + positive_label: optional + source: + openapi: batch-openapi.json + When: + enum: + - created_before + - created_after + source: + openapi: batch-openapi.json + Window: + docs: >- + Generate predictions based on time. + + + Setting the `window` field allows for a 'sliding window' approach, where a + fixed-size window moves across the audio or video file in defined steps. + This enables continuous analysis of prosody within subsets of the file, + providing dynamic and localized insights into emotional expression. + properties: + length: + type: optional + docs: The length of the sliding window. + default: 4 + validation: + min: 0.5 + step: + type: optional + docs: The step size of the sliding window. + default: 1 + validation: + min: 0.5 + source: + openapi: batch-openapi.json diff --git a/.mock/definition/expression-measurement/stream/__package__.yml b/.mock/definition/expression-measurement/stream/__package__.yml index 5ef4fe09..4963d594 100644 --- a/.mock/definition/expression-measurement/stream/__package__.yml +++ b/.mock/definition/expression-measurement/stream/__package__.yml @@ -1,528 +1,529 @@ channel: - path: /v0/stream/models - auth: false - headers: - X-Hume-Api-Key: - type: string - name: humeApiKey - messages: - subscribe: - origin: server - body: SubscribeEvent - publish: - origin: client - body: - type: StreamModelsEndpointPayload - docs: Models endpoint payload - examples: - - messages: - - type: publish - body: {} - - type: subscribe - body: {} + path: /v0/stream/models + auth: false + display-name: Stream + headers: + X-Hume-Api-Key: + type: string + name: humeApiKey + messages: + subscribe: + origin: server + body: SubscribeEvent + publish: + origin: client + body: + type: StreamModelsEndpointPayload + docs: Models endpoint payload + examples: + - messages: + - type: publish + body: {} + - type: subscribe + body: {} types: - StreamModelPredictionsJobDetails: + StreamModelPredictionsJobDetails: + docs: > + If the job_details flag was set in the request, details about the current + streaming job will be returned in the response body. + properties: + job_id: + type: optional + docs: ID of the current streaming job. + source: + openapi: streaming-asyncapi.yml + StreamModelPredictionsBurstPredictionsItem: + properties: + time: optional + emotions: optional + source: + openapi: streaming-asyncapi.yml + StreamModelPredictionsBurst: + docs: Response for the vocal burst emotion model. + properties: + predictions: optional> + source: + openapi: streaming-asyncapi.yml + StreamModelPredictionsFacePredictionsItem: + properties: + frame: + type: optional + docs: Frame number + time: + type: optional + docs: Time in seconds when face detection occurred. + bbox: optional + prob: + type: optional + docs: The predicted probability that a detected face was actually a face. + face_id: + type: optional + docs: >- + Identifier for a face. Not that this defaults to `unknown` unless face + identification is enabled in the face model configuration. + emotions: optional + facs: optional + descriptions: optional + source: + openapi: streaming-asyncapi.yml + StreamModelPredictionsFace: + docs: Response for the facial expression emotion model. + properties: + predictions: optional> + source: + openapi: streaming-asyncapi.yml + StreamModelPredictionsFacemeshPredictionsItem: + properties: + emotions: optional + source: + openapi: streaming-asyncapi.yml + StreamModelPredictionsFacemesh: + docs: Response for the facemesh emotion model. + properties: + predictions: optional> + source: + openapi: streaming-asyncapi.yml + StreamModelPredictionsLanguagePredictionsItem: + properties: + text: + type: optional + docs: A segment of text (like a word or a sentence). + position: optional + emotions: optional + sentiment: optional + toxicity: optional + source: + openapi: streaming-asyncapi.yml + StreamModelPredictionsLanguage: + docs: Response for the language emotion model. + properties: + predictions: optional> + source: + openapi: streaming-asyncapi.yml + StreamModelPredictionsProsodyPredictionsItem: + properties: + time: optional + emotions: optional + source: + openapi: streaming-asyncapi.yml + StreamModelPredictionsProsody: + docs: Response for the speech prosody emotion model. + properties: + predictions: optional> + source: + openapi: streaming-asyncapi.yml + StreamModelPredictions: + docs: Model predictions + properties: + payload_id: + type: optional docs: > - If the job_details flag was set in the request, details about the current - streaming job will be returned in the response body. - properties: - job_id: - type: optional - docs: ID of the current streaming job. - source: - openapi: streaming-asyncapi.yml - StreamModelPredictionsBurstPredictionsItem: - properties: - time: optional - emotions: optional - source: - openapi: streaming-asyncapi.yml - StreamModelPredictionsBurst: + If a payload ID was passed in the request, the same payload ID will be + sent back in the response body. + job_details: + type: optional + docs: > + If the job_details flag was set in the request, details about the + current streaming job will be returned in the response body. + burst: + type: optional docs: Response for the vocal burst emotion model. - properties: - predictions: optional> - source: - openapi: streaming-asyncapi.yml - StreamModelPredictionsFacePredictionsItem: - properties: - frame: - type: optional - docs: Frame number - time: - type: optional - docs: Time in seconds when face detection occurred. - bbox: optional - prob: - type: optional - docs: The predicted probability that a detected face was actually a face. - face_id: - type: optional - docs: >- - Identifier for a face. Not that this defaults to `unknown` unless face - identification is enabled in the face model configuration. - emotions: optional - facs: optional - descriptions: optional - source: - openapi: streaming-asyncapi.yml - StreamModelPredictionsFace: + face: + type: optional docs: Response for the facial expression emotion model. - properties: - predictions: optional> - source: - openapi: streaming-asyncapi.yml - StreamModelPredictionsFacemeshPredictionsItem: - properties: - emotions: optional - source: - openapi: streaming-asyncapi.yml - StreamModelPredictionsFacemesh: + facemesh: + type: optional docs: Response for the facemesh emotion model. - properties: - predictions: optional> - source: - openapi: streaming-asyncapi.yml - StreamModelPredictionsLanguagePredictionsItem: - properties: - text: - type: optional - docs: A segment of text (like a word or a sentence). - position: optional - emotions: optional - sentiment: optional - toxicity: optional - source: - openapi: streaming-asyncapi.yml - StreamModelPredictionsLanguage: + language: + type: optional docs: Response for the language emotion model. - properties: - predictions: optional> - source: - openapi: streaming-asyncapi.yml - StreamModelPredictionsProsodyPredictionsItem: - properties: - time: optional - emotions: optional - source: - openapi: streaming-asyncapi.yml - StreamModelPredictionsProsody: + prosody: + type: optional docs: Response for the speech prosody emotion model. - properties: - predictions: optional> - source: - openapi: streaming-asyncapi.yml - StreamModelPredictions: - docs: Model predictions - properties: - payload_id: - type: optional - docs: > - If a payload ID was passed in the request, the same payload ID will be - sent back in the response body. - job_details: - type: optional - docs: > - If the job_details flag was set in the request, details about the - current streaming job will be returned in the response body. - burst: - type: optional - docs: Response for the vocal burst emotion model. - face: - type: optional - docs: Response for the facial expression emotion model. - facemesh: - type: optional - docs: Response for the facemesh emotion model. - language: - type: optional - docs: Response for the language emotion model. - prosody: - type: optional - docs: Response for the speech prosody emotion model. - source: - openapi: streaming-asyncapi.yml - JobDetails: + source: + openapi: streaming-asyncapi.yml + JobDetails: + docs: > + If the job_details flag was set in the request, details about the current + streaming job will be returned in the response body. + properties: + job_id: + type: optional + docs: ID of the current streaming job. + source: + openapi: streaming-asyncapi.yml + StreamErrorMessage: + docs: Error message + properties: + error: + type: optional + docs: Error message text. + code: + type: optional + docs: Unique identifier for the error. + payload_id: + type: optional docs: > - If the job_details flag was set in the request, details about the current - streaming job will be returned in the response body. - properties: - job_id: - type: optional - docs: ID of the current streaming job. - source: - openapi: streaming-asyncapi.yml - StreamErrorMessage: - docs: Error message - properties: - error: - type: optional - docs: Error message text. - code: - type: optional - docs: Unique identifier for the error. - payload_id: - type: optional - docs: > - If a payload ID was passed in the request, the same payload ID will be - sent back in the response body. - job_details: - type: optional - docs: > - If the job_details flag was set in the request, details about the - current streaming job will be returned in the response body. - source: - openapi: streaming-asyncapi.yml - StreamWarningMessageJobDetails: + If a payload ID was passed in the request, the same payload ID will be + sent back in the response body. + job_details: + type: optional docs: > - If the job_details flag was set in the request, details about the current - streaming job will be returned in the response body. - properties: - job_id: - type: optional - docs: ID of the current streaming job. - source: - openapi: streaming-asyncapi.yml - StreamWarningMessage: - docs: Warning message - properties: - warning: - type: optional - docs: Warning message text. - code: - type: optional - docs: Unique identifier for the error. - payload_id: - type: optional - docs: > - If a payload ID was passed in the request, the same payload ID will be - sent back in the response body. - job_details: - type: optional - docs: > - If the job_details flag was set in the request, details about the - current streaming job will be returned in the response body. - source: - openapi: streaming-asyncapi.yml - SubscribeEvent: - discriminated: false - union: - - type: StreamModelPredictions - docs: Model predictions - - type: StreamErrorMessage - docs: Error message - - type: StreamWarningMessage - docs: Warning message - source: - openapi: streaming-asyncapi.yml - StreamFace: + If the job_details flag was set in the request, details about the + current streaming job will be returned in the response body. + source: + openapi: streaming-asyncapi.yml + StreamWarningMessageJobDetails: + docs: > + If the job_details flag was set in the request, details about the current + streaming job will be returned in the response body. + properties: + job_id: + type: optional + docs: ID of the current streaming job. + source: + openapi: streaming-asyncapi.yml + StreamWarningMessage: + docs: Warning message + properties: + warning: + type: optional + docs: Warning message text. + code: + type: optional + docs: Unique identifier for the error. + payload_id: + type: optional docs: > - Configuration for the facial expression emotion model. + If a payload ID was passed in the request, the same payload ID will be + sent back in the response body. + job_details: + type: optional + docs: > + If the job_details flag was set in the request, details about the + current streaming job will be returned in the response body. + source: + openapi: streaming-asyncapi.yml + SubscribeEvent: + discriminated: false + union: + - type: StreamModelPredictions + docs: Model predictions + - type: StreamErrorMessage + docs: Error message + - type: StreamWarningMessage + docs: Warning message + source: + openapi: streaming-asyncapi.yml + StreamFace: + docs: > + Configuration for the facial expression emotion model. - Note: Using the `reset_stream` parameter does not have any effect on face - identification. A single face identifier cache is maintained over a full - session whether `reset_stream` is used or not. - properties: - facs: - type: optional> - docs: >- - Configuration for FACS predictions. If missing or null, no FACS - predictions will be generated. - descriptions: - type: optional> - docs: >- - Configuration for Descriptions predictions. If missing or null, no - Descriptions predictions will be generated. - identify_faces: - type: optional - docs: > - Whether to return identifiers for faces across frames. If true, unique - identifiers will be assigned to face bounding boxes to differentiate - different faces. If false, all faces will be tagged with an "unknown" - ID. - default: false - fps_pred: - type: optional - docs: > - Number of frames per second to process. Other frames will be omitted - from the response. - default: 3 - prob_threshold: - type: optional - docs: > - Face detection probability threshold. Faces detected with a - probability less than this threshold will be omitted from the - response. - default: 3 - min_face_size: - type: optional - docs: > - Minimum bounding box side length in pixels to treat as a face. Faces - detected with a bounding box side length in pixels less than this - threshold will be omitted from the response. - default: 3 - source: - openapi: streaming-asyncapi.yml - StreamLanguage: - docs: Configuration for the language emotion model. - properties: - sentiment: - type: optional> - docs: >- - Configuration for sentiment predictions. If missing or null, no - sentiment predictions will be generated. - toxicity: - type: optional> - docs: >- - Configuration for toxicity predictions. If missing or null, no - toxicity predictions will be generated. - granularity: - type: optional - docs: >- - The granularity at which to generate predictions. Values are `word`, - `sentence`, `utterance`, or `passage`. To get a single prediction for - the entire text of your streaming payload use `passage`. Default value - is `word`. - source: - openapi: streaming-asyncapi.yml - Config: + Note: Using the `reset_stream` parameter does not have any effect on face + identification. A single face identifier cache is maintained over a full + session whether `reset_stream` is used or not. + properties: + facs: + type: optional> + docs: >- + Configuration for FACS predictions. If missing or null, no FACS + predictions will be generated. + descriptions: + type: optional> + docs: >- + Configuration for Descriptions predictions. If missing or null, no + Descriptions predictions will be generated. + identify_faces: + type: optional + docs: > + Whether to return identifiers for faces across frames. If true, unique + identifiers will be assigned to face bounding boxes to differentiate + different faces. If false, all faces will be tagged with an "unknown" + ID. + default: false + fps_pred: + type: optional + docs: > + Number of frames per second to process. Other frames will be omitted + from the response. + default: 3 + prob_threshold: + type: optional + docs: > + Face detection probability threshold. Faces detected with a + probability less than this threshold will be omitted from the + response. + default: 3 + min_face_size: + type: optional docs: > - Configuration used to specify which models should be used and with what - settings. - properties: - burst: - type: optional> - docs: | - Configuration for the vocal burst emotion model. + Minimum bounding box side length in pixels to treat as a face. Faces + detected with a bounding box side length in pixels less than this + threshold will be omitted from the response. + default: 3 + source: + openapi: streaming-asyncapi.yml + StreamLanguage: + docs: Configuration for the language emotion model. + properties: + sentiment: + type: optional> + docs: >- + Configuration for sentiment predictions. If missing or null, no + sentiment predictions will be generated. + toxicity: + type: optional> + docs: >- + Configuration for toxicity predictions. If missing or null, no + toxicity predictions will be generated. + granularity: + type: optional + docs: >- + The granularity at which to generate predictions. Values are `word`, + `sentence`, `utterance`, or `passage`. To get a single prediction for + the entire text of your streaming payload use `passage`. Default value + is `word`. + source: + openapi: streaming-asyncapi.yml + Config: + docs: > + Configuration used to specify which models should be used and with what + settings. + properties: + burst: + type: optional> + docs: | + Configuration for the vocal burst emotion model. - Note: Model configuration is not currently available in streaming. + Note: Model configuration is not currently available in streaming. - Please use the default configuration by passing an empty object `{}`. - face: - type: optional - docs: > - Configuration for the facial expression emotion model. + Please use the default configuration by passing an empty object `{}`. + face: + type: optional + docs: > + Configuration for the facial expression emotion model. - Note: Using the `reset_stream` parameter does not have any effect on - face identification. A single face identifier cache is maintained over - a full session whether `reset_stream` is used or not. - facemesh: - type: optional> - docs: | - Configuration for the facemesh emotion model. + Note: Using the `reset_stream` parameter does not have any effect on + face identification. A single face identifier cache is maintained over + a full session whether `reset_stream` is used or not. + facemesh: + type: optional> + docs: | + Configuration for the facemesh emotion model. - Note: Model configuration is not currently available in streaming. + Note: Model configuration is not currently available in streaming. - Please use the default configuration by passing an empty object `{}`. - language: - type: optional - docs: Configuration for the language emotion model. - prosody: - type: optional> - docs: | - Configuration for the speech prosody emotion model. + Please use the default configuration by passing an empty object `{}`. + language: + type: optional + docs: Configuration for the language emotion model. + prosody: + type: optional> + docs: | + Configuration for the speech prosody emotion model. - Note: Model configuration is not currently available in streaming. + Note: Model configuration is not currently available in streaming. - Please use the default configuration by passing an empty object `{}`. - source: - openapi: streaming-asyncapi.yml - StreamModelsEndpointPayload: - docs: Models endpoint payload - properties: - data: - type: optional - models: - type: optional - docs: > - Configuration used to specify which models should be used and with - what settings. - stream_window_ms: - type: optional - docs: > - Length in milliseconds of streaming sliding window. + Please use the default configuration by passing an empty object `{}`. + source: + openapi: streaming-asyncapi.yml + StreamModelsEndpointPayload: + docs: Models endpoint payload + properties: + data: + type: optional + models: + type: optional + docs: > + Configuration used to specify which models should be used and with + what settings. + stream_window_ms: + type: optional + docs: > + Length in milliseconds of streaming sliding window. - Extending the length of this window will prepend media context from - past payloads into the current payload. + Extending the length of this window will prepend media context from + past payloads into the current payload. - For example, if on the first payload you send 500ms of data and on the - second payload you send an additional 500ms of data, a window of at - least 1000ms will allow the model to process all 1000ms of stream - data. + For example, if on the first payload you send 500ms of data and on the + second payload you send an additional 500ms of data, a window of at + least 1000ms will allow the model to process all 1000ms of stream + data. - A window of 600ms would append the full 500ms of the second payload to - the last 100ms of the first payload. + A window of 600ms would append the full 500ms of the second payload to + the last 100ms of the first payload. - Note: This feature is currently only supported for audio data and - audio models. For other file types and models this parameter will be - ignored. - default: 5000 - validation: - min: 500 - max: 10000 - reset_stream: - type: optional - docs: > - Whether to reset the streaming sliding window before processing the - current payload. + Note: This feature is currently only supported for audio data and + audio models. For other file types and models this parameter will be + ignored. + default: 5000 + validation: + min: 500 + max: 10000 + reset_stream: + type: optional + docs: > + Whether to reset the streaming sliding window before processing the + current payload. - If this parameter is set to `true` then past context will be deleted - before processing the current payload. + If this parameter is set to `true` then past context will be deleted + before processing the current payload. - Use reset_stream when one audio file is done being processed and you - do not want context to leak across files. - default: false - raw_text: - type: optional - docs: > - Set to `true` to enable the data parameter to be parsed as raw text - rather than base64 encoded bytes. + Use reset_stream when one audio file is done being processed and you + do not want context to leak across files. + default: false + raw_text: + type: optional + docs: > + Set to `true` to enable the data parameter to be parsed as raw text + rather than base64 encoded bytes. - This parameter is useful if you want to send text to be processed by - the language model, but it cannot be used with other file types like - audio, image, or video. - default: false - job_details: - type: optional - docs: > - Set to `true` to get details about the job. + This parameter is useful if you want to send text to be processed by + the language model, but it cannot be used with other file types like + audio, image, or video. + default: false + job_details: + type: optional + docs: > + Set to `true` to get details about the job. - This parameter can be set in the same payload as data or it can be set - without data and models configuration to get the job details between - payloads. + This parameter can be set in the same payload as data or it can be set + without data and models configuration to get the job details between + payloads. - This parameter is useful to get the unique job ID. - default: false - payload_id: - type: optional - docs: > - Pass an arbitrary string as the payload ID and get it back at the top - level of the socket response. + This parameter is useful to get the unique job ID. + default: false + payload_id: + type: optional + docs: > + Pass an arbitrary string as the payload ID and get it back at the top + level of the socket response. - This can be useful if you have multiple requests running - asynchronously and want to disambiguate responses as they are - received. - source: - openapi: streaming-asyncapi.yml - EmotionEmbeddingItem: - properties: - name: - type: optional - docs: Name of the emotion being expressed. - score: - type: optional - docs: Embedding value for the emotion being expressed. - source: - openapi: streaming-asyncapi.yml - EmotionEmbedding: - docs: A high-dimensional embedding in emotion space. - type: list - StreamBoundingBox: - docs: A bounding box around a face. - properties: - x: - type: optional - docs: x-coordinate of bounding box top left corner. - validation: - min: 0 - "y": - type: optional - docs: y-coordinate of bounding box top left corner. - validation: - min: 0 - w: - type: optional - docs: Bounding box width. - validation: - min: 0 - h: - type: optional - docs: Bounding box height. - validation: - min: 0 - source: - openapi: streaming-asyncapi.yml - TimeRange: - docs: A time range with a beginning and end, measured in seconds. - properties: - begin: - type: optional - docs: Beginning of time range in seconds. - validation: - min: 0 - end: - type: optional - docs: End of time range in seconds. - validation: - min: 0 - source: - openapi: streaming-asyncapi.yml - TextPosition: - docs: > - Position of a segment of text within a larger document, measured in - characters. Uses zero-based indexing. The beginning index is inclusive and - the end index is exclusive. - properties: - begin: - type: optional - docs: The index of the first character in the text segment, inclusive. - validation: - min: 0 - end: - type: optional - docs: The index of the last character in the text segment, exclusive. - validation: - min: 0 - source: - openapi: streaming-asyncapi.yml - SentimentItem: - properties: - name: - type: optional - docs: Level of sentiment, ranging from 1 (negative) to 9 (positive) - score: - type: optional - docs: Prediction for this level of sentiment - source: - openapi: streaming-asyncapi.yml - Sentiment: - docs: >- - Sentiment predictions returned as a distribution. This model predicts the - probability that a given text could be interpreted as having each - sentiment level from 1 (negative) to 9 (positive). + This can be useful if you have multiple requests running + asynchronously and want to disambiguate responses as they are + received. + source: + openapi: streaming-asyncapi.yml + EmotionEmbeddingItem: + properties: + name: + type: optional + docs: Name of the emotion being expressed. + score: + type: optional + docs: Embedding value for the emotion being expressed. + source: + openapi: streaming-asyncapi.yml + EmotionEmbedding: + docs: A high-dimensional embedding in emotion space. + type: list + StreamBoundingBox: + docs: A bounding box around a face. + properties: + x: + type: optional + docs: x-coordinate of bounding box top left corner. + validation: + min: 0 + 'y': + type: optional + docs: y-coordinate of bounding box top left corner. + validation: + min: 0 + w: + type: optional + docs: Bounding box width. + validation: + min: 0 + h: + type: optional + docs: Bounding box height. + validation: + min: 0 + source: + openapi: streaming-asyncapi.yml + TimeRange: + docs: A time range with a beginning and end, measured in seconds. + properties: + begin: + type: optional + docs: Beginning of time range in seconds. + validation: + min: 0 + end: + type: optional + docs: End of time range in seconds. + validation: + min: 0 + source: + openapi: streaming-asyncapi.yml + TextPosition: + docs: > + Position of a segment of text within a larger document, measured in + characters. Uses zero-based indexing. The beginning index is inclusive and + the end index is exclusive. + properties: + begin: + type: optional + docs: The index of the first character in the text segment, inclusive. + validation: + min: 0 + end: + type: optional + docs: The index of the last character in the text segment, exclusive. + validation: + min: 0 + source: + openapi: streaming-asyncapi.yml + SentimentItem: + properties: + name: + type: optional + docs: Level of sentiment, ranging from 1 (negative) to 9 (positive) + score: + type: optional + docs: Prediction for this level of sentiment + source: + openapi: streaming-asyncapi.yml + Sentiment: + docs: >- + Sentiment predictions returned as a distribution. This model predicts the + probability that a given text could be interpreted as having each + sentiment level from 1 (negative) to 9 (positive). - Compared to returning one estimate of sentiment, this enables a more - nuanced analysis of a text's meaning. For example, a text with very - neutral sentiment would have an average rating of 5. But also a text that - could be interpreted as having very positive sentiment or very negative - sentiment would also have an average rating of 5. The average sentiment is - less informative than the distribution over sentiment, so this API returns - a value for each sentiment level. - type: list - ToxicityItem: - properties: - name: - type: optional - docs: Category of toxicity. - score: - type: optional - docs: Prediction for this category of toxicity - source: - openapi: streaming-asyncapi.yml - Toxicity: - docs: >- - Toxicity predictions returned as probabilities that the text can be - classified into the following categories: toxic, severe_toxic, obscene, - threat, insult, and identity_hate. - type: list + Compared to returning one estimate of sentiment, this enables a more + nuanced analysis of a text's meaning. For example, a text with very + neutral sentiment would have an average rating of 5. But also a text that + could be interpreted as having very positive sentiment or very negative + sentiment would also have an average rating of 5. The average sentiment is + less informative than the distribution over sentiment, so this API returns + a value for each sentiment level. + type: list + ToxicityItem: + properties: + name: + type: optional + docs: Category of toxicity. + score: + type: optional + docs: Prediction for this category of toxicity + source: + openapi: streaming-asyncapi.yml + Toxicity: + docs: >- + Toxicity predictions returned as probabilities that the text can be + classified into the following categories: toxic, severe_toxic, obscene, + threat, insult, and identity_hate. + type: list diff --git a/.mock/fern.config.json b/.mock/fern.config.json index b84e5700..b6f702af 100644 --- a/.mock/fern.config.json +++ b/.mock/fern.config.json @@ -1,4 +1,4 @@ { - "organization": "hume", - "version": "0.43.5" -} + "organization" : "hume", + "version" : "0.45.0-rc19" +} \ No newline at end of file diff --git a/package.json b/package.json index 28dc16f5..1d5a35b1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "hume", - "version": "0.9.2", + "version": "0.9.3", "private": false, "repository": "https://github.com/HumeAI/hume-typescript-sdk", "main": "./index.js", diff --git a/reference.md b/reference.md index 8d764bb1..69f3176c 100644 --- a/reference.md +++ b/reference.md @@ -1,8 +1,8 @@ # Reference -## ExpressionMeasurement Batch +## EmpathicVoice Tools -
client.expressionMeasurement.batch.listJobs({ ...params }) -> Hume.UnionJob[] +
client.empathicVoice.tools.listTools({ ...params }) -> core.Page
@@ -14,7 +14,9 @@
-Sort and filter jobs. +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.
@@ -30,7 +32,10 @@ Sort and filter jobs.
```typescript -await client.expressionMeasurement.batch.listJobs(); +await client.empathicVoice.tools.listTools({ + pageNumber: 0, + pageSize: 2, +}); ```
@@ -46,7 +51,7 @@ await client.expressionMeasurement.batch.listJobs();
-**request:** `Hume.expressionMeasurement.batch.BatchListJobsRequest` +**request:** `Hume.empathicVoice.ToolsListToolsRequest`
@@ -54,7 +59,7 @@ await client.expressionMeasurement.batch.listJobs();
-**requestOptions:** `Batch.RequestOptions` +**requestOptions:** `Tools.RequestOptions`
@@ -65,7 +70,7 @@ await client.expressionMeasurement.batch.listJobs();
-
client.expressionMeasurement.batch.startInferenceJob({ ...params }) -> Hume.JobId +
client.empathicVoice.tools.createTool({ ...params }) -> Hume.ReturnUserDefinedTool | undefined
@@ -77,7 +82,9 @@ await client.expressionMeasurement.batch.listJobs();
-Start a new measurement inference job. +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.
@@ -93,9 +100,13 @@ 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.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.", }); ``` @@ -112,7 +123,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
-**request:** `Hume.InferenceBaseRequest` +**request:** `Hume.empathicVoice.PostedUserDefinedTool`
@@ -120,7 +131,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
-**requestOptions:** `Batch.RequestOptions` +**requestOptions:** `Tools.RequestOptions`
@@ -131,7 +142,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
-
client.expressionMeasurement.batch.getJobDetails(id) -> Hume.UnionJob +
client.empathicVoice.tools.listToolVersions(id, { ...params }) -> Hume.ReturnPagedUserDefinedTools
@@ -143,7 +154,9 @@ await client.expressionMeasurement.batch.startInferenceJob({
-Get the request details and state of a given job. +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.
@@ -159,7 +172,7 @@ Get the request details and state of a given job.
```typescript -await client.expressionMeasurement.batch.getJobDetails("job_id"); +await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea"); ```
@@ -175,7 +188,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
-**id:** `string` — The unique identifier for the job. +**id:** `string` — Identifier for a Tool. Formatted as a UUID.
@@ -183,7 +196,15 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
-**requestOptions:** `Batch.RequestOptions` +**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest` + +
+
+ +
+
+ +**requestOptions:** `Tools.RequestOptions`
@@ -194,7 +215,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
-
client.expressionMeasurement.batch.getJobPredictions(id) -> Hume.UnionPredictResult[] +
client.empathicVoice.tools.createToolVersion(id, { ...params }) -> Hume.ReturnUserDefinedTool | undefined
@@ -206,7 +227,9 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
-Get the JSON predictions of a completed inference job. +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.
@@ -222,7 +245,13 @@ Get the JSON predictions of a completed inference job.
```typescript -await client.expressionMeasurement.batch.getJobPredictions("job_id"); +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.", +}); ```
@@ -238,7 +267,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
-**id:** `string` — The unique identifier for the job. +**id:** `string` — Identifier for a Tool. Formatted as a UUID.
@@ -246,7 +275,15 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
-**requestOptions:** `Batch.RequestOptions` +**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion` + +
+
+ +
+
+ +**requestOptions:** `Tools.RequestOptions`
@@ -257,7 +294,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
-
client.expressionMeasurement.batch.getJobArtifacts(id) -> stream.Readable +
client.empathicVoice.tools.deleteTool(id) -> void
@@ -269,7 +306,9 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
-Get the artifacts ZIP of a completed inference job. +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.
@@ -285,7 +324,7 @@ Get the artifacts ZIP of a completed inference job.
```typescript -await client.expressionMeasurement.batch.getJobArtifacts("string"); +await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea"); ```
@@ -301,7 +340,7 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
-**id:** `string` — The unique identifier for the job. +**id:** `string` — Identifier for a Tool. Formatted as a UUID.
@@ -309,7 +348,7 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
-**requestOptions:** `Batch.RequestOptions` +**requestOptions:** `Tools.RequestOptions`
@@ -320,7 +359,7 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
-
client.expressionMeasurement.batch.startInferenceJobFromLocalFile(file, { ...params }) -> Hume.JobId +
client.empathicVoice.tools.updateToolName(id, { ...params }) -> string
@@ -332,7 +371,9 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
-Start a new batch inference job. +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.
@@ -348,10 +389,9 @@ Start a new batch inference job.
```typescript -await client.expressionMeasurement.batch.startInferenceJobFromLocalFile( - [fs.createReadStream("/path/to/your/file")], - {} -); +await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", { + name: "get_current_temperature", +}); ```
@@ -367,7 +407,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
-**file:** `File[] | fs.ReadStream[] | Blob[]` +**id:** `string` — Identifier for a Tool. Formatted as a UUID.
@@ -375,7 +415,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
-**request:** `Hume.expressionMeasurement.batch.BatchStartInferenceJobFromLocalFileRequest` +**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
@@ -383,7 +423,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
-**requestOptions:** `Batch.RequestOptions` +**requestOptions:** `Tools.RequestOptions`
@@ -394,9 +434,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
-## EmpathicVoice Tools - -
client.empathicVoice.tools.listTools({ ...params }) -> core.Page +
client.empathicVoice.tools.getToolVersion(id, version) -> Hume.ReturnUserDefinedTool | undefined
@@ -408,7 +446,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
-Fetches a paginated list of **Tools**. +Fetches a specified version 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. @@ -426,10 +464,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.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1); ```
@@ -445,7 +480,21 @@ await client.empathicVoice.tools.listTools({
-**request:** `Hume.empathicVoice.ToolsListToolsRequest` +**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.
@@ -464,7 +513,7 @@ await client.empathicVoice.tools.listTools({
-
client.empathicVoice.tools.createTool({ ...params }) -> Hume.ReturnUserDefinedTool | undefined +
client.empathicVoice.tools.deleteToolVersion(id, version) -> void
@@ -476,7 +525,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). +Deletes a specified version 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. @@ -494,14 +543,7 @@ 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.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1); ```
@@ -517,7 +559,21 @@ await client.empathicVoice.tools.createTool({
-**request:** `Hume.empathicVoice.PostedUserDefinedTool` +**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.
@@ -536,7 +592,7 @@ await client.empathicVoice.tools.createTool({
-
client.empathicVoice.tools.listToolVersions(id, { ...params }) -> Hume.ReturnPagedUserDefinedTools +
client.empathicVoice.tools.updateToolDescription(id, version, { ...params }) -> Hume.ReturnUserDefinedTool | undefined
@@ -548,7 +604,7 @@ await client.empathicVoice.tools.createTool({
-Fetches a list of a **Tool's** versions. +Updates the description of a specified **Tool** version. 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. @@ -566,7 +622,10 @@ 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.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.", +}); ```
@@ -590,7 +649,21 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
-**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest` +**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`
@@ -609,7 +682,9 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
-
client.empathicVoice.tools.createToolVersion(id, { ...params }) -> Hume.ReturnUserDefinedTool | undefined +## EmpathicVoice Prompts + +
client.empathicVoice.prompts.listPrompts({ ...params }) -> core.Page
@@ -621,9 +696,9 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
-Updates a **Tool** by creating a new version of the **Tool**. +Fetches a paginated list of **Prompts**. -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. +See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
@@ -639,12 +714,9 @@ 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.empathicVoice.prompts.listPrompts({ + pageNumber: 0, + pageSize: 2, }); ``` @@ -661,15 +733,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` +**request:** `Hume.empathicVoice.PromptsListPromptsRequest`
@@ -677,7 +741,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
-**requestOptions:** `Tools.RequestOptions` +**requestOptions:** `Prompts.RequestOptions`
@@ -688,7 +752,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
-
client.empathicVoice.tools.deleteTool(id) -> void +
client.empathicVoice.prompts.createPrompt({ ...params }) -> Hume.ReturnPrompt | undefined
@@ -700,9 +764,9 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
-Deletes a **Tool** and its versions. +Creates a **Prompt** 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. +See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
@@ -718,7 +782,10 @@ 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.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.", +}); ```
@@ -734,7 +801,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
-**id:** `string` — Identifier for a Tool. Formatted as a UUID. +**request:** `Hume.empathicVoice.PostedPrompt`
@@ -742,7 +809,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
-**requestOptions:** `Tools.RequestOptions` +**requestOptions:** `Prompts.RequestOptions`
@@ -753,7 +820,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
-
client.empathicVoice.tools.updateToolName(id, { ...params }) -> string +
client.empathicVoice.prompts.listPromptVersions(id, { ...params }) -> Hume.ReturnPagedPrompts
@@ -765,9 +832,9 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
-Updates the name of a **Tool**. +Fetches a list of a **Prompt'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. +See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
@@ -783,9 +850,7 @@ 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.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5"); ```
@@ -801,7 +866,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
-**id:** `string` — Identifier for a Tool. Formatted as a UUID. +**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
@@ -809,7 +874,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
-**request:** `Hume.empathicVoice.PostedUserDefinedToolName` +**request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
@@ -817,7 +882,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
-**requestOptions:** `Tools.RequestOptions` +**requestOptions:** `Prompts.RequestOptions`
@@ -828,7 +893,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
-
client.empathicVoice.tools.getToolVersion(id, version) -> Hume.ReturnUserDefinedTool | undefined +
client.empathicVoice.prompts.createPromptVerison(id, { ...params }) -> Hume.ReturnPrompt | undefined
@@ -840,9 +905,9 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
-Fetches a specified version of a **Tool**. +Updates a **Prompt** by creating a new version of the **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. +See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
@@ -858,7 +923,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.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.", +}); ```
@@ -874,7 +942,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
-**id:** `string` — Identifier for a Tool. Formatted as a UUID. +**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
@@ -882,13 +950,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
-**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.PostedPromptVersion`
@@ -896,7 +958,7 @@ Version numbers are integer values representing different iterations of the Tool
-**requestOptions:** `Tools.RequestOptions` +**requestOptions:** `Prompts.RequestOptions`
@@ -907,7 +969,7 @@ Version numbers are integer values representing different iterations of the Tool
-
client.empathicVoice.tools.deleteToolVersion(id, version) -> void +
client.empathicVoice.prompts.deletePrompt(id) -> void
@@ -919,9 +981,9 @@ Version numbers are integer values representing different iterations of the Tool
-Deletes a specified version of a **Tool**. +Deletes a **Prompt** 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. +See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
@@ -937,7 +999,7 @@ 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.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5"); ```
@@ -953,21 +1015,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. +**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
@@ -975,7 +1023,7 @@ Version numbers are integer values representing different iterations of the Tool
-**requestOptions:** `Tools.RequestOptions` +**requestOptions:** `Prompts.RequestOptions`
@@ -986,7 +1034,7 @@ Version numbers are integer values representing different iterations of the Tool
-
client.empathicVoice.tools.updateToolDescription(id, version, { ...params }) -> Hume.ReturnUserDefinedTool | undefined +
client.empathicVoice.prompts.updatePromptName(id, { ...params }) -> string
@@ -998,9 +1046,9 @@ Version numbers are integer values representing different iterations of the Tool
-Updates the description of a specified **Tool** version. +Updates the name of a **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. +See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
@@ -1016,9 +1064,8 @@ 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.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", { + name: "Updated Weather Assistant Prompt Name", }); ``` @@ -1035,21 +1082,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
-**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. +**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
@@ -1057,7 +1090,7 @@ Version numbers are integer values representing different iterations of the Tool
-**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription` +**request:** `Hume.empathicVoice.PostedPromptName`
@@ -1065,7 +1098,7 @@ Version numbers are integer values representing different iterations of the Tool
-**requestOptions:** `Tools.RequestOptions` +**requestOptions:** `Prompts.RequestOptions`
@@ -1076,9 +1109,7 @@ Version numbers are integer values representing different iterations of the Tool
-## EmpathicVoice Prompts - -
client.empathicVoice.prompts.listPrompts({ ...params }) -> core.Page +
client.empathicVoice.prompts.getPromptVersion(id, version) -> Hume.ReturnPrompt | undefined
@@ -1090,7 +1121,7 @@ Version numbers are integer values representing different iterations of the Tool
-Fetches a paginated list of **Prompts**. +Fetches a specified version of a **Prompt**. See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. @@ -1108,10 +1139,7 @@ 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.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0); ```
@@ -1127,7 +1155,21 @@ await client.empathicVoice.prompts.listPrompts({
-**request:** `Hume.empathicVoice.PromptsListPromptsRequest` +**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.
@@ -1146,7 +1188,7 @@ await client.empathicVoice.prompts.listPrompts({
-
client.empathicVoice.prompts.createPrompt({ ...params }) -> Hume.ReturnPrompt | undefined +
client.empathicVoice.prompts.deletePromptVersion(id, version) -> void
@@ -1158,7 +1200,7 @@ 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 specified version of a **Prompt**. See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. @@ -1176,10 +1218,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.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1); ```
@@ -1195,7 +1234,21 @@ await client.empathicVoice.prompts.createPrompt({
-**request:** `Hume.empathicVoice.PostedPrompt` +**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.
@@ -1214,7 +1267,7 @@ await client.empathicVoice.prompts.createPrompt({
-
client.empathicVoice.prompts.listPromptVersions(id, { ...params }) -> Hume.ReturnPagedPrompts +
client.empathicVoice.prompts.updatePromptDescription(id, version, { ...params }) -> Hume.ReturnPrompt | undefined
@@ -1226,7 +1279,7 @@ await client.empathicVoice.prompts.createPrompt({
-Fetches a list of a **Prompt's** versions. +Updates the description of a **Prompt**. See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. @@ -1244,7 +1297,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.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, { + versionDescription: "This is an updated version_description.", +}); ```
@@ -1268,7 +1323,21 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
-**request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest` +**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`
@@ -1287,7 +1356,9 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
-
client.empathicVoice.prompts.createPromptVerison(id, { ...params }) -> Hume.ReturnPrompt | undefined +## EmpathicVoice CustomVoices + +
client.empathicVoice.customVoices.listCustomVoices({ ...params }) -> Hume.ReturnPagedCustomVoices
@@ -1299,9 +1370,9 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
-Updates a **Prompt** by creating a new version of the **Prompt**. +Fetches a paginated list of **Custom Voices**. -See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. +Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
@@ -1317,10 +1388,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.customVoices.listCustomVoices(); ```
@@ -1336,15 +1404,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
-**id:** `string` — Identifier for a Prompt. Formatted as a UUID. - -
-
- -
-
- -**request:** `Hume.empathicVoice.PostedPromptVersion` +**request:** `Hume.empathicVoice.CustomVoicesListCustomVoicesRequest`
@@ -1352,7 +1412,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
-**requestOptions:** `Prompts.RequestOptions` +**requestOptions:** `CustomVoices.RequestOptions`
@@ -1363,7 +1423,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
-
client.empathicVoice.prompts.deletePrompt(id) -> void +
client.empathicVoice.customVoices.createCustomVoice({ ...params }) -> Hume.ReturnCustomVoice
@@ -1375,9 +1435,9 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
-Deletes a **Prompt** and its versions. +Creates a **Custom Voice** 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. +Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
@@ -1393,7 +1453,11 @@ 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.customVoices.createCustomVoice({ + name: "name", + baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito, + parameterModel: "20241004-11parameter", +}); ```
@@ -1409,7 +1473,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
-**id:** `string` — Identifier for a Prompt. Formatted as a UUID. +**request:** `Hume.PostedCustomVoice`
@@ -1417,7 +1481,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
-**requestOptions:** `Prompts.RequestOptions` +**requestOptions:** `CustomVoices.RequestOptions`
@@ -1428,7 +1492,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
-
client.empathicVoice.prompts.updatePromptName(id, { ...params }) -> string +
client.empathicVoice.customVoices.getCustomVoice(id) -> Hume.ReturnCustomVoice
@@ -1440,9 +1504,9 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
-Updates the name of a **Prompt**. +Fetches a specific **Custom Voice** by ID. -See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. +Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
@@ -1458,9 +1522,7 @@ 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.customVoices.getCustomVoice("id"); ```
@@ -1476,15 +1538,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
-**id:** `string` — Identifier for a Prompt. Formatted as a UUID. - -
-
- -
-
- -**request:** `Hume.empathicVoice.PostedPromptName` +**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
@@ -1492,7 +1546,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
-**requestOptions:** `Prompts.RequestOptions` +**requestOptions:** `CustomVoices.RequestOptions`
@@ -1503,7 +1557,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
-
client.empathicVoice.prompts.getPromptVersion(id, version) -> Hume.ReturnPrompt | undefined +
client.empathicVoice.customVoices.createCustomVoiceVersion(id, { ...params }) -> Hume.ReturnCustomVoice
@@ -1515,9 +1569,9 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
-Fetches a specified version of a **Prompt**. +Updates a **Custom Voice** by creating a new version of the **Custom Voice**. -See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. +Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
@@ -1533,7 +1587,11 @@ 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.customVoices.createCustomVoiceVersion("id", { + name: "name", + baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito, + parameterModel: "20241004-11parameter", +}); ```
@@ -1549,7 +1607,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
-**id:** `string` — Identifier for a Prompt. Formatted as a UUID. +**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
@@ -1557,13 +1615,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
-**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.PostedCustomVoice`
@@ -1571,7 +1623,7 @@ Version numbers are integer values representing different iterations of the Prom
-**requestOptions:** `Prompts.RequestOptions` +**requestOptions:** `CustomVoices.RequestOptions`
@@ -1582,7 +1634,7 @@ Version numbers are integer values representing different iterations of the Prom
-
client.empathicVoice.prompts.deletePromptVersion(id, version) -> void +
client.empathicVoice.customVoices.deleteCustomVoice(id) -> void
@@ -1594,9 +1646,9 @@ Version numbers are integer values representing different iterations of the Prom
-Deletes a specified version of a **Prompt**. +Deletes a **Custom Voice** and its versions. -See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. +Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
@@ -1612,7 +1664,7 @@ 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.customVoices.deleteCustomVoice("id"); ```
@@ -1628,7 +1680,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
-**id:** `string` — Identifier for a Prompt. Formatted as a UUID. +**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
@@ -1636,21 +1688,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
-**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` +**requestOptions:** `CustomVoices.RequestOptions`
@@ -1661,7 +1699,9 @@ Version numbers are integer values representing different iterations of the Prom
-
client.empathicVoice.prompts.updatePromptDescription(id, version, { ...params }) -> Hume.ReturnPrompt | undefined +## EmpathicVoice Configs + +
client.empathicVoice.configs.listConfigs({ ...params }) -> Hume.ReturnPagedConfigs
@@ -1673,9 +1713,9 @@ Version numbers are integer values representing different iterations of the Prom
-Updates the description of a **Prompt**. +Fetches a paginated list of **Configs**. -See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt. +For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
@@ -1691,8 +1731,9 @@ 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.configs.listConfigs({ + pageNumber: 0, + pageSize: 1, }); ``` @@ -1709,29 +1750,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
-**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.PostedPromptVersionDescription` +**request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
@@ -1739,7 +1758,7 @@ Version numbers are integer values representing different iterations of the Prom
-**requestOptions:** `Prompts.RequestOptions` +**requestOptions:** `Configs.RequestOptions`
@@ -1750,9 +1769,7 @@ Version numbers are integer values representing different iterations of the Prom
-## EmpathicVoice CustomVoices - -
client.empathicVoice.customVoices.listCustomVoices({ ...params }) -> Hume.ReturnPagedCustomVoices +
client.empathicVoice.configs.createConfig({ ...params }) -> Hume.ReturnConfig
@@ -1764,9 +1781,9 @@ Version numbers are integer values representing different iterations of the Prom
-Fetches a paginated list of **Custom Voices**. +Creates a **Config** which can be applied to EVI. -Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice. +For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
@@ -1782,7 +1799,37 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
```typescript -await client.empathicVoice.customVoices.listCustomVoices(); +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: "", + }, + }, +}); ```
@@ -1798,7 +1845,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
-**request:** `Hume.empathicVoice.CustomVoicesListCustomVoicesRequest` +**request:** `Hume.empathicVoice.PostedConfig`
@@ -1806,7 +1853,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
-**requestOptions:** `CustomVoices.RequestOptions` +**requestOptions:** `Configs.RequestOptions`
@@ -1817,7 +1864,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
-
client.empathicVoice.customVoices.createCustomVoice({ ...params }) -> Hume.ReturnCustomVoice +
client.empathicVoice.configs.listConfigVersions(id, { ...params }) -> Hume.ReturnPagedConfigs
@@ -1829,9 +1876,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). +Fetches a list of a **Config's** versions. -Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice. +For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
@@ -1847,11 +1894,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.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3"); ```
@@ -1867,7 +1910,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
-**request:** `Hume.PostedCustomVoice` +**id:** `string` — Identifier for a Config. Formatted as a UUID.
@@ -1875,7 +1918,15 @@ await client.empathicVoice.customVoices.createCustomVoice({
-**requestOptions:** `CustomVoices.RequestOptions` +**request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest` + +
+
+ +
+
+ +**requestOptions:** `Configs.RequestOptions`
@@ -1886,7 +1937,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
-
client.empathicVoice.customVoices.getCustomVoice(id) -> Hume.ReturnCustomVoice +
client.empathicVoice.configs.createConfigVersion(id, { ...params }) -> Hume.ReturnConfig
@@ -1898,9 +1949,9 @@ await client.empathicVoice.customVoices.createCustomVoice({
-Fetches a specific **Custom Voice** by ID. +Updates a **Config** by creating a new version of the **Config**. -Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice. +For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
@@ -1916,7 +1967,40 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
```typescript -await client.empathicVoice.customVoices.getCustomVoice("id"); +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: "", + }, + }, +}); ```
@@ -1932,7 +2016,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
-**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID. +**id:** `string` — Identifier for a Config. Formatted as a UUID.
@@ -1940,7 +2024,15 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
-**requestOptions:** `CustomVoices.RequestOptions` +**request:** `Hume.empathicVoice.PostedConfigVersion` + +
+
+ +
+
+ +**requestOptions:** `Configs.RequestOptions`
@@ -1951,7 +2043,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
-
client.empathicVoice.customVoices.createCustomVoiceVersion(id, { ...params }) -> Hume.ReturnCustomVoice +
client.empathicVoice.configs.deleteConfig(id) -> void
@@ -1963,9 +2055,9 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
-Updates a **Custom Voice** by creating a new version of the **Custom Voice**. +Deletes a **Config** and its versions. -Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice. +For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
@@ -1981,11 +2073,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.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3"); ```
@@ -2001,15 +2089,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
-**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID. - -
-
- -
-
- -**request:** `Hume.PostedCustomVoice` +**id:** `string` — Identifier for a Config. Formatted as a UUID.
@@ -2017,7 +2097,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
-**requestOptions:** `CustomVoices.RequestOptions` +**requestOptions:** `Configs.RequestOptions`
@@ -2028,7 +2108,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
-
client.empathicVoice.customVoices.deleteCustomVoice(id) -> void +
client.empathicVoice.configs.updateConfigName(id, { ...params }) -> string
@@ -2040,9 +2120,9 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
-Deletes a **Custom Voice** and its versions. +Updates the name of a **Config**. -Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice. +For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
@@ -2058,7 +2138,9 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
```typescript -await client.empathicVoice.customVoices.deleteCustomVoice("id"); +await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", { + name: "Updated Weather Assistant Config Name", +}); ```
@@ -2074,7 +2156,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
-**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID. +**id:** `string` — Identifier for a Config. Formatted as a UUID.
@@ -2082,7 +2164,15 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
-**requestOptions:** `CustomVoices.RequestOptions` +**request:** `Hume.empathicVoice.PostedConfigName` + +
+
+ +
+
+ +**requestOptions:** `Configs.RequestOptions`
@@ -2093,7 +2183,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
-
client.empathicVoice.customVoices.updateCustomVoiceName(id, { ...params }) -> string +
client.empathicVoice.configs.getConfigVersion(id, version) -> Hume.ReturnConfig
@@ -2105,9 +2195,9 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
-Updates the name of a **Custom Voice**. +Fetches a specified version of a **Config**. -Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice. +For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
@@ -2123,9 +2213,7 @@ 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.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1); ```
@@ -2141,7 +2229,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
-**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID. +**id:** `string` — Identifier for a Config. Formatted as a UUID.
@@ -2149,7 +2237,13 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
-**request:** `Hume.empathicVoice.PostedCustomVoiceName` +**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.
@@ -2157,7 +2251,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
-**requestOptions:** `CustomVoices.RequestOptions` +**requestOptions:** `Configs.RequestOptions`
@@ -2168,9 +2262,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
-## EmpathicVoice Configs - -
client.empathicVoice.configs.listConfigs({ ...params }) -> Hume.ReturnPagedConfigs +
client.empathicVoice.configs.deleteConfigVersion(id, version) -> void
@@ -2182,7 +2274,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
-Fetches a paginated list of **Configs**. +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). @@ -2200,10 +2292,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.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1); ```
@@ -2219,7 +2308,21 @@ await client.empathicVoice.configs.listConfigs({
-**request:** `Hume.empathicVoice.ConfigsListConfigsRequest` +**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.
@@ -2238,7 +2341,7 @@ await client.empathicVoice.configs.listConfigs({
-
client.empathicVoice.configs.createConfig({ ...params }) -> Hume.ReturnConfig +
client.empathicVoice.configs.updateConfigDescription(id, version, { ...params }) -> Hume.ReturnConfig
@@ -2250,7 +2353,7 @@ await client.empathicVoice.configs.listConfigs({
-Creates a **Config** which can be applied to EVI. +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). @@ -2268,36 +2371,8 @@ 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.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, { + versionDescription: "This is an updated version_description.", }); ``` @@ -2314,7 +2389,29 @@ await client.empathicVoice.configs.createConfig({
-**request:** `Hume.empathicVoice.PostedConfig` +**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.PostedConfigVersionDescription`
@@ -2333,7 +2430,9 @@ await client.empathicVoice.configs.createConfig({
-
client.empathicVoice.configs.listConfigVersions(id, { ...params }) -> Hume.ReturnPagedConfigs +## EmpathicVoice Chats + +
client.empathicVoice.chats.listChats({ ...params }) -> core.Page
@@ -2345,9 +2444,7 @@ await client.empathicVoice.configs.createConfig({
-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). +Fetches a paginated list of **Chats**.
@@ -2363,7 +2460,11 @@ 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.chats.listChats({ + pageNumber: 0, + pageSize: 1, + ascendingOrder: true, +}); ```
@@ -2379,15 +2480,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` +**request:** `Hume.empathicVoice.ChatsListChatsRequest`
@@ -2395,7 +2488,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
-**requestOptions:** `Configs.RequestOptions` +**requestOptions:** `Chats.RequestOptions`
@@ -2406,7 +2499,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
-
client.empathicVoice.configs.createConfigVersion(id, { ...params }) -> Hume.ReturnConfig +
client.empathicVoice.chats.listChatEvents(id, { ...params }) -> core.Page
@@ -2418,57 +2511,26 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
-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). +Fetches a paginated list of **Chat** events.
-
-
-
- -#### 🔌 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 + +
+
+ +
+
+ +```typescript +await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", { + pageNumber: 0, + pageSize: 3, + ascendingOrder: true, }); ``` @@ -2485,7 +2547,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 Chat. Formatted as a UUID.
@@ -2493,7 +2555,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
-**request:** `Hume.empathicVoice.PostedConfigVersion` +**request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
@@ -2501,7 +2563,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
-**requestOptions:** `Configs.RequestOptions` +**requestOptions:** `Chats.RequestOptions`
@@ -2512,27 +2574,10 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
-
client.empathicVoice.configs.deleteConfig(id) -> void -
-
- -#### 📝 Description - -
-
- +
client.empathicVoice.chats.getAudio(id) -> Hume.ReturnChatPagedEvents
-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). - -
-
-
-
- #### 🔌 Usage
@@ -2542,7 +2587,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.chats.getAudio("id"); ```
@@ -2558,7 +2603,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 chat. Formatted as a UUID.
@@ -2566,7 +2611,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
-**requestOptions:** `Configs.RequestOptions` +**requestOptions:** `Chats.RequestOptions`
@@ -2577,7 +2622,9 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
-
client.empathicVoice.configs.updateConfigName(id, { ...params }) -> string +## EmpathicVoice ChatGroups + +
client.empathicVoice.chatGroups.listChatGroups({ ...params }) -> Hume.ReturnPagedChatGroups
@@ -2589,9 +2636,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
-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). +Fetches a paginated list of **Chat Groups**.
@@ -2607,8 +2652,11 @@ 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.chatGroups.listChatGroups({ + pageNumber: 0, + pageSize: 1, + ascendingOrder: true, + configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3", }); ``` @@ -2625,15 +2673,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
-**id:** `string` — Identifier for a Config. Formatted as a UUID. - -
-
- -
-
- -**request:** `Hume.empathicVoice.PostedConfigName` +**request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
@@ -2641,7 +2681,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
-**requestOptions:** `Configs.RequestOptions` +**requestOptions:** `ChatGroups.RequestOptions`
@@ -2652,7 +2692,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
-
client.empathicVoice.configs.getConfigVersion(id, version) -> Hume.ReturnConfig +
client.empathicVoice.chatGroups.getChatGroup(id, { ...params }) -> Hume.ReturnChatGroupPagedChats
@@ -2664,9 +2704,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
-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). +Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
@@ -2682,7 +2720,11 @@ 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.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", { + pageNumber: 0, + pageSize: 1, + ascendingOrder: true, +}); ```
@@ -2698,7 +2740,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
-**id:** `string` — Identifier for a Config. Formatted as a UUID. +**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
@@ -2706,13 +2748,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
-**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.ChatGroupsGetChatGroupRequest`
@@ -2720,7 +2756,7 @@ Version numbers are integer values representing different iterations of the Conf
-**requestOptions:** `Configs.RequestOptions` +**requestOptions:** `ChatGroups.RequestOptions`
@@ -2731,7 +2767,7 @@ Version numbers are integer values representing different iterations of the Conf
-
client.empathicVoice.configs.deleteConfigVersion(id, version) -> void +
client.empathicVoice.chatGroups.listChatGroupEvents(id, { ...params }) -> Hume.ReturnChatGroupPagedEvents
@@ -2743,9 +2779,7 @@ Version numbers are integer values representing different iterations of the Conf
-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). +Fetches a paginated list of **Chat** events associated with a **Chat Group**.
@@ -2761,7 +2795,11 @@ 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.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", { + pageNumber: 0, + pageSize: 3, + ascendingOrder: true, +}); ```
@@ -2777,7 +2815,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
-**id:** `string` — Identifier for a Config. Formatted as a UUID. +**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
@@ -2785,13 +2823,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
-**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.ChatGroupsListChatGroupEventsRequest`
@@ -2799,7 +2831,7 @@ Version numbers are integer values representing different iterations of the Conf
-**requestOptions:** `Configs.RequestOptions` +**requestOptions:** `ChatGroups.RequestOptions`
@@ -2810,27 +2842,10 @@ Version numbers are integer values representing different iterations of the Conf
-
client.empathicVoice.configs.updateConfigDescription(id, version, { ...params }) -> Hume.ReturnConfig -
-
- -#### 📝 Description - -
-
- +
client.empathicVoice.chatGroups.getAudio(id, { ...params }) -> Hume.ReturnChatPagedEvents
-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). - -
-
-
-
- #### 🔌 Usage
@@ -2840,9 +2855,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.chatGroups.getAudio("id"); ```
@@ -2858,21 +2871,7 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
-**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. +**id:** `string` — Identifier for a chat. Formatted as a UUID.
@@ -2880,7 +2879,7 @@ Version numbers are integer values representing different iterations of the Conf
-**request:** `Hume.empathicVoice.PostedConfigVersionDescription` +**request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
@@ -2888,7 +2887,7 @@ Version numbers are integer values representing different iterations of the Conf
-**requestOptions:** `Configs.RequestOptions` +**requestOptions:** `ChatGroups.RequestOptions`
@@ -2899,9 +2898,9 @@ Version numbers are integer values representing different iterations of the Conf
-## EmpathicVoice Chats +## ExpressionMeasurement Batch -
client.empathicVoice.chats.listChats({ ...params }) -> core.Page +
client.expressionMeasurement.batch.listJobs({ ...params }) -> Hume.UnionJob[]
@@ -2913,7 +2912,7 @@ Version numbers are integer values representing different iterations of the Conf
-Fetches a paginated list of **Chats**. +Sort and filter jobs.
@@ -2929,11 +2928,7 @@ Fetches a paginated list of **Chats**.
```typescript -await client.empathicVoice.chats.listChats({ - pageNumber: 0, - pageSize: 1, - ascendingOrder: true, -}); +await client.expressionMeasurement.batch.listJobs(); ```
@@ -2949,7 +2944,7 @@ await client.empathicVoice.chats.listChats({
-**request:** `Hume.empathicVoice.ChatsListChatsRequest` +**request:** `Hume.expressionMeasurement.batch.BatchListJobsRequest`
@@ -2957,7 +2952,7 @@ await client.empathicVoice.chats.listChats({
-**requestOptions:** `Chats.RequestOptions` +**requestOptions:** `Batch.RequestOptions`
@@ -2968,7 +2963,7 @@ await client.empathicVoice.chats.listChats({
-
client.empathicVoice.chats.listChatEvents(id, { ...params }) -> core.Page +
client.expressionMeasurement.batch.startInferenceJob({ ...params }) -> Hume.JobId
@@ -2980,7 +2975,7 @@ await client.empathicVoice.chats.listChats({
-Fetches a paginated list of **Chat** events. +Start a new measurement inference job.
@@ -2996,10 +2991,9 @@ 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.expressionMeasurement.batch.startInferenceJob({ + urls: ["https://hume-tutorials.s3.amazonaws.com/faces.zip"], + notify: true, }); ``` @@ -3016,15 +3010,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` +**request:** `Hume.InferenceBaseRequest`
@@ -3032,7 +3018,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
-**requestOptions:** `Chats.RequestOptions` +**requestOptions:** `Batch.RequestOptions`
@@ -3043,9 +3029,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
-## EmpathicVoice ChatGroups - -
client.empathicVoice.chatGroups.listChatGroups({ ...params }) -> Hume.ReturnPagedChatGroups +
client.expressionMeasurement.batch.getJobDetails(id) -> Hume.UnionJob
@@ -3057,7 +3041,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
-Fetches a paginated list of **Chat Groups**. +Get the request details and state of a given job.
@@ -3073,12 +3057,7 @@ 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.expressionMeasurement.batch.getJobDetails("job_id"); ```
@@ -3094,7 +3073,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
-**request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest` +**id:** `string` — The unique identifier for the job.
@@ -3102,7 +3081,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
-**requestOptions:** `ChatGroups.RequestOptions` +**requestOptions:** `Batch.RequestOptions`
@@ -3113,7 +3092,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
-
client.empathicVoice.chatGroups.getChatGroup(id, { ...params }) -> Hume.ReturnChatGroupPagedChats +
client.expressionMeasurement.batch.getJobPredictions(id) -> Hume.UnionPredictResult[]
@@ -3125,7 +3104,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
-Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**. +Get the JSON predictions of a completed inference job.
@@ -3141,11 +3120,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.expressionMeasurement.batch.getJobPredictions("job_id"); ```
@@ -3161,15 +3136,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
-**id:** `string` — Identifier for a Chat Group. Formatted as a UUID. - -
-
- -
-
- -**request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest` +**id:** `string` — The unique identifier for the job.
@@ -3177,7 +3144,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
-**requestOptions:** `ChatGroups.RequestOptions` +**requestOptions:** `Batch.RequestOptions`
@@ -3188,7 +3155,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
-
client.empathicVoice.chatGroups.listChatGroupEvents(id, { ...params }) -> Hume.ReturnChatGroupPagedEvents +
client.expressionMeasurement.batch.startInferenceJobFromLocalFile(file, { ...params }) -> Hume.JobId
@@ -3200,7 +3167,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
-Fetches a paginated list of **Chat** events associated with a **Chat Group**. +Start a new batch inference job.
@@ -3216,11 +3183,10 @@ 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.expressionMeasurement.batch.startInferenceJobFromLocalFile( + [fs.createReadStream("/path/to/your/file")], + {} +); ```
@@ -3236,7 +3202,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
-**id:** `string` — Identifier for a Chat Group. Formatted as a UUID. +**file:** `File[] | fs.ReadStream[] | Blob[]`
@@ -3244,7 +3210,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
-**request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest` +**request:** `Hume.expressionMeasurement.batch.BatchStartInferenceJobFromLocalFileRequest`
@@ -3252,7 +3218,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
-**requestOptions:** `ChatGroups.RequestOptions` +**requestOptions:** `Batch.RequestOptions`
diff --git a/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts b/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts index ffd419b9..b8741dc9 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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -332,6 +332,100 @@ export class ChatGroups { } } + /** + * @param {string} id - Identifier for a chat. Formatted as a UUID. + * @param {Hume.empathicVoice.ChatGroupsGetAudioRequest} request + * @param {ChatGroups.RequestOptions} requestOptions - Request-specific configuration. + * + * @throws {@link Hume.empathicVoice.BadRequestError} + * + * @example + * await client.empathicVoice.chatGroups.getAudio("id") + */ + public async getAudio( + id: string, + request: Hume.empathicVoice.ChatGroupsGetAudioRequest = {}, + requestOptions?: ChatGroups.RequestOptions + ): Promise { + const { pageNumber, pageSize, ascendingOrder } = request; + const _queryParams: Record = {}; + if (pageNumber != null) { + _queryParams["page_number"] = pageNumber.toString(); + } + + if (pageSize != null) { + _queryParams["page_size"] = pageSize.toString(); + } + + if (ascendingOrder != null) { + _queryParams["ascending_order"] = ascendingOrder.toString(); + } + + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: urlJoin( + (await core.Supplier.get(this._options.environment)) ?? environments.HumeEnvironment.Production, + `v0/evi/chat_groups/${encodeURIComponent(id)}/audio` + ), + method: "GET", + headers: { + "X-Fern-Language": "JavaScript", + "X-Fern-SDK-Name": "hume", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", + "X-Fern-Runtime": core.RUNTIME.type, + "X-Fern-Runtime-Version": core.RUNTIME.version, + ...(await this._getCustomAuthorizationHeaders()), + }, + contentType: "application/json", + queryParameters: _queryParams, + requestType: "json", + timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000, + maxRetries: requestOptions?.maxRetries, + abortSignal: requestOptions?.abortSignal, + }); + if (_response.ok) { + return serializers.empathicVoice.ReturnChatPagedEvents.parseOrThrow(_response.body, { + unrecognizedObjectKeys: "passthrough", + allowUnrecognizedUnionMembers: true, + allowUnrecognizedEnumValues: true, + breadcrumbsPrefix: ["response"], + }); + } + + if (_response.error.reason === "status-code") { + switch (_response.error.statusCode) { + case 400: + throw new Hume.empathicVoice.BadRequestError( + serializers.empathicVoice.ErrorResponse.parseOrThrow(_response.error.body, { + unrecognizedObjectKeys: "passthrough", + allowUnrecognizedUnionMembers: true, + allowUnrecognizedEnumValues: true, + breadcrumbsPrefix: ["response"], + }) + ); + default: + throw new errors.HumeError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + }); + } + } + + switch (_response.error.reason) { + case "non-json": + throw new errors.HumeError({ + statusCode: _response.error.statusCode, + body: _response.error.rawBody, + }); + case "timeout": + throw new errors.HumeTimeoutError(); + case "unknown": + throw new errors.HumeError({ + message: _response.error.errorMessage, + }); + } + } + protected async _getCustomAuthorizationHeaders() { const apiKeyValue = await core.Supplier.get(this._options.apiKey); return { "X-Hume-Api-Key": apiKeyValue }; diff --git a/src/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.ts b/src/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.ts new file mode 100644 index 00000000..35e1cbd2 --- /dev/null +++ b/src/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.ts @@ -0,0 +1,26 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ + +/** + * @example + * {} + */ +export interface ChatGroupsGetAudioRequest { + /** + * Specifies the page number to retrieve, enabling pagination. + * + * This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page. + */ + pageNumber?: number; + /** + * Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive. + * + * For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10. + */ + pageSize?: number; + /** + * Boolean to indicate if the results should be paginated in chronological order or reverse-chronological order. Defaults to true. + */ + ascendingOrder?: boolean; +} diff --git a/src/api/resources/empathicVoice/resources/chatGroups/client/requests/index.ts b/src/api/resources/empathicVoice/resources/chatGroups/client/requests/index.ts index 6e343f44..83de3dcf 100644 --- a/src/api/resources/empathicVoice/resources/chatGroups/client/requests/index.ts +++ b/src/api/resources/empathicVoice/resources/chatGroups/client/requests/index.ts @@ -1,3 +1,4 @@ export { type ChatGroupsListChatGroupsRequest } from "./ChatGroupsListChatGroupsRequest"; export { type ChatGroupsGetChatGroupRequest } from "./ChatGroupsGetChatGroupRequest"; export { type ChatGroupsListChatGroupEventsRequest } from "./ChatGroupsListChatGroupEventsRequest"; +export { type ChatGroupsGetAudioRequest } from "./ChatGroupsGetAudioRequest"; diff --git a/src/api/resources/empathicVoice/resources/chats/client/Client.ts b/src/api/resources/empathicVoice/resources/chats/client/Client.ts index 72e1e4af..f47ad2ab 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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -245,6 +245,83 @@ export class Chats { }); } + /** + * @param {string} id - Identifier for a chat. Formatted as a UUID. + * @param {Chats.RequestOptions} requestOptions - Request-specific configuration. + * + * @throws {@link Hume.empathicVoice.BadRequestError} + * + * @example + * await client.empathicVoice.chats.getAudio("id") + */ + public async getAudio( + id: string, + requestOptions?: Chats.RequestOptions + ): Promise { + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: urlJoin( + (await core.Supplier.get(this._options.environment)) ?? environments.HumeEnvironment.Production, + `v0/evi/chats/${encodeURIComponent(id)}/audio` + ), + method: "GET", + headers: { + "X-Fern-Language": "JavaScript", + "X-Fern-SDK-Name": "hume", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", + "X-Fern-Runtime": core.RUNTIME.type, + "X-Fern-Runtime-Version": core.RUNTIME.version, + ...(await this._getCustomAuthorizationHeaders()), + }, + contentType: "application/json", + requestType: "json", + timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000, + maxRetries: requestOptions?.maxRetries, + abortSignal: requestOptions?.abortSignal, + }); + if (_response.ok) { + return serializers.empathicVoice.ReturnChatPagedEvents.parseOrThrow(_response.body, { + unrecognizedObjectKeys: "passthrough", + allowUnrecognizedUnionMembers: true, + allowUnrecognizedEnumValues: true, + breadcrumbsPrefix: ["response"], + }); + } + + if (_response.error.reason === "status-code") { + switch (_response.error.statusCode) { + case 400: + throw new Hume.empathicVoice.BadRequestError( + serializers.empathicVoice.ErrorResponse.parseOrThrow(_response.error.body, { + unrecognizedObjectKeys: "passthrough", + allowUnrecognizedUnionMembers: true, + allowUnrecognizedEnumValues: true, + breadcrumbsPrefix: ["response"], + }) + ); + default: + throw new errors.HumeError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + }); + } + } + + switch (_response.error.reason) { + case "non-json": + throw new errors.HumeError({ + statusCode: _response.error.statusCode, + body: _response.error.rawBody, + }); + case "timeout": + throw new errors.HumeTimeoutError(); + case "unknown": + throw new errors.HumeError({ + message: _response.error.errorMessage, + }); + } + } + protected async _getCustomAuthorizationHeaders() { const apiKeyValue = await core.Supplier.get(this._options.apiKey); return { "X-Hume-Api-Key": apiKeyValue }; diff --git a/src/api/resources/empathicVoice/resources/configs/client/Client.ts b/src/api/resources/empathicVoice/resources/configs/client/Client.ts index d7593a38..64f6d2dd 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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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/requests/ConfigsListConfigsRequest.ts b/src/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigsRequest.ts index 90bd3a18..cdc50727 100644 --- a/src/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigsRequest.ts +++ b/src/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigsRequest.ts @@ -23,7 +23,7 @@ export interface ConfigsListConfigsRequest { */ pageSize?: number; /** - * By default, `restrict_to_most_recent` is set to true, returning only the latest version of each config. To include all versions of each config in the list, set `restrict_to_most_recent` to false. + * By default, `restrict_to_most_recent` is set to true, returning only the latest version of each tool. To include all versions of each tool in the list, set `restrict_to_most_recent` to false. */ restrictToMostRecent?: boolean; /** diff --git a/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts b/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts index 71546690..ab6d8447 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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -139,7 +139,7 @@ export class CustomVoices { * await client.empathicVoice.customVoices.createCustomVoice({ * name: "name", * baseVoice: Hume.empathicVoice.PostedCustomVoiceBaseVoice.Ito, - * parameterModel: "20240715-4parameter" + * parameterModel: "20241004-11parameter" * }) */ public async createCustomVoice( @@ -155,8 +155,8 @@ export class CustomVoices { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -307,7 +307,7 @@ export class CustomVoices { * await client.empathicVoice.customVoices.createCustomVoiceVersion("id", { * name: "name", * baseVoice: Hume.empathicVoice.PostedCustomVoiceBaseVoice.Ito, - * parameterModel: "20240715-4parameter" + * parameterModel: "20241004-11parameter" * }) */ public async createCustomVoiceVersion( @@ -324,8 +324,8 @@ export class CustomVoices { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, ...(await this._getCustomAuthorizationHeaders()), @@ -463,11 +463,6 @@ export class CustomVoices { * @param {CustomVoices.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Hume.empathicVoice.BadRequestError} - * - * @example - * await client.empathicVoice.customVoices.updateCustomVoiceName("string", { - * name: "string" - * }) */ public async updateCustomVoiceName( id: string, @@ -483,8 +478,8 @@ export class CustomVoices { headers: { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", - "X-Fern-SDK-Version": "0.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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/requests/CustomVoicesListCustomVoicesRequest.ts b/src/api/resources/empathicVoice/resources/customVoices/client/requests/CustomVoicesListCustomVoicesRequest.ts index be6820c2..fa7eacb6 100644 --- a/src/api/resources/empathicVoice/resources/customVoices/client/requests/CustomVoicesListCustomVoicesRequest.ts +++ b/src/api/resources/empathicVoice/resources/customVoices/client/requests/CustomVoicesListCustomVoicesRequest.ts @@ -20,7 +20,7 @@ export interface CustomVoicesListCustomVoicesRequest { */ pageSize?: number; /** - * Filter to only include custom voices with this name. + * Filter to only include custom voices with name. */ name?: string; } diff --git a/src/api/resources/empathicVoice/resources/customVoices/client/requests/PostedCustomVoiceName.ts b/src/api/resources/empathicVoice/resources/customVoices/client/requests/PostedCustomVoiceName.ts index 3362ed44..d8376f26 100644 --- a/src/api/resources/empathicVoice/resources/customVoices/client/requests/PostedCustomVoiceName.ts +++ b/src/api/resources/empathicVoice/resources/customVoices/client/requests/PostedCustomVoiceName.ts @@ -2,12 +2,6 @@ * This file was auto-generated by Fern from our API Definition. */ -/** - * @example - * { - * name: "string" - * } - */ export interface PostedCustomVoiceName { /** The name of the Custom Voice. Maximum length of 75 characters. Will be converted to all-uppercase. (e.g., "sample voice" becomes "SAMPLE VOICE") */ name: string; diff --git a/src/api/resources/empathicVoice/resources/prompts/client/Client.ts b/src/api/resources/empathicVoice/resources/prompts/client/Client.ts index ac8fb574..a0997f5a 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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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/requests/PromptsListPromptsRequest.ts b/src/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.ts index 7177739f..3f012bf6 100644 --- a/src/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.ts +++ b/src/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.ts @@ -23,11 +23,11 @@ export interface PromptsListPromptsRequest { */ pageSize?: number; /** - * By default, `restrict_to_most_recent` is set to true, returning only the latest version of each prompt. To include all versions of each prompt in the list, set `restrict_to_most_recent` to false. + * Only include the most recent version of each prompt in the list. */ restrictToMostRecent?: boolean; /** - * Filter to only include prompts with this name. + * Filter to only include prompts with name. */ name?: string; } diff --git a/src/api/resources/empathicVoice/resources/tools/client/Client.ts b/src/api/resources/empathicVoice/resources/tools/client/Client.ts index 0e1b5994..1b061bb3 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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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/requests/ToolsListToolsRequest.ts b/src/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolsRequest.ts index d080640b..1cac31af 100644 --- a/src/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolsRequest.ts +++ b/src/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolsRequest.ts @@ -27,7 +27,7 @@ export interface ToolsListToolsRequest { */ restrictToMostRecent?: boolean; /** - * Filter to only include tools with this name. + * Filter to only include tools with name. */ name?: string; } diff --git a/src/api/resources/empathicVoice/types/AudioOutput.ts b/src/api/resources/empathicVoice/types/AudioOutput.ts index 2ba8387d..e0772cdc 100644 --- a/src/api/resources/empathicVoice/types/AudioOutput.ts +++ b/src/api/resources/empathicVoice/types/AudioOutput.ts @@ -3,7 +3,7 @@ */ /** - * When provided, the output is audio. + * The type of message sent through the socket; for an Audio Output message, this must be `audio_output`. */ export interface AudioOutput { /** The type of message sent through the socket; for an Audio Output message, this must be `audio_output`. */ diff --git a/src/api/resources/empathicVoice/types/ExtendedVoiceArgs.ts b/src/api/resources/empathicVoice/types/ExtendedVoiceArgs.ts deleted file mode 100644 index f3d90b6c..00000000 --- a/src/api/resources/empathicVoice/types/ExtendedVoiceArgs.ts +++ /dev/null @@ -1,11 +0,0 @@ -/** - * This file was auto-generated by Fern from our API Definition. - */ - -import * as Hume from "../../../index"; - -export interface ExtendedVoiceArgs { - text: string; - useS2A?: boolean; - voiceArgs: Hume.empathicVoice.VoiceArgs; -} diff --git a/src/api/resources/empathicVoice/types/PostedCustomVoice.ts b/src/api/resources/empathicVoice/types/PostedCustomVoice.ts index 486d1c33..2fbcd63b 100644 --- a/src/api/resources/empathicVoice/types/PostedCustomVoice.ts +++ b/src/api/resources/empathicVoice/types/PostedCustomVoice.ts @@ -16,8 +16,8 @@ export interface PostedCustomVoice { name: string; /** Specifies the base voice used to create the Custom Voice. */ baseVoice: Hume.empathicVoice.PostedCustomVoiceBaseVoice; - /** The name of the parameter model used to define which attributes are used by the `parameters` field. Currently, only `20240715-4parameter` is supported as the parameter model. */ - parameterModel: "20240715-4parameter"; + /** The name of the parameter model used to define which attributes are used by the `parameters` field. Currently, only `20241004-11parameter` is supported as the parameter model. */ + parameterModel: "20241004-11parameter"; /** * The specified attributes of a Custom Voice. * diff --git a/src/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.ts b/src/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.ts index 7da60c48..fb6f7094 100644 --- a/src/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.ts +++ b/src/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.ts @@ -5,7 +5,7 @@ /** * Specifies the base voice used to create the Custom Voice. */ -export type PostedCustomVoiceBaseVoice = "ITO" | "KORA" | "DACHER" | "AURA" | "FINN" | "STELLA" | "WHIMSY"; +export type PostedCustomVoiceBaseVoice = "ITO" | "KORA" | "DACHER" | "AURA" | "FINN" | "WHIMSY" | "STELLA" | "SUNNY"; export const PostedCustomVoiceBaseVoice = { Ito: "ITO", @@ -13,6 +13,7 @@ export const PostedCustomVoiceBaseVoice = { Dacher: "DACHER", Aura: "AURA", Finn: "FINN", - Stella: "STELLA", Whimsy: "WHIMSY", + Stella: "STELLA", + Sunny: "SUNNY", } as const; diff --git a/src/api/resources/empathicVoice/types/PostedCustomVoiceParameters.ts b/src/api/resources/empathicVoice/types/PostedCustomVoiceParameters.ts index c820eff5..c31d2956 100644 --- a/src/api/resources/empathicVoice/types/PostedCustomVoiceParameters.ts +++ b/src/api/resources/empathicVoice/types/PostedCustomVoiceParameters.ts @@ -9,27 +9,69 @@ */ export interface PostedCustomVoiceParameters { /** - * The vocalization of gender, ranging between masculine and feminine. + * The vocalization of gender, ranging between more masculine and more feminine. * * The default value is `0`, with a minimum of `-100` (more masculine) and a maximum of `100` (more feminine). A value of `0` leaves this parameter unchanged from the base voice. */ gender?: number; /** - * The texture of the voice, ranging between bright and husky. + * The clarity of the voice, ranging between mumbled and articulate. * - * The default value is `0`, with a minimum of `-100` (brighter) and a maximum of `100` (huskier). A value of `0` leaves this parameter unchanged from the base voice. + * The default value is `0`, with a minimum of `-100` (mumbled) and a maximum of `100` (articulate). A value of `0` leaves this parameter unchanged from the base voice. */ - huskiness?: number; + articulation?: number; /** - * The openness of the voice, ranging between resonant and nasal. + * The firmness of the voice, ranging between whiny and bold. * - * The default value is `0`, with a minimum of `-100` (more resonant) and a maximum of `100` (more nasal). A value of `0` leaves this parameter unchanged from the base voice. + * The default value is `0`, with a minimum of `-100` (whiny) and a maximum of `100` (bold). A value of `0` leaves this parameter unchanged from the base voice. + */ + assertiveness?: number; + /** + * The density of the voice, ranging between deflated and buoyant. + * + * The default value is `0`, with a minimum of `-100` (deflated) and a maximum of `100` (buoyant). A value of `0` leaves this parameter unchanged from the base voice. + */ + buoyancy?: number; + /** + * The assuredness of the voice, ranging between shy and confident. + * + * The default value is `0`, with a minimum of `-100` (shy) and a maximum of `100` (confident). A value of `0` leaves this parameter unchanged from the base voice. + */ + confidence?: number; + /** + * The excitement within the voice, ranging between calm and enthusiastic. + * + * The default value is `0`, with a minimum of `-100` (calm) and a maximum of `100` (enthusiastic). A value of `0` leaves this parameter unchanged from the base voice. + */ + enthusiasm?: number; + /** + * The openness of the voice, ranging between clear and nasal. + * + * The default value is `0`, with a minimum of `-100` (clear) and a maximum of `100` (nasal). A value of `0` leaves this parameter unchanged from the base voice. */ nasality?: number; /** - * The frequency of the voice, ranging between low and high. + * The stress within the voice, ranging between tense and relaxed. + * + * The default value is `0`, with a minimum of `-100` (tense) and a maximum of `100` (relaxed). A value of `0` leaves this parameter unchanged from the base voice. + */ + relaxedness?: number; + /** + * The texture of the voice, ranging between smooth and staccato. + * + * The default value is `0`, with a minimum of `-100` (smooth) and a maximum of `100` (staccato). A value of `0` leaves this parameter unchanged from the base voice. + */ + smoothness?: number; + /** + * The liveliness behind the voice, ranging between tepid and vigorous. + * + * The default value is `0`, with a minimum of `-100` (tepid) and a maximum of `100` (vigorous). A value of `0` leaves this parameter unchanged from the base voice. + */ + tepidity?: number; + /** + * The containment of the voice, ranging between tight and breathy. * - * The default value is `0`, with a minimum of `-100` (lower) and a maximum of `100` (higher). A value of `0` leaves this parameter unchanged from the base voice. + * The default value is `0`, with a minimum of `-100` (tight) and a maximum of `100` (breathy). A value of `0` leaves this parameter unchanged from the base voice. */ - pitch?: number; + tightness?: number; } diff --git a/src/api/resources/empathicVoice/types/PostedVoice.ts b/src/api/resources/empathicVoice/types/PostedVoice.ts index 1ba08d83..43d342a9 100644 --- a/src/api/resources/empathicVoice/types/PostedVoice.ts +++ b/src/api/resources/empathicVoice/types/PostedVoice.ts @@ -13,7 +13,7 @@ export interface PostedVoice { /** * Specifies the name of the voice to use. * - * This can be either the name of a previously created Custom Voice or one of our 7 base voices: `ITO`, `KORA`, `DACHER`, `AURA`, `FINN`, `WHIMSY`, or `STELLA`. + * This can be either the name of a previously created Custom Voice or one of our 8 base voices: `ITO`, `KORA`, `DACHER`, `AURA`, `FINN`, `WHIMSY`, `STELLA`, or `SUNNY`. * * The name will be automatically converted to uppercase (e.g., "Ito" becomes "ITO"). If a name is not specified, then a [Custom Voice](/reference/empathic-voice-interface-evi/configs/create-config#request.body.voice.custom_voice) specification must be provided. */ diff --git a/src/api/resources/empathicVoice/types/ReturnCustomVoice.ts b/src/api/resources/empathicVoice/types/ReturnCustomVoice.ts index 7864cd9f..489fbdc8 100644 --- a/src/api/resources/empathicVoice/types/ReturnCustomVoice.ts +++ b/src/api/resources/empathicVoice/types/ReturnCustomVoice.ts @@ -26,8 +26,8 @@ export interface ReturnCustomVoice { modifiedOn: number; /** The base voice used to create the Custom Voice. */ baseVoice: Hume.empathicVoice.ReturnCustomVoiceBaseVoice; - /** The name of the parameter model used to define which attributes are used by the `parameters` field. Currently, only `20240715-4parameter` is supported as the parameter model. */ - parameterModel: "20240715-4parameter"; + /** The name of the parameter model used to define which attributes are used by the `parameters` field. Currently, only `20241004-11parameter` is supported as the parameter model. */ + parameterModel: "20241004-11parameter"; /** The specified attributes of a Custom Voice. If a parameter's value is `0` (default), it will not be included in the response. */ parameters: Hume.empathicVoice.ReturnCustomVoiceParameters; } diff --git a/src/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.ts b/src/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.ts index 34bf3edd..fb8969bc 100644 --- a/src/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.ts +++ b/src/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.ts @@ -5,7 +5,7 @@ /** * The base voice used to create the Custom Voice. */ -export type ReturnCustomVoiceBaseVoice = "ITO" | "KORA" | "DACHER" | "AURA" | "FINN" | "STELLA" | "WHIMSY"; +export type ReturnCustomVoiceBaseVoice = "ITO" | "KORA" | "DACHER" | "AURA" | "FINN" | "WHIMSY" | "STELLA" | "SUNNY"; export const ReturnCustomVoiceBaseVoice = { Ito: "ITO", @@ -13,6 +13,7 @@ export const ReturnCustomVoiceBaseVoice = { Dacher: "DACHER", Aura: "AURA", Finn: "FINN", - Stella: "STELLA", Whimsy: "WHIMSY", + Stella: "STELLA", + Sunny: "SUNNY", } as const; diff --git a/src/api/resources/empathicVoice/types/ReturnCustomVoiceParameters.ts b/src/api/resources/empathicVoice/types/ReturnCustomVoiceParameters.ts index d0e62f28..883d2b06 100644 --- a/src/api/resources/empathicVoice/types/ReturnCustomVoiceParameters.ts +++ b/src/api/resources/empathicVoice/types/ReturnCustomVoiceParameters.ts @@ -7,27 +7,69 @@ */ export interface ReturnCustomVoiceParameters { /** - * The vocalization of gender, ranging between masculine and feminine. + * The vocalization of gender, ranging between more masculine and more feminine. * * The default value is `0`, with a minimum of `-100` (more masculine) and a maximum of `100` (more feminine). A value of `0` leaves this parameter unchanged from the base voice. */ gender?: number; /** - * The texture of the voice, ranging between bright and husky. + * The clarity of the voice, ranging between mumbled and articulate. * - * The default value is `0`, with a minimum of `-100` (brighter) and a maximum of `100` (huskier). A value of `0` leaves this parameter unchanged from the base voice. + * The default value is `0`, with a minimum of `-100` (mumbled) and a maximum of `100` (articulate). A value of `0` leaves this parameter unchanged from the base voice. */ - huskiness?: number; + articulation?: number; /** - * The openness of the voice, ranging between resonant and nasal. + * The firmness of the voice, ranging between whiny and bold. * - * The default value is `0`, with a minimum of `-100` (more resonant) and a maximum of `100` (more nasal). A value of `0` leaves this parameter unchanged from the base voice. + * The default value is `0`, with a minimum of `-100` (whiny) and a maximum of `100` (bold). A value of `0` leaves this parameter unchanged from the base voice. + */ + assertiveness?: number; + /** + * The density of the voice, ranging between deflated and buoyant. + * + * The default value is `0`, with a minimum of `-100` (deflated) and a maximum of `100` (buoyant). A value of `0` leaves this parameter unchanged from the base voice. + */ + buoyancy?: number; + /** + * The assuredness of the voice, ranging between shy and confident. + * + * The default value is `0`, with a minimum of `-100` (shy) and a maximum of `100` (confident). A value of `0` leaves this parameter unchanged from the base voice. + */ + confidence?: number; + /** + * The excitement within the voice, ranging between calm and enthusiastic. + * + * The default value is `0`, with a minimum of `-100` (calm) and a maximum of `100` (enthusiastic). A value of `0` leaves this parameter unchanged from the base voice. + */ + enthusiasm?: number; + /** + * The openness of the voice, ranging between clear and nasal. + * + * The default value is `0`, with a minimum of `-100` (clear) and a maximum of `100` (nasal). A value of `0` leaves this parameter unchanged from the base voice. */ nasality?: number; /** - * The frequency of the voice, ranging between low and high. + * The stress within the voice, ranging between tense and relaxed. + * + * The default value is `0`, with a minimum of `-100` (tense) and a maximum of `100` (relaxed). A value of `0` leaves this parameter unchanged from the base voice. + */ + relaxedness?: number; + /** + * The texture of the voice, ranging between smooth and staccato. + * + * The default value is `0`, with a minimum of `-100` (smooth) and a maximum of `100` (staccato). A value of `0` leaves this parameter unchanged from the base voice. + */ + smoothness?: number; + /** + * The liveliness behind the voice, ranging between tepid and vigorous. + * + * The default value is `0`, with a minimum of `-100` (tepid) and a maximum of `100` (vigorous). A value of `0` leaves this parameter unchanged from the base voice. + */ + tepidity?: number; + /** + * The containment of the voice, ranging between tight and breathy. * - * The default value is `0`, with a minimum of `-100` (lower) and a maximum of `100` (higher). A value of `0` leaves this parameter unchanged from the base voice. + * The default value is `0`, with a minimum of `-100` (tight) and a maximum of `100` (breathy). A value of `0` leaves this parameter unchanged from the base voice. */ - pitch?: number; + tightness?: number; } diff --git a/src/api/resources/empathicVoice/types/ReturnVoice.ts b/src/api/resources/empathicVoice/types/ReturnVoice.ts index b49b2a8e..ddfe29a9 100644 --- a/src/api/resources/empathicVoice/types/ReturnVoice.ts +++ b/src/api/resources/empathicVoice/types/ReturnVoice.ts @@ -13,7 +13,7 @@ export interface ReturnVoice { /** * The name of the specified voice. * - * 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`. + * This will either be the name of a previously created Custom Voice or one of our 8 base voices: `ITO`, `KORA`, `DACHER`, `AURA`, `FINN`, `WHIMSY`, `STELLA`, or `SUNNY`. */ name?: string; customVoice?: Hume.empathicVoice.ReturnCustomVoice; diff --git a/src/api/resources/empathicVoice/types/UserInput.ts b/src/api/resources/empathicVoice/types/UserInput.ts index 341b0014..16aab91a 100644 --- a/src/api/resources/empathicVoice/types/UserInput.ts +++ b/src/api/resources/empathicVoice/types/UserInput.ts @@ -3,7 +3,9 @@ */ /** - * User text to insert into the conversation. + * User text to insert into the conversation. Text sent through a User Input message is treated as the user’s speech to EVI. EVI processes this input and provides a corresponding response. + * + * Expression measurement results are not available for User Input messages, as the prosody model relies on audio input and cannot process text alone. */ export interface UserInput { /** The type of message sent through the socket; must be `user_input` for our server to correctly identify and process it as a User Input message. */ diff --git a/src/api/resources/empathicVoice/types/VoiceArgs.ts b/src/api/resources/empathicVoice/types/VoiceArgs.ts deleted file mode 100644 index c0118dfe..00000000 --- a/src/api/resources/empathicVoice/types/VoiceArgs.ts +++ /dev/null @@ -1,15 +0,0 @@ -/** - * This file was auto-generated by Fern from our API Definition. - */ - -import * as Hume from "../../../index"; - -export interface VoiceArgs { - voice?: Hume.empathicVoice.VoiceNameEnum; - speechRateMultiplier?: number; - baseline?: boolean; - reconstruct?: boolean; - additive?: boolean; - drift?: boolean; - useV2?: boolean; -} diff --git a/src/api/resources/empathicVoice/types/VoiceNameEnum.ts b/src/api/resources/empathicVoice/types/VoiceNameEnum.ts index 90fe01b4..e2e94a4f 100644 --- a/src/api/resources/empathicVoice/types/VoiceNameEnum.ts +++ b/src/api/resources/empathicVoice/types/VoiceNameEnum.ts @@ -15,7 +15,8 @@ export type VoiceNameEnum = | "ACE" | "JUNO" | "STELLA" - | "HIRO"; + | "HIRO" + | "SUNNY"; export const VoiceNameEnum = { Ito: "ITO", @@ -31,4 +32,5 @@ export const VoiceNameEnum = { Juno: "JUNO", Stella: "STELLA", Hiro: "HIRO", + Sunny: "SUNNY", } as const; diff --git a/src/api/resources/empathicVoice/types/index.ts b/src/api/resources/empathicVoice/types/index.ts index eeef1b1a..3bc3970a 100644 --- a/src/api/resources/empathicVoice/types/index.ts +++ b/src/api/resources/empathicVoice/types/index.ts @@ -96,9 +96,7 @@ export * from "./JsonMessage"; export * from "./TtsInput"; export * from "./TextInput"; export * from "./FunctionCallResponseInput"; -export * from "./ExtendedVoiceArgs"; export * from "./HttpValidationError"; export * from "./ValidationErrorLocItem"; export * from "./ValidationError"; -export * from "./VoiceArgs"; export * from "./VoiceNameEnum"; diff --git a/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts b/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts index fee323bf..b3ab3638 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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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.9.1", - "User-Agent": "hume/0.9.1", + "X-Fern-SDK-Version": "0.9.3", + "User-Agent": "hume/0.9.3", "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 15ed9ecd..6a44d0fc 100644 --- a/src/api/resources/index.ts +++ b/src/api/resources/index.ts @@ -1,2 +1,2 @@ -export * as expressionMeasurement from "./expressionMeasurement"; export * as empathicVoice from "./empathicVoice"; +export * as expressionMeasurement from "./expressionMeasurement"; diff --git a/src/serialization/resources/empathicVoice/types/ExtendedVoiceArgs.ts b/src/serialization/resources/empathicVoice/types/ExtendedVoiceArgs.ts deleted file mode 100644 index af29200c..00000000 --- a/src/serialization/resources/empathicVoice/types/ExtendedVoiceArgs.ts +++ /dev/null @@ -1,25 +0,0 @@ -/** - * This file was auto-generated by Fern from our API Definition. - */ - -import * as serializers from "../../../index"; -import * as Hume from "../../../../api/index"; -import * as core from "../../../../core"; -import { VoiceArgs } from "./VoiceArgs"; - -export const ExtendedVoiceArgs: core.serialization.ObjectSchema< - serializers.empathicVoice.ExtendedVoiceArgs.Raw, - Hume.empathicVoice.ExtendedVoiceArgs -> = core.serialization.object({ - text: core.serialization.string(), - useS2A: core.serialization.property("use_s2a", core.serialization.boolean().optional()), - voiceArgs: core.serialization.property("voice_args", VoiceArgs), -}); - -export declare namespace ExtendedVoiceArgs { - interface Raw { - text: string; - use_s2a?: boolean | null; - voice_args: VoiceArgs.Raw; - } -} diff --git a/src/serialization/resources/empathicVoice/types/PostedCustomVoice.ts b/src/serialization/resources/empathicVoice/types/PostedCustomVoice.ts index 8d8e8b02..c306fcad 100644 --- a/src/serialization/resources/empathicVoice/types/PostedCustomVoice.ts +++ b/src/serialization/resources/empathicVoice/types/PostedCustomVoice.ts @@ -16,7 +16,7 @@ export const PostedCustomVoice: core.serialization.ObjectSchema< baseVoice: core.serialization.property("base_voice", PostedCustomVoiceBaseVoice), parameterModel: core.serialization.property( "parameter_model", - core.serialization.stringLiteral("20240715-4parameter") + core.serialization.stringLiteral("20241004-11parameter") ), parameters: PostedCustomVoiceParameters.optional(), }); @@ -25,7 +25,7 @@ export declare namespace PostedCustomVoice { interface Raw { name: string; base_voice: PostedCustomVoiceBaseVoice.Raw; - parameter_model: "20240715-4parameter"; + parameter_model: "20241004-11parameter"; parameters?: PostedCustomVoiceParameters.Raw | null; } } diff --git a/src/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.ts b/src/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.ts index 652a8217..ab337646 100644 --- a/src/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.ts +++ b/src/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.ts @@ -9,8 +9,8 @@ import * as core from "../../../../core"; export const PostedCustomVoiceBaseVoice: core.serialization.Schema< serializers.empathicVoice.PostedCustomVoiceBaseVoice.Raw, Hume.empathicVoice.PostedCustomVoiceBaseVoice -> = core.serialization.enum_(["ITO", "KORA", "DACHER", "AURA", "FINN", "STELLA", "WHIMSY"]); +> = core.serialization.enum_(["ITO", "KORA", "DACHER", "AURA", "FINN", "WHIMSY", "STELLA", "SUNNY"]); export declare namespace PostedCustomVoiceBaseVoice { - type Raw = "ITO" | "KORA" | "DACHER" | "AURA" | "FINN" | "STELLA" | "WHIMSY"; + type Raw = "ITO" | "KORA" | "DACHER" | "AURA" | "FINN" | "WHIMSY" | "STELLA" | "SUNNY"; } diff --git a/src/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.ts b/src/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.ts index 90a722f9..bdcf04a2 100644 --- a/src/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.ts +++ b/src/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.ts @@ -11,16 +11,30 @@ export const PostedCustomVoiceParameters: core.serialization.ObjectSchema< Hume.empathicVoice.PostedCustomVoiceParameters > = core.serialization.object({ gender: core.serialization.number().optional(), - huskiness: core.serialization.number().optional(), + articulation: core.serialization.number().optional(), + assertiveness: core.serialization.number().optional(), + buoyancy: core.serialization.number().optional(), + confidence: core.serialization.number().optional(), + enthusiasm: core.serialization.number().optional(), nasality: core.serialization.number().optional(), - pitch: core.serialization.number().optional(), + relaxedness: core.serialization.number().optional(), + smoothness: core.serialization.number().optional(), + tepidity: core.serialization.number().optional(), + tightness: core.serialization.number().optional(), }); export declare namespace PostedCustomVoiceParameters { interface Raw { gender?: number | null; - huskiness?: number | null; + articulation?: number | null; + assertiveness?: number | null; + buoyancy?: number | null; + confidence?: number | null; + enthusiasm?: number | null; nasality?: number | null; - pitch?: number | null; + relaxedness?: number | null; + smoothness?: number | null; + tepidity?: number | null; + tightness?: number | null; } } diff --git a/src/serialization/resources/empathicVoice/types/ReturnCustomVoice.ts b/src/serialization/resources/empathicVoice/types/ReturnCustomVoice.ts index ab22a948..acc7e29c 100644 --- a/src/serialization/resources/empathicVoice/types/ReturnCustomVoice.ts +++ b/src/serialization/resources/empathicVoice/types/ReturnCustomVoice.ts @@ -20,7 +20,7 @@ export const ReturnCustomVoice: core.serialization.ObjectSchema< baseVoice: core.serialization.property("base_voice", ReturnCustomVoiceBaseVoice), parameterModel: core.serialization.property( "parameter_model", - core.serialization.stringLiteral("20240715-4parameter") + core.serialization.stringLiteral("20241004-11parameter") ), parameters: ReturnCustomVoiceParameters, }); @@ -33,7 +33,7 @@ export declare namespace ReturnCustomVoice { created_on: number; modified_on: number; base_voice: ReturnCustomVoiceBaseVoice.Raw; - parameter_model: "20240715-4parameter"; + parameter_model: "20241004-11parameter"; parameters: ReturnCustomVoiceParameters.Raw; } } diff --git a/src/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.ts b/src/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.ts index 891cc9e9..91692ba3 100644 --- a/src/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.ts +++ b/src/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.ts @@ -9,8 +9,8 @@ import * as core from "../../../../core"; export const ReturnCustomVoiceBaseVoice: core.serialization.Schema< serializers.empathicVoice.ReturnCustomVoiceBaseVoice.Raw, Hume.empathicVoice.ReturnCustomVoiceBaseVoice -> = core.serialization.enum_(["ITO", "KORA", "DACHER", "AURA", "FINN", "STELLA", "WHIMSY"]); +> = core.serialization.enum_(["ITO", "KORA", "DACHER", "AURA", "FINN", "WHIMSY", "STELLA", "SUNNY"]); export declare namespace ReturnCustomVoiceBaseVoice { - type Raw = "ITO" | "KORA" | "DACHER" | "AURA" | "FINN" | "STELLA" | "WHIMSY"; + type Raw = "ITO" | "KORA" | "DACHER" | "AURA" | "FINN" | "WHIMSY" | "STELLA" | "SUNNY"; } diff --git a/src/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.ts b/src/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.ts index f5a76ad9..7e8b8ad1 100644 --- a/src/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.ts +++ b/src/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.ts @@ -11,16 +11,30 @@ export const ReturnCustomVoiceParameters: core.serialization.ObjectSchema< Hume.empathicVoice.ReturnCustomVoiceParameters > = core.serialization.object({ gender: core.serialization.number().optional(), - huskiness: core.serialization.number().optional(), + articulation: core.serialization.number().optional(), + assertiveness: core.serialization.number().optional(), + buoyancy: core.serialization.number().optional(), + confidence: core.serialization.number().optional(), + enthusiasm: core.serialization.number().optional(), nasality: core.serialization.number().optional(), - pitch: core.serialization.number().optional(), + relaxedness: core.serialization.number().optional(), + smoothness: core.serialization.number().optional(), + tepidity: core.serialization.number().optional(), + tightness: core.serialization.number().optional(), }); export declare namespace ReturnCustomVoiceParameters { interface Raw { gender?: number | null; - huskiness?: number | null; + articulation?: number | null; + assertiveness?: number | null; + buoyancy?: number | null; + confidence?: number | null; + enthusiasm?: number | null; nasality?: number | null; - pitch?: number | null; + relaxedness?: number | null; + smoothness?: number | null; + tepidity?: number | null; + tightness?: number | null; } } diff --git a/src/serialization/resources/empathicVoice/types/VoiceArgs.ts b/src/serialization/resources/empathicVoice/types/VoiceArgs.ts deleted file mode 100644 index 5fb9578f..00000000 --- a/src/serialization/resources/empathicVoice/types/VoiceArgs.ts +++ /dev/null @@ -1,33 +0,0 @@ -/** - * This file was auto-generated by Fern from our API Definition. - */ - -import * as serializers from "../../../index"; -import * as Hume from "../../../../api/index"; -import * as core from "../../../../core"; -import { VoiceNameEnum } from "./VoiceNameEnum"; - -export const VoiceArgs: core.serialization.ObjectSchema< - serializers.empathicVoice.VoiceArgs.Raw, - Hume.empathicVoice.VoiceArgs -> = core.serialization.object({ - voice: VoiceNameEnum.optional(), - speechRateMultiplier: core.serialization.property("speech_rate_multiplier", core.serialization.number().optional()), - baseline: core.serialization.boolean().optional(), - reconstruct: core.serialization.boolean().optional(), - additive: core.serialization.boolean().optional(), - drift: core.serialization.boolean().optional(), - useV2: core.serialization.property("use_v2", core.serialization.boolean().optional()), -}); - -export declare namespace VoiceArgs { - interface Raw { - voice?: VoiceNameEnum.Raw | null; - speech_rate_multiplier?: number | null; - baseline?: boolean | null; - reconstruct?: boolean | null; - additive?: boolean | null; - drift?: boolean | null; - use_v2?: boolean | null; - } -} diff --git a/src/serialization/resources/empathicVoice/types/VoiceNameEnum.ts b/src/serialization/resources/empathicVoice/types/VoiceNameEnum.ts index 7c6994dc..ea27c5f8 100644 --- a/src/serialization/resources/empathicVoice/types/VoiceNameEnum.ts +++ b/src/serialization/resources/empathicVoice/types/VoiceNameEnum.ts @@ -23,6 +23,7 @@ export const VoiceNameEnum: core.serialization.Schema< "JUNO", "STELLA", "HIRO", + "SUNNY", ]); export declare namespace VoiceNameEnum { @@ -39,5 +40,6 @@ export declare namespace VoiceNameEnum { | "ACE" | "JUNO" | "STELLA" - | "HIRO"; + | "HIRO" + | "SUNNY"; } diff --git a/src/serialization/resources/empathicVoice/types/index.ts b/src/serialization/resources/empathicVoice/types/index.ts index eeef1b1a..3bc3970a 100644 --- a/src/serialization/resources/empathicVoice/types/index.ts +++ b/src/serialization/resources/empathicVoice/types/index.ts @@ -96,9 +96,7 @@ export * from "./JsonMessage"; export * from "./TtsInput"; export * from "./TextInput"; export * from "./FunctionCallResponseInput"; -export * from "./ExtendedVoiceArgs"; export * from "./HttpValidationError"; export * from "./ValidationErrorLocItem"; export * from "./ValidationError"; -export * from "./VoiceArgs"; export * from "./VoiceNameEnum"; diff --git a/src/serialization/resources/index.ts b/src/serialization/resources/index.ts index 15ed9ecd..6a44d0fc 100644 --- a/src/serialization/resources/index.ts +++ b/src/serialization/resources/index.ts @@ -1,2 +1,2 @@ -export * as expressionMeasurement from "./expressionMeasurement"; export * as empathicVoice from "./empathicVoice"; +export * as expressionMeasurement from "./expressionMeasurement"; diff --git a/src/version.ts b/src/version.ts index 9ba59d65..51c81b83 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const SDK_VERSION = "0.9.1"; +export const SDK_VERSION = "0.9.3"; diff --git a/yarn.lock b/yarn.lock index 112abd2a..925ee32e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -10,131 +10,131 @@ "@jridgewell/gen-mapping" "^0.3.5" "@jridgewell/trace-mapping" "^0.3.24" -"@babel/code-frame@^7.0.0", "@babel/code-frame@^7.12.13", "@babel/code-frame@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.24.7.tgz#882fd9e09e8ee324e496bd040401c6f046ef4465" - integrity sha512-BcYH1CVJBO9tvyIZ2jVeXgSIMvGZ2FDRvDdOIVQyuklNKSsx+eppDEBq/g47Ayw+RqNFE+URvOShmf+f/qwAlA== +"@babel/code-frame@^7.0.0", "@babel/code-frame@^7.12.13", "@babel/code-frame@^7.25.9": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.25.9.tgz#895b6c7e04a7271a0cbfd575d2e8131751914cc7" + integrity sha512-z88xeGxnzehn2sqZ8UdGQEvYErF1odv2CftxInpSYJt6uHuPe9YjahKZITGs3l5LeI9d2ROG+obuDAoSlqbNfQ== dependencies: - "@babel/highlight" "^7.24.7" + "@babel/highlight" "^7.25.9" picocolors "^1.0.0" -"@babel/compat-data@^7.25.2": - version "7.25.4" - resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.25.4.tgz#7d2a80ce229890edcf4cc259d4d696cb4dae2fcb" - integrity sha512-+LGRog6RAsCJrrrg/IO6LGmpphNe5DiK30dGjCoxxeGv49B10/3XYGxPsAwrDlMFcFEvdAUavDT8r9k/hSyQqQ== +"@babel/compat-data@^7.25.9": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.25.9.tgz#24b01c5db6a3ebf85661b4fb4a946a9bccc72ac8" + integrity sha512-yD+hEuJ/+wAJ4Ox2/rpNv5HIuPG82x3ZlQvYVn8iYCprdxzE7P1udpGF1jyjQVBU4dgznN+k2h103vxZ7NdPyw== "@babel/core@^7.0.0", "@babel/core@^7.11.6", "@babel/core@^7.12.3", "@babel/core@^7.23.9": - version "7.25.2" - resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.25.2.tgz#ed8eec275118d7613e77a352894cd12ded8eba77" - integrity sha512-BBt3opiCOxUr9euZ5/ro/Xv8/V7yJ5bjYMqG/C1YAo8MIKAnumZalCN+msbci3Pigy4lIQfPUpfMM27HMGaYEA== + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.25.9.tgz#855a4cddcec4158f3f7afadacdab2a7de8af7434" + integrity sha512-WYvQviPw+Qyib0v92AwNIrdLISTp7RfDkM7bPqBvpbnhY4wq8HvHBZREVdYDXk98C8BkOIVnHAY3yvj7AVISxQ== dependencies: "@ampproject/remapping" "^2.2.0" - "@babel/code-frame" "^7.24.7" - "@babel/generator" "^7.25.0" - "@babel/helper-compilation-targets" "^7.25.2" - "@babel/helper-module-transforms" "^7.25.2" - "@babel/helpers" "^7.25.0" - "@babel/parser" "^7.25.0" - "@babel/template" "^7.25.0" - "@babel/traverse" "^7.25.2" - "@babel/types" "^7.25.2" + "@babel/code-frame" "^7.25.9" + "@babel/generator" "^7.25.9" + "@babel/helper-compilation-targets" "^7.25.9" + "@babel/helper-module-transforms" "^7.25.9" + "@babel/helpers" "^7.25.9" + "@babel/parser" "^7.25.9" + "@babel/template" "^7.25.9" + "@babel/traverse" "^7.25.9" + "@babel/types" "^7.25.9" convert-source-map "^2.0.0" debug "^4.1.0" gensync "^1.0.0-beta.2" json5 "^2.2.3" semver "^6.3.1" -"@babel/generator@^7.25.0", "@babel/generator@^7.25.6", "@babel/generator@^7.7.2": - version "7.25.6" - resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.25.6.tgz#0df1ad8cb32fe4d2b01d8bf437f153d19342a87c" - integrity sha512-VPC82gr1seXOpkjAAKoLhP50vx4vGNlF4msF64dSFq1P8RfB+QAuJWGHPXXPc8QyfVWwwB/TNNU4+ayZmHNbZw== +"@babel/generator@^7.25.9", "@babel/generator@^7.7.2": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.25.9.tgz#c7e828ebe0c2baba103b712924699c9e8a6e32f0" + integrity sha512-omlUGkr5EaoIJrhLf9CJ0TvjBRpd9+AXRG//0GEQ9THSo8wPiTlbpy1/Ow8ZTrbXpjd9FHXfbFQx32I04ht0FA== dependencies: - "@babel/types" "^7.25.6" + "@babel/types" "^7.25.9" "@jridgewell/gen-mapping" "^0.3.5" "@jridgewell/trace-mapping" "^0.3.25" - jsesc "^2.5.1" + jsesc "^3.0.2" -"@babel/helper-compilation-targets@^7.25.2": - version "7.25.2" - resolved "https://registry.yarnpkg.com/@babel/helper-compilation-targets/-/helper-compilation-targets-7.25.2.tgz#e1d9410a90974a3a5a66e84ff55ef62e3c02d06c" - integrity sha512-U2U5LsSaZ7TAt3cfaymQ8WHh0pxvdHoEk6HVpaexxixjyEquMh0L0YNJNM6CTGKMXV1iksi0iZkGw4AcFkPaaw== +"@babel/helper-compilation-targets@^7.25.9": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/helper-compilation-targets/-/helper-compilation-targets-7.25.9.tgz#55af025ce365be3cdc0c1c1e56c6af617ce88875" + integrity sha512-j9Db8Suy6yV/VHa4qzrj9yZfZxhLWQdVnRlXxmKLYlhWUVB1sB2G5sxuWYXk/whHD9iW76PmNzxZ4UCnTQTVEQ== dependencies: - "@babel/compat-data" "^7.25.2" - "@babel/helper-validator-option" "^7.24.8" - browserslist "^4.23.1" + "@babel/compat-data" "^7.25.9" + "@babel/helper-validator-option" "^7.25.9" + browserslist "^4.24.0" lru-cache "^5.1.1" semver "^6.3.1" -"@babel/helper-module-imports@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-module-imports/-/helper-module-imports-7.24.7.tgz#f2f980392de5b84c3328fc71d38bd81bbb83042b" - integrity sha512-8AyH3C+74cgCVVXow/myrynrAGv+nTVg5vKu2nZph9x7RcRwzmh0VFallJuFTZ9mx6u4eSdXZfcOzSqTUm0HCA== - dependencies: - "@babel/traverse" "^7.24.7" - "@babel/types" "^7.24.7" - -"@babel/helper-module-transforms@^7.25.2": - version "7.25.2" - resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.25.2.tgz#ee713c29768100f2776edf04d4eb23b8d27a66e6" - integrity sha512-BjyRAbix6j/wv83ftcVJmBt72QtHI56C7JXZoG2xATiLpmoC7dpd8WnkikExHDVPpi/3qCmO6WY1EaXOluiecQ== - dependencies: - "@babel/helper-module-imports" "^7.24.7" - "@babel/helper-simple-access" "^7.24.7" - "@babel/helper-validator-identifier" "^7.24.7" - "@babel/traverse" "^7.25.2" - -"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.10.4", "@babel/helper-plugin-utils@^7.12.13", "@babel/helper-plugin-utils@^7.14.5", "@babel/helper-plugin-utils@^7.24.7", "@babel/helper-plugin-utils@^7.24.8", "@babel/helper-plugin-utils@^7.8.0": - version "7.24.8" - resolved "https://registry.yarnpkg.com/@babel/helper-plugin-utils/-/helper-plugin-utils-7.24.8.tgz#94ee67e8ec0e5d44ea7baeb51e571bd26af07878" - integrity sha512-FFWx5142D8h2Mgr/iPVGH5G7w6jDn4jUSpZTyDnQO0Yn7Ks2Kuz6Pci8H6MPCoUJegd/UZQ3tAvfLCxQSnWWwg== - -"@babel/helper-simple-access@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-simple-access/-/helper-simple-access-7.24.7.tgz#bcade8da3aec8ed16b9c4953b74e506b51b5edb3" - integrity sha512-zBAIvbCMh5Ts+b86r/CjU+4XGYIs+R1j951gxI3KmmxBMhCg4oQMsv6ZXQ64XOm/cvzfU1FmoCyt6+owc5QMYg== - dependencies: - "@babel/traverse" "^7.24.7" - "@babel/types" "^7.24.7" - -"@babel/helper-string-parser@^7.24.8": - version "7.24.8" - resolved "https://registry.yarnpkg.com/@babel/helper-string-parser/-/helper-string-parser-7.24.8.tgz#5b3329c9a58803d5df425e5785865881a81ca48d" - integrity sha512-pO9KhhRcuUyGnJWwyEgnRJTSIZHiT+vMD0kPeD+so0l7mxkMT19g3pjY9GTnHySck/hDzq+dtW/4VgnMkippsQ== - -"@babel/helper-validator-identifier@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.7.tgz#75b889cfaf9e35c2aaf42cf0d72c8e91719251db" - integrity sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w== - -"@babel/helper-validator-option@^7.24.8": - version "7.24.8" - resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.24.8.tgz#3725cdeea8b480e86d34df15304806a06975e33d" - integrity sha512-xb8t9tD1MHLungh/AIoWYN+gVHaB9kwlu8gffXGSt3FFEIT7RjS+xWbc2vUD1UTZdIpKj/ab3rdqJ7ufngyi2Q== - -"@babel/helpers@^7.25.0": - version "7.25.6" - resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.25.6.tgz#57ee60141829ba2e102f30711ffe3afab357cc60" - integrity sha512-Xg0tn4HcfTijTwfDwYlvVCl43V6h4KyVVX2aEm4qdO/PC6L2YvzLHFdmxhoeSA3eslcE6+ZVXHgWwopXYLNq4Q== - dependencies: - "@babel/template" "^7.25.0" - "@babel/types" "^7.25.6" - -"@babel/highlight@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.24.7.tgz#a05ab1df134b286558aae0ed41e6c5f731bf409d" - integrity sha512-EStJpq4OuY8xYfhGVXngigBJRWxftKX9ksiGDnmlY3o7B/V7KIAc9X4oiK87uPJSc/vs5L869bem5fhZa8caZw== - dependencies: - "@babel/helper-validator-identifier" "^7.24.7" +"@babel/helper-module-imports@^7.25.9": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/helper-module-imports/-/helper-module-imports-7.25.9.tgz#e7f8d20602ebdbf9ebbea0a0751fb0f2a4141715" + integrity sha512-tnUA4RsrmflIM6W6RFTLFSXITtl0wKjgpnLgXyowocVPrbYrLUXSBXDgTs8BlbmIzIdlBySRQjINYs2BAkiLtw== + dependencies: + "@babel/traverse" "^7.25.9" + "@babel/types" "^7.25.9" + +"@babel/helper-module-transforms@^7.25.9": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.25.9.tgz#12e4fb2969197ef6d78ea8a2f24375ce85b425fb" + integrity sha512-TvLZY/F3+GvdRYFZFyxMvnsKi+4oJdgZzU3BoGN9Uc2d9C6zfNwJcKKhjqLAhK8i46mv93jsO74fDh3ih6rpHA== + dependencies: + "@babel/helper-module-imports" "^7.25.9" + "@babel/helper-simple-access" "^7.25.9" + "@babel/helper-validator-identifier" "^7.25.9" + "@babel/traverse" "^7.25.9" + +"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.10.4", "@babel/helper-plugin-utils@^7.12.13", "@babel/helper-plugin-utils@^7.14.5", "@babel/helper-plugin-utils@^7.25.9", "@babel/helper-plugin-utils@^7.8.0": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/helper-plugin-utils/-/helper-plugin-utils-7.25.9.tgz#9cbdd63a9443a2c92a725cca7ebca12cc8dd9f46" + integrity sha512-kSMlyUVdWe25rEsRGviIgOWnoT/nfABVWlqt9N19/dIPWViAOW2s9wznP5tURbs/IDuNk4gPy3YdYRgH3uxhBw== + +"@babel/helper-simple-access@^7.25.9": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/helper-simple-access/-/helper-simple-access-7.25.9.tgz#6d51783299884a2c74618d6ef0f86820ec2e7739" + integrity sha512-c6WHXuiaRsJTyHYLJV75t9IqsmTbItYfdj99PnzYGQZkYKvan5/2jKJ7gu31J3/BJ/A18grImSPModuyG/Eo0Q== + dependencies: + "@babel/traverse" "^7.25.9" + "@babel/types" "^7.25.9" + +"@babel/helper-string-parser@^7.25.9": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/helper-string-parser/-/helper-string-parser-7.25.9.tgz#1aabb72ee72ed35789b4bbcad3ca2862ce614e8c" + integrity sha512-4A/SCr/2KLd5jrtOMFzaKjVtAei3+2r/NChoBNoZ3EyP/+GlhoaEGoWOZUmFmoITP7zOJyHIMm+DYRd8o3PvHA== + +"@babel/helper-validator-identifier@^7.25.9": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.25.9.tgz#24b64e2c3ec7cd3b3c547729b8d16871f22cbdc7" + integrity sha512-Ed61U6XJc3CVRfkERJWDz4dJwKe7iLmmJsbOGu9wSloNSFttHV0I8g6UAgb7qnK5ly5bGLPd4oXZlxCdANBOWQ== + +"@babel/helper-validator-option@^7.25.9": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.25.9.tgz#86e45bd8a49ab7e03f276577f96179653d41da72" + integrity sha512-e/zv1co8pp55dNdEcCynfj9X7nyUKUXoUEwfXqaZt0omVOmDe9oOTdKStH4GmAw6zxMFs50ZayuMfHDKlO7Tfw== + +"@babel/helpers@^7.25.9": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.25.9.tgz#9e26aa6fbefdbca4f8c8a1d66dc6f1c00ddadb0a" + integrity sha512-oKWp3+usOJSzDZOucZUAMayhPz/xVjzymyDzUN8dk0Wd3RWMlGLXi07UCQ/CgQVb8LvXx3XBajJH4XGgkt7H7g== + dependencies: + "@babel/template" "^7.25.9" + "@babel/types" "^7.25.9" + +"@babel/highlight@^7.25.9": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.25.9.tgz#8141ce68fc73757946f983b343f1231f4691acc6" + integrity sha512-llL88JShoCsth8fF8R4SJnIn+WLvR6ccFxu1H3FlMhDontdcmZWf2HgIZ7AIqV3Xcck1idlohrN4EUBQz6klbw== + dependencies: + "@babel/helper-validator-identifier" "^7.25.9" chalk "^2.4.2" js-tokens "^4.0.0" picocolors "^1.0.0" -"@babel/parser@^7.1.0", "@babel/parser@^7.14.7", "@babel/parser@^7.20.7", "@babel/parser@^7.23.9", "@babel/parser@^7.25.0", "@babel/parser@^7.25.6": - version "7.25.6" - resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.25.6.tgz#85660c5ef388cbbf6e3d2a694ee97a38f18afe2f" - integrity sha512-trGdfBdbD0l1ZPmcJ83eNxB9rbEax4ALFTF7fN386TMYbeCQbyme5cOEXQhbGXKebwGaB/J52w1mrklMcbgy6Q== +"@babel/parser@^7.1.0", "@babel/parser@^7.14.7", "@babel/parser@^7.20.7", "@babel/parser@^7.23.9", "@babel/parser@^7.25.9": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.25.9.tgz#8fcaa079ac7458facfddc5cd705cc8005e4d3817" + integrity sha512-aI3jjAAO1fh7vY/pBGsn1i9LDbRP43+asrRlkPuTXW5yHXtd1NgTEMudbBoDDxrf1daEEfPJqR+JBMakzrR4Dg== dependencies: - "@babel/types" "^7.25.6" + "@babel/types" "^7.25.9" "@babel/plugin-syntax-async-generators@^7.8.4": version "7.8.4" @@ -165,11 +165,11 @@ "@babel/helper-plugin-utils" "^7.14.5" "@babel/plugin-syntax-import-attributes@^7.24.7": - version "7.25.6" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.25.6.tgz#6d4c78f042db0e82fd6436cd65fec5dc78ad2bde" - integrity sha512-sXaDXaJN9SNLymBdlWFA+bjzBhFD617ZaFiY13dGt7TVslVvVgA6fkZOP7Ki3IGElC45lwHdOTrCtKZGVAWeLQ== + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.25.9.tgz#29c9643445deea4533c05e6ac6c39d15424bbe78" + integrity sha512-u3EN9ub8LyYvgTnrgp8gboElouayiwPdnM7x5tcnW3iSt09/lQYPwMNK40I9IUxo7QOZhAsPHCmmuO7EPdruqg== dependencies: - "@babel/helper-plugin-utils" "^7.24.8" + "@babel/helper-plugin-utils" "^7.25.9" "@babel/plugin-syntax-import-meta@^7.10.4": version "7.10.4" @@ -186,11 +186,11 @@ "@babel/helper-plugin-utils" "^7.8.0" "@babel/plugin-syntax-jsx@^7.7.2": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.24.7.tgz#39a1fa4a7e3d3d7f34e2acc6be585b718d30e02d" - integrity sha512-6ddciUPe/mpMnOKv/U+RSd2vvVy+Yw/JfBB0ZHYjEZt9NLHmCUylNYlsbqCCS1Bffjlb0fCwC9Vqz+sBz6PsiQ== + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.25.9.tgz#a34313a178ea56f1951599b929c1ceacee719290" + integrity sha512-ld6oezHQMZsZfp6pWtbjaNDF2tiiCYYDqQszHt5VV437lewP9aSi2Of99CK0D0XB21k7FLgnLcmQKyKzynfeAA== dependencies: - "@babel/helper-plugin-utils" "^7.24.7" + "@babel/helper-plugin-utils" "^7.25.9" "@babel/plugin-syntax-logical-assignment-operators@^7.10.4": version "7.10.4" @@ -249,49 +249,48 @@ "@babel/helper-plugin-utils" "^7.14.5" "@babel/plugin-syntax-typescript@^7.7.2": - version "7.25.4" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.25.4.tgz#04db9ce5a9043d9c635e75ae7969a2cd50ca97ff" - integrity sha512-uMOCoHVU52BsSWxPOMVv5qKRdeSlPuImUCB2dlPuBSU+W2/ROE7/Zg8F2Kepbk+8yBa68LlRKxO+xgEVWorsDg== + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.25.9.tgz#67dda2b74da43727cf21d46cf9afef23f4365399" + integrity sha512-hjMgRy5hb8uJJjUcdWunWVcoi9bGpJp8p5Ol1229PoN6aytsLwNMgmdftO23wnCLMfVmTwZDWMPNq/D1SY60JQ== dependencies: - "@babel/helper-plugin-utils" "^7.24.8" + "@babel/helper-plugin-utils" "^7.25.9" "@babel/runtime@^7.0.0": - version "7.25.6" - resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.25.6.tgz#9afc3289f7184d8d7f98b099884c26317b9264d2" - integrity sha512-VBj9MYyDb9tuLq7yzqjgzt6Q+IBQLrGZfdjOekyEirZPHxXWoTSGUTMrpsfi58Up73d13NfYLv8HT9vmznjzhQ== + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.25.9.tgz#65884fd6dc255a775402cc1d9811082918f4bf00" + integrity sha512-4zpTHZ9Cm6L9L+uIqghQX8ZXg8HKFcjYO3qHoO8zTmRm6HQUJ8SSJ+KRvbMBZn0EGVlT4DRYeQ/6hjlyXBh+Kg== dependencies: regenerator-runtime "^0.14.0" -"@babel/template@^7.25.0", "@babel/template@^7.3.3": - version "7.25.0" - resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.25.0.tgz#e733dc3134b4fede528c15bc95e89cb98c52592a" - integrity sha512-aOOgh1/5XzKvg1jvVz7AVrx2piJ2XBi227DHmbY6y+bM9H2FlN+IfecYu4Xl0cNiiVejlsCri89LUsbj8vJD9Q== - dependencies: - "@babel/code-frame" "^7.24.7" - "@babel/parser" "^7.25.0" - "@babel/types" "^7.25.0" - -"@babel/traverse@^7.24.7", "@babel/traverse@^7.25.2": - version "7.25.6" - resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.25.6.tgz#04fad980e444f182ecf1520504941940a90fea41" - integrity sha512-9Vrcx5ZW6UwK5tvqsj0nGpp/XzqthkT0dqIc9g1AdtygFToNtTF67XzYS//dm+SAK9cp3B9R4ZO/46p63SCjlQ== - dependencies: - "@babel/code-frame" "^7.24.7" - "@babel/generator" "^7.25.6" - "@babel/parser" "^7.25.6" - "@babel/template" "^7.25.0" - "@babel/types" "^7.25.6" +"@babel/template@^7.25.9", "@babel/template@^7.3.3": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.25.9.tgz#ecb62d81a8a6f5dc5fe8abfc3901fc52ddf15016" + integrity sha512-9DGttpmPvIxBb/2uwpVo3dqJ+O6RooAFOS+lB+xDqoE2PVCE8nfoHMdZLpfCQRLwvohzXISPZcgxt80xLfsuwg== + dependencies: + "@babel/code-frame" "^7.25.9" + "@babel/parser" "^7.25.9" + "@babel/types" "^7.25.9" + +"@babel/traverse@^7.25.9": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.25.9.tgz#a50f8fe49e7f69f53de5bea7e413cd35c5e13c84" + integrity sha512-ZCuvfwOwlz/bawvAuvcj8rrithP2/N55Tzz342AkTvq4qaWbGfmCk/tKhNaV2cthijKrPAA8SRJV5WWe7IBMJw== + dependencies: + "@babel/code-frame" "^7.25.9" + "@babel/generator" "^7.25.9" + "@babel/parser" "^7.25.9" + "@babel/template" "^7.25.9" + "@babel/types" "^7.25.9" debug "^4.3.1" globals "^11.1.0" -"@babel/types@^7.0.0", "@babel/types@^7.20.7", "@babel/types@^7.24.7", "@babel/types@^7.25.0", "@babel/types@^7.25.2", "@babel/types@^7.25.6", "@babel/types@^7.3.3": - version "7.25.6" - resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.25.6.tgz#893942ddb858f32ae7a004ec9d3a76b3463ef8e6" - integrity sha512-/l42B1qxpG6RdfYf343Uw1vmDjeNhneUXtzhojE7pDgfpEypmRhI6j1kr17XCVv4Cgl9HdAiQY2x0GwKm7rWCw== +"@babel/types@^7.0.0", "@babel/types@^7.20.7", "@babel/types@^7.25.9", "@babel/types@^7.3.3": + version "7.25.9" + resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.25.9.tgz#620f35ea1f4233df529ec9a2668d2db26574deee" + integrity sha512-OwS2CM5KocvQ/k7dFJa8i5bNGJP0hXWfVCfDkqRFP1IreH1JDC7wG6eCYCi0+McbfT8OR/kNqsI0UU0xP9H6PQ== dependencies: - "@babel/helper-string-parser" "^7.24.8" - "@babel/helper-validator-identifier" "^7.24.7" - to-fast-properties "^2.0.0" + "@babel/helper-string-parser" "^7.25.9" + "@babel/helper-validator-identifier" "^7.25.9" "@bcoe/v8-coverage@^0.2.3": version "0.2.3" @@ -665,9 +664,9 @@ form-data "^4.0.0" "@types/node@*": - version "22.7.4" - resolved "https://registry.yarnpkg.com/@types/node/-/node-22.7.4.tgz#e35d6f48dca3255ce44256ddc05dee1c23353fcc" - integrity sha512-y+NPi1rFzDs1NdQHHToqeiX2TIS79SWEAw9GYhkkx8bD0ChpfqC+n2j5OXOCpzfojBEBt6DnEnnG9MY0zk1XLg== + version "22.7.9" + resolved "https://registry.yarnpkg.com/@types/node/-/node-22.7.9.tgz#2bf2797b5e84702d8262ea2cf843c3c3c880d0e9" + integrity sha512-jrTfRC7FM6nChvU7X2KqcrgquofrWLFDeYC1hKfwNWomVvrn7JIksqf344WN2X/y8xrgqBd2dJATZV4GbatBfg== dependencies: undici-types "~6.19.2" @@ -682,9 +681,9 @@ integrity sha512-u95svzDlTysU5xecFNTgfFG5RUWu1A9P0VzgpcIiGZA9iraHOdSzcxMxQ55DyeRaGCSxQi7LxXDI4rzq/MYfdg== "@types/readable-stream@^4.0.15": - version "4.0.15" - resolved "https://registry.yarnpkg.com/@types/readable-stream/-/readable-stream-4.0.15.tgz#e6ec26fe5b02f578c60baf1fa9452e90957d2bfb" - integrity sha512-oAZ3kw+kJFkEqyh7xORZOku1YAKvsFTogRY8kVl4vHpEKiDkfnSA/My8haRE7fvmix5Zyy+1pwzOi7yycGLBJw== + version "4.0.16" + resolved "https://registry.yarnpkg.com/@types/readable-stream/-/readable-stream-4.0.16.tgz#491ea991b327b1d62d4092fb22893e0d7e30c8f1" + integrity sha512-Fvp+8OcU8PyV90KTk5tR/rI8OjD3MP5NUow5rjOsZo+9zxf4p4soJtK9j4V6yeG30TH6rZxqRaP4JLa8lNNTNQ== dependencies: "@types/node" "*" safe-buffer "~5.1.1" @@ -892,9 +891,9 @@ acorn-walk@^8.0.2: acorn "^8.11.0" acorn@^8.1.0, acorn@^8.11.0, acorn@^8.7.1, acorn@^8.8.1, acorn@^8.8.2: - version "8.12.1" - resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.12.1.tgz#71616bdccbe25e27a54439e0046e89ca76df2248" - integrity sha512-tcpGyI9zbizT9JbV6oYE477V6mTlXvvi0T0G3SNIYE2apm/G5huBa1+K89VGeovbg+jycCrfhl3ADxErOuO6Jg== + version "8.13.0" + resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.13.0.tgz#2a30d670818ad16ddd6a35d3842dacec9e5d7ca3" + integrity sha512-8zSiw54Oxrdym50NlZ9sUusyO1Z1ZchgRLWRaK6c86XJFClyCgFKetdowBg5bKxyp/u+CDBJG4Mpp0m3HLZl9w== agent-base@6: version "6.0.2" @@ -1057,15 +1056,15 @@ braces@^3.0.3: dependencies: fill-range "^7.1.1" -browserslist@^4.21.10, browserslist@^4.23.1: - version "4.24.0" - resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.24.0.tgz#a1325fe4bc80b64fda169629fc01b3d6cecd38d4" - integrity sha512-Rmb62sR1Zpjql25eSanFGEhAxcFwfA1K0GuQcLoaJBAcENegrQut3hYdhXFF1obQfiDyqIW/cLM5HSJ/9k884A== +browserslist@^4.21.10, browserslist@^4.24.0: + version "4.24.2" + resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.24.2.tgz#f5845bc91069dbd55ee89faf9822e1d885d16580" + integrity sha512-ZIc+Q62revdMcqC6aChtW4jz3My3klmCO1fEmINZY/8J3EpBg5/A/D0AKmBveUh6pgoeycoMkVMko84tuYS+Gg== dependencies: - caniuse-lite "^1.0.30001663" - electron-to-chromium "^1.5.28" + caniuse-lite "^1.0.30001669" + electron-to-chromium "^1.5.41" node-releases "^2.0.18" - update-browserslist-db "^1.1.0" + update-browserslist-db "^1.1.1" bs-logger@0.x: version "0.2.6" @@ -1120,10 +1119,10 @@ camelcase@^6.2.0: resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-6.3.0.tgz#5685b95eb209ac9c0c177467778c9c84df58ba9a" integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA== -caniuse-lite@^1.0.30001663: - 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== +caniuse-lite@^1.0.30001669: + version "1.0.30001669" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001669.tgz#fda8f1d29a8bfdc42de0c170d7f34a9cf19ed7a3" + integrity sha512-DlWzFDJqstqtIVx1zeSpIMLjunf5SmwOw0N2Ck/QSQdS8PLS4+9HrLaYei4w8BIAL7IB/UEDu889d8vhCTPA0w== chalk@^2.4.2: version "2.4.2" @@ -1333,10 +1332,10 @@ domexception@^4.0.0: dependencies: webidl-conversions "^7.0.0" -electron-to-chromium@^1.5.28: - 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== +electron-to-chromium@^1.5.41: + version "1.5.45" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.45.tgz#fa592ce6a88b44d23acbc7453a2feab98996e6c9" + integrity sha512-vOzZS6uZwhhbkZbcRyiy99Wg+pYFV5hk+5YaECvx0+Z31NR3Tt5zS6dze2OepT6PCTzVzT0dIJItti+uAW5zmw== emittery@^0.13.1: version "0.13.1" @@ -1356,7 +1355,7 @@ enhanced-resolve@^5.0.0, enhanced-resolve@^5.17.1: graceful-fs "^4.2.4" tapable "^2.2.0" -entities@^4.4.0: +entities@^4.5.0: version "4.5.0" resolved "https://registry.yarnpkg.com/entities/-/entities-4.5.0.tgz#5d268ea5e7113ec74c4d033b79ea5a35a488fb48" integrity sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw== @@ -1548,9 +1547,9 @@ form-data-encoder@^4.0.2: integrity sha512-KQVhvhK8ZkWzxKxOr56CPulAhH3dobtuQ4+hNQ+HekH/Wp5gSOafqRAeTphQUJAIk0GBvHZgJ2ZGRWd5kphMuw== form-data@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/form-data/-/form-data-4.0.0.tgz#93919daeaf361ee529584b9b31664dc12c9fa452" - integrity sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww== + version "4.0.1" + resolved "https://registry.yarnpkg.com/form-data/-/form-data-4.0.1.tgz#ba1076daaaa5bfd7e99c1a6cb02aa0a5cff90d48" + integrity sha512-tzN8e4TX8+kkxGPK8D5u0FNmjPUjw3lwC9lSLxxoB/+GtsJG91CO8bSWy73APlgAZzZbXEYZJuxjkHH2w+Ezhw== dependencies: asynckit "^0.4.0" combined-stream "^1.0.8" @@ -2273,10 +2272,10 @@ jsdom@^20.0.0: ws "^8.11.0" xml-name-validator "^4.0.0" -jsesc@^2.5.1: - version "2.5.2" - resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-2.5.2.tgz#80564d2e483dacf6e8ef209650a67df3f0c283a4" - integrity sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA== +jsesc@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-3.0.2.tgz#bb8b09a6597ba426425f2e4a07245c3d00b9343e" + integrity sha512-xKqzzWXDttJuOcawBt4KnKHHIf5oQ/Cxax+0PWFG+DFDgHNAdi+TXECADI+RYiFUMmx8792xsMbbgXj4CwnP4g== json-parse-even-better-errors@^2.3.0, json-parse-even-better-errors@^2.3.1: version "2.3.1" @@ -2503,11 +2502,11 @@ parse-json@^5.2.0: lines-and-columns "^1.1.6" parse5@^7.0.0, parse5@^7.1.1: - version "7.1.2" - resolved "https://registry.yarnpkg.com/parse5/-/parse5-7.1.2.tgz#0736bebbfd77793823240a23b7fc5e010b7f8e32" - integrity sha512-Czj1WaSVpaoj0wbhMzLmWD69anp2WH7FXMB9n1Sy8/ZFF9jolSQVMu1Ij5WIyGmcBmhk7EOndpO4mIpihVqAXw== + version "7.2.0" + resolved "https://registry.yarnpkg.com/parse5/-/parse5-7.2.0.tgz#8a0591ce9b7c5e2027173ab737d4d3fc3d826fab" + integrity sha512-ZkDsAOcxsUMZ4Lz5fVciOehNcJ+Gb8gTzcA4yl3wnc273BAybYWrQ+Ks/OjCjSEpjvQkDSeZbybK9qj2VHHdGA== dependencies: - entities "^4.4.0" + entities "^4.5.0" path-exists@^4.0.0: version "4.0.0" @@ -2535,9 +2534,9 @@ path-to-regexp@^2.2.1: integrity sha512-G6zHoVqC6GGTQkZwF4lkuEyMbVOjoBKAEybQUypI1WTkqinCOrq2x6U2+phkJ1XsEMTy4LjtwPI7HW+NVrRR2w== picocolors@^1.0.0, picocolors@^1.1.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/picocolors/-/picocolors-1.1.0.tgz#5358b76a78cde483ba5cef6a9dc9671440b27d59" - integrity sha512-TQ92mBOW0l3LeMeyLV6mzy/kWr8lkd/hp3mTg7wYK7zJhuBStmGMBG0BdeDZS/dZx1IukaX6Bk11zcln25o1Aw== + version "1.1.1" + resolved "https://registry.yarnpkg.com/picocolors/-/picocolors-1.1.1.tgz#3d321af3eab939b083c8f929a1d12cda81c26b6b" + integrity sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA== picomatch@^2.0.4, picomatch@^2.2.3, picomatch@^2.3.1: version "2.3.1" @@ -2908,9 +2907,9 @@ terser-webpack-plugin@^5.3.10: terser "^5.26.0" terser@^5.26.0: - version "5.34.1" - resolved "https://registry.yarnpkg.com/terser/-/terser-5.34.1.tgz#af40386bdbe54af0d063e0670afd55c3105abeb6" - integrity sha512-FsJZ7iZLd/BXkz+4xrRTGJ26o/6VTjQytUk8b8OxkwcD2I+79VPJlz7qss1+zE7h8GNIScFqXcDyJ/KqBYZFVA== + version "5.36.0" + resolved "https://registry.yarnpkg.com/terser/-/terser-5.36.0.tgz#8b0dbed459ac40ff7b4c9fd5a3a2029de105180e" + integrity sha512-IYV9eNMuFAV4THUspIRXkLakHnV6XO7FEdtKjf/mDyrnqUg9LnlOn6/RwRvM9SZjR4GUq8Nk8zj67FzVARr74w== dependencies: "@jridgewell/source-map" "^0.3.3" acorn "^8.8.2" @@ -2931,11 +2930,6 @@ tmpl@1.0.5: resolved "https://registry.yarnpkg.com/tmpl/-/tmpl-1.0.5.tgz#8683e0b902bb9c20c4f726e3c0b69f36518c07cc" integrity sha512-3f0uOEAQwIqGuWW2MVzYg8fV/QNnc/IpuJNG837rLuczAaLVHslWHZQj4IGiEl5Hs3kkbhwL9Ab7Hrsmuj+Smw== -to-fast-properties@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/to-fast-properties/-/to-fast-properties-2.0.0.tgz#dc5e698cbd079265bc73e0377681a4e4e83f616e" - integrity sha512-/OaKK0xYrs3DmxRYqL/yDc+FxFUVYhDlXMhRmv3z915w2HF1tnN1omB354j8VUGO/hbRzyD6Y3sA7v7GS/ceog== - to-regex-range@^5.0.1: version "5.0.1" resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" @@ -3022,7 +3016,7 @@ universalify@^0.2.0: resolved "https://registry.yarnpkg.com/universalify/-/universalify-0.2.0.tgz#6451760566fa857534745ab1dde952d1b1761be0" integrity sha512-CJ1QgKmNg3CwvAv/kOFmtnEN05f0D/cn9QntgNOQlQF9dgvVTHj3t+8JPdjqawCHk7V/KA+fbUqzZ9XWhcqPUg== -update-browserslist-db@^1.1.0: +update-browserslist-db@^1.1.1: version "1.1.1" resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.1.1.tgz#80846fba1d79e82547fb661f8d141e0945755fe5" integrity sha512-R8UzCaa9Az+38REPiJ1tXlImTJXlVfgHZsglwBD/k6nj76ctsH1E3q4doGrukiLQd3sGQYu56r5+lo5r94l29A==