You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tools/tool/agentql.mdx
+8-11Lines changed: 8 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,10 +9,7 @@ Create your own AgentQL API key [here](https://dev.agentql.com).
9
9
10
10
## Description
11
11
12
-
AgentQL Web Loader is powered by AgentQL, an AI-powered query language for scraping web sites and automating workflows.
13
-
If you want to extract data in a precise format, use [AgentQL query language](https://docs.agentql.com/agentql-query) under the `query` field to pinpoint data on any web page, including authenticated and dynamically generated content.
14
-
Users can define structured data output and apply transforms within queries.
15
-
You could also directly describe the data you want to extract under the `prompt` field to let AgentQL Web Loader automatically generate the format and data.
12
+
[AgentQL](https://agentql.com) provides structured data extraction from any web page using an [AgentQL query](https://docs.agentql.com/concepts/query-language) or a Natural Language prompt. AgentQL can be used across multiple languages and web pages without breaking over time and change.
16
13
17
14
## Installation
18
15
@@ -30,15 +27,15 @@ AGENTQL_API_KEY=...
30
27
31
28
The following parameters can be used to customize the `AgentQL Web Loader`'s behavior:
|**url**|`string`| URL of the website to scrape from. |
36
-
|**query**|`string`|_Optional_. AgentQL query to scrape the URL. Please visit [AgentQL Query Language Introduction](https://docs.agentql.com/agentql-query) for more information. |
37
-
|**prompt**|`string`|_Optional_. Natural Language description of the data you want to scrape. Either `query` or `prompt` is required. |
38
-
39
-
If you want to hack our tool, feel free to do so by modifying `src/tools/agentql_tool.py` and reference our documentation for [AgentQL REST API](https://docs.agentql.com/rest-api/api-reference).
|**url**|`string`| The URL of the web page you want to query. |
33
+
|**query**|`string`|_Optional_. The AgentQL query to execute. Learn more about [how to write an AgentQL query in the docs](https://docs.agentql.com/agentql-query). |
34
+
|**prompt**|`string`|_Optional_. A Natural Language description of the data to query the page for. AgentQL will infer the data’s structure from your prompt. **Note: You must define either a `query` or a `prompt` to use AgentQL.**|
35
+
|**is_stealth_mode_enabled**|`boolean`| Whether to enable experimental anti-bot evasion strategies. This feature may not work for all websites at all times. Data extraction may take longer to complete with this mode enabled. **Defaults to `False`.**|
0 commit comments