Observe - 🤘 Stagehand

observe() 用于获取当前页面可执行的操作列表。该功能既可为规划步骤添加上下文，也可用于不确定当前所处页面时的场景。

const observations = await page.observe();

observe() 返回对象数组，每个对象包含XPath选择器selector和简短description描述。如需查找特定元素，也可传入指令进行观察：

const observations = await page.observe({
  instruction: "Find the buttons on this page",
});

通过将returnAction选项设为true，Observe还能返回针对候选元素的建议操作。以下是ObserveResult的示例：

  {
    "description": "A brief description of the component",
    "method": 'click',
    "arguments": [],
    "selector": 'xpath=/html/body[1]/div[1]/main[1]/button[1]'
  }

在Python中，ObserveResult被封装为Pydantic模型。可通过model_dump()方法获取等效的dict结构。

参数说明: `ObserveOptions`

TypeScript
Python

instruction

string

提供观察指令。默认为”查找可在此页面上执行的操作”。

returnAction

boolean

返回包含候选元素建议操作的观察结果对象。建议内容包括方法及参数（如有）。默认为true。

iframes

boolean

如需包含iframe内容进行观察，请设置iframes: true。

modelName

AvailableModel

指定使用的模型

modelClientOptions

object

模型客户端的配置选项

domSettleTimeoutMs

number

等待DOM稳定的超时时间（毫秒）

返回: `Promise<ObserveResult[]>`

每个 ObserveResult 对象包含 selector 和 description 属性。

selector

string

必填

表示元素选择器的字符串

description

string

必填

描述可能操作的字符串

method

string

在元素上调用的方法名称

arguments

object

传递给方法的参数对象

​参数说明: ObserveOptions

​返回: Promise<ObserveResult[]>

参数说明: `ObserveOptions`

返回: `Promise<ObserveResult[]>`