mindee/src/parsing/custom/listField.d.ts

Mindee Client Library for Node.js

import { BaseFieldConstructor } from "../standard";
import { Polygon, BoundingBox } from "../../geometry";
import { StringDict } from "../common";
export declare class ListFieldValue {
    /** Extracted content of the prediction */
    content: string;
    /**
     * The confidence score of the prediction.
     * Note: Score is calculated on **word selection**, not its textual content (OCR).
     */
    confidence: number;
    /**
     * Contains exactly 4 relative vertices coordinates (points) of a right
     * rectangle containing the word in the document.
     */
    bbox?: BoundingBox;
    /**
     * Contains the relative vertices coordinates (points) of a polygon containing
     * the word in the document.
     */
    polygon: Polygon;
    /** The document page on which the information was found. */
    pageId?: number;
    constructor(prediction: StringDict, pageId?: number);
    /**
     * Default string representation.
     */
    toString(): string;
}
export declare class ListField {
    readonly values: ListFieldValue[];
    confidence: number;
    /** True if the field was reconstructed or computed using other fields. */
    reconstructed: boolean;
    /**
     * @param {BaseFieldConstructor} constructor Constructor parameters.
     */
    constructor({ prediction, reconstructed, pageId, }: BaseFieldConstructor);
    contentsList(): Array<string | number>;
    contentsString(separator?: string): string;
    /**
     * Default string representation.
     */
    toString(): string;
}