observe

Observes the page for changes based on a natural language instruction and returns a list of observed interactions. This is an AI-driven feature that can identify and describe user interface elements and their behaviors. Example: observe(instruction: "Identify all interactive elements in the header.") Returns an array of Observe objects, each describing an observed element or interaction.

​

Definition

observe(
  instruction: String!
  options: ObserveOptions
): [Observe]!

​

Arguments

​

instruction: String!

A natural language instruction describing what to observe on the page. Example: "Find all buttons and links in the navigation bar."

​

options: ObserveOptions

Options for the observation process, like DOM settle timeout.

​

Returns

[Observe]!

Represents an observed UI element or interaction, typically generated by the ‘observe’ mutation.