@botpress/zai 1.0.0-beta.2 → 1.0.0-beta.3

package/dist/src/operations/rewrite.test.js

@@ -1,96 +0,0 @@
-import { describe, it, expect, beforeEach, afterEach, afterAll } from 'vitest';
-import { check } from '@botpress/vai';
-import { getClient, getZai, metadata, tokenizer } from './__tests';
-import { TableAdapter } from '../adapters/botpress-table';
-const Zoe = `
-Part 1. Zoe walks to the park.
-Part 2. She meets her friend.
-Part 3. They play together.
-Part 4. They have a picnic.
-Part 5. They go home.
-`.trim();
-describe('zai.rewrite', { timeout: 60_000 }, () => {
-    const zai = getZai();
-    it('transforms text to all caps', async () => {
-        const result = await zai.rewrite(`Hello, what is the time today?`, 'write in all caps');
-        expect(result).toBe(`HELLO, WHAT IS THE TIME TODAY?`);
-    });
-    it('transforms text to all caps and respects tokens restrictions', async () => {
-        const result = await zai.rewrite(Zoe, 'write in all caps', { length: 15 });
-        expect(tokenizer.count(result)).toBeLessThanOrEqual(20);
-        expect(result).toContain(`PART 1. ZOE WALKS TO THE PARK`);
-        expect(result).not.toContain(`PART 3`);
-    });
-    it('french translation of the story', async () => {
-        const result = await zai.rewrite(Zoe, 'translate to french');
-        check(result, 'is a french story about Zeo and with 5 parts').toBe(true);
-    });
-    it('Throws if input is bigger than the model max tokens', async () => {
-        await expect(zai.rewrite(Zoe.repeat(100_000), 'translate to french')).rejects.toThrow(/tokens/i);
-    });
-});
-describe('zai.learn.rewrite', { timeout: 60_000 }, () => {
-    const client = getClient();
-    let tableName = 'ZaiTestRewriteInternalTable';
-    let taskId = 'rewrite';
-    let zai = getZai();
-    beforeEach(async () => {
-        zai = getZai().with({
-            activeLearning: {
-                enable: true,
-                taskId,
-                tableName
-            }
-        });
-    });
-    afterEach(async () => {
-        try {
-            await client.deleteTableRows({ table: tableName, deleteAllRows: true });
-        }
-        catch (err) { }
-    });
-    afterAll(async () => {
-        try {
-            await client.deleteTable({ table: tableName });
-        }
-        catch (err) { }
-    });
-    it('learns rewrite rules from examples', async () => {
-        const adapter = new TableAdapter({
-            client,
-            tableName
-        });
-        const value = await zai.learn(taskId).rewrite(`Botpress is awesome`, 'write it like we want it');
-        check(value, `The text means more or less the same as "Botpress is awesome" but slightly different`).toBe(true);
-        let rows = await client.findTableRows({ table: tableName });
-        expect(rows.rows.length).toBe(1);
-        expect(rows.rows[0].output.value).toBe(value);
-        await adapter.saveExample({
-            key: 't1',
-            taskId: `zai/${taskId}`,
-            taskType: 'zai.rewrite',
-            instructions: 'write it like we want it',
-            input: 'Microsoft is a big company',
-            output: `# MICROSOFT IS A BIG COMPANY`,
-            metadata,
-            status: 'approved'
-        });
-        await adapter.saveExample({
-            key: 't2',
-            taskId: `zai/${taskId}`,
-            taskType: 'zai.rewrite',
-            instructions: 'write it like we want it',
-            input: 'Google is an evil company',
-            output: `# GOOGLE IS AN EVIL COMPANY`,
-            metadata,
-            status: 'approved'
-        });
-        const second = await zai.learn(taskId).rewrite(`Botpress is awesome`, 'write it like we want it');
-        rows = await client.findTableRows({ table: tableName });
-        expect(rows.rows.length).toBe(3);
-        check(second, `The text is "BOTPRESS IS AWESOME" and starts with a hashtag`).toBe(true);
-        expect(rows.rows.length).toBe(3);
-        expect(rows.rows[0].output.value).toBe(second);
-    });
-});
-//# sourceMappingURL=rewrite.test.js.map

package/dist/src/operations/summarize.test.js

