mindee 5.8.0 → 5.10.0

package/src/v2/product/extraction/params/dataSchema.d.ts

@@ -1,8 +1,12 @@
 import { StringDict } from "../../../../parsing/stringDict.js";
 import { DataSchemaReplace, DataSchemaReplaceJson } from "./dataSchemaReplace.js";
-/** JSON payload for top-level data schema options. */
+/**
+ * JSON payload for top-level data schema options.
+ */
 export interface DataSchemaJson {
-    /** Optional full replacement schema. */
+    /**
+     * Optional full replacement schema.
+     */
     replace?: DataSchemaReplaceJson;
 }
 /**
@@ -14,8 +18,12 @@ export declare class DataSchema {
      */
     replace?: DataSchemaReplace;
     constructor(dataSchema: StringDict | string);
-    /** Serializes the data schema parameters to API format. */
+    /**
+     * Serializes the data schema parameters to API format.
+     */
     toJSON(): DataSchemaJson;
-    /** Returns a JSON string representation of the data schema parameters. */
+    /**
+     * Returns a JSON string representation of the data schema parameters.
+     */
     toString(): string;
 }

package/src/v2/product/extraction/params/dataSchema.js

@@ -14,11 +14,15 @@ export class DataSchema {
             this.replace = new DataSchemaReplace(dataSchema["replace"]);
         }
     }
-    /** Serializes the data schema parameters to API format. */
+    /**
+     * Serializes the data schema parameters to API format.
+     */
     toJSON() {
         return { replace: this.replace?.toJSON() };
     }
-    /** Returns a JSON string representation of the data schema parameters. */
+    /**
+     * Returns a JSON string representation of the data schema parameters.
+     */
     toString() {
         return JSON.stringify(this.toJSON());
     }

package/src/v2/product/extraction/params/dataSchemaField.d.ts

@@ -1,26 +1,48 @@
 import { StringDict } from "../../../../parsing/index.js";
-/** JSON payload for a single data schema field definition. */
+/**
+ * JSON payload for a single data schema field definition.
+ */
 export interface DataSchemaFieldJson {
-    /** Field key used in results. */
+    /**
+     * Field key used in results.
+     */
     name: string;
-    /** Human-readable field title. */
+    /**
+     * Human-readable field title.
+     */
     title: string;
-    /** Whether the field accepts multiple values. */
+    /**
+     * Whether the field accepts multiple values.
+     */
     is_array: boolean;
-    /** Field type name. */
+    /**
+     * Field type name.
+     */
     type: string;
-    /** Optional allowed classes for classification fields. */
+    /**
+     * Optional allowed classes for classification fields.
+     */
     classification_values?: Array<string>;
-    /** Optional deduplication behavior for array fields. */
+    /**
+     * Optional deduplication behavior for array fields.
+     */
     unique_values?: boolean;
-    /** Optional field description. */
+    /**
+     * Optional field description.
+     */
     description?: string;
-    /** Optional extraction guidelines. */
+    /**
+     * Optional extraction guidelines.
+     */
     guidelines?: string;
-    /** Optional nested schema for object fields. */
+    /**
+     * Optional nested schema for object fields.
+     */
     nested_fields?: StringDict;
 }
-/** Data schema field definition used by extraction parameters. */
+/**
+ * Data schema field definition used by extraction parameters.
+ */
 export declare class DataSchemaField {
     /**
      * Display name for the field, also impacts inference results.
@@ -60,8 +82,12 @@ export declare class DataSchemaField {
      */
     nestedFields?: StringDict;
     constructor(fields: StringDict);
-    /** Serializes the field definition to API format. */
+    /**
+     * Serializes the field definition to API format.
+     */
     toJSON(): DataSchemaFieldJson;
-    /** Returns a JSON string representation of the field definition. */
+    /**
+     * Returns a JSON string representation of the field definition.
+     */
     toString(): string;
 }

package/src/v2/product/extraction/params/dataSchemaField.js

