AutoBE
    Preparing search index...

    Interface AutoBeInterfaceSchemaEvent

    Event fired when the Interface agent defines schema definitions during the API specification process.

    This event occurs when the Interface agent is creating the reusable schema definitions that will be used throughout the API specification. Schema definitions include data transfer objects (DTOs), request/response schemas, and other type definitions that provide the structural foundation for API operations and ensure type safety across the entire application.

    The schema creation process ensures that all data structures used in API operations are properly defined, validated, and documented, enabling consistent data handling and robust type checking throughout the generated application.

    Samchon

    interface AutoBeInterfaceSchemaEvent {
        completed: number;
        created_at: string & Format<"date-time">;
        id: string;
        metric: AutoBeFunctionCallingMetric;
        schemas: Record<string, AutoBeOpenApi.IJsonSchemaDescriptive>;
        step: number;
        tokenUsage: IAutoBeTokenUsageJson.IComponent;
        total: number;
        type: "interfaceSchema";
    }

    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

    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.

    schemas: Record<string, AutoBeOpenApi.IJsonSchemaDescriptive>

    Schema definitions being defined for the API specification.

    Contains the schema record that defines reusable schema definitions for the OpenAPI specification. These schemas serve as the building blocks for API operations, providing consistent type definitions and ensuring that data structures are properly validated and documented.

    The schemas maintain perfect alignment with the database schema while providing the appropriate level of abstraction for API consumers, including proper validation rules, descriptive documentation, and type safety throughout the application stack.

    step: number

    Iteration number of the requirements analysis this schema creation was performed for.

    Indicates which version of the requirements analysis this schema design reflects. This step number ensures that the schema definitions are aligned with the current requirements and helps track the evolution of data structures as requirements change.

    The step value enables proper synchronization between schema definitions and the underlying requirements, ensuring that the API schemas remain relevant to the current project scope and business objectives.

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

    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", "prismaSchema", "interfaceOperation", "testScenario"