hume 0.11.0 → 0.11.1

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 (116) hide show
  1. package/.mock/definition/empathic-voice/__package__.yml +15 -36
  2. package/.mock/definition/empathic-voice/chat.yml +18 -3
  3. package/.mock/definition/empathic-voice/chatGroups.yml +14 -10
  4. package/.mock/definition/empathic-voice/chatWebhooks.yml +2 -0
  5. package/.mock/definition/empathic-voice/chats.yml +2 -0
  6. package/.mock/definition/empathic-voice/configs.yml +2 -0
  7. package/.mock/definition/empathic-voice/customVoices.yml +1 -0
  8. package/.mock/definition/empathic-voice/prompts.yml +2 -0
  9. package/.mock/definition/empathic-voice/tools.yml +2 -0
  10. package/.mock/definition/expression-measurement/batch/__package__.yml +10 -10
  11. package/.mock/definition/expression-measurement/stream/stream.yml +1 -1
  12. package/.mock/definition/tts/__package__.yml +70 -55
  13. package/.mock/definition/tts/voices.yml +20 -9
  14. package/.mock/fern.config.json +1 -1
  15. package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +6 -6
  16. package/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +4 -4
  17. package/api/resources/empathicVoice/resources/chats/client/Client.js +5 -5
  18. package/api/resources/empathicVoice/resources/configs/client/Client.js +11 -11
  19. package/api/resources/empathicVoice/resources/customVoices/client/Client.js +7 -7
  20. package/api/resources/empathicVoice/resources/prompts/client/Client.js +10 -10
  21. package/api/resources/empathicVoice/resources/tools/client/Client.js +11 -11
  22. package/api/resources/empathicVoice/types/AssistantInput.d.ts +1 -1
  23. package/api/resources/empathicVoice/types/AssistantMessage.d.ts +1 -1
  24. package/api/resources/empathicVoice/types/PauseAssistantMessage.d.ts +1 -1
  25. package/api/resources/empathicVoice/types/ToolCallMessage.d.ts +1 -1
  26. package/api/resources/empathicVoice/types/ToolErrorMessage.d.ts +2 -2
  27. package/api/resources/empathicVoice/types/ToolResponseMessage.d.ts +3 -3
  28. package/api/resources/empathicVoice/types/UserInput.d.ts +1 -1
  29. package/api/resources/empathicVoice/types/UserMessage.d.ts +3 -3
  30. package/api/resources/empathicVoice/types/index.d.ts +0 -4
  31. package/api/resources/empathicVoice/types/index.js +0 -4
  32. package/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
  33. package/api/resources/tts/client/Client.d.ts +6 -6
  34. package/api/resources/tts/client/Client.js +10 -10
  35. package/api/resources/tts/resources/voices/client/Client.d.ts +5 -3
  36. package/api/resources/tts/resources/voices/client/Client.js +9 -7
  37. package/api/resources/tts/resources/voices/client/requests/VoicesListRequest.d.ts +4 -1
  38. package/api/resources/tts/types/PostedTts.d.ts +6 -6
  39. package/api/resources/tts/types/PostedUtterance.d.ts +5 -5
  40. package/api/resources/tts/types/PostedUtteranceVoiceWithId.d.ts +6 -7
  41. package/api/resources/tts/types/PostedUtteranceVoiceWithName.d.ts +6 -7
  42. package/api/resources/tts/types/ReturnGeneration.d.ts +1 -1
  43. package/api/resources/tts/types/ReturnTts.d.ts +1 -1
  44. package/api/resources/tts/types/ReturnVoice.d.ts +2 -8
  45. package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +6 -6
  46. package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +4 -4
  47. package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +5 -5
  48. package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +11 -11
  49. package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.js +7 -7
  50. package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +10 -10
  51. package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +11 -11
  52. package/dist/api/resources/empathicVoice/types/AssistantInput.d.ts +1 -1
  53. package/dist/api/resources/empathicVoice/types/AssistantMessage.d.ts +1 -1
  54. package/dist/api/resources/empathicVoice/types/PauseAssistantMessage.d.ts +1 -1
  55. package/dist/api/resources/empathicVoice/types/ToolCallMessage.d.ts +1 -1
  56. package/dist/api/resources/empathicVoice/types/ToolErrorMessage.d.ts +2 -2
  57. package/dist/api/resources/empathicVoice/types/ToolResponseMessage.d.ts +3 -3
  58. package/dist/api/resources/empathicVoice/types/UserInput.d.ts +1 -1
  59. package/dist/api/resources/empathicVoice/types/UserMessage.d.ts +3 -3
  60. package/dist/api/resources/empathicVoice/types/index.d.ts +0 -4
  61. package/dist/api/resources/empathicVoice/types/index.js +0 -4
  62. package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
  63. package/dist/api/resources/tts/client/Client.d.ts +6 -6
  64. package/dist/api/resources/tts/client/Client.js +10 -10
  65. package/dist/api/resources/tts/resources/voices/client/Client.d.ts +5 -3
  66. package/dist/api/resources/tts/resources/voices/client/Client.js +9 -7
  67. package/dist/api/resources/tts/resources/voices/client/requests/VoicesListRequest.d.ts +4 -1
  68. package/dist/api/resources/tts/types/PostedTts.d.ts +6 -6
  69. package/dist/api/resources/tts/types/PostedUtterance.d.ts +5 -5
  70. package/dist/api/resources/tts/types/PostedUtteranceVoiceWithId.d.ts +6 -7
  71. package/dist/api/resources/tts/types/PostedUtteranceVoiceWithName.d.ts +6 -7
  72. package/dist/api/resources/tts/types/ReturnGeneration.d.ts +1 -1
  73. package/dist/api/resources/tts/types/ReturnTts.d.ts +1 -1
  74. package/dist/api/resources/tts/types/ReturnVoice.d.ts +2 -8
  75. package/dist/serialization/resources/empathicVoice/types/index.d.ts +0 -4
  76. package/dist/serialization/resources/empathicVoice/types/index.js +0 -4
  77. package/dist/version.d.ts +1 -1
  78. package/dist/version.js +1 -1
  79. package/package.json +1 -1
  80. package/reference.md +11 -9
  81. package/serialization/resources/empathicVoice/types/index.d.ts +0 -4
  82. package/serialization/resources/empathicVoice/types/index.js +0 -4
  83. package/version.d.ts +1 -1
  84. package/version.js +1 -1
  85. package/api/resources/empathicVoice/types/FunctionCallResponseInput.d.ts +0 -6
  86. package/api/resources/empathicVoice/types/FunctionCallResponseInput.js +0 -5
  87. package/api/resources/empathicVoice/types/PostedPromptSpec.d.ts +0 -9
  88. package/api/resources/empathicVoice/types/PostedPromptSpec.js +0 -5
  89. package/api/resources/empathicVoice/types/TextInput.d.ts +0 -6
  90. package/api/resources/empathicVoice/types/TextInput.js +0 -5
  91. package/api/resources/empathicVoice/types/TtsInput.d.ts +0 -6
  92. package/api/resources/empathicVoice/types/TtsInput.js +0 -5
  93. package/dist/api/resources/empathicVoice/types/FunctionCallResponseInput.d.ts +0 -6
  94. package/dist/api/resources/empathicVoice/types/FunctionCallResponseInput.js +0 -5
  95. package/dist/api/resources/empathicVoice/types/PostedPromptSpec.d.ts +0 -9
  96. package/dist/api/resources/empathicVoice/types/PostedPromptSpec.js +0 -5
  97. package/dist/api/resources/empathicVoice/types/TextInput.d.ts +0 -6
  98. package/dist/api/resources/empathicVoice/types/TextInput.js +0 -5
  99. package/dist/api/resources/empathicVoice/types/TtsInput.d.ts +0 -6
  100. package/dist/api/resources/empathicVoice/types/TtsInput.js +0 -5
  101. package/dist/serialization/resources/empathicVoice/types/FunctionCallResponseInput.d.ts +0 -12
  102. package/dist/serialization/resources/empathicVoice/types/FunctionCallResponseInput.js +0 -43
  103. package/dist/serialization/resources/empathicVoice/types/PostedPromptSpec.d.ts +0 -12
  104. package/dist/serialization/resources/empathicVoice/types/PostedPromptSpec.js +0 -43
  105. package/dist/serialization/resources/empathicVoice/types/TextInput.d.ts +0 -12
  106. package/dist/serialization/resources/empathicVoice/types/TextInput.js +0 -43
  107. package/dist/serialization/resources/empathicVoice/types/TtsInput.d.ts +0 -12
  108. package/dist/serialization/resources/empathicVoice/types/TtsInput.js +0 -43
  109. package/serialization/resources/empathicVoice/types/FunctionCallResponseInput.d.ts +0 -12
  110. package/serialization/resources/empathicVoice/types/FunctionCallResponseInput.js +0 -43
  111. package/serialization/resources/empathicVoice/types/PostedPromptSpec.d.ts +0 -12
  112. package/serialization/resources/empathicVoice/types/PostedPromptSpec.js +0 -43
  113. package/serialization/resources/empathicVoice/types/TextInput.d.ts +0 -12
  114. package/serialization/resources/empathicVoice/types/TextInput.js +0 -43
  115. package/serialization/resources/empathicVoice/types/TtsInput.d.ts +0 -12
  116. package/serialization/resources/empathicVoice/types/TtsInput.js +0 -43
