hume 0.12.1 → 0.13.0

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

@@ -6,29 +6,15 @@ errors:
     examples:
       - value: {}
 types:
-  AssistantEnd:
-    docs: When provided, the output is an assistant end message.
-    properties:
-      custom_session_id:
-        type: optional<string>
-        docs: >-
-          Used to manage conversational state, correlate frontend and backend
-          data, and persist conversations across EVI sessions.
-      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.
-    source:
-      openapi: evi-asyncapi.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<string>
         docs: >-
@@ -47,84 +33,16 @@ types:
           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.AssistantMessage.type).
-      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.
-    source:
-      openapi: evi-asyncapi.json
-  AssistantMessage:
-    docs: When provided, the output is an assistant message.
-    properties:
-      custom_session_id:
-        type: optional<string>
-        docs: >-
-          Used to manage conversational state, correlate frontend and backend
-          data, and persist conversations across EVI sessions.
-      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.AssistantInput.text).
-      id:
-        type: optional<string>
-        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.
-      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.
-    source:
-      openapi: evi-asyncapi.json
-  AssistantProsody:
-    docs: When provided, the output is an Assistant Prosody message.
-    properties:
-      custom_session_id:
-        type: optional<string>
-        docs: >-
-          Used to manage conversational state, correlate frontend and backend
-          data, and persist conversations across EVI sessions.
-      id:
-        type: optional<string>
-        docs: Unique identifier for the segment.
-      models:
-        type: Inference
-        docs: Inference model results.
-      type:
-        type: literal<"assistant_prosody">
-        docs: >-
-          The type of message sent through the socket; for an Assistant Prosody
-          message, this must be `assistant_PROSODY`.
-
-
-          This message the expression measurement predictions of the assistant's
-          audio output.
     source:
       openapi: evi-asyncapi.json
   AudioConfiguration:
     properties:
-      channels:
-        type: integer
-        docs: Number of audio channels.
       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: >-
@@ -135,6 +53,17 @@ types:
   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<string>
         docs: >-
@@ -157,48 +86,6 @@ types:
 
           Hume recommends streaming audio with a buffer window of 20
           milliseconds (ms), or 100 milliseconds (ms) for web applications.
-      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.
-    source:
-      openapi: evi-asyncapi.json
-  AudioOutput:
-    docs: >-
-      The type of message sent through the socket; for an Audio Output message,
-      this must be `audio_output`.
-    properties:
-      custom_session_id:
-        type: optional<string>
-        docs: >-
-          Used to manage conversational state, correlate frontend and backend
-          data, and persist conversations across EVI sessions.
-      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.
-      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.
-      type:
-        type: literal<"audio_output">
-        docs: >-
-          The type of message sent through the socket; for an Audio Output
-          message, this must be `audio_output`.
     source:
       openapi: evi-asyncapi.json
   BuiltInTool:
@@ -212,87 +99,31 @@ types:
       openapi: evi-asyncapi.json
   BuiltinToolConfig:
     properties:
+      name:
+        type: BuiltInTool
       fallback_content:
         type: optional<string>
         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.
-      name:
-        type: BuiltInTool
-    source:
-      openapi: evi-asyncapi.json
-  ChatMessageToolResult:
-    discriminated: false
-    docs: Function call response from client.
-    union:
-      - type: ToolResponseMessage
-      - type: ToolErrorMessage
-    source:
-      openapi: evi-asyncapi.json
-    inline: true
-  ChatMessage:
-    properties:
-      content:
-        type: optional<string>
-        docs: Transcript of the message.
-      role:
-        type: Role
-        docs: Role of who is providing the message.
-      tool_call:
-        type: optional<ToolCallMessage>
-        docs: Function call name and arguments.
-      tool_result:
-        type: optional<ChatMessageToolResult>
-        docs: Function call response from client.
     source:
       openapi: evi-asyncapi.json
-  ChatMetadata:
-    docs: When provided, the output is a chat metadata message.
+  Context:
     properties:
-      chat_group_id:
-        type: string
+      type:
+        type: optional<ContextType>
         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.
