Skip to content

Commit 8dce02e

Browse files
fern-api[bot]twitchard
fern-api[bot]
and
twitchard
authored
🌿 Fern Regeneration -- March 26, 2025 (#298)
Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: twitchard <[email protected]>
1 parent 7e00e36 commit 8dce02e

File tree

19 files changed

+659
-111
lines changed

19 files changed

+659
-111
lines changed

‎.mock/definition/tts/__package__.yml

+82-4
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@ service:
6767
audio: //PExAA0DDYRvkpNfhv3JI5JZ...etc.
6868
snippets:
6969
- - audio: //PExAA0DDYRvkpNfhv3JI5JZ...etc.
70-
audio_format: mp3
7170
id: 37b1b1b1-1b1b-1b1b-1b1b-1b1b1b1b1b1b
7271
text: >-
7372
Beauty is no quality in things themselves: It exists
@@ -114,6 +113,88 @@ service:
114113
format:
115114
type: mp3
116115
num_generations: 1
116+
synthesize-file-streaming:
117+
path: /v0/tts/stream/file
118+
method: POST
119+
auth: true
120+
docs: >-
121+
Streams synthesized speech using the specified voice. If no voice is
122+
provided, a novel voice will be generated dynamically. Optionally,
123+
additional context can be included to influence the speech's style and
124+
prosody.
125+
source:
126+
openapi: tts-openapi.yml
127+
display-name: Text-to-speech (Streamed File)
128+
request:
129+
body:
130+
type: PostedTts
131+
content-type: application/json
132+
response:
133+
docs: OK
134+
type: file
135+
status-code: 200
136+
errors:
137+
- UnprocessableEntityError
138+
examples:
139+
- request:
140+
utterances:
141+
- text: >-
142+
Beauty is no quality in things themselves: It exists merely in
143+
the mind which contemplates them.
144+
description: >-
145+
Middle-aged masculine voice with a clear, rhythmic Scots lilt,
146+
rounded vowels, and a warm, steady tone with an articulate,
147+
academic quality.
148+
context:
149+
generation_id: 09ad914d-8e7f-40f8-a279-e34f07f7dab2
150+
format:
151+
type: mp3
152+
num_generations: 1
153+
synthesize-json-streaming:
154+
path: /v0/tts/stream/json
155+
method: POST
156+
auth: true
157+
docs: >-
158+
Streams synthesized speech using the specified voice. If no voice is
159+
provided, a novel voice will be generated dynamically. Optionally,
160+
additional context can be included to influence the speech's style and
161+
prosody.
162+
163+
164+
The response is a stream of JSON objects including audio encoded in
165+
base64.
166+
source:
167+
openapi: tts-openapi.yml
168+
display-name: Text-to-speech (Streamed JSON)
169+
request:
170+
body:
171+
type: PostedTts
172+
content-type: application/json
173+
response-stream:
174+
docs: Successful Response
175+
type: Snippet
176+
format: json
177+
errors:
178+
- UnprocessableEntityError
179+
examples:
180+
- request:
181+
utterances:
182+
- text: >-
183+
Beauty is no quality in things themselves: It exists merely in
184+
the mind which contemplates them.
185+
description: >-
186+
Middle-aged masculine voice with a clear, rhythmic Scots lilt,
187+
rounded vowels, and a warm, steady tone with an articulate,
188+
academic quality.
189+
context:
190+
utterances:
191+
- text: How can people see beauty so differently?
192+
description: >-
193+
A curious student with a clear and respectful tone, seeking
194+
clarification on Hume's ideas with a straightforward
195+
question.
196+
format:
197+
type: mp3
117198
source:
118199
openapi: tts-openapi.yml
119200
types:
@@ -291,9 +372,6 @@ types:
291372
The segmented audio output in the requested format, encoded as a
292373
base64 string.
293374
access: read-only
294-
audio_format:
295-
type: string
296-
docs: The generated audio output format.
297375
generation_id:
298376
type: string
299377
docs: The generation ID this snippet corresponds to.

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "hume",
3-
"version": "0.9.14",
3+
"version": "0.9.15",
44
"private": false,
55
"repository": "https://github.com/HumeAI/hume-typescript-sdk",
66
"main": "./index.js",

‎reference.md

+163
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,169 @@ await client.tts.synthesizeFile({
168168
</dl>
169169
</details>
170170

171+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFileStreaming</a>({ ...params }) -> stream.Readable</code></summary>
172+
<dl>
173+
<dd>
174+
175+
#### 📝 Description
176+
177+
<dl>
178+
<dd>
179+
180+
<dl>
181+
<dd>
182+
183+
Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
184+
185+
</dd>
186+
</dl>
187+
</dd>
188+
</dl>
189+
190+
#### 🔌 Usage
191+
192+
<dl>
193+
<dd>
194+
195+
<dl>
196+
<dd>
197+
198+
```typescript
199+
await client.tts.synthesizeFileStreaming({
200+
utterances: [
201+
{
202+
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
203+
description:
204+
"Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality.",
205+
},
206+
],
207+
context: {
208+
generationId: "09ad914d-8e7f-40f8-a279-e34f07f7dab2",
209+
},
210+
format: {
211+
type: "mp3",
212+
},
213+
numGenerations: 1,
214+
});
215+
```
216+
217+
</dd>
218+
</dl>
219+
</dd>
220+
</dl>
221+
222+
#### ⚙️ Parameters
223+
224+
<dl>
225+
<dd>
226+
227+
<dl>
228+
<dd>
229+
230+
**request:** `Hume.PostedTts`
231+
232+
</dd>
233+
</dl>
234+
235+
<dl>
236+
<dd>
237+
238+
**requestOptions:** `Tts.RequestOptions`
239+
240+
</dd>
241+
</dl>
242+
</dd>
243+
</dl>
244+
245+
</dd>
246+
</dl>
247+
</details>
248+
249+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJsonStreaming</a>({ ...params }) -> core.Stream<Hume.Snippet></code></summary>
250+
<dl>
251+
<dd>
252+
253+
#### 📝 Description
254+
255+
<dl>
256+
<dd>
257+
258+
<dl>
259+
<dd>
260+
261+
Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
262+
263+
The response is a stream of JSON objects including audio encoded in base64.
264+
265+
</dd>
266+
</dl>
267+
</dd>
268+
</dl>
269+
270+
#### 🔌 Usage
271+
272+
<dl>
273+
<dd>
274+
275+
<dl>
276+
<dd>
277+
278+
```typescript
279+
await client.tts.synthesizeJsonStreaming({
280+
utterances: [
281+
{
282+
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
283+
description:
284+
"Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality.",
285+
},
286+
],
287+
context: {
288+
utterances: [
289+
{
290+
text: "How can people see beauty so differently?",
291+
description:
292+
"A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question.",
293+
},
294+
],
295+
},
296+
format: {
297+
type: "mp3",
298+
},
299+
});
300+
```
301+
302+
</dd>
303+
</dl>
304+
</dd>
305+
</dl>
306+
307+
#### ⚙️ Parameters
308+
309+
<dl>
310+
<dd>
311+
312+
<dl>
313+
<dd>
314+
315+
**request:** `Hume.PostedTts`
316+
317+
</dd>
318+
</dl>
319+
320+
<dl>
321+
<dd>
322+
323+
**requestOptions:** `Tts.RequestOptions`
324+
325+
</dd>
326+
</dl>
327+
</dd>
328+
</dl>
329+
330+
</dd>
331+
</dl>
332+
</details>
333+
171334
## Tts Voices
172335

173336
<details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">create</a>({ ...params }) -> Hume.ReturnVoice</code></summary>

‎src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ export class ChatGroups {
7676
headers: {
7777
"X-Fern-Language": "JavaScript",
7878
"X-Fern-SDK-Name": "hume",
79-
"X-Fern-SDK-Version": "0.9.14",
80-
"User-Agent": "hume/0.9.14",
79+
"X-Fern-SDK-Version": "0.9.15",
80+
"User-Agent": "hume/0.9.15",
8181
"X-Fern-Runtime": core.RUNTIME.type,
8282
"X-Fern-Runtime-Version": core.RUNTIME.version,
8383
...(await this._getCustomAuthorizationHeaders()),
@@ -176,8 +176,8 @@ export class ChatGroups {
176176
headers: {
177177
"X-Fern-Language": "JavaScript",
178178
"X-Fern-SDK-Name": "hume",
179-
"X-Fern-SDK-Version": "0.9.14",
180-
"User-Agent": "hume/0.9.14",
179+
"X-Fern-SDK-Version": "0.9.15",
180+
"User-Agent": "hume/0.9.15",
181181
"X-Fern-Runtime": core.RUNTIME.type,
182182
"X-Fern-Runtime-Version": core.RUNTIME.version,
183183
...(await this._getCustomAuthorizationHeaders()),
@@ -276,8 +276,8 @@ export class ChatGroups {
276276
headers: {
277277
"X-Fern-Language": "JavaScript",
278278
"X-Fern-SDK-Name": "hume",
279-
"X-Fern-SDK-Version": "0.9.14",
280-
"User-Agent": "hume/0.9.14",
279+
"X-Fern-SDK-Version": "0.9.15",
280+
"User-Agent": "hume/0.9.15",
281281
"X-Fern-Runtime": core.RUNTIME.type,
282282
"X-Fern-Runtime-Version": core.RUNTIME.version,
283283
...(await this._getCustomAuthorizationHeaders()),
@@ -376,8 +376,8 @@ export class ChatGroups {
376376
headers: {
377377
"X-Fern-Language": "JavaScript",
378378
"X-Fern-SDK-Name": "hume",
379-
"X-Fern-SDK-Version": "0.9.14",
380-
"User-Agent": "hume/0.9.14",
379+
"X-Fern-SDK-Version": "0.9.15",
380+
"User-Agent": "hume/0.9.15",
381381
"X-Fern-Runtime": core.RUNTIME.type,
382382
"X-Fern-Runtime-Version": core.RUNTIME.version,
383383
...(await this._getCustomAuthorizationHeaders()),

‎src/api/resources/empathicVoice/resources/chats/client/Client.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ export class Chats {
7474
headers: {
7575
"X-Fern-Language": "JavaScript",
7676
"X-Fern-SDK-Name": "hume",
77-
"X-Fern-SDK-Version": "0.9.14",
78-
"User-Agent": "hume/0.9.14",
77+
"X-Fern-SDK-Version": "0.9.15",
78+
"User-Agent": "hume/0.9.15",
7979
"X-Fern-Runtime": core.RUNTIME.type,
8080
"X-Fern-Runtime-Version": core.RUNTIME.version,
8181
...(await this._getCustomAuthorizationHeaders()),
@@ -183,8 +183,8 @@ export class Chats {
183183
headers: {
184184
"X-Fern-Language": "JavaScript",
185185
"X-Fern-SDK-Name": "hume",
186-
"X-Fern-SDK-Version": "0.9.14",
187-
"User-Agent": "hume/0.9.14",
186+
"X-Fern-SDK-Version": "0.9.15",
187+
"User-Agent": "hume/0.9.15",
188188
"X-Fern-Runtime": core.RUNTIME.type,
189189
"X-Fern-Runtime-Version": core.RUNTIME.version,
190190
...(await this._getCustomAuthorizationHeaders()),
@@ -272,8 +272,8 @@ export class Chats {
272272
headers: {
273273
"X-Fern-Language": "JavaScript",
274274
"X-Fern-SDK-Name": "hume",
275-
"X-Fern-SDK-Version": "0.9.14",
276-
"User-Agent": "hume/0.9.14",
275+
"X-Fern-SDK-Version": "0.9.15",
276+
"User-Agent": "hume/0.9.15",
277277
"X-Fern-Runtime": core.RUNTIME.type,
278278
"X-Fern-Runtime-Version": core.RUNTIME.version,
279279
...(await this._getCustomAuthorizationHeaders()),

0 commit comments

Comments
 (0)