@@ -1,4 +1,6 @@
-/** Data schema field definition used by extraction parameters. */
+/**
+ * Data schema field definition used by extraction parameters.
+ */
 export class DataSchemaField {
     constructor(fields) {
         this.name = fields["name"];
@@ -11,7 +13,9 @@ export class DataSchemaField {
         this.guidelines = fields["guidelines"];
         this.nestedFields = fields["nested_fields"];
     }
-    /** Serializes the field definition to API format. */
+    /**
+     * Serializes the field definition to API format.
+     */
     toJSON() {
         const out = {
             name: this.name,
@@ -35,7 +39,9 @@ export class DataSchemaField {
             out.nested_fields = this.nestedFields;
         return out;
     }
-    /** Returns a JSON string representation of the field definition. */
+    /**
+     * Returns a JSON string representation of the field definition.
+     */
     toString() {
         return JSON.stringify(this.toJSON());
     }

package/src/v2/product/extraction/params/dataSchemaReplace.d.ts

@@ -1,8 +1,12 @@
 import { StringDict } from "../../../../parsing/index.js";
 import { DataSchemaField, DataSchemaFieldJson } from "./dataSchemaField.js";
-/** JSON payload for replacement data schema options. */
+/**
+ * JSON payload for replacement data schema options.
+ */
 export interface DataSchemaReplaceJson {
-    /** Field definitions replacing the current schema. */
+    /**
+     * Field definitions replacing the current schema.
+     */
     fields: Array<DataSchemaFieldJson>;
 }
 /**
@@ -14,8 +18,12 @@ export declare class DataSchemaReplace {
      */
     fields: Array<DataSchemaField>;
     constructor(dataSchemaReplace: StringDict);
-    /** Serializes the replacement schema to API format. */
+    /**
+     * Serializes the replacement schema to API format.
+     */
     toJSON(): DataSchemaReplaceJson;
-    /** Returns a JSON string representation of the replacement schema. */
+    /**
+     * Returns a JSON string representation of the replacement schema.
+     */
     toString(): string;
 }

package/src/v2/product/extraction/params/dataSchemaReplace.js

@@ -13,11 +13,15 @@ export class DataSchemaReplace {
         }
         this.fields = dataSchemaReplace["fields"].map((field) => (new DataSchemaField(field)));
     }
-    /** Serializes the replacement schema to API format. */
+    /**
+     * Serializes the replacement schema to API format.
+     */
     toJSON() {
         return { fields: this.fields.map(e => e.toJSON()) };
     }
-    /** Returns a JSON string representation of the replacement schema. */
+    /**
+     * Returns a JSON string representation of the replacement schema.
+     */
     toString() {
         return JSON.stringify(this.toJSON());
     }

package/src/v2/product/extraction/params/extractionParameters.d.ts

@@ -1,6 +1,6 @@
 import { StringDict } from "../../../../parsing/stringDict.js";
 import { DataSchema } from "./dataSchema.js";
-import { BaseProductParameters, BaseProductParametersConstructor } from "../../../../v2/clientOptions/baseProductParameters.js";
+import { BaseProductParameters, BaseProductParametersConstructor } from "../../../clientOptions/baseProductParameters.js";
 /**
  * Parameters for sending a file to an Extraction product.
  */

package/src/v2/product/extraction/params/extractionParameters.js

@@ -1,5 +1,5 @@
 import { DataSchema } from "./dataSchema.js";
-import { BaseProductParameters } from "../../../../v2/clientOptions/baseProductParameters.js";
+import { BaseProductParameters } from "../../../clientOptions/baseProductParameters.js";
 import { logger } from "../../../../logger.js";
 /**
  * Parameters for sending a file to an Extraction product.
@@ -13,11 +13,11 @@ export class ExtractionParameters extends BaseProductParameters {
         this.confidence = params.confidence;
         this.textContext = params.textContext;
         if (params.dataSchema !== undefined && params.dataSchema !== null) {
-            if (!(params.dataSchema instanceof DataSchema)) {
-                this.dataSchema = new DataSchema(params.dataSchema);
+            if (params.dataSchema instanceof DataSchema) {
+                this.dataSchema = params.dataSchema;
             }
             else {
-                this.dataSchema = params.dataSchema;
+                this.dataSchema = new DataSchema(params.dataSchema);
             }
         }
         logger.debug("Extraction parameters initialized.");

package/src/v2/product/extraction/ragDocuments/annotatedBaseField.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Base class for annotated fields.
+ */
+export declare abstract class AnnotatedBaseField {
+    /**
+     * When true, use the RAG information for the final result. When false, use the Data Schema information.
+     */
+    selected: boolean;
+    /**
+     * Guidelines or instructions for processing this field.
+     */
+    guidelines: string | null;
+    /**
+     * Default constructor.
+     * @param selected When true, use the RAG information for the final result.
+     *  When false, use the Data Schema information.
+     * @param guidelines Guidelines or instructions for processing this field.
+     */
+    protected constructor(selected: boolean, guidelines?: string | null);
+}

package/src/v2/product/extraction/ragDocuments/annotatedBaseField.js

@@ -0,0 +1,15 @@
+/**
+ * Base class for annotated fields.
+ */
+export class AnnotatedBaseField {
+    /**
+     * Default constructor.
+     * @param selected When true, use the RAG information for the final result.
+     *  When false, use the Data Schema information.
+     * @param guidelines Guidelines or instructions for processing this field.
+     */
+    constructor(selected, guidelines = null) {
+        this.selected = selected;
+        this.guidelines = guidelines;
+    }
+}

package/src/v2/product/extraction/ragDocuments/annotatedFields.d.ts

@@ -0,0 +1,27 @@
+import { AnnotatedSimpleField } from "./annotatedSimpleField.js";
+import { AnnotatedObjectField } from "./annotatedObjectField.js";
+import { AnnotatedListField } from "./annotatedListField.js";
+import { StringDict } from "../../../../parsing/index.js";
+/**
+ * A dictionary of field names and their corresponding configured field types.
+ */
+export declare class AnnotatedFields extends Map<string, AnnotatedSimpleField | AnnotatedObjectField | AnnotatedListField> {
+    constructor(serverResponse: StringDict);
+    /**
+     * Returns a field as an `AnnotatedSimpleField`, or throws if the type mismatches.
+     */
+    getSimpleField(fieldName: string): AnnotatedSimpleField;
+    /**
+     * Returns a field as an `AnnotatedObjectField`, or throws if the type mismatches.
+     */
+    getObjectField(fieldName: string): AnnotatedObjectField;
+    /**
+     * Returns a field as an `AnnotatedListField`, or throws if the type mismatches.
+     */
+    getListField(fieldName: string): AnnotatedListField;
+    /**
+     * Serializes the fields to API format.
+     * Needed because a `Map` is otherwise serialized as an empty object by `JSON.stringify`.
+     */
+    toJSON(): Record<string, AnnotatedSimpleField | AnnotatedObjectField | AnnotatedListField>;
+}

package/src/v2/product/extraction/ragDocuments/annotatedFields.js

@@ -0,0 +1,57 @@
+import { createAnnotatedField } from "./fieldFactory.js";
+/**
+ * A dictionary of field names and their corresponding configured field types.
+ */
+export class AnnotatedFields extends Map {
+    constructor(serverResponse) {
+        super(Object.entries(serverResponse).map(([key, value]) => {
+            return [key, createAnnotatedField(value)];
+        }));
+    }
+    /**
+     * Returns a field as an `AnnotatedSimpleField`, or throws if the type mismatches.
+     */
+    getSimpleField(fieldName) {
+        const field = this.get(fieldName);
+        if (field === undefined) {
+            throw new Error(`The field '${fieldName}' was not found.`);
+        }
+        if (field.constructor.name !== "AnnotatedSimpleField") {
+            throw new Error(`The field '${fieldName}' is not a AnnotatedSimpleField.`);
+        }
+        return field;
+    }
+    /**
+     * Returns a field as an `AnnotatedObjectField`, or throws if the type mismatches.
+     */
+    getObjectField(fieldName) {
+        const field = this.get(fieldName);
+        if (field === undefined) {
+            throw new Error(`The field '${fieldName}' was not found.`);
+        }
+        if (field.constructor.name !== "AnnotatedObjectField") {
+            throw new Error(`The field '${fieldName}' is not an ObjectField.`);
+        }
+        return field;
+    }
+    /**
+     * Returns a field as an `AnnotatedListField`, or throws if the type mismatches.
+     */
+    getListField(fieldName) {
+        const field = this.get(fieldName);
+        if (field === undefined) {
+            throw new Error(`The field '${fieldName}' was not found.`);
+        }
+        if (field.constructor.name !== "AnnotatedListField") {
+            throw new Error(`The field '${fieldName}' is not a ListField.`);
+        }
+        return field;
+    }
+    /**
+     * Serializes the fields to API format.
+     * Needed because a `Map` is otherwise serialized as an empty object by `JSON.stringify`.
+     */
+    toJSON() {
+        return Object.fromEntries(this);
+    }
+}

package/src/v2/product/extraction/ragDocuments/annotatedListField.d.ts

@@ -0,0 +1,26 @@
+import { StringDict } from "../../../../parsing/stringDict.js";
+import { AnnotatedBaseField } from "./annotatedBaseField.js";
+import { AnnotatedObjectField } from "./annotatedObjectField.js";
+import { AnnotatedSimpleField } from "./annotatedSimpleField.js";
+/**
+ * Field having a list of fields.
+ */
+export declare class AnnotatedListField extends AnnotatedBaseField {
+    /**
+     * Items contained in the list.
+     */
+    items: Array<AnnotatedListField | AnnotatedObjectField | AnnotatedSimpleField>;
+    constructor(serverResponse: StringDict);
+    /**
+     * AnnotatedSimpleField items from the list.
+     */
+    get simpleItems(): Array<AnnotatedSimpleField>;
+    /**
+     * AnnotatedObjectField items from the list.
+     */
+    get objectItems(): Array<AnnotatedObjectField>;
+    /**
+     * Returns a readable representation of list items.
+     */
+    toString(): string;
+}

package/src/v2/product/extraction/ragDocuments/annotatedListField.js

@@ -0,0 +1,69 @@
+import { MindeeDeserializationError } from "../../../../errors/index.js";
+import { AnnotatedBaseField } from "./annotatedBaseField.js";
+import { AnnotatedObjectField } from "./annotatedObjectField.js";
+import { AnnotatedSimpleField } from "./annotatedSimpleField.js";
+import { createAnnotatedField } from "./fieldFactory.js";
+/**
+ * Field having a list of fields.
+ */
+export class AnnotatedListField extends AnnotatedBaseField {
+    constructor(serverResponse) {
+        super(serverResponse["selected"], serverResponse["guidelines"]);
+        if (!Array.isArray(serverResponse["items"])) {
+            throw new MindeeDeserializationError(`Expected "items" to be an array in ${JSON.stringify(serverResponse)}.`);
+        }
+        this.items = serverResponse["items"].map((item) => {
+            return createAnnotatedField(item);
+        });
+    }
+    /**
+     * AnnotatedSimpleField items from the list.
+     */
+    get simpleItems() {
+        const result = [];
+        for (const item of this.items) {
+            if (item instanceof AnnotatedSimpleField) {
+                result.push(item);
+            }
+            else {
+                throw new MindeeDeserializationError(`All items must be AnnotatedSimpleField, found item of type ${item.constructor.name}.`);
+            }
+        }
+        return result;
+    }
+    /**
+     * AnnotatedObjectField items from the list.
+     */
+    get objectItems() {
+        const result = [];
+        for (const item of this.items) {
+            if (item instanceof AnnotatedObjectField) {
+                result.push(item);
+            }
+            else {
+                throw new MindeeDeserializationError(`All items must be AnnotatedObjectField, found item of type ${item.constructor.name}.`);
+            }
+        }
+        return result;
+    }
+    /**
+     * Returns a readable representation of list items.
+     */
+    toString() {
+        if (!this.items || this.items.length === 0) {
+            return "\n";
+        }
+        const parts = [""];
+        for (const item of this.items) {
+            if (!item)
+                continue;
+            if (item instanceof AnnotatedObjectField) {
+                parts.push(item.toStringFromList());
+            }
+            else {
+                parts.push(item.toString());
+            }
+        }
+        return parts.join("\n  * ");
+    }
+}

package/src/v2/product/extraction/ragDocuments/annotatedObjectField.d.ts

@@ -0,0 +1,43 @@
+import { AnnotatedBaseField } from "./annotatedBaseField.js";
+import { StringDict } from "../../../../parsing/index.js";
+import { AnnotatedFields } from "./annotatedFields.js";
+import { AnnotatedSimpleField } from "./annotatedSimpleField.js";
+import { AnnotatedListField } from "./annotatedListField.js";
+/**
+ * Field having a set of sub-fields.
+ */
+export declare class AnnotatedObjectField extends AnnotatedBaseField {
+    /**
+     * Nested fields carried by this object.
+     */
+    readonly fields: AnnotatedFields;
+    constructor(serverResponse: StringDict);
+    /**
+     * Retrieves a AnnotatedSimpleField by its name if it exists and is of the correct type.
+     *
+     * @param {string} fieldName - The name of the field to retrieve.
+     * @return {AnnotatedSimpleField} The field instance if it exists and is valid, or undefined if not.
+     * @throws {Error} If the field does not exist or is of wrong type.
+     */
+    getSimpleField(fieldName: string): AnnotatedSimpleField;
+    /**
+     * Retrieves a AnnotatedListField by its name if it exists and is of the correct type.
+     *
+     * @param {string} fieldName - The name of the field to retrieve.
+     * @return {AnnotatedListField} The field instance if it exists and is valid, or undefined if not.
+     * @throws {Error} If the field does not exist or is of wrong type.
+     */
+    getListField(fieldName: string): AnnotatedListField;
+    /**
+     * Retrieves an AnnotatedObjectField by its name if it exists and is of the correct type.
+     *
+     * @param {string} fieldName - The name of the field to retrieve.
+     * @return {AnnotatedObjectField} The field instance if it exists and is valid, or undefined if not.
+     * @throws {Error} If the field does not exist or is of wrong type.
+     */
+    getObjectField(fieldName: string): AnnotatedObjectField;
+    /**
+     * Returns a compact representation suitable for list items.
+     */
+    toStringFromList(): string;
+}

package/src/v2/product/extraction/ragDocuments/annotatedObjectField.js

@@ -0,0 +1,47 @@
+import { AnnotatedBaseField } from "./annotatedBaseField.js";
+import { AnnotatedFields } from "./annotatedFields.js";
+/**
+ * Field having a set of sub-fields.
+ */
+export class AnnotatedObjectField extends AnnotatedBaseField {
+    constructor(serverResponse) {
+        super(serverResponse["selected"], serverResponse["guidelines"]);
+        this.fields = new AnnotatedFields(serverResponse["fields"]);
+    }
+    /**
+     * Retrieves a AnnotatedSimpleField by its name if it exists and is of the correct type.
+     *
+     * @param {string} fieldName - The name of the field to retrieve.
+     * @return {AnnotatedSimpleField} The field instance if it exists and is valid, or undefined if not.
+     * @throws {Error} If the field does not exist or is of wrong type.
+     */
+    getSimpleField(fieldName) {
+        return this.fields.getSimpleField(fieldName);
+    }
+    /**
+     * Retrieves a AnnotatedListField by its name if it exists and is of the correct type.
+     *
+     * @param {string} fieldName - The name of the field to retrieve.
+     * @return {AnnotatedListField} The field instance if it exists and is valid, or undefined if not.
+     * @throws {Error} If the field does not exist or is of wrong type.
+     */
+    getListField(fieldName) {
+        return this.fields.getListField(fieldName);
+    }
+    /**
+     * Retrieves an AnnotatedObjectField by its name if it exists and is of the correct type.
+     *
+     * @param {string} fieldName - The name of the field to retrieve.
+     * @return {AnnotatedObjectField} The field instance if it exists and is valid, or undefined if not.
+     * @throws {Error} If the field does not exist or is of wrong type.
+     */
+    getObjectField(fieldName) {
+        return this.fields.getObjectField(fieldName);
+    }
+    /**
+     * Returns a compact representation suitable for list items.
+     */
+    toStringFromList() {
+        return this.fields ? this.fields.toString().substring(4) : "";
+    }
+}

package/src/v2/product/extraction/ragDocuments/annotatedSimpleField.d.ts

@@ -0,0 +1,15 @@
+import { AnnotatedBaseField } from "./annotatedBaseField.js";
+import { StringDict } from "../../../../parsing/index.js";
+/**
+ * A SimpleField with additional configuration for annotation.
+ */
+export declare class AnnotatedSimpleField extends AnnotatedBaseField {
+    /**
+     * Field value, one of: string, boolean, number, null.
+     */
+    value: string | boolean | number | null;
+    /**
+     * Default constructor.
+     */
+    constructor(serverResponse: StringDict);
+}

package/src/v2/product/extraction/ragDocuments/annotatedSimpleField.js

@@ -0,0 +1,13 @@
+import { AnnotatedBaseField } from "./annotatedBaseField.js";
+/**
+ * A SimpleField with additional configuration for annotation.
+ */
+export class AnnotatedSimpleField extends AnnotatedBaseField {
+    /**
+     * Default constructor.
+     */
+    constructor(serverResponse) {
+        super(serverResponse["selected"], serverResponse["guidelines"]);
+        this.value = serverResponse["value"];
+    }
+}

package/src/v2/product/extraction/ragDocuments/extractionRagAnnotationResponse.d.ts

@@ -0,0 +1,25 @@
+import { BaseRagAnnotationResponse } from "../../../parsing/baseRagAnnotationResponse.js";
+import { RagAnnotation } from "./ragAnnotation.js";
+import { StringDict } from "../../../../parsing/index.js";
+/**
+ * Response for a RAG document.
+ */
+export declare class ExtractionRagAnnotationResponse extends BaseRagAnnotationResponse {
+    /**
+     * Model identifier linked to the RAG document.
+     */
+    modelId: string;
+    /**
+     * Number of times this document was used in an inference.
+     */
+    totalMatches: number;
+    /**
+     * Date and time of the latest matching inference, if any.
+     */
+    lastMatchAt: Date | null;
+    /**
+     * Annotation metadata associated with the document.
+     */
+    annotation: RagAnnotation | null;
+    constructor(serverResponse: StringDict);
+}

package/src/v2/product/extraction/ragDocuments/extractionRagAnnotationResponse.js

@@ -0,0 +1,17 @@
+import { BaseRagAnnotationResponse } from "../../../parsing/baseRagAnnotationResponse.js";
+import { RagAnnotation } from "./ragAnnotation.js";
+import { parseDate } from "../../../../parsing/index.js";
+/**
+ * Response for a RAG document.
+ */
+export class ExtractionRagAnnotationResponse extends BaseRagAnnotationResponse {
+    constructor(serverResponse) {
+        super(serverResponse);
+        this.modelId = serverResponse["model_id"];
+        this.totalMatches = serverResponse["total_matches"];
+        this.lastMatchAt = parseDate(serverResponse["last_match_at"]);
+        this.annotation = serverResponse["annotation"]
+            ? new RagAnnotation(serverResponse["annotation"])
+            : null;
+    }
+}

package/src/v2/product/extraction/ragDocuments/fieldFactory.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Factory helper.
+ */
+import { StringDict } from "../../../../parsing/stringDict.js";
+import { AnnotatedListField } from "./annotatedListField.js";
+import { AnnotatedObjectField } from "./annotatedObjectField.js";
+import { AnnotatedSimpleField } from "./annotatedSimpleField.js";
+/**
+ * Create an annotated field from a server response.
+ * @param serverResponse Server response.
+ */
+export declare function createAnnotatedField(serverResponse: StringDict): AnnotatedSimpleField | AnnotatedListField | AnnotatedObjectField;

package/src/v2/product/extraction/ragDocuments/fieldFactory.js

@@ -0,0 +1,23 @@
+import { MindeeDeserializationError } from "../../../../errors/index.js";
+import { AnnotatedListField } from "./annotatedListField.js";
+import { AnnotatedObjectField } from "./annotatedObjectField.js";
+import { AnnotatedSimpleField } from "./annotatedSimpleField.js";
+/**
+ * Create an annotated field from a server response.
+ * @param serverResponse Server response.
+ */
+export function createAnnotatedField(serverResponse) {
+    if (typeof serverResponse !== "object" || serverResponse === null) {
+        throw new MindeeDeserializationError(`Unrecognized field format ${JSON.stringify(serverResponse)}.`);
+    }
+    if ("items" in serverResponse) {
+        return new AnnotatedListField(serverResponse);
+    }
+    if ("fields" in serverResponse) {
+        return new AnnotatedObjectField(serverResponse);
+    }
+    if ("value" in serverResponse) {
+        return new AnnotatedSimpleField(serverResponse);
+    }
+    throw new MindeeDeserializationError(`Unrecognized field format in ${JSON.stringify(serverResponse)}.`);
+}