viscribe 0.1.0 → 1.1.0

package/dist/index.cjs

@@ -45,12 +45,8 @@ module.exports = __toCommonJS(index_exports);
 // src/images.ts
 var images_exports = {};
 __export(images_exports, {
-  ask: () => ask,
   assertImagePathExists: () => assertImagePathExists,
   buildImageSource: () => buildImageSource,
-  classify: () => classify,
-  compare: () => compare,
-  describe: () => describe,
   extract: () => extract
 });
 
@@ -68,9 +64,7 @@ function buildImageSource(input) {
     input.imagePath !== void 0
   ].filter(Boolean).length;
   if (provided !== 1) {
-    throw new Error(
-      "Provide exactly one of 'imageUrl', 'imageBase64', or 'imagePath'."
-    );
+    throw new Error("Provide exactly one of 'imageUrl', 'imageBase64', or 'imagePath'.");
   }
   if (input.imageUrl !== void 0) {
     validateImageUrl(input.imageUrl);
@@ -90,9 +84,7 @@ function buildImageSource(input) {
     const mimeType = detectImageMimeType(imageBytes);
     return `data:${mimeType};base64,${input.imageBase64}`;
   }
-  throw new Error(
-    "Provide exactly one of 'imageUrl', 'imageBase64', or 'imagePath'."
-  );
+  throw new Error("Provide exactly one of 'imageUrl', 'imageBase64', or 'imagePath'.");
 }
 async function assertImagePathExists(imagePath) {
   const result = await (0, import_promises.stat)(imagePath);
@@ -157,67 +149,13 @@ CRITICAL INSTRUCTIONS:
 - Do not include explanatory text, code blocks, or markdown formatting.
 - Your response must be a single JSON object that exactly matches the provided schema.
 
-TASK:
+GOAL:
 - Analyze the image carefully and extract data according to the provided schema.
 - Be precise and accurate.
 - If a value is not visible or cannot be inferred from the image, use null
   when the schema allows it.
 - Ensure all required fields are included.
 `.trim();
-var DESCRIBE_SYSTEM_PROMPT = `
-You are an expert image analyst.
-
-CRITICAL INSTRUCTIONS:
-- Respond with valid JSON only.
-- Do not include explanatory text, code blocks, or markdown formatting.
-- Your response must be a single JSON object that exactly matches the provided schema.
-- Follow any user-provided instruction closely.
-
-TASK:
-- Provide a detailed, objective description of the image.
-- Focus on main elements, context, and notable details.
-- If tags are requested, generate up to 5 relevant tags.
-`.trim();
-var CLASSIFY_SYSTEM_PROMPT = `
-You are an expert at image classification.
-
-CRITICAL INSTRUCTIONS:
-- Respond with valid JSON only.
-- Do not include explanatory text, code blocks, or markdown formatting.
-- Your response must be a single JSON object that exactly matches the provided schema.
-
-TASK:
-- Analyze the image and classify it according to the requested categories or task.
-- Return only categories that are supported by the image.
-- If the image cannot be classified into a requested category, return an empty list.
-`.trim();
-var ASK_SYSTEM_PROMPT = `
-You are an expert at analyzing images and answering related questions.
-
-CRITICAL INSTRUCTIONS:
-- Respond with valid JSON only.
-- Do not include explanatory text, code blocks, or markdown formatting.
-- Your response must be a single JSON object that exactly matches the provided schema.
-
-TASK:
-- Carefully examine the provided image.
-- Deliver a clear, accurate, and detailed response to the question.
-- If the answer cannot be determined from the image, state that the information is not available.
-`.trim();
-var COMPARE_SYSTEM_PROMPT = `
-You are an expert at comparing images.
-
-CRITICAL INSTRUCTIONS:
-- Respond with valid JSON only.
-- Do not include explanatory text, code blocks, or markdown formatting.
-- Your response must be a single JSON object that exactly matches the provided schema.
-
-TASK:
-- Analyze two provided images, focusing on their visual elements.
-- Identify and describe similarities.
-- Highlight differences in color, texture, composition, subject matter, and context.
-- Point out notable features unique to each image.
-`.trim();
 
 // src/schema.ts
 function buildSchemaFromFields(fields) {
@@ -294,78 +232,6 @@ var CLIENT_CONFIG_KEYS = /* @__PURE__ */ new Set([
   "fetch",
   "httpAgent"
 ]);
-var DESCRIBE_SCHEMA = {
-  title: "ImageDescription",
-  description: "Structured description of an image.",
-  type: "object",
-  properties: {
-    image_description: {
-      type: "string",
-      description: "Objective description of the image."
-    },
-    tags: {
-      type: "array",
-      items: { type: "string" },
-      maxItems: 5,
-      description: "Relevant tags describing the image."
-    }
-  },
-  required: ["image_description", "tags"],
-  additionalProperties: false
-};
-var DESCRIBE_NO_TAGS_SCHEMA = {
-  title: "ImageDescription",
-  description: "Structured description of an image.",
-  type: "object",
-  properties: {
-    image_description: {
-      type: "string",
-      description: "Objective description of the image."
-    }
-  },
-  required: ["image_description"],
-  additionalProperties: false
-};
-var CLASSIFY_SCHEMA = {
-  title: "ImageClassification",
-  description: "Structured classification of an image.",
-  type: "object",
-  properties: {
-    classification: {
-      type: "array",
-      items: { type: "string" },
-      description: "Predicted class names."
-    }
-  },
-  required: ["classification"],
-  additionalProperties: false
-};
-var ASK_SCHEMA = {
-  title: "ImageQuestionAnswer",
-  description: "Answer to a question about an image.",
-  type: "object",
-  properties: {
-    answer: {
-      type: "string",
-      description: "Answer to the question based on the image."
-    }
-  },
-  required: ["answer"],
-  additionalProperties: false
-};
-var COMPARE_SCHEMA = {
-  title: "ImageComparison",
-  description: "Structured comparison of two images.",
-  type: "object",
-  properties: {
-    comparison_result: {
-      type: "string",
-      description: "Textual comparison of the two images."
-    }
-  },
-  required: ["comparison_result"],
-  additionalProperties: false
-};
 var StructuredOutputError = class extends Error {
 };
 var StructuredOutputRefusalError = class extends StructuredOutputError {
@@ -392,11 +258,7 @@ var ViscribeAI = class {
     this.strict = options.strict ?? true;
     this.client = options.client;
     this.images = {
-      extract: (extractOptions) => this.extractImage(extractOptions),
-      describe: (describeOptions) => this.describeImage(describeOptions),
-      classify: (classifyOptions) => this.classifyImage(classifyOptions),
-      ask: (askOptions) => this.askImage(askOptions),
-      compare: (compareOptions) => this.compareImages(compareOptions)
+      extract: (extractOptions) => this.extractImage(extractOptions)
     };
   }
   async extractImage(options) {
@@ -410,45 +272,6 @@ var ViscribeAI = class {
       schema
     });
   }
-  async describeImage(options) {
-    return this.structuredImageRequest({
-      messages: singleImageMessages({
-        systemPrompt: DESCRIBE_SYSTEM_PROMPT,
-        userPrompt: options.instruction ?? "Describe this image.",
-        imageSource: options
-      }),
-      schema: options.generateTags ?? true ? DESCRIBE_SCHEMA : DESCRIBE_NO_TAGS_SCHEMA
-    });
-  }
-  async classifyImage(options) {
-    const classes = validateClassificationOptions(options);
-    return this.structuredImageRequest({
-      messages: singleImageMessages({
-        systemPrompt: CLASSIFY_SYSTEM_PROMPT,
-        userPrompt: classificationPrompt({ ...options, classes }),
-        imageSource: options
-      }),
-      schema: classificationSchema({ multiLabel: options.multiLabel ?? false }),
-      transform: (data) => normalizeClassification(data, { classes })
-    });
-  }
-  async askImage(options) {
-    const question = validateQuestion(options.question);
-    return this.structuredImageRequest({
-      messages: singleImageMessages({
-        systemPrompt: ASK_SYSTEM_PROMPT,
-        userPrompt: question,
-        imageSource: options
-      }),
-      schema: ASK_SCHEMA
-    });
-  }
-  async compareImages(options) {
-    return this.structuredImageRequest({
-      messages: compareMessages(options),
-      schema: COMPARE_SCHEMA
-    });
-  }
   async structuredImageRequest(options) {
     const response = await this.getClient().chat.completions.create({
       messages: options.messages,
@@ -456,10 +279,7 @@ var ViscribeAI = class {
       response_format: responseFormatForSchema(options.schema, this.strict),
       ...this.modelConfig.request
     });
-    return resultFromResponse(response, {
-      rawSchema: options.schema,
-      transform: options.transform
-    });
+    return resultFromResponse(response);
   }
   getClient() {
     if (!this.client) {
@@ -519,116 +339,6 @@ function singleImageMessages(options) {
     }
   ];
 }
-function compareMessages(options) {
-  const image1Source = buildNumberedImageSource("image1", {
-    imageUrl: options.image1Url,
-    imageBase64: options.image1Base64,
-    imagePath: options.image1Path
-  });
-  const image2Source = buildNumberedImageSource("image2", {
-    imageUrl: options.image2Url,
-    imageBase64: options.image2Base64,
-    imagePath: options.image2Path
-  });
-  return [
-    { role: "system", content: COMPARE_SYSTEM_PROMPT },
-    {
-      role: "user",
-      content: [
-        {
-          type: "text",
-          text: options.instruction ?? "Describe the similarities and differences between these two images."
-        },
-        { type: "image_url", image_url: { url: image1Source } },
-        { type: "image_url", image_url: { url: image2Source } }
-      ]
-    }
-  ];
-}
-function buildNumberedImageSource(label, input) {
-  const provided = [
-    input.imageUrl !== void 0,
-    input.imageBase64 !== void 0,
-    input.imagePath !== void 0
-  ].filter(Boolean).length;
-  if (provided !== 1) {
-    throw new Error(
-      `Provide exactly one source for '${label}': '${label}Url', '${label}Base64', or '${label}Path'.`
-    );
-  }
-  return buildImageSource(input);
-}
-function classificationSchema(options) {
-  const schema = structuredClone(CLASSIFY_SCHEMA);
-  const properties = schema.properties;
-  if (!options.multiLabel && isPlainObject(properties)) {
-    const classification = properties.classification;
-    if (isPlainObject(classification)) {
-      classification.maxItems = 1;
-    }
-  }
-  return schema;
-}
-function classificationPrompt(options) {
-  const parts = [options.instruction ?? "Classify this image."];
-  if (options.classes && options.classes.length > 0) {
-    parts.push(`Allowed classes: ${options.classes.join(", ")}.`);
-  } else if (options.classes) {
-    parts.push("No allowed classes were provided; return an empty list.");
-  }
-  if (options.classDescriptions) {
-    const descriptions = Object.entries(options.classDescriptions).map(([className, description]) => `- ${className}: ${description}`).join("\n");
-    parts.push(`Class descriptions:
-${descriptions}`);
-  }
-  parts.push(
-    options.multiLabel ? "Return every relevant class in the classification list." : "Return at most one class in the classification list."
-  );
-  return parts.join("\n");
-}
-function validateClassificationOptions(options) {
-  const classes = options.classes ? [...options.classes] : void 0;
-  if (options.classDescriptions) {
-    if (!classes || classes.length === 0) {
-      throw new Error(
-        "'classDescriptions' can only be provided when 'classes' is provided."
-      );
-    }
-    const invalidClasses = Object.keys(options.classDescriptions).filter(
-      (className) => !classes.includes(className)
-    );
-    if (invalidClasses.length > 0) {
-      throw new Error(
-        `'classDescriptions' contains entries not present in 'classes': ${invalidClasses.sort().join(", ")}.`
-      );
-    }
-  }
-  return classes;
-}
-function normalizeClassification(data, options) {
-  const rawClassification = data.classification;
-  let classification;
-  if (typeof rawClassification === "string") {
-    classification = rawClassification ? [rawClassification] : [];
-  } else if (Array.isArray(rawClassification)) {
-    classification = rawClassification.filter((value) => typeof value === "string").map((value) => value);
-  } else {
-    classification = [];
-  }
-  if (options.classes) {
-    const allowedClasses = new Set(options.classes);
-    classification = classification.filter(
-      (className) => allowedClasses.has(className)
-    );
-  }
-  return { classification };
-}
-function validateQuestion(question) {
-  if (typeof question !== "string" || question.trim().length === 0) {
-    throw new Error("'question' must be provided.");
-  }
-  return question.trim();
-}
 function responseFormatForSchema(rawSchema, strict) {
   if (rawSchema.type === "json_schema" && typeof rawSchema.json_schema === "object" && rawSchema.json_schema !== null) {
     const jsonSchema = { ...rawSchema.json_schema };
@@ -688,10 +398,10 @@ function ensureStrictJsonSchema(schema) {
     delete schema.default;
   }
 }
-function resultFromResponse(response, context) {
+function resultFromResponse(response) {
   const parsed = parseStructuredResponse(response);
   return {
-    data: context.transform ? context.transform(parsed) : parsed,
+    data: parsed,
     raw: response,
     usageMetadata: usageMetadata(response)
   };
@@ -738,9 +448,7 @@ function messageContentText(message) {
     ).map((block) => block.text).join("");
     if (text) return text;
   }
-  throw new StructuredOutputParseError(
-    "Response message does not contain text content."
-  );
+  throw new StructuredOutputParseError("Response message does not contain text content.");
 }
 function loadsJsonObject(content) {
   const trimmed = content.trim();
@@ -761,9 +469,7 @@ function loadsJsonObject(content) {
     try {
       const data = JSON.parse(attempt);
       if (!isPlainObject(data)) {
-        throw new StructuredOutputParseError(
-          "Structured output must be a JSON object."
-        );
+        throw new StructuredOutputParseError("Structured output must be a JSON object.");
       }
       return data;
     } catch (error) {
@@ -796,22 +502,6 @@ async function extract(options) {
   const client = new ViscribeAI(options);
   return client.images.extract(options);
 }
-async function describe(options) {
-  const client = new ViscribeAI(options);
-  return client.images.describe(options);
-}
-async function classify(options) {
-  const client = new ViscribeAI(options);
-  return client.images.classify(options);
-}
-async function ask(options) {
-  const client = new ViscribeAI(options);
-  return client.images.ask(options);
-}
-async function compare(options) {
-  const client = new ViscribeAI(options);
-  return client.images.compare(options);
-}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   DEFAULT_MODEL,

package/dist/index.d.cts

@@ -25,45 +25,10 @@ interface ImageResult<T = Record<string, unknown>> {
 interface ExtractResult<T = Record<string, unknown>> extends ImageResult<T> {
 }
 type OutputSchema = ExtractField[] | JsonSchema;
-interface DescribeData {
-    image_description: string;
-    tags?: string[];
-}
-interface ClassificationData {
-    classification: string[];
-}
-interface AskData {
-    answer: string;
-}
-interface CompareData {
-    comparison_result: string;
-}
 interface ExtractOptions extends ImageSourceInput {
     outputSchema?: OutputSchema;
     instruction?: string;
 }
-interface DescribeOptions extends ImageSourceInput {
-    instruction?: string;
-    generateTags?: boolean;
-}
-interface ClassifyOptions extends ImageSourceInput {
-    classes?: string[];
-    classDescriptions?: Record<string, string>;
-    instruction?: string;
-    multiLabel?: boolean;
-}
-interface AskOptions extends ImageSourceInput {
-    question: string;
-}
-interface CompareOptions {
-    image1Url?: string;
-    image1Base64?: string;
-    image1Path?: string;
-    image2Url?: string;
-    image2Base64?: string;
-    image2Path?: string;
-    instruction?: string;
-}
 interface ViscribeAIOptions {
     modelConfig?: ModelConfig;
     apiKey?: string;
@@ -73,10 +38,6 @@ interface ViscribeAIOptions {
 }
 interface ImagesClient {
     extract<T = Record<string, unknown>>(options: ExtractOptions): Promise<ExtractResult<T>>;
-    describe(options: DescribeOptions): Promise<ImageResult<DescribeData>>;
-    classify(options: ClassifyOptions): Promise<ImageResult<ClassificationData>>;
-    ask(options: AskOptions): Promise<ImageResult<AskData>>;
-    compare(options: CompareOptions): Promise<ImageResult<CompareData>>;
 }
 type OpenAILike = {
     chat: {
@@ -106,30 +67,18 @@ declare class ViscribeAI {
     private client?;
     constructor(options?: ViscribeAIOptions);
     private extractImage;
-    private describeImage;
-    private classifyImage;
-    private askImage;
-    private compareImages;
     private structuredImageRequest;
     private getClient;
 }
 
 declare function extract<T = Record<string, unknown>>(options: ExtractOptions & ViscribeAIOptions): Promise<ExtractResult<T>>;
-declare function describe(options: DescribeOptions & ViscribeAIOptions): Promise<ImageResult<DescribeData>>;
-declare function classify(options: ClassifyOptions & ViscribeAIOptions): Promise<ImageResult<ClassificationData>>;
-declare function ask(options: AskOptions & ViscribeAIOptions): Promise<ImageResult<AskData>>;
-declare function compare(options: CompareOptions & ViscribeAIOptions): Promise<ImageResult<CompareData>>;
 
 type images_ImageSourceInput = ImageSourceInput;
-declare const images_ask: typeof ask;
 declare const images_assertImagePathExists: typeof assertImagePathExists;
 declare const images_buildImageSource: typeof buildImageSource;
-declare const images_classify: typeof classify;
-declare const images_compare: typeof compare;
-declare const images_describe: typeof describe;
 declare const images_extract: typeof extract;
 declare namespace images {
-  export { type images_ImageSourceInput as ImageSourceInput, images_ask as ask, images_assertImagePathExists as assertImagePathExists, images_buildImageSource as buildImageSource, images_classify as classify, images_compare as compare, images_describe as describe, images_extract as extract };
+  export { type images_ImageSourceInput as ImageSourceInput, images_assertImagePathExists as assertImagePathExists, images_buildImageSource as buildImageSource, images_extract as extract };
 }
 
-export { type AskData, type AskOptions, type ClassificationData, type ClassifyOptions, type CompareData, type CompareOptions, DEFAULT_MODEL, type DescribeData, type DescribeOptions, type ExtractField, type ExtractOptions, type ExtractResult, type FieldType, type ImageResult, type ImagesClient, type JsonSchema, type ModelConfig, type OpenAILike, type OutputSchema, StructuredOutputError, StructuredOutputFinishReasonError, StructuredOutputParseError, StructuredOutputRefusalError, StructuredOutputValidationError, ViscribeAI, type ViscribeAIOptions, buildSchemaFromFields, images };
+export { DEFAULT_MODEL, type ExtractField, type ExtractOptions, type ExtractResult, type FieldType, type ImageResult, type ImagesClient, type JsonSchema, type ModelConfig, type OpenAILike, type OutputSchema, StructuredOutputError, StructuredOutputFinishReasonError, StructuredOutputParseError, StructuredOutputRefusalError, StructuredOutputValidationError, ViscribeAI, type ViscribeAIOptions, buildSchemaFromFields, images };

package/dist/index.d.ts

@@ -25,45 +25,10 @@ interface ImageResult<T = Record<string, unknown>> {
 interface ExtractResult<T = Record<string, unknown>> extends ImageResult<T> {
 }
 type OutputSchema = ExtractField[] | JsonSchema;
-interface DescribeData {
-    image_description: string;
-    tags?: string[];
-}
-interface ClassificationData {
-    classification: string[];
-}
-interface AskData {
-    answer: string;
-}
-interface CompareData {
-    comparison_result: string;
-}
 interface ExtractOptions extends ImageSourceInput {
     outputSchema?: OutputSchema;
     instruction?: string;
 }
-interface DescribeOptions extends ImageSourceInput {
-    instruction?: string;
-    generateTags?: boolean;
-}
-interface ClassifyOptions extends ImageSourceInput {
-    classes?: string[];
-    classDescriptions?: Record<string, string>;
-    instruction?: string;
-    multiLabel?: boolean;
-}
-interface AskOptions extends ImageSourceInput {
-    question: string;
-}
-interface CompareOptions {
-    image1Url?: string;
-    image1Base64?: string;
-    image1Path?: string;
-    image2Url?: string;
-    image2Base64?: string;
-    image2Path?: string;
-    instruction?: string;
-}
 interface ViscribeAIOptions {
     modelConfig?: ModelConfig;
     apiKey?: string;
@@ -73,10 +38,6 @@ interface ViscribeAIOptions {
 }
 interface ImagesClient {
     extract<T = Record<string, unknown>>(options: ExtractOptions): Promise<ExtractResult<T>>;
-    describe(options: DescribeOptions): Promise<ImageResult<DescribeData>>;
-    classify(options: ClassifyOptions): Promise<ImageResult<ClassificationData>>;
-    ask(options: AskOptions): Promise<ImageResult<AskData>>;
-    compare(options: CompareOptions): Promise<ImageResult<CompareData>>;
 }
 type OpenAILike = {
     chat: {
@@ -106,30 +67,18 @@ declare class ViscribeAI {
     private client?;
     constructor(options?: ViscribeAIOptions);
     private extractImage;
-    private describeImage;
-    private classifyImage;
-    private askImage;
-    private compareImages;
     private structuredImageRequest;
     private getClient;
 }
 
 declare function extract<T = Record<string, unknown>>(options: ExtractOptions & ViscribeAIOptions): Promise<ExtractResult<T>>;
-declare function describe(options: DescribeOptions & ViscribeAIOptions): Promise<ImageResult<DescribeData>>;
-declare function classify(options: ClassifyOptions & ViscribeAIOptions): Promise<ImageResult<ClassificationData>>;
-declare function ask(options: AskOptions & ViscribeAIOptions): Promise<ImageResult<AskData>>;
-declare function compare(options: CompareOptions & ViscribeAIOptions): Promise<ImageResult<CompareData>>;
 
 type images_ImageSourceInput = ImageSourceInput;
-declare const images_ask: typeof ask;
 declare const images_assertImagePathExists: typeof assertImagePathExists;
 declare const images_buildImageSource: typeof buildImageSource;
-declare const images_classify: typeof classify;
-declare const images_compare: typeof compare;
-declare const images_describe: typeof describe;
 declare const images_extract: typeof extract;
 declare namespace images {
-  export { type images_ImageSourceInput as ImageSourceInput, images_ask as ask, images_assertImagePathExists as assertImagePathExists, images_buildImageSource as buildImageSource, images_classify as classify, images_compare as compare, images_describe as describe, images_extract as extract };
+  export { type images_ImageSourceInput as ImageSourceInput, images_assertImagePathExists as assertImagePathExists, images_buildImageSource as buildImageSource, images_extract as extract };
 }
 
-export { type AskData, type AskOptions, type ClassificationData, type ClassifyOptions, type CompareData, type CompareOptions, DEFAULT_MODEL, type DescribeData, type DescribeOptions, type ExtractField, type ExtractOptions, type ExtractResult, type FieldType, type ImageResult, type ImagesClient, type JsonSchema, type ModelConfig, type OpenAILike, type OutputSchema, StructuredOutputError, StructuredOutputFinishReasonError, StructuredOutputParseError, StructuredOutputRefusalError, StructuredOutputValidationError, ViscribeAI, type ViscribeAIOptions, buildSchemaFromFields, images };
+export { DEFAULT_MODEL, type ExtractField, type ExtractOptions, type ExtractResult, type FieldType, type ImageResult, type ImagesClient, type JsonSchema, type ModelConfig, type OpenAILike, type OutputSchema, StructuredOutputError, StructuredOutputFinishReasonError, StructuredOutputParseError, StructuredOutputRefusalError, StructuredOutputValidationError, ViscribeAI, type ViscribeAIOptions, buildSchemaFromFields, images };