providerplaneai
    Preparing search index...

    Class OpenAIOCRCapabilityImpl

    OCR capability contract.

    Implements

    Index

    Constructors

    constructor

    Properties

    OPENAI_OCR_SCHEMA OPENAI_OCR_TOOL

    Methods

    ocr

    Constructors

    Properties

    OPENAI_OCR_SCHEMA: {
        additionalProperties: boolean;
        properties: {
            annotations: {
                items: {
                    additionalProperties: boolean;
                    properties: {
                        data: {
                            anyOf: (
                                | {
                                    additionalProperties: boolean;
                                    items?: undefined;
                                    type: string;
                                }
                                | { additionalProperties?: undefined; items: {}; type: string }
                            )[];
                        };
                        label: { type: string };
                        pageNumber: { type: string };
                        text: { type: string };
                        type: { enum: string[]; type: string };
                    };
                    required: never[];
                    type: string;
                };
                type: string;
            };
            footers: {
                items: {
                    additionalProperties: boolean;
                    properties: { pageNumber: { type: string }; text: { type: string } };
                    required: never[];
                    type: string;
                };
                type: string;
            };
            fullText: { type: string };
            headers: {
                items: {
                    additionalProperties: boolean;
                    properties: { pageNumber: { type: string }; text: { type: string } };
                    required: never[];
                    type: string;
                };
                type: string;
            };
            language: { type: string };
            pages: {
                items: {
                    additionalProperties: boolean;
                    properties: { fullText: { type: string }; pageNumber: { type: string } };
                    required: never[];
                    type: string;
                };
                type: string;
            };
        };
        required: never[];
        type: string;
    } = ...

    JSON schema used to constrain OpenAI OCR tool output.

    This adapter routes OCR through the Responses API and normalizes the tool payload into NormalizedOCRDocument.

    Practical format support is intentionally left to the provider. Local playground validation in this repo has been strongest for PDF plus common image/document inputs, while some less common image formats such as BMP and TIFF have failed provider-side.

    OPENAI_OCR_TOOL: {
        description: string;
        name: string;
        parameters: {
            additionalProperties: boolean;
            properties: {
                annotations: {
                    items: {
                        additionalProperties: boolean;
                        properties: {
                            data: {
                                anyOf: (
                                    | {
                                        additionalProperties: boolean;
                                        items?: undefined;
                                        type: string;
                                    }
                                    | { additionalProperties?: undefined; items: {}; type: string }
                                )[];
                            };
                            label: { type: string };
                            pageNumber: { type: string };
                            text: { type: string };
                            type: { enum: string[]; type: string };
                        };
                        required: never[];
                        type: string;
                    };
                    type: string;
                };
                footers: {
                    items: {
                        additionalProperties: boolean;
                        properties: { pageNumber: { type: string }; text: { type: string } };
                        required: never[];
                        type: string;
                    };
                    type: string;
                };
                fullText: { type: string };
                headers: {
                    items: {
                        additionalProperties: boolean;
                        properties: { pageNumber: { type: string }; text: { type: string } };
                        required: never[];
                        type: string;
                    };
                    type: string;
                };
                language: { type: string };
                pages: {
                    items: {
                        additionalProperties: boolean;
                        properties: {
                            fullText: { type: string };
                            pageNumber: { type: string };
                        };
                        required: never[];
                        type: string;
                    };
                    type: string;
                };
            };
            required: never[];
            type: string;
        };
        type: string;
    } = ...

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods