@flamai/finesse 0.1.1 → 0.1.2

package/dist/index.d.cts

@@ -332,10 +332,11 @@ interface ContextOptions {
     voice_id: string;
     context_id?: string;
     language?: string;
-    /** `s16le` (default), `s24le`, `s32le`, `f32le`, `f64le` or `opus`. */
-    output_format?: "s16le" | "s24le" | "s32le" | "f32le" | "f64le" | "opus";
-    /** Output rate in Hz, 8000-48000; the native rate is 24000 and lower values still produce
-     * 24000. */
+    /** `s16le` (default), `s24le`, `s32le`, `f32le`, `f64le`, `opus`, or `mulaw` (G.711 µ-law
+     * for telephony, with `sample_rate: 8000`). */
+    output_format?: "s16le" | "s24le" | "s32le" | "f32le" | "f64le" | "opus" | "mulaw";
+    /** Output rate in Hz, 8000-48000; the native rate is 24000. 8000 is produced as asked, other
+     * lower values still produce 24000. */
     sample_rate?: number;
     /** Generation steps, 1-32 (default 32); fewer is faster. Values over 32 are capped. */
     num_step?: number;
@@ -581,7 +582,8 @@ interface AccessToken {
     expires_at: number;
     ttl_seconds: number;
 }
-type OutputFormat = "wav" | "s16le" | "s24le" | "s32le" | "f32le" | "f64le";
+/** `mulaw` is raw G.711 µ-law for telephony and needs `sample_rate: 8000`. */
+type OutputFormat = "wav" | "s16le" | "s24le" | "s32le" | "f32le" | "f64le" | "mulaw";
 interface SpeechParams {
     /** One of your voices or a public platform voice; it must be ready. */
     voice_id: string;
@@ -589,7 +591,8 @@ interface SpeechParams {
     text: string;
     language?: string;
     output_format?: OutputFormat;
-    /** Output rate in Hz, 8000-48000. The native rate is 24000; lower values still return 24000. */
+    /** Output rate in Hz, 8000-48000. The native rate is 24000; 8000 is produced as asked, other
+     * lower values still return 24000. */
     sample_rate?: number;
     /** Generation steps, 1-32 (default and maximum 32; over 32 is a 400); fewer is faster. */
     num_step?: number;
@@ -823,6 +826,6 @@ declare class Finesse {
     get withRawResponse(): RawClient<FinesseResources>;
 }
 
-declare const VERSION = "0.1.1";
+declare const VERSION = "0.1.2";
 
 export { APIConnectionError, APIStatusError, APITimeoutError, type AccessToken, type Audio, type AudioChunk, type AudioEvent, AuthenticationError, BadRequestError, type ClientOptions, CloneFailedError, type CloneJob, type CloneResult, CloneTimeoutError, type CloneVoiceParams, ConflictError, type ConnectOptions, type ConsentParams, type ContextOptions, type CreateTokenParams, type CreateVoiceParams, type EnrollVoiceParams, type FileInput, Finesse, FinesseError, InternalServerError, type ListVoicesParams, type LogLevel, type Logger, NotFoundError, type OutputFormat, PayloadTooLargeError, PaymentRequiredError, PermissionDeniedError, RateLimitError, type RawClient, type RawResponse, RealtimeContext, RealtimeError, type RealtimeEvent, RealtimeSession, type RequestOptions, type SentenceDone, type SpeechParams, SpeechStream, type StreamDone, StreamError, type TaskCancelled, type TaskDone, type TaskStarted, type UnknownEvent, UnprocessableEntityError, type UpdateVoiceParams, VERSION, type Voice, VoicePage, VoicePagePromise, type VoiceSettings, type WaitOptions, fileFromPath, isReady };

package/dist/index.d.ts

@@ -332,10 +332,11 @@ interface ContextOptions {
     voice_id: string;
     context_id?: string;
     language?: string;
-    /** `s16le` (default), `s24le`, `s32le`, `f32le`, `f64le` or `opus`. */
-    output_format?: "s16le" | "s24le" | "s32le" | "f32le" | "f64le" | "opus";
-    /** Output rate in Hz, 8000-48000; the native rate is 24000 and lower values still produce
-     * 24000. */
+    /** `s16le` (default), `s24le`, `s32le`, `f32le`, `f64le`, `opus`, or `mulaw` (G.711 µ-law
+     * for telephony, with `sample_rate: 8000`). */
+    output_format?: "s16le" | "s24le" | "s32le" | "f32le" | "f64le" | "opus" | "mulaw";
+    /** Output rate in Hz, 8000-48000; the native rate is 24000. 8000 is produced as asked, other
+     * lower values still produce 24000. */
     sample_rate?: number;
     /** Generation steps, 1-32 (default 32); fewer is faster. Values over 32 are capped. */
     num_step?: number;
@@ -581,7 +582,8 @@ interface AccessToken {
     expires_at: number;
     ttl_seconds: number;
 }
-type OutputFormat = "wav" | "s16le" | "s24le" | "s32le" | "f32le" | "f64le";
+/** `mulaw` is raw G.711 µ-law for telephony and needs `sample_rate: 8000`. */
+type OutputFormat = "wav" | "s16le" | "s24le" | "s32le" | "f32le" | "f64le" | "mulaw";
 interface SpeechParams {
     /** One of your voices or a public platform voice; it must be ready. */
     voice_id: string;
@@ -589,7 +591,8 @@ interface SpeechParams {
     text: string;
     language?: string;
     output_format?: OutputFormat;
-    /** Output rate in Hz, 8000-48000. The native rate is 24000; lower values still return 24000. */
+    /** Output rate in Hz, 8000-48000. The native rate is 24000; 8000 is produced as asked, other
+     * lower values still return 24000. */
     sample_rate?: number;
     /** Generation steps, 1-32 (default and maximum 32; over 32 is a 400); fewer is faster. */
     num_step?: number;
@@ -823,6 +826,6 @@ declare class Finesse {
     get withRawResponse(): RawClient<FinesseResources>;
 }
 
-declare const VERSION = "0.1.1";
+declare const VERSION = "0.1.2";
 
 export { APIConnectionError, APIStatusError, APITimeoutError, type AccessToken, type Audio, type AudioChunk, type AudioEvent, AuthenticationError, BadRequestError, type ClientOptions, CloneFailedError, type CloneJob, type CloneResult, CloneTimeoutError, type CloneVoiceParams, ConflictError, type ConnectOptions, type ConsentParams, type ContextOptions, type CreateTokenParams, type CreateVoiceParams, type EnrollVoiceParams, type FileInput, Finesse, FinesseError, InternalServerError, type ListVoicesParams, type LogLevel, type Logger, NotFoundError, type OutputFormat, PayloadTooLargeError, PaymentRequiredError, PermissionDeniedError, RateLimitError, type RawClient, type RawResponse, RealtimeContext, RealtimeError, type RealtimeEvent, RealtimeSession, type RequestOptions, type SentenceDone, type SpeechParams, SpeechStream, type StreamDone, StreamError, type TaskCancelled, type TaskDone, type TaskStarted, type UnknownEvent, UnprocessableEntityError, type UpdateVoiceParams, VERSION, type Voice, VoicePage, VoicePagePromise, type VoiceSettings, type WaitOptions, fileFromPath, isReady };

package/dist/index.js

@@ -163,7 +163,7 @@ function numberField(body2, key) {
 }
 
 // src/version.ts
-var VERSION = "0.1.1";
+var VERSION = "0.1.2";
 
 // src/core.ts
 var DEFAULT_BASE_URL = "https://fi.production.flamapis.com";