@botpress/zai 1.0.1-beta.4 → 1.0.1-beta.5

package/dist/index.d.ts

@@ -0,0 +1,917 @@
+import * as _bpinternal_zui from '@bpinternal/zui';
+import { z } from '@bpinternal/zui';
+import { Client } from '@botpress/client';
+import { TextTokenizer } from '@botpress/wasm';
+
+type GenerationMetadata = z.input<typeof GenerationMetadata>;
+declare const GenerationMetadata: _bpinternal_zui.ZodObject<{
+    model: _bpinternal_zui.ZodString;
+    cost: _bpinternal_zui.ZodObject<{
+        input: _bpinternal_zui.ZodNumber;
+        output: _bpinternal_zui.ZodNumber;
+    }, "strip", _bpinternal_zui.ZodTypeAny, {
+        input?: number;
+        output?: number;
+    }, {
+        input?: number;
+        output?: number;
+    }>;
+    latency: _bpinternal_zui.ZodNumber;
+    tokens: _bpinternal_zui.ZodObject<{
+        input: _bpinternal_zui.ZodNumber;
+        output: _bpinternal_zui.ZodNumber;
+    }, "strip", _bpinternal_zui.ZodTypeAny, {
+        input?: number;
+        output?: number;
+    }, {
+        input?: number;
+        output?: number;
+    }>;
+}, "strip", _bpinternal_zui.ZodTypeAny, {
+    model?: string;
+    cost?: {
+        input?: number;
+        output?: number;
+    };
+    latency?: number;
+    tokens?: {
+        input?: number;
+        output?: number;
+    };
+}, {
+    model?: string;
+    cost?: {
+        input?: number;
+        output?: number;
+    };
+    latency?: number;
+    tokens?: {
+        input?: number;
+        output?: number;
+    };
+}>;
+
+type SaveExampleProps<TInput, TOutput> = {
+    key: string;
+    taskType: string;
+    taskId: string;
+    instructions: string;
+    input: TInput;
+    output: TOutput;
+    explanation?: string;
+    metadata: GenerationMetadata;
+    status?: 'pending' | 'approved';
+};
+type GetExamplesProps<TInput> = {
+    taskType: string;
+    taskId: string;
+    input: TInput;
+};
+declare abstract class Adapter {
+    abstract getExamples<TInput, TOutput>(props: GetExamplesProps<TInput>): Promise<Array<{
+        key: string;
+        input: TInput;
+        output: TOutput;
+        explanation?: string;
+        similarity: number;
+    }>>;
+    abstract saveExample<TInput, TOutput>(props: SaveExampleProps<TInput, TOutput>): Promise<void>;
+}
+
+declare const Models: readonly [{
+    readonly id: "anthropic__claude-3-haiku-20240307";
+    readonly name: "Claude 3 Haiku";
+    readonly integration: "anthropic";
+    readonly input: {
+        readonly maxTokens: 200000;
+    };
+    readonly output: {
+        readonly maxTokens: 4096;
+    };
+}, {
+    readonly id: "anthropic__claude-3-5-sonnet-20240620";
+    readonly name: "Claude 3.5 Sonnet";
+    readonly integration: "anthropic";
+    readonly input: {
+        readonly maxTokens: 200000;
+    };
+    readonly output: {
+        readonly maxTokens: 4096;
+    };
+}, {
+    readonly id: "cerebras__llama3.1-70b";
+    readonly name: "Llama 3.1 70B";
+    readonly integration: "cerebras";
+    readonly input: {
+        readonly maxTokens: 8192;
+    };
+    readonly output: {
+        readonly maxTokens: 8192;
+    };
+}, {
+    readonly id: "cerebras__llama3.1-8b";
+    readonly name: "Llama 3.1 8B";
+    readonly integration: "cerebras";
+    readonly input: {
+        readonly maxTokens: 8192;
+    };
+    readonly output: {
+        readonly maxTokens: 8192;
+    };
+}, {
+    readonly id: "fireworks-ai__accounts/fireworks/models/deepseek-coder-v2-instruct";
+    readonly name: "DeepSeek Coder V2 Instruct";
+    readonly integration: "fireworks-ai";
+    readonly input: {
+        readonly maxTokens: 131072;
+    };
+    readonly output: {
+        readonly maxTokens: 131072;
+    };
+}, {
+    readonly id: "fireworks-ai__accounts/fireworks/models/deepseek-coder-v2-lite-instruct";
+    readonly name: "DeepSeek Coder V2 Lite";
+    readonly integration: "fireworks-ai";
+    readonly input: {
+        readonly maxTokens: 163840;
+    };
+    readonly output: {
+        readonly maxTokens: 163840;
+    };
+}, {
+    readonly id: "fireworks-ai__accounts/fireworks/models/firellava-13b";
+    readonly name: "FireLLaVA-13B";
+    readonly integration: "fireworks-ai";
+    readonly input: {
+        readonly maxTokens: 4096;
+    };
+    readonly output: {
+        readonly maxTokens: 4096;
+    };
+}, {
+    readonly id: "fireworks-ai__accounts/fireworks/models/firefunction-v2";
+    readonly name: "Firefunction V2";
+    readonly integration: "fireworks-ai";
+    readonly input: {
+        readonly maxTokens: 8192;
+    };
+    readonly output: {
+        readonly maxTokens: 8192;
+    };
+}, {
+    readonly id: "fireworks-ai__accounts/fireworks/models/gemma2-9b-it";
+    readonly name: "Gemma 2 9B Instruct";
+    readonly integration: "fireworks-ai";
+    readonly input: {
+        readonly maxTokens: 8192;
+    };
+    readonly output: {
+        readonly maxTokens: 8192;
+    };
+}, {
+    readonly id: "fireworks-ai__accounts/fireworks/models/llama-v3p1-405b-instruct";
+    readonly name: "Llama 3.1 405B Instruct";
+    readonly integration: "fireworks-ai";
+    readonly input: {
+        readonly maxTokens: 131072;
+    };
+    readonly output: {
+        readonly maxTokens: 131072;
+    };
+}, {
+    readonly id: "fireworks-ai__accounts/fireworks/models/llama-v3p1-70b-instruct";
+    readonly name: "Llama 3.1 70B Instruct";
+    readonly integration: "fireworks-ai";
+    readonly input: {
+        readonly maxTokens: 131072;
+    };
+    readonly output: {
+        readonly maxTokens: 131072;
+    };
+}, {
+    readonly id: "fireworks-ai__accounts/fireworks/models/llama-v3p1-8b-instruct";
+    readonly name: "Llama 3.1 8B Instruct";
+    readonly integration: "fireworks-ai";
+    readonly input: {
+        readonly maxTokens: 131072;
+    };
+    readonly output: {
+        readonly maxTokens: 131072;
+    };
+}, {
+    readonly id: "fireworks-ai__accounts/fireworks/models/mixtral-8x22b-instruct";
+    readonly name: "Mixtral MoE 8x22B Instruct";
+    readonly integration: "fireworks-ai";
+    readonly input: {
+        readonly maxTokens: 65536;
+    };
+    readonly output: {
+        readonly maxTokens: 65536;
+    };
+}, {
+    readonly id: "fireworks-ai__accounts/fireworks/models/mixtral-8x7b-instruct";
+    readonly name: "Mixtral MoE 8x7B Instruct";
+    readonly integration: "fireworks-ai";
+    readonly input: {
+        readonly maxTokens: 32768;
+    };
+    readonly output: {
+        readonly maxTokens: 32768;
+    };
+}, {
+    readonly id: "fireworks-ai__accounts/fireworks/models/mythomax-l2-13b";
+    readonly name: "MythoMax L2 13b";
+    readonly integration: "fireworks-ai";
+    readonly input: {
+        readonly maxTokens: 4096;
+    };
+    readonly output: {
+        readonly maxTokens: 4096;
+    };
+}, {
+    readonly id: "fireworks-ai__accounts/fireworks/models/qwen2-72b-instruct";
+    readonly name: "Qwen2 72b Instruct";
+    readonly integration: "fireworks-ai";
+    readonly input: {
+        readonly maxTokens: 32768;
+    };
+    readonly output: {
+        readonly maxTokens: 32768;
+    };
+}, {
+    readonly id: "groq__gemma2-9b-it";
+    readonly name: "Gemma2 9B";
+    readonly integration: "groq";
+    readonly input: {
+        readonly maxTokens: 8192;
+    };
+    readonly output: {
+        readonly maxTokens: 8192;
+    };
+}, {
+    readonly id: "groq__llama3-70b-8192";
+    readonly name: "LLaMA 3 70B";
+    readonly integration: "groq";
+    readonly input: {
+        readonly maxTokens: 8192;
+    };
+    readonly output: {
+        readonly maxTokens: 8192;
+    };
+}, {
+    readonly id: "groq__llama3-8b-8192";
+    readonly name: "LLaMA 3 8B";
+    readonly integration: "groq";
+    readonly input: {
+        readonly maxTokens: 8192;
+    };
+    readonly output: {
+        readonly maxTokens: 8192;
+    };
+}, {
+    readonly id: "groq__llama-3.1-70b-versatile";
+    readonly name: "LLaMA 3.1 70B";
+    readonly integration: "groq";
+    readonly input: {
+        readonly maxTokens: 128000;
+    };
+    readonly output: {
+        readonly maxTokens: 8192;
+    };
+}, {
+    readonly id: "groq__llama-3.1-8b-instant";
+    readonly name: "LLaMA 3.1 8B";
+    readonly integration: "groq";
+    readonly input: {
+        readonly maxTokens: 128000;
+    };
+    readonly output: {
+        readonly maxTokens: 8192;
+    };
+}, {
+    readonly id: "groq__llama-3.2-11b-vision-preview";
+    readonly name: "LLaMA 3.2 11B Vision";
+    readonly integration: "groq";
+    readonly input: {
+        readonly maxTokens: 128000;
+    };
+    readonly output: {
+        readonly maxTokens: 8192;
+    };
+}, {
+    readonly id: "groq__llama-3.2-1b-preview";
+    readonly name: "LLaMA 3.2 1B";
+    readonly integration: "groq";
+    readonly input: {
+        readonly maxTokens: 128000;
+    };
+    readonly output: {
+        readonly maxTokens: 8192;
+    };
+}, {
+    readonly id: "groq__llama-3.2-3b-preview";
+    readonly name: "LLaMA 3.2 3B";
+    readonly integration: "groq";
+    readonly input: {
+        readonly maxTokens: 128000;
+    };
+    readonly output: {
+        readonly maxTokens: 8192;
+    };
+}, {
+    readonly id: "groq__llama-3.2-90b-vision-preview";
+    readonly name: "LLaMA 3.2 90B Vision";
+    readonly integration: "groq";
+    readonly input: {
+        readonly maxTokens: 128000;
+    };
+    readonly output: {
+        readonly maxTokens: 8192;
+    };
+}, {
+    readonly id: "groq__llama-3.3-70b-versatile";
+    readonly name: "LLaMA 3.3 70B";
+    readonly integration: "groq";
+    readonly input: {
+        readonly maxTokens: 128000;
+    };
+    readonly output: {
+        readonly maxTokens: 32768;
+    };
+}, {
+    readonly id: "groq__mixtral-8x7b-32768";
+    readonly name: "Mixtral 8x7B";
+    readonly integration: "groq";
+    readonly input: {
+        readonly maxTokens: 32768;
+    };
+    readonly output: {
+        readonly maxTokens: 32768;
+    };
+}, {
+    readonly id: "openai__o1-2024-12-17";
+    readonly name: "GPT o1";
+    readonly integration: "openai";
+    readonly input: {
+        readonly maxTokens: 200000;
+    };
+    readonly output: {
+        readonly maxTokens: 100000;
+    };
+}, {
+    readonly id: "openai__o1-mini-2024-09-12";
+    readonly name: "GPT o1-mini";
+    readonly integration: "openai";
+    readonly input: {
+        readonly maxTokens: 128000;
+    };
+    readonly output: {
+        readonly maxTokens: 65536;
+    };
+}, {
+    readonly id: "openai__gpt-3.5-turbo-0125";
+    readonly name: "GPT-3.5 Turbo";
+    readonly integration: "openai";
+    readonly input: {
+        readonly maxTokens: 128000;
+    };
+    readonly output: {
+        readonly maxTokens: 4096;
+    };
+}, {
+    readonly id: "openai__gpt-4-turbo-2024-04-09";
+    readonly name: "GPT-4 Turbo";
+    readonly integration: "openai";
+    readonly input: {
+        readonly maxTokens: 128000;
+    };
+    readonly output: {
+        readonly maxTokens: 4096;
+    };
+}, {
+    readonly id: "openai__gpt-4o-2024-08-06";
+    readonly name: "GPT-4o (August 2024)";
+    readonly integration: "openai";
+    readonly input: {
+        readonly maxTokens: 128000;
+    };
+    readonly output: {
+        readonly maxTokens: 16384;
+    };
+}, {
+    readonly id: "openai__gpt-4o-2024-05-13";
+    readonly name: "GPT-4o (May 2024)";
+    readonly integration: "openai";
+    readonly input: {
+        readonly maxTokens: 128000;
+    };
+    readonly output: {
+        readonly maxTokens: 4096;
+    };
+}, {
+    readonly id: "openai__gpt-4o-2024-11-20";
+    readonly name: "GPT-4o (November 2024)";
+    readonly integration: "openai";
+    readonly input: {
+        readonly maxTokens: 128000;
+    };
+    readonly output: {
+        readonly maxTokens: 16384;
+    };
+}, {
+    readonly id: "openai__gpt-4o-mini-2024-07-18";
+    readonly name: "GPT-4o Mini";
+    readonly integration: "openai";
+    readonly input: {
+        readonly maxTokens: 128000;
+    };
+    readonly output: {
+        readonly maxTokens: 16384;
+    };
+}];
+
+declare namespace llm {
+    namespace generateContent {
+        type Input = {
+            /** Model to use for content generation */
+            model?: {
+                id: string;
+            };
+            /** Optional system prompt to guide the model */
+            systemPrompt?: string;
+            /** Array of messages for the model to process */
+            messages: Array<{
+                role: 'user' | 'assistant';
+                type?: 'text' | 'tool_calls' | 'tool_result' | 'multipart';
+                /** Required if `type` is "tool_calls" */
+                toolCalls?: Array<{
+                    id: string;
+                    type: 'function';
+                    function: {
+                        name: string;
+                        /** Some LLMs may generate invalid JSON for a tool call, so this will be `null` when it happens. */
+                        arguments: {
+                            [key: string]: any;
+                        } | null;
+                    };
+                }>;
+                /** Required if `type` is "tool_result" */
+                toolResultCallId?: string;
+                /** Required unless `type` is "tool_call". If `type` is "multipart", this field must be an array of content objects. If `type` is "tool_result" then this field should be the result of the tool call (a plain string or a JSON-encoded array or object). If `type` is "tool_call" then the `toolCalls` field should be used instead. */
+                content: string | Array<{
+                    type: 'text' | 'image';
+                    /** Indicates the MIME type of the content. If not provided it will be detected from the content-type header of the provided URL. */
+                    mimeType?: string;
+                    /** Required if part type is "text" */
+                    text?: string;
+                    /** Required if part type is "image" */
+                    url?: string;
+                }> | null;
+            }>;
+            /** Response format expected from the model. If "json_object" is chosen, you must instruct the model to generate JSON either via the system prompt or a user message. */
+            responseFormat?: 'text' | 'json_object';
+            /** Maximum number of tokens allowed in the generated response */
+            maxTokens?: number;
+            /** Sampling temperature for the model. Higher values result in more random outputs. */
+            temperature?: number;
+            /** Top-p sampling parameter. Limits sampling to the smallest set of tokens with a cumulative probability above the threshold. */
+            topP?: number;
+            /** Sequences where the model should stop generating further tokens. */
+            stopSequences?: string[];
+            tools?: Array<{
+                type: 'function';
+                function: {
+                    /** Function name */
+                    name: string;
+                    description?: string;
+                    /** JSON schema of the function arguments */
+                    argumentsSchema?: {};
+                };
+            }>;
+            toolChoice?: {
+                type?: 'auto' | 'specific' | 'any' | 'none' | '';
+                /** Required if `type` is "specific" */
+                functionName?: string;
+            };
+            userId?: string;
+            /** Set to `true` to output debug information to the bot logs */
+            debug?: boolean;
+            meta?: {
+                /** Source of the prompt, e.g. agent/:id/:version cards/ai-generate, cards/ai-task, nodes/autonomous, etc. */
+                promptSource?: string;
+                promptCategory?: string;
+                /** Name of the integration that originally received the message that initiated this action */
+                integrationName?: string;
+            };
+        };
+        type Output = {
+            /** Response ID from LLM provider */
+            id: string;
+            /** LLM provider name */
+            provider: string;
+            /** Model name */
+            model: string;
+            choices: Array<{
+                type?: 'text' | 'tool_calls' | 'tool_result' | 'multipart';
+                /** Required if `type` is "tool_calls" */
+                toolCalls?: Array<{
+                    id: string;
+                    type: 'function';
+                    function: {
+                        name: string;
+                        /** Some LLMs may generate invalid JSON for a tool call, so this will be `null` when it happens. */
+                        arguments: {
+                            [key: string]: any;
+                        } | null;
+                    };
+                }>;
+                /** Required if `type` is "tool_result" */
+                toolResultCallId?: string;
+                /** Required unless `type` is "tool_call". If `type` is "multipart", this field must be an array of content objects. If `type` is "tool_result" then this field should be the result of the tool call (a plain string or a JSON-encoded array or object). If `type` is "tool_call" then the `toolCalls` field should be used instead. */
+                content: string | Array<{
+                    type: 'text' | 'image';
+                    /** Indicates the MIME type of the content. If not provided it will be detected from the content-type header of the provided URL. */
+                    mimeType?: string;
+                    /** Required if part type is "text" */
+                    text?: string;
+                    /** Required if part type is "image" */
+                    url?: string;
+                }> | null;
+                role: 'assistant';
+                index: number;
+                stopReason: 'stop' | 'max_tokens' | 'tool_calls' | 'content_filter' | 'other';
+            }>;
+            usage: {
+                /** Number of input tokens used by the model */
+                inputTokens: number;
+                /** Cost of the input tokens received by the model, in U.S. dollars */
+                inputCost: number;
+                /** Number of output tokens used by the model */
+                outputTokens: number;
+                /** Cost of the output tokens generated by the model, in U.S. dollars */
+                outputCost: number;
+            };
+            botpress: {
+                /** Total cost of the content generation, in U.S. dollars */
+                cost: number;
+            };
+        };
+    }
+}
+
+type ActiveLearning = z.input<typeof ActiveLearning>;
+declare const ActiveLearning: _bpinternal_zui.ZodObject<{
+    enable: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodBoolean>;
+    tableName: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodString>;
+    taskId: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodString>;
+}, "strip", _bpinternal_zui.ZodTypeAny, {
+    tableName?: string;
+    taskId?: string;
+    enable?: boolean;
+}, {
+    tableName?: string;
+    taskId?: string;
+    enable?: boolean;
+}>;
+type ZaiConfig = z.input<typeof ZaiConfig>;
+declare const ZaiConfig: _bpinternal_zui.ZodObject<{
+    client: z.Schema<any, _bpinternal_zui.ZodTypeDef, any>;
+    userId: _bpinternal_zui.ZodOptional<_bpinternal_zui.ZodString>;
+    retry: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodObject<{
+        maxRetries: _bpinternal_zui.ZodNumber;
+    }, "strip", _bpinternal_zui.ZodTypeAny, {
+        maxRetries?: number;
+    }, {
+        maxRetries?: number;
+    }>>;
+    modelId: _bpinternal_zui.ZodDefault<z.Schema<string, _bpinternal_zui.ZodTypeDef, string>>;
+    activeLearning: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodObject<{
+        enable: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodBoolean>;
+        tableName: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodString>;
+        taskId: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodString>;
+    }, "strip", _bpinternal_zui.ZodTypeAny, {
+        tableName?: string;
+        taskId?: string;
+        enable?: boolean;
+    }, {
+        tableName?: string;
+        taskId?: string;
+        enable?: boolean;
+    }>>;
+    namespace: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodString>;
+}, "strip", _bpinternal_zui.ZodTypeAny, {
+    client?: any;
+    userId?: string;
+    retry?: {
+        maxRetries?: number;
+    };
+    modelId?: string;
+    activeLearning?: {
+        tableName?: string;
+        taskId?: string;
+        enable?: boolean;
+    };
+    namespace?: string;
+}, {
+    client?: any;
+    userId?: string;
+    retry?: {
+        maxRetries?: number;
+    };
+    modelId?: string;
+    activeLearning?: {
+        tableName?: string;
+        taskId?: string;
+        enable?: boolean;
+    };
+    namespace?: string;
+}>;
+declare class Zai {
+    protected static tokenizer: TextTokenizer;
+    protected client: Client;
+    private originalConfig;
+    private userId;
+    private integration;
+    private model;
+    private retry;
+    protected Model: (typeof Models)[number];
+    protected namespace: string;
+    protected adapter: Adapter;
+    protected activeLearning: ActiveLearning;
+    constructor(config: ZaiConfig);
+    /** @internal */
+    protected callModel(props: Partial<llm.generateContent.Input>): Promise<llm.generateContent.Output & {
+        metadata: GenerationMetadata;
+    }>;
+    /** @internal */
+    private _callModel;
+    protected getTokenizer(): Promise<TextTokenizer>;
+    protected get taskId(): string;
+    with(options: Partial<ZaiConfig>): Zai;
+    learn(taskId: string): Zai;
+}
+
+type Options$6 = z.input<typeof Options$6>;
+declare const Options$6: _bpinternal_zui.ZodObject<{
+    length: _bpinternal_zui.ZodOptional<_bpinternal_zui.ZodNumber>;
+}, "strip", _bpinternal_zui.ZodTypeAny, {
+    length?: number;
+}, {
+    length?: number;
+}>;
+declare module '@botpress/zai' {
+    interface Zai {
+        /** Generates a text of the desired length according to the prompt */
+        text(prompt: string, options?: Options$6): Promise<string>;
+    }
+}
+
+type Options$5 = z.input<typeof Options$5>;
+declare const Options$5: _bpinternal_zui.ZodObject<{
+    examples: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodArray<_bpinternal_zui.ZodObject<{
+        input: _bpinternal_zui.ZodString;
+        output: _bpinternal_zui.ZodString;
+    }, "strip", _bpinternal_zui.ZodTypeAny, {
+        input?: string;
+        output?: string;
+    }, {
+        input?: string;
+        output?: string;
+    }>, "many">>;
+    length: _bpinternal_zui.ZodOptional<_bpinternal_zui.ZodNumber>;
+}, "strip", _bpinternal_zui.ZodTypeAny, {
+    length?: number;
+    examples?: {
+        input?: string;
+        output?: string;
+    }[];
+}, {
+    length?: number;
+    examples?: {
+        input?: string;
+        output?: string;
+    }[];
+}>;
+declare module '@botpress/zai' {
+    interface Zai {
+        /** Rewrites a string according to match the prompt */
+        rewrite(original: string, prompt: string, options?: Options$5): Promise<string>;
+    }
+}
+
+type Options$4 = z.input<typeof Options$4>;
+declare const Options$4: _bpinternal_zui.ZodObject<{
+    prompt: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodString>;
+    format: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodString>;
+    length: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodNumber>;
+    intermediateFactor: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodNumber>;
+    maxIterations: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodNumber>;
+    sliding: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodObject<{
+        window: _bpinternal_zui.ZodNumber;
+        overlap: _bpinternal_zui.ZodNumber;
+    }, "strip", _bpinternal_zui.ZodTypeAny, {
+        window?: number;
+        overlap?: number;
+    }, {
+        window?: number;
+        overlap?: number;
+    }>>;
+}, "strip", _bpinternal_zui.ZodTypeAny, {
+    length?: number;
+    prompt?: string;
+    format?: string;
+    intermediateFactor?: number;
+    maxIterations?: number;
+    sliding?: {
+        window?: number;
+        overlap?: number;
+    };
+}, {
+    length?: number;
+    prompt?: string;
+    format?: string;
+    intermediateFactor?: number;
+    maxIterations?: number;
+    sliding?: {
+        window?: number;
+        overlap?: number;
+    };
+}>;
+declare module '@botpress/zai' {
+    interface Zai {
+        /** Summarizes a text of any length to a summary of the desired length */
+        summarize(original: string, options?: Options$4): Promise<string>;
+    }
+}
+
+type Options$3 = z.input<typeof Options$3>;
+declare const Options$3: _bpinternal_zui.ZodObject<{
+    examples: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodArray<_bpinternal_zui.ZodObject<{
+        input: _bpinternal_zui.ZodAny;
+        check: _bpinternal_zui.ZodBoolean;
+        reason: _bpinternal_zui.ZodOptional<_bpinternal_zui.ZodString>;
+    }, "strip", _bpinternal_zui.ZodTypeAny, {
+        input?: any;
+        check?: boolean;
+        reason?: string;
+    }, {
+        input?: any;
+        check?: boolean;
+        reason?: string;
+    }>, "many">>;
+}, "strip", _bpinternal_zui.ZodTypeAny, {
+    examples?: {
+        input?: any;
+        check?: boolean;
+        reason?: string;
+    }[];
+}, {
+    examples?: {
+        input?: any;
+        check?: boolean;
+        reason?: string;
+    }[];
+}>;
+declare module '@botpress/zai' {
+    interface Zai {
+        /** Checks wether a condition is true or not */
+        check(input: unknown, condition: string, options?: Options$3): Promise<boolean>;
+    }
+}
+
+type Options$2 = z.input<typeof Options$2>;
+declare const Options$2: _bpinternal_zui.ZodObject<{
+    tokensPerItem: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodOptional<_bpinternal_zui.ZodNumber>>;
+    examples: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodArray<_bpinternal_zui.ZodObject<{
+        input: _bpinternal_zui.ZodAny;
+        filter: _bpinternal_zui.ZodBoolean;
+        reason: _bpinternal_zui.ZodOptional<_bpinternal_zui.ZodString>;
+    }, "strip", _bpinternal_zui.ZodTypeAny, {
+        input?: any;
+        filter?: boolean;
+        reason?: string;
+    }, {
+        input?: any;
+        filter?: boolean;
+        reason?: string;
+    }>, "many">>;
+}, "strip", _bpinternal_zui.ZodTypeAny, {
+    examples?: {
+        input?: any;
+        filter?: boolean;
+        reason?: string;
+    }[];
+    tokensPerItem?: number;
+}, {
+    examples?: {
+        input?: any;
+        filter?: boolean;
+        reason?: string;
+    }[];
+    tokensPerItem?: number;
+}>;
+declare module '@botpress/zai' {
+    interface Zai {
+        /** Filters elements of an array against a condition */
+        filter<T>(input: Array<T>, condition: string, options?: Options$2): Promise<Array<T>>;
+    }
+}
+
+type Options$1 = z.input<typeof Options$1>;
+declare const Options$1: _bpinternal_zui.ZodObject<{
+    instructions: _bpinternal_zui.ZodOptional<_bpinternal_zui.ZodString>;
+    chunkLength: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodOptional<_bpinternal_zui.ZodNumber>>;
+}, "strip", _bpinternal_zui.ZodTypeAny, {
+    instructions?: string;
+    chunkLength?: number;
+}, {
+    instructions?: string;
+    chunkLength?: number;
+}>;
+declare module '@botpress/zai' {
+    interface Zai {
+        /** Extracts one or many elements from an arbitrary input */
+        extract<S extends z.AnyZodObject>(input: unknown, schema: S, options?: Options$1): Promise<z.infer<S>>;
+        extract<S extends z.AnyZodObject>(input: unknown, schema: z.ZodArray<S>, options?: Options$1): Promise<Array<z.infer<S>>>;
+    }
+}
+
+type Label = keyof typeof LABELS;
+declare const LABELS: {
+    readonly ABSOLUTELY_NOT: "ABSOLUTELY_NOT";
+    readonly PROBABLY_NOT: "PROBABLY_NOT";
+    readonly AMBIGUOUS: "AMBIGUOUS";
+    readonly PROBABLY_YES: "PROBABLY_YES";
+    readonly ABSOLUTELY_YES: "ABSOLUTELY_YES";
+};
+type Example<T extends string> = {
+    input: unknown;
+    labels: Partial<Record<T, {
+        label: Label;
+        explanation?: string;
+    }>>;
+};
+type Options<T extends string> = Omit<z.input<typeof Options>, 'examples'> & {
+    examples?: Array<Partial<Example<T>>>;
+};
+declare const Options: _bpinternal_zui.ZodObject<{
+    examples: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodArray<_bpinternal_zui.ZodObject<{
+        input: _bpinternal_zui.ZodAny;
+        labels: _bpinternal_zui.ZodRecord<_bpinternal_zui.ZodString, _bpinternal_zui.ZodObject<{
+            label: _bpinternal_zui.ZodEnum<never>;
+            explanation: _bpinternal_zui.ZodOptional<_bpinternal_zui.ZodString>;
+        }, "strip", _bpinternal_zui.ZodTypeAny, {
+            label: never;
+            explanation?: string;
+        }, {
+            label: never;
+            explanation?: string;
+        }>>;
+    }, "strip", _bpinternal_zui.ZodTypeAny, {
+        input?: any;
+        labels?: Record<string, {
+            label: never;
+            explanation?: string;
+        }>;
+    }, {
+        input?: any;
+        labels?: Record<string, {
+            label: never;
+            explanation?: string;
+        }>;
+    }>, "many">>;
+    instructions: _bpinternal_zui.ZodOptional<_bpinternal_zui.ZodString>;
+    chunkLength: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodOptional<_bpinternal_zui.ZodNumber>>;
+}, "strip", _bpinternal_zui.ZodTypeAny, {
+    instructions?: string;
+    examples?: {
+        input?: any;
+        labels?: Record<string, {
+            label: never;
+            explanation?: string;
+        }>;
+    }[];
+    chunkLength?: number;
+}, {
+    instructions?: string;
+    examples?: {
+        input?: any;
+        labels?: Record<string, {
+            label: never;
+            explanation?: string;
+        }>;
+    }[];
+    chunkLength?: number;
+}>;
+type Labels<T extends string> = Record<T, string>;
+declare const Labels: z.ZodTransformer<_bpinternal_zui.ZodRecord<_bpinternal_zui.ZodString, _bpinternal_zui.ZodString>, Record<string, string>, Record<string, string>>;
+declare module '@botpress/zai' {
+    interface Zai {
+        /** Tags the provided input with a list of predefined labels */
+        label<T extends string>(input: unknown, labels: Labels<T>, options?: Options<T>): Promise<{
+            [K in T]: boolean;
+        }>;
+    }
+}
+
+export { Zai };