ART Framework API Docs
    Preparing search index...

    Interface Observation

    Represents a recorded event during the agent's execution.

    Observation

    interface Observation {
        content: any;
        id: string;
        metadata?: Record<string, any>;
        parentId?: string;
        threadId: string;
        timestamp: number;
        title: string;
        traceId?: string;
        type: ObservationType;
    }
    Index

    Properties

    content: any

    The main data payload of the observation, structure depends on the type.

    Common content shapes by type:

    • TITLE: { title: string } — a concise thread title (<= 10 words)
    • INTENT: { intent: string }
    • PLAN: { plan: string; rawOutput?: string }
    • TOOL_CALL: { toolCalls: ParsedToolCall[] }
    • TOOL_EXECUTION: { callId: string; toolName: string; status: 'success' | 'error'; output?: any; error?: string }
    • FINAL_RESPONSE: { message: ConversationMessage; uiMetadata?: object }
    id: string

    A unique identifier for this specific observation record.

    metadata?: Record<string, any>

    Optional metadata providing additional context (e.g., source phase, related IDs, status).

    parentId?: string

    An optional identifier for the parent object (e.g., a TodoItem ID) to which this observation belongs. This allows differentiation between primary (user query) and secondary (sub-task) observations.

    threadId: string

    The identifier of the conversation thread this observation relates to.

    timestamp: number

    A Unix timestamp (in milliseconds) indicating when the observation was recorded.

    title: string

    A concise, human-readable title summarizing the observation (often generated based on type/metadata).

    traceId?: string

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

    The category of the event being observed (e.g., PLAN, THOUGHTS, TOOL_EXECUTION).