AutoBE
    Preparing search index...

    Interface AutoBeDocumentStateEvent

    Event emitted when a user-provided document changes lifecycle state.

    The payload is metadata-only and must not include raw file data, decoded document text, parser raw output, or selected chunks.

    interface AutoBeDocumentStateEvent {
        chunkCount?: number;
        created_at: string & Format<"date-time">;
        documentId: string;
        error?: DocumentErrorInfo;
        filename?: string;
        id: string;
        previousStatus?: DocumentStatus;
        status: DocumentStatus;
        type: "documentState";
    }

    Hierarchy (View Summary)

    Index

    Properties

    chunkCount? created_at documentId error? filename? id previousStatus? status type

    Properties

    chunkCount?: number

    Parsed document chunk count. Present only for parsed resources.

    created_at: string & Format<"date-time">

    Timestamp when the event was created.

    ISO 8601 formatted date-time string indicating when this event was emitted by the system. This timestamp is crucial for event ordering, performance analysis, and debugging the agent workflow execution timeline.

    Format: "YYYY-MM-DDTHH:mm:ss.sssZ" (e.g., "2024-01-15T14:30:45.123Z")

    documentId: string
    error?: DocumentErrorInfo

    Sanitized terminal error information.

    filename?: string
    id: string

    A unique identifier for the event.

    previousStatus?: DocumentStatus
    status: DocumentStatus
    type: "documentState"

    Unique identifier for the event type.

    A literal string that discriminates between different event types in the AutoBE system. This field enables TypeScript's discriminated union feature, allowing type-safe event handling through switch statements or conditional checks.

    Examples: "analyzeWrite", "databaseSchema", "interfaceOperation", "testScenario"

    Settings

    Member Visibility

    On This Page

    Properties