mindee/src/parsing/v2/field/fieldConfidence.d.ts

Mindee Client Library for Node.js

/**
 * Confidence level of a field as returned by the V2 API.
 */
export declare enum FieldConfidence {
    Certain = "Certain",
    High = "High",
    Medium = "Medium",
    Low = "Low"
}
export declare namespace FieldConfidence {
    /**
     * Converts a FieldConfidence value to an integer.
     * @param confidence The FieldConfidence value to convert
     * @returns Integer representation (Certain=4, High=3, Medium=2, Low=1)
     */
    function toInt(confidence: FieldConfidence | undefined): number;
    /**
     * Checks if the first FieldConfidence is greater than the second.
     * @param a First FieldConfidence value
     * @param b Second FieldConfidence value
     * @returns true if a > b
     */
    function greaterThan(a: FieldConfidence | undefined, b: FieldConfidence | undefined): boolean;
    /**
     * Checks if the first FieldConfidence is greater than or equal to the second.
     * @param a First FieldConfidence value
     * @param b Second FieldConfidence value
     * @returns true if a >= b
     */
    function greaterThanOrEqual(a: FieldConfidence | undefined, b: FieldConfidence | undefined): boolean;
    /**
     * Checks if the first FieldConfidence is less than the second.
     * @param a First FieldConfidence value
     * @param b Second FieldConfidence value
     * @returns true if a < b
     */
    function lessThan(a: FieldConfidence | undefined, b: FieldConfidence | undefined): boolean;
    /**
     * Checks if the first FieldConfidence is less than or equal to the second.
     * @param a First FieldConfidence value
     * @param b Second FieldConfidence value
     * @returns true if a <= b
     */
    function lessThanOrEqual(a: FieldConfidence | undefined, b: FieldConfidence | undefined): boolean;
}