+          The persistence level of the injected context. Specifies how long the
+          injected context will remain active in the session.
 
 
-          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.
-      custom_session_id:
-        type: optional<string>
-        docs: >-
-          Used to manage conversational state, correlate frontend and backend
-          data, and persist conversations across EVI sessions.
-      request_id:
-        type: optional<string>
-        docs: ID of the initiating request.
-      type:
-        type: literal<"chat_metadata">
-        docs: >-
-          The type of message sent through the socket; for a Chat Metadata
-          message, this must be `chat_metadata`.
+          - **Temporary**: Context that is only applied to the following
+          assistant response.
 
 
-          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.
-    source:
-      openapi: evi-asyncapi.json
-  Context:
-    properties:
+          - **Persistent**: Context that is applied to all subsequent assistant
+          responses for the remainder of the Chat.
       text:
         type: string
         docs: >-
@@ -301,163 +132,29 @@ types:
           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}`.
-      type:
-        type: optional<ContextType>
-        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`.
+          This text will be appended to the end of
+          [user_messages](/reference/speech-to-speech-evi/chat#receive.UserMessage.message.content)
+          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: evi-asyncapi.json
   ContextType:
     enum:
-      - editable
-      - persistent
       - temporary
+      - persistent
     source:
       openapi: evi-asyncapi.json
-  EmotionScores:
+  Encoding:
+    type: literal<"linear16">
+  ErrorLevel:
+    type: literal<"warn">
+  PauseAssistantMessage:
+    docs: >-
+      Pause responses from EVI. Chat history is still saved and sent after
+      resuming. 
     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: evi-asyncapi.json
-  Encoding:
-    type: literal<"linear16">
-  WebSocketError:
-    docs: When provided, the output is an error message.
-    properties:
-      code:
-        type: string
-        docs: Error code. Identifies the type of error encountered.
-      custom_session_id:
-        type: optional<string>
-        docs: >-
-          Used to manage conversational state, correlate frontend and backend
-          data, and persist conversations across EVI sessions.
-      message:
-        type: string
-        docs: Detailed description of the error.
-      request_id:
-        type: optional<string>
-        docs: ID of the initiating request.
-      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).
-      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.
-    source:
-      openapi: evi-asyncapi.json
-  ErrorLevel:
-    type: literal<"warn">
-  Inference:
-    properties:
-      prosody:
-        type: optional<ProsodyInference>
-        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: evi-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: evi-asyncapi.json
-  PauseAssistantMessage:
-    docs: >-
-      Pause responses from EVI. Chat history is still saved and sent after
-      resuming. 
-    properties:
-      custom_session_id:
-        type: optional<string>
-        docs: >-
-          Used to manage conversational state, correlate frontend and backend
-          data, and persist conversations across EVI sessions.
       type:
         type: literal<"pause_assistant_message">
         docs: >-
@@ -471,24 +168,11 @@ types:
           message](/reference/empathic-voice-interface-evi/chat/chat#send.ResumeAssistantMessage.type)
           is sent. When paused, EVI won’t respond, but transcriptions of your
           audio inputs will still be recorded.
-    source:
-      openapi: evi-asyncapi.json
-  ProsodyInference:
-    properties:
-      scores:
-        type: EmotionScores
+      custom_session_id:
+        type: optional<string>
         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.
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
     source:
       openapi: evi-asyncapi.json
   ResumeAssistantMessage:
@@ -496,11 +180,6 @@ types:
       Resume responses from EVI. Chat history sent while paused will now be
       sent. 
     properties:
-      custom_session_id:
-        type: optional<string>
-        docs: >-
-          Used to manage conversational state, correlate frontend and backend
-          data, and persist conversations across EVI sessions.
       type:
         type: literal<"resume_assistant_message">
         docs: >-
@@ -515,15 +194,11 @@ types:
           then send a `resume_assistant_message`, EVI will respond to the second
           question and have added the first question to its conversation
           context.)
-    source:
-      openapi: evi-asyncapi.json
-  Role:
-    enum:
-      - assistant
-      - system
-      - user
-      - all
-      - tool
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
     source:
       openapi: evi-asyncapi.json
   SessionSettingsVariablesValue:
@@ -538,48 +213,22 @@ types:
   SessionSettings:
     docs: Settings for this chat session.
     properties:
