Skip to content
Yosoi
/
Docs
Search
Ctrl
K
Cancel
Latest · 0.4.0
⌄
Latest · 0.4.0
v0.3.0
v0.2.1
v0.2.0
v0.1.2
v0.1.1
v0.1.0
GitHub
Discord
Menu
Getting Started
What is Yosoi?
Install
Docker setup
Concepts
Concepts
Making sense of HTML
Fetching our first page
Using a browser
Choosing a browser
Waiting for the page
Building a product record
Adding a product to the cart
Following the data
Building reusable browser recipes
Keeping the browser open
Accessing a protected page
Finding more pages
Bounding the work
Choosing a network route
Sharing browser capacity
Yielding while waiting
Keeping the evidence
Surfaces
Archiving a surface
CLI
Install
Update and uninstall
Request a document
Locate values
Policy profiles
Map
Search
Surface
Release Notes
Overview
0.4.x
0.4.0
0.3.x
0.3.0
0.2.x
0.2.1
0.2.0
0.1.x
0.1.2
0.1.1
0.1.0
References
Rust
Overview
Modules
Action
Overview
Types
AssertionBuilder
JavaScriptModuleBundle
JavaScriptModuleError
JavaScriptModuleImport
JavaScriptModuleImportKind
JavaScriptModuleLimits
JavaScriptModuleSource
JavaScriptSourceError
JavaScriptSourceOrigin
JavaScriptSourceProvenance
JavaScriptSourceSnapshot
Functions
assert
assert_all
check
click
enter_text
evaluate
evaluate_file
evaluate_file_with_limit
navigate
run_module
run_module_from_root
run_module_from_root_with_export
run_module_with_export
run_module_with_limits
screenshot
wait
wait_until
Constants
MAX_JAVASCRIPT_SOURCE_BYTES
Archive
Overview
Types
ArchiveError
ArchiveRefError
DocumentArchiveRef
PlanArchiveRef
Assertions
Overview
Types
AssertionError
AssertionGroup
AssertionReport
Check
CheckError
CheckResult
LocalAssertion
SourceError
Constants
MAX_ASSERTION_CONTRACT_TYPE_BYTES
MAX_CHECK_ERROR_BYTES
MAX_CHECK_NAME_BYTES
MAX_CHECKS
Automation record
Overview
Types
AutomationContext
AutomationRecord
AutomationRecordError
AutomationRecordRef
Observation
OperationReceipt
OperationStatus
Constants
AUTOMATION_RECORD_VERSION
MAX_AUTOMATION_RECORD_BYTES
MAX_AUTOMATION_RECORD_EVIDENCE_BYTES
MAX_AUTOMATION_RECORD_ITEMS
MAX_OBSERVATION_HTML_BYTES
MAX_OBSERVATION_SCREENSHOT_BYTES
Browser
Overview
Types
BrowserConfig
BrowserConfigurationError
BrowserEngine
BrowserExecutionIdentity
BrowserProtocol
MoliProfile
Contracts
Overview
Types
CandidateField
Cardinality
Contract
ContractId
ContractIdentity
ContractLocatorError
ContractOutcome
ContractSchema
ContractSchemaError
ContractValue
Extracted
ExtractionDiagnostic
ExtractionFailure
ExtractionLimit
FieldId
FieldIssue
FieldIssueKind
FieldSchema
RecordIssue
RecordScope
RuntimeCandidate
RuntimeContract
RuntimeContractError
RuntimeContractOutcome
RuntimeExtracted
RuntimeFieldValue
RuntimeRecordIssue
RuntimeValidatedRecord
RuntimeValue
ValidateContract
ValidatedRecord
ValidationFailure
Macros
Contract
Exports
ArchivedContractOutcome
RuntimeContractArchiveError
Documents
Overview
Types
AccessibilityCompleteness
BoundDocument
DocumentClass
DocumentEpoch
DocumentError
DocumentRef
DocumentRepresentation
DocumentSchemaProfile
ParsedDocument
ParseError
SourceFormat
Expect
Overview
Types
AccessibilityExpectation
AllExpectation
Expectation
JsonMatch
ResponseExpectation
UntilExpectation
Functions
all
ax
count_at_least
exists
response
visible
Constants
MAX_EXPECTATIONS
MAX_RESPONSE_JSON_MATCHES
Flow
Overview
Types
BoundFlow
Condition
FailureCapturePolicy
Flow
FlowCancellationCause
FlowCompletionError
FlowFailureCause
FlowInvokeError
FlowLimits
FlowOutcome
FlowStopCause
FlowStopReason
FlowTermination
FlowValidationError
SkippedStep
Step
StepOutcome
Functions
new
Locators
Overview
Modules
Locator
Overview
Functions
css
text_literal
Types
AccessibilityCoordinate
AccessibilityStateName
ByteRange
Completeness
CoordinateError
DecodedTextCoordinate
DomCoordinate
DomNodeId
ExpandedNamePathSegment
Finding
IncompleteEvidence
JsonCoordinate
JsonQuerySyntaxError
LocateFailure
LocateResult
NamedOutput
NamespaceBinding
NativeCoordinate
NodeReference
OutputId
OutputPlan
PinnedLocator
PinnedOutputLocator
Plan
PlanError
ProjectedValue
QueryAtom
QueryError
QueryResultShape
QuerySpec
RegionId
RegionLineage
RegionPlan
ResourceLimit
TextRange
TreeCoordinate
Functions
accessibility_state
accessibility_text
accessible_name
css
json_path
json_pointer
output
regex
role
text_literal
tree_text_contains
xpath
Map
Overview
Types
DiscoverySource
Exploration
FrontierEntry
HostEntry
HostVerification
LimitReached
MapError
MapOutcome
MapRequest
MapTermination
Observation
Omission
OmissionReason
PageEntry
PendingReason
PublicProvider
Rejection
Relationship
RelationshipKind
RequestTrace
RetainedCapture
SkipReason
SourceFailure
SourceOutcome
SourceSkipReason
SourceStatus
Summary
SupportDocument
SupportDocumentKind
TreeEntry
WildcardEntry
Functions
new
Policy
Overview
Modules
Search
Overview
Types
EffectiveProviderRoute
EffectiveSearch
ProfileSelectionKind
Provider
Search
Types
AccessibilityNodeLimit
Acquisition
AcquisitionKind
AddressableByteLimit
BrowserLimits
BrowserMode
Budget
DirectHttpRedirects
DirectHttpRedirectTargets
DiscoveryDocuments
DocumentRequest
Documents
DocumentSelectionKind
EventLimit
Filters
HostScope
IpFamily
Limits
Locators
Map
MaximumElapsed
Network
Page
PageDiscovery
PathScope
PolicySnapshot
ProfileSelection
ProviderDefaultsStatus
ProviderDefaultsVersion
ProviderRequestProfile
ProviderSelection
RedirectHopLimit
Request
ResourceLimit
Robots
Scope
SourceLimits
Subdomains
Tuning
TuningMode
Prelude
Overview
Request
Overview
Types
ActivityId
Attempt
AttemptDiagnostic
AttemptDocument
AttemptFailureKind
AttemptState
BoundPageRequest
BrowserFailureReason
CaptureId
DecodingErrorCode
DirectHttpRedirectErrorKind
DirectHttpTransportErrorKind
DocumentOutcome
NotStartedReason
PageRequest
PartialReason
RequestId
RequestPreparationError
RequestSendError
Response
ResponseRef
UnavailableReason
UnknownReason
UnprojectableReason
WebArtifactFamily
WebTarget
Functions
new
Exports
CancellationToken
Search
Overview
Types
BoundSearchRequest
FeatureCoverage
ImageResult
LocalPlace
ProviderCharge
ProviderIdentity
ProviderOutcome
ProviderResult
RequestAttemptSummary
RequestAttemptTerminal
SearchAttemptDiagnostic
SearchCoverage
SearchFailure
SearchFeature
SearchHit
SearchHitMetadata
SearchIssue
SearchIssueKind
SearchPage
SearchProfileFacts
SearchQueryError
SearchRequest
SearchRequestId
SearchResponse
SearchResultUrl
SearchSendError
SearchTermination
SearchUnavailableReason
WebCoverage
Functions
new
Session
Overview
Types
ActionKind
ExecutionPool
ExecutionPoolError
ExecutionSnapshot
JsFrame
JsTarget
JsWorld
Session
SessionBuilder
SessionError
SessionPolicy
SessionRequest
SessionRequestError
Tab
UntilCheck
UntilCheckState
UntilReport
UntilReportError
UntilScope
UntilTermination
Watcher
Work
Functions
new
new_operation_id
Constants
MAX_UNTIL_REPORT_BYTES
Surface
Overview
Modules
Archive
Overview
Functions
export
replay
Browser
Overview
Modules
Archive
Overview
Functions
rerun
Model
Overview
Types
Access
AddressToken
Capability
ContinuationToken
Descriptor
Entry
Inspection
Observation
ObservationId
Page
ReadOperation
ReadRequest
ReadResult
Reference
SourceId
SurfaceId
SurfaceRead
Video
Overview
Modules
Archive
Overview
Types
FrameArchiveRef
FrameInfo
VideoArchiveRef
VideoMetadata
Types
ActionLease
ActionReceipt
ActionStatus
ArchivedSource
ArchiveLimits
ArchivePolicy
Continuation
Coordinate
Coverage
Cursor
CursorId
CursorState
Entry
Event
EventBatch
EventKind
Freshness
ImageCrop
Inspection
Outcome
OutcomeRef
Page
Position
Reference
SourceInterpretation
SourceReference
WatchId
WatchState
Timing
Overview
Functions
milliseconds
seconds
View
Overview
Types
DomElementRow
View
ViewCaptureToken
ViewCursor
ViewError
ViewSource
Constants
MAX_VIEW_PAGE_SIZE
MAX_VIEW_SELECTOR_BYTES
MAX_VIEW_TEXT_PREVIEW_CHARS
MAX_VIEW_URL_BYTES
Types
Archive
BrowserSurface
Continuation
CountLimit
DecodedFrame
Document
DocumentId
DocumentProfile
EffectivePolicyIdentity
ExecutionError
FlowPolicy
LocateOutcome
PixelRect
Policy
PolicyError
ResponseTermination
StepLimit
StopScope
Surface
SurfaceBudget
SurfaceConnection
SurfaceError
SurfaceLimits
SurfacePolicy
SurfaceSession
SurfaceSessionPolicy
VideoError
VideoPolicy
VideoSession
VideoSurface
WebSurface
Exports
CancellationToken
Python
Overview
yosoi.archive
Overview
Types
Overview
Archive
AutomationContext
AutomationRecord
AutomationRecordRef
DocumentArchiveRef
PlanArchiveRef
yosoi.browser
Overview
Aliases
Overview
ActionKind
BrowserError
BrowserMode
Condition
ExecutionConcurrency
FlowTermination
HttpStatus
MaximumQueuedOperations
OperationStatus
PositiveMilliseconds
PositiveU32
PositiveU64
Step
StopCause
UntilCheckSource
UntilCheckState
UntilExpectation
UntilTermination
Constants
Overview
MAX_UNTIL_REPORT_BYTES
U64
Functions
Overview
action
all_of
assert_all
assert_that
ax
check
click
count_at_least
enter_text
evaluate
evaluate_file
exists
flow
navigate
response
run_module
run_module_with_export
screenshot
session
timed
until
visible
wait
wait_until
Types
Overview
AccessibilityExpectation
AllExpectation
Assert
BoundFlow
BrowserCleanupError
BrowserExecutionIdentity
Check
Click
ConditionExpectation
Configured
CountAtLeast
Duration
EnterText
Evaluate
EvaluateFile
EvaluateModule
Exists
Flow
FlowExecutionError
FlowInvocationError
FlowOutcome
FlowStopReason
JsonMatch
LocalContractExpectation
LocalRustAssertion
Navigate
NestedFlow
Observation
OperationReceipt
ResponseExpectation
Screenshot
Session
SessionPolicy
SkippedStep
StepOutcome
Timed
TriggerStep
UntilCheck
UntilReport
UntilScope
UntilStep
Visible
Wait
WaitExpectation
WaitUntil
Work
yosoi.cancellation
Overview
Types
Overview
CancellationToken
yosoi.contracts
Overview
Aliases
Overview
ArchivedContractCandidateField
ArchivedContractField
ArchivedContractOutcome
ArchivedContractRecordIssue
ArchivedContractString
ArchivedContractValue
ArchivedValidatedContractRecord
Cardinality
ContractSchemaFailure
ContractValidationReport
Limit
RuntimeCandidate
RuntimeContract
RuntimeContractOutcome
RuntimeExactlyOne
RuntimeExtracted
RuntimeExtractionFailure
RuntimeFieldValue
RuntimeMany
RuntimeRecordIssue
RuntimeString
RuntimeValidatedRecord
RuntimeValidationFailure
RuntimeValue
RuntimeZeroOrOne
Functions
Overview
Field
extract
extract_report
value_type_id
Types
Overview
Candidate
CandidateField
Contract
ContractIssues
ContractOutcome
ContractRecordIssue
ContractSchema
ContractValue
Extracted
ExtractionDiagnostic
ExtractionLimits
ExtractionPolicy
FieldIssue
FieldIssueKind
FieldSchema
RecordIssue
TerminalFailure
ValidatedRecord
ValidationLimits
yosoi.diagnostics
Overview
Aliases
Overview
AttemptDiagnostic
AttemptFailureKind
BrowserFailureReason
DecodingErrorCode
Diagnostic
DirectHttpRedirectErrorKind
NotStartedReason
PartialReason
ProjectionReason
SearchAttemptDiagnostic
TransportDiagnostic
UnavailableReason
UnknownReason
UnprojectableReason
WebArtifactFamily
yosoi.documents
Overview
Aliases
Overview
DocumentClass
SourceFormat
Types
Overview
BoundDocument
Document
DocumentProfile
ParsedDocument
yosoi.errors
Overview
Functions
Overview
rust_error_details
Types
Overview
RustErrorDetails
yosoi.identities
Overview
Types
Overview
ActivityId
CaptureId
ContractIdentity
RequestId
yosoi.locators
Overview
Aliases
Overview
AccessibilityStateName
JsonQuerySyntaxError
NamedOutput
OutputPlan
ProjectionKind
QueryKind
QueryResultShape
RegionPlan
Functions
Overview
accessibility_state
accessibility_text
accessible_name
css
json_path
json_pointer
output
regex
role
text_literal
tree_text_contains
xpath
Types
Overview
AccessibilityStateAtom
Locator
NamespaceBinding
Output
Plan
Query
QueryAtom
QuerySpec
Region
yosoi.map
Overview
Aliases
Overview
MapOrderingKind
Rejection
RelationshipKind
SkipReason
SourceSkipReason
Functions
Overview
compare_values
new
rejection_message
Types
Overview
BoundMapRequest
DiscoverySource
Exploration
FrontierEntry
HostEntry
MapOutcome
MapRequest
MapTermination
Observation
Omission
OmissionReason
PageEntry
PublicProvider
Relationship
RequestTrace
RetainedCapture
SourceFailure
SourceOutcome
SourceStatus
Summary
SupportDocument
TreeEntry
WildcardEntry
yosoi.outcomes
Overview
Aliases
Overview
Completeness
DocumentClassName
IncompleteEvidence
LocateFailure
LocateOutcome
NativeCoordinate
PositiveU32
ProjectedValue
ResourceLimit
Constants
Overview
U32
U64
Functions
Overview
projected_values_equal
projected_values_not_equal
Types
Overview
AccessibilityCoordinate
AccessibilityLocation
Attribute
AttributeValue
ByteRange
CapturedText
Complete
DecodedTextCoordinate
DecodedTextLocation
DomCoordinate
ExpandedNamePathSegment
Failure
Finding
Indeterminate
JsonLocation
JsonValueProjection
LocateFailed
LocateResult
Matched
NoMatch
NodeReference
NodeValue
Partial
RegionLineage
RenderedDomLocation
SourceTreeLocation
TextRange
TextValue
TextWithCaptures
TreeCoordinate
Unknown
yosoi.policy
Overview
Aliases
Overview
AccessibilityNodeLimitValue
AddressableByteLimitValue
BrowserEngine
BrowserMode
BudgetValue
Continuation
CountLimitValue
DirectHttpRedirectTargets
DiscoveryDocuments
DocumentRequest
DocumentSelectionKind
EventLimitValue
HostScope
IpFamily
MaximumElapsedValue
MoliProfile
PageDiscovery
PathScope
PositiveInt
PositiveU16
PositiveU32
PositiveU64
ProfileSelectionKind
RedirectHopLimitValue
ResourceLimitValue
Robots
StepLimitValue
StopScope
Subdomains
TuningMode
Constants
Overview
U16
U64
Types
Overview
Acquisition
AcquisitionKind
BrowserConfig
BrowserLimits
Continue
DocumentSelection
Documents
Duration
EffectiveAcquisition
EffectivePage
EffectivePolicy
EffectiveProviderRoute
EffectiveSearch
Filters
FlowPolicy
Locators
Map
MapLimits
Network
Page
Policy
PolicyIdentity
PolicySnapshot
ProfileSelection
Provider
ProviderDefaultsStatus
ProviderRequestProfile
ProviderSelection
Redirects
Request
Scope
Search
SourceLimits
Stop
Tuning
yosoi.request
Overview
Aliases
Overview
DocumentOutcome
DocumentRequest
Functions
Overview
new
Types
Overview
Attempt
AttemptDocument
BoundPageRequest
BoundSessionRequest
DocumentMetadata
PageRequest
PartialDocument
Produced
Response
Unavailable
Unprojectable
WebTarget
yosoi.runtime_contracts
Overview
Aliases
Overview
ArchivedContractFieldValue
ArchivedContractOutcomeData
ArchivedContractValue
ArchivedExtractionFailure
ArchivedExtractionLimitName
ArchivedValidationFailure
ContractSchemaFailure
ExtractionLimitName
RuntimeContractOutcomeData
RuntimeExtractedData
RuntimeExtractionFailure
RuntimeFieldValue
RuntimeValidationFailure
RuntimeValue
Types
Overview
ArchivedContractCandidateField
ArchivedContractField
ArchivedContractOutcome
ArchivedContractRecordIssue
ArchivedContractString
ArchivedValidatedContractRecord
RuntimeCandidate
RuntimeContract
RuntimeContractOutcome
RuntimeExactlyOne
RuntimeExtracted
RuntimeMany
RuntimeRecordIssue
RuntimeString
RuntimeValidatedRecord
RuntimeZeroOrOne
yosoi.scalars
Overview
Constants
Overview
RUST_DOMAIN_VALIDATED
Types
Overview
AccessibilityNodeLimit
AddressableByteLimit
Budget
ByteLimit
CaptureDeadline
CaptureDuration
ContractId
CountLimit
DocumentEpoch
DocumentId
DomNodeId
EventLimit
FieldId
JsonCoordinate
MaximumElapsed
NonZeroU32
OutputId
ProviderDefaultsVersion
RedirectHopLimit
RegionId
ResourceLimit
StepLimit
ValidatedInteger
ValidatedString
yosoi.search
Overview
Aliases
Overview
Provider
ProviderOutcome
Rank
SearchFeature
Functions
Overview
new
Types
Overview
Answer
BoundSearchRequest
Cancelled
ChargeAmount
Empty
Failed
ImageGallery
ImageResult
LocalPack
LocalPlace
NotStarted
ProviderCharge
ProviderIdentity
ProviderResult
RequestAttemptSummary
Results
SearchCoverage
SearchHit
SearchHitMetadata
SearchIssue
SearchPage
SearchProfileFacts
SearchRequest
SearchResponse
SearchResultUrl
Sponsored
yosoi.surface
Overview
Aliases
Overview
Access
ActionStatus
ArchivePolicy
CursorId
EventKind
ExecutionError
Freshness
ReadOperation
ReadResult
SurfaceError
VideoError
WatchId
Functions
Overview
export
replay
rerun_browser
Types
Overview
ActionLease
ActionReceipt
AddressToken
ArchiveLimits
ArchivedSource
BrowserSurface
Budget
Capability
Continuation
ContinuationToken
Coordinate
Coverage
Cursor
CursorState
DecodedFrame
Descriptor
Entry
Event
EventBatch
Expand
FrameArchiveRef
FrameInfo
ImageCrop
IndexMetadata
Inspect
Inspection
InspectionResult
Limits
NativeEntry
NativeInspection
NativePage
NativeReference
Observation
ObservationId
Outcome
OutcomeRef
Overview
Page
PageResult
Parent
ParentResult
PixelRect
Position
ReadRequest
Reference
Search
Session
SessionPolicy
SourceId
SourceInterpretation
SourceReference
Surface
SurfaceConnection
SurfaceId
SurfacePolicy
SurfaceRead
VideoArchiveRef
VideoMetadata
VideoPolicy
VideoSession
VideoSurface
WatchState
WebSurface
yosoi.view
Overview
Types
Overview
DomElementRow
View
ViewCaptureToken
ViewCursor
ViewSource
Yosoi documentation
Loading release documentation…
Archived documentation requires JavaScript.
Read the latest documentation.