retell-sdk 5.13.0 → 5.14.0

package/resources/playground.d.mts

@@ -0,0 +1,395 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Playground extends APIResource {
+    /**
+     * Stateless playground completion. Send the full conversation history (same shape
+     * as chat completion messages) and receive only the newly generated messages.
+     * Nothing is persisted server-side — the caller manages conversation state.
+     */
+    completion(agentID: string, params: PlaygroundCompletionParams, options?: RequestOptions): APIPromise<PlaygroundCompletionResponse>;
+}
+export interface PlaygroundCompletionResponse {
+    /**
+     * New messages generated by the agent. Same shape as chat completion response
+     * messages. Does not include the input messages.
+     */
+    messages: Array<PlaygroundCompletionResponse.MessageBase | PlaygroundCompletionResponse.ToolCallInvocationMessageBase | PlaygroundCompletionResponse.ToolCallResultMessageBase | PlaygroundCompletionResponse.NodeTransitionMessageBase | PlaygroundCompletionResponse.StateTransitionMessageBase>;
+    /**
+     * Whether the agent ended the conversation.
+     */
+    call_ended?: boolean;
+    /**
+     * Current node id (conversation-flow agents).
+     */
+    current_node_id?: string;
+    /**
+     * Current state name (retell-llm agents).
+     */
+    current_state?: string;
+    /**
+     * Updated dynamic variables after this turn.
+     */
+    dynamic_variables?: {
+        [key: string]: string;
+    };
+    /**
+     * Knowledge base chunks retrieved for this turn.
+     */
+    knowledge_base_retrieved_contents?: Array<string>;
+}
+export declare namespace PlaygroundCompletionResponse {
+    interface MessageBase {
+        /**
+         * Content of the message
+         */
+        content: string;
+        /**
+         * Documents whether this message is sent by agent or user.
+         */
+        role: 'agent' | 'user';
+        /**
+         * Create timestamp of the message
+         */
+        created_timestamp?: number;
+        /**
+         * Unique id of the message
+         */
+        message_id?: string;
+    }
+    interface ToolCallInvocationMessageBase {
+        /**
+         * Arguments for this tool call, it's a stringified JSON object.
+         */
+        arguments: string;
+        /**
+         * Name of the function in this tool call.
+         */
+        name: string;
+        /**
+         * This is a tool call invocation.
+         */
+        role: 'tool_call_invocation';
+        /**
+         * Tool call id, globally unique.
+         */
+        tool_call_id: string;
+        /**
+         * Create timestamp of the message
+         */
+        created_timestamp?: number;
+        /**
+         * Unique id of the message
+         */
+        message_id?: string;
+        /**
+         * Optional thought signature from Google Gemini thinking models. This is used
+         * internally to maintain reasoning chain in multi-turn function calling.
+         */
+        thought_signature?: string;
+    }
+    interface ToolCallResultMessageBase {
+        /**
+         * Result of the tool call, can be a string, a stringified json, etc.
+         */
+        content: string;
+        /**
+         * This is the result of a tool call.
+         */
+        role: 'tool_call_result';
+        /**
+         * Tool call id, globally unique.
+         */
+        tool_call_id: string;
+        /**
+         * Create timestamp of the message
+         */
+        created_timestamp?: number;
+        /**
+         * Unique id of the message
+         */
+        message_id?: string;
+        /**
+         * Whether the tool call was successful.
+         */
+        successful?: boolean;
+    }
+    interface NodeTransitionMessageBase {
+        /**
+         * This is a node transition.
+         */
+        role: 'node_transition';
+        /**
+         * Create timestamp of the message
+         */
+        created_timestamp?: number;
+        /**
+         * Former node id
+         */
+        former_node_id?: string;
+        /**
+         * Former node name
+         */
+        former_node_name?: string;
+        /**
+         * Unique id of the message
+         */
+        message_id?: string;
+        /**
+         * New node id
+         */
+        new_node_id?: string;
+        /**
+         * New node name
+         */
+        new_node_name?: string;
+        /**
+         * How this node was reached. "global" means a global node transition,
+         * "global_go_back" means returning from a global node, "interrupt_go_back" means
+         * going back due to user interruption, and "normal" means a regular edge
+         * transition.
+         */
+        transition_type?: 'global' | 'global_go_back' | 'interrupt_go_back' | 'normal';
+    }
+    interface StateTransitionMessageBase {
+        /**
+         * This is a state transition.
+         */
+        role: 'state_transition';
+        /**
+         * Create timestamp of the message
+         */
+        created_timestamp?: number;
+        /**
+         * Former state name
+         */
+        former_state_name?: string;
+        /**
+         * Unique id of the message
+         */
+        message_id?: string;
+        /**
+         * New state name
+         */
+        new_state_name?: string;
+    }
+}
+export interface PlaygroundCompletionParams {
+    /**
+     * Body param: Full conversation history, same shape as chat completion messages.
+     * message_id and created_timestamp are optional — server generates them if
+     * omitted.
+     */
+    messages: Array<PlaygroundCompletionParams.MessageBase | PlaygroundCompletionParams.ToolCallInvocationMessageBase | PlaygroundCompletionParams.ToolCallResultMessageBase | PlaygroundCompletionParams.NodeTransitionMessageBase | PlaygroundCompletionParams.StateTransitionMessageBase>;
+    /**
+     * Query param: Agent version to use. Defaults to latest.
+     */
+    version?: number;
+    /**
+     * Body param: Conversation flow component id. Required when current_node_id refers
+     * to a node within a component.
+     */
+    component_id?: string;
+    /**
+     * Body param: Current node id for conversation-flow agents. Used to resume from a
+     * specific node. Must be provided together with component_id when testing
+     * components.
+     */
+    current_node_id?: string;
+    /**
+     * Body param: Current state name for retell-llm agents. Used to resume from a
+     * specific state.
+     */
+    current_state?: string;
+    /**
+     * Body param: Key-value pairs for dynamic variable substitution.
+     */
+    dynamic_variables?: {
+        [key: string]: string;
+    };
+    /**
+     * Body param: Optional mock responses for tools. When provided, the agent uses
+     * these instead of executing real tool calls.
+     */
+    tool_mocks?: Array<PlaygroundCompletionParams.ToolMock>;
+}
+export declare namespace PlaygroundCompletionParams {
+    interface MessageBase {
+        /**
+         * Content of the message
+         */
+        content: string;
+        /**
+         * Documents whether this message is sent by agent or user.
+         */
+        role: 'agent' | 'user';
+        /**
+         * Create timestamp of the message
+         */
+        created_timestamp?: number;
+        /**
+         * Unique id of the message
+         */
+        message_id?: string;
+    }
+    interface ToolCallInvocationMessageBase {
+        /**
+         * Arguments for this tool call, it's a stringified JSON object.
+         */
+        arguments: string;
+        /**
+         * Name of the function in this tool call.
+         */
+        name: string;
+        /**
+         * This is a tool call invocation.
+         */
+        role: 'tool_call_invocation';
+        /**
+         * Tool call id, globally unique.
+         */
+        tool_call_id: string;
+        /**
+         * Create timestamp of the message
+         */
+        created_timestamp?: number;
+        /**
+         * Unique id of the message
+         */
+        message_id?: string;
+        /**
+         * Optional thought signature from Google Gemini thinking models. This is used
+         * internally to maintain reasoning chain in multi-turn function calling.
+         */
+        thought_signature?: string;
+    }
+    interface ToolCallResultMessageBase {
+        /**
+         * Result of the tool call, can be a string, a stringified json, etc.
+         */
+        content: string;
+        /**
+         * This is the result of a tool call.
+         */
+        role: 'tool_call_result';
+        /**
+         * Tool call id, globally unique.
+         */
+        tool_call_id: string;
+        /**
+         * Create timestamp of the message
+         */
+        created_timestamp?: number;
+        /**
+         * Unique id of the message
+         */
+        message_id?: string;
+        /**
+         * Whether the tool call was successful.
+         */
+        successful?: boolean;
+    }
+    interface NodeTransitionMessageBase {
+        /**
+         * This is a node transition.
+         */
+        role: 'node_transition';
+        /**
+         * Create timestamp of the message
+         */
+        created_timestamp?: number;
+        /**
+         * Former node id
+         */
+        former_node_id?: string;
+        /**
+         * Former node name
+         */
+        former_node_name?: string;
+        /**
+         * Unique id of the message
+         */
+        message_id?: string;
+        /**
+         * New node id
+         */
+        new_node_id?: string;
+        /**
+         * New node name
+         */
+        new_node_name?: string;
+        /**
+         * How this node was reached. "global" means a global node transition,
+         * "global_go_back" means returning from a global node, "interrupt_go_back" means
+         * going back due to user interruption, and "normal" means a regular edge
+         * transition.
+         */
+        transition_type?: 'global' | 'global_go_back' | 'interrupt_go_back' | 'normal';
+    }
+    interface StateTransitionMessageBase {
+        /**
+         * This is a state transition.
+         */
+        role: 'state_transition';
+        /**
+         * Create timestamp of the message
+         */
+        created_timestamp?: number;
+        /**
+         * Former state name
+         */
+        former_state_name?: string;
+        /**
+         * Unique id of the message
+         */
+        message_id?: string;
+        /**
+         * New state name
+         */
+        new_state_name?: string;
+    }
+    interface ToolMock {
+        /**
+         * Rule for matching tool calls
+         */
+        input_match_rule: ToolMock.Type | ToolMock.UnionMember1;
+        /**
+         * The output of the tool call that will be fed into the LLM. Should be a JSON
+         * string.
+         */
+        output: string;
+        /**
+         * Name of the tool to mock
+         */
+        tool_name: string;
+        /**
+         * For tool calls like transfer_call that require a boolean result. Optional for
+         * most tools.
+         */
+        result?: boolean | null;
+    }
+    namespace ToolMock {
+        interface Type {
+            /**
+             * Match any input of the tool
+             */
+            type: 'any';
+        }
+        interface UnionMember1 {
+            /**
+             * Arguments to match. Only provided fields will be checked
+             */
+            args: {
+                [key: string]: unknown;
+            };
+            /**
+             * Match only calls with specific arguments
+             */
+            type: 'partial_match';
+        }
+    }
+}
+export declare namespace Playground {
+    export { type PlaygroundCompletionResponse as PlaygroundCompletionResponse, type PlaygroundCompletionParams as PlaygroundCompletionParams, };
+}
+//# sourceMappingURL=playground.d.mts.map

