Skip to content

Commit 0c1b64c

Browse files
Skn0ttSkn0tt
authored
chore: hide stuff (#38882)
1 parent b1fd5d0 commit 0c1b64c

23 files changed

Lines changed: 63 additions & 731 deletions

File tree

‎docs/src/api/class-page.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -712,23 +712,27 @@ Raw CSS content to be injected into frame.
712712
## async method: Page.agent
713713
* since: v1.58
714714
* langs: js
715+
* hidden
715716
- returns: <[PageAgent]>
716717

717718
Initialize page agent with the llm provider and cache.
718719

719720
### option: Page.agent.cache
720721
* since: v1.58
722+
* hidden
721723
- `cache` <[Object]>
722724
- `cacheFile` ?<[string]> Cache file to use/generate code for performed actions into. Cache is not used if not specified (default).
723725
- `cacheOutFile` ?<[string]> When specified, generated entries are written into the `cacheOutFile` instead of updating the `cacheFile`.
724726

725727
### option: Page.agent.expect
726728
* since: v1.58
729+
* hidden
727730
- `expect` <[Object]>
728731
- `timeout` ?<[int]> Default timeout for expect calls in milliseconds, defaults to 5000ms.
729732

730733
### option: Page.agent.limits
731734
* since: v1.58
735+
* hidden
732736
- `limits` <[Object]>
733737
- `maxTokens` ?<[int]> Maximum number of tokens to consume. The agentic loop will stop after input + output tokens exceed this value. Defaults to unlimited.
734738
- `maxActions` ?<[int]> Maximum number of agentic actions to generate, defaults to 10.
@@ -738,6 +742,7 @@ Limits to use for the agentic loop.
738742

739743
### option: Page.agent.provider
740744
* since: v1.58
745+
* hidden
741746
- `provider` <[Object]>
742747
- `api` <[PageAgentAPI]<"openai"|"openai-compatible"|"anthropic"|"google">> API to use.
743748
- `apiEndpoint` ?<[string]> Endpoint to use if different from default.
@@ -747,12 +752,14 @@ Limits to use for the agentic loop.
747752

748753
### option: Page.agent.secrets
749754
* since: v1.58
755+
* hidden
750756
- `secrets` ?<[Object]<[string], [string]>>
751757

752758
Secrets to hide from the LLM.
753759

754760
### option: Page.agent.systemPrompt
755761
* since: v1.58
762+
* hidden
756763
- `systemPrompt` <[string]>
757764

758765
System prompt for the agent's loop.

‎docs/src/api/class-pageagent.md‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# class: PageAgent
22
* since: v1.58
33
* langs: js
4+
* hidden
45

56
## event: PageAgent.turn
67
* since: v1.58
8+
* hidden
79
- argument: <[Object]>
810
- `role` <[string]>
911
- `message` <[string]>
@@ -14,11 +16,13 @@
1416
Emitted when the agent makes a turn.
1517

1618
## async method: PageAgent.dispose
19+
* hidden
1720
* since: v1.58
1821

1922
Dispose this agent.
2023

2124
## async method: PageAgent.expect
25+
* hidden
2226
* since: v1.58
2327

2428
Expect certain condition to be met.
@@ -31,12 +35,14 @@ await agent.expect('"0 items" to be reported');
3135

3236
### param: PageAgent.expect.expectation
3337
* since: v1.58
38+
* hidden
3439
- `expectation` <[string]>
3540

3641
Expectation to assert.
3742

3843
### option: PageAgent.expect.timeout
3944
* since: v1.58
45+
* hidden
4046
- `timeout` <[float]>
4147

4248
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 [`option: Page.agent.expect`] option. Pass `0` to disable timeout.
@@ -46,6 +52,7 @@ Expect timeout in milliseconds. Defaults to `5000`. The default value can be cha
4652

4753
## async method: PageAgent.extract
4854
* since: v1.58
55+
* hidden
4956
- returns: <[Object]>
5057
- `result` <[any]>
5158
- `usage` <[Object]>
@@ -66,16 +73,19 @@ await agent.extract('List of items in the cart', z.object({
6673

6774
### param: PageAgent.extract.query
6875
* since: v1.58
76+
* hidden
6977
- `query` <[string]>
7078

7179
Task to perform using agentic loop.
7280

7381
### param: PageAgent.extract.schema
7482
* since: v1.58
83+
* hidden
7584
- `schema` <[z.ZodSchema]>
7685

7786
### option: PageAgent.extract.timeout
7887
* since: v1.58
88+
* hidden
7989
- `timeout` <[float]>
8090

8191
Extract timeout in milliseconds. Defaults to `5000`. The default value can be changed via `actionTimeout` option in the config, or by using the [`method: BrowserContext.setDefaultTimeout`] or
@@ -84,9 +94,9 @@ Extract timeout in milliseconds. Defaults to `5000`. The default value can be ch
8494
### option: PageAgent.extract.-inline- = %%-page-agent-call-options-v1.58-%%
8595
* since: v1.58
8696

87-
8897
## async method: PageAgent.perform
8998
* since: v1.58
99+
* hidden
90100
- returns: <[Object]>
91101
- `usage` <[Object]>
92102
- `turns` <[int]>
@@ -103,22 +113,26 @@ await agent.perform('Click submit button');
103113

104114
### param: PageAgent.perform.task
105115
* since: v1.58
116+
* hidden
106117
- `task` <[string]>
107118

108119
Task to perform using agentic loop.
109120

110121
### option: PageAgent.perform.timeout
111122
* since: v1.58
123+
* hidden
112124
- `timeout` <[float]>
113125

114126
Perform timeout in milliseconds. Defaults to `5000`. The default value can be changed via `actionTimeout` option in the config, or by using the [`method: BrowserContext.setDefaultTimeout`] or
115127
[`method: Page.setDefaultTimeout`] methods. Pass `0` to disable timeout.
116128

117129
### option: PageAgent.perform.-inline- = %%-page-agent-call-options-v1.58-%%
118130
* since: v1.58
131+
* hidden
119132

120133
## async method: PageAgent.usage
121134
* since: v1.58
135+
* hidden
122136
- returns: <[Object]>
123137
- `turns` <[int]>
124138
- `inputTokens` <[int]>

‎docs/src/api/params.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,26 +372,30 @@ Emulates consistent window screen size available inside web page via `window.scr
372372

373373
## page-agent-cache-key
374374
* since: v1.58
375+
* hidden
375376
- `cacheKey` <[string]>
376377

377378
All the agentic actions are converted to the Playwright calls and are cached.
378379
By default, they are cached globally with the `task` as a key. This option allows controlling the cache key explicitly.
379380

380381
## page-agent-max-tokens
381382
* since: v1.58
383+
* hidden
382384
- `maxTokens` <[int]>
383385

384386
Maximum number of tokens to consume. The agentic loop will stop after input + output tokens exceed this value.
385387
Defaults to context-wide value specified in `agent` property.
386388

387389
## page-agent-max-actions
388390
* since: v1.58
391+
* hidden
389392
- `maxActions` <[int]>
390393

391394
Maximum number of agentic actions to generate, defaults to context-wide value specified in `agent` property.
392395

393396
## page-agent-max-action-retries
394397
* since: v1.58
398+
* hidden
395399
- `maxActionRetries` <[int]>
396400

397401
Maximum number of retries when generating each action, defaults to context-wide value specified in `agent` property.

‎docs/src/test-api/class-fixtures.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Playwright Test comes with builtin fixtures listed below, and you can add your o
2020

2121
## property: Fixtures.agent
2222
* since: v1.58
23+
* hidden
2324
- type: <[PageAgent]>
2425

2526
## property: Fixtures.browser

‎docs/src/test-api/class-fullconfig.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ Base directory for all relative paths used in the reporters.
106106

107107
## property: FullConfig.runAgents
108108
* since: v1.58
109+
* hidden
109110
- type: <['RunAgentsMode]<"all"|"missing"|"none">>
110111

111112
Whether to run LLM agent for [PageAgent]:

‎docs/src/test-api/class-testconfig.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -516,6 +516,7 @@ export default defineConfig({
516516

517517
## property: TestConfig.runAgents
518518
* since: v1.58
519+
* hidden
519520
- type: ?<['RunAgentsMode]<"all"|"missing"|"none">>
520521

521522
Whether to run LLM agent for [PageAgent]:

‎docs/src/test-api/class-testoptions.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ export default defineConfig({
4848

4949
## property: TestOptions.agentOptions
5050
* since: v1.58
51+
* hidden
5152
- type: <[Object]>
5253
- `provider` <[Object]>
5354
- `api` <[PageAgentAPI]<"openai"|"openai-compatible"|"anthropic"|"google">> API to use.

0 commit comments

Comments
 (0)