@@ -1,22 +0,0 @@
-import { check } from '@botpress/vai';
-import { describe, it } from 'vitest';
-import { BotpressDocumentation, getZai } from './__tests';
-describe('zai.summarize', () => {
-    const zai = getZai();
-    it.skip('summarize long document to a concise 2000 token summary', async () => {
-        const result = await zai.summarize(BotpressDocumentation, {
-            length: 2000,
-            prompt: `Extract the Table of Contents for the Botpress Documentation. Pay special attention to all the different features. Focus on horizontal coverage of features rather than going in depth into one feature. The goal is to have a complete overview of what the documentation covers.`
-        });
-        check(result, 'The text is a summary of the Botpress documentation').toBe(true);
-        check(result, 'The text explains shortly what botpress is').toBe(true);
-        check(result, 'The text uses markdown format').toBe(true);
-        check(result, 'The text has some information about integrations').toBe(true);
-        check(result, 'The text has a section about Flows (or Workflows)').toBe(true);
-        check(result, 'The text has a section about the Botpress API').toBe(true);
-        check(result, 'The text mentions the notion of workspaces').toBe(true);
-        check(result, 'The text has some information about the Webchat').toBe(true);
-        check(result, 'The text has some information about HITL (human in the loop)').toBe(true);
-    });
-});
-//# sourceMappingURL=summarize.test.js.map

package/dist/src/operations/text.test.js

@@ -1,51 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { check } from '@botpress/vai';
-import { getZai, tokenizer } from './__tests';
-describe('zai.text', { timeout: 60_000 }, () => {
-    const zai = getZai();
-    it('generate a horror novel with no params', async () => {
-        const story = await zai.text('write a short horror novel');
-        check(story, 'is a short horror story').toBe(true);
-    });
-    it('No fluffy text at the beginning', async () => {
-        const story = await zai.text('write a short horror novel');
-        check(story, 'There is no LLM fluff at the beginning', {
-            examples: [
-                {
-                    value: 'Title: A horror story\nChapter 1: The woods\nOnce upen a time, ...',
-                    expected: true,
-                    reason: 'It begins straight with a story, no fluff at the beginning'
-                },
-                { value: 'Once upon a time, a ...', expected: true, reason: 'The story starts directly' },
-                {
-                    value: 'Sure, I will generate a story.\nOnce upen a time, a...',
-                    expected: false,
-                    reason: 'There is some fluff at the beginning'
-                }
-            ]
-        }).toBe(true);
-    });
-    it('No fluffy text at the end', async () => {
-        const story = await zai.text('write a short horror novel');
-        check(story, 'There is no LLM fluff at the end', {
-            examples: [
-                {
-                    value: 'Title: A horror story\nChapter 1: The woods\nOnce upen a time, ... The End.',
-                    expected: true,
-                    reason: 'The end is clear and direct, no fluff at the end'
-                },
-                {
-                    value: 'Sure, I will generate a story.\nOnce upen a time, a... The End.\nLet me know if you want more or if you are happy with this.',
-                    expected: false,
-                    reason: 'There is some fluff from the assistant at the end.'
-                }
-            ]
-        }).toBe(true);
-    });
-    it('length/max tokens param', async () => {
-        const story = await zai.text('write a short but complete horror story (with conclusion)', { length: 100 });
-        expect(tokenizer.count(story)).toBeLessThanOrEqual(110);
-        check(story, 'could be the beginning of a horror story').toBe(true);
-    });
-});
-//# sourceMappingURL=text.test.js.map

package/dist/src/operations/zai-learn.test.js

