ART Framework API Docs
    Preparing search index...

    Interface AgentProps

    Properties required to initiate an agent processing cycle.

    AgentProps

    interface AgentProps {
        isResume?: boolean;
        options?: AgentOptions;
        query: string;
        resumeDecision?: {
            approved: boolean;
            modifiedArgs?: Record<string, unknown>;
            reason?: string;
        };
        sessionId?: string;
        threadId: string;
        traceId?: string;
        userId?: string;
    }
    Index

    Properties

    isResume? options? query resumeDecision? sessionId? threadId traceId? userId?

    Properties

    isResume?: boolean

    Internal flag indicating this is a resume from a suspended state. Set automatically by resumeExecution() - do not set manually for regular queries. When true, the agent continues from the suspended step without triggering plan refinement.

    options?: AgentOptions

    Optional runtime options that can override default behaviors for this specific process call.

    query: string

    The user's input query or request to the agent.

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

    The decision payload provided by the user when resuming from a HITL suspension. Passed automatically by resumeExecution().

    sessionId?: string

    An optional identifier for the specific UI session, useful for targeting UI updates.

    threadId: string

    The mandatory identifier for the conversation thread. All context is scoped to this ID.

    traceId?: string

    An optional identifier used for tracing a request across multiple systems or services.

    userId?: string

    An optional identifier for the user interacting with the agent.

    Settings

    Member Visibility

    On This Page

    Properties