hume 0.12.0 → 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 (171) hide show
  1. package/.mock/definition/empathic-voice/__package__.yml +170 -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/JsonMessage.d.ts +1 -1
  21. package/api/resources/empathicVoice/types/LanguageModelType.d.ts +17 -1
  22. package/api/resources/empathicVoice/types/LanguageModelType.js +16 -0
  23. package/api/resources/empathicVoice/types/ModelProviderEnum.d.ts +4 -1
  24. package/api/resources/empathicVoice/types/ModelProviderEnum.js +3 -0
  25. package/api/resources/empathicVoice/types/ReturnChatEvent.d.ts +12 -17
  26. package/api/resources/empathicVoice/types/ReturnChatEventRole.d.ts +0 -4
  27. package/api/resources/empathicVoice/types/ReturnChatEventType.d.ts +22 -18
  28. package/api/resources/empathicVoice/types/ReturnChatEventType.js +9 -4
  29. package/api/resources/empathicVoice/types/ReturnConfig.d.ts +21 -17
  30. package/api/resources/empathicVoice/types/ReturnPrompt.d.ts +2 -2
  31. package/api/resources/empathicVoice/types/SupportsToolUse.d.ts +7 -0
  32. package/api/resources/empathicVoice/types/SupportsToolUse.js +5 -0
  33. package/api/resources/empathicVoice/types/UserMessage.d.ts +8 -1
  34. package/api/resources/empathicVoice/types/index.d.ts +1 -0
  35. package/api/resources/empathicVoice/types/index.js +1 -0
  36. package/api/resources/expressionMeasurement/resources/batch/client/Client.d.ts +2 -4
  37. package/api/resources/expressionMeasurement/resources/batch/client/Client.js +1 -1
  38. package/api/resources/expressionMeasurement/resources/batch/client/index.d.ts +1 -0
  39. package/api/resources/tts/client/index.d.ts +1 -0
  40. package/api/resources/tts/resources/voices/client/index.d.ts +1 -0
  41. package/api/resources/tts/types/PostedUtterance.d.ts +1 -1
  42. package/api/resources/tts/types/SnippetAudioChunk.d.ts +0 -16
  43. package/core/fetcher/BinaryResponse.d.ts +17 -0
  44. package/core/fetcher/BinaryResponse.js +14 -0
  45. package/core/fetcher/Fetcher.d.ts +1 -1
  46. package/core/fetcher/ResponseWithBody.d.ts +4 -0
  47. package/core/fetcher/ResponseWithBody.js +6 -0
  48. package/core/fetcher/getFetchFn.js +3 -3
  49. package/core/fetcher/getResponseBody.js +33 -32
  50. package/core/fetcher/index.d.ts +1 -0
  51. package/core/file.d.ts +1 -0
  52. package/core/file.js +2 -0
  53. package/core/form-data-utils/FormDataWrapper.d.ts +5 -52
  54. package/core/form-data-utils/FormDataWrapper.js +104 -124
  55. package/core/index.d.ts +1 -0
  56. package/core/index.js +1 -0
  57. package/dist/api/resources/empathicVoice/client/index.d.ts +1 -0
  58. package/dist/api/resources/empathicVoice/client/index.js +15 -0
  59. package/dist/api/resources/empathicVoice/client/requests/BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost.d.ts +12 -0
  60. package/dist/api/resources/empathicVoice/client/requests/BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost.js +5 -0
  61. package/dist/api/resources/empathicVoice/client/requests/index.d.ts +1 -0
  62. package/dist/api/resources/empathicVoice/client/requests/index.js +2 -0
  63. package/dist/api/resources/empathicVoice/errors/UnprocessableEntityError.d.ts +9 -0
  64. package/dist/{core/form-data-utils/toReadableStream.js → api/resources/empathicVoice/errors/UnprocessableEntityError.js} +16 -14
  65. package/dist/api/resources/empathicVoice/errors/index.d.ts +1 -0
  66. package/dist/api/resources/empathicVoice/errors/index.js +1 -0
  67. package/dist/api/resources/empathicVoice/resources/chatGroups/client/index.d.ts +1 -0
  68. package/dist/api/resources/empathicVoice/resources/chats/client/index.d.ts +1 -0
  69. package/dist/api/resources/empathicVoice/resources/configs/client/index.d.ts +1 -0
  70. package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +5 -1
  71. package/dist/api/resources/empathicVoice/resources/prompts/client/index.d.ts +1 -0
  72. package/dist/api/resources/empathicVoice/resources/tools/client/index.d.ts +1 -0
  73. package/dist/api/resources/empathicVoice/types/JsonMessage.d.ts +1 -1
  74. package/dist/api/resources/empathicVoice/types/LanguageModelType.d.ts +17 -1
  75. package/dist/api/resources/empathicVoice/types/LanguageModelType.js +16 -0
  76. package/dist/api/resources/empathicVoice/types/ModelProviderEnum.d.ts +4 -1
  77. package/dist/api/resources/empathicVoice/types/ModelProviderEnum.js +3 -0
  78. package/dist/api/resources/empathicVoice/types/ReturnChatEvent.d.ts +12 -17
  79. package/dist/api/resources/empathicVoice/types/ReturnChatEventRole.d.ts +0 -4
  80. package/dist/api/resources/empathicVoice/types/ReturnChatEventType.d.ts +22 -18
  81. package/dist/api/resources/empathicVoice/types/ReturnChatEventType.js +9 -4
  82. package/dist/api/resources/empathicVoice/types/ReturnConfig.d.ts +21 -17
  83. package/dist/api/resources/empathicVoice/types/ReturnPrompt.d.ts +2 -2
  84. package/dist/api/resources/empathicVoice/types/SupportsToolUse.d.ts +7 -0
  85. package/dist/api/resources/empathicVoice/types/SupportsToolUse.js +5 -0
  86. package/dist/api/resources/empathicVoice/types/UserMessage.d.ts +8 -1
  87. package/dist/api/resources/empathicVoice/types/index.d.ts +1 -0
  88. package/dist/api/resources/empathicVoice/types/index.js +1 -0
  89. package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.d.ts +2 -4
  90. package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +1 -1
  91. package/dist/api/resources/expressionMeasurement/resources/batch/client/index.d.ts +1 -0
  92. package/dist/api/resources/tts/client/index.d.ts +1 -0
  93. package/dist/api/resources/tts/resources/voices/client/index.d.ts +1 -0
  94. package/dist/api/resources/tts/types/PostedUtterance.d.ts +1 -1
  95. package/dist/api/resources/tts/types/SnippetAudioChunk.d.ts +0 -16
  96. package/dist/core/fetcher/BinaryResponse.d.ts +17 -0
  97. package/dist/core/fetcher/BinaryResponse.js +14 -0
  98. package/dist/core/fetcher/Fetcher.d.ts +1 -1
  99. package/dist/core/fetcher/ResponseWithBody.d.ts +4 -0
  100. package/dist/core/fetcher/ResponseWithBody.js +6 -0
  101. package/dist/core/fetcher/getFetchFn.js +3 -3
  102. package/dist/core/fetcher/getResponseBody.js +33 -32
  103. package/dist/core/fetcher/index.d.ts +1 -0
  104. package/dist/core/file.d.ts +1 -0
  105. package/dist/core/file.js +2 -0
  106. package/dist/core/form-data-utils/FormDataWrapper.d.ts +5 -52
  107. package/dist/core/form-data-utils/FormDataWrapper.js +104 -124
  108. package/dist/core/index.d.ts +1 -0
  109. package/dist/core/index.js +1 -0
  110. package/dist/serialization/resources/empathicVoice/client/index.d.ts +1 -0
  111. package/dist/serialization/resources/empathicVoice/client/index.js +17 -0
  112. package/dist/serialization/resources/empathicVoice/client/requests/BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost.d.ts +12 -0
  113. package/dist/serialization/resources/empathicVoice/client/requests/BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost.js +43 -0
  114. package/dist/serialization/resources/empathicVoice/client/requests/index.d.ts +1 -0
  115. package/dist/serialization/resources/empathicVoice/client/requests/index.js +5 -0
  116. package/dist/serialization/resources/empathicVoice/index.d.ts +1 -0
  117. package/dist/serialization/resources/empathicVoice/index.js +1 -0
  118. package/dist/serialization/resources/empathicVoice/types/JsonMessage.d.ts +2 -1
  119. package/dist/serialization/resources/empathicVoice/types/JsonMessage.js +2 -0
  120. package/dist/serialization/resources/empathicVoice/types/LanguageModelType.d.ts +1 -1
  121. package/dist/serialization/resources/empathicVoice/types/LanguageModelType.js +16 -0
  122. package/dist/serialization/resources/empathicVoice/types/ModelProviderEnum.d.ts +1 -1
  123. package/dist/serialization/resources/empathicVoice/types/ModelProviderEnum.js +3 -0
  124. package/dist/serialization/resources/empathicVoice/types/ReturnChatEventType.d.ts +1 -1
  125. package/dist/serialization/resources/empathicVoice/types/ReturnChatEventType.js +9 -4
  126. package/dist/serialization/resources/empathicVoice/types/ReturnConfig.d.ts +13 -13
  127. package/dist/serialization/resources/empathicVoice/types/ReturnConfig.js +13 -13
  128. package/dist/serialization/resources/empathicVoice/types/ReturnPrompt.d.ts +1 -1
  129. package/dist/serialization/resources/empathicVoice/types/ReturnPrompt.js +1 -1
  130. package/dist/serialization/resources/empathicVoice/types/SupportsToolUse.d.ts +13 -0
  131. package/dist/serialization/resources/empathicVoice/types/SupportsToolUse.js +44 -0
  132. package/dist/serialization/resources/empathicVoice/types/index.d.ts +1 -0
  133. package/dist/serialization/resources/empathicVoice/types/index.js +1 -0
  134. package/dist/serialization/resources/tts/types/SnippetAudioChunk.d.ts +0 -8
  135. package/dist/serialization/resources/tts/types/SnippetAudioChunk.js +1 -10
  136. package/dist/version.d.ts +1 -1
  137. package/dist/version.js +1 -1
  138. package/jest.browser.config.mjs +10 -0
  139. package/jest.config.mjs +1 -0
  140. package/package.json +6 -7
  141. package/reference.md +53 -1
  142. package/serialization/resources/empathicVoice/client/index.d.ts +1 -0
  143. package/serialization/resources/empathicVoice/client/index.js +17 -0
  144. package/serialization/resources/empathicVoice/client/requests/BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost.d.ts +12 -0
  145. package/serialization/resources/empathicVoice/client/requests/BodyCustomLanguageModelSupportsToolUseV0EviCustomLanguageModelSupportsToolUsePost.js +43 -0
  146. package/serialization/resources/empathicVoice/client/requests/index.d.ts +1 -0
  147. package/serialization/resources/empathicVoice/client/requests/index.js +5 -0
  148. package/serialization/resources/empathicVoice/index.d.ts +1 -0
  149. package/serialization/resources/empathicVoice/index.js +1 -0
  150. package/serialization/resources/empathicVoice/types/JsonMessage.d.ts +2 -1
  151. package/serialization/resources/empathicVoice/types/JsonMessage.js +2 -0
  152. package/serialization/resources/empathicVoice/types/LanguageModelType.d.ts +1 -1
  153. package/serialization/resources/empathicVoice/types/LanguageModelType.js +16 -0
  154. package/serialization/resources/empathicVoice/types/ModelProviderEnum.d.ts +1 -1
  155. package/serialization/resources/empathicVoice/types/ModelProviderEnum.js +3 -0
  156. package/serialization/resources/empathicVoice/types/ReturnChatEventType.d.ts +1 -1
  157. package/serialization/resources/empathicVoice/types/ReturnChatEventType.js +9 -4
  158. package/serialization/resources/empathicVoice/types/ReturnConfig.d.ts +13 -13
  159. package/serialization/resources/empathicVoice/types/ReturnConfig.js +13 -13
  160. package/serialization/resources/empathicVoice/types/ReturnPrompt.d.ts +1 -1
  161. package/serialization/resources/empathicVoice/types/ReturnPrompt.js +1 -1
  162. package/serialization/resources/empathicVoice/types/SupportsToolUse.d.ts +13 -0
  163. package/serialization/resources/empathicVoice/types/SupportsToolUse.js +44 -0
  164. package/serialization/resources/empathicVoice/types/index.d.ts +1 -0
  165. package/serialization/resources/empathicVoice/types/index.js +1 -0
  166. package/serialization/resources/tts/types/SnippetAudioChunk.d.ts +0 -8
  167. package/serialization/resources/tts/types/SnippetAudioChunk.js +1 -10
  168. package/version.d.ts +1 -1
  169. package/version.js +1 -1
  170. package/core/form-data-utils/toReadableStream.d.ts +0 -1
  171. 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.