@@ -1,71 +0,0 @@
-import { describe, it, expect, afterAll, beforeEach, afterEach, vi } from 'vitest';
-import { getClient, getZai } from './__tests';
-import { check } from '@botpress/vai';
-describe('zai.learn / generic', { timeout: 60_000 }, () => {
-    const client = getClient();
-    let tableName = 'ZaiTestInternalTable';
-    let taskId = 'test';
-    let zai = getZai();
-    beforeEach(async () => {
-        zai = getZai().with({
-            activeLearning: {
-                enable: true,
-                taskId,
-                tableName
-            }
-        });
-    });
-    afterEach(async () => {
-        try {
-            await client.deleteTableRows({ table: tableName, deleteAllRows: true });
-        }
-        catch (err) { }
-    });
-    afterAll(async () => {
-        try {
-            await client.deleteTable({ table: tableName });
-        }
-        catch (err) { }
-    });
-    it('saves examples to tables', async () => {
-        const value = await zai
-            .learn(taskId)
-            .check('This text is very clearly written in English.', 'is an english sentence');
-        const { rows } = await client.findTableRows({ table: tableName });
-        expect(value).toBe(true);
-        expect(rows.length).toBe(1);
-        check(rows[0].explanation, 'is an explanation sentence');
-        expect(rows[0].explanation).not.toContain('Final Answer:');
-        expect(rows[0].output).toMatchObject({ value: true });
-        expect(rows[0].input).toMatchInlineSnapshot(`
-      {
-        "value": "This text is very clearly written in English.",
-      }
-    `);
-        expect(rows[0].taskId).toEqual('zai/test');
-        expect(rows[0].taskType).toBe('zai.check');
-    });
-    it('works even if tables are down', async () => {
-        const upsertTableRows = vi.fn(async () => {
-            throw new Error('Table is down');
-        });
-        const findTableRows = vi.fn(async () => {
-            throw new Error('Table is down');
-        });
-        const client = {
-            ...getClient(),
-            findTableRows,
-            upsertTableRows
-        };
-        const value = await zai
-            .with({ client })
-            .learn(taskId)
-            .check('This text is very clearly written in English.', 'is an english sentence');
-        const { rows } = await getClient().findTableRows({ table: tableName });
-        expect(value).toBe(true);
-        expect(rows.length).toBe(0);
-        expect(upsertTableRows).toHaveBeenCalledTimes(1);
-        expect(findTableRows).toHaveBeenCalledTimes(1);
-    });
-});
-//# sourceMappingURL=zai-learn.test.js.map

package/dist/src/operations/zai-retry.test.js

@@ -1,50 +0,0 @@
-import { describe, it, expect, vi } from 'vitest';
-import { getClient, getZai } from './__tests';
-describe('zai retry', { timeout: 60_000 }, () => {
-    const client = getClient();
-    let zai = getZai().with({ retry: { maxRetries: 3 } });
-    it('retries 3 times and succeeds', async () => {
-        let retryCount = 0;
-        const throwingClient = {
-            ...client,
-            callAction: vi.fn((input) => {
-                if (++retryCount < 3) {
-                    throw new Error('Failed to call model');
-                }
-                return client.callAction(input);
-            })
-        };
-        const value = await zai
-            .with({ client: throwingClient })
-            .check('This text is very clearly written in English.', 'is an english sentence');
-        expect(value).toBe(true);
-        expect(retryCount).toBe(3);
-    });
-    it('retries 0 times when success', async () => {
-        const fn = vi.fn((input) => client.callAction(input));
-        const throwingClient = {
-            ...client,
-            callAction: fn
-        };
-        const value = await zai
-            .with({ client: throwingClient })
-            .check('This text is very clearly written in English.', 'is an english sentence');
-        expect(value).toBe(true);
-        expect(fn).toHaveBeenCalledOnce();
-    });
-    it('fails when exceeded max', async () => {
-        const fn = vi.fn(() => {
-            throw new Error('Failed to call model');
-        });
-        const throwingClient = {
-            ...client,
-            callAction: fn
-        };
-        const value = zai
-            .with({ client: throwingClient, retry: { maxRetries: 1 } })
-            .check('This text is very clearly written in English.', 'is an english sentence');
-        await expect(value).rejects.toThrowError(/retries/);
-        expect(fn).toHaveBeenCalledTimes(2);
-    });
-});
-//# sourceMappingURL=zai-retry.test.js.map

package/src/adapters/adapter.ts

@@ -1,35 +0,0 @@
-import { GenerationMetadata } from '../utils'
-
-export type SaveExampleProps<TInput, TOutput> = {
-  key: string
-  taskType: string
-  taskId: string
-  instructions: string
-  input: TInput
-  output: TOutput
-  explanation?: string
-  metadata: GenerationMetadata
-  status?: 'pending' | 'approved'
-}
-
-export type GetExamplesProps<TInput> = {
-  taskType: string
-  taskId: string
-  input: TInput
-}
-
-export 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>
-}

package/src/adapters/botpress-table.ts

