# LlamaIndex

与以下内容的 LlamaIndex 集成： [**Oxylabs 网页爬虫API**](https://oxylabs.io/products/scraper-api/web) 让你能够通过 LLM（大型语言模型）在同一工作流中抓取和处理网页数据。

## 概述

[**LlamaIndex**](https://docs.llamaindex.ai/en/stable/examples/data_connectors/OxylabsDemo/) 是一个数据框架，旨在利用外部数据源构建 LLM 应用。将其与 [**Oxylabs 网页爬虫API**](https://oxylabs.io/products/scraper-api/web) 结合使用，以：

* 在不处理验证码、IP 封锁或 JS 渲染的情况下抓取结构化数据
* 在同一流水线中使用 LLM 处理结果
* 构建从提取到 AI 驱动输出的端到端工作流

## 快速开始

**创建你的 API 用户凭据：** 在中注册免费试用或购买产品 [**Oxylabs 控制面板**](https://dashboard.oxylabs.io/en/registration) 以创建你的 API 用户凭据（`用户名` 并 `PASSWORD`).

{% hint style="info" %}
如果你的账户需要一个以上的 API 用户，请联系我们的客服或通过我们的 24/7 在线聊天支持发送消息。
{% endhint %}

### 环境设置

在本指南中，我们将使用 Python 编程语言。使用 pip 安装所需库：

```
pip install -qU llama-index llama-index-readers-oxylabs llama-index-readers-web
```

创建一个 `.env` 文件，放在你的项目目录中，包含你的 Oxylabs 网页爬虫API 凭据和 OpenAI API 密钥：

```
OXYLABS_USERNAME=your_API_username
OXYLABS_PASSWORD=your_API_password
OPENAI_API_KEY=your-openai-key
```

在你的 Python 脚本中加载这些环境变量：

```python
import os
from dotenv import load_dotenv

load_dotenv()
```

## 集成方法

在 LlamaIndex 中通过 网页爬虫API 访问网页内容有两种方式：

### Oxylabs Reader

“ `llama-index-readers-oxylabs` 模块包含特定类，可让你从各种来源抓取数据：

| API 数据源     | Reader 类                       |
| ----------- | ------------------------------ |
| Google 网页搜索 | OxylabsGoogleSearchReader      |
| Google 搜索广告 | OxylabsGoogleAdsReader         |
| Amazon 商品   | OxylabsAmazonProductReader     |
| Amazon 搜索   | OxylabsAmazonSearchReader      |
| Amazon 评论   | OxylabsAmazonReviewsReader     |
| YouTube 文字稿 | OxylabsYoutubeTranscriptReader |

例如，你可以提取 Google 搜索结果：

```python
import os
from dotenv import load_dotenv
from llama_index.readers.oxylabs import OxylabsGoogleSearchReader

load_dotenv()
reader = OxylabsGoogleSearchReader(
    os.getenv('OXYLABS_USERNAME'), os.getenv('OXYLABS_PASSWORD')
)
results = reader.load_data({
    'query': 'best pancake recipe',
    'parse': True
})
print(results[0].text)
```

### Oxylabs Web Reader

使用 `OxylabsWebReader` 类，你可以从任意 URL 提取数据：

```python
import os
from dotenv import load_dotenv
from llama_index.readers.web import OxylabsWebReader

load_dotenv()
reader = OxylabsWebReader(
    os.getenv('OXYLABS_USERNAME'), os.getenv('OXYLABS_PASSWORD')
)
results = reader.load_data(
    [
        'https://sandbox.oxylabs.io/products/1',
        'https://sandbox.oxylabs.io/products/2'
    ]
)
for result in results:
    print(result.text + '\n')
```

## 构建一个基础 AI 搜索代理

下面是一个简单 AI 代理的示例，它可以搜索 Google 并回答问题：

```python
import os
import asyncio
from dotenv import load_dotenv
from llama_index.readers.oxylabs import OxylabsGoogleSearchReader
from llama_index.core.agent.workflow import FunctionAgent
from llama_index.llms.openai import OpenAI

load_dotenv()
reader = OxylabsGoogleSearchReader(
    os.getenv('OXYLABS_USERNAME'), os.getenv('OXYLABS_PASSWORD')
)

def web_search(query: str) -> str:
    results = reader.load_data({'query': query, 'parse': True})
    return results[0].text

agent = FunctionAgent(
    tools=[web_search],
    llm=OpenAI(model='gpt-4o-mini'),
    max_function_calls=1,
    system_prompt=(
        'Craft a short Google search query to use with the `web_search` tool. '
        'Analyze the most relevant results and answer the question.'
    )
)

async def main():
    response = await agent.run('How did DeepSeek affect the stock market?')
    print(response)

if __name__ == '__main__':
    asyncio.run(main())
```

## 高级配置

### 处理动态内容

网页爬虫API 可以处理 JavaScript 渲染：

```python
reader = OxylabsWebReader(
    os.getenv('OXYLABS_USERNAME'), os.getenv('OXYLABS_PASSWORD')
)

results = reader.load_data(
    [
        'https://quotes.toscrape.com/js/'
    ],
    {'render': 'html'}
)
```

### 设置 user agent 类型

你可以指定不同的 user agent：

```python
reader = OxylabsWebReader(
    os.getenv('OXYLABS_USERNAME'), os.getenv('OXYLABS_PASSWORD')
)

results = reader.load_data(
    [
        'https://sandbox.oxylabs.io/products/1'
    ],
    {'user_agent_type': 'mobile'}
)
```

### 使用目标特定参数

许多目标特定的爬虫支持额外参数：

```python
reader = OxylabsGoogleSearchReader(
    os.getenv('OXYLABS_USERNAME'),
    os.getenv('OXYLABS_PASSWORD')
)
results = reader.load_data({
    'query': 'iphone',
    'parse': True,
    'domain': 'com',
    'start_page': 2,
    'pages': 3
})
```

## 创建向量索引

LlamaIndex 尤其适合从网页内容构建向量索引：

```python
import os
from dotenv import load_dotenv
from llama_index.readers.web import OxylabsWebReader
from llama_index.core import Settings, VectorStoreIndex
from llama_index.llms.openai import OpenAI

load_dotenv()
reader = OxylabsWebReader(
    os.getenv('OXYLABS_USERNAME'), os.getenv('OXYLABS_PASSWORD')
)
documents = reader.load_data([
    'https://sandbox.oxylabs.io/products/1',
    'https://sandbox.oxylabs.io/products/2'
])

# 配置 LlamaIndex 设置
Settings.llm = OpenAI(model='gpt-4o-mini')

# 创建索引
index = VectorStoreIndex.from_documents(documents)

# 查询索引
query_engine = index.as_query_engine()
response = query_engine.query('这些页面的主要主题是什么？')
print(response)
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.oxylabs.io/integrations/cn/wang-ye-pa-chong-api-ji-cheng/llamaindex.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.