-      audio:
-        type: optional<AudioConfiguration>
-        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
-          guide](/docs/empathic-voice-interface-evi/configuration/session-settings).
-      builtin_tools:
-        type: optional<list<BuiltinToolConfig>>
-        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/features/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.
-      context:
-        type: optional<Context>
+      type:
+        type: literal<"session_settings">
         docs: >-
-          Allows developers to inject additional context into the conversation,
-          which is appended to the end of user messages for the session.
+          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.
 
 
-          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.
+          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.
 
 
-          Set to `null` to disable context injection.
+          For more information, please refer to the [Session Settings
+          guide](/docs/empathic-voice-interface-evi/configuration/session-settings).
       custom_session_id:
         type: optional<string>
         docs: >-
@@ -598,17 +247,6 @@ types:
           language
           model](/docs/empathic-voice-interface-evi/guides/custom-language-model)
           with EVI to learn more.
-      language_model_api_key:
-        type: optional<string>
-        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.
-      metadata:
-        type: optional<map<string, unknown>>
       system_prompt:
         type: optional<string>
         docs: >-
@@ -631,6 +269,41 @@ types:
 
           For help writing a system prompt, see our [Prompting
           Guide](/docs/empathic-voice-interface-evi/guides/prompting).
+      context:
+        type: optional<Context>
+        docs: >-
+          Field for injecting 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 clear injected context.
+      audio:
+        type: optional<AudioConfiguration>
+        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
+          guide](/docs/empathic-voice-interface-evi/configuration/session-settings).
+      language_model_api_key:
+        type: optional<string>
+        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<list<Tool>>
         docs: >-
@@ -642,22 +315,24 @@ types:
           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/features/tool-use).
-      type:
-        type: literal<"session_settings">
+      builtin_tools:
+        type: optional<list<BuiltinToolConfig>>
         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.
+          List of built-in tools to enable for the session.
 
 
-          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.
+          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/features/tool-use).
 
 
-          For more information, please refer to the [Session Settings
-          guide](/docs/empathic-voice-interface-evi/configuration/session-settings).
+          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<map<string, unknown>>
       variables:
         type: optional<map<string, SessionSettingsVariablesValue>>
         docs: >-
@@ -680,17 +355,9 @@ types:
       openapi: evi-asyncapi.json
   Tool:
     properties:
-      description:
-        type: optional<string>
-        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<string>
-        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.
+      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.
@@ -704,127 +371,87 @@ types:
           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.
-      type:
-        type: ToolType
-        docs: Type of tool. Set to `function` for user-defined tools.
+      description:
+        type: optional<string>
+        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<string>
+        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: evi-asyncapi.json
-  ToolCallMessage:
-    docs: When provided, the output is a tool call.
+  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.ToolCallMessage.type)
+          and failing to invoke the function, this message is sent to notify EVI
+          of the tool's failure.
       custom_session_id:
         type: optional<string>
         docs: >-
           Used to manage conversational state, correlate frontend and backend
           data, and persist conversations across EVI sessions.
-      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.
-      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.ToolResponseMessage.type)
-          or a [Tool Error
-          message](/reference/empathic-voice-interface-evi/chat/chat#send.ToolErrorMessage.type).
-      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.
       tool_type:
         type: optional<ToolType>
         docs: >-
           Type of tool called. Either `builtin` for natively implemented tools,
           like web search, or `function` for user-defined tools.
-      type:
-        type: literal<"tool_call">
+      tool_call_id:
+        type: string
         docs: >-
-          The type of message sent through the socket; for a Tool Call message,
-          this must be `tool_call`.
+          The unique identifier for a specific tool call instance.
 
 
-          This message indicates that the supplemental LLM has detected a need
-          to invoke the specified tool.
-    source:
-      openapi: evi-asyncapi.json
-  ToolErrorMessage:
-    docs: When provided, the output is a function call error.
-    properties:
-      code:
-        type: optional<string>
-        docs: Error code. Identifies the type of error encountered.
+          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.ToolCallMessage.type).
       content:
         type: optional<string>
         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.
