GitHub问题加载器

class langchain_community.document_loaders.github.GitHubIssuesLoader

基础类：BaseGitHubLoader

加载GitHub仓库的问题。

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

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

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

param access_token: str [Required]

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

param assignee: str | None = None

按分配的用户进行筛选。传递‘none’表示没有用户，传递‘*’表示任何用户。

param creator: str | None = None

过滤创建问题的用户。

param direction: Literal['asc', 'desc'] | None = None

用于排序结果的方向。可以是以下之一：‘asc’, ‘desc’。

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

GitHub API的URL

param include_prs: bool = True

如果为True，则在结果中包含拉取请求，否则忽略它们。

param labels: List[str] | None = None

用于过滤的标签名称。示例：bug,ui,@high。

param mentioned: str | None = None

筛选问题中提到的用户。

param milestone: int | Literal['*', 'none'] | None = None

如果传递的是整数，它应该是里程碑的编号字段。 如果传递的是字符串‘*’，则接受任何里程碑的问题。 如果传递的是字符串‘none’，则返回没有里程碑的问题。

param page: int | None = None

分页结果的页码。 在GitHub API中默认为1。

param per_page: int | None = None

每页的项目数量。 在GitHub API中默认为30。

param repo: str [Required]

仓库名称

param since: str | None = None

仅显示在给定时间之后更新的通知。 这是一个ISO 8601格式的时间戳：YYYY-MM-DDTHH:MM:SSZ。

param sort: Literal['created', 'updated', 'comments'] | None = None

按什么排序结果。可以是以下之一：‘created’, ‘updated’, ‘comments’。默认是‘created’。

param state: Literal['open', 'closed', 'all'] | None = None

根据问题状态进行筛选。可以是以下之一：'open'（打开）、'closed'（关闭）、'all'（全部）。

async alazy_load() → AsyncIterator[Document]

文档的懒加载器。

Return type:

AsyncIterator[Document]

async aload() → list[Document]

将数据加载到Document对象中。

Return type:

列表[Document]

lazy_load() → Iterator[Document]

获取GitHub仓库的问题。

Returns:

• 页面内容

• 元数据

  • 网址

  • 标题

  • 创建者

  • 创建时间

  • 最后更新时间

  • 关闭时间

  • 评论数量

  • 状态

  • 标签

  • 负责人

  • 负责人列表

  • 里程碑

  • 锁定状态

  • 编号

  • 是否为拉取请求

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]

parse_issue(issue: dict) → Document

从GitHub问题列表中创建文档对象。

Parameters:

问题 (字典)

Return type:

Document

property headers: Dict[str, str]

property query_params: str

为GitHub API创建查询参数。

property url: str

创建GitHub API的URL。

使用 GitHubIssuesLoader 的示例

• GitHub