AutoBE
    Preparing search index...

    Interface AutoBeInterfaceSchemaReviewEvent

    Event fired during the multi-dimensional review and validation phase of OpenAPI schema generation process.

    This event represents the unified validation activity of specialized Interface Schema Review Agents, which ensure schemas are secure, structurally sound, and complete. The event supports three distinct review kinds executed sequentially: security, relation, and content validation.

    The Interface Schema Review Agents perform comprehensive validation including:

    • Security (kind: "security"): Authentication context removal, password/token field protection, phantom field detection, system-managed field protection
    • Relation (kind: "relation"): Relation classification, foreign key to object transformation, actor reversal prohibition, $ref extraction
    • Content (kind: "content"): Field completeness, type accuracy, required field alignment, cross-variant consistency

    Review execution order:

    1. Security review removes dangerous fields and prevents vulnerabilities
    2. Relation review structures relationships between clean schemas
    3. Content review validates completeness of secure, well-structured schemas

    Each review kind focuses on its specialized domain while contributing to production-ready, type-safe OpenAPI schemas that accurately model the business domain.

    Samchon

    interface AutoBeInterfaceSchemaReviewEvent {
        completed: number;
        created_at: string & Format<"date-time">;
        id: string;
        kind: "content" | "security" | "relation" | "phantom";
        metric: AutoBeFunctionCallingMetric;
        review: string;
        revises: AutoBeInterfaceSchemaPropertyRevise[];
        schema: AutoBeOpenApi.IJsonSchemaDescriptive;
        step: number;
        tokenUsage: IComponent;
        total: number;
        type: "interfaceSchemaReview";
        typeName: string;
    }

    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.

    kind: "content" | "security" | "relation" | "phantom"

    Review dimension discriminator.

    Specifies which specialized agent is performing validation:

    • "security": Security validation for authentication and data protection
    • "relation": Relation validation for DTO relationships and structure
    • "content": Content validation for field completeness and accuracy

    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.

    review: string

    Violation findings from the review.

    Documents all issues discovered during validation, categorized by severity or type according to the review kind:

    • Security: CRITICAL/HIGH/MEDIUM/LOW severity violations
    • Relation: CRITICAL/HIGH/MEDIUM/LOW relation issues
    • Content: Field completeness, type accuracy, description quality issues

    Each finding includes the affected schema, specific problem, and correction justification.

    Original schema submitted for review.

    Contains the OpenAPI schema requiring validation according to the review kind. The schema is the full descriptive JSON schema structure with AutoBE-specific metadata.

    step: number

    Current iteration number of the schema generation being reviewed.

    Indicates which version of the schemas is undergoing validation, helping track the iterative refinement process.

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

    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 reviewed.

    Specifies the specific DTO type name that is being validated in this review. Examples: "IUser.ICreate", "IProduct.ISummary", "IBbsArticle"