@@ -1004,6 +1043,7 @@ types:
1004
1043
  - type: ToolCallMessage
1005
1044
  - type: ToolResponseMessage
1006
1045
  - type: ToolErrorMessage
1046
+ - type: AssistantProsody
1007
1047
  source:
1008
1048
  openapi: evi-asyncapi.json
1009
1049
  HTTPValidationError:
@@ -1028,12 +1068,22 @@ types:
1028
1068
  name: Claude3Sonnet20240229
1029
1069
  - value: claude-3-haiku-20240307
1030
1070
  name: Claude3Haiku20240307
1071
+ - value: claude-sonnet-4-20250514
1072
+ name: ClaudeSonnet420250514
1031
1073
  - value: us.anthropic.claude-3-5-haiku-20241022-v1:0
1032
1074
  name: UsAnthropicClaude35Haiku20241022V10
1033
1075
  - value: us.anthropic.claude-3-5-sonnet-20240620-v1:0
1034
1076
  name: UsAnthropicClaude35Sonnet20240620V10
1035
1077
  - value: us.anthropic.claude-3-haiku-20240307-v1:0
1036
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
1037
1087
  - value: gemini-1.5-pro
1038
1088
  name: Gemini15Pro
1039
1089
  - value: gemini-1.5-flash
@@ -1044,6 +1094,10 @@ types:
1044
1094
  name: Gemini15Flash002
