Kizuki
    Preparing search index...

    Interface MaterialState

    A material (one added file) as it stands now.

    interface MaterialState {
        addedAt: string;
        bytes: number;
        courseId: string;
        dropped: number;
        error?: string;
        fileName: string;
        format: "pdf" | "pptx" | "docx" | "xlsx" | "csv" | "md" | "txt";
        linksProposed: number;
        materialId: string;
        passageCount: number;
        proposed: number;
        runId?: string;
        sections: {
            heading?: boolean;
            level: number;
            ordinal: number;
            sectionId: string;
            title: string;
        }[];
        sha256: string;
        status: MaterialStatus;
        storedName: string;
        updatedAt: string;
    }
    Index
    addedAt bytes courseId dropped error? fileName format linksProposed materialId passageCount proposed runId? sections sha256 status storedName updatedAt
    addedAt: string

    When the file was added, as an ISO time string.

    bytes: number

    The file's size in bytes.

    courseId: string

    The course the file was added to.

    dropped: number

    How many of the model's concept proposals failed the checks and were dropped.

    error?: string

    Why processing failed. undefined unless the last attempt failed; cleared when processing starts again.

    fileName: string

    The file's name when you added it.

    format: "pdf" | "pptx" | "docx" | "xlsx" | "csv" | "md" | "txt"

    The file's format, worked out from its ending.

    linksProposed: number

    How many prerequisite links between the course's confirmed concepts were proposed in the material's last step. 0 until then.

    materialId: string

    The material's id: mat_ and 16 hex characters.

    passageCount: number

    How many passages were read from the file. 0 until the file has been read.

    proposed: number

    How many concepts were proposed for the material. 0 until concepts are proposed.

    runId?: string

    The id of the workflow run that last started processing it. undefined until processing starts.

    sections: {
        heading?: boolean;
        level: number;
        ordinal: number;
        sectionId: string;
        title: string;
    }[]

    The headings read from the file. Empty until the file has been read.

    Type Declaration

    • Optionalheading?: boolean

      True when the title is a real heading of the material, not a page number or a file name.

    • level: number
    • ordinal: number
    • sectionId: string
    • title: string
    sha256: string

    The SHA-256 fingerprint of the file's bytes, as 64 lower-case hex characters. Used to refuse the same file twice in one course.

    status: MaterialStatus

    Where the material is in its processing.

    storedName: string

    The name of Kizuki's copy in files/: the material id plus the file's ending in lower case, such as mat_0123456789abcdef.pdf.

    updatedAt: string

    When the last event for this material was recorded.

    Settings
    Member Visibility

    On This Page
    Properties