AutoBE
    Preparing search index...

    Interface AutoBeInterfaceOperationEvent

    Event fired when the Interface agent defines API operations during the RESTful API specification process.

    This event occurs when the Interface agent is creating detailed operation specifications that define the role, behavior, and characteristics of each API function. Operations include comprehensive business logic definitions, parameter specifications, response schemas, error handling, and security requirements that transform endpoint definitions into fully functional API contracts.

    The operation definition process ensures that each API endpoint has complete behavioral specifications, proper documentation, and clear contracts that enable accurate code generation and reliable client integration.

    Samchon

    interface AutoBeInterfaceOperationEvent {
        completed: number;
        created_at: string & Format<"date-time">;
        id: string;
        metric: AutoBeFunctionCallingMetric;
        operations: IOperation[];
        step: number;
        tokenUsage: IAutoBeTokenUsageJson.IComponent;
        total: number;
        type: "interfaceOperation";
    }

    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.

    operations: IOperation[]

    Array of API operations being defined for the endpoints.

    Contains the detailed AutoBeOpenApi.IOperation specifications that define the business logic, parameters, responses, and behavior for each API function. Each operation includes comprehensive documentation, request/response schemas, error handling specifications, and security requirements that transform basic endpoints into complete API contracts.

    The operations ensure that every API function has clear behavioral definitions, proper validation rules, and comprehensive documentation that enables accurate implementation and reliable client integration throughout the application ecosystem.

    step: number

    Iteration number of the requirements analysis this operation definition was performed for.

    Indicates which version of the requirements analysis this operation design reflects. This step number ensures that the API operations are aligned with the current requirements and helps track the evolution of API functionality as business requirements change.

    The step value enables proper synchronization between operation definitions and the underlying requirements, ensuring that the API behavior remains 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: "interfaceOperation"

    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"