phonic 0.10.0 → 0.12.0

package/README.md

@@ -7,6 +7,8 @@ Node.js library for the Phonic API.
 - [Usage](#usage)
   - [Get voices](#get-voices)
   - [Get voice by id](#get-voice-by-id)
+  - [Get conversation by id](#get-conversation-by-id)
+  - [Get conversation by external id](#get-conversation-by-external-id)
   - [Speech-to-speech via WebSocket](#speech-to-speech-via-websocket)
 
 ## Installation
@@ -38,7 +40,7 @@ if (error === null) {
 ```
 
 
-### Get voice by ID
+### Get voice by id
 
 ```ts
 const { data, error } = await phonic.voices.get("meredith");
@@ -48,6 +50,26 @@ if (error === null) {
 }
 ```
 
+### Get conversation by id
+
+```ts
+const { data, error } = await phonic.conversations.get("conv_b1804883-5be4-42fe-b1cf-aa84450d5c84");
+
+if (error === null) {
+  console.log(data.conversation);
+}
+```
+
+### Get conversation by external id
+
+```ts
+const { data, error } = await phonic.conversations.getByExternalId("CAdb9c032c809fec7feb932ea4c96d71e1");
+
+if (error === null) {
+  console.log(data.conversation);
+}
+```
+
 ### Speech-to-speech via WebSocket
 
 To start a conversation, open a WebSocket connection:
@@ -104,10 +126,20 @@ phonicWebSocket.onMessage((message) => {
   }
 });
 ```
+
 Update the system prompt mid-conversation:
+
 ```ts
 phonicWebSocket.updateSystemPrompt({
-  systemPrompt = "..."
+  systemPrompt: "..."
+})
+```
+
+Set an external id for the conversation (can be the Twilio Call SID, for example):
+
+```ts
+phonicWebSocket.setExternalId({
+  externalId: "..."
 })
 ```
 

package/dist/index.d.mts

@@ -20,6 +20,47 @@ type DataOrError<T> = Promise<{
     error: ErrorResponse;
 }>;
 
+type ISODateTime = `${string}Z`;
+type ConversationItem = {
+    role: "user";
+    item_idx: number;
+    text: string;
+    duration_ms: number;
+    started_at: string;
+} | {
+    role: "assistant";
+    item_idx: number;
+    text: string;
+    voice_id: string;
+    system_prompt: string;
+    output_audio_speed: number;
+    duration_ms: number;
+    started_at: string;
+};
+type Conversation = {
+    id: string;
+    external_id: string | null;
+    model: string;
+    welcome_message: string | null;
+    input_format: "pcm_44100" | "mulaw_8000";
+    output_format: "pcm_44100" | "mulaw_8000";
+    text: string;
+    duration_ms: number;
+    started_at: ISODateTime;
+    ended_at: ISODateTime;
+    items: Array<ConversationItem>;
+};
+type ConversationSuccessResponse = {
+    conversation: Conversation;
+};
+
+declare class Conversations {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    get(id: string): DataOrError<ConversationSuccessResponse>;
+    getByExternalId(externalId: string): DataOrError<ConversationSuccessResponse>;
+}
+
 type PhonicSTSConfig = {
     input_format: "pcm_44100" | "mulaw_8000";
     system_prompt?: string;
@@ -66,12 +107,15 @@ declare class PhonicSTSWebSocket {
     onMessage(callback: OnMessageCallback): void;
     onClose(callback: OnCloseCallback): void;
     onError(callback: OnErrorCallback): void;
-    audioChunk(message: {
+    audioChunk({ audio }: {
         audio: string;
     }): void;
-    updateSystemPrompt(message: {
+    updateSystemPrompt({ systemPrompt }: {
         systemPrompt: string;
     }): void;
+    setExternalId({ externalId }: {
+        externalId: string;
+    }): void;
     close(code?: number): void;
 }
 
@@ -109,6 +153,7 @@ declare class Phonic {
     readonly baseUrl: string;
     readonly __downstreamWebSocketUrl: string | null;
     readonly headers: Record<string, string>;
+    readonly conversations: Conversations;
     readonly voices: Voices;
     readonly sts: SpeechToSpeech;
     constructor(apiKey: string, config?: PhonicConfig);

package/dist/index.d.ts

@@ -20,6 +20,47 @@ type DataOrError<T> = Promise<{
     error: ErrorResponse;
 }>;
 
+type ISODateTime = `${string}Z`;
+type ConversationItem = {
+    role: "user";
+    item_idx: number;
+    text: string;
+    duration_ms: number;
+    started_at: string;
+} | {
+    role: "assistant";
+    item_idx: number;
+    text: string;
+    voice_id: string;
+    system_prompt: string;
+    output_audio_speed: number;
+    duration_ms: number;
+    started_at: string;
+};
+type Conversation = {
+    id: string;
+    external_id: string | null;
+    model: string;
+    welcome_message: string | null;
+    input_format: "pcm_44100" | "mulaw_8000";
+    output_format: "pcm_44100" | "mulaw_8000";
+    text: string;
+    duration_ms: number;
+    started_at: ISODateTime;
+    ended_at: ISODateTime;
+    items: Array<ConversationItem>;
+};
+type ConversationSuccessResponse = {
+    conversation: Conversation;
+};
+
+declare class Conversations {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    get(id: string): DataOrError<ConversationSuccessResponse>;
+    getByExternalId(externalId: string): DataOrError<ConversationSuccessResponse>;
+}
+
 type PhonicSTSConfig = {
     input_format: "pcm_44100" | "mulaw_8000";
     system_prompt?: string;
@@ -66,12 +107,15 @@ declare class PhonicSTSWebSocket {
     onMessage(callback: OnMessageCallback): void;
     onClose(callback: OnCloseCallback): void;
     onError(callback: OnErrorCallback): void;
-    audioChunk(message: {
+    audioChunk({ audio }: {
         audio: string;
     }): void;
-    updateSystemPrompt(message: {
+    updateSystemPrompt({ systemPrompt }: {
         systemPrompt: string;
     }): void;
+    setExternalId({ externalId }: {
+        externalId: string;
+    }): void;
     close(code?: number): void;
 }
 
@@ -109,6 +153,7 @@ declare class Phonic {
     readonly baseUrl: string;
     readonly __downstreamWebSocketUrl: string | null;
     readonly headers: Record<string, string>;
+    readonly conversations: Conversations;
     readonly voices: Voices;
     readonly sts: SpeechToSpeech;
     constructor(apiKey: string, config?: PhonicConfig);

package/dist/index.js

@@ -35,7 +35,26 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // package.json
-var version = "0.10.0";
+var version = "0.12.0";
+
+// src/conversations/index.ts
+var Conversations = class {
+  constructor(phonic) {
+    this.phonic = phonic;
+  }
+  async get(id) {
+    const response = await this.phonic.get(
+      `/conversations/${id}`
+    );
+    return response;
+  }
+  async getByExternalId(externalId) {
+    const response = await this.phonic.get(
+      `/conversations?external_id=${externalId}`
+    );
+    return response;
+  }
+};
 
 // src/sts/index.ts
 var import_ws = __toESM(require("ws"));
@@ -86,19 +105,27 @@ var PhonicSTSWebSocket = class {
   onError(callback) {
     this.onErrorCallback = callback;
   }
-  audioChunk(message) {
+  audioChunk({ audio }) {
     this.ws.send(
       JSON.stringify({
         type: "audio_chunk",
-        ...message
+        audio
       })
     );
   }
-  updateSystemPrompt(message) {
+  updateSystemPrompt({ systemPrompt }) {
     this.ws.send(
       JSON.stringify({
         type: "update_system_prompt",
-        system_prompt: message.systemPrompt
+        system_prompt: systemPrompt
+      })
+    );
+  }
+  setExternalId({ externalId }) {
+    this.ws.send(
+      JSON.stringify({
+        type: "set_external_id",
+        external_id: externalId
       })
     );
   }
@@ -248,6 +275,7 @@ var Phonic = class {
   baseUrl;
   __downstreamWebSocketUrl;
   headers;
+  conversations = new Conversations(this);
   voices = new Voices(this);
   sts = new SpeechToSpeech(this);
   async fetchRequest(path, options) {

package/dist/index.mjs

@@ -1,5 +1,24 @@
 // package.json
-var version = "0.10.0";
+var version = "0.12.0";
+
+// src/conversations/index.ts
+var Conversations = class {
+  constructor(phonic) {
+    this.phonic = phonic;
+  }
+  async get(id) {
+    const response = await this.phonic.get(
+      `/conversations/${id}`
+    );
+    return response;
+  }
+  async getByExternalId(externalId) {
+    const response = await this.phonic.get(
+      `/conversations?external_id=${externalId}`
+    );
+    return response;
+  }
+};
 
 // src/sts/index.ts
 import WebSocket from "ws";
@@ -50,19 +69,27 @@ var PhonicSTSWebSocket = class {
   onError(callback) {
     this.onErrorCallback = callback;
   }
-  audioChunk(message) {
+  audioChunk({ audio }) {
     this.ws.send(
       JSON.stringify({
         type: "audio_chunk",
-        ...message
+        audio
       })
     );
   }
-  updateSystemPrompt(message) {
+  updateSystemPrompt({ systemPrompt }) {
     this.ws.send(
       JSON.stringify({
         type: "update_system_prompt",
-        system_prompt: message.systemPrompt
+        system_prompt: systemPrompt
+      })
+    );
+  }
+  setExternalId({ externalId }) {
+    this.ws.send(
+      JSON.stringify({
+        type: "set_external_id",
+        external_id: externalId
       })
     );
   }
@@ -212,6 +239,7 @@ var Phonic = class {
   baseUrl;
   __downstreamWebSocketUrl;
   headers;
+  conversations = new Conversations(this);
   voices = new Voices(this);
   sts = new SpeechToSpeech(this);
   async fetchRequest(path, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "phonic",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "Phonic Node.js SDK",
   "scripts": {
     "build": "tsup",