npm - mindee - Versions diffs - 5.9.0 → 5.10.0 - Mend

mindee 5.9.0 → 5.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (318) hide show

package/src/v2/product/split/split.js CHANGED Viewed

@@ -5,15 +5,21 @@ import { BaseProduct } from "../baseProduct.js";
  * Break a multipage source file into separate documents, associating a class for each one.
  */
 export class Split extends BaseProduct {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get parametersClass() {
         return SplitParameters;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass() {
         return SplitResponse;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get slug() {
         return "split";
     }

package/src/v2/product/split/splitInference.d.ts CHANGED Viewed

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

package/src/v2/product/split/splitInference.js CHANGED Viewed

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

package/src/v2/product/split/splitRange.d.ts CHANGED Viewed

@@ -20,7 +20,9 @@ export declare class SplitRange {
      */
     extractionResponse?: ExtractionResponse;
     constructor(serverResponse: StringDict);
-    /** Returns a readable summary of the split range. */
+    /**
+     * Returns a readable summary of the split range.
+     */
     toString(): string;
     /**
      * Extracts a single split from the input file.

package/src/v2/product/split/splitRange.js CHANGED Viewed

@@ -11,7 +11,9 @@ export class SplitRange {
             ? new ExtractionResponse(serverResponse["extraction_response"])
             : undefined;
     }
-    /** Returns a readable summary of the split range. */
+    /**
+     * Returns a readable summary of the split range.
+     */
     toString() {
         const pageRange = this.pageRange.join(",");
         return `* :Page Range: ${pageRange}\n  :Document Type: ${this.documentType}`;

package/src/v2/product/split/splitResponse.d.ts CHANGED Viewed

@@ -1,7 +1,9 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { SplitInference } from "./splitInference.js";
 import { BaseResponse } from "../../parsing/index.js";
-/** Response wrapper for split product calls. */
+/**
+ * Response wrapper for split product calls.
+ */
 export declare class SplitResponse extends BaseResponse {
     /**
      * Response for an OCR utility inference.

package/src/v2/product/split/splitResponse.js CHANGED Viewed

@@ -1,6 +1,8 @@
 import { SplitInference } from "./splitInference.js";
 import { BaseResponse } from "../../parsing/index.js";
-/** Response wrapper for split product calls. */
+/**
+ * Response wrapper for split product calls.
+ */
 export class SplitResponse extends BaseResponse {
     /**
      * @param serverResponse JSON response from the server.

package/src/v2/product/split/splitResult.d.ts CHANGED Viewed

@@ -16,6 +16,8 @@ export declare class SplitResult {
      * @param inputSource The input file to extract from.
      */
     extractFromInputSource(inputSource: LocalInputSource): Promise<ExtractedPdfs>;
-    /** Returns a readable list of split ranges. */
+    /**
+     * Returns a readable list of split ranges.
+     */
     toString(): string;
 }

package/src/v2/product/split/splitResult.js CHANGED Viewed

@@ -18,7 +18,9 @@ export class SplitResult {
         }
         return await extractMultipleSplits(inputSource, splits);
     }
-    /** Returns a readable list of split ranges. */
+    /**
+     * Returns a readable list of split ranges.
+     */
     toString() {
         let splits = "\n";
         if (this.splits.length > 0) {

package/src/v2/search/baseSearch.d.ts CHANGED Viewed

@@ -6,10 +6,16 @@ import { BaseSearchParameters } from "../clientOptions/index.js";
  * Child classes are passed to the Client when making requests.
  */
 export declare abstract class BaseSearch {
-    /** Parameter class used for the search query. */
+    /**
+     * Parameter class used for the search query.
+     */
     static get parametersClass(): new (...args: any[]) => BaseSearchParameters;
-    /** Response class returned by the search. */
+    /**
+     * Response class returned by the search.
+     */
     static get responseClass(): ResponseConstructor<any>;
-    /** API slug for the search. */
+    /**
+     * API slug for the search.
+     */
     static get slug(): string;
 }

package/src/v2/search/baseSearch.js CHANGED Viewed

@@ -4,15 +4,21 @@
  * Child classes are passed to the Client when making requests.
  */
 export class BaseSearch {
-    /** Parameter class used for the search query. */
+    /**
+     * Parameter class used for the search query.
+     */
     static get parametersClass() {
         throw new Error("Must define static parametersClass property");
     }
-    /** Response class returned by the search. */
+    /**
+     * Response class returned by the search.
+     */
     static get responseClass() {
         throw new Error("Must define static response property");
     }
-    /** API slug for the search. */
+    /**
+     * API slug for the search.
+     */
     static get slug() {
         throw new Error("Must define static slug property");
     }

package/src/v2/search/models/modelSearch.d.ts CHANGED Viewed

@@ -10,10 +10,16 @@ import { ModelSearchResponse } from "./modelSearchResponse.js";
  * Results are paginated.
  */
 export declare class ModelSearch extends BaseSearch {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get parametersClass(): typeof ModelSearchParameters;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass(): typeof ModelSearchResponse;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get slug(): string;
 }

package/src/v2/search/models/modelSearch.js CHANGED Viewed

@@ -10,15 +10,21 @@ import { ModelSearchResponse } from "./modelSearchResponse.js";
  * Results are paginated.
  */
 export class ModelSearch extends BaseSearch {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get parametersClass() {
         return ModelSearchParameters;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass() {
         return ModelSearchResponse;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get slug() {
         return "models";
     }

package/src/v2/search/models/modelSearchParameters.d.ts CHANGED Viewed

@@ -19,6 +19,8 @@ export declare class ModelSearchParameters extends BaseSearchParameters {
      */
     modelType?: string;
     constructor(params?: ModelSearchParametersConstructor);
-    /** @inheritdoc */
+    /**
+     * @inheritdoc
+     */
     getRequestParameters(): Record<string, string>;
 }

package/src/v2/search/models/modelSearchParameters.js CHANGED Viewed

@@ -8,7 +8,9 @@ export class ModelSearchParameters extends BaseSearchParameters {
         this.name = params.name;
         this.modelType = params.modelType;
     }
-    /** @inheritdoc */
+    /**
+     * @inheritdoc
+     */
     getRequestParameters() {
         const parameters = super.getRequestParameters();
         if (this.name) {

package/src/v2/search/ragDocuments/ragDocumentSearch.d.ts CHANGED Viewed

@@ -5,10 +5,16 @@ import { RagDocumentSearchResponse } from "./ragDocumentSearchResponse.js";
  * Search for RAG Documents.
  */
 export declare class RagDocumentSearch extends BaseSearch {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get parametersClass(): typeof RagDocumentSearchParameters;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass(): typeof RagDocumentSearchResponse;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get slug(): string;
 }

package/src/v2/search/ragDocuments/ragDocumentSearch.js CHANGED Viewed

@@ -5,15 +5,21 @@ import { RagDocumentSearchResponse } from "./ragDocumentSearchResponse.js";
  * Search for RAG Documents.
  */
 export class RagDocumentSearch extends BaseSearch {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get parametersClass() {
         return RagDocumentSearchParameters;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass() {
         return RagDocumentSearchResponse;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get slug() {
         return "rag-documents";
     }

package/src/v2/search/ragDocuments/ragDocumentSearchParameters.d.ts CHANGED Viewed

@@ -19,6 +19,8 @@ export declare class RagDocumentSearchParameters extends BaseSearchParameters {
      */
     filename?: string;
     constructor(params: RagDocumentSearchParametersConstructor);
-    /** @inheritdoc */
+    /**
+     * @inheritdoc
+     */
     getRequestParameters(): Record<string, string>;
 }

package/src/v2/search/ragDocuments/ragDocumentSearchParameters.js CHANGED Viewed

@@ -12,7 +12,9 @@ export class RagDocumentSearchParameters extends BaseSearchParameters {
         this.modelId = params.modelId;
         this.filename = params.filename;
     }
-    /** @inheritdoc */
+    /**
+     * @inheritdoc
+     */
     getRequestParameters() {
         const parameters = super.getRequestParameters();
         parameters["model_id"] = this.modelId;