zoushiyang/page-agent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(website): update config docs

Browse Source
This commit is contained in:
Simon
2026-01-17 02:05:09 +08:00
parent 6d6c82648c
commit 2410c27b55
1 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
packages/website/src/pages/docs/integration/configuration/page.tsx
View File

@@ -28,15 +28,17 @@ export default function Configuration() {
className="mb-4" className="mb-4"
language="typescript" language="typescript"
code={`interface LLMConfig { code={`interface LLMConfig {
baseURL?: string baseURL: string
apiKey?: string apiKey: string
model?: string model: string
temperature?: number temperature?: number
maxRetries?: number maxRetries?: number
/** /**
* Custom fetch function for LLM API requests. * Custom fetch function for LLM API requests.
* Use this to customize headers, credentials, proxy, etc. * Use this to customize headers, credentials, proxy, etc.
* The response should follow OpenAI API format.
*/ */
customFetch?: typeof globalThis.fetch customFetch?: typeof globalThis.fetch
}`} }`}
@@ -71,12 +73,12 @@ export default function Configuration() {
getPageInstructions?: (url: string) => string | undefined | null getPageInstructions?: (url: string) => string | undefined | null
} }
// Lifecycle hooks // Lifecycle hooks (with \`this\` bound to PageAgent instance)
onBeforeStep?: (stepCnt: number) => Promise<void> | void onBeforeStep?: (this: PageAgent, stepCnt: number) => Promise<void> | void
onAfterStep?: (stepCnt: number, history: AgentHistory[]) => Promise<void> | void onAfterStep?: (this: PageAgent, stepCnt: number, history: HistoryEvent[]) => Promise<void> | void
onBeforeTask?: () => Promise<void> | void onBeforeTask?: (this: PageAgent) => Promise<void> | void
onAfterTask?: (result: ExecutionResult) => Promise<void> | void onAfterTask?: (this: PageAgent, result: ExecutionResult) => Promise<void> | void
onDispose?: (reason?: string) => void onDispose?: (this: PageAgent, reason?: string) => void
/** /**
* Transform page content before sending to LLM. * Transform page content before sending to LLM.
@@ -103,7 +105,7 @@ export default function Configuration() {
<CodeEditor <CodeEditor
className="mb-4" className="mb-4"
language="typescript" language="typescript"
code={`interface PageControllerConfig { code={`interface DomConfig {
/** Elements to exclude from interaction */ /** Elements to exclude from interaction */
interactiveBlacklist?: (Element | (() => Element))[] interactiveBlacklist?: (Element | (() => Element))[]
@@ -118,15 +120,13 @@ export default function Configuration() {
/** Highlight label opacity (0-1) */ /** Highlight label opacity (0-1) */
highlightLabelOpacity?: number highlightLabelOpacity?: number
}
/** Viewport expansion in pixels (-1 for full page) */ interface PageControllerConfig extends DomConfig {
/** Viewport expansion in pixels */
viewportExpansion?: number viewportExpansion?: number
/** /** Enable visual mask overlay during operations (default: false) */
* Enable visual mask overlay during automation.
* Blocks user interaction while agent is running.
* Default: false for PageController, true for PageAgent.
*/
enableMask?: boolean enableMask?: boolean
}`} }`}
/> />