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
+17-11Lines changed: 17 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,22 +4,23 @@ description: Precise web data extraction for agents
4
4
icon: browser
5
5
---
6
6
7
-
AgentQL Web Loader is a tool that Scrape a url with a given AgentQL query or a natural language description of the data you want to scrape.
7
+
AgentQL Web Loader is a tool that scrapes a URL with a given AgentQL query or a Natural Language description of the data you want to scrape.
8
8
Create your own AgentQL API key [here](https://dev.agentql.com).
9
9
10
10
## Description
11
-
AgentQL Web Loader is powered by AgentQL, an AI-powered query language for scraping web sites and automating workflows.
12
-
If you want to extract data in a precise format, use AgentQL natural language queries under the `query` field to pinpoint data on any web page, including authenticated and dynamically generated content.
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.
13
14
Users can define structured data output and apply transforms within queries.
14
-
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.
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.
15
16
16
17
## Installation
17
18
18
19
```bash
19
20
agentstack tools add agentql
20
21
```
21
22
22
-
Set the environment variable
23
+
Set the environment variable in your project's `.env` file.
23
24
24
25
```env
25
26
AGENTQL_API_KEY=...
@@ -29,10 +30,15 @@ AGENTQL_API_KEY=...
29
30
30
31
The following parameters can be used to customize the `AgentQL Web Loader`'s behavior:
|**url**|`string`| Url of the website to scrape from. |
35
-
|**query**|`string`|_Optional_. AgentQL query to scrape the url. Please visit [AgentQL Query Language Introduction](https://docs.agentql.com/agentql-query) for more information. |
36
-
|**prompt**|`string`|_Optional_. Natural language description of the data you want to scrape. Either `query` or `prompt` is required. |
|**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).
40
+
41
+
## Examples
37
42
38
-
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).
0 commit comments