Skip to content

Commit d2577f1

Browse files
committed
SDK regeneration
1 parent c339b2d commit d2577f1

22 files changed

+307
-246
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -664,6 +664,7 @@ service:
664664
response:
665665
docs: Success
666666
type: text
667+
status-code: 200
667668
errors:
668669
- root.BadRequestError
669670
examples:

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -377,6 +377,7 @@ service:
377377
response:
378378
docs: Success
379379
type: text
380+
status-code: 200
380381
errors:
381382
- root.BadRequestError
382383
examples:

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -430,6 +430,8 @@ service:
430430
content-type: application/json
431431
response:
432432
docs: Success
433+
type: text
434+
status-code: 200
433435
errors:
434436
- root.BadRequestError
435437
examples:

.mock/definition/tts/__package__.yml

Lines changed: 70 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ service:
2121
auth: true
2222
docs: >-
2323
Synthesizes one or more input texts into speech using the specified
24-
voice. If no voice is provided, a novel voice will be generated
24+
voice. If no voice is provided, a novel voice will be generated
2525
dynamically. Optionally, additional context can be included to influence
26-
the speech's style and prosody.
26+
the speech's style and prosody.
2727
2828
2929
The response includes the base64-encoded audio and metadata in JSON
@@ -49,14 +49,14 @@ service:
4949
the mind which contemplates them.
5050
description: >-
5151
Middle-aged masculine voice with a clear, rhythmic Scots lilt,
52-
rounded vowels, and a warm, steady tone with an articulate,
52+
rounded vowels, and a warm, steady tone with an articulate,
5353
academic quality.
5454
context:
5555
utterances:
5656
- text: How can people see beauty so differently?
5757
description: >-
5858
A curious student with a clear and respectful tone, seeking
59-
clarification on Hume's ideas with a straightforward
59+
clarification on Hume's ideas with a straightforward
6060
question.
6161
format:
6262
type: mp3
@@ -86,9 +86,9 @@ service:
8686
auth: true
8787
docs: >-
8888
Synthesizes one or more input texts into speech using the specified
89-
voice. If no voice is provided, a novel voice will be generated
89+
voice. If no voice is provided, a novel voice will be generated
9090
dynamically. Optionally, additional context can be included to influence
91-
the speech's style and prosody.
91+
the speech's style and prosody.
9292
9393
9494
The response contains the generated audio file in the requested format.
@@ -113,7 +113,7 @@ service:
113113
the mind which contemplates them.
114114
description: >-
115115
Middle-aged masculine voice with a clear, rhythmic Scots lilt,
116-
rounded vowels, and a warm, steady tone with an articulate,
116+
rounded vowels, and a warm, steady tone with an articulate,
117117
academic quality.
118118
context:
119119
generation_id: 09ad914d-8e7f-40f8-a279-e34f07f7dab2
@@ -126,7 +126,7 @@ service:
126126
auth: true
127127
docs: >-
128128
Streams synthesized speech using the specified voice. If no voice is
129-
provided, a novel voice will be generated dynamically. Optionally,
129+
provided, a novel voice will be generated dynamically. Optionally,
130130
additional context can be included to influence the speech's style and
131131
prosody.
132132
source:
@@ -150,7 +150,7 @@ service:
150150
the mind which contemplates them.
151151
description: >-
152152
Middle-aged masculine voice with a clear, rhythmic Scots lilt,
153-
rounded vowels, and a warm, steady tone with an articulate,
153+
rounded vowels, and a warm, steady tone with an articulate,
154154
academic quality.
155155
context:
156156
generation_id: 09ad914d-8e7f-40f8-a279-e34f07f7dab2
@@ -163,8 +163,8 @@ service:
163163
auth: true
164164
docs: >-
165165
Streams synthesized speech using the specified voice. If no voice is
166-
provided, a novel voice will be generated dynamically. Optionally,
167-
additional context can be included to influence the speech's style and
166+
provided, a novel voice will be generated dynamically. Optionally,
167+
additional context can be included to influence the speech's style and
168168
prosody.
169169
170170
@@ -191,14 +191,14 @@ service:
191191
the mind which contemplates them.
192192
description: >-
193193
Middle-aged masculine voice with a clear, rhythmic Scots lilt,
194-
rounded vowels, and a warm, steady tone with an articulate,
194+
rounded vowels, and a warm, steady tone with an articulate,
195195
academic quality.
196196
context:
197197
utterances:
198198
- text: How can people see beauty so differently?
199199
description: >-
200200
A curious student with a clear and respectful tone, seeking
201-
clarification on Hume's ideas with a straightforward
201+
clarification on Hume's ideas with a straightforward
202202
question.
203203
format:
204204
type: mp3
@@ -267,7 +267,7 @@ types:
267267
snippets:
268268
docs: >-
269269
A list of snippet groups where each group corresponds to an utterance
270-
in the request. Each group contains segmented snippets that represent
270+
in the request. Each group contains segmented snippets that represent
271271
the original utterance divided into more natural-sounding units
272272
optimized for speech delivery.
273273
type: list<list<Snippet>>
@@ -330,19 +330,19 @@ types:
330330
Controls how audio output is segmented in the response.
331331
332332
333-
- When **enabled** (`true`), input utterances are automatically split
333+
- When **enabled** (`true`), input utterances are automatically split
334334
into natural-sounding speech segments.
335335
336336
337-
- When **disabled** (`false`), the response maintains a strict
337+
- When **disabled** (`false`), the response maintains a strict
338338
one-to-one mapping between input utterances and output snippets.
339339
340340
341341
This setting affects how the `snippets` array is structured in the
342-
response, which may be important for applications that need to track
343-
the relationship between input text and generated audio segments.
344-
When setting to `false`, avoid including utterances with long `text`,
345-
as this can result in distorted output.
342+
response, which may be important for applications that need to track
343+
the relationship between input text and generated audio segments. When
344+
setting to `false`, avoid including utterances with long `text`, as
345+
this can result in distorted output.
346346
default: true
347347
strip_headers:
348348
type: optional<boolean>
@@ -357,9 +357,9 @@ types:
357357
A list of **Utterances** to be converted to speech output.
358358
359359
360-
An **Utterance** is a unit of input for
360+
An **Utterance** is a unit of input for
361361
[Octave](/docs/text-to-speech-tts/overview), and includes input
362-
`text`, an optional `description` to serve as the prompt for how the
362+
`text`, an optional `description` to serve as the prompt for how the
363363
speech should be delivered, an optional `voice` specification, and
364364
additional controls to guide delivery for `speed` and
365365
`trailing_silence`.
@@ -374,11 +374,11 @@ types:
374374
mode](/docs/text-to-speech-tts/overview#ultra-low-latency-streaming-instant-mode).
375375
376376
- Dynamic voice generation is not supported with this mode; a
377-
predefined
378-
[voice](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.utterances.voice)
377+
predefined
378+
[voice](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.utterances.voice)
379379
must be specified in your request.
380380
381-
- This mode is only supported for streaming endpoints (e.g.,
381+
- This mode is only supported for streaming endpoints (e.g.,
382382
[/v0/tts/stream/json](/reference/text-to-speech-tts/synthesize-json-streaming),
383383
[/v0/tts/stream/file](/reference/text-to-speech-tts/synthesize-file-streaming)).
384384
@@ -399,7 +399,7 @@ types:
399399
type: optional<string>
400400
docs: >-
401401
A unique ID associated with this request for tracking and
402-
troubleshooting. Use this ID when contacting [support](/support) for
402+
troubleshooting. Use this ID when contacting [support](/support) for
403403
troubleshooting assistance.
404404
source:
405405
openapi: tts-openapi.yml
@@ -414,16 +414,12 @@ types:
414414
docs: Name of the voice in the `Voice Library`.
415415
provider:
416416
type: optional<VoiceProvider>
417-
docs: |-
418-
Specifies the provider of the voice.
419-
420-
- **HUME_AI**: Preset voices generated by Hume.
421-
422-
- **CUSTOM_VOICE**: Voices you have generated and saved to your `Voice library`.
417+
docs: >-
418+
The provider associated with the created voice.
423419
424-
If a provider is not specified, the provider will default to `CUSTOM_VOICE`.
425420
426-
While Hume's preset voices are shared and usable by anyone, your custom voices are only available to calls made with your API key.
421+
Voices created through this endpoint will always have the provider set
422+
to `CUSTOM_VOICE`, indicating a custom voice stored in your account.
427423
source:
428424
openapi: tts-openapi.yml
429425
FormatPcm:
@@ -490,15 +486,15 @@ types:
490486
type: optional<string>
491487
docs: >-
492488
Natural language instructions describing how the synthesized speech
493-
should sound, including but not limited to tone, intonation, pacing,
494-
and accent (e.g., 'a soft, gentle voice with a strong British
489+
should sound, including but not limited to tone, intonation, pacing,
490+
and accent (e.g., 'a soft, gentle voice with a strong British
495491
accent').
496492
497493
- If a Voice is specified in the request, this description serves as
498-
acting instructions. For tips on how to effectively guide speech
494+
acting instructions. For tips on how to effectively guide speech
499495
delivery, see our guide on [Acting
500496
instructions](/docs/text-to-speech-tts/acting-instructions).
501-
- If no Voice is specified, a new voice is generated based on this description. See our [prompting guide](/docs/text-to-speech-tts/prompting) for tips on designing a voice.
497+
- If no Voice is specified, a new voice is generated based on this description. See our [prompting guide](/docs/text-to-speech-tts/prompting) for tips on designing a voice.
502498
validation:
503499
maxLength: 1000
504500
speed:
@@ -524,10 +520,10 @@ types:
524520
type: optional<PostedUtteranceVoice>
525521
docs: >-
526522
The `name` or `id` associated with a **Voice** from the **Voice
527-
Library** to be used as the speaker for this and all subsequent
523+
Library** to be used as the speaker for this and all subsequent
528524
`utterances`, until the `voice` field is updated again.
529525
530-
See our [voices guide](/docs/text-to-speech-tts/voices) for more details on generating and specifying **Voices**.
526+
See our [voices guide](/docs/text-to-speech-tts/voices) for more details on generating and specifying **Voices**.
531527
source:
532528
openapi: tts-openapi.yml
533529
ValidationErrorLocItem:
@@ -550,38 +546,58 @@ types:
550546
properties:
551547
id:
552548
type: string
553-
docs: The ID of a **Voice** within the **Voice Library**.
549+
docs: The unique ID associated with the **Voice**.
554550
provider:
555551
type: optional<VoiceProvider>
556-
docs: |-
557-
Specifies the provider of the voice associated with this voice ID.
552+
docs: >-
553+
Specifies the source provider associated with the chosen voice.
554+
558555
559-
- **HUME_AI**: Preset voices generated by Hume.
556+
- **`HUME_AI`**: Select voices from Hume's [Voice
557+
Library](https://platform.hume.ai/tts/voice-library), containing a
558+
variety of preset, shared voices.
560559
561-
- **CUSTOM_VOICE**: Voices you have generated and saved to your `Voice library`.
560+
- **`CUSTOM_VOICE`**: Select from voices you've personally generated
561+
and saved in your account.
562562
563-
If a provider is not specified, the provider will default to `CUSTOM_VOICE`.
564563
565-
While Hume's preset voices are shared and usable by anyone, your custom voices are only available to calls made with your API key.
564+
If no provider is explicitly set, the default provider is
565+
`CUSTOM_VOICE`. When using voices from Hume's **Voice Library**, you
566+
must explicitly set the provider to `HUME_AI`.
567+
568+
569+
Preset voices from Hume's **Voice Library** are accessible by all
570+
users. In contrast, your custom voices are private and accessible only
571+
via requests authenticated with your API key.
566572
source:
567573
openapi: tts-openapi.yml
568574
PostedUtteranceVoiceWithName:
569575
properties:
570576
name:
571577
type: string
572-
docs: The name of a **Voice** within the **Voice Library**.
578+
docs: The name of a **Voice**.
573579
provider:
574580
type: optional<VoiceProvider>
575-
docs: |-
576-
Specifies the provider of the voice associated with this voice name.
581+
docs: >-
582+
Specifies the source provider associated with the chosen voice.
583+
584+
585+
- **`HUME_AI`**: Select voices from Hume's [Voice
586+
Library](https://platform.hume.ai/tts/voice-library), containing a
587+
variety of preset, shared voices.
588+
589+
- **`CUSTOM_VOICE`**: Select from voices you've personally generated
590+
and saved in your account.
577591
578-
- **HUME_AI**: Preset voices generated by Hume.
579592
580-
- **CUSTOM_VOICE**: Voices you have generated and saved to your `Voice library`.
593+
If no provider is explicitly set, the default provider is
594+
`CUSTOM_VOICE`. When using voices from Hume's **Voice Library**, you
595+
must explicitly set the provider to `HUME_AI`.
581596
582-
If a provider is not specified, the provider will default to `CUSTOM_VOICE`.
583597
584-
While Hume's preset voices are shared and usable by anyone, your custom voices are only available to calls made with your API key.
598+
Preset voices from Hume's **Voice Library** are accessible by all
599+
users. In contrast, your custom voices are private and accessible only
600+
via requests authenticated with your API key.
585601
source:
586602
openapi: tts-openapi.yml
587603
VoiceProvider:

.mock/definition/tts/voices.yml

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
types:
2+
VoicesListRequestProvider:
3+
enum:
4+
- HUME_AI
5+
- CUSTOM_VOICE
6+
source:
7+
openapi: tts-openapi.yml
18
imports:
29
root: __package__.yml
310
service:
@@ -9,9 +16,8 @@ service:
916
method: GET
1017
auth: true
1118
docs: >-
12-
Lists voices in your **Voice Library**. Set provider to `HUME_AI` to
13-
list Hume's preset voices, or to `CUSTOM_VOICE` to a custom voice
14-
created in your account.
19+
Lists voices you have saved in your account, or voices from the [Voice
20+
Library](https://platform.hume.ai/tts/voice-library).
1521
pagination:
1622
offset: $request.page_number
1723
results: $response.voices_page
@@ -22,10 +28,17 @@ service:
2228
name: VoicesListRequest
2329
query-parameters:
2430
provider:
25-
type: root.VoiceProvider
31+
type: VoicesListRequestProvider
2632
docs: >-
27-
Specifies whether to return custom voices created in your account
28-
or shared voices provided by Hume
33+
Specify the voice provider to filter voices returned by the
34+
endpoint:
35+
36+
37+
- **`HUME_AI`**: Lists preset, shared voices from Hume's [Voice
38+
Library](https://platform.hume.ai/tts/voice-library).
39+
40+
- **`CUSTOM_VOICE`**: Lists custom voices created and saved to
41+
your account.
2942
page_number:
3043
type: optional<integer>
3144
docs: >-
@@ -74,9 +87,13 @@ service:
7487
method: POST
7588
auth: true
7689
docs: >-
77-
Creates a new voice from a specified TTS generation ID and saves it to
78-
your **Voice Library**. This allows for consistent speech style and
79-
prosody across multiple requests.
90+
Saves a new custom voice to your account using the specified TTS
91+
generation ID.
92+
93+
94+
Once saved, this voice can be reused in subsequent TTS requests,
95+
ensuring consistent speech style and prosody. For more details on voice
96+
creation, see the [Voices Guide](/docs/text-to-speech-tts/voices).
8097
source:
8198
openapi: tts-openapi.yml
8299
display-name: Create voice
@@ -113,7 +130,7 @@ service:
113130
path: /v0/tts/voices
114131
method: DELETE
115132
auth: true
116-
docs: Removes a custom voice from your **Voice Library**.
133+
docs: Deletes a previously generated custom voice.
117134
source:
118135
openapi: tts-openapi.yml
119136
display-name: Delete voice

0 commit comments

Comments
 (0)