ART Framework API Docs
    Preparing search index...

    Interface ArtInstance

    interface ArtInstance {
        authManager?: null | AuthManager;
        checkForSuspendedState: (
            threadId: string,
        ) => Promise<
            | null
            | {
                itemId: string;
                suspensionId: string;
                toolInput: any;
                toolName: string;
            },
        >;
        conversationManager: ConversationManager;
        observationManager: ObservationManager;
        process: (props: AgentProps) => Promise<AgentFinalResponse>;
        resumeExecution: (
            threadId: string,
            suspensionId: string,
            decision: {
                approved: boolean;
                modifiedArgs?: Record<string, unknown>;
                reason?: string;
            },
        ) => Promise<AgentFinalResponse>;
        stateManager: StateManager;
        toolRegistry: ToolRegistry;
        uiSystem: UISystem;
    }
    Index

    Properties

    authManager? checkForSuspendedState conversationManager observationManager process resumeExecution stateManager toolRegistry uiSystem

    Properties

    authManager?: null | AuthManager

    Accessor for the Auth Manager, used for handling authentication.

    checkForSuspendedState: (
        threadId: string,
    ) => Promise<
        | null
        | {
            itemId: string;
            suspensionId: string;
            toolInput: any;
            toolName: string;
        },
    >

    Checks if a thread is currently in a suspended state (waiting for HITL approval). Use this on app initialization to detect and restore suspension UI after page refresh.

    Type declaration

      • (
            threadId: string,
        ): Promise<
            | null
            | {
                itemId: string;
                suspensionId: string;
                toolInput: any;
                toolName: string;
            },
        >

      • Parameters

        • threadId: string

          The ID of the thread to check.

        Returns Promise<
            | null
            | {
                itemId: string;
                suspensionId: string;
                toolInput: any;
                toolName: string;
            },
        >

        Suspension info if suspended, null otherwise.

    conversationManager: ConversationManager

    Accessor for the Conversation Manager, used for managing message history.

    observationManager: ObservationManager

    Accessor for the Observation Manager, used for recording and retrieving observations.

    process: (props: AgentProps) => Promise<AgentFinalResponse>

    The main method to process a user query using the configured Agent Core.

    Type declaration

      • (props: AgentProps): Promise<AgentFinalResponse>

      • Processes a user query through the configured agent reasoning pattern (e.g., PES). Orchestrates interactions between various ART subsystems.

        Parameters

        • props: AgentProps

          The input properties for the agent execution, including the query, thread ID, and injected dependencies.

        Returns Promise<AgentFinalResponse>

        A promise that resolves with the final agent response and execution metadata.

        If a critical error occurs during orchestration that prevents completion.

    resumeExecution: (
        threadId: string,
        suspensionId: string,
        decision: {
            approved: boolean;
            modifiedArgs?: Record<string, unknown>;
            reason?: string;
        },
    ) => Promise<AgentFinalResponse>

    Resumes a suspended agent execution (HITL).

    Type declaration

      • (
            threadId: string,
            suspensionId: string,
            decision: {
                approved: boolean;
                modifiedArgs?: Record<string, unknown>;
                reason?: string;
            },
        ): Promise<AgentFinalResponse>

      • Parameters

        • threadId: string

          The ID of the suspended thread.

        • suspensionId: string

          The ID provided in the suspension observation/state.

        • decision: { approved: boolean; modifiedArgs?: Record<string, unknown>; reason?: string }

          The user's decision payload.

        Returns Promise<AgentFinalResponse>

    stateManager: StateManager

    Accessor for the State Manager, used for managing thread configuration and state.

    toolRegistry: ToolRegistry

    Accessor for the Tool Registry, used for managing available tools.

    uiSystem: UISystem

    Accessor for the UI System, used to get sockets for subscriptions.

    Settings

    Member Visibility

    On This Page

    Properties