Skip to content
YosoiDocs

yosoi.policy

yosoi.policy

Typed policy authoring with Rust-owned defaults and validation.

Source: python/yosoi/policy.py:1

Name Summary
Acquisition Authored acquisition mechanism with explicit document selection.
AcquisitionKind Resolved acquisition family and optional browser mode.
BrowserConfig Select a browser implementation without installing or launching it.
BrowserLimits Browser evidence byte bounds and capture resource counts.
Continue Retain an unsuccessful result and attempt the next safe step.
DocumentSelection Current or explicit document outputs for one acquisition.
Documents Retained-payload parsing resource limits.
Duration Portable elapsed duration with seconds and subsecond nanoseconds.
EffectiveAcquisition Resolved acquisition output selection preserving authored intent.
EffectivePage Resolved acquisitions retained in authored page order.
EffectivePolicy Rust-resolved behavior view, separate from caller authoring intent.
EffectiveProviderRoute Resolved provider profile with its default-selection provenance.
EffectiveSearch Resolved ordered provider routes and shared search budgets.
Filters Explicit Map admission exclusions rather than discovery selectors.
FlowPolicy Independent fallback continuation for failures and cancellations.
Locators Locator traversal, query, match, and output resource limits.
Map Complete bounded discovery declaration resolved by the Rust SDK.
MapLimits Map discovery counts, retention bounds, and execution budgets.
Network Opt-in TCP routing retained by Requests and owned browser Sessions.
Page Ordered bounded acquisitions for one page request.
Policy Editable complete declaration with Rust-owned defaults and validation.
PolicyIdentity Versioned Rust digest identifying effective policy behavior.
PolicySnapshot Deeply frozen Rust-validated authoring and resolved behavior.
ProfileSelection Current provider defaults or an explicit complete request profile.
Provider Supported provider names with Rust registry default-status evidence.
ProviderDefaultsStatus Explicit registry certification or exact-profile provenance.
ProviderRequestProfile Complete child-request policy sections for a search provider.
ProviderSelection One provider and its current or explicit child-request profile.
Redirects Direct HTTP redirect traversal configuration.
Request Acquisition deadlines and source/browser evidence budgets.
Scope Map URL admission boundaries relative to the authored seed.
Search Ordered provider selection with shared search resource budgets.
SourceLimits Separate retained byte budgets for the HTTP source stages.
Stop Stop a selected Flow scope after failure or cancellation.
Tuning Package-owned tuning mode without independent runtime overrides.
Name Summary
AccessibilityNodeLimitValue Strict positive addressable u32 accessibility-node bound validated by Rust.
AddressableByteLimitValue Strict positive u64 byte limit checked by Rust to fit platform address size.
BrowserEngine Browser implementation. Optional engines use native BiDi; Chrome retains CDP.
BrowserMode Headless or headful acquisition mode. Session settings and bound browser acquisitions must agree before startup.
BudgetValue Strict positive u32 Map budget validated by Rust; zero is not an unlimited setting.
Continuation Tagged Continue or Stop behavior for known failures and observed cancellations. Retaining a result does not imply successful business effects.
CountLimitValue Strict positive u64 policy count validated by Rust; zero never means unlimited.
DirectHttpRedirectTargets Redirect admission allows supported HTTP(S) destinations or restricts transitions to the seed origin. Hop and request budgets apply separately.
DiscoveryDocuments Map evidence retention either discards documents after inspection or retains them within the configured payload budget.
DocumentRequest Requested output evidence families. Selection does not guarantee production; inspect typed partial, unavailable, or unprojectable outcomes.
DocumentSelectionKind Current selection resolves package output defaults; exact selection preserves authored outputs, including an intentionally empty selection.
EventLimitValue Strict positive addressable browser event count validated by Rust.
HostScope Map admission stays on the seed host or the supported registrable domain. Passive discoveries do not prove HTTP reachability.
IpFamily Permitted outbound TCP family; an upstream proxy owns its destination family.
MaximumElapsedValue Strict positive u64 elapsed budget in microseconds. Conversion to a platform capture deadline is checked separately.
MoliProfile Moli DOM-only or on-demand layout profile, independent of window mode.
PageDiscovery Disable ordinary page-link exploration or explore admitted pages within depth and resource budgets.
PathScope Map admission stays within the seed path subtree or admits the entire origin; scheme, port, and host rules remain independent.
PositiveInt Strict positive Python integer. Native policy validation applies operation-specific width and plan constraints.
PositiveU16 Strict positive u16 integer; zero and numeric coercions are rejected.
PositiveU32 Strict positive u32 integer; zero and numeric coercions are rejected.
PositiveU64 Strict positive u64 integer; zero and numeric coercions are rejected.
ProfileSelectionKind Current provider profiles resolve registry metadata; exact profiles retain complete authored child-request sections.
RedirectHopLimitValue Strict positive u32 Direct HTTP redirect-transition bound validated by Rust.
ResourceLimitValue Strict positive addressable u32 resource-count bound validated by Rust.
Robots Ignore or respect applicable robots rules during Map exploration. This does not change URL scope admission.
StepLimitValue Strict positive u32 query/depth counter validated by Rust.
StopScope current_flow stops its remaining leaves; invocation stops all remaining invocation work. Unknown effects can still force a hard safety stop.
Subdomains Disable name discovery or use passive historical provider evidence, without guessing hosts or claiming current reachability.
TuningMode Current supported tuning vocabulary uses package defaults; no separate override mode is implied.
Name Summary
U16 Strict integer from zero through the u16 maximum. Numeric strings, booleans, and floats are not coerced.
U64 Strict integer from zero through the u64 maximum; units depend on the consuming field.