hume 0.9.9 → 0.9.11

package/.mock/definition/empathic-voice/__package__.yml

@@ -19,6 +19,7 @@ types:
     docs: >-
       Type of Tool. Either `BUILTIN` for natively implemented tools, like web
       search, or `FUNCTION` for user-defined tools.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnUserDefinedToolVersionType:
@@ -28,6 +29,7 @@ types:
     docs: >-
       Versioning method for a Tool. Either `FIXED` for using a fixed version
       number or `LATEST` for auto-updating to the latest version.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnUserDefinedTool:
@@ -106,6 +108,7 @@ types:
     docs: >-
       Versioning method for a Prompt. Either `FIXED` for using a fixed version
       number or `LATEST` for auto-updating to the latest version.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnPrompt:
@@ -164,7 +167,7 @@ types:
 
 
           For help writing a system prompt, see our [Prompting
-          Guide](/docs/empathic-voice-interface-evi/prompting).
+          Guide](/docs/empathic-voice-interface-evi/guides/prompting).
     source:
       openapi: stenographer-openapi.json
   PostedCustomVoiceBaseVoice:
@@ -178,6 +181,7 @@ types:
       - STELLA
       - SUNNY
     docs: Specifies the base voice used to create the Custom Voice.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   PostedCustomVoiceParameters:
