phonic 0.31.15 → 0.31.16

package/README.md

@@ -12,6 +12,7 @@ The Phonic TypeScript library provides convenient access to the Phonic APIs from
 - [Usage](#usage)
 - [Request and Response Types](#request-and-response-types)
 - [Exception Handling](#exception-handling)
+- [Binary Response](#binary-response)
 - [Advanced](#advanced)
   - [Subpackage Exports](#subpackage-exports)
   - [Additional Headers](#additional-headers)
@@ -72,6 +73,10 @@ await client.agents.create({
     multilingual_mode: "request",
     push_to_talk: false,
     boosted_keywords: ["Load ID", "dispatch"],
+    pronunciation_dictionary: [{
+            word: "Phuket",
+            pronunciation: "Poo-ket"
+        }],
     min_words_to_interrupt: 1,
     configuration_endpoint: {
         url: "https://api.example.com/config",
@@ -116,6 +121,395 @@ try {
 }
 ```
 
+## Binary Response
+
+You can consume binary data from endpoints using the `BinaryResponse` type which lets you choose how to consume the data:
+
+```typescript
+const response = await client.tts.stream(...);
+const stream: ReadableStream<Uint8Array> = response.stream();
+// const arrayBuffer: ArrayBuffer = await response.arrayBuffer();
+// const blob: Blob = response.blob();
+// const bytes: Uint8Array = response.bytes();
+// You can only use the response body once, so you must choose one of the above methods.
+// If you want to check if the response body has been used, you can use the following property.
+const bodyUsed = response.bodyUsed;
+```
+<details>
+<summary>Save binary response to a file</summary>
+
+<blockquote>
+<details>
+<summary>Node.js</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+import { createWriteStream } from 'fs';
+import { Readable } from 'stream';
+import { pipeline } from 'stream/promises';
+
+const response = await client.tts.stream(...);
+
+const stream = response.stream();
+const nodeStream = Readable.fromWeb(stream);
+const writeStream = createWriteStream('path/to/file');
+
+await pipeline(nodeStream, writeStream);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.tts.stream(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await writeFile('path/to/file', Buffer.from(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.tts.stream(...);
+
+const blob = await response.blob();
+const arrayBuffer = await blob.arrayBuffer();
+await writeFile('output.bin', Buffer.from(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.tts.stream(...);
+
+const bytes = await response.bytes();
+await writeFile('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bun</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const stream = response.stream();
+await Bun.write('path/to/file', stream);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await Bun.write('path/to/file', arrayBuffer);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const blob = await response.blob();
+await Bun.write('path/to/file', blob);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const bytes = await response.bytes();
+await Bun.write('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Deno</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const stream = response.stream();
+const file = await Deno.open('path/to/file', { write: true, create: true });
+await stream.pipeTo(file.writable);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const blob = await response.blob();
+const arrayBuffer = await blob.arrayBuffer();
+await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const bytes = await response.bytes();
+await Deno.writeFile('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Browser</summary>
+
+<blockquote>
+<details>
+<summary>Blob (most-efficient)</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const blob = await response.blob();
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ReadableStream</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const stream = response.stream();
+const reader = stream.getReader();
+const chunks = [];
+
+while (true) {
+  const { done, value } = await reader.read();
+  if (done) break;
+  chunks.push(value);
+}
+
+const blob = new Blob(chunks);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const arrayBuffer = await response.arrayBuffer();
+const blob = new Blob([arrayBuffer]);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const bytes = await response.bytes();
+const blob = new Blob([bytes]);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<details>
+<summary>Convert binary response to text</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const stream = response.stream();
+const text = await new Response(stream).text();
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const arrayBuffer = await response.arrayBuffer();
+const text = new TextDecoder().decode(arrayBuffer);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const blob = await response.blob();
+const text = await blob.text();
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.tts.stream(...);
+
+const bytes = await response.bytes();
+const text = new TextDecoder().decode(bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+
 ## Advanced
 
 ### Subpackage Exports

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "phonic",
-        "X-Fern-SDK-Version": "0.31.13",
-        "User-Agent": "phonic/0.31.13",
+        "X-Fern-SDK-Version": "0.31.16",
+        "User-Agent": "phonic/0.31.16",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/Client.d.ts

@@ -5,6 +5,7 @@ import { ConversationsClient } from "./api/resources/conversations/client/Client
 import { ExtractionSchemasClient } from "./api/resources/extractionSchemas/client/Client.js";
 import { ProjectsClient } from "./api/resources/projects/client/Client.js";
 import { ToolsClient } from "./api/resources/tools/client/Client.js";
+import { TtsClient } from "./api/resources/tts/client/Client.js";
 import { VoicesClient } from "./api/resources/voices/client/Client.js";
 import { WorkspaceClient } from "./api/resources/workspace/client/Client.js";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
@@ -28,6 +29,7 @@ export declare class PhonicClient {
     protected _agents: AgentsClient | undefined;
     protected _tools: ToolsClient | undefined;
     protected _extractionSchemas: ExtractionSchemasClient | undefined;
+    protected _tts: TtsClient | undefined;
     protected _voices: VoicesClient | undefined;
     protected _conversations: ConversationsClient | undefined;
     protected _conversationItems: ConversationItemsClient | undefined;
@@ -38,6 +40,7 @@ export declare class PhonicClient {
     get agents(): AgentsClient;
     get tools(): ToolsClient;
     get extractionSchemas(): ExtractionSchemasClient;
+    get tts(): TtsClient;
     get voices(): VoicesClient;
     get conversations(): ConversationsClient;
     get conversationItems(): ConversationItemsClient;

package/dist/cjs/Client.js

@@ -51,8 +51,9 @@ const Client_js_4 = require("./api/resources/conversations/client/Client.js");
 const Client_js_5 = require("./api/resources/extractionSchemas/client/Client.js");
 const Client_js_6 = require("./api/resources/projects/client/Client.js");
 const Client_js_7 = require("./api/resources/tools/client/Client.js");
-const Client_js_8 = require("./api/resources/voices/client/Client.js");
-const Client_js_9 = require("./api/resources/workspace/client/Client.js");
+const Client_js_8 = require("./api/resources/tts/client/Client.js");
+const Client_js_9 = require("./api/resources/voices/client/Client.js");
+const Client_js_10 = require("./api/resources/workspace/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
 const core = __importStar(require("./core/index.js"));
 const environments = __importStar(require("./environments.js"));
@@ -72,9 +73,13 @@ class PhonicClient {
         var _a;
         return ((_a = this._extractionSchemas) !== null && _a !== void 0 ? _a : (this._extractionSchemas = new Client_js_5.ExtractionSchemasClient(this._options)));
     }
+    get tts() {
+        var _a;
+        return ((_a = this._tts) !== null && _a !== void 0 ? _a : (this._tts = new Client_js_8.TtsClient(this._options)));
+    }
     get voices() {
         var _a;
-        return ((_a = this._voices) !== null && _a !== void 0 ? _a : (this._voices = new Client_js_8.VoicesClient(this._options)));
+        return ((_a = this._voices) !== null && _a !== void 0 ? _a : (this._voices = new Client_js_9.VoicesClient(this._options)));
     }
     get conversations() {
         var _a;
@@ -94,7 +99,7 @@ class PhonicClient {
     }
     get workspace() {
         var _a;
-        return ((_a = this._workspace) !== null && _a !== void 0 ? _a : (this._workspace = new Client_js_9.WorkspaceClient(this._options)));
+        return ((_a = this._workspace) !== null && _a !== void 0 ? _a : (this._workspace = new Client_js_10.WorkspaceClient(this._options)));
     }
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

package/dist/cjs/api/resources/agents/client/Client.d.ts

@@ -64,6 +64,10 @@ export declare class AgentsClient {
      *         multilingual_mode: "request",
      *         push_to_talk: false,
      *         boosted_keywords: ["Load ID", "dispatch"],
+     *         pronunciation_dictionary: [{
+     *                 word: "Phuket",
+     *                 pronunciation: "Poo-ket"
+     *             }],
      *         min_words_to_interrupt: 1,
      *         configuration_endpoint: {
      *             url: "https://api.example.com/config",
@@ -114,6 +118,10 @@ export declare class AgentsClient {
      *         multilingual_mode: "request",
      *         push_to_talk: false,
      *         boosted_keywords: ["Load ID", "dispatch"],
+     *         pronunciation_dictionary: [{
+     *                 word: "Phuket",
+     *                 pronunciation: "Poo-ket"
+     *             }],
      *         min_words_to_interrupt: 1,
      *         configuration_endpoint: {
      *             url: "https://api.example.com/config",
@@ -200,6 +208,10 @@ export declare class AgentsClient {
      *         multilingual_mode: "request",
      *         push_to_talk: false,
      *         boosted_keywords: ["Load ID", "dispatch"],
+     *         pronunciation_dictionary: [{
+     *                 word: "Phuket",
+     *                 pronunciation: "Poo-ket"
+     *             }],
      *         min_words_to_interrupt: 1,
      *         configuration_endpoint: {
      *             url: "https://api.example.com/config",

package/dist/cjs/api/resources/agents/client/Client.js

@@ -162,6 +162,10 @@ class AgentsClient {
      *         multilingual_mode: "request",
      *         push_to_talk: false,
      *         boosted_keywords: ["Load ID", "dispatch"],
+     *         pronunciation_dictionary: [{
+     *                 word: "Phuket",
+     *                 pronunciation: "Poo-ket"
+     *             }],
      *         min_words_to_interrupt: 1,
      *         configuration_endpoint: {
      *             url: "https://api.example.com/config",
@@ -261,6 +265,10 @@ class AgentsClient {
      *         multilingual_mode: "request",
      *         push_to_talk: false,
      *         boosted_keywords: ["Load ID", "dispatch"],
+     *         pronunciation_dictionary: [{
+     *                 word: "Phuket",
+     *                 pronunciation: "Poo-ket"
+     *             }],
      *         min_words_to_interrupt: 1,
      *         configuration_endpoint: {
      *             url: "https://api.example.com/config",
@@ -476,6 +484,10 @@ class AgentsClient {
      *         multilingual_mode: "request",
      *         push_to_talk: false,
      *         boosted_keywords: ["Load ID", "dispatch"],
+     *         pronunciation_dictionary: [{
+     *                 word: "Phuket",
+     *                 pronunciation: "Poo-ket"
+     *             }],
      *         min_words_to_interrupt: 1,
      *         configuration_endpoint: {
      *             url: "https://api.example.com/config",

package/dist/cjs/api/resources/agents/client/requests/AgentsCreateRequest.d.ts

@@ -29,6 +29,10 @@ import type * as Phonic from "../../../../index.js";
  *         multilingual_mode: "request",
  *         push_to_talk: false,
  *         boosted_keywords: ["Load ID", "dispatch"],
+ *         pronunciation_dictionary: [{
+ *                 word: "Phuket",
+ *                 pronunciation: "Poo-ket"
+ *             }],
  *         min_words_to_interrupt: 1,
  *         configuration_endpoint: {
  *             url: "https://api.example.com/config",
@@ -94,6 +98,8 @@ export interface AgentsCreateRequest {
     push_to_talk?: boolean;
     /** These words, or short phrases, will be more accurately recognized by the agent. */
     boosted_keywords?: string[];
+    /** Array of `{ word, pronunciation }` entries. Words must be unique. */
+    pronunciation_dictionary?: Phonic.CreateAgentRequest.PronunciationDictionary.Item[];
     /** Minimum number of words required to interrupt the assistant. */
     min_words_to_interrupt?: number;
     /** When not `null`, at the beginning of the conversation the agent will make a POST request to this endpoint to get configuration options. */

package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.d.ts

@@ -29,6 +29,10 @@ import type * as Phonic from "../../../../index.js";
  *         multilingual_mode: "request",
  *         push_to_talk: false,
  *         boosted_keywords: ["Load ID", "dispatch"],
+ *         pronunciation_dictionary: [{
+ *                 word: "Phuket",
+ *                 pronunciation: "Poo-ket"
+ *             }],
  *         min_words_to_interrupt: 1,
  *         configuration_endpoint: {
  *             url: "https://api.example.com/config",
@@ -94,6 +98,8 @@ export interface UpdateAgentRequest {
     push_to_talk?: boolean;
     /** These words, or short phrases, will be more accurately recognized by the agent. */
     boosted_keywords?: string[];
+    /** Array of `{ word, pronunciation }` entries. Words must be unique. */
+    pronunciation_dictionary?: UpdateAgentRequest.PronunciationDictionary.Item[];
     /** Minimum number of words required to interrupt the assistant. */
     min_words_to_interrupt?: number;
     /** When not `null`, at the beginning of the conversation the agent will make a POST request to this endpoint to get configuration options. */
@@ -151,6 +157,13 @@ export declare namespace UpdateAgentRequest {
         readonly Request: "request";
     };
     type MultilingualMode = (typeof MultilingualMode)[keyof typeof MultilingualMode];
+    type PronunciationDictionary = PronunciationDictionary.Item[];
+    namespace PronunciationDictionary {
+        interface Item {
+            word: string;
+            pronunciation: string;
+        }
+    }
     /**
      * When not `null`, at the beginning of the conversation the agent will make a POST request to this endpoint to get configuration options.
      */

package/dist/cjs/api/resources/agents/client/requests/UpsertAgentRequest.d.ts

@@ -29,6 +29,10 @@ import type * as Phonic from "../../../../index.js";
  *         multilingual_mode: "request",
  *         push_to_talk: false,
  *         boosted_keywords: ["Load ID", "dispatch"],
+ *         pronunciation_dictionary: [{
+ *                 word: "Phuket",
+ *                 pronunciation: "Poo-ket"
+ *             }],
  *         min_words_to_interrupt: 1,
  *         configuration_endpoint: {
  *             url: "https://api.example.com/config",

package/dist/cjs/api/resources/conversations/client/requests/OutboundCallRequest.d.ts

@@ -21,6 +21,10 @@ import type * as Phonic from "../../../../index.js";
  *             multilingual_mode: "request",
  *             push_to_talk: false,
  *             boosted_keywords: ["Load ID", "dispatch"],
+ *             pronunciation_dictionary: [{
+ *                     word: "Phuket",
+ *                     pronunciation: "Poo-ket"
+ *                 }],
  *             min_words_to_interrupt: 1,
  *             tools: ["keypad_input"]
  *         },

package/dist/cjs/api/resources/index.d.ts

@@ -18,6 +18,8 @@ export * from "./projects/types/index.js";
 export * from "./tools/client/requests/index.js";
 export * as tools from "./tools/index.js";
 export * from "./tools/types/index.js";
+export * from "./tts/client/requests/index.js";
+export * as tts from "./tts/index.js";
 export * from "./voices/client/requests/index.js";
 export * as voices from "./voices/index.js";
 export * from "./voices/types/index.js";

package/dist/cjs/api/resources/index.js

@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.workspace = exports.voices = exports.tools = exports.projects = exports.extractionSchemas = exports.conversations = exports.conversationItems = exports.auth = exports.agents = void 0;
+exports.workspace = exports.voices = exports.tts = exports.tools = exports.projects = exports.extractionSchemas = exports.conversations = exports.conversationItems = exports.auth = exports.agents = void 0;
 __exportStar(require("./agents/client/requests/index.js"), exports);
 exports.agents = __importStar(require("./agents/index.js"));
 __exportStar(require("./agents/types/index.js"), exports);
@@ -57,6 +57,8 @@ __exportStar(require("./projects/types/index.js"), exports);
 __exportStar(require("./tools/client/requests/index.js"), exports);
 exports.tools = __importStar(require("./tools/index.js"));
 __exportStar(require("./tools/types/index.js"), exports);
+__exportStar(require("./tts/client/requests/index.js"), exports);
+exports.tts = __importStar(require("./tts/index.js"));
 __exportStar(require("./voices/client/requests/index.js"), exports);
 exports.voices = __importStar(require("./voices/index.js"));
 __exportStar(require("./voices/types/index.js"), exports);

package/dist/cjs/api/resources/tts/client/Client.d.ts

@@ -0,0 +1,23 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Phonic from "../../../index.js";
+export declare namespace TtsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class TtsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<TtsClient.Options>;
+    constructor(options?: TtsClient.Options);
+    /**
+     * Streams generated speech audio for the provided text.
+     *
+     * @throws {@link Phonic.BadRequestError}
+     * @throws {@link Phonic.UnauthorizedError}
+     * @throws {@link Phonic.ForbiddenError}
+     * @throws {@link Phonic.InternalServerError}
+     */
+    stream(request: Phonic.StreamTtsRequest, requestOptions?: TtsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __stream;
+}