observe() is used to get a list of actions that can be taken on the current page. It’s useful for adding context to your planning step, or if you unsure of what page you’re on.
observe() returns an array of objects, each with an XPath selector and short description.
If you are looking for a specific element, you can also pass in an instruction to observe:
returnAction option to true. Here is a sample ObserveResult:
In Python, the ObserveResult is wrapped in a Pydantic model. You can use model_dump() to get the
dict equivalent.Arguments: ObserveOptions
- TypeScript
- Python
string
Provides instructions for the observation. Defaults to “Find actions that can be performed on this page.”
boolean
Returns an observe result object that contains a suggested action for the candidate element. The suggestion includes method, and arguments (if any). Defaults to
true.boolean
Set
iframes: true if content from iframes should be included in the observation.AvailableModel
Specifies the model to use
object
Configuration options for the model client
number
Timeout in milliseconds for waiting for the DOM to settle
Returns: Promise<ObserveResult[]>
Each ObserveResult object contains a selector and description.
string
required
A string representing the element selector
string
required
A string describing the possible action
string
The method to call on the element
object
The arguments to pass to the method