AutoBE
    Preparing search index...

    Interface AutoBeAnalyzeWriteUnitEvent

    Event fired during the unit section (##) generation phase of the hierarchical requirements analysis process.

    This event represents the second step in the hierarchical document generation pipeline where the Analyze Writer Agent creates unit-level sections within an approved module section structure.

    The Unit Agent operates with:

    • Input: Approved module section from ModuleReviewEvent
    • Output: Unit sections with titles, purposes, content, and keywords

    Key characteristics of the unit generation process:

    • Receives confirmed module section structure as input
    • Generates functional requirement groupings
    • Defines unit section boundaries and purposes
    • Provides keywords as hints for section generation
    • Must be approved by review before sections are generated

    Juntak

    interface AutoBeAnalyzeWriteUnitEvent {
        acquisition: Pick<AutoBePreliminaryAcquisition, Kind>;
        completed: number;
        created_at: string & Format<"date-time">;
        id: string;
        metric: AutoBeFunctionCallingMetric;
        moduleIndex: number;
        retry: number;
        step: number;
        tokenUsage: IComponent;
        total: number;
        type: "analyzeWriteUnit";
        unitSections: AutoBeAnalyzeUnitSection[];
    }

    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 for the operation.

    Records the complete trial history of function calling attempts, tracking total executions, successful completions, consent requests, validation failures, and invalid JSON responses. These metrics reveal the reliability and quality of AI agent autonomous operation with tool usage.

    Trial statistics are critical for identifying operations where agents struggle with tool interfaces, generate invalid outputs, or require multiple correction attempts through self-healing spiral loops. High failure rates indicate opportunities for system prompt optimization or tool interface improvements.

    moduleIndex: number

    Index of the parent module section.

    References which module section (0-based) these unit sections belong to.

    retry: number

    Retry attempt number for this event.

    Starts at 0 for the first attempt. Increments each time the review rejects and the generation is retried. When retry > 0, completed may exceed total due to repeated work.

    step: number

    Current iteration number of the unit section generation.

    Indicates which version is being generated. Increments with each retry after review feedback.

    tokenUsage: IComponent

    Detailed token usage metrics for the operation.

    Contains comprehensive token consumption data including total usage, input token breakdown with cache hit rates, and output token categorization by generation type (reasoning, predictions). This component-level tracking enables precise cost analysis and identification of operations that benefit most from prompt caching or require optimization.

    Token usage directly translates to operational costs, making this metric essential for understanding the financial implications of different operation types and guiding resource allocation decisions.

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

    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"

    unitSections: AutoBeAnalyzeUnitSection[]

    Array of unit sections generated for this module section.

    Each unit section represents a subsection (### level) with its title, purpose, content, and keywords for guiding section generation.