providerplaneai
    Preparing search index...

    Interface ClientOCRStructuredOptions

    Optional structured OCR extraction settings used by providers with richer document understanding APIs.

    interface ClientOCRStructuredOptions {
        annotationMode?: ClientOCRAnnotationMode;
        annotationPrompt?: string;
        annotationSchema?: ClientOCRAnnotationSchema;
        extractFooters?: boolean;
        extractHeaders?: boolean;
        pages?: number[];
        tableFormat?: ClientOCRTableFormat;
    }
    Index

    Properties

    annotationMode? annotationPrompt? annotationSchema? extractFooters? extractHeaders? pages? tableFormat?

    Properties

    annotationMode?: ClientOCRAnnotationMode

    Structured annotation mode requested from the provider.

    annotationPrompt?: string

    Prompt describing which annotations should be extracted.

    Some providers require annotationFormat to be set when this field is used.

    annotationSchema?: ClientOCRAnnotationSchema

    Structured schema required by providers that support schema-constrained annotation extraction.

    extractFooters?: boolean

    Whether document footers should be extracted when the provider supports it.

    extractHeaders?: boolean

    Whether document headers should be extracted when the provider supports it.

    pages?: number[]

    Optional one-based page numbers to process.

    tableFormat?: ClientOCRTableFormat

    Preferred table serialization format when table extraction is available.

    Settings

    Member Visibility

    On This Page

    Properties