hume 0.12.1 → 0.12.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (165) hide show
  1. package/.mock/definition/empathic-voice/__package__.yml +169 -75
  2. package/.mock/definition/empathic-voice/configs.yml +10 -4
  3. package/.mock/definition/tts/__package__.yml +7 -38
  4. package/api/resources/empathicVoice/client/index.d.ts +1 -0
  5. package/api/resources/empathicVoice/client/index.js +15 -0
  6. package/api/resources/empathicVoice/client/requests/BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost.d.ts +12 -0
  7. package/api/resources/empathicVoice/client/requests/BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost.js +5 -0
  8. package/api/resources/empathicVoice/client/requests/index.d.ts +1 -0
  9. package/api/resources/empathicVoice/client/requests/index.js +2 -0
  10. package/api/resources/empathicVoice/errors/UnprocessableEntityError.d.ts +9 -0
  11. package/{core/form-data-utils/toReadableStream.js → api/resources/empathicVoice/errors/UnprocessableEntityError.js} +16 -14
  12. package/api/resources/empathicVoice/errors/index.d.ts +1 -0
  13. package/api/resources/empathicVoice/errors/index.js +1 -0
  14. package/api/resources/empathicVoice/resources/chatGroups/client/index.d.ts +1 -0
  15. package/api/resources/empathicVoice/resources/chats/client/index.d.ts +1 -0
  16. package/api/resources/empathicVoice/resources/configs/client/index.d.ts +1 -0
  17. package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +5 -1
  18. package/api/resources/empathicVoice/resources/prompts/client/index.d.ts +1 -0
  19. package/api/resources/empathicVoice/resources/tools/client/index.d.ts +1 -0
  20. package/api/resources/empathicVoice/types/LanguageModelType.d.ts +17 -1
  21. package/api/resources/empathicVoice/types/LanguageModelType.js +16 -0
  22. package/api/resources/empathicVoice/types/ModelProviderEnum.d.ts +4 -1
  23. package/api/resources/empathicVoice/types/ModelProviderEnum.js +3 -0
  24. package/api/resources/empathicVoice/types/ReturnChatEvent.d.ts +12 -17
  25. package/api/resources/empathicVoice/types/ReturnChatEventRole.d.ts +0 -4
  26. package/api/resources/empathicVoice/types/ReturnChatEventType.d.ts +22 -18
  27. package/api/resources/empathicVoice/types/ReturnChatEventType.js +9 -4
  28. package/api/resources/empathicVoice/types/ReturnConfig.d.ts +21 -17
  29. package/api/resources/empathicVoice/types/ReturnPrompt.d.ts +2 -2
  30. package/api/resources/empathicVoice/types/SupportsToolUse.d.ts +7 -0
  31. package/api/resources/empathicVoice/types/SupportsToolUse.js +5 -0
  32. package/api/resources/empathicVoice/types/UserMessage.d.ts +8 -1
  33. package/api/resources/empathicVoice/types/index.d.ts +1 -0
  34. package/api/resources/empathicVoice/types/index.js +1 -0
  35. package/api/resources/expressionMeasurement/resources/batch/client/Client.d.ts +2 -4
  36. package/api/resources/expressionMeasurement/resources/batch/client/Client.js +1 -1
  37. package/api/resources/expressionMeasurement/resources/batch/client/index.d.ts +1 -0
  38. package/api/resources/tts/client/index.d.ts +1 -0
  39. package/api/resources/tts/resources/voices/client/index.d.ts +1 -0
  40. package/api/resources/tts/types/PostedUtterance.d.ts +1 -1
  41. package/api/resources/tts/types/SnippetAudioChunk.d.ts +0 -16
  42. package/core/fetcher/BinaryResponse.d.ts +17 -0
  43. package/core/fetcher/BinaryResponse.js +14 -0
  44. package/core/fetcher/Fetcher.d.ts +1 -1
  45. package/core/fetcher/ResponseWithBody.d.ts +4 -0
  46. package/core/fetcher/ResponseWithBody.js +6 -0
  47. package/core/fetcher/getFetchFn.js +3 -3
  48. package/core/fetcher/getResponseBody.js +33 -32
  49. package/core/fetcher/index.d.ts +1 -0
  50. package/core/file.d.ts +1 -0
  51. package/core/file.js +2 -0
  52. package/core/form-data-utils/FormDataWrapper.d.ts +5 -52
  53. package/core/form-data-utils/FormDataWrapper.js +104 -124
  54. package/core/index.d.ts +1 -0
  55. package/core/index.js +1 -0
  56. package/dist/api/resources/empathicVoice/client/index.d.ts +1 -0
  57. package/dist/api/resources/empathicVoice/client/index.js +15 -0
  58. package/dist/api/resources/empathicVoice/client/requests/BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost.d.ts +12 -0
  59. package/dist/api/resources/empathicVoice/client/requests/BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost.js +5 -0
  60. package/dist/api/resources/empathicVoice/client/requests/index.d.ts +1 -0
  61. package/dist/api/resources/empathicVoice/client/requests/index.js +2 -0
  62. package/dist/api/resources/empathicVoice/errors/UnprocessableEntityError.d.ts +9 -0
  63. package/dist/{core/form-data-utils/toReadableStream.js → api/resources/empathicVoice/errors/UnprocessableEntityError.js} +16 -14
  64. package/dist/api/resources/empathicVoice/errors/index.d.ts +1 -0
  65. package/dist/api/resources/empathicVoice/errors/index.js +1 -0
  66. package/dist/api/resources/empathicVoice/resources/chatGroups/client/index.d.ts +1 -0
  67. package/dist/api/resources/empathicVoice/resources/chats/client/index.d.ts +1 -0
  68. package/dist/api/resources/empathicVoice/resources/configs/client/index.d.ts +1 -0
  69. package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +5 -1
  70. package/dist/api/resources/empathicVoice/resources/prompts/client/index.d.ts +1 -0
  71. package/dist/api/resources/empathicVoice/resources/tools/client/index.d.ts +1 -0
  72. package/dist/api/resources/empathicVoice/types/LanguageModelType.d.ts +17 -1
  73. package/dist/api/resources/empathicVoice/types/LanguageModelType.js +16 -0
  74. package/dist/api/resources/empathicVoice/types/ModelProviderEnum.d.ts +4 -1
  75. package/dist/api/resources/empathicVoice/types/ModelProviderEnum.js +3 -0
  76. package/dist/api/resources/empathicVoice/types/ReturnChatEvent.d.ts +12 -17
  77. package/dist/api/resources/empathicVoice/types/ReturnChatEventRole.d.ts +0 -4
  78. package/dist/api/resources/empathicVoice/types/ReturnChatEventType.d.ts +22 -18
  79. package/dist/api/resources/empathicVoice/types/ReturnChatEventType.js +9 -4
  80. package/dist/api/resources/empathicVoice/types/ReturnConfig.d.ts +21 -17
  81. package/dist/api/resources/empathicVoice/types/ReturnPrompt.d.ts +2 -2
  82. package/dist/api/resources/empathicVoice/types/SupportsToolUse.d.ts +7 -0
  83. package/dist/api/resources/empathicVoice/types/SupportsToolUse.js +5 -0
  84. package/dist/api/resources/empathicVoice/types/UserMessage.d.ts +8 -1
  85. package/dist/api/resources/empathicVoice/types/index.d.ts +1 -0
  86. package/dist/api/resources/empathicVoice/types/index.js +1 -0
  87. package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.d.ts +2 -4
  88. package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +1 -1
  89. package/dist/api/resources/expressionMeasurement/resources/batch/client/index.d.ts +1 -0
  90. package/dist/api/resources/tts/client/index.d.ts +1 -0
  91. package/dist/api/resources/tts/resources/voices/client/index.d.ts +1 -0
  92. package/dist/api/resources/tts/types/PostedUtterance.d.ts +1 -1
  93. package/dist/api/resources/tts/types/SnippetAudioChunk.d.ts +0 -16
  94. package/dist/core/fetcher/BinaryResponse.d.ts +17 -0
  95. package/dist/core/fetcher/BinaryResponse.js +14 -0
  96. package/dist/core/fetcher/Fetcher.d.ts +1 -1
  97. package/dist/core/fetcher/ResponseWithBody.d.ts +4 -0
  98. package/dist/core/fetcher/ResponseWithBody.js +6 -0
  99. package/dist/core/fetcher/getFetchFn.js +3 -3
  100. package/dist/core/fetcher/getResponseBody.js +33 -32
  101. package/dist/core/fetcher/index.d.ts +1 -0
  102. package/dist/core/file.d.ts +1 -0
  103. package/dist/core/file.js +2 -0
  104. package/dist/core/form-data-utils/FormDataWrapper.d.ts +5 -52
  105. package/dist/core/form-data-utils/FormDataWrapper.js +104 -124
  106. package/dist/core/index.d.ts +1 -0
  107. package/dist/core/index.js +1 -0
  108. package/dist/serialization/resources/empathicVoice/client/index.d.ts +1 -0
  109. package/dist/serialization/resources/empathicVoice/client/index.js +17 -0
  110. package/dist/serialization/resources/empathicVoice/client/requests/BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost.d.ts +12 -0
  111. package/dist/serialization/resources/empathicVoice/client/requests/BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost.js +43 -0
  112. package/dist/serialization/resources/empathicVoice/client/requests/index.d.ts +1 -0
  113. package/dist/serialization/resources/empathicVoice/client/requests/index.js +5 -0
  114. package/dist/serialization/resources/empathicVoice/index.d.ts +1 -0
  115. package/dist/serialization/resources/empathicVoice/index.js +1 -0
  116. package/dist/serialization/resources/empathicVoice/types/LanguageModelType.d.ts +1 -1
  117. package/dist/serialization/resources/empathicVoice/types/LanguageModelType.js +16 -0
  118. package/dist/serialization/resources/empathicVoice/types/ModelProviderEnum.d.ts +1 -1
  119. package/dist/serialization/resources/empathicVoice/types/ModelProviderEnum.js +3 -0
  120. package/dist/serialization/resources/empathicVoice/types/ReturnChatEventType.d.ts +1 -1
  121. package/dist/serialization/resources/empathicVoice/types/ReturnChatEventType.js +9 -4
  122. package/dist/serialization/resources/empathicVoice/types/ReturnConfig.d.ts +13 -13
  123. package/dist/serialization/resources/empathicVoice/types/ReturnConfig.js +13 -13
  124. package/dist/serialization/resources/empathicVoice/types/ReturnPrompt.d.ts +1 -1
  125. package/dist/serialization/resources/empathicVoice/types/ReturnPrompt.js +1 -1
  126. package/dist/serialization/resources/empathicVoice/types/SupportsToolUse.d.ts +13 -0
  127. package/dist/serialization/resources/empathicVoice/types/SupportsToolUse.js +44 -0
  128. package/dist/serialization/resources/empathicVoice/types/index.d.ts +1 -0
  129. package/dist/serialization/resources/empathicVoice/types/index.js +1 -0
  130. package/dist/serialization/resources/tts/types/SnippetAudioChunk.d.ts +0 -8
  131. package/dist/serialization/resources/tts/types/SnippetAudioChunk.js +1 -10
  132. package/dist/version.d.ts +1 -1
  133. package/dist/version.js +1 -1
  134. package/jest.browser.config.mjs +10 -0
  135. package/jest.config.mjs +1 -0
  136. package/package.json +6 -7
  137. package/reference.md +53 -1
  138. package/serialization/resources/empathicVoice/client/index.d.ts +1 -0
  139. package/serialization/resources/empathicVoice/client/index.js +17 -0
  140. package/serialization/resources/empathicVoice/client/requests/BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost.d.ts +12 -0
  141. package/serialization/resources/empathicVoice/client/requests/BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost.js +43 -0
  142. package/serialization/resources/empathicVoice/client/requests/index.d.ts +1 -0
  143. package/serialization/resources/empathicVoice/client/requests/index.js +5 -0
  144. package/serialization/resources/empathicVoice/index.d.ts +1 -0
  145. package/serialization/resources/empathicVoice/index.js +1 -0
  146. package/serialization/resources/empathicVoice/types/LanguageModelType.d.ts +1 -1
  147. package/serialization/resources/empathicVoice/types/LanguageModelType.js +16 -0
  148. package/serialization/resources/empathicVoice/types/ModelProviderEnum.d.ts +1 -1
  149. package/serialization/resources/empathicVoice/types/ModelProviderEnum.js +3 -0
  150. package/serialization/resources/empathicVoice/types/ReturnChatEventType.d.ts +1 -1
  151. package/serialization/resources/empathicVoice/types/ReturnChatEventType.js +9 -4
  152. package/serialization/resources/empathicVoice/types/ReturnConfig.d.ts +13 -13
  153. package/serialization/resources/empathicVoice/types/ReturnConfig.js +13 -13
  154. package/serialization/resources/empathicVoice/types/ReturnPrompt.d.ts +1 -1
  155. package/serialization/resources/empathicVoice/types/ReturnPrompt.js +1 -1
  156. package/serialization/resources/empathicVoice/types/SupportsToolUse.d.ts +13 -0
  157. package/serialization/resources/empathicVoice/types/SupportsToolUse.js +44 -0
  158. package/serialization/resources/empathicVoice/types/index.d.ts +1 -0
  159. package/serialization/resources/empathicVoice/types/index.js +1 -0
  160. package/serialization/resources/tts/types/SnippetAudioChunk.d.ts +0 -8
  161. package/serialization/resources/tts/types/SnippetAudioChunk.js +1 -10
  162. package/version.d.ts +1 -1
  163. package/version.js +1 -1
  164. package/core/form-data-utils/toReadableStream.d.ts +0 -1
  165. package/dist/core/form-data-utils/toReadableStream.d.ts +0 -1
