@rimelabs/sdk 0.1.0-alpha.14 → 0.1.0-alpha.16

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.1.0-alpha.16](https://github.com/rimelabs/rime-sdk/compare/typescript-v0.1.0-alpha.15...typescript-v0.1.0-alpha.16) (2026-10-16)
+
+
+### Features
+
+* **realtime:** expose Prism's speech hint ([#73](https://github.com/rimelabs/rime-sdk/issues/73)) ([cb7187d](https://github.com/rimelabs/rime-sdk/commit/cb7187d687c2210332fee704d43ac9ba45c760ea))
+
+## [0.1.0-alpha.15](https://github.com/rimelabs/rime-sdk/compare/typescript-v0.1.0-alpha.14...typescript-v0.1.0-alpha.15) (2026-10-13)
+
+
+### Bug Fixes
+
+* **realtime:** align Prism protocol names and contract fixtures ([#68](https://github.com/rimelabs/rime-sdk/issues/68)) ([806d8a4](https://github.com/rimelabs/rime-sdk/commit/806d8a4811f0baf6b220487dfc6ccd21cfe8ea18))
+
 ## [0.1.0-alpha.14](https://github.com/rimelabs/rime-sdk/compare/typescript-v0.1.0-alpha.13...typescript-v0.1.0-alpha.14) (2026-10-12)
 
 

package/dist/realtime/protocol.js

@@ -66,15 +66,15 @@ function duration(value, field) {
 }
 function session(value) {
     const view = object(value, "session");
-    const waits = view.prsm_tool_waits === undefined
+    const waits = view.prism_tool_waits === undefined
         ? {}
-        : object(view.prsm_tool_waits, "session.prsm_tool_waits");
-    if (view.prsm_tool_waits !== undefined &&
+        : object(view.prism_tool_waits, "session.prism_tool_waits");
+    if (view.prism_tool_waits !== undefined &&
         (!("result_timeout_s" in waits) || !("continuation_timeout_s" in waits)))
-        invalid("session.prsm_tool_waits");
-    const interrupt = view.prsm_effective_interrupt_response;
+        invalid("session.prism_tool_waits");
+    const interrupt = view.prism_effective_interrupt_response;
     if (interrupt !== undefined && typeof interrupt !== "boolean")
-        invalid("session.prsm_effective_interrupt_response");
+        invalid("session.prism_effective_interrupt_response");
     return {
         id: id(view.id, "session.id"),
         voice: view.voice === undefined ? "" : string(view.voice, "session.voice"),
@@ -189,9 +189,15 @@ function decodeValue(value, sessionId) {
                 contentIndex: integer(event.content_index, "content_index"),
             };
             break;
-        case "prsm.typed_input.ready":
+        case "prism.typed_input.ready":
             payload = { kind: "input.ready" };
             break;
+        case "prism.input_audio_buffer.speech_hint":
+            payload = {
+                kind: "speech.hint",
+                audioStartMs: integer(event.audio_start_ms, "audio_start_ms"),
+            };
+            break;
         case "input_audio_buffer.speech_started":
             payload = {
                 kind: "speech.started",
@@ -244,10 +250,10 @@ function decodeValue(value, sessionId) {
             const response = object(event.response, "response"), metadata = response.metadata == null
                 ? {}
                 : object(response.metadata, "metadata");
-            const cause = metadata.prsm_cause === undefined
+            const cause = metadata.prism_cause === undefined
                 ? undefined
-                : string(metadata.prsm_cause, "prsm_cause");
-            const parent = optionalString(metadata.prsm_parent_response_id, "prsm_parent_response_id");
+                : string(metadata.prism_cause, "prism_cause");
+            const parent = optionalString(metadata.prism_parent_response_id, "prism_parent_response_id");
             payload = {
                 kind: "response.started",
                 response: ref(response.id),
@@ -261,7 +267,7 @@ function decodeValue(value, sessionId) {
                                 ? "proactive"
                                 : "unknown",
                 parent: parent === null ? null : ref(parent),
-                inputItemId: optionalString(metadata.prsm_input_item_id, "prsm_input_item_id"),
+                inputItemId: optionalString(metadata.prism_input_item_id, "prism_input_item_id"),
             };
             break;
         }
@@ -282,7 +288,7 @@ function decodeValue(value, sessionId) {
                     ? status
                     : "unknown",
                 reason: optionalString(details.reason, "reason"),
-                drainToken: optionalString(metadata.prsm_drain_token, "prsm_drain_token"),
+                drainToken: optionalString(metadata.prism_drain_token, "prism_drain_token"),
             };
             break;
         }
@@ -348,7 +354,7 @@ function decodeValue(value, sessionId) {
     }
     return {
         eventId: event.event_id === undefined ? "" : string(event.event_id, "event_id"),
-        requestId: optionalString(event.prsm_request_event_id, "prsm_request_event_id"),
+        requestId: optionalString(event.prism_request_event_id, "prism_request_event_id"),
         payload,
     };
 }

package/dist/realtime/session.js

@@ -348,21 +348,21 @@ export class RealtimeSession {
     }
     async sendText(value, options = {}) {
         text(value);
-        return this.operation(options, (signal) => this.create({ prsm_input_text: value, metadata: { prsm_cause: "user_text" } }, signal, p.requests.text));
+        return this.operation(options, (signal) => this.create({ prism_input_text: value, metadata: { prism_cause: "user_text" } }, signal, p.requests.text));
     }
     async requestReply(options = {}) {
         const body = {
-            metadata: { prsm_cause: "proactive" },
+            metadata: { prism_cause: "proactive" },
         };
         if (options.instruction != null) {
             text(options.instruction);
-            body.prsm_instruction = options.instruction;
+            body.prism_instruction = options.instruction;
         }
         if (options.toolCall != null) {
             const state = this.response(options.toolCall);
             if (state.calls.get(options.toolCall.callId) === null)
                 throw new RimeInputError("Record the tool result before requesting its report");
-            body.prsm_call_id = options.toolCall.callId;
+            body.prism_call_id = options.toolCall.callId;
         }
         return this.operation(options, (signal) => this.create(body, signal));
     }
@@ -434,8 +434,8 @@ export class RealtimeSession {
             return (await this.request(p.requests.create, {
                 response: {
                     metadata: {
-                        prsm_cause: "tool_continuation",
-                        prsm_parent_response_id: ref.responseId,
+                        prism_cause: "tool_continuation",
+                        prism_parent_response_id: ref.responseId,
                     },
                 },
             }, signal, undefined, state)).response;
@@ -524,7 +524,7 @@ export class RealtimeSession {
             this.check();
             if (state.token)
                 await this.send({
-                    type: "prsm.playback.drained",
+                    type: "prism.playback.drained",
                     response_id: state.ref.responseId,
                     drain_token: state.token,
                     played_ms: played,

package/dist/realtime/types.d.ts

@@ -81,6 +81,13 @@ export declare class RimeRealtimeError extends RimeError {
 export interface InputReady {
     readonly kind: "input.ready";
 }
+/** The user may have started speaking over a playing reply. Prism sends it
+ * before `speech.started` when it may interrupt the reply; it can be a false
+ * alarm, so lower playback on it rather than stopping. */
+export interface SpeechHint {
+    readonly kind: "speech.hint";
+    readonly audioStartMs: number;
+}
 export interface SpeechStarted {
     readonly kind: "speech.started";
     readonly itemId: string;
@@ -164,7 +171,7 @@ export interface FaultEvent {
     readonly kind: "error";
     readonly error: RealtimeFault;
 }
-export type InputEvent = InputReady | SpeechStarted | SpeechStopped | InputCommitted | TranscriptDelta | TranscriptFinal | TranscriptFailed;
+export type InputEvent = InputReady | SpeechHint | SpeechStarted | SpeechStopped | InputCommitted | TranscriptDelta | TranscriptFinal | TranscriptFailed;
 export type ResponseEvent = ResponseStarted | ResponseAbandoned | MessageStarted | TextDelta | TextDone | AudioDelta | AudioDone | ToolCall | ResponseEnded;
 export interface SessionEvent {
     readonly sessionId: string;

package/docs/realtime.md

@@ -1,5 +1,8 @@
 # Realtime / Prism for Node.js
 
+The endpoint must use Rime's `prism.` events and `prism_` fields. Endpoints
+that use the former `prsm` names are not supported.
+
 Keep one event consumer running while your application sends input, runs tools,
 and plays audio. The SDK manages the protocol state. Your application owns
 microphone capture, tool execution, and playback.
@@ -127,6 +130,7 @@ are exported from `@rimelabs/sdk`.
 | Kind | Payload fields |
 | --- | --- |
 | `input.ready` | No data fields. Turn methods handle the readiness wait. |
+| `speech.hint` | `audioStartMs`; the user may have started speaking over a playing reply. It can be a false alarm: lower playback, do not stop it. |
 | `speech.started`, `speech.stopped` | `itemId` and `audioStartMs` or `audioEndMs` |
 | `input.committed` | `itemId` |
 | `transcript.delta`, `transcript.final` | `itemId` and `delta` or `text` |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimelabs/sdk",
-  "version": "0.1.0-alpha.14",
+  "version": "0.1.0-alpha.16",
   "description": "Rime streaming TTS, STT and Prism realtime SDK for Node.js",
   "license": "MIT",
   "type": "module",