AutoBE
    Preparing search index...

    Interface AutoBeRealizeWriteEvent

    Event fired during the implementation process as the Realize agent creates individual implementation files.

    This event provides real-time visibility into the implementation progress as the Realize agent systematically creates service classes, business logic methods, data access objects, and integration code. Each progress event represents the completion of a specific implementation file that contributes to the overall application functionality.

    The progress events enable stakeholders to monitor the final development phase and understand how the complete application is being assembled from individual implementation components that bridge API specifications with database schemas.

    Samchon

    interface AutoBeRealizeWriteEvent {
        completed: number;
        content: string;
        created_at: string & Format<"date-time">;
        id: string;
        location: string;
        step: number;
        tokenUsage: IAutoBeTokenUsageJson.IComponent;
        total: number;
        type: "realizeWrite";
    }

    Hierarchy (View Summary)

    Index

    Properties

    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

    content: string

    Content of the completed implementation file.

    Contains the actual TypeScript implementation code that was generated for this file, including service methods, business logic, data access patterns, error handling, and integration logic. The content represents working code that implements the business requirements while maintaining consistency with the established API contracts and database schemas.

    This implementation code bridges the gap between design specifications and executable functionality, providing the concrete business logic that makes the application operational and ready for deployment.

    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.

    location: string

    Name of the implementation file that has been completed.

    Specifies the filename of the TypeScript implementation file that was just generated, which could be a service class, business logic module, data access object, integration handler, or other implementation component. The filename provides context about which part of the application functionality has been implemented.

    step: number

    Iteration number of the requirements analysis this implementation progress reflects.

    Indicates which version of the requirements analysis this implementation work is based on. This step number ensures that the implementation progress is aligned with the current requirements and helps track the development of implementation components as they evolve with changing business needs.

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

    Detailed token usage metrics for the current operation.

    Contains comprehensive token consumption data including total usage, input token breakdown with cache statistics, and output token categorization by generation type. This component-level tracking enables precise analysis of resource utilization for specific agent operations such as schema generation, test writing, or code implementation.

    The token usage data helps identify optimization opportunities, monitor operational costs, and ensure efficient use of AI resources throughout the automated backend development process.

    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: "realizeWrite"

    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", "prismaSchemas", "interfaceOperations", "testScenarios"