mindee/src/product/resume/resumeV1Education.d.ts

Mindee Client Library for Node.js

import { StringDict } from "../../parsing/common";
import { Polygon } from "../../geometry";
/**
 * The list of the candidate's educational background.
 */
export declare class ResumeV1Education {
    #private;
    /** The area of study or specialization. */
    degreeDomain: string | null;
    /** The type of degree obtained, such as Bachelor's, Master's, or Doctorate. */
    degreeType: string | null;
    /** The month when the education program or course was completed. */
    endMonth: string | null;
    /** The year when the education program or course was completed. */
    endYear: string | null;
    /** The name of the school. */
    school: string | null;
    /** The month when the education program or course began. */
    startMonth: string | null;
    /** The year when the education program or course began. */
    startYear: string | null;
    /** Confidence score */
    confidence: number;
    /** The document page on which the information was found. */
    pageId: number;
    /**
     * Contains the relative vertices coordinates (points) of a polygon containing
     * the field in the document.
     */
    polygon: Polygon;
    constructor({ prediction }: StringDict);
    /**
     * Default string representation.
     */
    toString(): string;
    /**
     * Output in a format suitable for inclusion in an rST table.
     */
    toTableLine(): string;
}