Skip to content

Commit 437db17

Browse files
authored
Merge pull request #343 from desi003/update-agentql-page
Update AgentQL page
2 parents 6c919b0 + 45f7d67 commit 437db17

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

docs/tools/tool/agentql.mdx

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,7 @@ Create your own AgentQL API key [here](https://dev.agentql.com).
99

1010
## Description
1111

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.
1613

1714
## Installation
1815

@@ -30,15 +27,15 @@ AGENTQL_API_KEY=...
3027

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

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).
30+
| Argument | Type | Description |
31+
| :-------------------------- | :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
32+
| **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`.** |
4036

4137
## Examples
4238

4339
- [Research Assistant](https://github.com/AgentOps-AI/AgentStack/tree/main/examples/research_assistant)
4440
- [Sentiment Analyzer](https://github.com/AgentOps-AI/AgentStack/tree/main/examples/sentiment_analyser)
41+
- [Market Monitoring](https://github.com/AgentOps-AI/AgentStack/tree/main/examples/market_monitoring)

0 commit comments

Comments
 (0)