ReadTheDocsLoader

class langchain_community.document_loaders.readthedocs.ReadTheDocsLoader(path: str | Path, encoding: str | None = None, errors: str | None = None, custom_html_tag: Tuple[str, dict] | None = None, patterns: Sequence[str] = ('*.htm', '*.html'), exclude_links_ratio: float = 1.0, **kwargs: Any | None)

加载 ReadTheDocs 文档目录。

初始化 ReadTheDocsLoader

加载器循环遍历path下的所有文件，并通过检索主要的html标签提取文件的实际内容。默认的主要html标签包括

、<div role=”main>和

。您还可以通过传递custom_html_tag来定义自己的html标签，例如(“div”, “class=main”)。加载器按照自定义html标签（如果存在）和默认html标签的顺序迭代html标签。如果任何一个标签不为空，循环将中断并从该标签中提取内容。

Parameters:

• path (Union[str, Path]) – 拉取的readthedocs文件夹的位置。

• encoding (可选[str]) – 用于打开文档的编码。

• errors (可选[str]) – 指定如何处理编码和解码错误——这不能在二进制模式下使用。

• custom_html_tag (可选[Tuple[str, dict]]) – 可选的自定义HTML标签，用于从文件中检索内容。

• patterns (Sequence[str]) – 要加载的文件模式，传递给 glob.rglob。

• exclude_links_ratio (float) – 用于排除页面的链接与内容的比例。 这是为了减少索引页面进入检索结果的频率。推荐值：0.5

• kwargs (可选[任意]) – 传递给 bs4.BeautifulSoup 的命名参数。

方法

__init__(path[, encoding, errors, ...])	初始化 ReadTheDocsLoader
alazy_load()	文档的懒加载器。
aload()	将数据加载到Document对象中。
lazy_load()	一个用于文档的懒加载器。
load()	将数据加载到Document对象中。
load_and_split([text_splitter])	加载文档并将其分割成块。

__init__(path: str | Path, encoding: str | None = None, errors: str | None = None, custom_html_tag: Tuple[str, dict] | None = None, patterns: Sequence[str] = ('*.htm', '*.html'), exclude_links_ratio: float = 1.0, **kwargs: Any | None)

初始化 ReadTheDocsLoader

加载器循环遍历path下的所有文件，并通过检索主要的html标签提取文件的实际内容。默认的主要html标签包括

、<div role=”main>和

。您还可以通过传递custom_html_tag来定义自己的html标签，例如(“div”, “class=main”)。加载器按照自定义html标签（如果存在）和默认html标签的顺序迭代html标签。如果任何一个标签不为空，循环将中断并从该标签中提取内容。

Parameters:

• path (str | Path) – 拉取的readthedocs文件夹的位置。

• encoding (str | None) – 用于打开文档的编码。

• errors (str | None) – 指定如何处理编码和解码错误——这不能在二进制模式下使用。

• custom_html_tag (Tuple[str, dict] | None) – 可选的自定义HTML标签，用于从文件中检索内容。

• patterns (Sequence[str]) – 要加载的文件模式，传递给 glob.rglob。

• exclude_links_ratio (float) – 用于排除页面的链接与内容的比例。 这是为了减少索引页面进入检索结果的频率。推荐值：0.5

• kwargs (Any | None) – 传递给 bs4.BeautifulSoup 的命名参数。

async alazy_load() → AsyncIterator[Document]

文档的懒加载器。

Return type:

AsyncIterator[Document]

async aload() → list[Document]

将数据加载到Document对象中。

Return type:

列表[Document]

lazy_load() → Iterator[Document]

文档的懒加载器。

Return type:

迭代器[文档]

load() → list[Document]

将数据加载到Document对象中。

Return type:

列表[Document]

load_and_split(text_splitter: TextSplitter | None = None) → list[Document]

加载文档并将其分割成块。块以文档形式返回。

不要重写此方法。它应该被视为已弃用！

Parameters:

text_splitter (可选[TextSplitter]) – 用于分割文档的TextSplitter实例。 默认为RecursiveCharacterTextSplitter。

Returns:

文档列表。

Return type:

列表[Document]

使用 ReadTheDocsLoader 的示例

• ReadTheDocs 文档