@archastro/sdk
    Preparing search index...

    Interface ContextDocumentContent

    The text content of a context document, optionally sliced by line or byte range. Includes totals and slice boundary fields for the requested unit.

    interface ContextDocumentContent {
        content: string;
        end_byte?: number;
        end_line?: number;
        id: string;
        limit?: number;
        metadata?: Record<string, unknown>;
        offset?: number;
        start_byte?: number;
        start_line?: number;
        title?: string;
        total_lines: number;
        total_size: number;
        unit?: string;
    }
    Index

    Properties

    content: string

    Text of the document. Contains the full content when no offset/limit was requested, or only the requested slice otherwise.

    end_byte?: number

    Zero-based exclusive index of the last byte in content (i.e. the slice covers bytes start_byte..end_byte-1). Populated only when unit is "bytes"; null otherwise.

    end_line?: number

    1-indexed line number of the last line included in content (i.e. the slice covers lines start_line through end_line inclusive). Populated only when unit is "lines"; null otherwise.

    id: string

    Context document ID (cdo_...).

    limit?: number

    The limit value echoed from the request. null when no limit was requested.

    metadata?: Record<string, unknown>

    Arbitrary key-value metadata attached to the document, such as source URL or author. null if no metadata was recorded.

    offset?: number

    The offset value echoed from the request. null when no offset was requested.

    start_byte?: number

    Zero-based index of the first byte included in content. Populated only when unit is "bytes"; null otherwise.

    start_line?: number

    1-indexed line number of the first line included in content. Populated only when unit is "lines"; null otherwise.

    title?: string

    Human-readable display title of the document. null if the document has no title set.

    total_lines: number

    Total number of lines in the document's full content, regardless of any slice.

    total_size: number

    Total byte size of the document's full content, regardless of any slice.

    unit?: string

    Slice unit used when offset and limit were provided. One of "lines" (default) or "bytes". null when no slice was requested.