@@ -1,213 +0,0 @@
-import { type Client } from '@botpress/client'
-import { z } from '@bpinternal/zui'
-
-import { BotpressClient, GenerationMetadata } from '../utils'
-import { Adapter, GetExamplesProps, SaveExampleProps } from './adapter'
-
-const CRITICAL_TAGS = {
-  system: 'true',
-  'schema-purpose': 'active-learning',
-  'schema-version': 'Oct-2024'
-} as const
-
-const OPTIONAL_TAGS = {
-  'x-studio-title': 'Active Learning',
-  'x-studio-description': 'Table for storing active learning tasks and examples',
-  'x-studio-readonly': 'true',
-  'x-studio-icon': 'lucide://atom',
-  'x-studio-color': 'green'
-} as const
-
-const FACTOR = 30
-
-const Props = z.object({
-  client: BotpressClient,
-  tableName: z
-    .string()
-    .regex(
-      /^[a-zA-Z0-9_]{1,45}Table$/,
-      'Table name must be lowercase and contain only letters, numbers and underscores'
-    )
-})
-
-export type TableSchema = z.input<typeof TableSchema>
-const TableSchema = z.object({
-  taskType: z.string().describe('The type of the task (filter, extract, etc.)'),
-  taskId: z.string(),
-  key: z.string().describe('A unique key for the task (e.g. a hash of the input, taskId, taskType and instructions)'),
-  instructions: z.string(),
-  input: z.object({}).passthrough().describe('The input to the task'),
-  output: z.object({}).passthrough().describe('The expected output'),
-  explanation: z.string().nullable(),
-  metadata: GenerationMetadata,
-  status: z.enum(['pending', 'rejected', 'approved']),
-  feedback: z
-    .object({
-      rating: z.enum(['very-bad', 'bad', 'good', 'very-good']),
-      comment: z.string().nullable()
-    })
-    .nullable()
-    .default(null)
-})
-
-const searchableColumns = ['input'] as const satisfies Array<keyof typeof TableSchema.shape> as string[]
-
-const TableJsonSchema = Object.entries(TableSchema.shape).reduce((acc, [key, value]) => {
-  acc[key] = value.toJsonSchema()
-  acc[key]['x-zui'] ??= {}
-  acc[key]['x-zui'].searchable = searchableColumns.includes(key)
-  return acc
-}, {})
-
-export class TableAdapter extends Adapter {
-  private client: Client
-  private tableName: string
-
-  private status: 'initialized' | 'ready' | 'error'
-  private errors = [] as string[]
-
-  constructor(props: z.input<typeof Props>) {
-    super()
-    props = Props.parse(props)
-    this.client = props.client
-    this.tableName = props.tableName
-    this.status = 'ready'
-  }
-
-  public async getExamples<TInput, TOutput>({ taskType, taskId, input }: GetExamplesProps<TInput>) {
-    await this.assertTableExists()
-
-    const { rows } = await this.client
-      .findTableRows({
-        table: this.tableName,
-        search: JSON.stringify({ value: input }).substring(0, 1023), // Search is limited to 1024 characters
-        limit: 10, // TODO
-        filter: {
-          // Proximity match of approved examples
-          taskType,
-          taskId,
-          status: 'approved'
-        } satisfies Partial<TableSchema>
-      })
-      .catch((err) => {
-        // TODO: handle error
-        console.error(`Error fetching examples: ${err.message}`)
-        return { rows: [] }
-      })
-
-    return rows.map((row) => ({
-      key: row.key,
-      input: row.input.value as TInput,
-      output: row.output.value as TOutput,
-      explanation: row.explanation,
-      similarity: row.similarity ?? 0
-    }))
-  }
-
-  public async saveExample<TInput, TOutput>({
-    key,
-    taskType,
-    taskId,
-    instructions,
-    input,
-    output,
-    explanation,
-    metadata,
-    status = 'pending'
-  }: SaveExampleProps<TInput, TOutput>) {
-    await this.assertTableExists()
-
-    await this.client
-      .upsertTableRows({
-        table: this.tableName,
-        keyColumn: 'key',
-        rows: [
-          {
-            key,
-            taskType,
-            taskId,
-            instructions,
-            input: { value: input },
-            output: { value: output },
-            explanation: explanation ?? null,
-            status,
-            metadata
-          } satisfies TableSchema
-        ]
-      })
-      .catch(() => {
-        // TODO: handle error
-      })
-  }
-
-  private async assertTableExists() {
-    if (this.status !== 'ready') {
-      return
-    }
-
-    const { table, created } = await this.client
-      .getOrCreateTable({
-        table: this.tableName,
-        factor: FACTOR,
-        frozen: true,
-        isComputeEnabled: false,
-        tags: {
-          ...CRITICAL_TAGS,
-          ...OPTIONAL_TAGS
-        },
-        schema: TableJsonSchema
-      })
-      .catch((err) => {
-        this.status = 'error'
-        this.errors = [err.message]
-        return { table: null, created: false }
-      })
-
-    if (!table) {
-      return
-    }
-
-    if (!created) {
-      const issues: string[] = []
-
-      if (table.factor !== FACTOR) {
-        issues.push(`Factor is ${table.factor} instead of ${FACTOR}`)
-      }
-
-      if (table.frozen !== true) {
-        issues.push('Table is not frozen')
-      }
-
-      for (const [key, value] of Object.entries(CRITICAL_TAGS)) {
-        if (table.tags?.[key] !== value) {
-          issues.push(`Tag ${key} is ${table.tags?.[key]} instead of ${value}`)
-        }
-      }
-
-      for (const key of Object.keys(TableJsonSchema)) {
-        const column = table.schema?.properties[key]
-        const expected = TableJsonSchema[key] as { type: string }
-
-        if (!column) {
-          issues.push(`Column ${key} is missing`)
-          continue
-        }
-
-        if (column.type !== expected.type) {
-          issues.push(`Column ${key} has type ${column.type} instead of ${expected.type}`)
-        }
-
-        if (expected['x-zui'].searchable && !column['x-zui'].searchable) {
-          issues.push(`Column ${key} is not searchable but should be`)
-        }
-      }
-
-      if (issues.length) {
-        this.status = 'error'
-        this.errors = issues
-      }
-    }
-
-    this.status = 'initialized'
-  }
-}

