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

package/src/models.d.ts

@@ -0,0 +1,351 @@
+export 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;
+    };
+}];

package/src/operations/__tests/index.d.ts

@@ -0,0 +1,20 @@
+import { Client } from '@botpress/client';
+import { type TextTokenizer } from '@botpress/wasm';
+import { Zai } from '../..';
+export declare const getClient: () => Client;
+export declare const getCachedClient: () => Client;
+export declare const getZai: () => Zai;
+export declare let tokenizer: TextTokenizer;
+export declare const BotpressDocumentation: string;
+export declare const metadata: {
+    cost: {
+        input: number;
+        output: number;
+    };
+    latency: number;
+    model: string;
+    tokens: {
+        input: number;
+        output: number;
+    };
+};

package/src/operations/check.d.ts

@@ -0,0 +1,36 @@
+import { z } from '@bpinternal/zui';
+export type Options = z.input<typeof Options>;
+declare const Options: import("@bpinternal/zui").ZodObject<{
+    examples: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodArray<import("@bpinternal/zui").ZodObject<{
+        input: import("@bpinternal/zui").ZodAny;
+        check: import("@bpinternal/zui").ZodBoolean;
+        reason: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+    }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+        input?: any;
+        check?: boolean;
+        reason?: string;
+    }, {
+        input?: any;
+        check?: boolean;
+        reason?: string;
+    }>, "many">>;
+}, "strip", import("@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): Promise<boolean>;
+    }
+}
+export {};

package/src/operations/check.test.d.ts

@@ -0,0 +1 @@
+export {};

package/src/operations/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const PROMPT_INPUT_BUFFER = 1048;
+export declare const PROMPT_OUTPUT_BUFFER = 512;

package/src/operations/errors.d.ts

@@ -0,0 +1,5 @@
+export declare class JsonParsingError extends Error {
+    json: unknown;
+    error: Error;
+    constructor(json: unknown, error: Error);
+}

package/src/operations/extract.d.ts

@@ -0,0 +1,20 @@
+import { z } from '@bpinternal/zui';
+export type Options = z.input<typeof Options>;
+declare const Options: import("@bpinternal/zui").ZodObject<{
+    instructions: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+    chunkLength: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodNumber>>;
+}, "strip", import("@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): Promise<z.infer<S>>;
+        extract<S extends z.AnyZodObject>(input: unknown, schema: z.ZodArray<S>, options?: Options): Promise<Array<z.infer<S>>>;
+    }
+}
+export {};

package/src/operations/extract.test.d.ts

@@ -0,0 +1 @@
+export {};

package/src/operations/filter.d.ts

@@ -0,0 +1,39 @@
+import { z } from '@bpinternal/zui';
+export type Options = z.input<typeof Options>;
+declare const Options: import("@bpinternal/zui").ZodObject<{
+    tokensPerItem: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodNumber>>;
+    examples: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodArray<import("@bpinternal/zui").ZodObject<{
+        input: import("@bpinternal/zui").ZodAny;
+        filter: import("@bpinternal/zui").ZodBoolean;
+        reason: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+    }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+        input?: any;
+        filter?: boolean;
+        reason?: string;
+    }, {
+        input?: any;
+        filter?: boolean;
+        reason?: string;
+    }>, "many">>;
+}, "strip", import("@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): Promise<Array<T>>;
+    }
+}
+export {};

package/src/operations/filter.test.d.ts

@@ -0,0 +1 @@
+export {};

package/src/operations/label.d.ts

@@ -0,0 +1,79 @@
+import { z } from '@bpinternal/zui';
+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;
+    }>>;
+};
+export type Options<T extends string> = Omit<z.input<typeof Options>, 'examples'> & {
+    examples?: Array<Partial<Example<T>>>;
+};
+declare const Options: import("@bpinternal/zui").ZodObject<{
+    examples: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodArray<import("@bpinternal/zui").ZodObject<{
+        input: import("@bpinternal/zui").ZodAny;
+        labels: import("@bpinternal/zui").ZodRecord<import("@bpinternal/zui").ZodString, import("@bpinternal/zui").ZodObject<{
+            label: import("@bpinternal/zui").ZodEnum<never>;
+            explanation: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+        }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+            label: never;
+            explanation?: string;
+        }, {
+            label: never;
+            explanation?: string;
+        }>>;
+    }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+        input?: any;
+        labels?: Record<string, {
+            label: never;
+            explanation?: string;
+        }>;
+    }, {
+        input?: any;
+        labels?: Record<string, {
+            label: never;
+            explanation?: string;
+        }>;
+    }>, "many">>;
+    instructions: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+    chunkLength: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodNumber>>;
+}, "strip", import("@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<import("@bpinternal/zui").ZodRecord<import("@bpinternal/zui").ZodString, import("@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 {};

package/src/operations/label.test.d.ts

@@ -0,0 +1 @@
+export {};

package/src/operations/rewrite.d.ts

@@ -0,0 +1,34 @@
+import { z } from '@bpinternal/zui';
+export type Options = z.input<typeof Options>;
+declare const Options: import("@bpinternal/zui").ZodObject<{
+    examples: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodArray<import("@bpinternal/zui").ZodObject<{
+        input: import("@bpinternal/zui").ZodString;
+        output: import("@bpinternal/zui").ZodString;
+    }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+        input?: string;
+        output?: string;
+    }, {
+        input?: string;
+        output?: string;
+    }>, "many">>;
+    length: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodNumber>;
+}, "strip", import("@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): Promise<string>;
+    }
+}
+export {};

package/src/operations/rewrite.test.d.ts

@@ -0,0 +1 @@
+export {};

package/src/operations/summarize.d.ts

@@ -0,0 +1,46 @@
+import { z } from '@bpinternal/zui';
+export type Options = z.input<typeof Options>;
+declare const Options: import("@bpinternal/zui").ZodObject<{
+    prompt: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodString>;
+    format: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodString>;
+    length: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodNumber>;
+    intermediateFactor: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodNumber>;
+    maxIterations: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodNumber>;
+    sliding: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodObject<{
+        window: import("@bpinternal/zui").ZodNumber;
+        overlap: import("@bpinternal/zui").ZodNumber;
+    }, "strip", import("@bpinternal/zui").ZodTypeAny, {
+        window?: number;
+        overlap?: number;
+    }, {
+        window?: number;
+        overlap?: number;
+    }>>;
+}, "strip", import("@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): Promise<string>;
+    }
+}
+export {};

package/src/operations/summarize.test.d.ts

@@ -0,0 +1 @@
+export {};

package/src/operations/text.d.ts

@@ -0,0 +1,16 @@
+import { z } from '@bpinternal/zui';
+export type Options = z.input<typeof Options>;
+declare const Options: import("@bpinternal/zui").ZodObject<{
+    length: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodNumber>;
+}, "strip", import("@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): Promise<string>;
+    }
+}
+export {};

package/src/operations/text.test.d.ts

@@ -0,0 +1 @@
+export {};

package/src/operations/zai-learn.test.d.ts

@@ -0,0 +1 @@
+export {};

package/src/operations/zai-retry.test.d.ts

@@ -0,0 +1 @@
+export {};