hume 0.13.3 → 0.13.5

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 (91) hide show
  1. package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +1 -5
  2. package/api/resources/empathicVoice/types/AssistantInput.d.ts +1 -1
  3. package/api/resources/empathicVoice/types/AssistantMessage.d.ts +1 -1
  4. package/api/resources/empathicVoice/types/ChatMetadata.d.ts +2 -2
  5. package/api/resources/empathicVoice/types/PauseAssistantMessage.d.ts +1 -1
  6. package/api/resources/empathicVoice/types/SessionSettings.d.ts +9 -7
  7. package/api/resources/empathicVoice/types/ToolCallMessage.d.ts +1 -1
  8. package/api/resources/empathicVoice/types/ToolErrorMessage.d.ts +2 -2
  9. package/api/resources/empathicVoice/types/ToolResponseMessage.d.ts +3 -3
  10. package/api/resources/empathicVoice/types/UserMessage.d.ts +3 -3
  11. package/api/resources/tts/types/PublishTts.d.ts +23 -0
  12. package/api/resources/tts/types/PublishTts.js +5 -0
  13. package/api/resources/tts/types/SnippetAudioChunk.d.ts +6 -1
  14. package/api/resources/tts/types/index.d.ts +7 -6
  15. package/api/resources/tts/types/index.js +7 -6
  16. package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +1 -5
  17. package/dist/api/resources/empathicVoice/types/AssistantInput.d.ts +1 -1
  18. package/dist/api/resources/empathicVoice/types/AssistantMessage.d.ts +1 -1
  19. package/dist/api/resources/empathicVoice/types/ChatMetadata.d.ts +2 -2
  20. package/dist/api/resources/empathicVoice/types/PauseAssistantMessage.d.ts +1 -1
  21. package/dist/api/resources/empathicVoice/types/SessionSettings.d.ts +9 -7
  22. package/dist/api/resources/empathicVoice/types/ToolCallMessage.d.ts +1 -1
  23. package/dist/api/resources/empathicVoice/types/ToolErrorMessage.d.ts +2 -2
  24. package/dist/api/resources/empathicVoice/types/ToolResponseMessage.d.ts +3 -3
  25. package/dist/api/resources/empathicVoice/types/UserMessage.d.ts +3 -3
  26. package/dist/api/resources/tts/types/PublishTts.d.ts +23 -0
  27. package/dist/api/resources/tts/types/PublishTts.js +5 -0
  28. package/dist/api/resources/tts/types/SnippetAudioChunk.d.ts +6 -1
  29. package/dist/api/resources/tts/types/index.d.ts +7 -6
  30. package/dist/api/resources/tts/types/index.js +7 -6
  31. package/dist/serialization/resources/empathicVoice/types/SessionSettings.d.ts +1 -0
  32. package/dist/serialization/resources/empathicVoice/types/SessionSettings.js +1 -0
  33. package/dist/serialization/resources/tts/types/PublishTts.d.ts +19 -0
  34. package/dist/serialization/resources/tts/types/PublishTts.js +50 -0
  35. package/dist/serialization/resources/tts/types/SnippetAudioChunk.d.ts +2 -1
  36. package/dist/serialization/resources/tts/types/SnippetAudioChunk.js +2 -1
  37. package/dist/serialization/resources/tts/types/index.d.ts +7 -6
  38. package/dist/serialization/resources/tts/types/index.js +7 -6
  39. package/dist/version.d.ts +1 -1
  40. package/dist/version.js +1 -1
  41. package/dist/wrapper/EVIWebAudioPlayer.d.ts +6 -7
  42. package/dist/wrapper/EVIWebAudioPlayer.js +237 -73
  43. package/dist/wrapper/SilenceFiller.d.ts +85 -0
  44. package/dist/wrapper/SilenceFiller.js +203 -0
  45. package/dist/wrapper/collate.d.ts +36 -0
  46. package/dist/wrapper/collate.js +126 -0
  47. package/dist/wrapper/convertFrequencyScale.d.ts +1 -0
  48. package/dist/wrapper/convertFrequencyScale.js +28 -0
  49. package/dist/wrapper/generateEmptyFft.d.ts +1 -0
  50. package/dist/wrapper/generateEmptyFft.js +6 -0
  51. package/dist/wrapper/index.d.ts +2 -0
  52. package/dist/wrapper/index.js +5 -1
  53. package/package.json +2 -1
  54. package/serialization/resources/empathicVoice/types/SessionSettings.d.ts +1 -0
  55. package/serialization/resources/empathicVoice/types/SessionSettings.js +1 -0
  56. package/serialization/resources/tts/types/PublishTts.d.ts +19 -0
  57. package/serialization/resources/tts/types/PublishTts.js +50 -0
  58. package/serialization/resources/tts/types/SnippetAudioChunk.d.ts +2 -1
  59. package/serialization/resources/tts/types/SnippetAudioChunk.js +2 -1
  60. package/serialization/resources/tts/types/index.d.ts +7 -6
  61. package/serialization/resources/tts/types/index.js +7 -6
  62. package/version.d.ts +1 -1
  63. package/version.js +1 -1
  64. package/wrapper/EVIWebAudioPlayer.d.ts +6 -7
  65. package/wrapper/EVIWebAudioPlayer.js +237 -73
  66. package/wrapper/SilenceFiller.d.ts +85 -0
  67. package/wrapper/SilenceFiller.js +203 -0
  68. package/wrapper/collate.d.ts +36 -0
  69. package/wrapper/collate.js +126 -0
  70. package/wrapper/convertFrequencyScale.d.ts +1 -0
  71. package/wrapper/convertFrequencyScale.js +28 -0
  72. package/wrapper/generateEmptyFft.d.ts +1 -0
  73. package/wrapper/generateEmptyFft.js +6 -0
  74. package/wrapper/index.d.ts +2 -0
  75. package/wrapper/index.js +5 -1
  76. package/.mock/definition/api.yml +0 -12
  77. package/.mock/definition/empathic-voice/__package__.yml +0 -2973
  78. package/.mock/definition/empathic-voice/chat.yml +0 -175
  79. package/.mock/definition/empathic-voice/chatGroups.yml +0 -627
  80. package/.mock/definition/empathic-voice/chatWebhooks.yml +0 -30
  81. package/.mock/definition/empathic-voice/chats.yml +0 -506
  82. package/.mock/definition/empathic-voice/configs.yml +0 -852
  83. package/.mock/definition/empathic-voice/prompts.yml +0 -558
  84. package/.mock/definition/empathic-voice/tools.yml +0 -626
  85. package/.mock/definition/expression-measurement/__package__.yml +0 -1
  86. package/.mock/definition/expression-measurement/batch/__package__.yml +0 -1803
  87. package/.mock/definition/expression-measurement/stream/__package__.yml +0 -113
  88. package/.mock/definition/expression-measurement/stream/stream.yml +0 -438
  89. package/.mock/definition/tts/__package__.yml +0 -660
  90. package/.mock/definition/tts/voices.yml +0 -143
  91. package/.mock/fern.config.json +0 -4
