AutoBE
    Preparing search index...

    Interface AutoBeRealizePlanEvent

    Event fired when the Realize planning phase completes collector and transformer planning.

    This event occurs after the planning orchestrators (REALIZE_COLLECTOR_PLAN and REALIZE_TRANSFORMER_PLAN) have analyzed operation requirements and determined which collectors and transformers must be generated. The planning phase solves dependency resolution by identifying all required code modules before the write phase begins, enabling parallel generation and ensuring all dependencies exist.

    The planning results provide visibility into the generation strategy before actual code generation starts, allowing the frontend to display what will be generated and enabling users to track progress as each planned item is realized.

    Samchon

    interface AutoBeRealizePlanEvent {
        acquisition: Pick<AutoBePreliminaryAcquisition, Kind>;
        completed: number;
        created_at: string & Format<"date-time">;
        id: string;
        metric: AutoBeFunctionCallingMetric;
        plans: (AutoBeRealizeCollectorPlan | AutoBeRealizeTransformerPlan)[];
        step: number;
        tokenUsage: IComponent;
        total: number;
        type: "realizePlan";
    }

    Hierarchy (View Summary)

    Index

    Properties

    acquisition: Pick<AutoBePreliminaryAcquisition, Kind>

    Summary of preliminary data acquired by the agent during RAG.

    Contains lightweight identifiers for each kind of preliminary data that was loaded into the agent's local context before producing its output. Only the kinds specified by the Kind type parameter are present.

    completed: number

    Number of items completed.

    Tracks how many items have been successfully processed so far in the current operation. This value increments as each item is completed, providing real-time progress indication.

    The ratio of completed to total gives the completion percentage: progress = (completed / total) * 100

    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")

    id: string

    A unique identifier for the event.

    Function calling trial statistics (total, success, failure counts).

    Complete list of collectors and transformers planned for generation.

    Contains planning results from both REALIZE_COLLECTOR_PLAN and REALIZE_TRANSFORMER_PLAN orchestrators. Each plan entry includes:

    • Kind discriminator ("collector" or "transformer")
    • Target DTO type name or function name
    • Agent's reasoning for planning this module
    • Associated Prisma schema name

    The order may reflect generation dependencies, though the orchestrator determines actual execution order. The frontend can use this to display a checklist of items to generate and show progress as each item completes.

    step: number

    Iteration number of the requirements analysis this planning reflects.

    Indicates which version of the requirements analysis this planning work is based on. This step number ensures that the planning decisions are aligned with the current requirements and helps track the development of implementation strategy as requirements evolve.

    The step value enables proper synchronization between planning activities and the underlying requirements, ensuring that the generation plan remains relevant to the current project scope and business objectives.

    tokenUsage: IComponent

    Token consumption breakdown (input, output, cache hits).

    total: number

    Total number of items to process.

    Represents the complete count of operations, files, endpoints, or other entities that need to be processed in the current workflow step. This value is typically determined at the beginning of an operation and remains constant throughout the process.

    Used together with the completed field to calculate progress percentage and estimate time to completion.

    type: "realizePlan"

    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"