Skip to content

Commit a019d26

Browse files
authored
Merge pull request #341 from desi003/update-agentql-page
Update Agentql page
2 parents 04e62b7 + 2501e81 commit a019d26

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

docs/tools/tool/agentql.mdx

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,23 @@ description: Precise web data extraction for agents
44
icon: browser
55
---
66

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.
88
Create your own AgentQL API key [here](https://dev.agentql.com).
99

1010
## 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.
1314
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.
1516

1617
## Installation
1718

1819
```bash
1920
agentstack tools add agentql
2021
```
2122

22-
Set the environment variable
23+
Set the environment variable in your project's `.env` file.
2324

2425
```env
2526
AGENTQL_API_KEY=...
@@ -29,10 +30,15 @@ AGENTQL_API_KEY=...
2930

3031
The following parameters can be used to customize the `AgentQL Web Loader`'s behavior:
3132

32-
| Argument | Type | Description |
33-
|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------------------------------|
34-
| **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. |
33+
| Argument | Type | Description |
34+
| :--------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
35+
| **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
3742

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).
43+
- [Research Assistant](https://github.com/AgentOps-AI/AgentStack/tree/main/examples/research_assistant)
44+
- [Sentiment Analyzer](https://github.com/AgentOps-AI/AgentStack/tree/main/examples/sentiment_analyser)

0 commit comments

Comments
 (0)