forked from Archives/langchain
Harrison/site map (#2061)
Co-authored-by: Tim Asp <707699+timothyasp@users.noreply.github.com>searx
parent
8b5a43d720
commit
a0cd6672aa
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -0,0 +1,69 @@
|
|||||||
|
"""Loader that fetches a sitemap and loads those URLs."""
|
||||||
|
import re
|
||||||
|
from typing import Any, List, Optional
|
||||||
|
|
||||||
|
from langchain.document_loaders.web_base import WebBaseLoader
|
||||||
|
from langchain.schema import Document
|
||||||
|
|
||||||
|
|
||||||
|
class SitemapLoader(WebBaseLoader):
|
||||||
|
"""Loader that fetches a sitemap and loads those URLs."""
|
||||||
|
|
||||||
|
def __init__(self, web_path: str, filter_urls: Optional[List[str]] = None):
|
||||||
|
"""Initialize with webpage path and optional filter URLs.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
web_path: url of the sitemap
|
||||||
|
filter_urls: list of strings or regexes that will be applied to filter the
|
||||||
|
urls that are parsed and loaded
|
||||||
|
"""
|
||||||
|
|
||||||
|
try:
|
||||||
|
import lxml # noqa:F401
|
||||||
|
except ImportError:
|
||||||
|
raise ValueError(
|
||||||
|
"lxml package not found, please install it with " "`pip install lxml`"
|
||||||
|
)
|
||||||
|
|
||||||
|
super().__init__(web_path)
|
||||||
|
|
||||||
|
self.filter_urls = filter_urls
|
||||||
|
|
||||||
|
def parse_sitemap(self, soup: Any) -> List[dict]:
|
||||||
|
"""Parse sitemap xml and load into a list of dicts."""
|
||||||
|
els = []
|
||||||
|
for url in soup.find_all("url"):
|
||||||
|
loc = url.find("loc")
|
||||||
|
if not loc:
|
||||||
|
continue
|
||||||
|
|
||||||
|
if self.filter_urls and not any(
|
||||||
|
re.match(r, loc.text) for r in self.filter_urls
|
||||||
|
):
|
||||||
|
continue
|
||||||
|
|
||||||
|
els.append(
|
||||||
|
{
|
||||||
|
tag: prop.text
|
||||||
|
for tag in ["loc", "lastmod", "changefreq", "priority"]
|
||||||
|
if (prop := url.find(tag))
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
return els
|
||||||
|
|
||||||
|
def load(self) -> List[Document]:
|
||||||
|
"""Load sitemap."""
|
||||||
|
soup = self.scrape("xml")
|
||||||
|
|
||||||
|
els = self.parse_sitemap(soup)
|
||||||
|
|
||||||
|
results = self.scrape_all([el["loc"] for el in els if "loc" in el])
|
||||||
|
|
||||||
|
return [
|
||||||
|
Document(
|
||||||
|
page_content=str(results[i].get_text()),
|
||||||
|
metadata={**{"source": els[i]["loc"]}, **els[i]},
|
||||||
|
)
|
||||||
|
for i in range(len(results))
|
||||||
|
]
|
@ -0,0 +1,20 @@
|
|||||||
|
from langchain.document_loaders import SitemapLoader
|
||||||
|
|
||||||
|
|
||||||
|
def test_sitemap() -> None:
|
||||||
|
"""Test sitemap loader."""
|
||||||
|
loader = SitemapLoader("https://langchain.readthedocs.io/sitemap.xml")
|
||||||
|
documents = loader.load()
|
||||||
|
assert len(documents) > 1
|
||||||
|
assert "🦜🔗" in documents[0].page_content
|
||||||
|
|
||||||
|
|
||||||
|
def test_filter_sitemap() -> None:
|
||||||
|
"""Test sitemap loader."""
|
||||||
|
loader = SitemapLoader(
|
||||||
|
"https://langchain.readthedocs.io/sitemap.xml",
|
||||||
|
filter_urls=["https://langchain.readthedocs.io/en/stable/"],
|
||||||
|
)
|
||||||
|
documents = loader.load()
|
||||||
|
assert len(documents) == 1
|
||||||
|
assert "🦜🔗" in documents[0].page_content
|
Loading…
Reference in New Issue