@botpress/vai 0.0.1-beta.1

package/dist/index.d.ts

@@ -0,0 +1,473 @@
+import * as _botpress_sdk from '@botpress/sdk';
+import { z } from '@botpress/sdk';
+import { TestFunction } from 'vitest';
+import { Client } from '@botpress/client';
+
+type ScenarioLike = z.infer<typeof ScenarioLike>;
+declare const ScenarioLike: _botpress_sdk.ZodUnion<[_botpress_sdk.ZodString, _botpress_sdk.ZodObject<{
+    name: _botpress_sdk.ZodString;
+}, "passthrough", _botpress_sdk.ZodTypeAny, _botpress_sdk.objectOutputType<{
+    name: _botpress_sdk.ZodString;
+}, _botpress_sdk.ZodTypeAny, "passthrough">, _botpress_sdk.objectInputType<{
+    name: _botpress_sdk.ZodString;
+}, _botpress_sdk.ZodTypeAny, "passthrough">>, _botpress_sdk.ZodObject<{
+    id: _botpress_sdk.ZodString;
+}, "passthrough", _botpress_sdk.ZodTypeAny, _botpress_sdk.objectOutputType<{
+    id: _botpress_sdk.ZodString;
+}, _botpress_sdk.ZodTypeAny, "passthrough">, _botpress_sdk.objectInputType<{
+    id: _botpress_sdk.ZodString;
+}, _botpress_sdk.ZodTypeAny, "passthrough">>]>;
+declare function compare<T extends ReadonlyArray<ScenarioLike>>(name: string | Function, scenarios: T, fn?: TestFunction<{
+    scenario: T[number];
+}>): void;
+
+type Input = z.infer<typeof Input>;
+declare const Input: _botpress_sdk.ZodUnion<[_botpress_sdk.ZodUnion<[_botpress_sdk.ZodString, z.ZodTransformer<_botpress_sdk.ZodObject<{}, "passthrough", _botpress_sdk.ZodTypeAny, _botpress_sdk.objectOutputType<{}, _botpress_sdk.ZodTypeAny, "passthrough">, _botpress_sdk.objectInputType<{}, _botpress_sdk.ZodTypeAny, "passthrough">>, _botpress_sdk.objectOutputType<{}, _botpress_sdk.ZodTypeAny, "passthrough">, _botpress_sdk.objectInputType<{}, _botpress_sdk.ZodTypeAny, "passthrough">>]>, _botpress_sdk.ZodArray<_botpress_sdk.ZodAny, "many">]>;
+type Output<T = any> = z.infer<typeof Output> & {
+    result: T;
+};
+declare const Output: _botpress_sdk.ZodObject<{
+    reason: _botpress_sdk.ZodString;
+    result: _botpress_sdk.ZodAny;
+}, "strip", _botpress_sdk.ZodTypeAny, {
+    reason: string;
+    result?: any;
+}, {
+    reason: string;
+    result?: any;
+}>;
+
+declare class AsyncExpectError<T> extends Error {
+    readonly output: Output<T>;
+    constructor(message: string, output: Output<T>);
+}
+
+type CheckOptions<T> = {
+    examples?: {
+        value: T;
+        expected: boolean;
+        reason: string;
+    }[];
+};
+declare function check<T extends Input>(value: T, condition: string, options?: CheckOptions<T>): {
+    toBe: (expected: boolean) => Promise<Output<boolean> | AsyncExpectError<boolean>>;
+    toMatchInlineSnapshot: (expected?: string) => Promise<void | Output<boolean> | AsyncExpectError<boolean>>;
+    then<TResult1 = Output<boolean>, TResult2 = never>(onfulfilled?: ((value: Output<boolean>) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): PromiseLike<TResult1 | TResult2>;
+    value: PromiseLike<boolean>;
+};
+
+type ExtractOptions<T, S> = {
+    description?: string;
+    examples?: {
+        value: T;
+        extracted: S;
+        reason: string;
+    }[];
+};
+declare function extract<T extends Input, S extends z.AnyZodObject>(value: T, shape: S, options?: ExtractOptions<T, z.infer<S>>): {
+    toBe: (expected: z.infer<S>) => Promise<Output<z.infer<S>> | AsyncExpectError<z.infer<S>>>;
+    toMatchObject: (expected: Partial<z.infer<S>>) => Promise<Output<z.infer<S>> | AsyncExpectError<z.infer<S>>>;
+    toMatchInlineSnapshot: (expected?: string) => Promise<void | Output<z.infer<S>> | AsyncExpectError<z.infer<S>>>;
+    then<TResult1 = Output<z.infer<S>>, TResult2 = never>(onfulfilled?: ((value: Output<z.infer<S>>) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): PromiseLike<TResult1 | TResult2>;
+    value: PromiseLike<z.infer<S>>;
+};
+
+type FilterOptions<T> = {
+    examples?: {
+        value: T;
+        reason: string;
+        keep: boolean;
+    }[];
+};
+declare function filter<U>(values: U[], condition: string, options?: FilterOptions<U>): {
+    toBe: (expected: U[]) => Promise<Output<U[]> | AsyncExpectError<U[]>>;
+    toMatchInlineSnapshot: (expected?: string) => Promise<void | Output<U[]> | AsyncExpectError<U[]>>;
+    toHaveNoneFiltered: () => Promise<Output<U[]> | AsyncExpectError<U[]>>;
+    toHaveSomeFiltered: () => Promise<Output<U[]> | AsyncExpectError<U[]>>;
+    toBeEmpty: () => Promise<Output<U[]> | AsyncExpectError<U[]>>;
+    length: {
+        toBe: (expected: number) => Promise<Output<U[]> | AsyncExpectError<U[]>>;
+        toBeGreaterThanOrEqual: (expected: number) => Promise<Output<U[]> | AsyncExpectError<U[]>>;
+        toBeLessThanOrEqual: (expected: number) => Promise<Output<U[]> | AsyncExpectError<U[]>>;
+        toBeBetween: (min: number, max: number) => Promise<Output<U[]> | AsyncExpectError<U[]>>;
+    };
+    then<TResult1 = Output<U[]>, TResult2 = never>(onfulfilled?: ((value: Output<U[]>) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): PromiseLike<TResult1 | TResult2>;
+    value: PromiseLike<U[]>;
+};
+
+type RatingScore = 1 | 2 | 3 | 4 | 5;
+type RateOptions<T> = {
+    examples?: {
+        value: T;
+        rating: number;
+        reason: string;
+    }[];
+};
+declare function rate<T extends Input>(value: T, condition: string, options?: RateOptions<T>): {
+    toBe: (expected: number) => Promise<Output<number> | AsyncExpectError<number>>;
+    toMatchInlineSnapshot: (expected?: string) => Promise<void | Output<number> | AsyncExpectError<number>>;
+    toBeGreaterThanOrEqual: (expected: RatingScore) => Promise<Output<number> | AsyncExpectError<number>>;
+    toBeLessThanOrEqual: (expected: RatingScore) => Promise<Output<number> | AsyncExpectError<number>>;
+    then<TResult1 = Output<number>, TResult2 = never>(onfulfilled?: ((value: Output<number>) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): PromiseLike<TResult1 | TResult2>;
+    value: PromiseLike<number>;
+};
+
+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;
+    };
+}];
+
+type EvaluatorModel = (typeof Models)[number]['id'];
+
+declare const setEvaluator: (model: EvaluatorModel) => void;
+
+declare const setupClient: (client: Client) => void;
+
+export { check, compare, extract, filter, rate, setEvaluator, setupClient };