mindee/src/v1/parsing/generated/generatedList.d.ts

Mindee Client Library for Node.js

import { StringDict } from "../../../parsing/stringDict.js";
import { StringField } from "../../../v1/parsing/standard/index.js";
import { GeneratedObjectField } from "./generatedObject.js";
export interface GeneratedListFieldConstructor {
    prediction: StringDict[];
    pageId?: number;
}
/**
 * A list of values or objects, used in generated APIs.
 */
export declare class GeneratedListField {
    /** Id of the page the object was found on. */
    pageId?: number;
    /** List of word values. */
    values: Array<GeneratedObjectField | StringField>;
    constructor({ prediction, pageId, }: GeneratedListFieldConstructor);
    /**
     * Returns an array of the contents of all values.
     */
    contentsList(): string[];
    /**
     * Return a string representation of all values.
     * @param separator Character(s) to use when concatenating fields.
     * @returns string representation.
     */
    contentsString(separator?: string): string;
    /**
     * Default string representation.
     */
    toString(): string;
}