hume 0.9.14 → 0.9.15

package/dist/core/streaming-fetcher/Stream.js

@@ -0,0 +1,170 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readableStreamAsyncIterable = exports.Stream = void 0;
+const runtime_1 = require("../runtime");
+const DATA_PREFIX = "data:";
+class Stream {
+    constructor({ stream, parse, eventShape, signal }) {
+        this.controller = new AbortController();
+        this.stream = stream;
+        this.parse = parse;
+        if (eventShape.type === "sse") {
+            this.prefix = DATA_PREFIX;
+            this.messageTerminator = "\n";
+            this.streamTerminator = eventShape.streamTerminator;
+        }
+        else {
+            this.messageTerminator = eventShape.messageTerminator;
+        }
+        signal === null || signal === void 0 ? void 0 : signal.addEventListener("abort", () => this.controller.abort());
+    }
+    iterMessages() {
+        return __asyncGenerator(this, arguments, function* iterMessages_1() {
+            var e_1, _a;
+            this.controller.signal;
+            const stream = readableStreamAsyncIterable(this.stream);
+            let buf = "";
+            let prefixSeen = false;
+            try {
+                for (var stream_1 = __asyncValues(stream), stream_1_1; stream_1_1 = yield __await(stream_1.next()), !stream_1_1.done;) {
+                    const chunk = stream_1_1.value;
+                    buf += this.decodeChunk(chunk);
+                    let terminatorIndex;
+                    // Parse the chunk into as many messages as possible
+                    while ((terminatorIndex = buf.indexOf(this.messageTerminator)) >= 0) {
+                        // Extract the line from the buffer
+                        let line = buf.slice(0, terminatorIndex + 1);
+                        buf = buf.slice(terminatorIndex + 1);
+                        // Skip empty lines
+                        if (line.length === 0) {
+                            continue;
+                        }
+                        // Skip the chunk until the prefix is found
+                        if (!prefixSeen && this.prefix != null) {
+                            const prefixIndex = line.indexOf(this.prefix);
+                            if (prefixIndex === -1) {
+                                continue;
+                            }
+                            prefixSeen = true;
+                            line = line.slice(prefixIndex + this.prefix.length);
+                        }
+                        // If the stream terminator is present, return
+                        if (this.streamTerminator != null && line.includes(this.streamTerminator)) {
+                            return yield __await(void 0);
+                        }
+                        // Otherwise, yield message from the prefix to the terminator
+                        const message = yield __await(this.parse(JSON.parse(line)));
+                        yield yield __await(message);
+                        prefixSeen = false;
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (stream_1_1 && !stream_1_1.done && (_a = stream_1.return)) yield __await(_a.call(stream_1));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        });
+    }
+    [Symbol.asyncIterator]() {
+        return __asyncGenerator(this, arguments, function* _a() {
+            var e_2, _b;
+            try {
+                for (var _c = __asyncValues(this.iterMessages()), _d; _d = yield __await(_c.next()), !_d.done;) {
+                    const message = _d.value;
+                    yield yield __await(message);
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (_d && !_d.done && (_b = _c.return)) yield __await(_b.call(_c));
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+        });
+    }
+    decodeChunk(chunk) {
+        let decoded = "";
+        // If TextDecoder is present, use it
+        if (typeof TextDecoder !== "undefined") {
+            const decoder = new TextDecoder("utf8");
+            decoded += decoder.decode(chunk);
+        }
+        // Buffer is present in Node.js environment
+        else if (runtime_1.RUNTIME.type === "node" && typeof chunk != "undefined") {
+            decoded += Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk);
+        }
+        return decoded;
+    }
+}
+exports.Stream = Stream;
+/**
+ * Browser polyfill for ReadableStream
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function readableStreamAsyncIterable(stream) {
+    if (stream[Symbol.asyncIterator]) {
+        return stream;
+    }
+    const reader = stream.getReader();
+    return {
+        next() {
+            return __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const result = yield reader.read();
+                    if (result === null || result === void 0 ? void 0 : result.done) {
+                        reader.releaseLock();
+                    } // release lock when stream becomes closed
+                    return result;
+                }
+                catch (e) {
+                    reader.releaseLock(); // release lock when stream becomes errored
+                    throw e;
+                }
+            });
+        },
+        return() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const cancelPromise = reader.cancel();
+                reader.releaseLock();
+                yield cancelPromise;
+                return { done: true, value: undefined };
+            });
+        },
+        [Symbol.asyncIterator]() {
+            return this;
+        },
+    };
+}
+exports.readableStreamAsyncIterable = readableStreamAsyncIterable;

package/dist/core/streaming-fetcher/index.d.ts

@@ -0,0 +1 @@
+export { Stream } from "./Stream";

package/dist/core/streaming-fetcher/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Stream = void 0;
+var Stream_1 = require("./Stream");
+Object.defineProperty(exports, "Stream", { enumerable: true, get: function () { return Stream_1.Stream; } });

package/dist/serialization/resources/tts/types/Snippet.d.ts

@@ -8,7 +8,6 @@ export declare const Snippet: core.serialization.ObjectSchema<serializers.tts.Sn
 export declare namespace Snippet {
     interface Raw {
         audio: string;
-        audio_format: string;
         generation_id: string;
         id: string;
         text: string;

package/dist/serialization/resources/tts/types/Snippet.js

@@ -30,7 +30,6 @@ exports.Snippet = void 0;
 const core = __importStar(require("../../../../core"));
 exports.Snippet = core.serialization.object({
     audio: core.serialization.string(),
-    audioFormat: core.serialization.property("audio_format", core.serialization.string()),
     generationId: core.serialization.property("generation_id", core.serialization.string()),
     id: core.serialization.string(),
     text: core.serialization.string(),

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.9.14";
+export declare const SDK_VERSION = "0.9.15";

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.9.14";
+exports.SDK_VERSION = "0.9.15";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hume",
-    "version": "0.9.14",
+    "version": "0.9.15",
     "private": false,
     "repository": "https://github.com/HumeAI/hume-typescript-sdk",
     "main": "./index.js",

package/reference.md

@@ -168,6 +168,169 @@ await client.tts.synthesizeFile({
 </dl>
 </details>
 
+<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFileStreaming</a>({ ...params }) -> stream.Readable</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tts.synthesizeFileStreaming({
+    utterances: [
+        {
+            text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
+            description:
+                "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm,  steady tone with an articulate, academic quality.",
+        },
+    ],
+    context: {
+        generationId: "09ad914d-8e7f-40f8-a279-e34f07f7dab2",
+    },
+    format: {
+        type: "mp3",
+    },
+    numGenerations: 1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Hume.PostedTts`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Tts.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJsonStreaming</a>({ ...params }) -> core.Stream<Hume.Snippet></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+
+The response is a stream of JSON objects including audio encoded in base64.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tts.synthesizeJsonStreaming({
+    utterances: [
+        {
+            text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
+            description:
+                "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm,  steady tone with an articulate, academic quality.",
+        },
+    ],
+    context: {
+        utterances: [
+            {
+                text: "How can people see beauty so differently?",
+                description:
+                    "A curious student with a clear and respectful tone, seeking clarification on Hume's  ideas with a straightforward question.",
+            },
+        ],
+    },
+    format: {
+        type: "mp3",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Hume.PostedTts`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Tts.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Tts Voices
 
 <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">create</a>({ ...params }) -> Hume.ReturnVoice</code></summary>

package/serialization/resources/tts/types/Snippet.d.ts

@@ -8,7 +8,6 @@ export declare const Snippet: core.serialization.ObjectSchema<serializers.tts.Sn
 export declare namespace Snippet {
     interface Raw {
         audio: string;
-        audio_format: string;
         generation_id: string;
         id: string;
         text: string;

package/serialization/resources/tts/types/Snippet.js

@@ -30,7 +30,6 @@ exports.Snippet = void 0;
 const core = __importStar(require("../../../../core"));
 exports.Snippet = core.serialization.object({
     audio: core.serialization.string(),
-    audioFormat: core.serialization.property("audio_format", core.serialization.string()),
     generationId: core.serialization.property("generation_id", core.serialization.string()),
     id: core.serialization.string(),
     text: core.serialization.string(),

package/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.9.14";
+export declare const SDK_VERSION = "0.9.15";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.9.14";
+exports.SDK_VERSION = "0.9.15";