@fonoster/common 0.26.0 → 0.30.0

package/dist/assistants/assistantSchema.d.ts

@@ -1,739 +0,0 @@
-/**
- * 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";
-declare const assistantSchema: z.ZodObject<{
-    audioFilters: z.ZodDefault<z.ZodArray<z.ZodObject<{
-        name: z.ZodString;
-        options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    }, "strip", z.ZodTypeAny, {
-        options?: Record<string, unknown>;
-        name?: string;
-    }, {
-        options?: Record<string, unknown>;
-        name?: string;
-    }>, "many">>;
-    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>;
-        maxSpeechWaitTimeout: z.ZodDefault<z.ZodNumber>;
-        transferOptions: z.ZodOptional<z.ZodObject<{
-            phoneNumber: z.ZodString;
-            message: z.ZodString;
-            timeout: z.ZodDefault<z.ZodNumber>;
-        }, "strip", z.ZodTypeAny, {
-            message?: string;
-            phoneNumber?: string;
-            timeout?: number;
-        }, {
-            message?: string;
-            phoneNumber?: string;
-            timeout?: number;
-        }>>;
-        idleOptions: 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.ZodOptional<z.ZodBoolean>>;
-        vad: z.ZodDefault<z.ZodObject<{
-            pathToModel: z.ZodOptional<z.ZodString>;
-            activationThreshold: z.ZodNumber;
-            deactivationThreshold: z.ZodNumber;
-            debounceFrames: z.ZodNumber;
-        }, "strip", z.ZodTypeAny, {
-            pathToModel?: string;
-            activationThreshold?: number;
-            deactivationThreshold?: number;
-            debounceFrames?: number;
-        }, {
-            pathToModel?: string;
-            activationThreshold?: number;
-            deactivationThreshold?: number;
-            debounceFrames?: number;
-        }>>;
-    }, "strip", z.ZodTypeAny, {
-        firstMessage?: string;
-        systemPrompt?: string;
-        goodbyeMessage?: string;
-        systemErrorMessage?: string;
-        initialDtmf?: string;
-        maxSessionDuration?: number;
-        maxSpeechWaitTimeout?: number;
-        transferOptions?: {
-            message?: string;
-            phoneNumber?: string;
-            timeout?: number;
-        };
-        idleOptions?: {
-            message?: string;
-            timeout?: number;
-            maxTimeoutCount?: number;
-        };
-        allowUserBargeIn?: boolean;
-        vad?: {
-            pathToModel?: string;
-            activationThreshold?: number;
-            deactivationThreshold?: number;
-            debounceFrames?: number;
-        };
-    }, {
-        firstMessage?: string;
-        systemPrompt?: string;
-        goodbyeMessage?: string;
-        systemErrorMessage?: string;
-        initialDtmf?: string;
-        maxSessionDuration?: number;
-        maxSpeechWaitTimeout?: number;
-        transferOptions?: {
-            message?: string;
-            phoneNumber?: string;
-            timeout?: number;
-        };
-        idleOptions?: {
-            message?: string;
-            timeout?: number;
-            maxTimeoutCount?: number;
-        };
-        allowUserBargeIn?: boolean;
-        vad?: {
-            pathToModel?: string;
-            activationThreshold?: number;
-            deactivationThreshold?: number;
-            debounceFrames?: number;
-        };
-    }>;
-    languageModel: z.ZodObject<{
-        provider: z.ZodNativeEnum<typeof import("./LanguageModelProvider").LanguageModelProvider>;
-        apiKey: z.ZodOptional<z.ZodString>;
-        model: z.ZodString;
-        temperature: z.ZodNumber;
-        maxTokens: z.ZodNumber;
-        baseUrl: z.ZodOptional<z.ZodString>;
-        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">>;
-        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">>;
-    }, "strip", z.ZodTypeAny, {
-        provider?: import("./LanguageModelProvider").LanguageModelProvider;
-        apiKey?: string;
-        model?: string;
-        temperature?: number;
-        maxTokens?: number;
-        baseUrl?: string;
-        knowledgeBase?: {
-            type?: "s3";
-            title?: string;
-            document?: string;
-        }[];
-        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;
-            };
-        }[];
-    }, {
-        provider?: import("./LanguageModelProvider").LanguageModelProvider;
-        apiKey?: string;
-        model?: string;
-        temperature?: number;
-        maxTokens?: number;
-        baseUrl?: string;
-        knowledgeBase?: {
-            type?: "s3";
-            title?: string;
-            document?: string;
-        }[];
-        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;
-            };
-        }[];
-    }>;
-    eventsHook: z.ZodOptional<z.ZodObject<{
-        url: z.ZodString;
-        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-        events: z.ZodDefault<z.ZodArray<z.ZodNativeEnum<typeof import("./eventsHookSchema").EventsHookAllowedEvents>, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        url?: string;
-        headers?: Record<string, string>;
-        events?: import("./eventsHookSchema").EventsHookAllowedEvents[];
-    }, {
-        url?: string;
-        headers?: Record<string, string>;
-        events?: import("./eventsHookSchema").EventsHookAllowedEvents[];
-    }>>;
-    testCases: z.ZodOptional<z.ZodObject<{
-        evalsLanguageModel: z.ZodObject<{
-            provider: z.ZodEnum<["openai"]>;
-            model: z.ZodString;
-            apiKey: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            provider?: "openai";
-            apiKey?: string;
-            model?: string;
-        }, {
-            provider?: "openai";
-            apiKey?: string;
-            model?: string;
-        }>;
-        evalsSystemPrompt: z.ZodOptional<z.ZodString>;
-        scenarios: z.ZodArray<z.ZodObject<{
-            ref: z.ZodString;
-            description: z.ZodString;
-            telephonyContext: z.ZodObject<{
-                callDirection: z.ZodNativeEnum<typeof import("@fonoster/types").CallDirection>;
-                ingressNumber: z.ZodString;
-                callerNumber: z.ZodString;
-                metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-            }, "strip", z.ZodTypeAny, {
-                callDirection?: import("@fonoster/types").CallDirection;
-                ingressNumber?: string;
-                callerNumber?: string;
-                metadata?: Record<string, string>;
-            }, {
-                callDirection?: import("@fonoster/types").CallDirection;
-                ingressNumber?: string;
-                callerNumber?: string;
-                metadata?: Record<string, string>;
-            }>;
-            conversation: z.ZodArray<z.ZodObject<{
-                userInput: z.ZodString;
-                expected: z.ZodObject<{
-                    text: z.ZodObject<{
-                        type: z.ZodEnum<["EXACT", "SIMILAR"]>;
-                        response: z.ZodString;
-                    }, "strip", z.ZodTypeAny, {
-                        type?: "EXACT" | "SIMILAR";
-                        response?: string;
-                    }, {
-                        type?: "EXACT" | "SIMILAR";
-                        response?: string;
-                    }>;
-                    tools: z.ZodOptional<z.ZodArray<z.ZodObject<{
-                        tool: z.ZodString;
-                        parameters: z.ZodRecord<z.ZodString, z.ZodAny>;
-                    }, "strip", z.ZodTypeAny, {
-                        parameters?: Record<string, any>;
-                        tool?: string;
-                    }, {
-                        parameters?: Record<string, any>;
-                        tool?: string;
-                    }>, "many">>;
-                }, "strip", z.ZodTypeAny, {
-                    tools?: {
-                        parameters?: Record<string, any>;
-                        tool?: string;
-                    }[];
-                    text?: {
-                        type?: "EXACT" | "SIMILAR";
-                        response?: string;
-                    };
-                }, {
-                    tools?: {
-                        parameters?: Record<string, any>;
-                        tool?: string;
-                    }[];
-                    text?: {
-                        type?: "EXACT" | "SIMILAR";
-                        response?: string;
-                    };
-                }>;
-            }, "strip", z.ZodTypeAny, {
-                expected?: {
-                    tools?: {
-                        parameters?: Record<string, any>;
-                        tool?: string;
-                    }[];
-                    text?: {
-                        type?: "EXACT" | "SIMILAR";
-                        response?: string;
-                    };
-                };
-                userInput?: string;
-            }, {
-                expected?: {
-                    tools?: {
-                        parameters?: Record<string, any>;
-                        tool?: string;
-                    }[];
-                    text?: {
-                        type?: "EXACT" | "SIMILAR";
-                        response?: string;
-                    };
-                };
-                userInput?: string;
-            }>, "many">;
-        }, "strip", z.ZodTypeAny, {
-            description?: string;
-            ref?: string;
-            telephonyContext?: {
-                callDirection?: import("@fonoster/types").CallDirection;
-                ingressNumber?: string;
-                callerNumber?: string;
-                metadata?: Record<string, string>;
-            };
-            conversation?: {
-                expected?: {
-                    tools?: {
-                        parameters?: Record<string, any>;
-                        tool?: string;
-                    }[];
-                    text?: {
-                        type?: "EXACT" | "SIMILAR";
-                        response?: string;
-                    };
-                };
-                userInput?: string;
-            }[];
-        }, {
-            description?: string;
-            ref?: string;
-            telephonyContext?: {
-                callDirection?: import("@fonoster/types").CallDirection;
-                ingressNumber?: string;
-                callerNumber?: string;
-                metadata?: Record<string, string>;
-            };
-            conversation?: {
-                expected?: {
-                    tools?: {
-                        parameters?: Record<string, any>;
-                        tool?: string;
-                    }[];
-                    text?: {
-                        type?: "EXACT" | "SIMILAR";
-                        response?: string;
-                    };
-                };
-                userInput?: string;
-            }[];
-        }>, "many">;
-    }, "strip", z.ZodTypeAny, {
-        evalsLanguageModel?: {
-            provider?: "openai";
-            apiKey?: string;
-            model?: string;
-        };
-        evalsSystemPrompt?: string;
-        scenarios?: {
-            description?: string;
-            ref?: string;
-            telephonyContext?: {
-                callDirection?: import("@fonoster/types").CallDirection;
-                ingressNumber?: string;
-                callerNumber?: string;
-                metadata?: Record<string, string>;
-            };
-            conversation?: {
-                expected?: {
-                    tools?: {
-                        parameters?: Record<string, any>;
-                        tool?: string;
-                    }[];
-                    text?: {
-                        type?: "EXACT" | "SIMILAR";
-                        response?: string;
-                    };
-                };
-                userInput?: string;
-            }[];
-        }[];
-    }, {
-        evalsLanguageModel?: {
-            provider?: "openai";
-            apiKey?: string;
-            model?: string;
-        };
-        evalsSystemPrompt?: string;
-        scenarios?: {
-            description?: string;
-            ref?: string;
-            telephonyContext?: {
-                callDirection?: import("@fonoster/types").CallDirection;
-                ingressNumber?: string;
-                callerNumber?: string;
-                metadata?: Record<string, string>;
-            };
-            conversation?: {
-                expected?: {
-                    tools?: {
-                        parameters?: Record<string, any>;
-                        tool?: string;
-                    }[];
-                    text?: {
-                        type?: "EXACT" | "SIMILAR";
-                        response?: string;
-                    };
-                };
-                userInput?: string;
-            }[];
-        }[];
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    audioFilters?: {
-        options?: Record<string, unknown>;
-        name?: string;
-    }[];
-    conversationSettings?: {
-        firstMessage?: string;
-        systemPrompt?: string;
-        goodbyeMessage?: string;
-        systemErrorMessage?: string;
-        initialDtmf?: string;
-        maxSessionDuration?: number;
-        maxSpeechWaitTimeout?: number;
-        transferOptions?: {
-            message?: string;
-            phoneNumber?: string;
-            timeout?: number;
-        };
-        idleOptions?: {
-            message?: string;
-            timeout?: number;
-            maxTimeoutCount?: number;
-        };
-        allowUserBargeIn?: boolean;
-        vad?: {
-            pathToModel?: string;
-            activationThreshold?: number;
-            deactivationThreshold?: number;
-            debounceFrames?: number;
-        };
-    };
-    languageModel?: {
-        provider?: import("./LanguageModelProvider").LanguageModelProvider;
-        apiKey?: string;
-        model?: string;
-        temperature?: number;
-        maxTokens?: number;
-        baseUrl?: string;
-        knowledgeBase?: {
-            type?: "s3";
-            title?: string;
-            document?: string;
-        }[];
-        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;
-            };
-        }[];
-    };
-    eventsHook?: {
-        url?: string;
-        headers?: Record<string, string>;
-        events?: import("./eventsHookSchema").EventsHookAllowedEvents[];
-    };
-    testCases?: {
-        evalsLanguageModel?: {
-            provider?: "openai";
-            apiKey?: string;
-            model?: string;
-        };
-        evalsSystemPrompt?: string;
-        scenarios?: {
-            description?: string;
-            ref?: string;
-            telephonyContext?: {
-                callDirection?: import("@fonoster/types").CallDirection;
-                ingressNumber?: string;
-                callerNumber?: string;
-                metadata?: Record<string, string>;
-            };
-            conversation?: {
-                expected?: {
-                    tools?: {
-                        parameters?: Record<string, any>;
-                        tool?: string;
-                    }[];
-                    text?: {
-                        type?: "EXACT" | "SIMILAR";
-                        response?: string;
-                    };
-                };
-                userInput?: string;
-            }[];
-        }[];
-    };
-}, {
-    audioFilters?: {
-        options?: Record<string, unknown>;
-        name?: string;
-    }[];
-    conversationSettings?: {
-        firstMessage?: string;
-        systemPrompt?: string;
-        goodbyeMessage?: string;
-        systemErrorMessage?: string;
-        initialDtmf?: string;
-        maxSessionDuration?: number;
-        maxSpeechWaitTimeout?: number;
-        transferOptions?: {
-            message?: string;
-            phoneNumber?: string;
-            timeout?: number;
-        };
-        idleOptions?: {
-            message?: string;
-            timeout?: number;
-            maxTimeoutCount?: number;
-        };
-        allowUserBargeIn?: boolean;
-        vad?: {
-            pathToModel?: string;
-            activationThreshold?: number;
-            deactivationThreshold?: number;
-            debounceFrames?: number;
-        };
-    };
-    languageModel?: {
-        provider?: import("./LanguageModelProvider").LanguageModelProvider;
-        apiKey?: string;
-        model?: string;
-        temperature?: number;
-        maxTokens?: number;
-        baseUrl?: string;
-        knowledgeBase?: {
-            type?: "s3";
-            title?: string;
-            document?: string;
-        }[];
-        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;
-            };
-        }[];
-    };
-    eventsHook?: {
-        url?: string;
-        headers?: Record<string, string>;
-        events?: import("./eventsHookSchema").EventsHookAllowedEvents[];
-    };
-    testCases?: {
-        evalsLanguageModel?: {
-            provider?: "openai";
-            apiKey?: string;
-            model?: string;
-        };
-        evalsSystemPrompt?: string;
-        scenarios?: {
-            description?: string;
-            ref?: string;
-            telephonyContext?: {
-                callDirection?: import("@fonoster/types").CallDirection;
-                ingressNumber?: string;
-                callerNumber?: string;
-                metadata?: Record<string, string>;
-            };
-            conversation?: {
-                expected?: {
-                    tools?: {
-                        parameters?: Record<string, any>;
-                        tool?: string;
-                    }[];
-                    text?: {
-                        type?: "EXACT" | "SIMILAR";
-                        response?: string;
-                    };
-                };
-                userInput?: string;
-            }[];
-        }[];
-    };
-}>;
-export { assistantSchema };