> ## Documentation Index
> Fetch the complete documentation index at: https://cndoc-langchain.site/llms.txt
> Use this file to discover all available pages before exploring further.

# AgentQLLoader 集成

> 使用 LangChain Python 与 AgentQLLoader 文档加载器集成。

[AgentQL](https://www.agentql.com/) 的文档加载器使用 [AgentQL 查询](https://docs.agentql.com/agentql-query) 从任何网页提取结构化数据。AgentQL 可以跨多种语言和网页使用，不会因时间和变化而失效。

## 概述

`AgentQLLoader` 需要以下两个参数：

* `url`：您想要从中提取数据的网页的 URL。
* `query`：要执行的 AgentQL 查询。在[文档](https://docs.agentql.com/agentql-query)中了解更多关于[如何编写 AgentQL 查询](https://docs.agentql.com/agentql-query)的信息，或在 [AgentQL Playground](https://dev.agentql.com/playground) 中测试一个。

以下参数是可选的：

* `api_key`：您从 [dev.agentql.com](https://dev.agentql.com) 获取的 AgentQL API 密钥。**`可选`。**
* `timeout`：请求超时前的等待秒数。**默认为 `900`。**
* `is_stealth_mode_enabled`：是否启用实验性的反机器人规避策略。此功能可能并非对所有网站都始终有效。启用此模式后，数据提取可能需要更长时间才能完成。**默认为 `False`。**
* `wait_for`：在提取数据前等待页面加载的秒数。**默认为 `0`。**
* `is_scroll_to_bottom_enabled`：是否在提取数据前滚动到页面底部。**默认为 `False`。**
* `mode`：`"standard"` 使用深度数据分析，而 `"fast"` 以牺牲部分分析深度换取速度，对于大多数用例来说已经足够。[在此指南中了解更多关于模式的信息。](https://docs.agentql.com/accuracy/standard-mode) **默认为 `"fast"`。**
* `is_screenshot_enabled`：是否在提取数据前截取屏幕截图。以 Base64 字符串形式在 'metadata' 中返回。**默认为 `False`。**

AgentQLLoader 是使用 AgentQL 的 [REST API](https://docs.agentql.com/rest-api/api-reference) 实现的。

### 集成详情

| 类               | 包                 |  本地 | 可序列化 | JS 支持 |
| :-------------- | :---------------- | :-: | :--: | :---: |
| `AgentQLLoader` | langchain-agentql |  ✅  |   ❌  |   ❌   |

### 加载器特性

|        来源       | 文档延迟加载 | 原生异步支持 |
| :-------------: | :----: | :----: |
| `AgentQLLoader` |    ✅   |    ❌   |

## 设置

要使用 AgentQL 文档加载器，您需要配置 `AGENTQL_API_KEY` 环境变量，或使用 `api_key` 参数。您可以从我们的 [Dev Portal](https://dev.agentql.com) 获取 API 密钥。

### 安装

安装 **langchain-agentql**。

```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
pip install -qU langchain-agentql
```

### 设置凭证

```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
import os

os.environ["AGENTQL_API_KEY"] = "YOUR_AGENTQL_API_KEY"
```

## 初始化

接下来实例化您的模型对象：

```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
from langchain_agentql.document_loaders import AgentQLLoader

loader = AgentQLLoader(
    url="https://www.agentql.com/blog",
    query="""
    {
        posts[] {
            title
            url
            date
            author
        }
    }
    """,
    is_scroll_to_bottom_enabled=True,
)
```

## 加载

```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
docs = loader.load()
docs[0]
```

```text theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
Document(metadata={'request_id': 'bdb9dbe7-8a7f-427f-bc16-839ccc02cae6', 'generated_query': None, 'screenshot': None}, page_content="{'posts': [{'title': 'Launch Week Recap—make the web AI-ready', 'url': 'https://www.agentql.com/blog/2024-launch-week-recap', 'date': 'Nov 18, 2024', 'author': 'Rachel-Lee Nabors'}, {'title': 'Accurate data extraction from PDFs and images with AgentQL', 'url': 'https://www.agentql.com/blog/accurate-data-extraction-pdfs-images', 'date': 'Feb 1, 2025', 'author': 'Rachel-Lee Nabors'}, {'title': 'Introducing Scheduled Scraping Workflows', 'url': 'https://www.agentql.com/blog/scheduling', 'date': 'Dec 2, 2024', 'author': 'Rachel-Lee Nabors'}, {'title': 'Updates to Our Pricing Model', 'url': 'https://www.agentql.com/blog/2024-pricing-update', 'date': 'Nov 19, 2024', 'author': 'Rachel-Lee Nabors'}, {'title': 'Get data from any page: AgentQL’s REST API Endpoint—Launch week day 5', 'url': 'https://www.agentql.com/blog/data-rest-api', 'date': 'Nov 15, 2024', 'author': 'Rachel-Lee Nabors'}]}")
```

```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
print(docs[0].metadata)
```

```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
{'request_id': 'bdb9dbe7-8a7f-427f-bc16-839ccc02cae6', 'generated_query': None, 'screenshot': None}
```

## 延迟加载

`AgentQLLoader` 目前一次只加载一个 [`Document`](https://reference.langchain.com/python/langchain-core/documents/base/Document)。因此，`load()` 和 `lazy_load()` 的行为相同：

```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
pages = [doc for doc in loader.lazy_load()]
pages
```

```text theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
[Document(metadata={'request_id': '06273abd-b2ef-4e15-b0ec-901cba7b4825', 'generated_query': None, 'screenshot': None}, page_content="{'posts': [{'title': 'Launch Week Recap—make the web AI-ready', 'url': 'https://www.agentql.com/blog/2024-launch-week-recap', 'date': 'Nov 18, 2024', 'author': 'Rachel-Lee Nabors'}, {'title': 'Accurate data extraction from PDFs and images with AgentQL', 'url': 'https://www.agentql.com/blog/accurate-data-extraction-pdfs-images', 'date': 'Feb 1, 2025', 'author': 'Rachel-Lee Nabors'}, {'title': 'Introducing Scheduled Scraping Workflows', 'url': 'https://www.agentql.com/blog/scheduling', 'date': 'Dec 2, 2024', 'author': 'Rachel-Lee Nabors'}, {'title': 'Updates to Our Pricing Model', 'url': 'https://www.agentql.com/blog/2024-pricing-update', 'date': 'Nov 19, 2024', 'author': 'Rachel-Lee Nabors'}, {'title': 'Get data from any page: AgentQL’s REST API Endpoint—Launch week day 5', 'url': 'https://www.agentql.com/blog/data-rest-api', 'date': 'Nov 15, 2024', 'author': 'Rachel-Lee Nabors'}]}")]
```

***

## API 参考

有关如何使用此集成的更多信息，请参阅 [git 仓库](https://github.com/tinyfish-io/agentql-integrations/tree/main/langchain) 或 [langchain 集成文档](https://docs.agentql.com/integrations/langchain)。

***

<div className="source-links">
  <Callout icon="terminal-2">
    [将这些文档](/use-these-docs)通过 MCP 连接到 Claude、VSCode 等，以获取实时答案。
  </Callout>

  <Callout icon="edit">
    [在 GitHub 上编辑此页面](https://github.com/langchain-ai/docs/edit/main/src/oss/python/integrations/document_loaders/agentql.mdx) 或 [提交问题](https://github.com/langchain-ai/docs/issues/new/choose)。
  </Callout>
</div>