@@ -298,7 +302,7 @@ types:
       [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.
+       See our [Voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for a tutorial on how to craft a Custom Voice.
     properties:
       name:
         type: string
@@ -337,6 +341,7 @@ types:
       - STELLA
       - SUNNY
     docs: The base voice used to create the Custom Voice.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnCustomVoiceParameters:
@@ -512,7 +517,8 @@ types:
 
 
       For more information, see our guide on [using built-in
-      tools](/docs/empathic-voice-interface-evi/tool-use#using-built-in-tools).
+      tools](/docs/empathic-voice-interface-evi/features/tool-use#using-built-in-tools).
+    inline: true
     source:
       openapi: stenographer-openapi.json
   PostedBuiltinTool:
@@ -533,7 +539,7 @@ types:
 
 
           For more information, see our guide on [using built-in
-          tools](/docs/empathic-voice-interface-evi/tool-use#using-built-in-tools).
+          tools](/docs/empathic-voice-interface-evi/features/tool-use#using-built-in-tools).
       fallback_content:
         type: optional<string>
         docs: >-
@@ -642,6 +648,7 @@ types:
       - GROQ
       - GOOGLE
     docs: The provider of the supplemental language model.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   PostedLanguageModelModelResource:
@@ -698,6 +705,7 @@ types:
         name: AccountsFireworksModelsLlamaV3P18BInstruct
       - ellm
     docs: String that specifies the language model to use with `model_provider`.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   PostedLanguageModel:
@@ -847,6 +855,7 @@ types:
     docs: >-
       The provider of the voice to use. Supported values are `HUME_AI` and
       `CUSTOM_VOICE`.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   PostedVoice:
@@ -880,6 +889,7 @@ types:
       - chat_started
       - chat_ended
     docs: Events this URL is subscribed to
+    inline: true
     source:
       openapi: stenographer-openapi.json
   PostedWebhookSpec:
@@ -887,9 +897,18 @@ types:
     properties:
       url:
         type: string
-        docs: URL to send the webhook to
+        docs: >-
+          The URL where event payloads will be sent. This must be a valid https
+          URL to ensure secure communication. The server at this URL must accept
+          POST requests with a JSON payload.
       events:
-        docs: Events this URL is subscribed to
+        docs: >-
+          The list of events the specified URL is subscribed to. 
+
+
+          See our [webhooks
+          guide](/docs/empathic-voice-interface-evi/configuration/build-a-configuration#supported-events)
+          for more information on supported events.
         type: list<PostedWebhookEventType>
     source:
       openapi: stenographer-openapi.json
@@ -900,6 +919,7 @@ types:
     docs: >-
       Type of Tool. Either `BUILTIN` for natively implemented tools, like web
       search, or `FUNCTION` for user-defined tools.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnBuiltinTool:
@@ -948,7 +968,7 @@ types:
           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).
+          [guide](/docs/empathic-voice-interface-evi/configuration/evi-version).
       version_description:
         type: optional<string>
         docs: An optional description of the Config version.
@@ -1083,6 +1103,7 @@ types:
       - GROQ
       - GOOGLE
     docs: The provider of the supplemental language model.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnLanguageModelModelResource:
@@ -1143,6 +1164,7 @@ types:
         name: AccountsFireworksModelsLlamaV3P18BInstruct
       - ellm
     docs: String that specifies the language model to use with `model_provider`.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnLanguageModel:
@@ -1224,6 +1246,7 @@ types:
     docs: >-
       The provider of the voice to use. Supported values are `HUME_AI` and
       `CUSTOM_VOICE`.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnVoice:
@@ -1251,6 +1274,7 @@ types:
       - chat_started
       - chat_ended
     docs: Events this URL is subscribed to
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnWebhookSpec:
@@ -1258,9 +1282,18 @@ types:
     properties:
       url:
         type: string
-        docs: Webhook URL to send the event updates to
+        docs: >-
+          The URL where event payloads will be sent. This must be a valid https
+          URL to ensure secure communication. The server at this URL must accept
+          POST requests with a JSON payload.
       events:
-        docs: Events this URL is subscribed to
+        docs: >-
+          The list of events the specified URL is subscribed to. 
+
+
+          See our [webhooks
+          guide](/docs/empathic-voice-interface-evi/configuration/build-a-configuration#supported-events)
+          for more information on supported events.
         type: list<ReturnWebhookEventType>
     source:
       openapi: stenographer-openapi.json
@@ -1407,6 +1440,7 @@ types:
 
 
       - `ERROR`: The chat ended unexpectedly due to an error.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnChat:
@@ -1499,6 +1533,7 @@ types:
       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.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnPagedChats:
@@ -1562,6 +1597,7 @@ types:
 
 
       - `TOOL`: The function calling mechanism.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnChatEventType:
@@ -1594,6 +1630,7 @@ types:
 
 
       - `FUNCTION_CALL_RESPONSE`: Contains the tool response.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnChatEvent:
@@ -1702,6 +1739,7 @@ types:
 
 
       - `ERROR`: The chat ended unexpectedly due to an error.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnChatPagedEventsPaginationDirection:
@@ -1717,6 +1755,7 @@ types:
       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.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnChatPagedEvents:
@@ -1830,6 +1869,7 @@ types:
 
 
       - `CANCELED`: The reconstruction job has been canceled.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnChatAudioReconstruction:
@@ -1929,6 +1969,7 @@ types:
       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.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnPagedChatGroups:
@@ -1984,6 +2025,7 @@ types:
       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.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnChatGroupPagedChats:
@@ -2062,6 +2104,7 @@ types:
       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.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnChatGroupPagedEvents:
@@ -2122,6 +2165,7 @@ types:
       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.
+    inline: true
     source:
       openapi: stenographer-openapi.json
   ReturnChatGroupPagedAudioReconstructions:
@@ -2408,8 +2452,7 @@ types:
 
 
           For more information, please refer to the [Session Settings
-          section](/docs/empathic-voice-interface-evi/configuration#session-settings)
-          on the EVI Configuration page.
+          guide](/docs/empathic-voice-interface-evi/configuration/session-settings).
       custom_session_id:
         type: optional<string>
         docs: >-
@@ -2426,8 +2469,8 @@ types:
           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.
+          model](/docs/empathic-voice-interface-evi/guides/custom-language-model)
+          with EVI to learn more.
       system_prompt:
         type: optional<string>
         docs: >-
@@ -2449,7 +2492,7 @@ types:
 
 
           For help writing a system prompt, see our [Prompting
-          Guide](/docs/empathic-voice-interface-evi/prompting).
+          Guide](/docs/empathic-voice-interface-evi/guides/prompting).
       context:
         type: optional<Context>
         docs: >-
@@ -2475,8 +2518,7 @@ types:
           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.
+          guide](/docs/empathic-voice-interface-evi/configuration/session-settings).
       language_model_api_key:
         type: optional<string>
         docs: >-
@@ -2496,7 +2538,7 @@ types:
           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).
+          Guide](/docs/empathic-voice-interface-evi/features/tool-use).
       builtin_tools:
         type: optional<list<BuiltinToolConfig>>
         docs: >-
@@ -2507,7 +2549,7 @@ types:
           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).
+          Guide](/docs/empathic-voice-interface-evi/features/tool-use).
 
 
           Currently, the only built-in tool Hume provides is **Web Search**.