package/src/adapters/memory.ts

@@ -1,13 +0,0 @@
-import { Adapter } from './adapter'
-
-export class MemoryAdapter extends Adapter {
-  constructor(public examples: any[]) {
-    super()
-  }
-
-  async getExamples() {
-    return this.examples
-  }
-
-  async saveExample() {}
-}

package/src/env.ts

@@ -1,54 +0,0 @@
-import { z } from '@bpinternal/zui'
-import dotenv from 'dotenv'
-
-dotenv.config({ override: false })
-dotenv.populate(
-  process.env,
-  {
-    VITE_CLOUD_API_ENDPOINT: 'https://api.botpress.dev'
-  },
-  { override: false }
-)
-
-const envVariables = z.object({
-  CI: z.coerce.boolean().optional().describe('Indicates whether the tests are running in a CI environment'),
-  VITE_CLOUD_API_ENDPOINT: z.string(),
-  VITE_BOT_ID: z.string(),
-  VITE_CLOUD_PAT: z.string(),
-  // for CI
-  VITEST_CLOUD_PAT: z.string().optional(),
-  VITEST_BOT_ID: z.string().optional()
-})
-
-const result = envVariables.safeParse(process.env)
-
-if (!result.success) {
-  for (const error of result.error.errors) {
-    if (error.code === 'invalid_type') {
-      console.error(`Missing environment variable: ${error.path.join('.')}`)
-    } else {
-      console.error(error)
-    }
-  }
-}
-
-type Deprecated = Omit<
-  {
-    [key: string]: any
-  },
-  keyof z.infer<typeof envVariables>
->
-
-type AllEnv = z.infer<typeof envVariables> & Deprecated
-
-/** @internal */
-declare global {
-  namespace NodeJS {
-    interface ProcessEnv extends AllEnv {
-      /**  @deprecated please define your ENV variable in {@link env.ts} */
-      [key: keyof Deprecated]: any
-    }
-  }
-}
-
-export {}

package/src/index.ts

@@ -1,11 +0,0 @@
-import { Zai } from './zai'
-
-import './operations/text'
-import './operations/rewrite'
-import './operations/summarize'
-import './operations/check'
-import './operations/filter'
-import './operations/extract'
-import './operations/label'
-
-export { Zai }