@breeze.blue/sdk 0.21.0 → 0.21.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.21.1
+
+- Document Voice Design guidance: omitted or null samples 1–4 per preview; explicit values still accept 1–10.
+
+- Clarify speaker boost docs: instructions are always applied; boost is ignored with non-empty instructions and guidance above 1, otherwise guidance is applied as 1. Realtime needs a new session to add instructions only when boost applies with requested guidance above 1.
+
 ## 0.21.0
 
 - Support request-scoped speaker boost across HTTP and realtime TTS, with performance instructions taking priority when guidance exceeds 1.

package/README.md

@@ -7,7 +7,7 @@ models, and account usage.
 The root entrypoint is safe to import in Node, browser, and edge runtimes. Local
 audio playback helpers live in the Node-only `@breeze.blue/sdk/node` subpath.
 
-Guidance accepts 1–10; when omitted, the default 1 is used. HTTP speed and volume are per request and default to 1. Use `voiceSettings: { useSpeakerBoost: true }` for closer similarity to the reference voice (default false): it is ignored with non-empty instructions and guidance above 1, and otherwise instructions are not used. Realtime fixes boost at session creation; create a new session to change instructions while boost applies. Pass `removeBackgroundNoise: true` to denoise a clone sample (default false).
+TTS guidance accepts 1–10; when omitted, the default 1 is used. Voice Design accepts 1–10; omitting guidance or passing null samples uniformly between 1–4 for each preview, rounded to one decimal place. HTTP speed and volume are per request and default to 1. Use `voiceSettings: { useSpeakerBoost: true }` for closer similarity to the reference voice (default false): it is ignored with non-empty instructions and guidance above 1, otherwise guidance is applied as 1; instructions are always applied. Realtime fixes boost at session creation; when boost applies with requested guidance above 1, create a new session to add instructions. Pass `removeBackgroundNoise: true` to denoise a clone sample (default false).
 
 ## Install
 

package/dist/types.d.ts

@@ -227,7 +227,7 @@ export type RealtimeTextToSpeechMessage = RealtimeTextToSpeechEvent | RealtimeTe
 export interface TtsVoiceSettings {
     /** Generation guidance strength (1–10). Omitted or null uses the default 1. */
     guidanceScale?: number | null;
-    /** Default false. Ignored with non-empty instructions and guidanceScale > 1; otherwise instructions are not used. */
+    /** Default false. Ignored with non-empty instructions and guidanceScale > 1; otherwise guidanceScale is applied as 1. Instructions are always applied. */
     useSpeakerBoost?: boolean;
     /** Pitch-preserving speed (0.5–2.0). */
     speed?: number;
@@ -415,6 +415,7 @@ export interface VoiceDesignRequest {
     text?: string;
     modelId?: string;
     languageCode?: VoiceLanguageCode;
+    /** Voice Design accepts 1–10; omitted or null samples 1–4 per preview, rounded to one decimal place. */
     guidanceScale?: number | null;
     previewCount?: number;
 }
@@ -423,6 +424,7 @@ export interface VoiceDesignStreamRequest {
     text?: string;
     modelId?: string;
     languageCode?: VoiceLanguageCode;
+    /** Voice Design accepts 1–10; omitted or null samples 1–4 per preview, rounded to one decimal place. */
     guidanceScale?: number | null;
 }
 export interface VoiceDesignPreview {

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "0.21.0";
+export declare const SDK_VERSION = "0.21.1";
 export declare const SDK_NAME = "@breeze.blue/sdk";

package/dist/version.js

@@ -1,2 +1,2 @@
-export const SDK_VERSION = "0.21.0";
+export const SDK_VERSION = "0.21.1";
 export const SDK_NAME = "@breeze.blue/sdk";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breeze.blue/sdk",
-  "version": "0.21.0",
+  "version": "0.21.1",
   "description": "ESM-first TypeScript SDK for the Breeze Blue Developer API.",
   "license": "MIT",
   "author": "Breeze Blue <support@breezeblue.ai>",