GitLoader#

class langchain_community.document_loaders.git.GitLoader(repo_path: str, clone_url: str | None = None, branch: str | None = 'main', file_filter: Callable[[str], bool] | None = None)[源代码]#

加载 Git 仓库文件。

仓库可以是本地磁盘上的，位于repo_path，也可以是远程的，位于clone_url，它将被克隆到repo_path。目前仅支持文本文件。

每个文档代表存储库中的一个文件。path指向本地Git存储库，branch指定从中加载文件的分支。默认情况下，它从main分支加载。

Parameters:

repo_path (str) – Git仓库的路径。
clone_url (str | None) – 可选。用于克隆仓库的URL。
branch (str | None) – 可选。加载文件的分支。默认为 main。
file_filter (Callable[[str], bool] | None) – 可选。一个函数，接受文件路径并返回一个布尔值，指示是否加载该文件。默认为 None。

方法

`__init__`(repo_path[, clone_url, branch, ...])
`alazy_load`()	一个用于文档的懒加载器。
`aload`()	将数据加载到Document对象中。
`lazy_load`()	一个用于文档的懒加载器。
`load`()	将数据加载到Document对象中。
`load_and_split`([text_splitter])	加载文档并将其分割成块。

__init__(repo_path: str, clone_url: str | None = None, branch: str | None = 'main', file_filter: Callable[[str], bool] | None = None)[源代码]#

Parameters:

repo_path (str) – Git仓库的路径。
clone_url (str | None) – 可选。用于克隆仓库的URL。
branch (str | None) – 可选。加载文件的分支。默认为 main。
file_filter (Callable[[str], bool] | None) – 可选。一个函数，接受文件路径并返回一个布尔值，指示是否加载该文件。默认为 None。

async alazy_load() → AsyncIterator[Document]#

文档的懒加载器。

Return type:: AsyncIterator[Document]

async aload() → list[Document]#

将数据加载到Document对象中。

Return type:: 列表[Document]

lazy_load() → Iterator[Document][source]#

文档的懒加载器。

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]

使用 GitLoader 的示例

Git