Github文件加载器

class langchain_community.document_loaders.github.GithubFileLoader

基础类：BaseGitHubLoader, ABC

加载 GitHub 文件

通过解析和验证来自关键字参数的输入数据来创建一个新模型。

如果输入数据无法验证以形成有效模型，则引发 [ValidationError][pydantic_core.ValidationError]。

self 被显式地设为仅位置参数，以允许 self 作为字段名称。

param access_token: str [Required]

个人访问令牌 - 参见 settings/tokens

param branch: str = 'main'

param file_filter: Callable[[str], bool] | None [Required]

param github_api_url: str = 'https://api.github.com'

GitHub API的URL

param repo: str [Required]

仓库名称

async alazy_load() → AsyncIterator[Document]

文档的懒加载器。

Return type:

AsyncIterator[Document]

async aload() → list[Document]

将数据加载到Document对象中。

Return type:

列表[Document]

get_file_content_by_path(path: str) → str

Parameters:

路径 (字符串)

Return type:

字符串

get_file_paths() → List[Dict]

Return type:

列表[字典]

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]

property headers: Dict[str, str]

使用 GithubFileLoader 的示例

• GitHub