1045
1095
  - value: gemini-2.0-flash
1046
1096
  name: Gemini20Flash
1097
+ - value: gemini-2.5-flash
1098
+ name: Gemini25Flash
1099
+ - value: gemini-2.5-flash-preview-04-17
1100
+ name: Gemini25FlashPreview0417
1047
1101
  - value: gpt-4-turbo
1048
1102
  name: Gpt4Turbo
1049
1103
  - value: gpt-4-turbo-preview
@@ -1056,6 +1110,8 @@ types:
1056
1110
  name: Gpt4O
1057
1111
  - value: gpt-4o-mini
1058
1112
  name: Gpt4OMini
1113
+ - value: gpt-4.1
1114
+ name: Gpt41
1059
1115
  - value: gemma-7b-it
1060
1116
  name: Gemma7BIt
1061
1117
  - value: llama3-8b-8192
@@ -1068,6 +1124,8 @@ types:
1068
1124
  name: Llama3370BVersatile
1069
1125
  - value: llama-3.1-8b-instant
1070
1126
  name: Llama318BInstant
1127
+ - value: moonshotai/kimi-k2-instruct
1128
+ name: MoonshotaiKimiK2Instruct
1071
1129
  - value: accounts/fireworks/models/mixtral-8x7b-instruct
1072
1130
  name: AccountsFireworksModelsMixtral8X7BInstruct
