Sitemap
继承自WebBaseLoader，SitemapLoader从给定的URL加载站点地图，然后抓取并加载站点地图中的所有页面，将每个页面作为文档返回。
抓取是并发进行的。并发请求有合理的限制，默认每秒2次。如果你不关心是否是一个好公民，或者你控制被抓取的服务器，或者不关心负载，你可以增加这个限制。注意，虽然这会加快抓取过程，但可能会导致服务器屏蔽你。请小心！
概述
集成详情
| 类 | 包 | 本地 | 可序列化 | JS支持 |
|---|---|---|---|---|
| SiteMapLoader | langchain_community | ✅ | ❌ | ✅ |
加载器特性
| 来源 | 文档懒加载 | 原生异步支持 |
|---|---|---|
| SiteMapLoader | ✅ | ❌ |
设置
要访问SiteMap文档加载器，您需要安装langchain-community集成包。
凭证
运行此操作不需要凭据。
如果你想获得自动化的最佳模型调用跟踪，你也可以通过取消注释以下内容来设置你的LangSmith API密钥：
# os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")
# os.environ["LANGSMITH_TRACING"] = "true"
安装
安装 langchain_community。
%pip install -qU langchain-community
修复笔记本 asyncio 错误
import nest_asyncio
nest_asyncio.apply()
初始化
现在我们可以实例化我们的模型对象并加载文档：
from langchain_community.document_loaders.sitemap import SitemapLoader
sitemap_loader = SitemapLoader(web_path="https://api.python.langchain.com/sitemap.xml")
加载
docs = sitemap_loader.load()
docs[0]
Fetching pages: 100%|##########| 28/28 [00:04<00:00, 6.83it/s]
Document(metadata={'source': 'https://api.python.langchain.com/en/stable/', 'loc': 'https://api.python.langchain.com/en/stable/', 'lastmod': '2024-05-15T00:29:42.163001+00:00', 'changefreq': 'weekly', 'priority': '1'}, page_content='\n\n\n\n\n\n\n\n\n\nLangChain Python API Reference Documentation.\n\n\nYou will be automatically redirected to the new location of this page.\n\n')
print(docs[0].metadata)
{'source': 'https://api.python.langchain.com/en/stable/', 'loc': 'https://api.python.langchain.com/en/stable/', 'lastmod': '2024-05-15T00:29:42.163001+00:00', 'changefreq': 'weekly', 'priority': '1'}
你可以更改requests_per_second参数以增加最大并发请求数，并在发送请求时使用requests_kwargs传递kwargs。
sitemap_loader.requests_per_second = 2
# Optional: avoid `[SSL: CERTIFICATE_VERIFY_FAILED]` issue
sitemap_loader.requests_kwargs = {"verify": False}
懒加载
您还可以延迟加载页面，以最小化内存负载。
page = []
for doc in sitemap_loader.lazy_load():
page.append(doc)
if len(page) >= 10:
# do some paged operation, e.g.
# index.upsert(page)
page = []
Fetching pages: 100%|##########| 28/28 [00:01<00:00, 19.06it/s]
过滤站点地图URL
站点地图可能是包含数千个URL的大文件。通常你并不需要每一个URL。你可以通过向filter_urls参数传递字符串列表或正则表达式模式来过滤URL。只有匹配其中一个模式的URL才会被加载。
loader = SitemapLoader(
web_path="https://api.python.langchain.com/sitemap.xml",
filter_urls=["https://api.python.langchain.com/en/latest"],
)
documents = loader.load()
documents[0]
Document(page_content='\n\n\n\n\n\n\n\n\n\nLangChain Python API Reference Documentation.\n\n\nYou will be automatically redirected to the new location of this page.\n\n', metadata={'source': 'https://api.python.langchain.com/en/latest/', 'loc': 'https://api.python.langchain.com/en/latest/', 'lastmod': '2024-02-12T05:26:10.971077+00:00', 'changefreq': 'daily', 'priority': '0.9'})
添加自定义抓取规则
SitemapLoader 使用 beautifulsoup4 进行抓取过程，默认情况下它会抓取页面上的每个元素。SitemapLoader 构造函数接受一个自定义的抓取函数。这个功能可以帮助您根据特定需求定制抓取过程；例如，您可能希望避免抓取标题或导航元素。
以下示例展示了如何开发和使用自定义函数以避免导航和标题元素。
导入beautifulsoup4库并定义自定义函数。
pip install beautifulsoup4
from bs4 import BeautifulSoup
def remove_nav_and_header_elements(content: BeautifulSoup) -> str:
# Find all 'nav' and 'header' elements in the BeautifulSoup object
nav_elements = content.find_all("nav")
header_elements = content.find_all("header")
# Remove each 'nav' and 'header' element from the BeautifulSoup object
for element in nav_elements + header_elements:
element.decompose()
return str(content.get_text())
将您的自定义函数添加到SitemapLoader对象中。
loader = SitemapLoader(
"https://api.python.langchain.com/sitemap.xml",
filter_urls=["https://api.python.langchain.com/en/latest/"],
parsing_function=remove_nav_and_header_elements,
)
本地站点地图
站点地图加载器也可以用于加载本地文件。
sitemap_loader = SitemapLoader(web_path="example_data/sitemap.xml", is_local=True)
docs = sitemap_loader.load()
API 参考
有关所有SiteMapLoader功能和配置的详细文档，请访问API参考：https://python.langchain.com/api_reference/community/document_loaders/langchain_community.document_loaders.sitemap.SitemapLoader.html#langchain_community.document_loaders.sitemap.SitemapLoader