@@ -109,7 +109,7 @@ class Batch {
109
109
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
110
110
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, "v0/batch/jobs"),
111
111
  method: "GET",
112
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
112
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
113
113
  contentType: "application/json",
114
114
  queryParameters: _queryParams,
115
115
  requestType: "json",
@@ -164,7 +164,7 @@ class Batch {
164
164
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
165
165
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, "v0/batch/jobs"),
166
166
  method: "POST",
167
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
167
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
168
168
  contentType: "application/json",
169
169
  requestType: "json",
170
170
  body: serializers.expressionMeasurement.batch.InferenceBaseRequest.jsonOrThrow(request, {
@@ -218,7 +218,7 @@ class Batch {
218
218
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
219
219
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, `v0/batch/jobs/${encodeURIComponent(id)}`),
220
220
  method: "GET",
221
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
221
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
222
222
  contentType: "application/json",
223
223
  requestType: "json",
224
224
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -269,7 +269,7 @@ class Batch {
269
269
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
270
270
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, `v0/batch/jobs/${encodeURIComponent(id)}/predictions`),
271
271
  method: "GET",
272
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
272
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
273
273
  contentType: "application/json",
274
274
  requestType: "json",
275
275
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -314,7 +314,7 @@ class Batch {
314
314
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
315
315
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, `v0/batch/jobs/${encodeURIComponent(id)}/artifacts`),
316
316
  method: "GET",
317
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
317
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
318
318
  contentType: "application/json",
319
319
  requestType: "json",
320
320
  responseType: "streaming",
@@ -372,7 +372,7 @@ class Batch {
372
372
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
373
373
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, "v0/batch/jobs"),
374
374
  method: "POST",
375
- headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
375
+ headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
376
376
  requestType: "file",
377
377
  duplex: _maybeEncodedRequest.duplex,
378
378
  body: _maybeEncodedRequest.body,
@@ -31,7 +31,7 @@ export declare class Tts {
31
31
  constructor(_options?: Tts.Options);
32
32
  get voices(): Voices;
33
33
  /**
34
- * Synthesizes one or more input texts into 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.
34
+ * Synthesizes one or more input texts into 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.
35
35
  *
36
36
  * The response includes the base64-encoded audio and metadata in JSON format.
37
37
  *
@@ -44,12 +44,12 @@ export declare class Tts {
44
44
  * await client.tts.synthesizeJson({
45
45
  * utterances: [{
46
46
  * text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
47
- * description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
47
+ * description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
48
48
  * }],
49
49
  * context: {
50
50
  * utterances: [{
51
51
  * text: "How can people see beauty so differently?",
52
- * description: "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question."
52
+ * description: "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question."
53
53
  * }]
54
54
  * },
55
55
  * format: {
@@ -60,19 +60,19 @@ export declare class Tts {
60
60
  */
61
61
  synthesizeJson(request: Hume.tts.PostedTts, requestOptions?: Tts.RequestOptions): Promise<Hume.tts.ReturnTts>;
62
62
  /**
63
- * Synthesizes one or more input texts into 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.
63
+ * Synthesizes one or more input texts into 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.
64
64
  *
65
65
  * The response contains the generated audio file in the requested format.
66
66
  * @throws {@link Hume.tts.UnprocessableEntityError}
67
67
  */
68
68
  synthesizeFile(request: Hume.tts.PostedTts, requestOptions?: Tts.RequestOptions): Promise<stream.Readable>;
69
69
  /**
70
- * 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.
70
+ * 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.
71
71
  * @throws {@link Hume.tts.UnprocessableEntityError}
72
72
  */
73
73
  synthesizeFileStreaming(request: Hume.tts.PostedTts, requestOptions?: Tts.RequestOptions): Promise<stream.Readable>;
74
74
  /**
75
- * 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.
75
+ * 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.
76
76
  *
77
77
  * The response is a stream of JSON objects including audio encoded in base64.
78
78
  */
@@ -65,7 +65,7 @@ class Tts {
65
65
  return ((_a = this._voices) !== null && _a !== void 0 ? _a : (this._voices = new Client_1.Voices(this._options)));
66
66
  }
67
67
  /**
68
- * Synthesizes one or more input texts into 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.
68
+ * Synthesizes one or more input texts into 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.
69
69
  *
70
70
  * The response includes the base64-encoded audio and metadata in JSON format.
71
71
  *
@@ -78,12 +78,12 @@ class Tts {
78
78
  * await client.tts.synthesizeJson({
79
79
  * utterances: [{
80
80
  * text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
81
- * description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
81
+ * description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
82
82
  * }],
83
83
  * context: {
84
84
  * utterances: [{
85
85
  * text: "How can people see beauty so differently?",
86
- * description: "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question."
86
+ * description: "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question."
87
87
  * }]
88
88
  * },
89
89
  * format: {
@@ -98,7 +98,7 @@ class Tts {
98
98
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
99
99
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, "v0/tts"),
100
100
  method: "POST",
101
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
101
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
102
102
  contentType: "application/json",
103
103
  requestType: "json",
104
104
  body: serializers.tts.PostedTts.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -146,7 +146,7 @@ class Tts {
146
146
  });
147
147
  }
148
148
  /**
149
- * Synthesizes one or more input texts into 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.
149
+ * Synthesizes one or more input texts into 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.
150
150
  *
151
151
  * The response contains the generated audio file in the requested format.
152
152
  * @throws {@link Hume.tts.UnprocessableEntityError}
@@ -157,7 +157,7 @@ class Tts {
157
157
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
158
158
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, "v0/tts/file"),
159
159
  method: "POST",
160
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
160
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
161
161
  contentType: "application/json",
162
162
  requestType: "json",
163
163
  body: serializers.tts.PostedTts.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -201,7 +201,7 @@ class Tts {
201
201
  });
202
202
  }
203
203
  /**
204
- * 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.
204
+ * 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.
205
205
  * @throws {@link Hume.tts.UnprocessableEntityError}
206
206
  */
207
207
  synthesizeFileStreaming(request, requestOptions) {
@@ -210,7 +210,7 @@ class Tts {
210
210
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
211
211
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, "v0/tts/stream/file"),
212
212
  method: "POST",
213
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
213
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
214
214
  contentType: "application/json",
215
215
  requestType: "json",
216
216
  body: serializers.tts.PostedTts.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -254,7 +254,7 @@ class Tts {
254
254
  });
255
255
  }
256
256
  /**
257
- * 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.
257
+ * 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.
258
258
  *
259
259
  * The response is a stream of JSON objects including audio encoded in base64.
260
260
  */
@@ -264,7 +264,7 @@ class Tts {
264
264
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
265
265
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, "v0/tts/stream/json"),
266
266
  method: "POST",
267
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
267
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
268
268
  contentType: "application/json",
269
269
  requestType: "json",
270
270
  body: serializers.tts.PostedTts.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -27,7 +27,7 @@ export declare class Voices {
27
27
  protected readonly _options: Voices.Options;
28
28
  constructor(_options?: Voices.Options);
29
29
  /**
30
- * Lists voices in your **Voice Library**. Set provider to `HUME_AI` to list Hume's preset voices, or to `CUSTOM_VOICE` to a custom voice created in your account.
30
+ * Lists voices you have saved in your account, or voices from the [Voice Library](https://platform.hume.ai/tts/voice-library).
31
31
  *
32
32
  * @param {Hume.tts.VoicesListRequest} request
33
33
  * @param {Voices.RequestOptions} requestOptions - Request-specific configuration.
@@ -41,7 +41,9 @@ export declare class Voices {
41
41
  */
42
42
  list(request: Hume.tts.VoicesListRequest, requestOptions?: Voices.RequestOptions): Promise<core.Page<Hume.tts.ReturnVoice>>;
43
43
  /**
44
- * Creates a new voice from a specified TTS generation ID and saves it to your **Voice Library**. This allows for consistent speech style and prosody across multiple requests.
44
+ * Saves a new custom voice to your account using the specified TTS generation ID.
45
+ *
46
+ * Once saved, this voice can be reused in subsequent TTS requests, ensuring consistent speech style and prosody. For more details on voice creation, see the [Voices Guide](/docs/text-to-speech-tts/voices).
45
47
  *
46
48
  * @param {Hume.tts.PostedVoice} request
47
49
  * @param {Voices.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,7 +58,7 @@ export declare class Voices {
56
58
  */
57
59
  create(request: Hume.tts.PostedVoice, requestOptions?: Voices.RequestOptions): Promise<Hume.tts.ReturnVoice>;
58
60
  /**
59
- * Removes a custom voice from your **Voice Library**.
61
+ * Deletes a previously generated custom voice.
60
62
  *
61
63
  * @param {Hume.tts.VoicesDeleteRequest} request
62
64
  * @param {Voices.RequestOptions} requestOptions - Request-specific configuration.
@@ -60,7 +60,7 @@ class Voices {
60
60
  this._options = _options;
61
61
  }
62
62
  /**
63
- * Lists voices in your **Voice Library**. Set provider to `HUME_AI` to list Hume's preset voices, or to `CUSTOM_VOICE` to a custom voice created in your account.
63
+ * Lists voices you have saved in your account, or voices from the [Voice Library](https://platform.hume.ai/tts/voice-library).
64
64
  *
65
65
  * @param {Hume.tts.VoicesListRequest} request
66
66
  * @param {Voices.RequestOptions} requestOptions - Request-specific configuration.
@@ -93,7 +93,7 @@ class Voices {
93
93
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
94
94
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, "v0/tts/voices"),
95
95
  method: "GET",
96
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
96
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
97
97
  contentType: "application/json",
98
98
  queryParameters: _queryParams,
99
99
  requestType: "json",
@@ -139,7 +139,7 @@ class Voices {
139
139
  });
140
140
  }
141
141
  });
142
- let _offset = (request === null || request === void 0 ? void 0 : request.pageNumber) != null ? request === null || request === void 0 ? void 0 : request.pageNumber : 1;
142
+ let _offset = (request === null || request === void 0 ? void 0 : request.pageNumber) != null ? request === null || request === void 0 ? void 0 : request.pageNumber : 0;
143
143
  return new core.Pageable({
144
144
  response: yield list(request),
145
145
  hasNextPage: (response) => { var _a; return ((_a = response === null || response === void 0 ? void 0 : response.voicesPage) !== null && _a !== void 0 ? _a : []).length > 0; },
@@ -152,7 +152,9 @@ class Voices {
152
152
  });
153
153
  }
154
154
  /**
155
- * Creates a new voice from a specified TTS generation ID and saves it to your **Voice Library**. This allows for consistent speech style and prosody across multiple requests.
155
+ * Saves a new custom voice to your account using the specified TTS generation ID.
156
+ *
157
+ * Once saved, this voice can be reused in subsequent TTS requests, ensuring consistent speech style and prosody. For more details on voice creation, see the [Voices Guide](/docs/text-to-speech-tts/voices).
156
158
  *
157
159
  * @param {Hume.tts.PostedVoice} request
158
160
  * @param {Voices.RequestOptions} requestOptions - Request-specific configuration.
@@ -171,7 +173,7 @@ class Voices {
171
173
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
172
174
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, "v0/tts/voices"),
173
175
  method: "POST",
174
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
176
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
175
177
  contentType: "application/json",
176
178
  requestType: "json",
177
179
  body: serializers.tts.PostedVoice.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -219,7 +221,7 @@ class Voices {
219
221
  });
220
222
  }
221
223
  /**
222
- * Removes a custom voice from your **Voice Library**.
224
+ * Deletes a previously generated custom voice.
223
225
  *
224
226
  * @param {Hume.tts.VoicesDeleteRequest} request
225
227
  * @param {Voices.RequestOptions} requestOptions - Request-specific configuration.
@@ -240,7 +242,7 @@ class Voices {
240
242
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
241
243
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.HumeEnvironment.Production, "v0/tts/voices"),
242
244
  method: "DELETE",
243
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.10.3", "User-Agent": "hume/0.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
245
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.11.1", "User-Agent": "hume/0.11.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
244
246
  contentType: "application/json",
245
247
  queryParameters: _queryParams,
246
248
  requestType: "json",
@@ -10,7 +10,10 @@ import * as Hume from "../../../../../../index";
10
10
  */
11
11
  export interface VoicesListRequest {
12
12
  /**
13
- * Specifies whether to return custom voices created in your account or shared voices provided by Hume
13
+ * Specify the voice provider to filter voices returned by the endpoint:
14
+ *
15
+ * - **`HUME_AI`**: Lists preset, shared voices from Hume's [Voice Library](https://platform.hume.ai/tts/voice-library).
16
+ * - **`CUSTOM_VOICE`**: Lists custom voices created and saved to your account.
14
17
  */
15
18
  provider: Hume.tts.VoiceProvider;
16
19
  /**
@@ -12,11 +12,11 @@ export interface PostedTts {
12
12
  /**
13
13
  * Controls how audio output is segmented in the response.
14
14
  *
15
- * - When **enabled** (`true`), input utterances are automatically split into natural-sounding speech segments.
15
+ * - When **enabled** (`true`), input utterances are automatically split into natural-sounding speech segments.
16
16
  *
17
- * - When **disabled** (`false`), the response maintains a strict one-to-one mapping between input utterances and output snippets.
17
+ * - When **disabled** (`false`), the response maintains a strict one-to-one mapping between input utterances and output snippets.
18
18
  *
19
- * This setting affects how the `snippets` array is structured in the response, which may be important for applications that need to track the relationship between input text and generated audio segments. When setting to `false`, avoid including utterances with long `text`, as this can result in distorted output.
19
+ * This setting affects how the `snippets` array is structured in the response, which may be important for applications that need to track the relationship between input text and generated audio segments. When setting to `false`, avoid including utterances with long `text`, as this can result in distorted output.
20
20
  */
21
21
  splitUtterances?: boolean;
22
22
  /** If enabled, the audio for all the chunks of a generation, once concatenated together, will constitute a single audio file. Otherwise, if disabled, each chunk's audio will be its own audio file, each with its own headers (if applicable). */
@@ -24,13 +24,13 @@ export interface PostedTts {
24
24
  /**
25
25
  * A list of **Utterances** to be converted to speech output.
26
26
  *
27
- * An **Utterance** is a unit of input for [Octave](/docs/text-to-speech-tts/overview), and includes input `text`, an optional `description` to serve as the prompt for how the speech should be delivered, an optional `voice` specification, and additional controls to guide delivery for `speed` and `trailing_silence`.
27
+ * An **Utterance** is a unit of input for [Octave](/docs/text-to-speech-tts/overview), and includes input `text`, an optional `description` to serve as the prompt for how the speech should be delivered, an optional `voice` specification, and additional controls to guide delivery for `speed` and `trailing_silence`.
28
28
  */
29
29
  utterances: Hume.tts.PostedUtterance[];
30
30
  /**
31
31
  * Enables ultra-low latency streaming, significantly reducing the time until the first audio chunk is received. Recommended for real-time applications requiring immediate audio playback. For further details, see our documentation on [instant mode](/docs/text-to-speech-tts/overview#ultra-low-latency-streaming-instant-mode).
32
- * - Dynamic voice generation is not supported with this mode; a predefined [voice](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.utterances.voice) must be specified in your request.
33
- * - This mode is only supported for streaming endpoints (e.g., [/v0/tts/stream/json](/reference/text-to-speech-tts/synthesize-json-streaming), [/v0/tts/stream/file](/reference/text-to-speech-tts/synthesize-file-streaming)).
32
+ * - Dynamic voice generation is not supported with this mode; a predefined [voice](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.utterances.voice) must be specified in your request.
33
+ * - This mode is only supported for streaming endpoints (e.g., [/v0/tts/stream/json](/reference/text-to-speech-tts/synthesize-json-streaming), [/v0/tts/stream/file](/reference/text-to-speech-tts/synthesize-file-streaming)).
34
34
  * - Ensure only a single generation is requested ([num_generations](/reference/text-to-speech-tts/synthesize-json-streaming#request.body.num_generations) must be `1` or omitted).
35
35
  * - With `instant_mode` enabled, **requests incur a 10% higher cost** due to increased compute and resource requirements.
36
36
  */
@@ -4,9 +4,9 @@
4
4
  import * as Hume from "../../../index";
5
5
  export interface PostedUtterance {
6
6
  /**
7
- * Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').
8
- * - If a Voice is specified in the request, this description serves as acting instructions. For tips on how to effectively guide speech delivery, see our guide on [Acting instructions](/docs/text-to-speech-tts/acting-instructions).
9
- * - 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.
7
+ * Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').
8
+ * - If a Voice is specified in the request, this description serves as acting instructions. For tips on how to effectively guide speech delivery, see our guide on [Acting instructions](/docs/text-to-speech-tts/acting-instructions).
9
+ * - 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.
10
10
  */
11
11
  description?: string;
12
12
  /** Speed multiplier for the synthesized speech. */
@@ -16,9 +16,9 @@ export interface PostedUtterance {
16
16
  /** Duration of trailing silence (in seconds) to add to this utterance */
17
17
  trailingSilence?: number;
18
18
  /**
19
- * The `name` or `id` associated with a **Voice** from the **Voice Library** to be used as the speaker for this and all subsequent `utterances`, until the `voice` field is updated again.
19
+ * The `name` or `id` associated with a **Voice** from the **Voice Library** to be used as the speaker for this and all subsequent `utterances`, until the `voice` field is updated again.
20
20
  *
21
- * See our [voices guide](/docs/text-to-speech-tts/voices) for more details on generating and specifying **Voices**.
21
+ * See our [voices guide](/docs/text-to-speech-tts/voices) for more details on generating and specifying **Voices**.
22
22
  */
23
23
  voice?: Hume.tts.PostedUtteranceVoice;
24
24
  }
@@ -3,18 +3,17 @@
3
3
  */
4
4
  import * as Hume from "../../../index";
5
5
  export interface PostedUtteranceVoiceWithId {
6
- /** The ID of a **Voice** within the **Voice Library**. */
6
+ /** The unique ID associated with the **Voice**. */
7
7
  id: string;
8
8
  /**
9
- * Specifies the provider of the voice associated with this voice ID.
9
+ * Specifies the source provider associated with the chosen voice.
10
10
  *
11
- * - **HUME_AI**: Preset voices generated by Hume.
11
+ * - **`HUME_AI`**: Select voices from Hume's [Voice Library](https://platform.hume.ai/tts/voice-library), containing a variety of preset, shared voices.
12
+ * - **`CUSTOM_VOICE`**: Select from voices you've personally generated and saved in your account.
12
13
  *
13
- * - **CUSTOM_VOICE**: Voices you have generated and saved to your `Voice library`.
14
+ * If no provider is explicitly set, the default provider is `CUSTOM_VOICE`. When using voices from Hume's **Voice Library**, you must explicitly set the provider to `HUME_AI`.
14
15
  *
15
- * If a provider is not specified, the provider will default to `CUSTOM_VOICE`.
16
- *
17
- * While Hume's preset voices are shared and usable by anyone, your custom voices are only available to calls made with your API key.
16
+ * Preset voices from Hume's **Voice Library** are accessible by all users. In contrast, your custom voices are private and accessible only via requests authenticated with your API key.
18
17
  */
19
18
  provider?: Hume.tts.VoiceProvider;
20
19
  }
@@ -3,18 +3,17 @@
3
3
  */
4
4
  import * as Hume from "../../../index";
5
5
  export interface PostedUtteranceVoiceWithName {
6
- /** The name of a **Voice** within the **Voice Library**. */
6
+ /** The name of a **Voice**. */
7
7
  name: string;
8
8
  /**
9
- * Specifies the provider of the voice associated with this voice name.
9
+ * Specifies the source provider associated with the chosen voice.
10
10
  *
11
- * - **HUME_AI**: Preset voices generated by Hume.
11
+ * - **`HUME_AI`**: Select voices from Hume's [Voice Library](https://platform.hume.ai/tts/voice-library), containing a variety of preset, shared voices.
12
+ * - **`CUSTOM_VOICE`**: Select from voices you've personally generated and saved in your account.
12
13
  *
13
- * - **CUSTOM_VOICE**: Voices you have generated and saved to your `Voice library`.
14
+ * If no provider is explicitly set, the default provider is `CUSTOM_VOICE`. When using voices from Hume's **Voice Library**, you must explicitly set the provider to `HUME_AI`.
14
15
  *
15
- * If a provider is not specified, the provider will default to `CUSTOM_VOICE`.
16
- *
17
- * While Hume's preset voices are shared and usable by anyone, your custom voices are only available to calls made with your API key.
16
+ * Preset voices from Hume's **Voice Library** are accessible by all users. In contrast, your custom voices are private and accessible only via requests authenticated with your API key.
18
17
  */
19
18
  provider?: Hume.tts.VoiceProvider;
20
19
  }
@@ -12,6 +12,6 @@ export interface ReturnGeneration {
12
12
  fileSize: number;
13
13
  /** A unique ID associated with this TTS generation that can be used as context for generating consistent speech style and prosody across multiple requests. */
14
14
  generationId: string;
15
- /** A list of snippet groups where each group corresponds to an utterance in the request. Each group contains segmented snippets that represent the original utterance divided into more natural-sounding units optimized for speech delivery. */
15
+ /** A list of snippet groups where each group corresponds to an utterance in the request. Each group contains segmented snippets that represent the original utterance divided into more natural-sounding units optimized for speech delivery. */
16
16
  snippets: Hume.tts.Snippet[][];
17
17
  }
@@ -4,6 +4,6 @@
4
4
  import * as Hume from "../../../index";
5
5
  export interface ReturnTts {
6
6
  generations: Hume.tts.ReturnGeneration[];
7
- /** A unique ID associated with this request for tracking and troubleshooting. Use this ID when contacting [support](/support) for troubleshooting assistance. */
7
+ /** A unique ID associated with this request for tracking and troubleshooting. Use this ID when contacting [support](/support) for troubleshooting assistance. */
8
8
  requestId?: string;
9
9
  }
@@ -11,15 +11,9 @@ export interface ReturnVoice {
11
11
  /** Name of the voice in the `Voice Library`. */
12
12
  name?: string;
13
13
  /**
14
- * Specifies the provider of the voice.
14
+ * The provider associated with the created voice.
15
15
  *
16
- * - **HUME_AI**: Preset voices generated by Hume.
17
- *
18
- * - **CUSTOM_VOICE**: Voices you have generated and saved to your `Voice library`.
19
- *
20
- * If a provider is not specified, the provider will default to `CUSTOM_VOICE`.
21
- *
22
- * While Hume's preset voices are shared and usable by anyone, your custom voices are only available to calls made with your API key.
16
+ * Voices created through this endpoint will always have the provider set to `CUSTOM_VOICE`, indicating a custom voice stored in your account.
23
17
  */
24
18
  provider?: Hume.tts.VoiceProvider;
25
19
  }
@@ -32,9 +32,6 @@ export * from "./UserInput";
32
32
  export * from "./UserInterruption";
33
33
  export * from "./UserMessage";
34
34
  export * from "./JsonMessage";
35
- export * from "./TtsInput";
36
- export * from "./TextInput";
37
- export * from "./FunctionCallResponseInput";
38
35
  export * from "./HttpValidationError";
39
36
  export * from "./LanguageModelType";
40
37
  export * from "./ModelProviderEnum";
@@ -109,7 +106,6 @@ export * from "./PostedEventMessageSpec";
109
106
  export * from "./PostedTimeoutSpec";
110
107
  export * from "./ReturnEventMessageSpec";
111
108
  export * from "./ReturnTimeoutSpec";
112
- export * from "./PostedPromptSpec";
113
109
  export * from "./PostedVoiceProvider";
114
110
  export * from "./PostedVoice";
115
111
  export * from "./ReturnVoiceProvider";
@@ -48,9 +48,6 @@ __exportStar(require("./UserInput"), exports);
48
48
  __exportStar(require("./UserInterruption"), exports);
49
49
  __exportStar(require("./UserMessage"), exports);
50
50
  __exportStar(require("./JsonMessage"), exports);
51
- __exportStar(require("./TtsInput"), exports);
52
- __exportStar(require("./TextInput"), exports);
53
- __exportStar(require("./FunctionCallResponseInput"), exports);
54
51
  __exportStar(require("./HttpValidationError"), exports);
55
52
  __exportStar(require("./LanguageModelType"), exports);
56
53
  __exportStar(require("./ModelProviderEnum"), exports);
@@ -125,7 +122,6 @@ __exportStar(require("./PostedEventMessageSpec"), exports);
125
122
  __exportStar(require("./PostedTimeoutSpec"), exports);
126
123
  __exportStar(require("./ReturnEventMessageSpec"), exports);
127
124
  __exportStar(require("./ReturnTimeoutSpec"), exports);
128
- __exportStar(require("./PostedPromptSpec"), exports);
129
125
  __exportStar(require("./PostedVoiceProvider"), exports);
130
126
  __exportStar(require("./PostedVoice"), exports);
131
127
  __exportStar(require("./ReturnVoiceProvider"), exports);
package/dist/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.10.3";
1
+ export declare const SDK_VERSION = "0.11.1";
package/dist/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.10.3";
4
+ exports.SDK_VERSION = "0.11.1";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "hume",
3
- "version": "0.11.0",
3
+ "version": "0.11.1",
4
4
  "private": false,
5
5
  "repository": "https://github.com/HumeAI/hume-typescript-sdk",
6
6
  "main": "./index.js",