-      custom_session_id:
-        type: optional<string>
-        docs: >-
-          Used to manage conversational state, correlate frontend and backend
-          data, and persist conversations across EVI sessions.
       error:
         type: string
         docs: Error message from the tool call, not exposed to the LLM or user.
+      code:
+        type: optional<string>
+        docs: Error code. Identifies the type of error encountered.
       level:
         type: optional<ErrorLevel>
         docs: >-
           Indicates the severity of an error; for a Tool Error message, this
           must be `warn` to signal an unexpected event.
-      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.ToolCallMessage.type).
-      tool_type:
-        type: optional<ToolType>
-        docs: >-
-          Type of tool called. Either `builtin` for natively implemented tools,
-          like web search, or `function` for user-defined tools.
-      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.ToolCallMessage.type)
-          and failing to invoke the function, this message is sent to notify EVI
-          of the tool's failure.
     source:
       openapi: evi-asyncapi.json
   ToolResponseMessage:
     docs: When provided, the output is a function call response.
     properties:
-      content:
-        type: string
+      type:
+        type: literal<"tool_response">
         docs: >-
-          Return value of the tool call. Contains the output generated by the
-          tool to pass back to EVI.
+          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.ToolCallMessage.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<string>
         docs: >-
@@ -841,6 +468,11 @@ types:
           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.ToolCallMessage.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<string>
         docs: >-
@@ -856,17 +488,6 @@ types:
         docs: >-
           Type of tool called. Either `builtin` for natively implemented tools,
           like web search, or `function` for user-defined tools.
-      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.ToolCallMessage.type)
-          and successfully invoking the function, this message is sent to convey
-          the result of the function call back to EVI.
     source:
       openapi: evi-asyncapi.json
   ToolType:
@@ -882,44 +503,408 @@ types:
       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:
+      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<string>
+        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: evi-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<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
+    source:
+      openapi: evi-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<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
+      id:
+        type: optional<string>
+        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.AssistantInput.text).
+    source:
+      openapi: evi-asyncapi.json
+  AssistantProsody:
+    docs: When provided, the output is an Assistant Prosody message.
+    properties:
+      type:
+        type: literal<"assistant_prosody">
+        docs: >-
+          The type of message sent through the socket; for an Assistant Prosody
+          message, this must be `assistant_PROSODY`.
+
+
+          This message the expression measurement predictions of the assistant's
+          audio output.
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
+      models:
+        type: Inference
+        docs: Inference model results.
+      id:
+        type: optional<string>
+        docs: Unique identifier for the segment.
+    source:
+      openapi: evi-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<string>
+        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: evi-asyncapi.json
+  ChatMessageToolResult:
+    discriminated: false
+    docs: Function call response from client.
+    union:
+      - type: ToolResponseMessage
+      - type: ToolErrorMessage
+    source:
+      openapi: evi-asyncapi.json
+    inline: true
+  ChatMessage:
+    properties:
+      role:
+        type: Role
+        docs: Role of who is providing the message.
+      content:
+        type: optional<string>
+        docs: Transcript of the message.
+      tool_call:
+        type: optional<ToolCallMessage>
+        docs: Function call name and arguments.
+      tool_result:
+        type: optional<ChatMessageToolResult>
+        docs: Function call response from client.
+    source:
+      openapi: evi-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<string>
+        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<string>
+        docs: ID of the initiating request.
+    source:
+      openapi: evi-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: evi-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<string>
+        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.
+      request_id:
+        type: optional<string>
+        docs: ID of the initiating request.
+    source:
+      openapi: evi-asyncapi.json
+  Inference:
+    properties:
+      prosody:
+        type: optional<ProsodyInference>
+        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: evi-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: evi-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: evi-asyncapi.json
+  Role:
+    enum:
+      - assistant
+      - system
+      - user
+      - all
+      - tool
+    source:
+      openapi: evi-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<string>
         docs: >-
           Used to manage conversational state, correlate frontend and backend
           data, and persist conversations across EVI sessions.
-      text:
-        type: string
+      tool_type:
+        type: optional<ToolType>
         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.
-      type:
-        type: literal<"user_input">
+          Type of tool called. Either `builtin` for natively implemented tools,
+          like web search, or `function` for user-defined tools.
+      response_required:
+        type: boolean
         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.
