> For the complete documentation index, see [llms.txt](https://developers.oxylabs.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.oxylabs.io/products/cn/web-scraper-api/features/custom-parser/parser-presets.md). # 解析器预设 你可以 **保存**, **重复使用**、以及 **修改** 通过网页爬虫API使用自定义解析指令。一旦你创建了解析器预设，我们会将其托管在我们的系统中，使你能够在抓取任务中通过 `parser_preset` payload 中的参数。 此功能提供几项 **核心功能**: * 在我们的系统上保存并管理你自己的解析器 * 在多个抓取任务中轻松重复使用预设 * 创建、检索、更新、删除并列出所有预设 * 访问预设的性能和使用统计信息 * 使用自修复预设适应不断变化的网站 ## API 参考 **端点：** `https://data.oxylabs.io/v1/parsers/presets` 下表列出了每个可用操作及其端点路径：
操作请求方法路径
创建 一个预设POST/v1/parsers/presets
检索 一个预设GET/v1/parsers/presets/{preset_name}
更新 一个预设PUT/v1/parsers/presets/{preset_name}
删除 一个预设DELETE/v1/parsers/presets/{preset_name}
列出所有 预设GET/v1/parsers/presets
查看使用情况 和 性能 统计信息GET/v1/parsers/presets/{preset_name}/stats
跟踪自修复 变更GET/v1/parsers/presets/{parser_name}/changelog
## 启用自修复 解析器预设具备自修复功能，可在网站变化时帮助维护解析器及其成功率。启用后，解析器预设 **会自动修复自身** 并在后台调整解析指令，无需额外手动输入。 要 **启用自修复** 要为你的自定义解析器预设启用自修复，在创建或更新预设时请包含以下必填参数：
参数描述
self_heal设置为 时会开启自修复功能 True.
prompt_schema一个描述所需解析器输出的 JSON schema。你可以在以下情况下自动创建该 schema 使用 API 生成解析器时.
urls同一页面类型最多 5 个 URL 的列表。我们建议提供 3-5 个 URL，以帮助解析器适应不同布局并提高解析准确性。
载荷示例 此处显示的载荷示例通过更新现有预设来启用自修复。 **端点：** `PUT https://data.oxylabs.io/v1/parsers/presets/{preset_name}` ```json { "self_heal": true, "urls": ["https://sandbox.oxylabs.io/products"], "prompt_schema": { "properties": { "product_titles": { "description": "Title of each product.", "items": { "type": "字符串" }, "maxItems": 5, "title": "Product Titles", "type": "array" } }, "required": [ "product_titles" ], "title": "字段", "type": "对象" } } ```
## 使用示例 ### 创建预设 **端点：** `POST https://data.oxylabs.io/v1/parsers/presets` **载荷：** ```json { "name": "my_new_parser", "description": "Extract text from all H4 elements on the page.", "parsing_instructions": { "titles": { "_fns": [ { "_args": ["//h4/text()"], "_fn": "xpath" } ] } } } ```
输出 ```json { "id": 421947, "name": "my_new_parser", "description": "Extract text from all H4 elements on the page.", "prompt_text": null, "prompt_schema": null, "urls": [], "render": false, "parsing_instructions": { "titles": { "_fns": [ { "_args": [ "//h4/text()" ], "_fn": "xpath" } ] } }, "self_heal": false, "heal_status": "disabled", "last_healed_at": null, "created_at": "2025-10-27 11:40:22", "updated_at": "2025-10-27 11:40:22" } ```
### 使用预设 **端点：** `POST https://realtime.oxylabs.io/v1/queries` **载荷：** ```json { "source": "universal", "url": "https://sandbox.oxylabs.io/products", "parse": true, "parser_preset": "my_new_parser" } ```
输出 ```json { "results": [ { "content": { "titles": [ "The Legend of Zelda: Ocarina of Time", "Super Mario Galaxy", "Super Mario Galaxy 2", "Metroid Prime", "Super Mario Odyssey", "Halo: Combat Evolved", "The House in Fata Morgana - Dreams of the Revenants Edition -", "NFL 2K1", "Uncharted 2: Among Thieves", "Tekken 3", "The Legend of Zelda: The Wind Waker", "Gran Turismo", "Metal Gear Solid 2: Sons of Liberty", "Grand Theft Auto Double Pack", "Baldur's Gate II: Shadows of Amn", "Tetris Effect: Connected", "The Legend of Zelda Collector's Edition", "Gran Turismo 3: A-Spec", "The Legend of Zelda: A Link to the Past", "The Legend of Zelda: Majora's Mask", "The Last of Us", "Persona 5 Royal", "The Last of Us Remastered", "The Legend of Zelda: Ocarina of Time 3D", "Chrono Cross", "Gears of War", "Sid Meier's Civilization II", "Halo 3", "Ninja Gaiden Black", "Super Mario Advance 4: Super Mario Bros. 3", "Jet Grind Radio", "Grim Fandango" ], "parse_status_code": 12000 }, "created_at": "2025-10-27 11:41:18", "updated_at": "2025-10-27 11:41:19", "page": 1, "url": "https://sandbox.oxylabs.io/products", "job_id": "7388540292158203905", "is_render_forced": false, "status_code": 200, "type": "parsed", "parser_type": "preset", "parser_preset": "my_new_parser" } ] } ```
### 检索预设 **端点：** `GET https://data.oxylabs.io/v1/parsers/presets/{preset_name}`
输出 ```json { "id": 421947, "name": "my_new_parser", "description": "Extract text from all H4 elements on the page.", "prompt_text": null, "prompt_schema": null, "urls": [], "render": false, "parsing_instructions": { "titles": { "_fns": [ { "_args": [ "//h4/text()" ], "_fn": "xpath" } ] } }, "self_heal": false, "heal_status": "disabled", "last_healed_at": null, "created_at": "2025-10-27 11:40:22", "updated_at": "2025-10-27 11:40:22" } ```
### 更新预设 **端点：** `PUT https://data.oxylabs.io/v1/parsers/presets/{preset_name}` 定义你要更新的预设字段。以下示例中，只有 `parsing_instructions` 会被更新。 **载荷：** ```json { "parsing_instructions": { "titles": { "_fns": [ { "_args": ["//h4/text()"], "_fn": "xpath" } ] }, "prices": { "_fns": [ { "_args": [".price-wrapper"], "_fn": "css" }, {"_fn": "element_text"} ] } } } ```
输出 ```json { "id": 421947, "name": "my_new_parser", "description": "Extract text from all H4 elements on the page.", "prompt_text": null, "prompt_schema": null, "urls": [], "render": false, "parsing_instructions": { "prices": { "_fns": [ { "_args": [ ".price-wrapper" ], "_fn": "css" }, { "_fn": "element_text" } ] }, "titles": { "_fns": [ { "_args": [ "//h4/text()" ], "_fn": "xpath" } ] } }, "self_heal": false, "heal_status": "disabled", "last_healed_at": null, "created_at": "2025-10-27 11:40:22", "updated_at": "2025-10-27 11:44:24" } ```
### 删除预设 **端点：** `DELETE https://data.oxylabs.io/v1/parsers/presets/{preset_name}` ### 列出所有预设 **端点：** `GET https://data.oxylabs.io/v1/parsers/presets`
输出 ```json [ { "id": 421950, "name": "books_parser", "description": "Parses all book titles on the page.", "prompt_text": null, "prompt_schema": null, "urls": [], "render": false, "parsing_instructions": { "titles": { "_fns": [ { "_args": [ "//h3//text()" ], "_fn": "xpath" } ] } }, "self_heal": false, "heal_status": "disabled", "last_healed_at": null, "created_at": "2025-10-27 11:46:59", "updated_at": "2025-10-27 11:46:59" }, { "id": 421947, "name": "my_new_parser", "description": "Extract text from all H4 elements on the page.", "prompt_text": null, "prompt_schema": null, "urls": [], "render": false, "parsing_instructions": { "titles": { "_fns": [ { "_args": [ "//h4/text()" ], "_fn": "xpath" } ] } }, "self_heal": false, "heal_status": "disabled", "last_healed_at": null, "created_at": "2025-10-27 11:40:22", "updated_at": "2025-10-27 11:45:20" } ] ```
### 查看统计 **端点：** `GET https://data.oxylabs.io/v1/parsers/presets/{preset_name}/stats`
输出 ```json { "total_results": 9, "successful_results": 9, "success_rate": 100, "success_rate_by_path": { "titles": 100 } } ```
你可以 **按日期和时间筛选结果** 使用 `date_from` 和/或 `date_to` URL 参数。使用格式 `YYYY-MM-DDTHH`，其中 `T` 表示时间， `HH` 是 24 小时制中的小时。 例如，要获取 2025 年 8 月 5 日上午 9 点到下午 2 点的统计信息： ```url https://data.oxylabs.io/v1/parsers/presets/{preset_name}/stats?date_from=2025-08-05T9&date_to=2025-08-05T14 ``` ### 跟踪自修复变更 **端点：** `GET https://data.oxylabs.io/v1/parsers/presets/{preset_name}/changelog` 我们的系统会自动记录自修复活动。你可以访问这份历史日志，查看自修复功能所做的所有修改。 --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://developers.oxylabs.io/products/cn/web-scraper-api/features/custom-parser/parser-presets.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.