package/resources/playground.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playground.d.mts","sourceRoot":"","sources":["../src/resources/playground.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;OAIG;IACH,UAAU,CACR,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAS5C;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,QAAQ,EAAE,KAAK,CACX,4BAA4B,CAAC,WAAW,GACxC,4BAA4B,CAAC,6BAA6B,GAC1D,4BAA4B,CAAC,yBAAyB,GACtD,4BAA4B,CAAC,yBAAyB,GACtD,4BAA4B,CAAC,0BAA0B,CAC1D,CAAC;IAEF;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,iBAAiB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE9C;;OAEG;IACH,iCAAiC,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACnD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,WAAW;QAC1B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC;QAEvB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,6BAA6B;QAC5C;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,sBAAsB,CAAC;QAE7B;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B;IAED,UAAiB,yBAAyB;QACxC;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,kBAAkB,CAAC;QAEzB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB;IAED,UAAiB,yBAAyB;QACxC;;WAEG;QACH,IAAI,EAAE,iBAAiB,CAAC;QAExB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;;;;WAKG;QACH,eAAe,CAAC,EAAE,QAAQ,GAAG,gBAAgB,GAAG,mBAAmB,GAAG,QAAQ,CAAC;KAChF;IAED,UAAiB,0BAA0B;QACzC;;WAEG;QACH,IAAI,EAAE,kBAAkB,CAAC;QAEzB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,QAAQ,EAAE,KAAK,CACX,0BAA0B,CAAC,WAAW,GACtC,0BAA0B,CAAC,6BAA6B,GACxD,0BAA0B,CAAC,yBAAyB,GACpD,0BAA0B,CAAC,yBAAyB,GACpD,0BAA0B,CAAC,0BAA0B,CACxD,CAAC;IAEF;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,iBAAiB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE9C;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC;CACzD;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,WAAW;QAC1B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC;QAEvB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,6BAA6B;QAC5C;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,sBAAsB,CAAC;QAE7B;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B;IAED,UAAiB,yBAAyB;QACxC;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,kBAAkB,CAAC;QAEzB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB;IAED,UAAiB,yBAAyB;QACxC;;WAEG;QACH,IAAI,EAAE,iBAAiB,CAAC;QAExB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;;;;WAKG;QACH,eAAe,CAAC,EAAE,QAAQ,GAAG,gBAAgB,GAAG,mBAAmB,GAAG,QAAQ,CAAC;KAChF;IAED,UAAiB,0BAA0B;QACzC;;WAEG;QACH,IAAI,EAAE,kBAAkB,CAAC;QAEzB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,gBAAgB,EAAE,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAC,YAAY,CAAC;QAExD;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,QAAQ,CAAC;QACxB,UAAiB,IAAI;YACnB;;eAEG;YACH,IAAI,EAAE,KAAK,CAAC;SACb;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,IAAI,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;YAEjC;;eAEG;YACH,IAAI,EAAE,eAAe,CAAC;SACvB;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}