1073
1131
  - value: accounts/fireworks/models/llama-v3p1-405b-instruct
@@ -1076,9 +1134,21 @@ types:
1076
1134
  name: AccountsFireworksModelsLlamaV3P170BInstruct
1077
1135
  - value: accounts/fireworks/models/llama-v3p1-8b-instruct
1078
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
1079
1147
  - ellm
1080
1148
  - value: custom-language-model
1081
1149
  name: CustomLanguageModel
1150
+ - value: hume-evi-3-web-search
1151
+ name: HumeEvi3WebSearch
1082
1152
  source:
1083
1153
  openapi: evi-openapi.json
1084
1154
  ModelProviderEnum:
@@ -1091,6 +1161,15 @@ types:
1091
1161
  - GOOGLE
1092
1162
  - HUME_AI
1093
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
1094
1173
  source:
1095
1174
  openapi: evi-openapi.json
1096
1175
  ValidationErrorLocItem:
@@ -1409,6 +1488,9 @@ types:
1409
1488
  docs: >-
1410
1489
  Versioning method for a Prompt. Either `FIXED` for using a fixed
1411
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.
1412
1494
  created_on:
1413
1495
  type: long
1414
1496
  docs: >-
@@ -1419,9 +1501,6 @@ types:
1419
1501
  docs: >-