@@ -1,852 +0,0 @@
1
- imports:
2
- root: __package__.yml
3
- service:
4
- auth: false
5
- base-path: ''
6
- endpoints:
7
- list-configs:
8
- path: /v0/evi/configs
9
- method: GET
10
- auth: true
11
- docs: >-
12
- Fetches a paginated list of **Configs**.
13
-
14
-
15
- For more details on configuration options and how to configure EVI, see
16
- our [configuration guide](/docs/speech-to-speech-evi/configuration).
17
- pagination:
18
- offset: $request.page_number
19
- results: $response.configs_page
20
- source:
21
- openapi: evi-openapi.json
22
- display-name: List configs
23
- request:
24
- name: ConfigsListConfigsRequest
25
- query-parameters:
26
- page_number:
27
- type: optional<integer>
28
- default: 0
29
- docs: >-
30
- Specifies the page number to retrieve, enabling pagination.
31
-
32
-
33
- This parameter uses zero-based indexing. For example, setting
34
- `page_number` to 0 retrieves the first page of results (items 0-9
35
- if `page_size` is 10), setting `page_number` to 1 retrieves the
36
- second page (items 10-19), and so on. Defaults to 0, which
37
- retrieves the first page.
38
- page_size:
39
- type: optional<integer>
40
- docs: >-
41
- Specifies the maximum number of results to include per page,
42
- enabling pagination. The value must be between 1 and 100,
43
- inclusive.
44
-
45
-
46
- For example, if `page_size` is set to 10, each page will include
47
- up to 10 items. Defaults to 10.
48
- restrict_to_most_recent:
49
- type: optional<boolean>
50
- docs: >-
51
- By default, `restrict_to_most_recent` is set to true, returning
52
- only the latest version of each tool. To include all versions of
53
- each tool in the list, set `restrict_to_most_recent` to false.
54
- name:
55
- type: optional<string>
56
- docs: Filter to only include configs with this name.
57
- response:
58
- docs: Success
59
- type: root.ReturnPagedConfigs
60
- status-code: 200
61
- errors:
62
- - root.BadRequestError
63
- examples:
64
- - query-parameters:
65
- page_number: 0
66
- page_size: 1
67
- response:
68
- body:
69
- page_number: 0
70
- page_size: 1
71
- total_pages: 1
72
- configs_page:
73
- - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
74
- version: 0
75
- version_description: ''
76
- name: Weather Assistant Config
77
- created_on: 1715267200693
78
- modified_on: 1715267200693
79
- evi_version: '3'
80
- prompt:
81
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
82
- version: 0
83
- version_type: FIXED
84
- version_description: ''
85
- name: Weather Assistant Prompt
86
- created_on: 1715267200693
87
- modified_on: 1715267200693
88
- text: >-
89
- <role>You are an AI weather assistant providing users with
90
- accurate and up-to-date weather information. Respond to
91
- user queries concisely and clearly. Use simple language
92
- and avoid technical jargon. Provide temperature,
93
- precipitation, wind conditions, and any weather alerts.
94
- Include helpful tips if severe weather is expected.</role>
95
- voice:
96
- provider: HUME_AI
97
- name: Ava Song
98
- id: 5bb7de05-c8fe-426a-8fcc-ba4fc4ce9f9c
99
- language_model:
100
- model_provider: ANTHROPIC
101
- model_resource: claude-3-7-sonnet-latest
102
- temperature: 1
103
- ellm_model:
104
- allow_short_responses: false
105
- tools: []
106
- builtin_tools: []
107
- event_messages:
108
- on_new_chat:
109
- enabled: false
110
- text: ''
111
- on_inactivity_timeout:
112
- enabled: false
113
- text: ''
114
- on_max_duration_timeout:
115
- enabled: false
116
- text: ''
117
- timeouts:
118
- inactivity:
119
- enabled: true
120
- duration_secs: 600
121
- max_duration:
122
- enabled: true
123
- duration_secs: 1800
124
- create-config:
125
- path: /v0/evi/configs
126
- method: POST
127
- auth: true
128
- docs: >-
129
- Creates a **Config** which can be applied to EVI.
130
-
131
-
132
- For more details on configuration options and how to configure EVI, see
133
- our [configuration guide](/docs/speech-to-speech-evi/configuration).
134
- source:
135
- openapi: evi-openapi.json
136
- display-name: Create config
137
- request:
138
- name: PostedConfig
139
- body:
140
- properties:
141
- evi_version:
142
- type: string
143
- docs: >-
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.
154
- name:
155
- type: string
156
- docs: Name applied to all versions of a particular Config.
157
- version_description:
158
- type: optional<string>
159
- docs: An optional description of the Config version.
160
- prompt: optional<root.PostedConfigPromptSpec>
161
- voice:
162
- type: optional<root.VoiceRef>
163
- docs: A voice specification associated with this Config.
164
- language_model:
165
- type: optional<root.PostedLanguageModel>
166
- docs: >-
167
- The supplemental language model associated with this Config.
168
-
169
-
170
- This model is used to generate longer, more detailed responses
171
- from EVI. Choosing an appropriate supplemental language model
172
- for your use case is crucial for generating fast, high-quality
173
- responses from EVI.
174
- ellm_model:
175
- type: optional<root.PostedEllmModel>
176
- docs: >-
177
- The eLLM setup associated with this Config.
178
-
179
-
180
- Hume's eLLM (empathic Large Language Model) is a multimodal
181
- language model that takes into account both expression measures
182
- and language. The eLLM generates short, empathic language
183
- responses and guides text-to-speech (TTS) prosody.
184
- tools:
185
- type: optional<list<optional<root.PostedUserDefinedToolSpec>>>
186
- docs: List of user-defined tools associated with this Config.
187
- builtin_tools:
188
- type: optional<list<optional<root.PostedBuiltinTool>>>
189
- docs: List of built-in tools associated with this Config.
190
- event_messages: optional<root.PostedEventMessageSpecs>
191
- nudges:
192
- type: optional<root.PostedNudgeSpec>
193
- docs: >-
194
- Configures nudges, brief audio prompts that can guide
195
- conversations when users pause or need encouragement to continue
196
- speaking. Nudges help create more natural, flowing interactions
197
- by providing gentle conversational cues.
198
- timeouts: optional<root.PostedTimeoutSpecs>
199
- webhooks:
200
- type: optional<list<optional<root.PostedWebhookSpec>>>
201
- docs: Webhook config specifications for each subscriber.
202
- content-type: application/json
203
- response:
204
- docs: Created
205
- type: root.ReturnConfig
206
- status-code: 201
207
- errors:
208
- - root.BadRequestError
209
- examples:
210
- - request:
211
- name: Weather Assistant Config
212
- prompt:
213
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
214
- version: 0
215
- evi_version: '3'
216
- voice:
217
- provider: HUME_AI
218
- name: Ava Song
219
- language_model:
220
- model_provider: ANTHROPIC
221
- model_resource: claude-3-7-sonnet-latest
222
- temperature: 1
223
- event_messages:
224
- on_new_chat:
225
- enabled: false
226
- text: ''
227
- on_inactivity_timeout:
228
- enabled: false
229
- text: ''
230
- on_max_duration_timeout:
231
- enabled: false
232
- text: ''
233
- response:
234
- body:
235
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
236
- version: 0
237
- version_description: ''
238
- name: Weather Assistant Config
239
- created_on: 1715275452390
240
- modified_on: 1715275452390
241
- evi_version: '3'
242
- prompt:
243
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
244
- version: 0
245
- version_type: FIXED
246
- version_description: ''
247
- name: Weather Assistant Prompt
248
- created_on: 1715267200693
249
- modified_on: 1715267200693
250
- text: >-
251
- <role>You are an AI weather assistant providing users with
252
- accurate and up-to-date weather information. Respond to user
253
- queries concisely and clearly. Use simple language and avoid
254
- technical jargon. Provide temperature, precipitation, wind
255
- conditions, and any weather alerts. Include helpful tips if
256
- severe weather is expected.</role>
257
- voice:
258
- provider: HUME_AI
259
- name: Ava Song
260
- id: 5bb7de05-c8fe-426a-8fcc-ba4fc4ce9f9c
261
- language_model:
262
- model_provider: ANTHROPIC
263
- model_resource: claude-3-7-sonnet-latest
264
- temperature: 1
265
- ellm_model:
266
- allow_short_responses: false
267
- tools: []
268
- builtin_tools: []
269
- event_messages:
270
- on_new_chat:
271
- enabled: false
272
- text: ''
273
- on_inactivity_timeout:
274
- enabled: false
275
- text: ''
276
- on_max_duration_timeout:
277
- enabled: false
278
- text: ''
279
- timeouts:
280
- inactivity:
281
- enabled: true
282
- duration_secs: 600
283
- max_duration:
284
- enabled: true
285
- duration_secs: 1800
286
- list-config-versions:
287
- path: /v0/evi/configs/{id}
288
- method: GET
289
- auth: true
290
- docs: >-
291
- Fetches a list of a **Config's** versions.
292
-
293
-
294
- For more details on configuration options and how to configure EVI, see
295
- our [configuration guide](/docs/speech-to-speech-evi/configuration).
296
- pagination:
297
- offset: $request.page_number
298
- results: $response.configs_page
299
- source:
300
- openapi: evi-openapi.json
301
- path-parameters:
302
- id:
303
- type: string
304
- docs: Identifier for a Config. Formatted as a UUID.
305
- display-name: List config versions
306
- request:
307
- name: ConfigsListConfigVersionsRequest
308
- query-parameters:
309
- page_number:
310
- type: optional<integer>
311
- default: 0
312
- docs: >-
313
- Specifies the page number to retrieve, enabling pagination.
314
-
315
-
316
- This parameter uses zero-based indexing. For example, setting
317
- `page_number` to 0 retrieves the first page of results (items 0-9
318
- if `page_size` is 10), setting `page_number` to 1 retrieves the
319
- second page (items 10-19), and so on. Defaults to 0, which
320
- retrieves the first page.
321
- page_size:
322
- type: optional<integer>
323
- docs: >-
324
- Specifies the maximum number of results to include per page,
325
- enabling pagination. The value must be between 1 and 100,
326
- inclusive.
327
-
328
-
329
- For example, if `page_size` is set to 10, each page will include
330
- up to 10 items. Defaults to 10.
331
- restrict_to_most_recent:
332
- type: optional<boolean>
333
- docs: >-
334
- By default, `restrict_to_most_recent` is set to true, returning
335
- only the latest version of each config. To include all versions of
336
- each config in the list, set `restrict_to_most_recent` to false.
337
- response:
338
- docs: Success
339
- type: root.ReturnPagedConfigs
340
- status-code: 200
341
- errors:
342
- - root.BadRequestError
343
- examples:
344
- - path-parameters:
345
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
346
- response:
347
- body:
348
- page_number: 0
349
- page_size: 10
350
- total_pages: 1
351
- configs_page:
352
- - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
353
- version: 0
354
- version_description: ''
355
- name: Weather Assistant Config
356
- created_on: 1715275452390
357
- modified_on: 1715275452390
358
- evi_version: '3'
359
- prompt:
360
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
361
- version: 0
362
- version_type: FIXED
363
- version_description: ''
364
- name: Weather Assistant Prompt
365
- created_on: 1715267200693
366
- modified_on: 1715267200693
367
- text: >-
368
- <role>You are an AI weather assistant providing users with
369
- accurate and up-to-date weather information. Respond to
370
- user queries concisely and clearly. Use simple language
371
- and avoid technical jargon. Provide temperature,
372
- precipitation, wind conditions, and any weather alerts.
373
- Include helpful tips if severe weather is expected.</role>
374
- voice:
375
- provider: HUME_AI
376
- name: Ava Song
377
- id: 5bb7de05-c8fe-426a-8fcc-ba4fc4ce9f9c
378
- language_model:
379
- model_provider: ANTHROPIC
380
- model_resource: claude-3-7-sonnet-latest
381
- temperature: 1
382
- ellm_model:
383
- allow_short_responses: false
384
- tools: []
385
- builtin_tools: []
386
- event_messages:
387
- on_new_chat:
388
- enabled: false
389
- text: ''
390
- on_inactivity_timeout:
391
- enabled: false
392
- text: ''
393
- on_max_duration_timeout:
394
- enabled: false
395
- text: ''
396
- timeouts:
397
- inactivity:
398
- enabled: true
399
- duration_secs: 600
400
- max_duration:
401
- enabled: true
402
- duration_secs: 1800
403
- create-config-version:
404
- path: /v0/evi/configs/{id}
405
- method: POST
406
- auth: true
407
- docs: >-
408
- Updates a **Config** by creating a new version of the **Config**.
409
-
410
-
411
- For more details on configuration options and how to configure EVI, see
412
- our [configuration guide](/docs/speech-to-speech-evi/configuration).
413
- source:
414
- openapi: evi-openapi.json
415
- path-parameters:
416
- id:
417
- type: string
418
- docs: Identifier for a Config. Formatted as a UUID.
419
- display-name: Create config version
420
- request:
421
- name: PostedConfigVersion
422
- body:
423
- properties:
424
- evi_version:
425
- type: string
426
- docs: The version of the EVI used with this config.
427
- version_description:
428
- type: optional<string>
429
- docs: An optional description of the Config version.
430
- prompt: optional<root.PostedConfigPromptSpec>
431
- voice:
432
- type: optional<root.VoiceRef>
433
- docs: A voice specification associated with this Config version.
434
- language_model:
435
- type: optional<root.PostedLanguageModel>
436
- docs: >-
437
- The supplemental language model associated with this Config
438
- version.
439
-
440
-
441
- This model is used to generate longer, more detailed responses
442
- from EVI. Choosing an appropriate supplemental language model
443
- for your use case is crucial for generating fast, high-quality
444
- responses from EVI.
445
- ellm_model:
446
- type: optional<root.PostedEllmModel>
447
- docs: >-
448
- The eLLM setup associated with this Config version.
449
-
450
-
451
- Hume's eLLM (empathic Large Language Model) is a multimodal
452
- language model that takes into account both expression measures
453
- and language. The eLLM generates short, empathic language
454
- responses and guides text-to-speech (TTS) prosody.
455
- tools:
456
- type: optional<list<optional<root.PostedUserDefinedToolSpec>>>
457
- docs: List of user-defined tools associated with this Config version.
458
- builtin_tools:
459
- type: optional<list<optional<root.PostedBuiltinTool>>>
460
- docs: List of built-in tools associated with this Config version.
461
- event_messages: optional<root.PostedEventMessageSpecs>
462
- timeouts: optional<root.PostedTimeoutSpecs>
463
- nudges: optional<root.PostedNudgeSpec>
464
- webhooks:
465
- type: optional<list<optional<root.PostedWebhookSpec>>>
466
- docs: Webhook config specifications for each subscriber.
467
- content-type: application/json
468
- response:
469
- docs: Created
470
- type: root.ReturnConfig
471
- status-code: 201
472
- errors:
473
- - root.BadRequestError
474
- examples:
475
- - path-parameters:
476
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
477
- request:
478
- version_description: This is an updated version of the Weather Assistant Config.
479
- evi_version: '3'
480
- prompt:
481
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
482
- version: 0
483
- voice:
484
- provider: HUME_AI
485
- name: Ava Song
486
- language_model:
487
- model_provider: ANTHROPIC
488
- model_resource: claude-3-7-sonnet-latest
489
- temperature: 1
490
- ellm_model:
491
- allow_short_responses: true
492
- event_messages:
493
- on_new_chat:
494
- enabled: false
495
- text: ''
496
- on_inactivity_timeout:
497
- enabled: false
498
- text: ''
499
- on_max_duration_timeout:
500
- enabled: false
501
- text: ''
502
- response:
503
- body:
504
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
505
- version: 1
506
- version_description: This is an updated version of the Weather Assistant Config.
507
- name: Weather Assistant Config
508
- created_on: 1715275452390
509
- modified_on: 1722642242998
510
- evi_version: '3'
511
- prompt:
512
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
513
- version: 0
514
- version_type: FIXED
515
- version_description: ''
516
- name: Weather Assistant Prompt
517
- created_on: 1715267200693
518
- modified_on: 1715267200693
519
- text: >-
520
- <role>You are an AI weather assistant providing users with
521
- accurate and up-to-date weather information. Respond to user
522
- queries concisely and clearly. Use simple language and avoid
523
- technical jargon. Provide temperature, precipitation, wind
524
- conditions, and any weather alerts. Include helpful tips if
525
- severe weather is expected.</role>
526
- voice:
527
- provider: HUME_AI
528
- name: Ava Song
529
- id: 5bb7de05-c8fe-426a-8fcc-ba4fc4ce9f9c
530
- language_model:
531
- model_provider: ANTHROPIC
532
- model_resource: claude-3-7-sonnet-latest
533
- temperature: 1
534
- ellm_model:
535
- allow_short_responses: true
536
- tools: []
537
- builtin_tools: []
538
- event_messages:
539
- on_new_chat:
540
- enabled: false
541
- text: ''
542
- on_inactivity_timeout:
543
- enabled: false
544
- text: ''
545
- on_max_duration_timeout:
546
- enabled: false
547
- text: ''
548
- timeouts:
549
- inactivity:
550
- enabled: true
551
- duration_secs: 600
552
- max_duration:
553
- enabled: true
554
- duration_secs: 1800
555
- delete-config:
556
- path: /v0/evi/configs/{id}
557
- method: DELETE
558
- auth: true
559
- docs: >-
560
- Deletes a **Config** and its versions.
561
-
562
-
563
- For more details on configuration options and how to configure EVI, see
564
- our [configuration guide](/docs/speech-to-speech-evi/configuration).
565
- source:
566
- openapi: evi-openapi.json
567
- path-parameters:
568
- id:
569
- type: string
570
- docs: Identifier for a Config. Formatted as a UUID.
571
- display-name: Delete config
572
- errors:
573
- - root.BadRequestError
574
- examples:
575
- - path-parameters:
576
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
577
- update-config-name:
578
- path: /v0/evi/configs/{id}
579
- method: PATCH
580
- auth: true
581
- docs: >-
582
- Updates the name of a **Config**.
583
-
584
-
585
- For more details on configuration options and how to configure EVI, see
586
- our [configuration guide](/docs/speech-to-speech-evi/configuration).
587
- source:
588
- openapi: evi-openapi.json
589
- path-parameters:
590
- id:
591
- type: string
592
- docs: Identifier for a Config. Formatted as a UUID.
593
- display-name: Update config name
594
- request:
595
- name: PostedConfigName
596
- body:
597
- properties:
598
- name:
599
- type: string
600
- docs: Name applied to all versions of a particular Config.
601
- content-type: application/json
602
- response:
603
- docs: Success
604
- type: text
605
- status-code: 200
606
- errors:
607
- - root.BadRequestError
608
- examples:
609
- - path-parameters:
610
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
611
- request:
612
- name: Updated Weather Assistant Config Name
613
- get-config-version:
614
- path: /v0/evi/configs/{id}/version/{version}
615
- method: GET
616
- auth: true
617
- docs: >-
618
- Fetches a specified version of a **Config**.
619
-
620
-
621
- For more details on configuration options and how to configure EVI, see
622
- our [configuration guide](/docs/speech-to-speech-evi/configuration).
623
- source:
624
- openapi: evi-openapi.json
625
- path-parameters:
626
- id:
627
- type: string
628
- docs: Identifier for a Config. Formatted as a UUID.
629
- version:
630
- type: integer
631
- docs: >-
632
- Version number for a Config.
633
-
634
-
635
- Configs, Prompts, Custom Voices, and Tools are versioned. This
636
- versioning system supports iterative development, allowing you to
637
- progressively refine configurations and revert to previous versions
638
- if needed.
639
-
640
-
641
- Version numbers are integer values representing different iterations
642
- of the Config. Each update to the Config increments its version
643
- number.
644
- display-name: Get config version
645
- response:
646
- docs: Success
647
- type: root.ReturnConfig
648
- status-code: 200
649
- errors:
650
- - root.BadRequestError
651
- examples:
652
- - path-parameters:
653
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
654
- version: 1
655
- response:
656
- body:
657
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
658
- version: 1
659
- version_description: ''
660
- name: Weather Assistant Config
661
- created_on: 1715275452390
662
- modified_on: 1715275452390
663
- evi_version: '3'
664
- prompt:
665
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
666
- version: 0
667
- version_type: FIXED
668
- version_description: ''
669
- name: Weather Assistant Prompt
670
- created_on: 1715267200693
671
- modified_on: 1715267200693
672
- text: >-
673
- <role>You are an AI weather assistant providing users with
674
- accurate and up-to-date weather information. Respond to user
675
- queries concisely and clearly. Use simple language and avoid
676
- technical jargon. Provide temperature, precipitation, wind
677
- conditions, and any weather alerts. Include helpful tips if
678
- severe weather is expected.</role>
679
- voice:
680
- provider: HUME_AI
681
- name: Ava Song
682
- id: 5bb7de05-c8fe-426a-8fcc-ba4fc4ce9f9c
683
- language_model:
684
- model_provider: ANTHROPIC
685
- model_resource: claude-3-7-sonnet-latest
686
- temperature: 1
687
- ellm_model:
688
- allow_short_responses: false
689
- tools: []
690
- builtin_tools: []
691
- event_messages:
692
- on_new_chat:
693
- enabled: false
694
- text: ''
695
- on_inactivity_timeout:
696
- enabled: false
697
- text: ''
698
- on_max_duration_timeout:
699
- enabled: false
700
- text: ''
701
- timeouts:
702
- inactivity:
703
- enabled: true
704
- duration_secs: 600
705
- max_duration:
706
- enabled: true
707
- duration_secs: 1800
708
- delete-config-version:
709
- path: /v0/evi/configs/{id}/version/{version}
710
- method: DELETE
711
- auth: true
712
- docs: >-
713
- Deletes a specified version of a **Config**.
714
-
715
-
716
- For more details on configuration options and how to configure EVI, see
717
- our [configuration guide](/docs/speech-to-speech-evi/configuration).
718
- source:
719
- openapi: evi-openapi.json
720
- path-parameters:
721
- id:
722
- type: string
723
- docs: Identifier for a Config. Formatted as a UUID.
724
- version:
725
- type: integer
726
- docs: >-
727
- Version number for a Config.
728
-
729
-
730
- Configs, Prompts, Custom Voices, and Tools are versioned. This
731
- versioning system supports iterative development, allowing you to
732
- progressively refine configurations and revert to previous versions
733
- if needed.
734
-
735
-
736
- Version numbers are integer values representing different iterations
737
- of the Config. Each update to the Config increments its version
738
- number.
739
- display-name: Delete config version
740
- errors:
741
- - root.BadRequestError
742
- examples:
743
- - path-parameters:
744
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
745
- version: 1
746
- update-config-description:
747
- path: /v0/evi/configs/{id}/version/{version}
748
- method: PATCH
749
- auth: true
750
- docs: >-
751
- Updates the description of a **Config**.
752
-
753
-
754
- For more details on configuration options and how to configure EVI, see
755
- our [configuration guide](/docs/speech-to-speech-evi/configuration).
756
- source:
757
- openapi: evi-openapi.json
758
- path-parameters:
759
- id:
760
- type: string
761
- docs: Identifier for a Config. Formatted as a UUID.
762
- version:
763
- type: integer
764
- docs: >-
765
- Version number for a Config.
766
-
767
-
768
- Configs, Prompts, Custom Voices, and Tools are versioned. This
769
- versioning system supports iterative development, allowing you to
770
- progressively refine configurations and revert to previous versions
771
- if needed.
772
-
773
-
774
- Version numbers are integer values representing different iterations
775
- of the Config. Each update to the Config increments its version
776
- number.
777
- display-name: Update config description
778
- request:
779
- name: PostedConfigVersionDescription
780
- body:
781
- properties:
782
- version_description:
783
- type: optional<string>
784
- docs: An optional description of the Config version.
785
- content-type: application/json
786
- response:
787
- docs: Success
788
- type: root.ReturnConfig
789
- status-code: 200
790
- errors:
791
- - root.BadRequestError
792
- examples:
793
- - path-parameters:
794
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
795
- version: 1
796
- request:
797
- version_description: This is an updated version_description.
798
- response:
799
- body:
800
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
801
- version: 1
802
- version_description: This is an updated version_description.
803
- name: Weather Assistant Config
804
- created_on: 1715275452390
805
- modified_on: 1715275452390
806
- evi_version: '3'
807
- prompt:
808
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
809
- version: 0
810
- version_type: FIXED
811
- version_description: ''
812
- name: Weather Assistant Prompt
813
- created_on: 1715267200693
814
- modified_on: 1715267200693
815
- text: >-
816
- <role>You are an AI weather assistant providing users with
817
- accurate and up-to-date weather information. Respond to user
818
- queries concisely and clearly. Use simple language and avoid
819
- technical jargon. Provide temperature, precipitation, wind
820
- conditions, and any weather alerts. Include helpful tips if
821
- severe weather is expected.</role>
822
- voice:
823
- provider: HUME_AI
824
- name: Ava Song
825
- id: 5bb7de05-c8fe-426a-8fcc-ba4fc4ce9f9c
826
- language_model:
827
- model_provider: ANTHROPIC
828
- model_resource: claude-3-7-sonnet-latest
829
- temperature: 1
830
- ellm_model:
831
- allow_short_responses: false
832
- tools: []
833
- builtin_tools: []
834
- event_messages:
835
- on_new_chat:
836
- enabled: false
837
- text: ''
838
- on_inactivity_timeout:
839
- enabled: false
840
- text: ''
841
- on_max_duration_timeout:
842
- enabled: false
843
- text: ''
844
- timeouts:
845
- inactivity:
846
- enabled: true
847
- duration_secs: 600
848
- max_duration:
849
- enabled: true
850
- duration_secs: 1800
851
- source:
852
- openapi: evi-openapi.json