mindee 5.8.0 → 5.10.0

package/src/v2/product/classification/classificationInference.js

@@ -1,12 +1,16 @@
-import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
+import { BaseInference } from "../../parsing/inference/baseInference.js";
 import { ClassificationResult } from "./classificationResult.js";
-/** Inference payload for classification responses. */
+/**
+ * Inference payload for classification responses.
+ */
 export class ClassificationInference extends BaseInference {
     constructor(serverResponse) {
         super(serverResponse);
         this.result = new ClassificationResult(serverResponse["result"]);
     }
-    /** Returns a readable representation of the inference. */
+    /**
+     * Returns a readable representation of the inference.
+     */
     toString() {
         return (super.toString() +
             this.result.toString() + "\n");

package/src/v2/product/classification/classificationResponse.d.ts

@@ -1,7 +1,9 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { ClassificationInference } from "./classificationInference.js";
-import { BaseResponse } from "../../../v2/parsing/index.js";
-/** Response wrapper for classification product calls. */
+import { BaseResponse } from "../../parsing/index.js";
+/**
+ * Response wrapper for classification product calls.
+ */
 export declare class ClassificationResponse extends BaseResponse {
     /**
      * The inference result for a classification utility request.

package/src/v2/product/classification/classificationResponse.js

@@ -1,6 +1,8 @@
 import { ClassificationInference } from "./classificationInference.js";
-import { BaseResponse } from "../../../v2/parsing/index.js";
-/** Response wrapper for classification product calls. */
+import { BaseResponse } from "../../parsing/index.js";
+/**
+ * Response wrapper for classification product calls.
+ */
 export class ClassificationResponse extends BaseResponse {
     /**
      * @param serverResponse JSON response from the server.

package/src/v2/product/classification/classificationResult.d.ts

@@ -1,12 +1,16 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { ClassificationClassifier } from "./classificationClassifier.js";
-/** Classification section of a classification inference result. */
+/**
+ * Classification section of a classification inference result.
+ */
 export declare class ClassificationResult {
     /**
      * Fields contained in the inference.
      */
     classification: ClassificationClassifier;
     constructor(serverResponse: StringDict);
-    /** Returns a readable classification summary. */
+    /**
+     * Returns a readable classification summary.
+     */
     toString(): string;
 }

package/src/v2/product/classification/classificationResult.js

@@ -1,10 +1,14 @@
 import { ClassificationClassifier } from "./classificationClassifier.js";
-/** Classification section of a classification inference result. */
+/**
+ * Classification section of a classification inference result.
+ */
 export class ClassificationResult {
     constructor(serverResponse) {
         this.classification = new ClassificationClassifier(serverResponse["classification"]);
     }
-    /** Returns a readable classification summary. */
+    /**
+     * Returns a readable classification summary.
+     */
     toString() {
         return `Classification\n==============\n${this.classification}`;
     }

package/src/v2/product/classification/params/classificationParameters.d.ts

@@ -1,4 +1,4 @@
-import { BaseProductParameters, BaseProductParametersConstructor } from "../../../../v2/clientOptions/baseProductParameters.js";
+import { BaseProductParameters, BaseProductParametersConstructor } from "../../../clientOptions/baseProductParameters.js";
 /**
  * Parameters for sending a file to a Classification product.
  */

package/src/v2/product/classification/params/classificationParameters.js

@@ -1,4 +1,4 @@
-import { BaseProductParameters } from "../../../../v2/clientOptions/baseProductParameters.js";
+import { BaseProductParameters } from "../../../clientOptions/baseProductParameters.js";
 import { logger } from "../../../../logger.js";
 /**
  * Parameters for sending a file to a Classification product.

package/src/v2/product/crop/crop.d.ts

@@ -1,14 +1,20 @@
 import { CropResponse } from "./cropResponse.js";
 import { CropParameters } from "./params/index.js";
-import { BaseProduct } from "../../../v2/product/baseProduct.js";
+import { BaseProduct } from "../baseProduct.js";
 /**
  * Identify the borders of documents on each page, matching each one to a category.
  */
 export declare class Crop extends BaseProduct {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get parametersClass(): typeof CropParameters;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass(): typeof CropResponse;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get slug(): string;
 }

package/src/v2/product/crop/crop.js

@@ -1,19 +1,25 @@
 import { CropResponse } from "./cropResponse.js";
 import { CropParameters } from "./params/index.js";
-import { BaseProduct } from "../../../v2/product/baseProduct.js";
+import { BaseProduct } from "../baseProduct.js";
 /**
  * Identify the borders of documents on each page, matching each one to a category.
  */
 export class Crop extends BaseProduct {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get parametersClass() {
         return CropParameters;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass() {
         return CropResponse;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get slug() {
         return "crop";
     }

package/src/v2/product/crop/cropInference.d.ts

@@ -1,13 +1,17 @@
 import { StringDict } from "../../../parsing/index.js";
-import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
-import { CropResult } from "../../../v2/product/crop/cropResult.js";
-/** Inference payload for crop responses. */
+import { BaseInference } from "../../parsing/inference/baseInference.js";
+import { CropResult } from "./cropResult.js";
+/**
+ * Inference payload for crop responses.
+ */
 export declare class CropInference extends BaseInference {
     /**
      * Result of a crop utility inference.
      */
     result: CropResult;
     constructor(serverResponse: StringDict);
-    /** Returns a readable representation of the inference. */
+    /**
+     * Returns a readable representation of the inference.
+     */
     toString(): string;
 }

package/src/v2/product/crop/cropInference.js

@@ -1,12 +1,16 @@
-import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
-import { CropResult } from "../../../v2/product/crop/cropResult.js";
-/** Inference payload for crop responses. */
+import { BaseInference } from "../../parsing/inference/baseInference.js";
+import { CropResult } from "./cropResult.js";
+/**
+ * Inference payload for crop responses.
+ */
 export class CropInference extends BaseInference {
     constructor(serverResponse) {
         super(serverResponse);
         this.result = new CropResult(serverResponse["result"]);
     }
-    /** Returns a readable representation of the inference. */
+    /**
+     * Returns a readable representation of the inference.
+     */
     toString() {
         return (super.toString() +
             this.result.toString() + "\n");

package/src/v2/product/crop/cropItem.d.ts

@@ -1,9 +1,11 @@
-import { FieldLocation } from "../../../v2/parsing/inference/field/index.js";
+import { FieldLocation } from "../../parsing/inference/field/index.js";
 import { StringDict } from "../../../parsing/index.js";
 import { LocalInputSource } from "../../../input/index.js";
 import { ExtractedImage } from "../../../image/index.js";
-import { ExtractionResponse } from "../../../v2/product/index.js";
-/** Single crop detection returned by the crop product. */
+import { ExtractionResponse } from "../index.js";
+/**
+ * Single crop detection returned by the crop product.
+ */
 export declare class CropItem {
     /**
      * Type or classification of the detected object.
@@ -18,7 +20,9 @@ export declare class CropItem {
      */
     extractionResponse?: ExtractionResponse;
     constructor(serverResponse: StringDict);
-    /** Returns a readable crop item summary. */
+    /**
+     * Returns a readable crop item summary.
+     */
     toString(): string;
     /**
      * Extracts a single crop from an input.

package/src/v2/product/crop/cropItem.js

@@ -1,7 +1,9 @@
-import { FieldLocation } from "../../../v2/parsing/inference/field/index.js";
-import { extractSingleCrop } from "../../../v2/fileOperations/crop.js";
-import { ExtractionResponse } from "../../../v2/product/index.js";
-/** Single crop detection returned by the crop product. */
+import { FieldLocation } from "../../parsing/inference/field/index.js";
+import { extractSingleCrop } from "../../fileOperations/crop.js";
+import { ExtractionResponse } from "../index.js";
+/**
+ * Single crop detection returned by the crop product.
+ */
 export class CropItem {
     constructor(serverResponse) {
         this.objectType = serverResponse["object_type"];
@@ -10,7 +12,9 @@ export class CropItem {
             ? new ExtractionResponse(serverResponse["extraction_response"])
             : undefined;
     }
-    /** Returns a readable crop item summary. */
+    /**
+     * Returns a readable crop item summary.
+     */
     toString() {
         return `* :Location: ${this.location}\n  :Object Type: ${this.objectType}`;
     }

package/src/v2/product/crop/cropResponse.d.ts

@@ -1,7 +1,9 @@
 import { StringDict } from "../../../parsing/stringDict.js";
-import { BaseResponse } from "../../../v2/parsing/index.js";
+import { BaseResponse } from "../../parsing/index.js";
 import { CropInference } from "./cropInference.js";
-/** Response wrapper for crop product calls. */
+/**
+ * Response wrapper for crop product calls.
+ */
 export declare class CropResponse extends BaseResponse {
     /**
      * Response for a crop utility inference.

package/src/v2/product/crop/cropResponse.js

@@ -1,6 +1,8 @@
-import { BaseResponse } from "../../../v2/parsing/index.js";
+import { BaseResponse } from "../../parsing/index.js";
 import { CropInference } from "./cropInference.js";
-/** Response wrapper for crop product calls. */
+/**
+ * Response wrapper for crop product calls.
+ */
 export class CropResponse extends BaseResponse {
     /**
      * @param serverResponse JSON response from the server.

package/src/v2/product/crop/cropResult.d.ts

@@ -1,15 +1,19 @@
 import { StringDict } from "../../../parsing/stringDict.js";
-import { CropItem } from "../../../v2/product/crop/cropItem.js";
+import { CropItem } from "./cropItem.js";
 import { LocalInputSource } from "../../../input/index.js";
 import { ExtractedImages } from "../../../image/extractedImages.js";
-/** Crop section of a crop inference result. */
+/**
+ * Crop section of a crop inference result.
+ */
 export declare class CropResult {
     /**
      * Fields contained in the inference.
      */
     crops: CropItem[];
     constructor(serverResponse: StringDict);
-    /** Returns a readable list of detected crops. */
+    /**
+     * Returns a readable list of detected crops.
+     */
     toString(): string;
     /**
      * Extracts a single crop from an input.

package/src/v2/product/crop/cropResult.js

@@ -1,6 +1,8 @@
-import { CropItem } from "../../../v2/product/crop/cropItem.js";
-import { extractMultipleCrops } from "../../../v2/fileOperations/crop.js";
-/** Crop section of a crop inference result. */
+import { CropItem } from "./cropItem.js";
+import { extractMultipleCrops } from "../../fileOperations/crop.js";
+/**
+ * Crop section of a crop inference result.
+ */
 export class CropResult {
     constructor(serverResponse) {
         /**
@@ -9,7 +11,9 @@ export class CropResult {
         this.crops = [];
         this.crops = serverResponse["crops"].map((cropItem) => new CropItem(cropItem));
     }
-    /** Returns a readable list of detected crops. */
+    /**
+     * Returns a readable list of detected crops.
+     */
     toString() {
         const crops = this.crops.map(item => item.toString()).join("\n");
         return `Crops\n=====\n${crops}`;

package/src/v2/product/crop/params/cropParameters.d.ts

@@ -1,4 +1,4 @@
-import { BaseProductParameters, BaseProductParametersConstructor } from "../../../../v2/clientOptions/baseProductParameters.js";
+import { BaseProductParameters, BaseProductParametersConstructor } from "../../../clientOptions/baseProductParameters.js";
 /**
  * Parameters for sending a file to a Crop product.
  */

package/src/v2/product/crop/params/cropParameters.js

@@ -1,4 +1,4 @@
-import { BaseProductParameters } from "../../../../v2/clientOptions/baseProductParameters.js";
+import { BaseProductParameters } from "../../../clientOptions/baseProductParameters.js";
 import { logger } from "../../../../logger.js";
 /**
  * Parameters for sending a file to a Crop product.

package/src/v2/product/extraction/dataSchemaActiveOption.d.ts

@@ -8,6 +8,8 @@ export declare class DataSchemaActiveOption {
      */
     replace: boolean;
     constructor(serverResponse: StringDict);
-    /** Returns a readable representation of active data schema options. */
+    /**
+     * Returns a readable representation of active data schema options.
+     */
     toString(): string;
 }

package/src/v2/product/extraction/dataSchemaActiveOption.js

@@ -5,7 +5,9 @@ export class DataSchemaActiveOption {
     constructor(serverResponse) {
         this.replace = serverResponse["replace"];
     }
-    /** Returns a readable representation of active data schema options. */
+    /**
+     * Returns a readable representation of active data schema options.
+     */
     toString() {
         return `Data Schema\n-----------\n:Replace: ${this.replace ? "True" : "False"}`;
     }

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

@@ -1,14 +1,34 @@
 import { ExtractionResponse } from "./extractionResponse.js";
 import { ExtractionParameters } from "./params/index.js";
-import { BaseProduct } from "../../../v2/product/baseProduct.js";
+import { BaseProduct } from "../baseProduct.js";
+import { ExtractionRagAnnotationResponse } from "./ragDocuments/index.js";
+import { RagDocumentAnnotationParameters, RagDocumentUploadParameters } from "./ragDocuments/params/index.js";
 /**
  * Automatically extract structured data from any image or scanned document.
  */
 export declare class Extraction extends BaseProduct {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
+    static get slug(): string;
+    /**
+     * @inheritDoc
+     */
     static get parametersClass(): typeof ExtractionParameters;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass(): typeof ExtractionResponse;
-    /** @inheritDoc */
-    static get slug(): string;
+    /**
+     * @inheritDoc
+     */
+    static get annotationResponseClass(): typeof ExtractionRagAnnotationResponse;
+    /**
+     * @inheritDoc
+     */
+    static get annotationParametersClass(): typeof RagDocumentAnnotationParameters;
+    /**
+     * @inheritDoc
+     */
+    static get ragDocumentUploadClass(): typeof RagDocumentUploadParameters;
 }

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

@@ -1,20 +1,46 @@
 import { ExtractionResponse } from "./extractionResponse.js";
 import { ExtractionParameters } from "./params/index.js";
-import { BaseProduct } from "../../../v2/product/baseProduct.js";
+import { BaseProduct } from "../baseProduct.js";
+import { ExtractionRagAnnotationResponse } from "./ragDocuments/index.js";
+import { RagDocumentAnnotationParameters, RagDocumentUploadParameters } from "./ragDocuments/params/index.js";
 /**
  * Automatically extract structured data from any image or scanned document.
  */
 export class Extraction extends BaseProduct {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
+    static get slug() {
+        return "extraction";
+    }
+    /**
+     * @inheritDoc
+     */
     static get parametersClass() {
         return ExtractionParameters;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass() {
         return ExtractionResponse;
     }
-    /** @inheritDoc */
-    static get slug() {
-        return "extraction";
+    /**
+     * @inheritDoc
+     */
+    static get annotationResponseClass() {
+        return ExtractionRagAnnotationResponse;
+    }
+    /**
+     * @inheritDoc
+     */
+    static get annotationParametersClass() {
+        return RagDocumentAnnotationParameters;
+    }
+    /**
+     * @inheritDoc
+     */
+    static get ragDocumentUploadClass() {
+        return RagDocumentUploadParameters;
     }
 }

package/src/v2/product/extraction/extractionActiveOptions.d.ts

@@ -1,6 +1,8 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { DataSchemaActiveOption } from "./dataSchemaActiveOption.js";
-/** Active extraction options echoed by the API. */
+/**
+ * Active extraction options echoed by the API.
+ */
 export declare class ExtractionActiveOptions {
     /**
      * Whether the RAG feature was activated.
@@ -27,6 +29,8 @@ export declare class ExtractionActiveOptions {
      */
     dataSchema: DataSchemaActiveOption;
     constructor(serverResponse: StringDict);
-    /** Returns a readable representation of active options. */
+    /**
+     * Returns a readable representation of active options.
+     */
     toString(): string;
 }

package/src/v2/product/extraction/extractionActiveOptions.js

@@ -1,5 +1,7 @@
 import { DataSchemaActiveOption } from "./dataSchemaActiveOption.js";
-/** Active extraction options echoed by the API. */
+/**
+ * Active extraction options echoed by the API.
+ */
 export class ExtractionActiveOptions {
     constructor(serverResponse) {
         this.rag = serverResponse["rag"];
@@ -9,7 +11,9 @@ export class ExtractionActiveOptions {
         this.textContext = serverResponse["text_context"];
         this.dataSchema = new DataSchemaActiveOption(serverResponse["data_schema"]);
     }
-    /** Returns a readable representation of active options. */
+    /**
+     * Returns a readable representation of active options.
+     */
     toString() {
         return "Active Options\n" +
             "==============\n" +

package/src/v2/product/extraction/extractionInference.d.ts

@@ -1,8 +1,10 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { ExtractionResult } from "./extractionResult.js";
 import { ExtractionActiveOptions } from "./extractionActiveOptions.js";
-import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
-/** Inference payload for extraction responses. */
+import { BaseInference } from "../../parsing/inference/baseInference.js";
+/**
+ * Inference payload for extraction responses.
+ */
 export declare class ExtractionInference extends BaseInference {
     /**
      * Result of the inference.
@@ -13,6 +15,8 @@ export declare class ExtractionInference extends BaseInference {
      */
     activeOptions: ExtractionActiveOptions;
     constructor(serverResponse: StringDict);
-    /** Returns a readable representation of the inference. */
+    /**
+     * Returns a readable representation of the inference.
+     */
     toString(): string;
 }

package/src/v2/product/extraction/extractionInference.js

@@ -1,14 +1,18 @@
 import { ExtractionResult } from "./extractionResult.js";
 import { ExtractionActiveOptions } from "./extractionActiveOptions.js";
-import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
-/** Inference payload for extraction responses. */
+import { BaseInference } from "../../parsing/inference/baseInference.js";
+/**
+ * Inference payload for extraction responses.
+ */
 export class ExtractionInference extends BaseInference {
     constructor(serverResponse) {
         super(serverResponse);
         this.result = new ExtractionResult(serverResponse["result"]);
         this.activeOptions = new ExtractionActiveOptions(serverResponse["active_options"]);
     }
-    /** Returns a readable representation of the inference. */
+    /**
+     * Returns a readable representation of the inference.
+     */
     toString() {
         return (super.toString() +
             this.activeOptions.toString() + "\n" +

package/src/v2/product/extraction/extractionResponse.d.ts

@@ -1,7 +1,9 @@
 import { ExtractionInference } from "./extractionInference.js";
 import { StringDict } from "../../../parsing/stringDict.js";
-import { BaseResponse } from "../../../v2/parsing/index.js";
-/** Response wrapper for extraction product calls. */
+import { BaseResponse } from "../../parsing/index.js";
+/**
+ * Response wrapper for extraction product calls.
+ */
 export declare class ExtractionResponse extends BaseResponse {
     /**
      * The inference result for an extraction request.

package/src/v2/product/extraction/extractionResponse.js

@@ -1,6 +1,8 @@
 import { ExtractionInference } from "./extractionInference.js";
-import { BaseResponse } from "../../../v2/parsing/index.js";
-/** Response wrapper for extraction product calls. */
+import { BaseResponse } from "../../parsing/index.js";
+/**
+ * Response wrapper for extraction product calls.
+ */
 export class ExtractionResponse extends BaseResponse {
     /**
      * @param serverResponse JSON response from the server.

package/src/v2/product/extraction/extractionResult.d.ts

@@ -1,8 +1,10 @@
-import { InferenceFields } from "../../../v2/parsing/inference/field/index.js";
+import { InferenceFields } from "../../parsing/inference/field/index.js";
 import { StringDict } from "../../../parsing/stringDict.js";
-import { RawText } from "../../../v2/parsing/inference/field/rawText.js";
-import { RagMetadata } from "../../../v2/parsing/inference/field/ragMetadata.js";
-/** Extraction result payload containing fields and optional extras. */
+import { RawText } from "../../parsing/inference/field/rawText.js";
+import { RagMetadata } from "../../parsing/inference/field/ragMetadata.js";
+/**
+ * Extraction result payload containing fields and optional extras.
+ */
 export declare class ExtractionResult {
     /**
      * Fields contained in the inference.
@@ -17,6 +19,8 @@ export declare class ExtractionResult {
      */
     rag?: RagMetadata;
     constructor(serverResponse: StringDict);
-    /** Returns a readable representation of extracted fields. */
+    /**
+     * Returns a readable representation of extracted fields.
+     */
     toString(): string;
 }

package/src/v2/product/extraction/extractionResult.js

@@ -1,7 +1,9 @@
-import { InferenceFields } from "../../../v2/parsing/inference/field/index.js";
-import { RawText } from "../../../v2/parsing/inference/field/rawText.js";
-import { RagMetadata } from "../../../v2/parsing/inference/field/ragMetadata.js";
-/** Extraction result payload containing fields and optional extras. */
+import { InferenceFields } from "../../parsing/inference/field/index.js";
+import { RawText } from "../../parsing/inference/field/rawText.js";
+import { RagMetadata } from "../../parsing/inference/field/ragMetadata.js";
+/**
+ * Extraction result payload containing fields and optional extras.
+ */
 export class ExtractionResult {
     constructor(serverResponse) {
         this.fields = new InferenceFields(serverResponse["fields"]);
@@ -12,7 +14,9 @@ export class ExtractionResult {
             this.rag = new RagMetadata(serverResponse["rag"]);
         }
     }
-    /** Returns a readable representation of extracted fields. */
+    /**
+     * Returns a readable representation of extracted fields.
+     */
     toString() {
         return `Fields\n======\n${this.fields}`;
     }

package/src/v2/product/extraction/index.d.ts

@@ -6,3 +6,4 @@ export { ExtractionActiveOptions } from "./extractionActiveOptions.js";
 export { ExtractionResponse } from "./extractionResponse.js";
 export { ExtractionResult } from "./extractionResult.js";
 export { DataSchemaActiveOption } from "./dataSchemaActiveOption.js";
+export * as ragDocuments from "./ragDocuments/index.js";

package/src/v2/product/extraction/index.js

@@ -6,3 +6,4 @@ export { ExtractionActiveOptions } from "./extractionActiveOptions.js";
 export { ExtractionResponse } from "./extractionResponse.js";
 export { ExtractionResult } from "./extractionResult.js";
 export { DataSchemaActiveOption } from "./dataSchemaActiveOption.js";
+export * as ragDocuments from "./ragDocuments/index.js";