1420
1502
  Time at which the Prompt was last modified. Measured in seconds since
1421
1503
  the Unix epoch.
1422
- version_description:
1423
- type: optional<string>
1424
- docs: An optional description of the Prompt version.
1425
1504
  source:
1426
1505
  openapi: evi-openapi.json
1427
1506
  ReturnPagedConfigs:
@@ -1477,15 +1556,32 @@ types:
1477
1556
  Version numbers are integer values representing different iterations
1478
1557
  of the Config. Each update to the Config increments its version
1479
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.
1480
1571
  evi_version:
1481
1572
  type: optional<string>
1482
1573
  docs: >-
1483
- Specifies the EVI version to use. Use `"1"` for version 1, or `"2"`
1484
- for the latest enhanced version. For a detailed comparison of the two
1485
- versions, refer to our
1486
- [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.
1487
1583
  timeouts: optional<ReturnTimeoutSpecs>
1488
- nudges: optional<ReturnNudgeSpec>
1584
+ event_messages: optional<ReturnEventMessageSpecs>
1489
1585
  ellm_model:
1490
1586
  type: optional<ReturnEllmModel>
1491
1587
  docs: >-
@@ -1496,14 +1592,12 @@ types:
1496
1592
  model that takes into account both expression measures and language.
1497
1593
  The eLLM generates short, empathic language responses and guides
1498
1594
  text-to-speech (TTS) prosody.
1499
- voice: optional<unknown>
1500
- prompt: optional<ReturnPrompt>
1501
- tools:
1502
- type: optional<list<optional<ReturnUserDefinedTool>>>
1503
- docs: List of user-defined tools associated with this Config.
1504
1595
  webhooks:
1505
1596
  type: optional<list<optional<ReturnWebhookSpec>>>
1506
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.
1507
1601
  created_on:
1508
1602
  type: optional<long>
1509
1603
  docs: >-
@@ -1514,22 +1608,12 @@ types:
1514
1608
  docs: >-
1515
1609
  Time at which the Config was last modified. Measured in seconds since
1516
1610
  the Unix epoch.
1517
- language_model:
1518
- type: optional<ReturnLanguageModel>
1519
- docs: >-
1520
- The supplemental language model associated with this Config.
1521
-
1522
-
1523
- This model is used to generate longer, more detailed responses from
1524
- EVI. Choosing an appropriate supplemental language model for your use
1525
- case is crucial for generating fast, high-quality responses from EVI.
1526
- builtin_tools:
1527
- type: optional<list<optional<ReturnBuiltinTool>>>
1528
- docs: List of built-in tools associated with this Config.
1529
- event_messages: optional<ReturnEventMessageSpecs>
1530
- version_description:
1531
- type: optional<string>
1532
- 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.
1533
1617
  source:
1534
1618
  openapi: evi-openapi.json
1535
1619
  ReturnPagedChatsPaginationDirection:
@@ -2631,50 +2715,58 @@ types:
2631
2715
  The role of the entity which generated the Chat Event. There are four
2632
2716
  possible values:
2633
2717
 
2634
-
2635
2718
  - `USER`: The user, capable of sending user messages and interruptions.
2636
2719
 
2637
-
2638
2720
  - `AGENT`: The assistant, capable of sending agent messages.
2639
2721
 
2640
-
2641
2722
  - `SYSTEM`: The backend server, capable of transmitting errors.
2642
2723
 
2643
-
2644
2724
  - `TOOL`: The function calling mechanism.
2645
2725
  inline: true
2646
2726
  source:
2647
2727
  openapi: evi-openapi.json
2648
2728
  ReturnChatEventType:
2649
2729
  enum:
2650
- - SYSTEM_PROMPT
2651
- - USER_MESSAGE
2652
- - USER_INTERRUPTION
2653
- - AGENT_MESSAGE
2654
2730
  - FUNCTION_CALL
2655
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
2656
2741
  docs: >-
2657
- Type of Chat Event. There are six possible values:
2658
-
2742
+ Type of Chat Event. There are eleven Chat Event types:
2659
2743
 
2660
- - `SYSTEM_PROMPT`: Contains the system prompt for use in the session.
2744
+ - `SYSTEM_PROMPT`: The system prompt used to initialize the session.
2661
2745
 
2746
+ - `CHAT_START_MESSAGE`: Marks the beginning of the chat session.
2662
2747
 
2663
- - `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.
2664
2750
 
2751
+ - `USER_MESSAGE`: A message sent by the user.
2665
2752
 
2666
- - `USER_INTERRUPTION`: Contains an interruption made by the user while the
2667
- agent is speaking.
2753
+ - `USER_INTERRUPTION`: A user-initiated interruption while the assistant
2754
+ is speaking.
2668
2755
 
2756
+ - `AGENT_MESSAGE`: A response generated by the assistant.
2669
2757
 
2670
- - `AGENT_MESSAGE`: Contains the assistant’s message, generated by Hume’s
2671
- eLLM and supplemental LLM.
2758
+ - `FUNCTION_CALL`: A record of a tool invocation by the assistant.
2672
2759
 
2760
+ - `FUNCTION_CALL_RESPONSE`: The result of a previously invoked function or
2761
+ tool.
2673
2762
 
2674
- - `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.
2675
2765
 
2766
+ - `RESUME_ONSET`: Marks when the client sent a `resume_assistant_message`
2767
+ to resume the assistant.
2676
2768
 
2677
- - `FUNCTION_CALL_RESPONSE`: Contains the tool response.
2769
+ - `CHAT_END_MESSAGE`: Indicates the end of the chat session.
2678
2770
  inline: true
2679
2771
  source:
2680
2772
  openapi: evi-openapi.json
@@ -2698,42 +2790,45 @@ types:
2698
2790
  The role of the entity which generated the Chat Event. There are four
2699
2791
  possible values:
2700
2792
 
2701
-
2702
2793
  - `USER`: The user, capable of sending user messages and
2703
2794
  interruptions.
2704
2795
 
2705
-
2706
2796
  - `AGENT`: The assistant, capable of sending agent messages.
2707
2797
 
2708
-
2709
2798
  - `SYSTEM`: The backend server, capable of transmitting errors.
2710
2799
 
2711
-
2712
2800
  - `TOOL`: The function calling mechanism.
2713
2801
  type:
2714
2802
  type: ReturnChatEventType
2715
2803
  docs: >-
2716
- Type of Chat Event. There are six possible values:
2717
-
2804
+ Type of Chat Event. There are eleven Chat Event types:
2718
2805
 
2719
- - `SYSTEM_PROMPT`: Contains the system prompt for use in the session.
2806
+ - `SYSTEM_PROMPT`: The system prompt used to initialize the session.
2720
2807
 
2808
+ - `CHAT_START_MESSAGE`: Marks the beginning of the chat session.
2721
2809
 
2722
- - `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.
2723
2812
 
2813
+ - `USER_MESSAGE`: A message sent by the user.
2724
2814
 
2725
- - `USER_INTERRUPTION`: Contains an interruption made by the user while
2726
- the agent is speaking.
2815
+ - `USER_INTERRUPTION`: A user-initiated interruption while the
2816
+ assistant is speaking.
2727
2817
 
2818
+ - `AGENT_MESSAGE`: A response generated by the assistant.
2728
2819
 
2729
- - `AGENT_MESSAGE`: Contains the assistant’s message, generated by
2730
- Hume’s eLLM and supplemental LLM.
2820
+ - `FUNCTION_CALL`: A record of a tool invocation by the assistant.
2731
2821
 
2822
+ - `FUNCTION_CALL_RESPONSE`: The result of a previously invoked
2823
+ function or tool.
2732
2824
 
2733
- - `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.
2734
2827
 
2828
+ - `RESUME_ONSET`: Marks when the client sent a
2829
+ `resume_assistant_message` to resume the assistant.
2735
2830
 
2736
- - `FUNCTION_CALL_RESPONSE`: Contains the tool response.
2831
+ - `CHAT_END_MESSAGE`: Indicates the end of the chat session.
2737
2832
  message_text:
2738
2833
  type: optional<string>
2739
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";