@@ -1,10 +1,49 @@
1
1
  errors:
2
+ UnprocessableEntityError:
3
+ status-code: 422
4
+ type: HTTPValidationError
5
+ docs: Validation Error
6
+ examples:
7
+ - value: {}
2
8
  BadRequestError:
3
9
  status-code: 400
4
10
  type: ErrorResponse
5
11
  docs: Bad Request
6
12
  examples:
7
13
  - value: {}
14
+ service:
15
+ auth: false
16
+ base-path: ''
17
+ endpoints:
18
+ custom_language_model_supports_tool_use_v0_evi_custom_language_model_supports_tool_use_post:
19
+ path: /v0/evi/custom_language_model_supports_tool_use
20
+ method: POST
21
+ auth: true
22
+ source:
23
+ openapi: evi-openapi.json
24
+ display-name: Custom Language Model Supports Tool Use
25
+ request:
26
+ name: >-
27
+ BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost
28
+ body:
29
+ properties:
30
+ model_resource: string
31
+ content-type: application/json
32
+ response:
33
+ docs: Successful Response
34
+ type: SupportsToolUse
35
+ status-code: 200
36
+ errors:
37
+ - UnprocessableEntityError
38
+ examples:
39
+ - request:
40
+ model_resource: model_resource
41
+ response:
42
+ body:
43
+ model_resource: model_resource
44
+ supports_tool_use: true
45
+ source:
46
+ openapi: evi-openapi.json
8
47
  types:
9
48
  AssistantEnd:
10
49
  docs: When provided, the output is an assistant end message.
@@ -952,20 +991,20 @@ types:
952
991
  interim:
953
992
  type: boolean
954
993
  docs: >-
955
- Indicates if this message contains an immediate and unfinalized
956
- transcript of the user’s audio input. If it does, words may be
957
- repeated across successive `UserMessage` messages as our transcription
958
- model becomes more confident about what was said with additional
959
- context. Interim messages are useful to detect if the user is
960
- interrupting during audio playback on the client. Even without a
961
- finalized transcription, along with
962
- [UserInterrupt](/reference/empathic-voice-interface-evi/chat/chat#receive.UserInterruption.type)
963
- messages, interim `UserMessages` are useful for detecting if the user
964
- is interrupting during audio playback on the client, signaling to stop
965
- playback in your application. Interim `UserMessages` will only be
966
- received if the
967
- [verbose_transcription](/reference/empathic-voice-interface-evi/chat/chat#request.query.verbose_transcription)
968
- query parameter is set to `true` in the handshake request.
994
+ Indicates whether this `UserMessage` contains an interim (unfinalized)
995
+ transcript.
996
+
997
+
998
+ - `true`: the transcript is provisional; words may be repeated or
999
+ refined in subsequent `UserMessage` responses as additional audio is
1000
+ processed.
1001
+
1002
+ - `false`: the transcript is final and complete.
1003
+
1004
+
1005
+ Interim transcripts are only sent when the
1006
+ [`verbose_transcription`](/reference/empathic-voice-interface-evi/chat/chat#request.query.verbose_transcription)
1007
+ query parameter is set to `true` in the initial handshake.
969
1008
  message:
970
1009
  type: ChatMessage
971
1010
  docs: Transcript of the message.
@@ -1029,12 +1068,22 @@ types:
1029
1068
  name: Claude3Sonnet20240229
1030
1069
  - value: claude-3-haiku-20240307
1031
1070
  name: Claude3Haiku20240307
1071
+ - value: claude-sonnet-4-20250514
1072
+ name: ClaudeSonnet420250514
1032
1073
  - value: us.anthropic.claude-3-5-haiku-20241022-v1:0
1033
1074
  name: UsAnthropicClaude35Haiku20241022V10
1034
1075
  - value: us.anthropic.claude-3-5-sonnet-20240620-v1:0
1035
1076
  name: UsAnthropicClaude35Sonnet20240620V10
1036
1077
  - value: us.anthropic.claude-3-haiku-20240307-v1:0
1037
1078
  name: UsAnthropicClaude3Haiku20240307V10
1079
+ - value: gpt-oss-120b
1080
+ name: GptOss120B
1081
+ - value: qwen-3-235b-a22b
1082
+ name: Qwen3235BA22B
1083
+ - value: qwen-3-235b-a22b-instruct-2507
1084
+ name: Qwen3235BA22BInstruct2507
1085
+ - value: qwen-3-235b-a22b-thinking-2507
1086
+ name: Qwen3235BA22BThinking2507
1038
1087
  - value: gemini-1.5-pro
1039
1088
  name: Gemini15Pro
1040
1089
  - value: gemini-1.5-flash
@@ -1045,6 +1094,10 @@ types:
1045
1094
  name: Gemini15Flash002
1046
1095
  - value: gemini-2.0-flash
1047
1096
  name: Gemini20Flash
1097
+ - value: gemini-2.5-flash
1098
+ name: Gemini25Flash
1099
+ - value: gemini-2.5-flash-preview-04-17
1100
+ name: Gemini25FlashPreview0417
1048
1101
  - value: gpt-4-turbo
1049
1102
  name: Gpt4Turbo
1050
1103
  - value: gpt-4-turbo-preview
@@ -1057,6 +1110,8 @@ types:
1057
1110
  name: Gpt4O
1058
1111
  - value: gpt-4o-mini
1059
1112
  name: Gpt4OMini
1113
+ - value: gpt-4.1
1114
+ name: Gpt41
1060
1115
  - value: gemma-7b-it
1061
1116
  name: Gemma7BIt
1062
1117
  - value: llama3-8b-8192
@@ -1069,6 +1124,8 @@ types:
1069
1124
  name: Llama3370BVersatile
1070
1125
  - value: llama-3.1-8b-instant
1071
1126
  name: Llama318BInstant
1127
+ - value: moonshotai/kimi-k2-instruct
1128
+ name: MoonshotaiKimiK2Instruct
1072
1129
  - value: accounts/fireworks/models/mixtral-8x7b-instruct
1073
1130
  name: AccountsFireworksModelsMixtral8X7BInstruct
1074
1131
  - value: accounts/fireworks/models/llama-v3p1-405b-instruct
@@ -1077,9 +1134,21 @@ types:
1077
1134
  name: AccountsFireworksModelsLlamaV3P170BInstruct
1078
1135
  - value: accounts/fireworks/models/llama-v3p1-8b-instruct
1079
1136
  name: AccountsFireworksModelsLlamaV3P18BInstruct
1137
+ - sonar
1138
+ - value: sonar-pro
1139
+ name: SonarPro
1140
+ - sambanova
1141
+ - value: DeepSeek-R1-Distill-Llama-70B
1142
+ name: DeepSeekR1DistillLlama70B
1143
+ - value: Llama-4-Maverick-17B-128E-Instruct
1144
+ name: Llama4Maverick17B128EInstruct
1145
+ - value: Qwen3-32B
1146
+ name: Qwen332B
1080
1147
  - ellm
1081
1148
  - value: custom-language-model
1082
1149
  name: CustomLanguageModel
1150
+ - value: hume-evi-3-web-search
1151
+ name: HumeEvi3WebSearch
1083
1152
  source:
1084
1153
  openapi: evi-openapi.json
1085
1154
  ModelProviderEnum:
@@ -1092,6 +1161,15 @@ types:
1092
1161
  - GOOGLE
1093
1162
  - HUME_AI
1094
1163
  - AMAZON_BEDROCK
1164
+ - PERPLEXITY
1165
+ - SAMBANOVA
1166
+ - CEREBRAS
1167
+ source:
1168
+ openapi: evi-openapi.json
1169
+ SupportsToolUse:
1170
+ properties:
1171
+ model_resource: string
1172
+ supports_tool_use: boolean
1095
1173
  source:
1096
1174
  openapi: evi-openapi.json
1097
1175
  ValidationErrorLocItem:
@@ -1410,6 +1488,9 @@ types:
1410
1488
  docs: >-
1411
1489
  Versioning method for a Prompt. Either `FIXED` for using a fixed
1412
1490
  version number or `LATEST` for auto-updating to the latest version.
1491
+ version_description:
1492
+ type: optional<string>
1493
+ docs: An optional description of the Prompt version.
1413
1494
  created_on:
1414
1495
  type: long
1415
1496
  docs: >-
@@ -1420,9 +1501,6 @@ types:
1420
1501
  docs: >-
1421
1502
  Time at which the Prompt was last modified. Measured in seconds since
1422
1503
  the Unix epoch.
1423
- version_description:
1424
- type: optional<string>
1425
- docs: An optional description of the Prompt version.
1426
1504
  source:
1427
1505
  openapi: evi-openapi.json
1428
1506
  ReturnPagedConfigs:
@@ -1478,15 +1556,32 @@ types:
1478
1556
  Version numbers are integer values representing different iterations
1479
1557
  of the Config. Each update to the Config increments its version
1480
1558
  number.
1559
+ language_model:
1560
+ type: optional<ReturnLanguageModel>
1561
+ docs: >-
1562
+ The supplemental language model associated with this Config.
1563
+
1564
+
1565
+ This model is used to generate longer, more detailed responses from
1566
+ EVI. Choosing an appropriate supplemental language model for your use
1567
+ case is crucial for generating fast, high-quality responses from EVI.
1568
+ builtin_tools:
1569
+ type: optional<list<optional<ReturnBuiltinTool>>>
1570
+ docs: List of built-in tools associated with this Config.
1481
1571
  evi_version:
1482
1572
  type: optional<string>
1483
1573
  docs: >-
1484
- Specifies the EVI version to use. Use `"1"` for version 1, or `"2"`
1485
- for the latest enhanced version. For a detailed comparison of the two
1486
- versions, refer to our
1487
- [guide](/docs/speech-to-speech-evi/configuration/evi-version).
1574
+ Specifies the EVI version to use. See our [EVI Version
1575
+ Guide](/docs/speech-to-speech-evi/configuration/evi-version) for
1576
+ differences between versions.
1577
+
1578
+
1579
+ **We're officially sunsetting EVI versions 1 and 2 on August 30,
1580
+ 2025**. To keep things running smoothly, be sure to [migrate to EVI
1581
+ 3](/docs/speech-to-speech-evi/configuration/evi-version#migrating-to-evi-3)
1582
+ before then.
1488
1583
  timeouts: optional<ReturnTimeoutSpecs>
1489
- nudges: optional<ReturnNudgeSpec>
1584
+ event_messages: optional<ReturnEventMessageSpecs>
1490
1585
  ellm_model:
1491
1586
  type: optional<ReturnEllmModel>
1492
1587
  docs: >-
@@ -1497,14 +1592,12 @@ types:
1497
1592
  model that takes into account both expression measures and language.
1498
1593
  The eLLM generates short, empathic language responses and guides
1499
1594
  text-to-speech (TTS) prosody.
1500
- voice: optional<unknown>
1501
- prompt: optional<ReturnPrompt>
1502
- tools:
1503
- type: optional<list<optional<ReturnUserDefinedTool>>>
1504
- docs: List of user-defined tools associated with this Config.
1505
1595
  webhooks:
1506
1596
  type: optional<list<optional<ReturnWebhookSpec>>>
1507
1597
  docs: Map of webhooks associated with this config.
1598
+ version_description:
1599
+ type: optional<string>
1600
+ docs: An optional description of the Config version.
1508
1601
  created_on:
1509
1602
  type: optional<long>
1510
1603
  docs: >-
@@ -1515,22 +1608,12 @@ types:
1515
1608
  docs: >-
1516
1609
  Time at which the Config was last modified. Measured in seconds since
1517
1610
  the Unix epoch.
1518
- language_model:
1519
- type: optional<ReturnLanguageModel>
1520
- docs: >-
1521
- The supplemental language model associated with this Config.
1522
-
1523
-
1524
- This model is used to generate longer, more detailed responses from
1525
- EVI. Choosing an appropriate supplemental language model for your use
1526
- case is crucial for generating fast, high-quality responses from EVI.
1527
- builtin_tools:
1528
- type: optional<list<optional<ReturnBuiltinTool>>>
1529
- docs: List of built-in tools associated with this Config.
1530
- event_messages: optional<ReturnEventMessageSpecs>
1531
- version_description:
1532
- type: optional<string>
1533
- docs: An optional description of the Config version.
1611
+ nudges: optional<ReturnNudgeSpec>
1612
+ voice: optional<unknown>
1613
+ prompt: optional<ReturnPrompt>
1614
+ tools:
1615
+ type: optional<list<optional<ReturnUserDefinedTool>>>
1616
+ docs: List of user-defined tools associated with this Config.
1534
1617
  source:
1535
1618
  openapi: evi-openapi.json
1536
1619
  ReturnPagedChatsPaginationDirection:
@@ -2632,50 +2715,58 @@ types:
2632
2715
  The role of the entity which generated the Chat Event. There are four
2633
2716
  possible values:
2634
2717
 
2635
-
2636
2718
  - `USER`: The user, capable of sending user messages and interruptions.
2637
2719
 
2638
-
2639
2720
  - `AGENT`: The assistant, capable of sending agent messages.
2640
2721
 
2641
-
2642
2722
  - `SYSTEM`: The backend server, capable of transmitting errors.
2643
2723
 
2644
-
2645
2724
  - `TOOL`: The function calling mechanism.
2646
2725
  inline: true
2647
2726
  source:
2648
2727
  openapi: evi-openapi.json
2649
2728
  ReturnChatEventType:
2650
2729
  enum:
2651
- - SYSTEM_PROMPT
2652
- - USER_MESSAGE
2653
- - USER_INTERRUPTION
2654
- - AGENT_MESSAGE
2655
2730
  - FUNCTION_CALL
2656
2731
  - FUNCTION_CALL_RESPONSE
2732
+ - CHAT_END_MESSAGE
2733
+ - AGENT_MESSAGE
2734
+ - SYSTEM_PROMPT
2735
+ - USER_RECORDING_START_MESSAGE
2736
+ - RESUME_ONSET
2737
+ - USER_INTERRUPTION
2738
+ - CHAT_START_MESSAGE
2739
+ - PAUSE_ONSET
2740
+ - USER_MESSAGE
2657
2741
  docs: >-
2658
- Type of Chat Event. There are six possible values:
2659
-
2742
+ Type of Chat Event. There are eleven Chat Event types:
2660
2743
 
2661
- - `SYSTEM_PROMPT`: Contains the system prompt for use in the session.
2744
+ - `SYSTEM_PROMPT`: The system prompt used to initialize the session.
2662
2745
 
2746
+ - `CHAT_START_MESSAGE`: Marks the beginning of the chat session.
2663
2747
 
2664
- - `USER_MESSAGE`: Contains the message sent by the user.
2748
+ - `USER_RECORDING_START_MESSAGE`: Marks when the client began streaming
2749
+ audio and the start of audio processing.
2665
2750
 
2751
+ - `USER_MESSAGE`: A message sent by the user.
2666
2752
 
2667
- - `USER_INTERRUPTION`: Contains an interruption made by the user while the
2668
- agent is speaking.
2753
+ - `USER_INTERRUPTION`: A user-initiated interruption while the assistant
2754
+ is speaking.
2669
2755
 
2756
+ - `AGENT_MESSAGE`: A response generated by the assistant.
2670
2757
 
2671
- - `AGENT_MESSAGE`: Contains the assistant’s message, generated by Hume’s
2672
- eLLM and supplemental LLM.
2758
+ - `FUNCTION_CALL`: A record of a tool invocation by the assistant.
2673
2759
 
2760
+ - `FUNCTION_CALL_RESPONSE`: The result of a previously invoked function or
2761
+ tool.
2674
2762
 
2675
- - `FUNCTION_CALL`: Contains the invocation of a tool.
2763
+ - `PAUSE_ONSET`: Marks when the client sent a `pause_assistant_message` to
2764
+ pause the assistant.
2676
2765
 
2766
+ - `RESUME_ONSET`: Marks when the client sent a `resume_assistant_message`
2767
+ to resume the assistant.
2677
2768
 
2678
- - `FUNCTION_CALL_RESPONSE`: Contains the tool response.
2769
+ - `CHAT_END_MESSAGE`: Indicates the end of the chat session.
2679
2770
  inline: true
2680
2771
  source:
2681
2772
  openapi: evi-openapi.json
@@ -2699,42 +2790,45 @@ types:
2699
2790
  The role of the entity which generated the Chat Event. There are four
2700
2791
  possible values:
2701
2792
 
2702
-
2703
2793
  - `USER`: The user, capable of sending user messages and
2704
2794
  interruptions.
2705
2795
 
2706
-
2707
2796
  - `AGENT`: The assistant, capable of sending agent messages.
2708
2797
 
2709
-
2710
2798
  - `SYSTEM`: The backend server, capable of transmitting errors.
2711
2799
 
2712
-
2713
2800
  - `TOOL`: The function calling mechanism.
2714
2801
  type:
2715
2802
  type: ReturnChatEventType
2716
2803
  docs: >-
2717
- Type of Chat Event. There are six possible values:
2718
-
2804
+ Type of Chat Event. There are eleven Chat Event types:
2719
2805
 
2720
- - `SYSTEM_PROMPT`: Contains the system prompt for use in the session.
2806
+ - `SYSTEM_PROMPT`: The system prompt used to initialize the session.
2721
2807
 
2808
+ - `CHAT_START_MESSAGE`: Marks the beginning of the chat session.
2722
2809
 
2723
- - `USER_MESSAGE`: Contains the message sent by the user.
2810
+ - `USER_RECORDING_START_MESSAGE`: Marks when the client began
2811
+ streaming audio and the start of audio processing.
2724
2812
 
2813
+ - `USER_MESSAGE`: A message sent by the user.
2725
2814
 
2726
- - `USER_INTERRUPTION`: Contains an interruption made by the user while
2727
- the agent is speaking.
2815
+ - `USER_INTERRUPTION`: A user-initiated interruption while the
2816
+ assistant is speaking.
2728
2817
 
2818
+ - `AGENT_MESSAGE`: A response generated by the assistant.
2729
2819
 
2730
- - `AGENT_MESSAGE`: Contains the assistant’s message, generated by
2731
- Hume’s eLLM and supplemental LLM.
2820
+ - `FUNCTION_CALL`: A record of a tool invocation by the assistant.
2732
2821
 
2822
+ - `FUNCTION_CALL_RESPONSE`: The result of a previously invoked
2823
+ function or tool.
2733
2824
 
2734
- - `FUNCTION_CALL`: Contains the invocation of a tool.
2825
+ - `PAUSE_ONSET`: Marks when the client sent a
2826
+ `pause_assistant_message` to pause the assistant.
2735
2827
 
2828
+ - `RESUME_ONSET`: Marks when the client sent a
2829
+ `resume_assistant_message` to resume the assistant.
2736
2830
 
2737
- - `FUNCTION_CALL_RESPONSE`: Contains the tool response.
2831
+ - `CHAT_END_MESSAGE`: Indicates the end of the chat session.
2738
2832
  message_text:
2739
2833
  type: optional<string>
2740
2834
  docs: >-
@@ -141,10 +141,16 @@ service:
141
141
  evi_version:
142
142
  type: string
143
143
  docs: >-
144
- Specifies the EVI version to use. Use `"1"` for version 1, or
145
- `"2"` for the latest enhanced version. For a detailed comparison
146
- of the two versions, refer to our
147
- [guide](/docs/speech-to-speech-evi/configuration/evi-version).
144
+ Specifies the EVI version to use. See our [EVI Version
145
+ Guide](/docs/speech-to-speech-evi/configuration/evi-version) for
146
+ differences between versions.
147
+
148
+
149
+ **We're officially sunsetting EVI versions 1 and 2 on August 30,
150
+ 2025**. To keep things running smoothly, be sure to [migrate to
151
+ EVI
152
+ 3](/docs/speech-to-speech-evi/configuration/evi-version#migrating-to-evi-3)
153
+ before then.
148
154
  name:
149
155
  type: string
150
156
  docs: Name applied to all versions of a particular Config.
@@ -453,40 +453,7 @@ types:
453
453
  source:
454
454
  openapi: tts-openapi.yml
455
455
  SnippetAudioChunk:
456
- properties:
457
- audio:
458
- type: string
459
- docs: The generated audio output chunk in the requested format.
460
- chunk_index:
461
- type: integer
462
- docs: The index of the audio chunk in the snippet.
463
- generation_id:
464
- type: string
465
- docs: >-
466
- The generation ID of the parent snippet that this chunk corresponds
467
- to.
468
- is_last_chunk:
469
- type: boolean
470
- docs: >-
471
- Whether or not this is the last chunk streamed back from the decoder
472
- for one input snippet.
473
- snippet_id:
474
- type: string
475
- docs: The ID of the parent snippet that this chunk corresponds to.
476
- text:
477
- type: string
478
- docs: The text of the parent snippet that this chunk corresponds to.
479
- transcribed_text:
480
- type: optional<string>
481
- docs: >-
482
- The transcribed text of the generated audio of the parent snippet that
483
- this chunk corresponds to. It is only present if `instant_mode` is set
484
- to `false`.
485
- utterance_index:
486
- type: optional<integer>
487
- docs: >-
488
- The index of the utterance in the request that the parent snippet of
489
- this chunk corresponds to.
456
+ properties: {}
490
457
  source:
491
458
  openapi: tts-openapi.yml
492
459
  PostedUtterance:
@@ -514,11 +481,13 @@ types:
514
481
  maxLength: 1000
515
482
  speed:
516
483
  type: optional<double>
517
- docs: Speed multiplier for the synthesized speech.
484
+ docs: >-
485
+ Speed multiplier for the synthesized speech. Extreme values below 0.75
486
+ and above 1.5 may sometimes cause instability to the generated output.
518
487
  default: 1
519
488
  validation:
520
- min: 0.25
521
- max: 3
489
+ min: 0.5
490
+ max: 2
522
491
  text:
523
492
  type: string
524
493
  docs: The input text to be synthesized into speech.
@@ -527,7 +496,7 @@ types:
527
496
  trailing_silence:
528
497
  type: optional<double>
529
498
  docs: Duration of trailing silence (in seconds) to add to this utterance
530
- default: 0.35
499
+ default: 0
531
500
  validation:
532
501
  min: 0
533
502
  max: 5
@@ -1 +1,2 @@
1
1
  export {};
2
+ export * from "./requests";
@@ -1,2 +1,17 @@
1
1
  "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
2
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./requests"), exports);
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * @example
6
+ * {
7
+ * modelResource: "model_resource"
8
+ * }
9
+ */
10
+ export interface BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost {
11
+ modelResource: string;
12
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1 @@
1
+ export { type BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost } from "./BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost";
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as errors from "../../../../errors/index";
5
+ import * as Hume from "../../../index";
6
+ import * as core from "../../../../core";
7
+ export declare class UnprocessableEntityError extends errors.HumeError {
8
+ constructor(body: Hume.empathicVoice.HttpValidationError, rawResponse?: core.RawResponse);
9
+ }
@@ -1,4 +1,7 @@
1
1
  "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
2
5
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
6
  if (k2 === undefined) k2 = k;
4
7
  var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -32,19 +35,18 @@ var __importStar = (this && this.__importStar) || (function () {
32
35
  return result;
33
36
  };
34
37
  })();
35
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
36
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
37
- return new (P || (P = Promise))(function (resolve, reject) {
38
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
39
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
40
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
41
- step((generator = generator.apply(thisArg, _arguments || [])).next());
42
- });
43
- };
44
38
  Object.defineProperty(exports, "__esModule", { value: true });
45
- exports.toReadableStream = toReadableStream;
46
- function toReadableStream(encoder) {
47
- return __awaiter(this, void 0, void 0, function* () {
48
- return (yield Promise.resolve().then(() => __importStar(require("readable-stream")))).Readable.from(encoder);
49
- });
39
+ exports.UnprocessableEntityError = void 0;
40
+ const errors = __importStar(require("../../../../errors/index"));
41
+ class UnprocessableEntityError extends errors.HumeError {
42
+ constructor(body, rawResponse) {
43
+ super({
44
+ message: "UnprocessableEntityError",
45
+ statusCode: 422,
46
+ body: body,
47
+ rawResponse: rawResponse,
48
+ });
49
+ Object.setPrototypeOf(this, UnprocessableEntityError.prototype);
50
+ }
50
51
  }
52
+ exports.UnprocessableEntityError = UnprocessableEntityError;
@@ -1 +1,2 @@
1
+ export * from "./UnprocessableEntityError";
1
2
  export * from "./BadRequestError";
@@ -14,4 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./UnprocessableEntityError"), exports);
17
18
  __exportStar(require("./BadRequestError"), exports);
@@ -1 +1,2 @@
1
+ export {};
1
2
  export * from "./requests";
@@ -1 +1,2 @@
1
+ export {};
1
2
  export * from "./requests";
@@ -1 +1,2 @@
1
+ export {};
1
2
  export * from "./requests";
@@ -37,7 +37,11 @@ import * as Hume from "../../../../../../index";
37
37
  * }
38
38
  */
39
39
  export interface PostedConfig {
40
- /** 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). */
40
+ /**
41
+ * Specifies the EVI version to use. See our [EVI Version Guide](/docs/speech-to-speech-evi/configuration/evi-version) for differences between versions.
42
+ *
43
+ * **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.
44
+ */
41
45
  eviVersion: string;
42
46
  /** Name applied to all versions of a particular Config. */
43
47
  name: string;
@@ -1 +1,2 @@
1
+ export {};
1
2
  export * from "./requests";
@@ -1 +1,2 @@
1
+ export {};
1
2
  export * from "./requests";