🌿 Fern Regeneration -- August 5, 2025 (#474)

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: twitchard <[email protected]>

Author: fern-api[bot]

.github/workflows/ci.yml

@@ -46,6 +46,9 @@ jobs:
             - name: Run tests
               run: yarn test
 
+            - name: Run browser tests
+              run: yarn test:browser
+
     publish:
         needs: [compile, test]
         if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')

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

@@ -952,20 +952,20 @@ types:
       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.
+          Indicates whether this `UserMessage` contains an interim (unfinalized)
+          transcript.
+
+
+          - `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.
       message:
         type: ChatMessage
         docs: Transcript of the message.
@@ -1029,12 +1029,16 @@ 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: qwen-3-235b-a22b
+        name: Qwen3235BA22B
       - value: gemini-1.5-pro
         name: Gemini15Pro
       - value: gemini-1.5-flash
@@ -1045,6 +1049,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
@@ -1069,6 +1077,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 +1087,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 +1114,9 @@ types:
       - GOOGLE
       - HUME_AI
       - AMAZON_BEDROCK
+      - PERPLEXITY
+      - SAMBANOVA
+      - CEREBRAS
     source:
       openapi: evi-openapi.json
   ValidationErrorLocItem:
@@ -1405,6 +1430,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 +1448,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,13 +1503,34 @@ types:
           Version numbers are integer values representing different iterations
           of the Config. Each update to the Config increments its version
           number.
+      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.
+      event_messages: optional<ReturnEventMessageSpecs>
       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>
       ellm_model:
@@ -1515,22 +1561,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 +2662,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`: 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.
     inline: true
     source:
       openapi: evi-openapi.json
@@ -2699,42 +2737,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: >-

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

@@ -141,10 +141,16 @@ service:
             evi_version:
               type: string
               docs: >-
-                Specifies the EVI version to use. Use `"1"` for version 1, or
-                `"2"` for the latest enhanced version. For a detailed comparison
-                of the two versions, refer to our
-                [guide](/docs/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.
             name:
               type: string
               docs: Name applied to all versions of a particular Config.

.mock/definition/tts/__package__.yml

@@ -514,11 +514,13 @@ types:
           maxLength: 1000
       speed:
         type: optional<double>
-        docs: Speed multiplier for the synthesized speech.
+        docs: >-
+          Speed multiplier for the synthesized speech. Extreme values below 0.75
+          and above 1.5 may sometimes cause instability to the generated output.
         default: 1
         validation:
-          min: 0.25
-          max: 3
+          min: 0.5
+          max: 2
       text:
         type: string
         docs: The input text to be synthesized into speech.
@@ -527,7 +529,7 @@ types:
       trailing_silence:
         type: optional<double>
         docs: Duration of trailing silence (in seconds) to add to this utterance
-        default: 0.35
+        default: 0
         validation:
           min: 0
           max: 5

jest.browser.config.mjs

@@ -0,0 +1,10 @@
+/** @type {import('jest').Config} */
+export default {
+    preset: "ts-jest",
+    testEnvironment: "<rootDir>/tests/BrowserTestEnvironment.ts",
+    testMatch: ["**/tests/**/*.browser.test.ts"],
+    moduleNameMapper: {
+        "^(\\.{1,2}/.*)\\.js$": "$1",
+    },
+    passWithNoTests: true,
+};

jest.config.mjs

@@ -2,6 +2,7 @@
 export default {
     preset: "ts-jest",
     testEnvironment: "node",
+    testPathIgnorePatterns: [".*\\.browser\\.test\\.ts$"],
     moduleNameMapper: {
         "(.+)\.js$": "$1",
     },