box-node-sdk/lib/schemas/aiExtractSubField.d.ts

Official SDK for Box Platform APIs

import { AiExtractFieldOption } from './aiExtractFieldOption.js';
import { SerializedData } from '../serialization/json.js';
export interface AiExtractSubField {
    /**
     * A unique identifier for the nested field. */
    readonly key: string;
    /**
     * A description of the nested field. */
    readonly description?: string;
    /**
     * The display name of the nested field. */
    readonly displayName?: string;
    /**
     * Context about the nested field that may include how to find and how to format it. */
    readonly prompt?: string;
    /**
     * The type of the nested field. Allowed types include `string`, `float`, `date`, `number`, `text`, `boolean`, `enum` and `multiSelect`. */
    readonly type?: string;
    /**
     * A list of options for this nested field. Used with `enum` and `multiSelect` types. */
    readonly options?: readonly AiExtractFieldOption[];
    readonly rawData?: SerializedData;
}
export declare function serializeAiExtractSubField(val: AiExtractSubField): SerializedData;
export declare function deserializeAiExtractSubField(val: SerializedData): AiExtractSubField;
//# sourceMappingURL=aiExtractSubField.d.ts.map