AutoBE
    Preparing search index...

    Interface AutoBeInterfacePrerequisiteEvent

    Event emitted when a single API operation's prerequisite dependencies are analyzed.

    This event is triggered when the Interface Prerequisite Agent completes analyzing one API operation to determine its prerequisite dependencies. It represents the result of establishing which POST operations must be executed before the target operation can succeed, ensuring proper resource creation order for E2E test generation.

    The prerequisite analysis examines the API operation to identify required resource dependencies based on path parameters, request body schemas, and entity relationships. For example, a PUT /orders/{orderId}/items/{itemId} operation would require POST /orders and POST /orders/{orderId}/items as prerequisites to create the necessary resources first.

    By extending multiple base interfaces, this event provides comprehensive tracking capabilities including progress monitoring for one-by-one operation processing and token usage analytics for cost optimization.

    Samchon

    interface AutoBeInterfacePrerequisiteEvent {
        acquisition: Pick<AutoBePreliminaryAcquisition, Kind>;
        analysis: string;
        completed: number;
        created_at: string & Format<"date-time">;
        endpoint: IEndpoint;
        id: string;
        metric: AutoBeFunctionCallingMetric;
        prerequisites: IPrerequisite[];
        rationale: string;
        step: number;
        tokenUsage: IComponent;
        total: number;
        type: "interfacePrerequisite";
    }

    Hierarchy (View Summary)

    • AutoBeEventBase<"interfacePrerequisite">
    • AutoBeProgressEventBase
    • AutoBeAggregateEventBase
    • AutoBeAcquisitionEventBase<
          | "analysisSections"
          | "databaseSchemas"
          | "interfaceOperations"
          | "interfaceSchemas"
          | "previousAnalysisSections"
          | "previousDatabaseSchemas"
          | "previousInterfaceOperations"
          | "previousInterfaceSchemas",
      >
      • AutoBeInterfacePrerequisiteEvent
    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

    Analysis of the operation's resource dependencies.

    Documents the agent's understanding of what resources the operation requires to exist, foreign key relationships, path parameters implying dependencies, and request body fields referencing other resources.

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

    endpoint: IEndpoint

    The API endpoint being analyzed for prerequisite dependencies.

    Identifies the specific operation (method + path) that requires prerequisite operations to be executed first. This can be any HTTP method (GET, POST, PUT, DELETE, PATCH) as all operations may have resource dependencies that need to be satisfied.

    id: string

    A unique identifier for the event.

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

    prerequisites: IPrerequisite[]

    Array of prerequisite POST operations required before this operation.

    Contains the list of API operations that must be successfully executed before the target operation can be performed. Each prerequisite is a POST operation that creates a required resource, derived from path parameter dependencies, request body schema references, and entity relationships.

    For example, a DELETE /orders/{orderId}/items/{itemId} operation would have prerequisites including POST /orders to create the order and POST /orders/{orderId}/items to create the item being deleted.

    Prerequisites are ordered logically with parent resources before child resources to ensure proper creation sequence.

    rationale: string

    Rationale for the prerequisite chain decisions.

    Explains why each prerequisite operation is necessary, what resources must exist, the correct ordering of prerequisite operations, and what prerequisites were excluded.

    step: number

    Iteration number of the Prisma schema this prerequisite analysis was performed for.

    Indicates which version of the Prisma schema and interface specification this analysis reflects. This step number ensures that the prerequisite mappings are aligned with the current database schema and API structure.

    The step value enables proper synchronization between prerequisite analysis and the underlying schema definitions, ensuring that dependency chains remain valid as the schema evolves through iterations.

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

    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"