retell-sdk 4.24.0 → 4.26.0

package/src/resources/llm.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
 import * as Core from '../core';
 
 export class Llm extends APIResource {
@@ -15,15 +16,37 @@ export class Llm extends APIResource {
   /**
    * Retrieve details of a specific Retell LLM Response Engine
    */
-  retrieve(llmId: string, options?: Core.RequestOptions): Core.APIPromise<LlmResponse> {
-    return this._client.get(`/get-retell-llm/${llmId}`, options);
+  retrieve(
+    llmId: string,
+    query?: LlmRetrieveParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<LlmResponse>;
+  retrieve(llmId: string, options?: Core.RequestOptions): Core.APIPromise<LlmResponse>;
+  retrieve(
+    llmId: string,
+    query: LlmRetrieveParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<LlmResponse> {
+    if (isRequestOptions(query)) {
+      return this.retrieve(llmId, {}, query);
+    }
+    return this._client.get(`/get-retell-llm/${llmId}`, { query, ...options });
   }
 
   /**
    * Update an existing Retell LLM Response Engine
    */
-  update(llmId: string, body: LlmUpdateParams, options?: Core.RequestOptions): Core.APIPromise<LlmResponse> {
-    return this._client.patch(`/update-retell-llm/${llmId}`, { body, ...options });
+  update(
+    llmId: string,
+    params: LlmUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<LlmResponse> {
+    const { query_version, ...body } = params;
+    return this._client.patch(`/update-retell-llm/${llmId}`, {
+      query: { version: query_version },
+      body,
+      ...options,
+    });
   }
 
   /**
@@ -105,7 +128,14 @@ export interface LlmResponse {
   /**
    * Select the underlying text LLM. If not set, would default to gpt-4o.
    */
-  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.7-sonnet' | 'claude-3.5-haiku' | null;
+  model?:
+    | 'gpt-4o'
+    | 'gpt-4o-mini'
+    | 'claude-3.7-sonnet'
+    | 'claude-3.5-haiku'
+    | 'gemini-2.0-flash'
+    | 'gemini-2.0-flash-lite'
+    | null;
 
   /**
    * If set to true, will use high priority pool with more dedicated resource to
@@ -149,6 +179,11 @@ export interface LlmResponse {
    * processing is needed. Default to false.
    */
   tool_call_strict_mode?: boolean;
+
+  /**
+   * Version of the Retell LLM.
+   */
+  version?: number | null;
 }
 
 export namespace LlmResponse {
@@ -177,6 +212,10 @@ export namespace LlmResponse {
      */
     name: string;
 
+    transfer_destination:
+      | TransferCallTool.TransferDestinationPredefined
+      | TransferCallTool.TransferDestinationInferred;
+
     type: 'transfer_call';
 
     /**
@@ -185,12 +224,6 @@ export namespace LlmResponse {
      */
     description?: string;
 
-    /**
-     * The number to transfer to in E.164 format or a dynamic variable like
-     * {{transfer_number}}.
-     */
-    number?: string | null;
-
     /**
      * If set to true, will show transferee (the user, not the AI agent) as caller when
      * transferring, requires the telephony side to support SIP REFER to PSTN. This is
@@ -199,10 +232,6 @@ export namespace LlmResponse {
      */
     show_transferee_as_caller?: boolean | null;
 
-    transfer_destination?:
-      | TransferCallTool.TransferDestinationPredefined
-      | TransferCallTool.TransferDestinationInferred;
-
     /**
      * If set, when transfer is successful, will perform a warm handoff. Can leave
      * either a static message or a dynamic one based on prompt. Set to null to disable
@@ -571,6 +600,10 @@ export namespace LlmResponse {
        */
       name: string;
 
+      transfer_destination:
+        | TransferCallTool.TransferDestinationPredefined
+        | TransferCallTool.TransferDestinationInferred;
+
       type: 'transfer_call';
 
       /**
@@ -579,12 +612,6 @@ export namespace LlmResponse {
        */
       description?: string;
 
-      /**
-       * The number to transfer to in E.164 format or a dynamic variable like
-       * {{transfer_number}}.
-       */
-      number?: string | null;
-
       /**
        * If set to true, will show transferee (the user, not the AI agent) as caller when
        * transferring, requires the telephony side to support SIP REFER to PSTN. This is
@@ -593,10 +620,6 @@ export namespace LlmResponse {
        */
       show_transferee_as_caller?: boolean | null;
 
-      transfer_destination?:
-        | TransferCallTool.TransferDestinationPredefined
-        | TransferCallTool.TransferDestinationInferred;
-
       /**
        * If set, when transfer is successful, will perform a warm handoff. Can leave
        * either a static message or a dynamic one based on prompt. Set to null to disable
@@ -899,7 +922,14 @@ export interface LlmCreateParams {
   /**
    * Select the underlying text LLM. If not set, would default to gpt-4o.
    */
-  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.7-sonnet' | 'claude-3.5-haiku' | null;
+  model?:
+    | 'gpt-4o'
+    | 'gpt-4o-mini'
+    | 'claude-3.7-sonnet'
+    | 'claude-3.5-haiku'
+    | 'gemini-2.0-flash'
+    | 'gemini-2.0-flash-lite'
+    | null;
 
   /**
    * If set to true, will use high priority pool with more dedicated resource to
@@ -943,6 +973,11 @@ export interface LlmCreateParams {
    * processing is needed. Default to false.
    */
   tool_call_strict_mode?: boolean;
+
+  /**
+   * Version of the Retell LLM.
+   */
+  version?: number | null;
 }
 
 export namespace LlmCreateParams {
@@ -971,6 +1006,10 @@ export namespace LlmCreateParams {
      */
     name: string;
 
+    transfer_destination:
+      | TransferCallTool.TransferDestinationPredefined
+      | TransferCallTool.TransferDestinationInferred;
+
     type: 'transfer_call';
 
     /**
@@ -979,12 +1018,6 @@ export namespace LlmCreateParams {
      */
     description?: string;
 
-    /**
-     * The number to transfer to in E.164 format or a dynamic variable like
-     * {{transfer_number}}.
-     */
-    number?: string | null;
-
     /**
      * If set to true, will show transferee (the user, not the AI agent) as caller when
      * transferring, requires the telephony side to support SIP REFER to PSTN. This is
@@ -993,10 +1026,6 @@ export namespace LlmCreateParams {
      */
     show_transferee_as_caller?: boolean | null;
 
-    transfer_destination?:
-      | TransferCallTool.TransferDestinationPredefined
-      | TransferCallTool.TransferDestinationInferred;
-
     /**
      * If set, when transfer is successful, will perform a warm handoff. Can leave
      * either a static message or a dynamic one based on prompt. Set to null to disable
@@ -1365,6 +1394,10 @@ export namespace LlmCreateParams {
        */
       name: string;
 
+      transfer_destination:
+        | TransferCallTool.TransferDestinationPredefined
+        | TransferCallTool.TransferDestinationInferred;
+
       type: 'transfer_call';
 
       /**
@@ -1373,12 +1406,6 @@ export namespace LlmCreateParams {
        */
       description?: string;
 
-      /**
-       * The number to transfer to in E.164 format or a dynamic variable like
-       * {{transfer_number}}.
-       */
-      number?: string | null;
-
       /**
        * If set to true, will show transferee (the user, not the AI agent) as caller when
        * transferring, requires the telephony side to support SIP REFER to PSTN. This is
@@ -1387,10 +1414,6 @@ export namespace LlmCreateParams {
        */
       show_transferee_as_caller?: boolean | null;
 
-      transfer_destination?:
-        | TransferCallTool.TransferDestinationPredefined
-        | TransferCallTool.TransferDestinationInferred;
-
       /**
        * If set, when transfer is successful, will perform a warm handoff. Can leave
        * either a static message or a dynamic one based on prompt. Set to null to disable
@@ -1641,22 +1664,36 @@ export namespace LlmCreateParams {
   }
 }
 
+export interface LlmRetrieveParams {
+  /**
+   * Optional version of the API to use for this request. Default to 0.
+   */
+  version?: number;
+}
+
 export interface LlmUpdateParams {
   /**
-   * First utterance said by the agent in the call. If not set, LLM will dynamically
-   * generate a message. If set to "", agent will wait for user to speak first.
+   * Query param: Optional version of the API to use for this request. Default to 0.
+   */
+  query_version?: number;
+
+  /**
+   * Body param: First utterance said by the agent in the call. If not set, LLM will
+   * dynamically generate a message. If set to "", agent will wait for user to speak
+   * first.
    */
   begin_message?: string | null;
 
   /**
-   * Default dynamic variables represented as key-value pairs of strings. These are
-   * injected into your Retell LLM prompt and tool description when specific values
-   * are not provided in a request. Only applicable for Retell LLM.
+   * Body param: Default dynamic variables represented as key-value pairs of strings.
+   * These are injected into your Retell LLM prompt and tool description when
+   * specific values are not provided in a request. Only applicable for Retell LLM.
    */
   default_dynamic_variables?: Record<string, string> | null;
 
   /**
-   * General prompt appended to system prompt no matter what state the agent is in.
+   * Body param: General prompt appended to system prompt no matter what state the
+   * agent is in.
    *
    * - System prompt (with state) = general prompt + state prompt.
    *
@@ -1665,9 +1702,10 @@ export interface LlmUpdateParams {
   general_prompt?: string | null;
 
   /**
-   * A list of tools the model may call (to get external knowledge, call API, etc).
-   * You can select from some common predefined tools like end call, transfer call,
-   * etc; or you can create your own custom tool (last option) for the LLM to use.
+   * Body param: A list of tools the model may call (to get external knowledge, call
+   * API, etc). You can select from some common predefined tools like end call,
+   * transfer call, etc; or you can create your own custom tool (last option) for the
+   * LLM to use.
    *
    * - Tools of LLM (with state) = general tools + state tools + state transitions
    *
@@ -1683,58 +1721,70 @@ export interface LlmUpdateParams {
   > | null;
 
   /**
-   * A list of knowledge base ids to use for this resource. Set to null to remove all
-   * knowledge bases.
+   * Body param: A list of knowledge base ids to use for this resource. Set to null
+   * to remove all knowledge bases.
    */
   knowledge_base_ids?: Array<string> | null;
 
   /**
-   * Select the underlying text LLM. If not set, would default to gpt-4o.
+   * Body param: Select the underlying text LLM. If not set, would default to gpt-4o.
    */
-  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.7-sonnet' | 'claude-3.5-haiku' | null;
+  model?:
+    | 'gpt-4o'
+    | 'gpt-4o-mini'
+    | 'claude-3.7-sonnet'
+    | 'claude-3.5-haiku'
+    | 'gemini-2.0-flash'
+    | 'gemini-2.0-flash-lite'
+    | null;
 
   /**
-   * If set to true, will use high priority pool with more dedicated resource to
-   * ensure lower and more consistent latency, default to false. This feature usually
-   * comes with a higher cost.
+   * Body param: If set to true, will use high priority pool with more dedicated
+   * resource to ensure lower and more consistent latency, default to false. This
+   * feature usually comes with a higher cost.
    */
   model_high_priority?: boolean;
 
   /**
-   * If set, will control the randomness of the response. Value ranging from [0,1].
-   * Lower value means more deterministic, while higher value means more random. If
-   * unset, default value 0 will apply. Note that for tool calling, a lower value is
-   * recommended.
+   * Body param: If set, will control the randomness of the response. Value ranging
+   * from [0,1]. Lower value means more deterministic, while higher value means more
+   * random. If unset, default value 0 will apply. Note that for tool calling, a
+   * lower value is recommended.
    */
   model_temperature?: number;
 
   /**
-   * Select the underlying speech to speech model. Can only set this or model, not
-   * both.
+   * Body param: Select the underlying speech to speech model. Can only set this or
+   * model, not both.
    */
   s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | null;
 
   /**
-   * Name of the starting state. Required if states is not empty.
+   * Body param: Name of the starting state. Required if states is not empty.
    */
   starting_state?: string | null;
 
   /**
-   * States of the LLM. This is to help reduce prompt length and tool choices when
-   * the call can be broken into distinct states. With shorter prompts and less
-   * tools, the LLM can better focus and follow the rules, minimizing hallucination.
-   * If this field is not set, the agent would only have general prompt and general
-   * tools (essentially one state).
+   * Body param: States of the LLM. This is to help reduce prompt length and tool
+   * choices when the call can be broken into distinct states. With shorter prompts
+   * and less tools, the LLM can better focus and follow the rules, minimizing
+   * hallucination. If this field is not set, the agent would only have general
+   * prompt and general tools (essentially one state).
    */
   states?: Array<LlmUpdateParams.State> | null;
 
   /**
-   * Only applicable when model is gpt-4o or gpt-4o mini. If set to true, will use
-   * structured output to make sure tool call arguments follow the json schema. The
-   * time to save a new tool or change to a tool will be longer as additional
-   * processing is needed. Default to false.
+   * Body param: Only applicable when model is gpt-4o or gpt-4o mini. If set to true,
+   * will use structured output to make sure tool call arguments follow the json
+   * schema. The time to save a new tool or change to a tool will be longer as
+   * additional processing is needed. Default to false.
    */
   tool_call_strict_mode?: boolean;
+
+  /**
+   * Body param: Version of the Retell LLM.
+   */
+  body_version?: number | null;
 }
 
 export namespace LlmUpdateParams {
@@ -1763,6 +1813,10 @@ export namespace LlmUpdateParams {
      */
     name: string;
 
+    transfer_destination:
+      | TransferCallTool.TransferDestinationPredefined
+      | TransferCallTool.TransferDestinationInferred;
+
     type: 'transfer_call';
 
     /**
@@ -1771,12 +1825,6 @@ export namespace LlmUpdateParams {
      */
     description?: string;
 
-    /**
-     * The number to transfer to in E.164 format or a dynamic variable like
-     * {{transfer_number}}.
-     */
-    number?: string | null;
-
     /**
      * If set to true, will show transferee (the user, not the AI agent) as caller when
      * transferring, requires the telephony side to support SIP REFER to PSTN. This is
@@ -1785,10 +1833,6 @@ export namespace LlmUpdateParams {
      */
     show_transferee_as_caller?: boolean | null;
 
-    transfer_destination?:
-      | TransferCallTool.TransferDestinationPredefined
-      | TransferCallTool.TransferDestinationInferred;
-
     /**
      * If set, when transfer is successful, will perform a warm handoff. Can leave
      * either a static message or a dynamic one based on prompt. Set to null to disable
@@ -2157,6 +2201,10 @@ export namespace LlmUpdateParams {
        */
       name: string;
 
+      transfer_destination:
+        | TransferCallTool.TransferDestinationPredefined
+        | TransferCallTool.TransferDestinationInferred;
+
       type: 'transfer_call';
 
       /**
@@ -2165,12 +2213,6 @@ export namespace LlmUpdateParams {
        */
       description?: string;
 
-      /**
-       * The number to transfer to in E.164 format or a dynamic variable like
-       * {{transfer_number}}.
-       */
-      number?: string | null;
-
       /**
        * If set to true, will show transferee (the user, not the AI agent) as caller when
        * transferring, requires the telephony side to support SIP REFER to PSTN. This is
@@ -2179,10 +2221,6 @@ export namespace LlmUpdateParams {
        */
       show_transferee_as_caller?: boolean | null;
 
-      transfer_destination?:
-        | TransferCallTool.TransferDestinationPredefined
-        | TransferCallTool.TransferDestinationInferred;
-
       /**
        * If set, when transfer is successful, will perform a warm handoff. Can leave
        * either a static message or a dynamic one based on prompt. Set to null to disable
@@ -2438,6 +2476,7 @@ export declare namespace Llm {
     type LlmResponse as LlmResponse,
     type LlmListResponse as LlmListResponse,
     type LlmCreateParams as LlmCreateParams,
+    type LlmRetrieveParams as LlmRetrieveParams,
     type LlmUpdateParams as LlmUpdateParams,
   };
 }

package/src/resources/phone-number.ts

@@ -80,6 +80,11 @@ export interface PhoneNumberResponse {
    */
   inbound_agent_id?: string | null;
 
+  /**
+   * The version of the inbound agent.
+   */
+  inbound_agent_version?: number | null;
+
   /**
    * If set, will send a webhook for inbound calls, where you can to override agent
    * id, set dynamic variables and other fields specific to that call.
@@ -98,6 +103,11 @@ export interface PhoneNumberResponse {
    */
   outbound_agent_id?: string | null;
 
+  /**
+   * The version of the outbound agent.
+   */
+  outbound_agent_version?: number | null;
+
   /**
    * Pretty printed phone number, provided for your reference.
    */
@@ -125,6 +135,12 @@ export interface PhoneNumberCreateParams {
    */
   inbound_agent_id?: string | null;
 
+  /**
+   * Version of the inbound agent to bind to the number. If not provided, will
+   * default to 0.
+   */
+  inbound_agent_version?: number | null;
+
   /**
    * If set, will send a webhook for inbound calls, where you can to override agent
    * id, set dynamic variables and other fields specific to that call.
@@ -147,6 +163,12 @@ export interface PhoneNumberCreateParams {
    * initiate outbound call without agent id override.
    */
   outbound_agent_id?: string | null;
+
+  /**
+   * Version of the outbound agent to bind to the number. If not provided, will
+   * default to 0.
+   */
+  outbound_agent_version?: number | null;
 }
 
 export interface PhoneNumberUpdateParams {
@@ -157,6 +179,12 @@ export interface PhoneNumberUpdateParams {
    */
   inbound_agent_id?: string | null;
 
+  /**
+   * Version of the inbound agent to bind to the number. If not provided, will
+   * default to 0.
+   */
+  inbound_agent_version?: number | null;
+
   /**
    * If set, will send a webhook for inbound calls, where you can to override agent
    * id, set dynamic variables and other fields specific to that call.
@@ -174,6 +202,12 @@ export interface PhoneNumberUpdateParams {
    * able to initiate outbound call without agent id override.
    */
   outbound_agent_id?: string | null;
+
+  /**
+   * Version of the outbound agent to bind to the number. If not provided, will
+   * default to 0.
+   */
+  outbound_agent_version?: number | null;
 }
 
 export interface PhoneNumberImportParams {
@@ -198,6 +232,12 @@ export interface PhoneNumberImportParams {
    */
   inbound_agent_id?: string | null;
 
+  /**
+   * Version of the inbound agent to bind to the number. If not provided, will
+   * default to 0.
+   */
+  inbound_agent_version?: number | null;
+
   /**
    * If set, will send a webhook for inbound calls, where you can to override agent
    * id, set dynamic variables and other fields specific to that call.
@@ -214,7 +254,13 @@ export interface PhoneNumberImportParams {
    * agent when conducting outbound calls. If null, this number would not be able to
    * initiate outbound call without agent id override.
    */
-  outbound_agent_id?: string | null;
+  outbound_agent_id?: string;
+
+  /**
+   * Version of the outbound agent to bind to the number. If not provided, will
+   * default to 0.
+   */
+  outbound_agent_version?: number | null;
 
   /**
    * The password used for authentication for the SIP trunk.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.24.0'; // x-release-please-version
+export const VERSION = '4.26.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.24.0";
+export declare const VERSION = "4.26.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.24.0'; // x-release-please-version
+exports.VERSION = '4.26.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.24.0'; // x-release-please-version
+export const VERSION = '4.26.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map