AutoBE
    Preparing search index...

    Interface AutoBeInterfaceSchemaComplementEvent

    Event fired when the Interface agent supplements missing types and schemas during the API specification process.

    This event occurs when the Interface agent identifies that additional type definitions or schema components are needed to complete the API specification. The complement phase ensures that all necessary types used in API operations are properly defined, including nested objects, utility types, and supporting data structures that may have been initially overlooked.

    The complement process is essential for creating complete and self-contained OpenAPI specifications that can generate fully functional NestJS applications without missing dependencies or incomplete type definitions.

    Samchon

    interface AutoBeInterfaceSchemaComplementEvent {
        analysis: string;
        completed: number;
        created_at: string & Format<"date-time">;
        id: string;
        metric: AutoBeFunctionCallingMetric;
        rationale: string;
        schema: AutoBeOpenApi.IJsonSchemaDescriptive;
        step: number;
        tokenUsage: IComponent;
        total: number;
        type: "interfaceSchemaComplement";
        typeName: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    analysis: string

    Analysis of the missing type's purpose and context.

    Documents the agent's understanding of why this type is referenced, where it is referenced from ($ref locations), what the reference context reveals about expected structure, and similar types that provide structural hints.

    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.

    rationale: string

    Rationale for the schema design decisions.

    Explains why the schema was designed with specific properties, required vs optional field choices, how it satisfies referencing schemas' expectations, and what patterns from existing schemas were followed.

    Additional schema definition being added to complement the API specification.

    Contains the newly created schema definition that fills the gap identified as the missing type. The schema contains the complete AutoBeOpenApi.IJsonSchemaDescriptive definition with proper typing, validation rules, and descriptive documentation.

    This complementary schema ensures that the type referenced throughout the API specification is properly defined, enabling successful code generation and maintaining type safety across the entire application.

    step: number

    Iteration number of the requirements analysis this API complement was performed for.

    Indicates which version of the requirements analysis this schema complement activity reflects. This step number ensures that the complementary types are aligned with the current requirements and helps track the evolution of the API specification as requirements change.

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

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

    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"

    typeName: string

    Type name of the schema being created.

    Specifies the specific DTO type name that is being generated to fill the gap. This will be the same as the missed field.