AutoBE
    Preparing search index...

    Interface AutoBeInterfaceSchemaRefineEvent

    Event fired during the schema property refinement phase of OpenAPI schema generation process.

    This event represents the activity of the Interface Schema Refine Agent, which enriches pure JSON Schema structures with documentation and metadata. Initial JSON Schema generation produces only type structure (type, properties, $ref, etc.) without descriptive information. The refine phase adds databaseSchemaProperty, specification, and description to each property.

    The Interface Schema Refine Agent performs enrichment operations including:

    • depict: Add documentation to existing property
    • create: Add missing property with documentation
    • update: Fix incorrect type and add documentation
    • erase: Remove invalid property

    The agent reviews both object-level metadata (databaseSchema, specification, description) and property-level documentation to ensure complete and accurate schema definitions that properly map to database entities.

    Samchon

    interface AutoBeInterfaceSchemaRefineEvent {
        acquisition: Pick<AutoBePreliminaryAcquisition, Kind>;
        completed: number;
        created_at: string & Format<"date-time">;
        databaseSchema: string | null;
        description: string;
        excludes: AutoBeInterfaceSchemaPropertyExclude[];
        id: string;
        metric: AutoBeFunctionCallingMetric;
        review: string;
        revises: AutoBeInterfaceSchemaPropertyRefine[];
        schema: AutoBeOpenApi.IJsonSchema;
        specification: string;
        step: number;
        tokenUsage: IComponent;
        total: number;
        type: "interfaceSchemaRefine";
        typeName: string;
    }

    Hierarchy (View Summary)

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

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

    databaseSchema: string | null

    Database schema context for the type.

    Specifies which database table or entity this schema maps to, providing context for property-level database field mappings. Set to null for types that don't map to a single database table.

    description: string

    Description for API consumers.

    Documents WHAT the schema represents for API consumers, explaining the purpose and usage of this data type in the API context.

    Database properties explicitly excluded from this DTO.

    Each entry declares a database property that intentionally does not appear in this DTO, along with the reason for exclusion (e.g., "aggregation relation", "internal field", "handled by separate endpoint").

    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.

    review: string

    Review findings from the refinement process.

    Documents the agent's analysis of the schema's current state, including which properties need documentation, any structural issues discovered, and the overall completeness assessment of the schema metadata.

    Refinement operations performed on the DTO schema properties.

    Contains the list of operations executed to enrich schema properties:

    • depict: Documentation added to existing property
    • create: New property created with documentation
    • update: Property type corrected and documented
    • erase: Invalid property removed

    Every DTO property must appear exactly once. Every database property must be addressed either here (via databaseSchemaProperty) or in excludes.

    Original schema submitted for refinement.

    Contains the OpenAPI schema requiring enrichment with documentation and metadata. The schema is the full descriptive JSON schema structure that needs specification and description fields populated for each property.

    specification: string

    Specification for the schema implementation.

    Documents HOW the schema should be implemented, including data source mappings, transformation rules, and technical implementation details.

    step: number

    Current iteration number of the schema refinement.

    Indicates which version of the schemas is undergoing refinement, helping track the iterative enrichment 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: "interfaceSchemaRefine"

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

    Specifies the specific DTO type name that is being enriched with documentation and metadata. Examples: "IUser.ICreate", "IProduct.ISummary", "IBbsArticle"