Skip to content

VisualReferenceOutput

Source code in docs_src/capo_synthetics/types/visual_reference_output.py 
13
14
15
16
17
18
19
20
21
class VisualReferenceOutput(TypedDict, closed=True):
    base_screenshots: NotRequired[
        "capo_synthetics.types.base_screenshots.BaseScreenshots"
    ]
    """<p>An array of screenshots that are used as the baseline for comparisons during visual monitoring.</p>"""
    base_canary_run_id: NotRequired["capo_synthetics.types.string.String"]
    """<p>The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.</p>"""
    browser_type: NotRequired["capo_synthetics.types.browser_type.BrowserType"]
    """<p>The browser type associated with this visual reference.</p>"""

base_canary_run_id instance-attribute 

base_canary_run_id: NotRequired[String]

The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.

base_screenshots instance-attribute 

base_screenshots: NotRequired[BaseScreenshots]

An array of screenshots that are used as the baseline for comparisons during visual monitoring.

browser_type instance-attribute 

browser_type: NotRequired[BrowserType]

The browser type associated with this visual reference.