Schema Reference

    OpenEye uses Pydantic models for structured output. All models are defined in cli/openeye_ai/schema.py.

    BBox

    Normalized bounding box (0-1 range).

    FieldTypeDescription
    xfloatLeft edge (0-1)
    yfloatTop edge (0-1)
    wfloatWidth (0-1)
    hfloatHeight (0-1)

    DetectedObject

    FieldTypeDescription
    labelstrClass label
    confidencefloatDetection confidence (0-1)
    bboxBBoxBounding box

    ImageInfo

    FieldTypeDescription
    widthintImage width in pixels
    heightintImage height in pixels
    sourcestrSource identifier

    SegmentationMask

    FieldTypeDescription
    maskstrBase64-encoded mask PNG
    areaintMask area in pixels
    bboxBBoxBounding box of mask
    stability_scorefloatMask stability score

    PredictionResult

    FieldTypeDescription
    modelstrModel name
    taskstrTask type (detection, depth, segmentation, vla)
    timestampstrISO 8601 timestamp
    imageImageInfoInput image info
    objectslist[DetectedObject]Detected objects
    depth_mapstr or nullBase64 depth map PNG
    segmentation_maskslist[SegmentationMask] or nullSegmentation masks from SAM2
    vla_actionlist[float] or nullVLA action vector for robotic control
    inference_msfloatInference time in milliseconds

    Observation

    A memory-worthy snapshot from one perception tick, used by the agentic pipeline.

    FieldTypeDescription
    idstrAuto-generated unique ID
    tickintTick number
    timestampstrISO 8601 timestamp
    detectionslist[DetectedObject]Objects detected in this tick
    scene_summarystrBrief scene summary
    change_descriptionstrWhat changed since last tick
    significancefloatSignificance score (0-1)
    tagslist[str]Searchable tags

    AgentReasoning

    One reasoning step produced by the LLM in the agentic loop.

    FieldTypeDescription
    observation_summarystrSummary of what was observed
    memory_contextstrRelevant context recalled from memory
    chain_of_thoughtstrLLM reasoning chain
    current_planlist[str]Current action plan steps
    decided_actionstrAction decided by the agent
    plan_changedboolWhether the plan was updated this tick

    AgentTickEvent

    Complete tick output streamed to clients via SSE from /agent/stream.

    FieldTypeDescription
    tickintTick number
    phasestrCurrent phase: perceive, recall, reason, or act
    predictionPredictionResult or nullRaw prediction result
    observationObservation or nullProcessed observation
    reasoningAgentReasoning or nullLLM reasoning output
    action_takenstrAction that was executed
    memory_recalledlist[Observation]Observations recalled from memory
    current_planlist[str]Current plan steps
    timestampstrISO 8601 timestamp

    RecallQuery

    Query for memory recall via POST /agent/recall.

    FieldTypeDescription
    querystrFree-text query
    time_rangestr or nullTime filter (e.g. "last_1h", "last_24h")
    significance_minfloatMinimum significance threshold
    limitintMax results to return (default 10)

    RecallResult

    Response from memory recall.

    FieldTypeDescription
    observationslist[Observation]Matching observations
    querystrThe query that was executed
    total_matchesintTotal number of matches