@@ -2532,7 +2574,7 @@ types:
           Using this field, you can personalize responses based on
           session-specific details. For more guidance, see our [guide on using
           dynamic
-          variables](/docs/empathic-voice-interface-evi/conversational-controls#dynamic-variables).
+          variables](/docs/empathic-voice-interface-evi/features/dynamic-variables).
     source:
       openapi: assistant-asyncapi.json
   Tool:
@@ -3190,3 +3232,106 @@ types:
       type: string
     source:
       openapi: assistant-openapi.json
+  WebhookEventChatEnded:
+    properties:
+      event_name:
+        type: optional<literal<"chat_ended">>
+        docs: Always `chat_ended`.
+      end_time:
+        type: integer
+        docs: Unix timestamp (in milliseconds) indicating when the session ended.
+      duration_seconds:
+        type: integer
+        docs: Total duration of the session in seconds.
+      end_reason:
+        type: WebhookEventChatStatus
+        docs: Reason for the session's termination.
+      caller_number:
+        type: optional<string>
+        docs: >-
+          Phone number of the caller in E.164 format (e.g., `+12223333333`).
+          This field is included only if the Chat was created via the [Twilio
+          phone
+          calling](/docs/empathic-voice-interface-evi/guides/phone-calling)
+          integration.
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          User-defined session ID. Relevant only when employing a [custom
+          language
+          model](/docs/empathic-voice-interface-evi/guides/custom-language-model)
+          in the EVI Config.
+    extends:
+      - WebhookEventBase
+    source:
+      openapi: assistant-openapi.json
+  WebhookEventChatStartType:
+    enum:
+      - new_chat_group
+      - resumed_chat_group
+    source:
+      openapi: assistant-openapi.json
+  WebhookEventChatStarted:
+    properties:
+      event_name:
+        type: optional<literal<"chat_started">>
+        docs: Always `chat_started`.
+      start_time:
+        type: integer
+        docs: Unix timestamp (in milliseconds) indicating when the session started.
+      chat_start_type:
+        type: WebhookEventChatStartType
+        docs: >-
+          Indicates whether the chat is the first in a new Chat Group
+          (`new_chat_group`) or the continuation of an existing chat group
+          (`resumed_chat_group`).
+      caller_number:
+        type: optional<string>
+        docs: >-
+          Phone number of the caller in E.164 format (e.g., `+12223333333`).
+          This field is included only if the Chat was created via the [Twilio
+          phone
+          calling](/docs/empathic-voice-interface-evi/guides/phone-calling)
+          integration.
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          User-defined session ID. Relevant only when employing a [custom
+          language
+          model](/docs/empathic-voice-interface-evi/guides/custom-language-model)
+          in the EVI Config.
+    extends:
+      - WebhookEventBase
+    source:
+      openapi: assistant-openapi.json
+  WebhookEventChatStatus:
+    enum:
+      - ACTIVE
+      - USER_ENDED
+      - USER_TIMEOUT
+      - INACTIVITY_TIMEOUT
+      - MAX_DURATION_TIMEOUT
+      - ERROR
+    source:
+      openapi: assistant-openapi.json
+  WebhookEvent:
+    discriminated: false
+    union:
+      - WebhookEventChatStarted
+      - WebhookEventChatEnded
+    source:
+      openapi: assistant-openapi.json
+  WebhookEventBase:
+    docs: Represents the fields common to all webhook events.
+    properties:
+      chat_group_id:
+        type: string
+        docs: Unique ID of the **Chat Group** associated with the **Chat** session.
+      chat_id:
+        type: string
+        docs: Unique ID of the **Chat** session.
+      config_id:
+        type: optional<string>
+        docs: Unique ID of the EVI **Config** used for the session.
+    source:
+      openapi: assistant-openapi.json

package/.mock/definition/empathic-voice/chat.yml

@@ -1,5 +1,6 @@
 channel:
   path: /v0/evi/chat
+  url: prod
   auth: false
   query-parameters:
     config_id:
@@ -11,7 +12,7 @@ channel:
         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).
