@botpress/zai 2.0.3 → 2.0.5

package/dist/adapters/botpress-table.js

@@ -17,8 +17,8 @@ const FACTOR = 30;
 const Props = z.object({
   client: z.custom(() => true),
   tableName: z.string().regex(
-    /^[a-zA-Z0-9_]{1,45}Table$/,
-    "Table name must be lowercase and contain only letters, numbers and underscores"
+    /^[a-zA-Z0-9_]{1,45}Table$/i,
+    'Table name must be lowercase and contain only letters, numbers and underscores. It must also end with "Table". Example: "ActiveLearningTable"'
   )
 });
 const TableSchema = z.object({

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { z, ZodObject } from '@bpinternal/zui';
 import { Cognitive, Model, BotpressClientLike } from '@botpress/cognitive';
 import { TextTokenizer } from '@bpinternal/thicktoken';
 
-type GenerationMetadata = z.input<typeof GenerationMetadata>;
+type GenerationMetadata = (typeof GenerationMetadata)['_input'];
 declare const GenerationMetadata: _bpinternal_zui.ZodObject<{
     model: _bpinternal_zui.ZodString;
     cost: _bpinternal_zui.ZodObject<{
@@ -79,7 +79,7 @@ declare abstract class Adapter {
 }
 
 type ModelId = Required<Parameters<Cognitive['generateContent']>[0]['model']>;
-type ActiveLearning = z.input<typeof ActiveLearning>;
+type ActiveLearning = (typeof ActiveLearning)['_input'];
 declare const ActiveLearning: _bpinternal_zui.ZodObject<{
     enable: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodBoolean>;
     tableName: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodString>;
@@ -93,7 +93,7 @@ declare const ActiveLearning: _bpinternal_zui.ZodObject<{
     taskId?: string;
     enable?: boolean;
 }>;
-type ZaiConfig = z.input<typeof ZaiConfig>;
+type ZaiConfig = (typeof ZaiConfig)['_input'];
 declare const ZaiConfig: _bpinternal_zui.ZodObject<{
     client: z.Schema<Cognitive | BotpressClientLike, _bpinternal_zui.ZodTypeDef, Cognitive | BotpressClientLike>;
     userId: _bpinternal_zui.ZodOptional<_bpinternal_zui.ZodString>;
@@ -153,7 +153,7 @@ declare class Zai {
     learn(taskId: string): Zai;
 }
 
-type Options$6 = z.input<typeof Options$6>;
+type Options$6 = (typeof Options$6)['_input'];
 declare const Options$6: _bpinternal_zui.ZodObject<{
     length: _bpinternal_zui.ZodOptional<_bpinternal_zui.ZodNumber>;
 }, "strip", _bpinternal_zui.ZodTypeAny, {
@@ -168,7 +168,7 @@ declare module '@botpress/zai' {
     }
 }
 
-type Options$5 = z.input<typeof Options$5>;
+type Options$5 = (typeof Options$5)['_input'];
 declare const Options$5: _bpinternal_zui.ZodObject<{
     examples: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodArray<_bpinternal_zui.ZodObject<{
         input: _bpinternal_zui.ZodString;
@@ -201,7 +201,7 @@ declare module '@botpress/zai' {
     }
 }
 
-type Options$4 = z.input<typeof Options$4>;
+type Options$4 = (typeof Options$4)['_input'];
 declare const Options$4: _bpinternal_zui.ZodObject<{
     prompt: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodString>;
     format: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodString>;
@@ -246,7 +246,7 @@ declare module '@botpress/zai' {
     }
 }
 
-type Options$3 = z.input<typeof Options$3>;
+type Options$3 = (typeof Options$3)['_input'];
 declare const Options$3: _bpinternal_zui.ZodObject<{
     examples: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodArray<_bpinternal_zui.ZodObject<{
         input: _bpinternal_zui.ZodAny;
@@ -286,7 +286,7 @@ declare module '@botpress/zai' {
     }
 }
 
-type Options$2 = z.input<typeof Options$2>;
+type Options$2 = (typeof Options$2)['_input'];
 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<{
@@ -324,7 +324,7 @@ declare module '@botpress/zai' {
     }
 }
 
-type Options$1 = z.input<typeof Options$1>;
+type Options$1 = (typeof Options$1)['_input'];
 declare const Options$1: ZodObject<{
     instructions: _bpinternal_zui.ZodOptional<_bpinternal_zui.ZodString>;
     chunkLength: _bpinternal_zui.ZodDefault<_bpinternal_zui.ZodOptional<_bpinternal_zui.ZodNumber>>;
@@ -335,10 +335,15 @@ declare const Options$1: ZodObject<{
     instructions?: string;
     chunkLength?: number;
 }>;
+type __Z<T extends any = any> = {
+    _output: T;
+};
+type OfType<O, T extends __Z = __Z<O>> = T extends __Z<O> ? T : never;
+type AnyObjectOrArray = Record<string, unknown> | Array<unknown>;
 declare module '@botpress/zai' {
     interface Zai {
         /** Extracts one or many elements from an arbitrary input */
-        extract<S extends z.AnyZodObject | z.ZodArray>(input: unknown, schema: S, options?: Options$1): Promise<z.TypeOf<S>>;
+        extract<S extends OfType<AnyObjectOrArray>>(input: unknown, schema: S, options?: Options$1): Promise<S['_output']>;
     }
 }
 
@@ -357,7 +362,7 @@ type Example<T extends string> = {
         explanation?: string;
     }>>;
 };
-type Options<T extends string> = Omit<z.input<typeof Options>, 'examples'> & {
+type Options<T extends string> = Omit<(typeof Options)['_input'], 'examples'> & {
     examples?: Array<Partial<Example<T>>>;
 };
 declare const Options: _bpinternal_zui.ZodObject<{

package/dist/operations/extract.js

@@ -13,7 +13,8 @@ const Options = z.object({
 const START = "\u25A0json_start\u25A0";
 const END = "\u25A0json_end\u25A0";
 const NO_MORE = "\u25A0NO_MORE_ELEMENT\u25A0";
-Zai.prototype.extract = async function(input, schema, _options) {
+Zai.prototype.extract = async function(input, _schema, _options) {
+  let schema = _schema;
   const options = Options.parse(_options ?? {});
   const tokenizer = await this.getTokenizer();
   await this.fetchModelDetails();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@botpress/zai",
   "description": "Zui AI (zai) – An LLM utility library written on top of Zui and the Botpress API",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -23,7 +23,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@botpress/cognitive": "0.1.18",
+    "@botpress/cognitive": "0.1.20",
     "json5": "^2.2.3",
     "jsonrepair": "^3.10.0",
     "lodash-es": "^4.17.21"

package/src/adapters/botpress-table.ts

@@ -25,12 +25,12 @@ const Props = z.object({
   tableName: z
     .string()
     .regex(
-      /^[a-zA-Z0-9_]{1,45}Table$/,
-      'Table name must be lowercase and contain only letters, numbers and underscores'
+      /^[a-zA-Z0-9_]{1,45}Table$/i,
+      'Table name must be lowercase and contain only letters, numbers and underscores. It must also end with "Table". Example: "ActiveLearningTable"'
     ),
 })
 
-export type TableSchema = z.input<typeof TableSchema>
+export type TableSchema = (typeof TableSchema)['_input']
 const TableSchema = z.object({
   taskType: z.string().describe('The type of the task (filter, extract, etc.)'),
   taskId: z.string(),
@@ -65,7 +65,7 @@ export class TableAdapter extends Adapter {
 
   private _status: 'initialized' | 'ready' | 'error'
 
-  public constructor(props: z.input<typeof Props>) {
+  public constructor(props: (typeof Props)['_input']) {
     super()
     props = Props.parse(props)
     this._client = props.client

package/src/operations/check.ts

@@ -11,7 +11,7 @@ const Example = z.object({
   reason: z.string().optional(),
 })
 
-export type Options = z.input<typeof Options>
+export type Options = (typeof Options)['_input']
 const Options = z.object({
   examples: z.array(Example).describe('Examples to check the condition against').default([]),
 })

package/src/operations/extract.ts

@@ -10,7 +10,7 @@ import { Zai } from '../zai'
 import { PROMPT_INPUT_BUFFER } from './constants'
 import { JsonParsingError } from './errors'
 
-export type Options = z.input<typeof Options>
+export type Options = (typeof Options)['_input']
 const Options = z.object({
   instructions: z.string().optional().describe('Instructions to guide the user on how to extract the data'),
   chunkLength: z
@@ -22,10 +22,14 @@ const Options = z.object({
     .default(16_000),
 })
 
+type __Z<T extends any = any> = { _output: T }
+type OfType<O, T extends __Z = __Z<O>> = T extends __Z<O> ? T : never
+type AnyObjectOrArray = Record<string, unknown> | Array<unknown>
+
 declare module '@botpress/zai' {
   interface Zai {
     /** Extracts one or many elements from an arbitrary input */
-    extract<S extends z.AnyZodObject | z.ZodArray>(input: unknown, schema: S, options?: Options): Promise<z.TypeOf<S>>
+    extract<S extends OfType<AnyObjectOrArray>>(input: unknown, schema: S, options?: Options): Promise<S['_output']>
   }
 }
 
@@ -33,7 +37,13 @@ const START = '■json_start■'
 const END = '■json_end■'
 const NO_MORE = '■NO_MORE_ELEMENT■'
 
-Zai.prototype.extract = async function (this: Zai, input, schema, _options) {
+Zai.prototype.extract = async function <S extends OfType<AnyObjectOrArray>>(
+  this: Zai,
+  input: unknown,
+  _schema: S,
+  _options?: Options
+): Promise<S['_output']> {
+  let schema = _schema as any as z.ZodType
   const options = Options.parse(_options ?? {})
   const tokenizer = await this.getTokenizer()
   await this.fetchModelDetails()
@@ -83,9 +93,9 @@ Zai.prototype.extract = async function (this: Zai, input, schema, _options) {
     if (isArrayOfObjects) {
       const tokens = tokenizer.split(inputAsString)
       const chunks = chunk(tokens, options.chunkLength).map((x) => x.join(''))
-      const all = await Promise.all(chunks.map((chunk) => this.extract(chunk, originalSchema as z.AnyZodObject)))
+      const all = await Promise.all(chunks.map((chunk) => this.extract(chunk, originalSchema)))
 
-      return all.flat()
+      return all.flat() as any as S['_output']
     } else {
       // Truncate the input to fit the model's input size
       inputAsString = tokenizer.truncate(stringify(input), options.chunkLength)
@@ -137,7 +147,7 @@ Zai.prototype.extract = async function (this: Zai, input, schema, _options) {
 
   const exactMatch = examples.find((x) => x.key === Key)
   if (exactMatch) {
-    return exactMatch.output
+    return exactMatch.output as any as S['_output']
   }
 
   const defaultExample = isArrayOfObjects

package/src/operations/filter.ts

@@ -6,14 +6,14 @@ import { fastHash, stringify, takeUntilTokens } from '../utils'
 import { Zai } from '../zai'
 import { PROMPT_INPUT_BUFFER, PROMPT_OUTPUT_BUFFER } from './constants'
 
-type Example = z.input<typeof Example>
+type Example = (typeof Example)['_input']
 const Example = z.object({
   input: z.any(),
   filter: z.boolean(),
   reason: z.string().optional(),
 })
 
-export type Options = z.input<typeof Options>
+export type Options = (typeof Options)['_input']
 const Options = z.object({
   tokensPerItem: z
     .number()

package/src/operations/label.ts

@@ -22,7 +22,7 @@ type Example<T extends string> = {
   labels: Partial<Record<T, { label: Label; explanation?: string }>>
 }
 
-export type Options<T extends string> = Omit<z.input<typeof Options>, 'examples'> & {
+export type Options<T extends string> = Omit<(typeof Options)['_input'], 'examples'> & {
   examples?: Array<Partial<Example<T>>>
 }
 

package/src/operations/rewrite.ts

@@ -5,13 +5,13 @@ import { fastHash, stringify, takeUntilTokens } from '../utils'
 import { Zai } from '../zai'
 import { PROMPT_INPUT_BUFFER } from './constants'
 
-type Example = z.input<typeof Example> & { instructions?: string }
+type Example = (typeof Example)['_input'] & { instructions?: string }
 const Example = z.object({
   input: z.string(),
   output: z.string(),
 })
 
-export type Options = z.input<typeof Options>
+export type Options = (typeof Options)['_input']
 const Options = z.object({
   examples: z.array(Example).default([]),
   length: z.number().min(10).max(16_000).optional().describe('The maximum number of tokens to generate'),

package/src/operations/summarize.ts

@@ -5,7 +5,7 @@ import { chunk } from 'lodash-es'
 import { Zai } from '../zai'
 import { PROMPT_INPUT_BUFFER, PROMPT_OUTPUT_BUFFER } from './constants'
 
-export type Options = z.input<typeof Options>
+export type Options = (typeof Options)['_input']
 const Options = z.object({
   prompt: z
     .string()

package/src/operations/text.ts

@@ -5,7 +5,7 @@ import { clamp } from 'lodash-es'
 import { Zai } from '../zai'
 import { PROMPT_INPUT_BUFFER, PROMPT_OUTPUT_BUFFER } from './constants'
 
-export type Options = z.input<typeof Options>
+export type Options = (typeof Options)['_input']
 const Options = z.object({
   length: z.number().min(1).max(100_000).optional().describe('The maximum number of tokens to generate'),
 })

package/src/utils.ts

@@ -33,7 +33,7 @@ export const takeUntilTokens = <T>(arr: T[], tokens: number, count: (el: T) => n
   return result
 }
 
-export type GenerationMetadata = z.input<typeof GenerationMetadata>
+export type GenerationMetadata = (typeof GenerationMetadata)['_input']
 export const GenerationMetadata = z.object({
   model: z.string(),
   cost: z

package/src/zai.ts

@@ -9,7 +9,7 @@ import { MemoryAdapter } from './adapters/memory'
 
 type ModelId = Required<Parameters<Cognitive['generateContent']>[0]['model']>
 
-type ActiveLearning = z.input<typeof ActiveLearning>
+type ActiveLearning = (typeof ActiveLearning)['_input']
 const ActiveLearning = z.object({
   enable: z.boolean().describe('Whether to enable active learning').default(false),
   tableName: z
@@ -30,7 +30,7 @@ const ActiveLearning = z.object({
     .default('default'),
 })
 
-type ZaiConfig = z.input<typeof ZaiConfig>
+type ZaiConfig = (typeof ZaiConfig)['_input']
 const ZaiConfig = z.object({
   client: z.custom<BotpressClientLike | Cognitive>(),
   userId: z.string().describe('The ID of the user consuming the API').optional(),