retell-sdk 2.2.4 → 2.2.7

package/src/models/operations/createagent.ts

@@ -3,7 +3,6 @@
  */
 
 import * as components from "../../models/components";
-import { Function } from "../../models/components";
 import { z } from "zod";
 
 export type CreateAgentRequestBody = {
@@ -12,22 +11,13 @@ export type CreateAgentRequestBody = {
    */
   agentName?: string | undefined;
   /*
-   * Determines how to generate the response in the call. Currently supports using our in-house LLM response system or your own custom
-   * response generation system.
+   * The URL we will establish LLM websocket for getting response, usually your server.
    */
-  llmSetting: components.RetellLlmSetting | components.CustomLlmSetting;
-  /**
-   * Setting combination that controls interaction flow, like begin and end logic.
-   */
-  interactionSetting?: components.InteractionSettingRequest | undefined;
+  llmWebsocketUrl: string;
   /**
    * Unique voice id used for the agent. Find list of available voices in documentation.
    */
   voiceId: string;
-  /**
-   * Functions are the actions that the agent can perform, like booking appointments, retriving information, etc. By setting this field, either OpenAI's function calling feature or your own custom LLM's logic would determine when the function shall get called, and our server would make the call.
-   */
-  functions?: Function[] | undefined;
 };
 
 export type CreateAgentResponse = {
@@ -53,14 +43,8 @@ export type CreateAgentResponse = {
 export namespace CreateAgentRequestBody$ {
   export type Inbound = {
     agent_name?: string | undefined;
-    llm_setting:
-      | components.RetellLlmSetting$.Inbound
-      | components.CustomLlmSetting$.Inbound;
-    interaction_setting?:
-      | components.InteractionSettingRequest$.Inbound
-      | undefined;
+    llm_websocket_url: string;
     voice_id: string;
-    functions?: Function[] | undefined;
   };
 
   export const inboundSchema: z.ZodType<
@@ -70,37 +54,21 @@ export namespace CreateAgentRequestBody$ {
   > = z
     .object({
       agent_name: z.string().optional(),
-      llm_setting: z.union([
-        components.RetellLlmSetting$.inboundSchema,
-        components.CustomLlmSetting$.inboundSchema,
-      ]),
-      interaction_setting:
-        components.InteractionSettingRequest$.inboundSchema.optional(),
+      llm_websocket_url: z.string(),
       voice_id: z.string(),
-      functions: z.array(components.Function$.inboundSchema).optional(),
     })
     .transform((v) => {
       return {
         ...(v.agent_name === undefined ? null : { agentName: v.agent_name }),
-        llmSetting: v.llm_setting,
-        ...(v.interaction_setting === undefined
-          ? null
-          : { interactionSetting: v.interaction_setting }),
+        llmWebsocketUrl: v.llm_websocket_url,
         voiceId: v.voice_id,
-        ...(v.functions === undefined ? null : { functions: v.functions }),
       };
     });
 
   export type Outbound = {
     agent_name?: string | undefined;
-    llm_setting:
-      | components.RetellLlmSetting$.Inbound
-      | components.CustomLlmSetting$.Inbound;
-    interaction_setting?:
-      | components.InteractionSettingRequest$.Inbound
-      | undefined;
+    llm_websocket_url: string;
     voice_id: string;
-    functions?: Function[] | undefined;
   };
 
   export const outboundSchema: z.ZodType<
@@ -110,24 +78,14 @@ export namespace CreateAgentRequestBody$ {
   > = z
     .object({
       agentName: z.string().optional(),
-      llmSetting: z.union([
-        components.RetellLlmSetting$.outboundSchema,
-        components.CustomLlmSetting$.outboundSchema,
-      ]),
-      interactionSetting:
-        components.InteractionSettingRequest$.outboundSchema.optional(),
+      llmWebsocketUrl: z.string(),
       voiceId: z.string(),
-      functions: z.array(components.Function$.inboundSchema).optional(),
     })
     .transform((v) => {
       return {
         ...(v.agentName === undefined ? null : { agent_name: v.agentName }),
-        llm_setting: v.llmSetting,
-        ...(v.interactionSetting === undefined
-          ? null
-          : { interaction_setting: v.interactionSetting }),
+        llm_websocket_url: v.llmWebsocketUrl,
         voice_id: v.voiceId,
-        ...(v.functions === undefined ? null : { functions: v.functions }),
       };
     });
 }

package/src/models/operations/getcall.ts

@@ -14,7 +14,7 @@ export type GetCallRequest = {
 
 export type GetCallResponse = {
   /**
-   * Successfully retrieved an agent.
+   * Successfully retrieved a call.
    */
   callDetail?: components.CallDetail | undefined;
   /**

package/src/models/operations/index.ts

@@ -3,16 +3,10 @@
  */
 
 export * from "./createagent";
-export * from "./createphonecall";
-export * from "./createwebcall";
-export * from "./createphonenumber";
+export * from "./registercall";
 export * from "./deleteagent";
-export * from "./deletephonenumber";
 export * from "./getagent";
 export * from "./getcall";
-export * from "./getphonenumber";
 export * from "./listagents";
 export * from "./listcalls";
-export * from "./listphonenumbers";
 export * from "./updateagent";
-export * from "./updatephoneagent";

package/src/models/operations/listcalls.ts

@@ -32,10 +32,6 @@ export type FilterCriteria = {
    * Exclusive. Filter calls that start before this timestamp.
    */
   beforeStartTimestamp?: number | undefined;
-  /**
-   * Only retrieve calls of specific type(s).
-   */
-  callType?: Array<CallType> | undefined;
 };
 
 /**
@@ -72,7 +68,7 @@ export type ListCallsResponse = {
    */
   rawResponse: Response;
   /**
-   * Successfully retrieved all agents.
+   * Successfully retrieved all calls.
    */
   calls?: Array<components.CallDetail> | undefined;
 };
@@ -88,7 +84,6 @@ export namespace FilterCriteria$ {
     agent_id?: Array<string> | undefined;
     before_end_timestamp?: number | undefined;
     before_start_timestamp?: number | undefined;
-    call_type?: Array<CallType> | undefined;
   };
 
   export const inboundSchema: z.ZodType<FilterCriteria, z.ZodTypeDef, Inbound> =
@@ -99,7 +94,6 @@ export namespace FilterCriteria$ {
         agent_id: z.array(z.string()).optional(),
         before_end_timestamp: z.number().int().optional(),
         before_start_timestamp: z.number().int().optional(),
-        call_type: z.array(CallType$).optional(),
       })
       .transform((v) => {
         return {
@@ -116,7 +110,6 @@ export namespace FilterCriteria$ {
           ...(v.before_start_timestamp === undefined
             ? null
             : { beforeStartTimestamp: v.before_start_timestamp }),
-          ...(v.call_type === undefined ? null : { callType: v.call_type }),
         };
       });
 
@@ -126,7 +119,6 @@ export namespace FilterCriteria$ {
     agent_id?: Array<string> | undefined;
     before_end_timestamp?: number | undefined;
     before_start_timestamp?: number | undefined;
-    call_type?: Array<CallType> | undefined;
   };
 
   export const outboundSchema: z.ZodType<
@@ -140,7 +132,6 @@ export namespace FilterCriteria$ {
       agentId: z.array(z.string()).optional(),
       beforeEndTimestamp: z.number().int().optional(),
       beforeStartTimestamp: z.number().int().optional(),
-      callType: z.array(CallType$).optional(),
     })
     .transform((v) => {
       return {
@@ -157,7 +148,6 @@ export namespace FilterCriteria$ {
         ...(v.beforeStartTimestamp === undefined
           ? null
           : { before_start_timestamp: v.beforeStartTimestamp }),
-        ...(v.callType === undefined ? null : { call_type: v.callType }),
       };
     });
 }

package/src/models/operations/registercall.ts

@@ -0,0 +1,167 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import {
+  AudioEncoding,
+  AudioWebsocketProtocol,
+  AudioEncoding$,
+  AudioWebsocketProtocol$,
+} from "../../models/components";
+import * as components from "../../models/components";
+import { z } from "zod";
+
+export type RegisterCallRequestBody = {
+  /**
+   * Corresponding agent id of this call.
+   */
+  agentId: string;
+  /**
+   * The audio encoding of the call.
+   */
+  audioEncoding: AudioEncoding;
+  /**
+   * Sample rate of the conversation, the input and output audio bytes will all conform to this rate. Check the audio source, audio format, and voice used for the agent to select one that works.
+   */
+  sampleRate: number;
+  /**
+   * The protocol how audio websocket read and send audio bytes.
+   */
+  audioWebsocketProtocol: AudioWebsocketProtocol;
+};
+
+export type RegisterCallResponse = {
+  /**
+   * Successfully retrieved a call.
+   */
+  callDetail?: components.CallDetail | undefined;
+  /**
+   * HTTP response content type for this operation
+   */
+  contentType: string;
+  /**
+   * HTTP response status code for this operation
+   */
+  statusCode: number;
+  /**
+   * Raw HTTP response; suitable for custom response parsing
+   */
+  rawResponse: Response;
+};
+
+/** @internal */
+export namespace RegisterCallRequestBody$ {
+  export type Inbound = {
+    agent_id: string;
+    audio_encoding: AudioEncoding;
+    sample_rate: number;
+    audio_websocket_protocol: AudioWebsocketProtocol;
+  };
+
+  export const inboundSchema: z.ZodType<
+    RegisterCallRequestBody,
+    z.ZodTypeDef,
+    Inbound
+  > = z
+    .object({
+      agent_id: z.string(),
+      call_id: z.string(),
+      audio_encoding: AudioEncoding$,
+      sample_rate: z.number().int(),
+      audio_websocket_protocol: AudioWebsocketProtocol$,
+    })
+    .transform((v) => {
+      return {
+        agentId: v.agent_id,
+        audioEncoding: v.audio_encoding,
+        sampleRate: v.sample_rate,
+        audioWebsocketProtocol: v.audio_websocket_protocol,
+      };
+    });
+
+  export type Outbound = {
+    agent_id: string;
+    audio_encoding: components.AudioEncoding;
+    sample_rate: number;
+    audio_websocket_protocol: components.AudioWebsocketProtocol;
+  };
+
+  export const outboundSchema: z.ZodType<
+    Outbound,
+    z.ZodTypeDef,
+    RegisterCallRequestBody
+  > = z
+    .object({
+      agentId: z.string(),
+      audioEncoding: AudioEncoding$,
+      sampleRate: z.number().int(),
+      audioWebsocketProtocol: AudioWebsocketProtocol$,
+    })
+    .transform((v) => {
+      return {
+        agent_id: v.agentId,
+        audio_encoding: v.audioEncoding,
+        sample_rate: v.sampleRate,
+        audio_websocket_protocol: v.audioWebsocketProtocol,
+      };
+    });
+}
+
+/** @internal */
+export namespace RegisterCallResponse$ {
+  export type Inbound = {
+    CallDetail?: components.CallDetail$.Inbound | undefined;
+    ContentType: string;
+    StatusCode: number;
+    RawResponse: Response;
+  };
+
+  export const inboundSchema: z.ZodType<
+    RegisterCallResponse,
+    z.ZodTypeDef,
+    Inbound
+  > = z
+    .object({
+      CallDetail: components.CallDetail$.inboundSchema.optional(),
+      ContentType: z.string(),
+      StatusCode: z.number().int(),
+      RawResponse: z.instanceof(Response),
+    })
+    .transform((v) => {
+      return {
+        ...(v.CallDetail === undefined ? null : { callDetail: v.CallDetail }),
+        contentType: v.ContentType,
+        statusCode: v.StatusCode,
+        rawResponse: v.RawResponse,
+      };
+    });
+
+  export type Outbound = {
+    CallDetail?: components.CallDetail$.Outbound | undefined;
+    ContentType: string;
+    StatusCode: number;
+    RawResponse: never;
+  };
+
+  export const outboundSchema: z.ZodType<
+    Outbound,
+    z.ZodTypeDef,
+    RegisterCallResponse
+  > = z
+    .object({
+      callDetail: components.CallDetail$.outboundSchema.optional(),
+      contentType: z.string(),
+      statusCode: z.number().int(),
+      rawResponse: z.instanceof(Response).transform(() => {
+        throw new Error("Response cannot be serialized");
+      }),
+    })
+    .transform((v) => {
+      return {
+        ...(v.callDetail === undefined ? null : { CallDetail: v.callDetail }),
+        ContentType: v.contentType,
+        StatusCode: v.statusCode,
+        RawResponse: v.rawResponse,
+      };
+    });
+}

package/src/models/operations/updateagent.ts

@@ -3,7 +3,6 @@
  */
 
 import * as components from "../../models/components";
-import { Function } from "../../models/components";
 import { z } from "zod";
 
 export type UpdateAgentRequestBody = {
@@ -12,40 +11,21 @@ export type UpdateAgentRequestBody = {
    */
   agentName?: string | undefined;
   /*
-   * Determines how to generate the response in the call. Currently supports using our in-house LLM response system or your own custom
-   * response generation system.
+   * The URL we will establish LLM websocket for getting response, usually your server.
    */
-  llmSetting?:
-    | components.RetellLlmSetting
-    | components.CustomLlmSetting
-    | undefined;
-  /**
-   * Setting combination that controls interaction flow, like begin and end logic.
-   */
-  interactionSetting?: components.InteractionSettingRequest | undefined;
+  llmWebsocketUrl?: string | undefined;
   /**
    * Unique voice id used for the agent. Find list of available voices in documentation.
    */
   voiceId?: string | undefined;
-  /**
-   * Functions are the actions that the agent can perform, like booking appointments, retriving information, etc. By setting this field, either OpenAI's function calling feature or your own custom LLM's logic would determine when the function shall get called, and our server would make the call.
-   */
-  functions?: Function[] | undefined;
 };
 
 /** @internal */
 export namespace UpdateAgentRequestBody$ {
   export type Inbound = {
     agent_name?: string | undefined;
-    llm_setting?:
-      | components.RetellLlmSetting$.Inbound
-      | components.CustomLlmSetting$.Inbound
-      | undefined;
-    interaction_setting?:
-      | components.InteractionSettingRequest$.Inbound
-      | undefined;
+    llm_websocket_url?: string | undefined;
     voice_id?: string | undefined;
-    functions?: Function[] | undefined;
   };
 
   export const inboundSchema: z.ZodType<
@@ -55,40 +35,23 @@ export namespace UpdateAgentRequestBody$ {
   > = z
     .object({
       agent_name: z.string().optional(),
-      llm_setting: z
-        .union([
-          components.RetellLlmSetting$.inboundSchema,
-          components.CustomLlmSetting$.inboundSchema,
-        ])
-        .optional(),
-      interaction_setting:
-        components.InteractionSettingRequest$.inboundSchema.optional(),
-      voice_id: z.string().optional(),
-      functions: z.array(components.Function$.inboundSchema).optional(),
+      llm_websocket_url: z.string(),
+      voice_id: z.string(),
     })
     .transform((v) => {
       return {
         ...(v.agent_name === undefined ? null : { agentName: v.agent_name }),
-        ...(v.llm_setting === undefined ? null : { llmSetting: v.llm_setting }),
-        ...(v.interaction_setting === undefined
+        ...(v.llm_websocket_url === undefined
           ? null
-          : { interactionSetting: v.interaction_setting }),
+          : { llmWebsocketUrl: v.llm_websocket_url }),
         ...(v.voice_id === undefined ? null : { voiceId: v.voice_id }),
-        ...(v.functions === undefined ? null : { functions: v.functions }),
       };
     });
 
   export type Outbound = {
     agent_name?: string | undefined;
-    llm_setting?:
-      | components.RetellLlmSetting$.Outbound
-      | components.CustomLlmSetting$.Outbound
-      | undefined;
-    interaction_setting?:
-      | components.InteractionSettingRequest$.Outbound
-      | undefined;
+    llm_websocket_url?: string | undefined;
     voice_id?: string | undefined;
-    functions?: Function[] | undefined;
   };
 
   export const outboundSchema: z.ZodType<
@@ -98,26 +61,16 @@ export namespace UpdateAgentRequestBody$ {
   > = z
     .object({
       agentName: z.string().optional(),
-      llmSetting: z
-        .union([
-          components.RetellLlmSetting$.outboundSchema,
-          components.CustomLlmSetting$.outboundSchema,
-        ])
-        .optional(),
-      interactionSetting:
-        components.InteractionSettingRequest$.outboundSchema.optional(),
+      llmWebsocketUrl: z.string().optional(),
       voiceId: z.string().optional(),
-      functions: z.array(components.Function$.inboundSchema).optional(),
     })
     .transform((v) => {
       return {
         ...(v.agentName === undefined ? null : { agent_name: v.agentName }),
-        ...(v.llmSetting === undefined ? null : { llm_setting: v.llmSetting }),
-        ...(v.interactionSetting === undefined
+        ...(v.llmWebsocketUrl === undefined
           ? null
-          : { interaction_setting: v.interactionSetting }),
+          : { llm_websocket_url: v.llmWebsocketUrl }),
         ...(v.voiceId === undefined ? null : { voice_id: v.voiceId }),
-        ...(v.functions === undefined ? null : { functions: v.functions }),
       };
     });
 }

package/src/sdk/audioWsClient.ts

@@ -0,0 +1,68 @@
+import { EventEmitter } from "eventemitter3";
+import WebSocket from "isomorphic-ws";
+
+let baseEndpoint = "wss://api.re-tell.ai/audio-websocket/";
+
+export class AudioWsClient extends EventEmitter {
+  private ws: WebSocket;
+
+  constructor(callId: string, customEndpoint?: string) {
+    super();
+
+    if (customEndpoint) baseEndpoint = customEndpoint;
+    const endpoint = baseEndpoint + callId;
+    this.ws = new WebSocket(endpoint);
+    this.ws.binaryType = "arraybuffer";
+
+    this.ws.onmessage = (event) => {
+      const eventStr = event.data.toString();
+      if (eventStr === "clear") {
+        this.emit("clear");
+      } else {
+        const audio: ArrayBuffer = event.data as ArrayBuffer;
+        this.emit("audio", new Uint8Array(audio));
+      }
+    };
+    this.ws.onclose = (event) => {
+      this.emit("close", event.code, event.reason);
+    };
+    this.ws.onerror = (event) => {
+      this.emit("error", event.error);
+    };
+  }
+
+  send(audio: Uint8Array) {
+    if (this.ws.readyState === 1) {
+      this.ws.send(audio);
+    }
+  }
+
+  close() {
+    this.ws.close();
+  }
+}
+
+export function convertUint8ToFloat32(array: Uint8Array): Float32Array {
+  const targetArray = new Float32Array(array.byteLength / 2);
+
+  // A DataView is used to read our 16-bit little-endian samples out of the Uint8Array buffer
+  const sourceDataView = new DataView(array.buffer);
+
+  // Loop through, get values, and divide by 32,768
+  for (let i = 0; i < targetArray.length; i++) {
+    targetArray[i] = sourceDataView.getInt16(i * 2, true) / Math.pow(2, 16 - 1);
+  }
+  return targetArray;
+}
+
+export function convertFloat32ToUint8(array: Float32Array): Uint8Array {
+  const buffer = new ArrayBuffer(array.length * 2);
+  const view = new DataView(buffer);
+
+  for (let i = 0; i < array.length; i++) {
+    const value = (array[i] as number) * 32768;
+    view.setInt16(i * 2, value, true); // true for little-endian
+  }
+
+  return new Uint8Array(buffer);
+}

package/src/sdk/index.ts

@@ -3,4 +3,4 @@
  */
 
 export * from "./sdk";
-export * from "./liveClient";
+export * from "./audioWsClient";