+        settings](/docs/empathic-voice-interface-evi/configuration/build-a-configuration#default-configuration).
 
 
         For help obtaining this ID, see our [Configuration
@@ -76,6 +77,7 @@ channel:
         list of all available chat groups.
     verbose_transcription:
       type: optional<boolean>
+      default: false
       docs: >-
         A flag to enable verbose transcription. Set this query parameter to
         `true` to have unfinalized user transcripts be sent to the client as
@@ -86,6 +88,7 @@ channel:
         denotes whether the message is "interim" or "final."
     access_token:
       type: optional<string>
+      default: ''
       docs: >-
         Access token used for authenticating the client. If not provided, an
         `api_key` must be provided to authenticate.
@@ -100,6 +103,7 @@ channel:
         Guide](/docs/introduction/api-key#authentication-strategies).
     api_key:
       type: optional<string>
+      default: ''
       docs: >-
         API key used for authenticating the client. If not provided, an
         `access_token` must be provided to authenticate.

package/.mock/definition/empathic-voice/chatGroups.yml

@@ -57,6 +57,7 @@ service:
       response:
         docs: Success
         type: root.ReturnPagedChatGroups
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -127,6 +128,7 @@ service:
       response:
         docs: Success
         type: root.ReturnChatGroupPagedChats
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -153,6 +155,8 @@ service:
                   start_timestamp: 1712334213647
                   end_timestamp: 1712334332571
                   event_count: 0
+                  metadata: null
+                  config: null
               active: false
     list-chat-group-events:
       path: /v0/evi/chat_groups/{id}/events
@@ -203,6 +207,7 @@ service:
       response:
         docs: Success
         type: root.ReturnChatGroupPagedEvents
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -580,6 +585,7 @@ service:
       response:
         docs: Success
         type: root.ReturnChatGroupPagedAudioReconstructions
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:

package/.mock/definition/empathic-voice/chatWebhooks.yml

@@ -0,0 +1,32 @@
+imports:
+  root: __package__.yml
+webhooks:
+  chatEnded:
+    method: POST
+    display-name: Chat Ended
+    headers: {}
+    payload: root.WebhookEventChatEnded
+    examples:
+      - payload:
+          chat_group_id: 9fc18597-3567-42d5-94d6-935bde84bf2f
+          chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0
+          config_id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
+          event_name: chat_ended
+          end_time: 1716244958546
+          duration_seconds: 180
+          end_reason: USER_ENDED
+    docs: Sent when an EVI chat ends.
+  chatStarted:
+    method: POST
+    display-name: Chat Started
+    headers: {}
+    payload: root.WebhookEventChatStarted
+    examples:
+      - payload:
+          chat_group_id: 9fc18597-3567-42d5-94d6-935bde84bf2f
+          chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0
+          config_id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
+          event_name: chat_started
+          start_time: 1716244940648
+          chat_start_type: new_chat_group
+    docs: Sent when an EVI chat is started.

package/.mock/definition/empathic-voice/chats.yml

@@ -55,6 +55,7 @@ service:
       response:
         docs: Success
         type: root.ReturnPagedChats
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -129,6 +130,7 @@ service:
       response:
         docs: Success
         type: root.ReturnChatPagedEvents
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -482,6 +484,7 @@ service:
       response:
         docs: Success
         type: root.ReturnChatAudioReconstruction
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:

package/.mock/definition/empathic-voice/configs.yml

@@ -54,6 +54,7 @@ service:
       response:
         docs: Success
         type: root.ReturnPagedConfigs
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -159,7 +160,7 @@ service:
                 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).
+                [guide](/docs/empathic-voice-interface-evi/configuration/evi-version).
             name:
               type: string
               docs: Name applied to all versions of a particular Config.
@@ -205,6 +206,7 @@ service:
       response:
         docs: Created
         type: root.ReturnConfig
+        status-code: 201
       errors:
         - root.BadRequestError
       examples:
@@ -353,6 +355,7 @@ service:
       response:
         docs: Success
         type: root.ReturnPagedConfigs
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -501,6 +504,7 @@ service:
       response:
         docs: Created
         type: root.ReturnConfig
+        status-code: 201
       errors:
         - root.BadRequestError
       examples:
@@ -654,6 +658,7 @@ service:
       response:
         docs: Success
         type: text
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -697,6 +702,7 @@ service:
       response:
         docs: Success
         type: root.ReturnConfig
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -857,6 +863,7 @@ service:
       response:
         docs: Success
         type: root.ReturnConfig
+        status-code: 200
       errors:
         - root.BadRequestError
       examples: