hume 0.13.0 → 0.13.2

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

@@ -29,7 +29,7 @@ types:
 
           EVI uses this text to generate spoken audio using our proprietary
           expressive text-to-speech model. Our model adds appropriate emotional
-          inflections and tones to the text based on the user’s expressions and
+          inflections and tones to the text based on the user's expressions and
           the context of the conversation. The synthesized audio is streamed
           back to the user as an [Assistant
           Message](/reference/empathic-voice-interface-evi/chat/chat#receive.AssistantMessage.type).
@@ -75,7 +75,7 @@ types:
           Base64 encoded audio input to insert into the conversation.
 
 
-          The content of an Audio Input message is treated as the user’s speech
+          The content of an Audio Input message is treated as the user's speech
           to EVI and must be streamed continuously. Pre-recorded audio files are
           not supported.
 
@@ -142,8 +142,8 @@ types:
       openapi: evi-asyncapi.json
   ContextType:
     enum:
-      - temporary
       - persistent
+      - temporary
     source:
       openapi: evi-asyncapi.json
   Encoding:
@@ -166,7 +166,7 @@ types:
           Once this message is sent, EVI will not respond until a [Resume
           Assistant
           message](/reference/empathic-voice-interface-evi/chat/chat#send.ResumeAssistantMessage.type)
-          is sent. When paused, EVI won’t respond, but transcriptions of your
+          is sent. When paused, EVI won't respond, but transcriptions of your
           audio inputs will still be recorded.
       custom_session_id:
         type: optional<string>
@@ -250,7 +250,7 @@ types:
       system_prompt:
         type: optional<string>
         docs: >-
-          Instructions used to shape EVI’s behavior, responses, and style for
+          Instructions used to shape EVI's behavior, responses, and style for
           the session.
 
 
@@ -301,7 +301,7 @@ types:
           Third party API key for the supplemental language model.
 
 
-          When provided, EVI will use this key instead of Hume’s API key for the
+          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:
@@ -367,7 +367,7 @@ types:
           Parameters of the tool. Is a stringified JSON schema.
 
 
-          These parameters define the inputs needed for the tool’s execution,
+          These parameters define the inputs needed for the tool's execution,
           including the expected data type and description for each input field.
           Structured as a JSON schema, this format ensures the tool receives
           data in the expected format.
@@ -521,7 +521,7 @@ types:
         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
+          Input message is treated as the user's speech to EVI. EVI processes
           this input and provides a corresponding response.
 
 
@@ -540,7 +540,7 @@ types:
           message, this must be `assistant_end`.
 
 
-          This message indicates the conclusion of the assistant’s response,
+          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:
@@ -560,8 +560,8 @@ types:
           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
+          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>
@@ -860,7 +860,7 @@ types:
           Parameters of the tool.
 
 
-          These parameters define the inputs needed for the tool’s execution,
+          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.
@@ -912,7 +912,7 @@ types:
           message, this must be `user_interruption`.
 
 
-          This message indicates the user has interrupted the assistant’s
+          This message indicates the user has interrupted the assistant's
           response. EVI detects the interruption in real-time and sends this
           message to signal the interruption event. This message allows the
           system to stop the current audio playback, clear the audio queue, and
@@ -937,7 +937,7 @@ types:
           must be `user_message`.
 
 
-          This message contains both a transcript of the user’s input and the
+          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).
@@ -990,6 +990,7 @@ types:
     union:
       - type: AssistantEnd
       - type: AssistantMessage
+      - type: AssistantProsody
       - type: ChatMetadata
       - type: WebSocketError
       - type: UserInterruption
@@ -997,7 +998,6 @@ types:
       - type: ToolCallMessage
       - type: ToolResponseMessage
       - type: ToolErrorMessage
-      - type: AssistantProsody
     source:
       openapi: evi-asyncapi.json
   HTTPValidationError:
@@ -1142,6 +1142,26 @@ types:
       type: string
     source:
       openapi: evi-openapi.json
+  VoiceId:
+    properties:
+      id:
+        type: string
+        docs: ID of the voice in the `Voice Library`.
+      provider:
+        type: optional<VoiceProvider>
+        docs: Model provider associated with this Voice ID.
+    source:
+      openapi: evi-openapi.json
+  VoiceName:
+    properties:
+      name:
+        type: string
+        docs: Name of the voice in the `Voice Library`.
+      provider:
+        type: optional<VoiceProvider>
+        docs: Model provider associated with this Voice Name.
+    source:
+      openapi: evi-openapi.json
   WebhookEventChatEnded:
     properties:
       event_name:
@@ -1363,7 +1383,7 @@ types:
           Tool.
 
 
-          These parameters define the inputs needed for the Tool’s execution,
+          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.
@@ -1410,17 +1430,15 @@ types:
       text:
         type: string
         docs: >-
-          Instructions used to shape EVI’s behavior, responses, and style.
+          Instructions used to shape EVI's behavior, responses, and style.
 
 
           You can use the Prompt to define a specific goal or role for EVI,
           specifying how it should act or what it should focus on during the
           conversation. For example, EVI can be instructed to act as a customer
           support representative, a fitness coach, or a travel advisor, each
-          with its own set of behaviors and response styles.
-
-
-          For help writing a system prompt, see our [Prompting
+          with its own set of behaviors and response styles. For help writing a
+          system prompt, see our [Prompting
           Guide](/docs/speech-to-speech-evi/guides/prompting).
       version:
         type: integer
@@ -1553,7 +1571,9 @@ types:
           model that takes into account both expression measures and language.
           The eLLM generates short, empathic language responses and guides
           text-to-speech (TTS) prosody.
-      voice: optional<unknown>
+      voice:
+        type: optional<ReturnVoice>
+        docs: A voice specification associated with this Config.
       prompt: optional<ReturnPrompt>
       webhooks:
         type: optional<list<optional<ReturnWebhookSpec>>>
@@ -2142,7 +2162,7 @@ types:
           The model temperature, with values between 0 to 1 (inclusive).
 
 
-          Controls the randomness of the LLM’s output, with values closer to 0
+          Controls the randomness of the LLM's output, with values closer to 0
           yielding focused, deterministic responses and values closer to 1
           producing more creative, diverse responses.
     source:
@@ -2293,6 +2313,11 @@ types:
       Accepts a minimum value of 30 seconds and a maximum value of 1,800
       seconds.
     properties:
+      duration_secs:
+        type: optional<integer>
+        docs: >-
+          Duration in seconds for the timeout (e.g. 600 seconds represents 10
+          minutes).
       enabled:
         type: boolean
         docs: >-
@@ -2303,11 +2328,6 @@ types:
           user inactivity being reached. However, the conversation will
           eventually disconnect after 1,800 seconds (30 minutes), which is the
           maximum WebSocket duration limit for EVI.
-      duration_secs:
-        type: optional<integer>
-        docs: >-
-          Duration in seconds for the timeout (e.g. 600 seconds represents 10
-          minutes).
     source:
       openapi: evi-openapi.json
     inline: true
@@ -2321,6 +2341,11 @@ types:
       Accepts a minimum value of 30 seconds and a maximum value of 1,800
       seconds.
     properties:
+      duration_secs:
+        type: optional<integer>
+        docs: >-
+          Duration in seconds for the timeout (e.g. 600 seconds represents 10
+          minutes).
       enabled:
         type: boolean
         docs: >-
@@ -2331,11 +2356,6 @@ types:
           duration being reached. However, the conversation will eventually
           disconnect after 1,800 seconds (30 minutes), which is the maximum
           WebSocket duration limit for EVI.
-      duration_secs:
-        type: optional<integer>
-        docs: >-
-          Duration in seconds for the timeout (e.g. 600 seconds represents 10
-          minutes).
     source:
       openapi: evi-openapi.json
     inline: true
@@ -2414,7 +2434,7 @@ types:
           The model temperature, with values between 0 to 1 (inclusive).
 
 
-          Controls the randomness of the LLM’s output, with values closer to 0
+          Controls the randomness of the LLM's output, with values closer to 0
           yielding focused, deterministic responses and values closer to 1
           producing more creative, diverse responses.
     source:
@@ -2930,33 +2950,6 @@ types:
           minutes).
     source:
       openapi: evi-openapi.json
-  VoiceProvider:
-    enum:
-      - HUME_AI
-      - CUSTOM_VOICE
-      - OCTAVE_COMBINED
-    source:
-      openapi: evi-openapi.json
-  VoiceId:
-    properties:
-      id:
-        type: string
-        docs: ID of the voice in the `Voice Library`.
-      provider:
-        type: optional<VoiceProvider>
-        docs: Model provider associated with this Voice ID.
-    source:
-      openapi: evi-openapi.json
-  VoiceName:
-    properties:
-      name:
-        type: string
-        docs: Name of the voice in the `Voice Library`.
-      provider:
-        type: optional<VoiceProvider>
-        docs: Model provider associated with this Voice Name.
-    source:
-      openapi: evi-openapi.json
   VoiceRef:
     discriminated: false
     union:
@@ -2964,3 +2957,17 @@ types:
       - type: VoiceName
     source:
       openapi: evi-openapi.json
+  ReturnVoice:
+    docs: An Octave voice available for text-to-speech
+    properties:
+      id: optional<string>
+      name: optional<string>
+      provider: optional<VoiceProvider>
+    source:
+      openapi: evi-openapi.json
+  VoiceProvider:
+    enum:
+      - HUME_AI
+      - CUSTOM_VOICE
+    source:
+      openapi: evi-openapi.json

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

@@ -9,13 +9,11 @@ webhooks:
     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
+          chat_group_id: chat_group_id
+          chat_id: chat_id
+          end_time: 1
+          duration_seconds: 1
+          end_reason: ACTIVE
     docs: Sent when an EVI chat ends.
   chatStarted:
     audiences: []
@@ -25,10 +23,8 @@ webhooks:
     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_group_id: chat_group_id
+          chat_id: chat_id
+          start_time: 1
           chat_start_type: new_chat_group
     docs: Sent when an EVI chat is started.

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

@@ -126,7 +126,7 @@ service:
             text:
               type: string
               docs: >-
-                Instructions used to shape EVI’s behavior, responses, and style.
+                Instructions used to shape EVI's behavior, responses, and style.
 
 
                 You can use the Prompt to define a specific goal or role for
@@ -278,7 +278,7 @@ service:
             text:
               type: string
               docs: >-
-                Instructions used to shape EVI’s behavior, responses, and style
+                Instructions used to shape EVI's behavior, responses, and style
                 for this version of the Prompt.
 
 

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

@@ -145,7 +145,7 @@ service:
                 the Tool.
 
 
-                These parameters define the inputs needed for the Tool’s
+                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.
@@ -324,7 +324,7 @@ service:
                 the Tool.
 
 
-                These parameters define the inputs needed for the Tool’s
+                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.