+          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.ToolResponseMessage.type)
+          or a [Tool Error
+          message](/reference/empathic-voice-interface-evi/chat/chat#send.ToolErrorMessage.type).
     source:
       openapi: evi-asyncapi.json
   UserInterruption:
     docs: When provided, the output is an interruption.
     properties:
-      custom_session_id:
-        type: optional<string>
-        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.
       type:
         type: literal<"user_interruption">
         docs: >-
@@ -932,40 +917,39 @@ types:
           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<string>
+        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: evi-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.AudioInput.type).
+          Expression measurement predictions are not provided for a [User Input
+          message](/reference/empathic-voice-interface-evi/chat/chat#send.UserInput.type),
+          as the prosody model relies on audio input and cannot process text
+          alone.
       custom_session_id:
         type: optional<string>
         docs: >-
           Used to manage conversational state, correlate frontend and backend
           data, and persist conversations across EVI sessions.
-      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.UserInput.text)
-          message.
-      interim:
-        type: boolean
-        docs: >-
-          Indicates if this message contains an immediate and unfinalized
-          transcript of the user’s audio input. If it does, words may be
-          repeated across successive `UserMessage` messages as our transcription
-          model becomes more confident about what was said with additional
-          context. Interim messages are useful to detect if the user is
-          interrupting during audio playback on the client. Even without a
-          finalized transcription, along with
-          [UserInterrupt](/reference/empathic-voice-interface-evi/chat/chat#receive.UserInterruption.type)
-          messages, interim `UserMessages` are useful for detecting if the user
-          is interrupting during audio playback on the client, signaling to stop
-          playback in your application. Interim `UserMessages` will only be
-          received if the
-          [verbose_transcription](/reference/empathic-voice-interface-evi/chat/chat#request.query.verbose_transcription)
-          query parameter is set to `true` in the handshake request.
       message:
         type: ChatMessage
         docs: Transcript of the message.
@@ -975,21 +959,30 @@ types:
       time:
         type: MillisecondInterval
         docs: Start and End time of user message.
-      type:
-        type: literal<"user_message">
+      from_text:
+        type: boolean
         docs: >-
-          The type of message sent through the socket; for a User Message, this
-          must be `user_message`.
+          Indicates if this message was inserted into the conversation as text
+          from a [User
+          Input](/reference/empathic-voice-interface-evi/chat/chat#send.UserInput.text)
+          message.
+      interim:
+        type: boolean
+        docs: >-
+          Indicates whether this `UserMessage` contains an interim (unfinalized)
+          transcript.
 
 
-          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.AudioInput.type).
-          Expression measurement predictions are not provided for a [User Input
-          message](/reference/empathic-voice-interface-evi/chat/chat#send.UserInput.type),
-          as the prosody model relies on audio input and cannot process text
-          alone.
+          - `true`: the transcript is provisional; words may be repeated or
+          refined in subsequent `UserMessage` responses as additional audio is
+          processed.
+
+          - `false`: the transcript is final and complete.
+
+
+          Interim transcripts are only sent when the
+          [`verbose_transcription`](/reference/empathic-voice-interface-evi/chat/chat#request.query.verbose_transcription)
+          query parameter is set to `true` in the initial handshake.
     source:
       openapi: evi-asyncapi.json
   JsonMessage:
@@ -1029,12 +1022,22 @@ types:
         name: Claude3Sonnet20240229
       - value: claude-3-haiku-20240307
         name: Claude3Haiku20240307
+      - value: claude-sonnet-4-20250514
+        name: ClaudeSonnet420250514
       - value: us.anthropic.claude-3-5-haiku-20241022-v1:0
         name: UsAnthropicClaude35Haiku20241022V10
       - value: us.anthropic.claude-3-5-sonnet-20240620-v1:0
         name: UsAnthropicClaude35Sonnet20240620V10
       - value: us.anthropic.claude-3-haiku-20240307-v1:0
         name: UsAnthropicClaude3Haiku20240307V10
+      - value: gpt-oss-120b
+        name: GptOss120B
+      - value: qwen-3-235b-a22b
+        name: Qwen3235BA22B
+      - value: qwen-3-235b-a22b-instruct-2507
+        name: Qwen3235BA22BInstruct2507
+      - value: qwen-3-235b-a22b-thinking-2507
+        name: Qwen3235BA22BThinking2507
       - value: gemini-1.5-pro
         name: Gemini15Pro
       - value: gemini-1.5-flash
@@ -1045,6 +1048,10 @@ types:
         name: Gemini15Flash002
       - value: gemini-2.0-flash
         name: Gemini20Flash
+      - value: gemini-2.5-flash
+        name: Gemini25Flash
+      - value: gemini-2.5-flash-preview-04-17
+        name: Gemini25FlashPreview0417
       - value: gpt-4-turbo
         name: Gpt4Turbo
       - value: gpt-4-turbo-preview
@@ -1057,6 +1064,14 @@ types:
         name: Gpt4O
       - value: gpt-4o-mini
         name: Gpt4OMini
+      - value: gpt-4.1
+        name: Gpt41
+      - value: gpt-5
+        name: Gpt5
+      - value: gpt-5-mini
+        name: Gpt5Mini
+      - value: gpt-5-nano
+        name: Gpt5Nano
       - value: gemma-7b-it
         name: Gemma7BIt
       - value: llama3-8b-8192
@@ -1069,6 +1084,8 @@ types:
         name: Llama3370BVersatile
       - value: llama-3.1-8b-instant
         name: Llama318BInstant
+      - value: moonshotai/kimi-k2-instruct
+        name: MoonshotaiKimiK2Instruct
       - value: accounts/fireworks/models/mixtral-8x7b-instruct
         name: AccountsFireworksModelsMixtral8X7BInstruct
       - value: accounts/fireworks/models/llama-v3p1-405b-instruct
@@ -1077,9 +1094,21 @@ types:
         name: AccountsFireworksModelsLlamaV3P170BInstruct
       - value: accounts/fireworks/models/llama-v3p1-8b-instruct
         name: AccountsFireworksModelsLlamaV3P18BInstruct
+      - sonar
+      - value: sonar-pro
+        name: SonarPro
+      - sambanova
+      - value: DeepSeek-R1-Distill-Llama-70B
+        name: DeepSeekR1DistillLlama70B
+      - value: Llama-4-Maverick-17B-128E-Instruct
+        name: Llama4Maverick17B128EInstruct
+      - value: Qwen3-32B
+        name: Qwen332B
       - ellm
       - value: custom-language-model
         name: CustomLanguageModel
+      - value: hume-evi-3-web-search
+        name: HumeEvi3WebSearch
     source:
       openapi: evi-openapi.json
   ModelProviderEnum:
@@ -1092,6 +1121,9 @@ types:
       - GOOGLE
       - HUME_AI
       - AMAZON_BEDROCK
+      - PERPLEXITY
+      - SAMBANOVA
+      - CEREBRAS
     source:
       openapi: evi-openapi.json
   ValidationErrorLocItem:
@@ -1110,29 +1142,20 @@ types:
       type: string
     source:
       openapi: evi-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: evi-openapi.json
-  WebhookEvent:
-    discriminated: false
-    union:
-      - WebhookEventChatStarted
-      - WebhookEventChatEnded
-    source:
-      openapi: evi-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: >-
@@ -1147,18 +1170,6 @@ types:
           language
           model](/docs/empathic-voice-interface-evi/custom-language-model) in
           the EVI Config.
-      duration_seconds:
-        type: integer
-        docs: Total duration of the session in seconds.
-      end_reason:
-        type: WebhookEventChatStatus
-        docs: Reason for the session's termination.
-      end_time:
-        type: integer
-        docs: Unix timestamp (in milliseconds) indicating when the session ended.
-      event_name:
-        type: optional<literal<"chat_ended">>
-        docs: Always `chat_ended`.
     extends:
       - WebhookEventBase
     source:
@@ -1171,6 +1182,18 @@ types:
       openapi: evi-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: >-
@@ -1178,12 +1201,6 @@ types:
           This field is included only if the Chat was created via the [Twilio
           phone calling](/docs/empathic-voice-interface-evi/phone-calling)
           integration.
-      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`).
       custom_session_id:
         type: optional<string>
         docs: >-
@@ -1191,12 +1208,6 @@ types:
           language
           model](/docs/empathic-voice-interface-evi/custom-language-model) in
           the EVI Config.
-      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.
     extends:
       - WebhookEventBase
     source:
@@ -1212,6 +1223,27 @@ types:
       - ERROR
     source:
       openapi: evi-openapi.json
+  WebhookEvent:
+    discriminated: false
+    union:
+      - WebhookEventChatStarted
+      - WebhookEventChatEnded
+    source:
+      openapi: evi-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: evi-openapi.json
   ErrorResponse:
     properties:
       error: optional<string>
@@ -1405,6 +1437,9 @@ types:
           Version numbers are integer values representing different iterations
           of the Prompt. Each update to the Prompt increments its version
           number.
+      version_description:
+        type: optional<string>
+        docs: An optional description of the Prompt version.
       version_type:
         type: ReturnPromptVersionType
         docs: >-
@@ -1420,9 +1455,6 @@ types:
         docs: >-
           Time at which the Prompt was last modified. Measured in seconds since
           the Unix epoch.
-      version_description:
-        type: optional<string>
-        docs: An optional description of the Prompt version.
     source:
       openapi: evi-openapi.json
   ReturnPagedConfigs:
@@ -1478,15 +1510,39 @@ types:
           Version numbers are integer values representing different iterations
           of the Config. Each update to the Config increments its version
           number.
+      tools:
+        type: optional<list<optional<ReturnUserDefinedTool>>>
+        docs: List of user-defined tools associated with this Config.
+      version_description:
+        type: optional<string>
+        docs: An optional description of the Config version.
+      language_model:
+        type: optional<ReturnLanguageModel>
+        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.
+      builtin_tools:
+        type: optional<list<optional<ReturnBuiltinTool>>>
+        docs: List of built-in tools associated with this Config.
       evi_version:
         type: optional<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/speech-to-speech-evi/configuration/evi-version).
+          Specifies the EVI version to use. See our [EVI Version 
+          Guide](/docs/speech-to-speech-evi/configuration/evi-version) for
+          differences between versions.
+
+
+          **We're officially sunsetting EVI versions 1 and 2 on August 30,
+          2025**. To keep things running smoothly, be sure to [migrate to EVI
+          3](/docs/speech-to-speech-evi/configuration/evi-version#migrating-to-evi-3)
+          before then.
       timeouts: optional<ReturnTimeoutSpecs>
       nudges: optional<ReturnNudgeSpec>
+      event_messages: optional<ReturnEventMessageSpecs>
       ellm_model:
         type: optional<ReturnEllmModel>
         docs: >-
@@ -1499,9 +1555,6 @@ types:
           text-to-speech (TTS) prosody.
       voice: optional<unknown>
       prompt: optional<ReturnPrompt>
-      tools:
-        type: optional<list<optional<ReturnUserDefinedTool>>>
-        docs: List of user-defined tools associated with this Config.
       webhooks:
         type: optional<list<optional<ReturnWebhookSpec>>>
         docs: Map of webhooks associated with this config.
@@ -1515,22 +1568,6 @@ types:
         docs: >-
           Time at which the Config was last modified. Measured in seconds since
           the Unix epoch.
-      language_model:
-        type: optional<ReturnLanguageModel>
-        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.
-      builtin_tools:
-        type: optional<list<optional<ReturnBuiltinTool>>>
-        docs: List of built-in tools associated with this Config.
-      event_messages: optional<ReturnEventMessageSpecs>
-      version_description:
-        type: optional<string>
-        docs: An optional description of the Config version.
     source:
       openapi: evi-openapi.json
   ReturnPagedChatsPaginationDirection:
@@ -2632,50 +2669,58 @@ types:
       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.
     inline: true
     source:
       openapi: evi-openapi.json
   ReturnChatEventType:
     enum:
-      - SYSTEM_PROMPT
-      - USER_MESSAGE
-      - USER_INTERRUPTION
-      - AGENT_MESSAGE
       - FUNCTION_CALL
       - FUNCTION_CALL_RESPONSE
+      - CHAT_END_MESSAGE
+      - AGENT_MESSAGE
+      - SYSTEM_PROMPT
+      - USER_RECORDING_START_MESSAGE
+      - RESUME_ONSET
+      - USER_INTERRUPTION
+      - CHAT_START_MESSAGE
+      - PAUSE_ONSET
+      - USER_MESSAGE
     docs: >-
-      Type of Chat Event. There are six possible values:
+      Type of Chat Event. There are eleven Chat Event types:
 
+      - `SYSTEM_PROMPT`: The system prompt used to initialize the session.
 
-      - `SYSTEM_PROMPT`: Contains the system prompt for use in the session.
+      - `CHAT_START_MESSAGE`: Marks the beginning of the chat session.
 
+      - `USER_RECORDING_START_MESSAGE`: Marks when the client began streaming
+      audio and the start of audio processing.
 
-      - `USER_MESSAGE`: Contains the message sent by the user.
+      - `USER_MESSAGE`: A message sent by the user.
 
+      - `USER_INTERRUPTION`: A user-initiated interruption while the assistant
+      is speaking.
 
-      - `USER_INTERRUPTION`: Contains an interruption made by the user while the
-      agent is speaking.
+      - `AGENT_MESSAGE`: A response generated by the assistant.
 
+      - `FUNCTION_CALL`: A record of a tool invocation by the assistant.
 
-      - `AGENT_MESSAGE`: Contains the assistant’s message, generated by Hume’s
-      eLLM and supplemental LLM.
+      - `FUNCTION_CALL_RESPONSE`: The result of a previously invoked function or
+      tool.
 
+      - `PAUSE_ONSET`: Marks when the client sent a `pause_assistant_message` to
+      pause the assistant.
 
-      - `FUNCTION_CALL`: Contains the invocation of a tool.
+      - `RESUME_ONSET`: Marks when the client sent a `resume_assistant_message`
+      to resume the assistant.
 
-
-      - `FUNCTION_CALL_RESPONSE`: Contains the tool response.
+      - `CHAT_END_MESSAGE`: Indicates the end of the chat session.
     inline: true
     source:
       openapi: evi-openapi.json
@@ -2699,42 +2744,45 @@ types:
           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.
       type:
         type: ReturnChatEventType
         docs: >-
-          Type of Chat Event. There are six possible values:
-
+          Type of Chat Event. There are eleven Chat Event types:
 
-          - `SYSTEM_PROMPT`: Contains the system prompt for use in the session.
+          - `SYSTEM_PROMPT`: The system prompt used to initialize the session.
 
+          - `CHAT_START_MESSAGE`: Marks the beginning of the chat session.
 
-          - `USER_MESSAGE`: Contains the message sent by the user.
+          - `USER_RECORDING_START_MESSAGE`: Marks when the client began
+          streaming audio and the start of audio processing.
 
+          - `USER_MESSAGE`: A message sent by the user.
 
-          - `USER_INTERRUPTION`: Contains an interruption made by the user while
-          the agent is speaking.
+          - `USER_INTERRUPTION`: A user-initiated interruption while the
+          assistant is speaking.
 
+          - `AGENT_MESSAGE`: A response generated by the assistant.
 
-          - `AGENT_MESSAGE`: Contains the assistant’s message, generated by
-          Hume’s eLLM and supplemental LLM.
+          - `FUNCTION_CALL`: A record of a tool invocation by the assistant.
 
+          - `FUNCTION_CALL_RESPONSE`: The result of a previously invoked
+          function or tool.
 
-          - `FUNCTION_CALL`: Contains the invocation of a tool.
+          - `PAUSE_ONSET`: Marks when the client sent a
+          `pause_assistant_message` to pause the assistant.
 
+          - `RESUME_ONSET`: Marks when the client sent a
+          `resume_assistant_message` to resume the assistant.
 
-          - `FUNCTION_CALL_RESPONSE`: Contains the tool response.
+          - `CHAT_END_MESSAGE`: Indicates the end of the chat session.
       message_text:
         type: optional<string>
         docs: >-
@@ -2886,6 +2934,7 @@ types:
     enum:
       - HUME_AI
       - CUSTOM_VOICE
+      - OCTAVE_COMBINED
     source:
       openapi: evi-openapi.json
   VoiceId: