Skip to main content

class: PageAgent

Added in: v1.58

Languages: JavaScript

event: PageAgent.turn​

Added in: v1.58

  • argument: <Object>
    • role <string>
    • message <string>
    • usage ?<Object>
      • inputTokens <int>
      • outputTokens <int>

Emitted when the agent makes a turn.

async method: PageAgent.dispose​

Added in: v1.58

Dispose this agent.

async method: PageAgent.expect​

Added in: v1.58

Expect certain condition to be met.

Usage

await agent.expect('"0 items" to be reported');

param: PageAgent.expect.expectation​

Added in: v1.58

  • expectation <string>

Expectation to assert.

option: PageAgent.expect.timeout​

Added in: v1.58

  • timeout <float>

Expect timeout in milliseconds. Defaults to 5000. The default value can be changed via expect.timeout option in the config, or by specifying the expect property of the Page.agent.expect option. Pass 0 to disable timeout.

option: PageAgent.expect.-inline- = %%-page-agent-call-options-v1.58-%%​

Added in: v1.58

async method: PageAgent.extract​

Added in: v1.58 Returns: Object

  • result <any>
  • usage <Object>
    • turns <int>
    • inputTokens <int>
    • outputTokens <int>

Extract information from the page using the agentic loop, return it in a given Zod format.

Usage

await agent.extract('List of items in the cart', z.object({
  title: z.string().describe('Item title to extract'),
  price: z.string().describe('Item price to extract'),
}).array());

param: PageAgent.extract.query​

Added in: v1.58

  • query <string>

Task to perform using agentic loop.

param: PageAgent.extract.schema​

Added in: v1.58

  • schema <[z.ZodSchema]>

option: PageAgent.extract.timeout​

Added in: v1.58

  • timeout <float>

Extract timeout in milliseconds. Defaults to 5000. The default value can be changed via actionTimeout option in the config, or by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods. Pass 0 to disable timeout.

option: PageAgent.extract.-inline- = %%-page-agent-call-options-v1.58-%%​

Added in: v1.58

async method: PageAgent.perform​

Added in: v1.58 Returns: Object

  • usage <Object>
    • turns <int>
    • inputTokens <int>
    • outputTokens <int>

Perform action using agentic loop.

Usage

await agent.perform('Click submit button');

param: PageAgent.perform.task​

Added in: v1.58

  • task <string>

Task to perform using agentic loop.

option: PageAgent.perform.timeout​

Added in: v1.58

  • timeout <float>

Perform timeout in milliseconds. Defaults to 5000. The default value can be changed via actionTimeout option in the config, or by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods. Pass 0 to disable timeout.

option: PageAgent.perform.-inline- = %%-page-agent-call-options-v1.58-%%​

Added in: v1.58

async method: PageAgent.usage​

Added in: v1.58 Returns: Object

  • turns <int>
  • inputTokens <int>
  • outputTokens <int>

Returns the current token usage for this agent.

Usage

const usage = await agent.usage();
console.log(`Tokens used: ${usage.inputTokens} in, ${usage.outputTokens} out`);