@fonoster/common 0.27.0 → 0.30.0

package/dist/assistants/sessionAssistantSchema.d.ts

@@ -0,0 +1,741 @@
+/**
+ * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { z } from "zod";
+export declare const sessionLanguageModelSchema: z.ZodObject<{
+    /** A catalog id such as "openai/gpt-4o-mini". */
+    model: z.ZodString;
+    temperature: z.ZodDefault<z.ZodNumber>;
+    maxTokens: z.ZodDefault<z.ZodNumber>;
+    tools: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodString;
+        parameters: z.ZodObject<{
+            type: z.ZodEnum<["object", "array"]>;
+            properties: z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodObject<{
+                type: z.ZodString;
+                format: z.ZodOptional<z.ZodEnum<["enum", "date-time"]>>;
+                pattern: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                type?: string;
+                format?: "enum" | "date-time";
+                pattern?: string;
+            }, {
+                type?: string;
+                format?: "enum" | "date-time";
+                pattern?: string;
+            }>, {
+                type?: string;
+                format?: "enum" | "date-time";
+                pattern?: string;
+            }, {
+                type?: string;
+                format?: "enum" | "date-time";
+                pattern?: string;
+            }>>;
+            required: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            type?: "object" | "array";
+            properties?: Record<string, {
+                type?: string;
+                format?: "enum" | "date-time";
+                pattern?: string;
+            }>;
+            required?: string[];
+        }, {
+            type?: "object" | "array";
+            properties?: Record<string, {
+                type?: string;
+                format?: "enum" | "date-time";
+                pattern?: string;
+            }>;
+            required?: string[];
+        }>;
+        requestStartMessage: z.ZodOptional<z.ZodString>;
+        operation: z.ZodObject<{
+            method: z.ZodDefault<z.ZodNativeEnum<typeof import("..").AllowedHttpMethod>>;
+            url: z.ZodString;
+            waitForResponse: z.ZodDefault<z.ZodBoolean>;
+            headers: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodString>, Record<string, string>, Record<string, string>>>;
+        }, "strip", z.ZodTypeAny, {
+            url?: string;
+            method?: import("..").AllowedHttpMethod;
+            headers?: Record<string, string>;
+            waitForResponse?: boolean;
+        }, {
+            url?: string;
+            method?: import("..").AllowedHttpMethod;
+            headers?: Record<string, string>;
+            waitForResponse?: boolean;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        name?: string;
+        description?: string;
+        parameters?: {
+            type?: "object" | "array";
+            properties?: Record<string, {
+                type?: string;
+                format?: "enum" | "date-time";
+                pattern?: string;
+            }>;
+            required?: string[];
+        };
+        requestStartMessage?: string;
+        operation?: {
+            url?: string;
+            method?: import("..").AllowedHttpMethod;
+            headers?: Record<string, string>;
+            waitForResponse?: boolean;
+        };
+    }, {
+        name?: string;
+        description?: string;
+        parameters?: {
+            type?: "object" | "array";
+            properties?: Record<string, {
+                type?: string;
+                format?: "enum" | "date-time";
+                pattern?: string;
+            }>;
+            required?: string[];
+        };
+        requestStartMessage?: string;
+        operation?: {
+            url?: string;
+            method?: import("..").AllowedHttpMethod;
+            headers?: Record<string, string>;
+            waitForResponse?: boolean;
+        };
+    }>, "many">>;
+    /** Documents for the knowledge port (same shape as before; wired by the operator). */
+    knowledgeBase: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<["s3"]>;
+        title: z.ZodString;
+        document: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type?: "s3";
+        title?: string;
+        document?: string;
+    }, {
+        type?: "s3";
+        title?: string;
+        document?: string;
+    }>, "many">>;
+    provider: z.ZodEffects<z.ZodOptional<z.ZodAny>, any, any>;
+    apiKey: z.ZodEffects<z.ZodOptional<z.ZodAny>, any, any>;
+    baseUrl: z.ZodEffects<z.ZodOptional<z.ZodAny>, any, any>;
+}, "strict", z.ZodTypeAny, {
+    model?: string;
+    temperature?: number;
+    maxTokens?: number;
+    tools?: {
+        name?: string;
+        description?: string;
+        parameters?: {
+            type?: "object" | "array";
+            properties?: Record<string, {
+                type?: string;
+                format?: "enum" | "date-time";
+                pattern?: string;
+            }>;
+            required?: string[];
+        };
+        requestStartMessage?: string;
+        operation?: {
+            url?: string;
+            method?: import("..").AllowedHttpMethod;
+            headers?: Record<string, string>;
+            waitForResponse?: boolean;
+        };
+    }[];
+    knowledgeBase?: {
+        type?: "s3";
+        title?: string;
+        document?: string;
+    }[];
+    provider?: any;
+    apiKey?: any;
+    baseUrl?: any;
+}, {
+    model?: string;
+    temperature?: number;
+    maxTokens?: number;
+    tools?: {
+        name?: string;
+        description?: string;
+        parameters?: {
+            type?: "object" | "array";
+            properties?: Record<string, {
+                type?: string;
+                format?: "enum" | "date-time";
+                pattern?: string;
+            }>;
+            required?: string[];
+        };
+        requestStartMessage?: string;
+        operation?: {
+            url?: string;
+            method?: import("..").AllowedHttpMethod;
+            headers?: Record<string, string>;
+            waitForResponse?: boolean;
+        };
+    }[];
+    knowledgeBase?: {
+        type?: "s3";
+        title?: string;
+        document?: string;
+    }[];
+    provider?: any;
+    apiKey?: any;
+    baseUrl?: any;
+}>;
+export declare const sessionConversationSettingsSchema: z.ZodObject<{
+    firstMessage: z.ZodOptional<z.ZodString>;
+    systemPrompt: z.ZodString;
+    goodbyeMessage: z.ZodString;
+    systemErrorMessage: z.ZodString;
+    initialDtmf: z.ZodOptional<z.ZodString>;
+    maxSessionDuration: z.ZodDefault<z.ZodNumber>;
+    transferOptions: z.ZodOptional<z.ZodObject<{
+        phoneNumber: z.ZodString;
+        message: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        message?: string;
+        phoneNumber?: string;
+    }, {
+        message?: string;
+        phoneNumber?: string;
+    }>>;
+    idleOptions: z.ZodOptional<z.ZodObject<{
+        message: z.ZodString;
+        timeout: z.ZodDefault<z.ZodNumber>;
+        maxTimeoutCount: z.ZodDefault<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        message?: string;
+        timeout?: number;
+        maxTimeoutCount?: number;
+    }, {
+        message?: string;
+        timeout?: number;
+        maxTimeoutCount?: number;
+    }>>;
+    allowUserBargeIn: z.ZodDefault<z.ZodBoolean>;
+    /**
+     * The turn-taking patience knob (TT-B5): sent to the gateway with listen.update so its Pacing
+     * policy waits less (low) or more (high) before turn.ended. Autopilot prepares a reply on
+     * turn.likely_ended at low and normal, and only on turn.ended at high.
+     */
+    patience: z.ZodDefault<z.ZodEnum<["low", "normal", "high"]>>;
+    /** Words to bias speech recognition toward (names, brands), sent with listen.update. */
+    hints: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    /** Played with play() while thinking; the reply preempts it (A9). */
+    filler: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        url?: string;
+    }, {
+        url?: string;
+    }>>;
+    /** Catalog ids overriding the app's speech defaults on every speak. */
+    voice: z.ZodOptional<z.ZodString>;
+    language: z.ZodOptional<z.ZodString>;
+    vad: z.ZodEffects<z.ZodOptional<z.ZodAny>, any, any>;
+    maxSpeechWaitTimeout: z.ZodEffects<z.ZodOptional<z.ZodAny>, any, any>;
+}, "strict", z.ZodTypeAny, {
+    firstMessage?: string;
+    systemPrompt?: string;
+    goodbyeMessage?: string;
+    systemErrorMessage?: string;
+    initialDtmf?: string;
+    maxSessionDuration?: number;
+    transferOptions?: {
+        message?: string;
+        phoneNumber?: string;
+    };
+    idleOptions?: {
+        message?: string;
+        timeout?: number;
+        maxTimeoutCount?: number;
+    };
+    allowUserBargeIn?: boolean;
+    patience?: "low" | "normal" | "high";
+    hints?: string[];
+    filler?: {
+        url?: string;
+    };
+    voice?: string;
+    language?: string;
+    vad?: any;
+    maxSpeechWaitTimeout?: any;
+}, {
+    firstMessage?: string;
+    systemPrompt?: string;
+    goodbyeMessage?: string;
+    systemErrorMessage?: string;
+    initialDtmf?: string;
+    maxSessionDuration?: number;
+    transferOptions?: {
+        message?: string;
+        phoneNumber?: string;
+    };
+    idleOptions?: {
+        message?: string;
+        timeout?: number;
+        maxTimeoutCount?: number;
+    };
+    allowUserBargeIn?: boolean;
+    patience?: "low" | "normal" | "high";
+    hints?: string[];
+    filler?: {
+        url?: string;
+    };
+    voice?: string;
+    language?: string;
+    vad?: any;
+    maxSpeechWaitTimeout?: any;
+}>;
+export declare const sessionAssistantSchema: z.ZodObject<{
+    conversationSettings: z.ZodObject<{
+        firstMessage: z.ZodOptional<z.ZodString>;
+        systemPrompt: z.ZodString;
+        goodbyeMessage: z.ZodString;
+        systemErrorMessage: z.ZodString;
+        initialDtmf: z.ZodOptional<z.ZodString>;
+        maxSessionDuration: z.ZodDefault<z.ZodNumber>;
+        transferOptions: z.ZodOptional<z.ZodObject<{
+            phoneNumber: z.ZodString;
+            message: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            message?: string;
+            phoneNumber?: string;
+        }, {
+            message?: string;
+            phoneNumber?: string;
+        }>>;
+        idleOptions: z.ZodOptional<z.ZodObject<{
+            message: z.ZodString;
+            timeout: z.ZodDefault<z.ZodNumber>;
+            maxTimeoutCount: z.ZodDefault<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            message?: string;
+            timeout?: number;
+            maxTimeoutCount?: number;
+        }, {
+            message?: string;
+            timeout?: number;
+            maxTimeoutCount?: number;
+        }>>;
+        allowUserBargeIn: z.ZodDefault<z.ZodBoolean>;
+        /**
+         * The turn-taking patience knob (TT-B5): sent to the gateway with listen.update so its Pacing
+         * policy waits less (low) or more (high) before turn.ended. Autopilot prepares a reply on
+         * turn.likely_ended at low and normal, and only on turn.ended at high.
+         */
+        patience: z.ZodDefault<z.ZodEnum<["low", "normal", "high"]>>;
+        /** Words to bias speech recognition toward (names, brands), sent with listen.update. */
+        hints: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        /** Played with play() while thinking; the reply preempts it (A9). */
+        filler: z.ZodOptional<z.ZodObject<{
+            url: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            url?: string;
+        }, {
+            url?: string;
+        }>>;
+        /** Catalog ids overriding the app's speech defaults on every speak. */
+        voice: z.ZodOptional<z.ZodString>;
+        language: z.ZodOptional<z.ZodString>;
+        vad: z.ZodEffects<z.ZodOptional<z.ZodAny>, any, any>;
+        maxSpeechWaitTimeout: z.ZodEffects<z.ZodOptional<z.ZodAny>, any, any>;
+    }, "strict", z.ZodTypeAny, {
+        firstMessage?: string;
+        systemPrompt?: string;
+        goodbyeMessage?: string;
+        systemErrorMessage?: string;
+        initialDtmf?: string;
+        maxSessionDuration?: number;
+        transferOptions?: {
+            message?: string;
+            phoneNumber?: string;
+        };
+        idleOptions?: {
+            message?: string;
+            timeout?: number;
+            maxTimeoutCount?: number;
+        };
+        allowUserBargeIn?: boolean;
+        patience?: "low" | "normal" | "high";
+        hints?: string[];
+        filler?: {
+            url?: string;
+        };
+        voice?: string;
+        language?: string;
+        vad?: any;
+        maxSpeechWaitTimeout?: any;
+    }, {
+        firstMessage?: string;
+        systemPrompt?: string;
+        goodbyeMessage?: string;
+        systemErrorMessage?: string;
+        initialDtmf?: string;
+        maxSessionDuration?: number;
+        transferOptions?: {
+            message?: string;
+            phoneNumber?: string;
+        };
+        idleOptions?: {
+            message?: string;
+            timeout?: number;
+            maxTimeoutCount?: number;
+        };
+        allowUserBargeIn?: boolean;
+        patience?: "low" | "normal" | "high";
+        hints?: string[];
+        filler?: {
+            url?: string;
+        };
+        voice?: string;
+        language?: string;
+        vad?: any;
+        maxSpeechWaitTimeout?: any;
+    }>;
+    languageModel: z.ZodObject<{
+        /** A catalog id such as "openai/gpt-4o-mini". */
+        model: z.ZodString;
+        temperature: z.ZodDefault<z.ZodNumber>;
+        maxTokens: z.ZodDefault<z.ZodNumber>;
+        tools: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodString;
+            parameters: z.ZodObject<{
+                type: z.ZodEnum<["object", "array"]>;
+                properties: z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodObject<{
+                    type: z.ZodString;
+                    format: z.ZodOptional<z.ZodEnum<["enum", "date-time"]>>;
+                    pattern: z.ZodOptional<z.ZodString>;
+                }, "strip", z.ZodTypeAny, {
+                    type?: string;
+                    format?: "enum" | "date-time";
+                    pattern?: string;
+                }, {
+                    type?: string;
+                    format?: "enum" | "date-time";
+                    pattern?: string;
+                }>, {
+                    type?: string;
+                    format?: "enum" | "date-time";
+                    pattern?: string;
+                }, {
+                    type?: string;
+                    format?: "enum" | "date-time";
+                    pattern?: string;
+                }>>;
+                required: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            }, "strip", z.ZodTypeAny, {
+                type?: "object" | "array";
+                properties?: Record<string, {
+                    type?: string;
+                    format?: "enum" | "date-time";
+                    pattern?: string;
+                }>;
+                required?: string[];
+            }, {
+                type?: "object" | "array";
+                properties?: Record<string, {
+                    type?: string;
+                    format?: "enum" | "date-time";
+                    pattern?: string;
+                }>;
+                required?: string[];
+            }>;
+            requestStartMessage: z.ZodOptional<z.ZodString>;
+            operation: z.ZodObject<{
+                method: z.ZodDefault<z.ZodNativeEnum<typeof import("..").AllowedHttpMethod>>;
+                url: z.ZodString;
+                waitForResponse: z.ZodDefault<z.ZodBoolean>;
+                headers: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodString>, Record<string, string>, Record<string, string>>>;
+            }, "strip", z.ZodTypeAny, {
+                url?: string;
+                method?: import("..").AllowedHttpMethod;
+                headers?: Record<string, string>;
+                waitForResponse?: boolean;
+            }, {
+                url?: string;
+                method?: import("..").AllowedHttpMethod;
+                headers?: Record<string, string>;
+                waitForResponse?: boolean;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            name?: string;
+            description?: string;
+            parameters?: {
+                type?: "object" | "array";
+                properties?: Record<string, {
+                    type?: string;
+                    format?: "enum" | "date-time";
+                    pattern?: string;
+                }>;
+                required?: string[];
+            };
+            requestStartMessage?: string;
+            operation?: {
+                url?: string;
+                method?: import("..").AllowedHttpMethod;
+                headers?: Record<string, string>;
+                waitForResponse?: boolean;
+            };
+        }, {
+            name?: string;
+            description?: string;
+            parameters?: {
+                type?: "object" | "array";
+                properties?: Record<string, {
+                    type?: string;
+                    format?: "enum" | "date-time";
+                    pattern?: string;
+                }>;
+                required?: string[];
+            };
+            requestStartMessage?: string;
+            operation?: {
+                url?: string;
+                method?: import("..").AllowedHttpMethod;
+                headers?: Record<string, string>;
+                waitForResponse?: boolean;
+            };
+        }>, "many">>;
+        /** Documents for the knowledge port (same shape as before; wired by the operator). */
+        knowledgeBase: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            type: z.ZodEnum<["s3"]>;
+            title: z.ZodString;
+            document: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type?: "s3";
+            title?: string;
+            document?: string;
+        }, {
+            type?: "s3";
+            title?: string;
+            document?: string;
+        }>, "many">>;
+        provider: z.ZodEffects<z.ZodOptional<z.ZodAny>, any, any>;
+        apiKey: z.ZodEffects<z.ZodOptional<z.ZodAny>, any, any>;
+        baseUrl: z.ZodEffects<z.ZodOptional<z.ZodAny>, any, any>;
+    }, "strict", z.ZodTypeAny, {
+        model?: string;
+        temperature?: number;
+        maxTokens?: number;
+        tools?: {
+            name?: string;
+            description?: string;
+            parameters?: {
+                type?: "object" | "array";
+                properties?: Record<string, {
+                    type?: string;
+                    format?: "enum" | "date-time";
+                    pattern?: string;
+                }>;
+                required?: string[];
+            };
+            requestStartMessage?: string;
+            operation?: {
+                url?: string;
+                method?: import("..").AllowedHttpMethod;
+                headers?: Record<string, string>;
+                waitForResponse?: boolean;
+            };
+        }[];
+        knowledgeBase?: {
+            type?: "s3";
+            title?: string;
+            document?: string;
+        }[];
+        provider?: any;
+        apiKey?: any;
+        baseUrl?: any;
+    }, {
+        model?: string;
+        temperature?: number;
+        maxTokens?: number;
+        tools?: {
+            name?: string;
+            description?: string;
+            parameters?: {
+                type?: "object" | "array";
+                properties?: Record<string, {
+                    type?: string;
+                    format?: "enum" | "date-time";
+                    pattern?: string;
+                }>;
+                required?: string[];
+            };
+            requestStartMessage?: string;
+            operation?: {
+                url?: string;
+                method?: import("..").AllowedHttpMethod;
+                headers?: Record<string, string>;
+                waitForResponse?: boolean;
+            };
+        }[];
+        knowledgeBase?: {
+            type?: "s3";
+            title?: string;
+            document?: string;
+        }[];
+        provider?: any;
+        apiKey?: any;
+        baseUrl?: any;
+    }>;
+    /** Conversation eval cases, kept as they were (evaluated outside calls). */
+    testCases: z.ZodOptional<z.ZodAny>;
+    eventsHook: z.ZodEffects<z.ZodOptional<z.ZodAny>, any, any>;
+    audioFilters: z.ZodEffects<z.ZodOptional<z.ZodAny>, any, any>;
+}, "strict", z.ZodTypeAny, {
+    conversationSettings?: {
+        firstMessage?: string;
+        systemPrompt?: string;
+        goodbyeMessage?: string;
+        systemErrorMessage?: string;
+        initialDtmf?: string;
+        maxSessionDuration?: number;
+        transferOptions?: {
+            message?: string;
+            phoneNumber?: string;
+        };
+        idleOptions?: {
+            message?: string;
+            timeout?: number;
+            maxTimeoutCount?: number;
+        };
+        allowUserBargeIn?: boolean;
+        patience?: "low" | "normal" | "high";
+        hints?: string[];
+        filler?: {
+            url?: string;
+        };
+        voice?: string;
+        language?: string;
+        vad?: any;
+        maxSpeechWaitTimeout?: any;
+    };
+    languageModel?: {
+        model?: string;
+        temperature?: number;
+        maxTokens?: number;
+        tools?: {
+            name?: string;
+            description?: string;
+            parameters?: {
+                type?: "object" | "array";
+                properties?: Record<string, {
+                    type?: string;
+                    format?: "enum" | "date-time";
+                    pattern?: string;
+                }>;
+                required?: string[];
+            };
+            requestStartMessage?: string;
+            operation?: {
+                url?: string;
+                method?: import("..").AllowedHttpMethod;
+                headers?: Record<string, string>;
+                waitForResponse?: boolean;
+            };
+        }[];
+        knowledgeBase?: {
+            type?: "s3";
+            title?: string;
+            document?: string;
+        }[];
+        provider?: any;
+        apiKey?: any;
+        baseUrl?: any;
+    };
+    testCases?: any;
+    eventsHook?: any;
+    audioFilters?: any;
+}, {
+    conversationSettings?: {
+        firstMessage?: string;
+        systemPrompt?: string;
+        goodbyeMessage?: string;
+        systemErrorMessage?: string;
+        initialDtmf?: string;
+        maxSessionDuration?: number;
+        transferOptions?: {
+            message?: string;
+            phoneNumber?: string;
+        };
+        idleOptions?: {
+            message?: string;
+            timeout?: number;
+            maxTimeoutCount?: number;
+        };
+        allowUserBargeIn?: boolean;
+        patience?: "low" | "normal" | "high";
+        hints?: string[];
+        filler?: {
+            url?: string;
+        };
+        voice?: string;
+        language?: string;
+        vad?: any;
+        maxSpeechWaitTimeout?: any;
+    };
+    languageModel?: {
+        model?: string;
+        temperature?: number;
+        maxTokens?: number;
+        tools?: {
+            name?: string;
+            description?: string;
+            parameters?: {
+                type?: "object" | "array";
+                properties?: Record<string, {
+                    type?: string;
+                    format?: "enum" | "date-time";
+                    pattern?: string;
+                }>;
+                required?: string[];
+            };
+            requestStartMessage?: string;
+            operation?: {
+                url?: string;
+                method?: import("..").AllowedHttpMethod;
+                headers?: Record<string, string>;
+                waitForResponse?: boolean;
+            };
+        }[];
+        knowledgeBase?: {
+            type?: "s3";
+            title?: string;
+            document?: string;
+        }[];
+        provider?: any;
+        apiKey?: any;
+        baseUrl?: any;
+    };
+    testCases?: any;
+    eventsHook?: any;
+    audioFilters?: any;
+}>;
+export type SessionAssistant = z.infer<typeof sessionAssistantSchema>;
+export type SessionConversationSettings = SessionAssistant["conversationSettings"];
+export type SessionLanguageModel = SessionAssistant["languageModel"];
+export type ToolDefinition = SessionLanguageModel["tools"][number];