AutoBE
    Preparing search index...

    Interface AutoBeInterfaceSchemaEnumEvent

    Event fired when the Interface agent canonicalizes one logical literal-union (enum-like) across the schema set.

    Every DTO is generated independently, so the same logical enum can appear in many DTOs with slightly different literal sets — "pending" in one, "Pending" in another, a member missing somewhere. The Enum agent groups the drifted property sites that mean the same enum, then decides one canonical member set for them — each member carrying its own summarized description.

    Each logical enum is processed independently: one LLM call per enum, one event dispatched per enum. The orchestrator projects the canonical member set back onto every site deterministically, so the contract can never drift between the places the enum appears.

    Samchon

    interface AutoBeInterfaceSchemaEnumEvent {
        acquisition: Pick<AutoBePreliminaryAcquisition, Kind>;
        analysis: string;
        completed: number;
        created_at: string & Format<"date-time">;
        id: string;
        members: IMember[];
        metric: AutoBeFunctionCallingMetric;
        name: string;
        sites: ISite[];
        step: number;
        tokenUsage: IAutoBeTokenUsageJson.IComponent;
        total: number;
        type: "interfaceSchemaEnum";
    }

    Hierarchy (View Summary)

    • AutoBeEventBase<"interfaceSchemaEnum">
    • AutoBeProgressEventBase
    • AutoBeAggregateEventBase
    • AutoBeAcquisitionEventBase<
          | "analysisSections"
          | "databaseSchemas"
          | "interfaceOperations"
          | "interfaceSchemas",
      >
      • AutoBeInterfaceSchemaEnumEvent
    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.

    analysis: string

    LLM analysis of this enum and the canonicalization decision.

    Documents why these sites are the same logical enum and why the chosen member set (drift resolved, no invented values) is correct.

    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.

    members: IMember[]

    The canonical, de-drifted member set adopted by every site in this enum.

    Each member carries its exact literal value and its own summarized description, mirroring AutoBeOpenApi.IJsonSchemaDescriptive.IConstant.

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

    name: string

    Canonical name for this logical enum, used only for reasoning and documentation (e.g. "OrderStatus"). It is never emitted as a named type.

    sites: ISite[]

    The DTO property sites that adopt this canonical member set.

    Every site is rewritten to the canonical members, so the same logical enum is identical everywhere it appears.

    step: number

    Current iteration number of the requirements analysis.

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

    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"