cayu.tools.browser_visual

Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.

BrowserVisualPolicy

from cayu.tools import BrowserVisualPolicy

Explicit application-owned permission to capture and publish browser pixels.

Retention is session-scoped and application-managed: the application owns deletion from the named artifact store. This is not a TTL or secure erasure promise. publish_to_model permits pixels to reach the models selected by the application’s execution profile, through normal attachment admission.

Bases: _VisualModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
artifact_store_id	str	Field(min_length=1, max_length=256)
allowed_origins	tuple[str, ...]	Field(min_length=1, max_length=64)
retention	Literal['application_managed']	required
publish_to_model	bool	Field(strict=True)
allow_coordinate_fallback	bool	Field(default=False, strict=True)
allowed_profile_contexts	tuple[Literal['fresh_temporary'], ...]	('fresh_temporary',)
allow_authenticated_pages	Literal[False]	False
capture_during_sensitive_takeover	Literal[False]	False
max_width	int	Field(default=1280, strict=True, ge=1, le=4096)
max_height	int	Field(default=1024, strict=True, ge=1, le=4096)
max_pixels	int	Field(default=1310720, strict=True, ge=1, le=8000000)
max_bytes	int	Field(default=2 * 1024 * 1024, strict=True, ge=1, le=8 * 1024 * 1024)
max_targets	int	Field(default=64, strict=True, ge=1, le=MAX_VISUAL_TARGETS)
max_label_bytes	int	Field(default=128, strict=True, ge=0, le=512)
max_hit_tests	int	Field(default=256, strict=True, ge=1, le=1024)
max_frame_depth	int	Field(default=8, strict=True, ge=0, le=16)
max_processing_ms	int	Field(default=5000, strict=True, ge=1, le=30000)
max_captures	int	Field(default=8, strict=True, ge=1, le=MAX_VISUAL_CAPTURES)
evidence_lifetime_ms	int	Field(default=30000, strict=True, ge=1, le=120000)

validate_takeover_exclusion (method)

BrowserVisualPolicy.validate_takeover_exclusion(value: object) -> bool

validate_profile_contexts (method)

BrowserVisualPolicy.validate_profile_contexts(value: tuple[str, ...]) -> tuple[str, ...]

validate_store_id (method)

BrowserVisualPolicy.validate_store_id(value: str) -> str

validate_origins (method)

BrowserVisualPolicy.validate_origins(values: tuple[str, ...]) -> tuple[str, ...]

validate_limits (method)

BrowserVisualPolicy.validate_limits() -> Self

Release source · Runtime guarantees · Capability guides