AgentOS Extensions API - v1.0.3
    Preparing search index...

    Interface DocumentReadResult

    Document read result

    interface DocumentReadResult {
        content: string;
        format: string;
        metadata?: Record<string, any>;
        path: string;
        size: number;
        structured?: {
            sheets?: {
                headers: string[];
                name: string;
                rowCount: number;
                rows: any[][];
                truncated: boolean;
            }[];
        };
    }
    Index

    Properties

    content format metadata? path size structured?

    Properties

    content

    content: string

    Human/LLM-readable text representation (always present)

    format: string

    Detected format

    metadata?: Record<string, any>

    Document metadata (PDF info, etc.)

    path: string

    File path

    size: number

    File size in bytes

    structured?: {
        sheets?: {
            headers: string[];
            name: string;
            rowCount: number;
            rows: any[][];
            truncated: boolean;
        }[];
    }

    Structured data for spreadsheets

    Settings

    Member Visibility

    On This Page

    Properties