langchain_community.document_loaders.github
.GitHubIssuesLoader¶
- class langchain_community.document_loaders.github.GitHubIssuesLoader[源代码]¶
基类:
BaseGitHubLoader
加载GitHub仓库的问题。
通过解析和验证从关键字参数中输入的数据来创建一个新的模型。
如果输入数据无法解析成有效的模型,则抛出ValidationError异常。
- 参数 access_token: str [必需]¶
个人访问令牌 - 请参考 https://github.com/settings/tokens?type=beta
- 参数 assignee: Optional[str] = None¶
按指派的用户进行筛选。传递‘none’以跳过用户,传递‘*’以选择任何用户。
- 参数 creator: Optional[str] = None¶
按创建问题的用户进行筛选。
- 参数 direction: Optional[Literal['asc', 'desc']] = None¶
排序结果的方向。可以是以下之一:‘asc’,‘desc’。
- 参数 github_api_url: str = 'https://api.github.com'¶
GitHub API的URL
- 参数 include_prs: bool = True¶
如果为True,则在结果中包含拉取请求,否则忽略它们。
- 参数 labels: 可选[List[str]] = None¶
用于筛选标签的标签名称。例如:bug、ui、@high。
- 参数 mentioned: 可选[str] = None¶
根据在问题中被提及的用户的筛选。
- 参数 milestone: 可选[Union[int, Literal['*', 'none']] = None¶
如果传入整数,则应为其里程碑的编号字段。如果传入字符串‘*’,则接受任何里程碑的问题。如果传入字符串‘none’,则返回没有里程碑的问题。
- 参数 page: 可选[int] = None¶
分页结果的页码。默认为GitHub API中的1。
- 参数 per_page: 可选[int] = None¶
每页的项目数量。在GitHub API中默认为30。
- 参数 repo: str [必选]¶
仓库名称
- param since: Optional[str] = None¶
仅显示给定时间之后的更新通知。这是一个ISO 8601格式的时间戳:YYYY-MM-DDTHH:MM:SSZ。
- param sort: Optional[Literal['created', 'updated', 'comments']] = None¶
如何排序结果。可以是以下之一:‘created’、‘updated’、‘comments’。默认是‘created’。
- param state: Optional[Literal['open', 'closed', 'all']] = None¶
按问题状态进行筛选。可以是以下之一:‘open’、‘closed’、‘all’。
- lazy_load() Iterator[Document] [source]¶
获取GitHub仓库的问题。
- 返回
page_content
- metadata
url
title
creator
created_at
last_update_time
closed_time
评论数
状态
标签
assignee
assignees
里程碑
锁定
编号
是否为pull请求
- 返回类型
具有属性的对象的Document列表
- load_and_split(text_splitter: Optional[TextSplitter] = None) List[Document] ¶
加载文档并将它们分割成块。块作为Document返回。
请不要重写此方法。应考虑将其弃用!
- 参数
text_splitter (Optional[TextSplitter]) – 用于分割文档的TextSplitter实例。默认为RecursiveCharacterTextSplitter。
- 返回
文档列表。
- 返回类型
List[Document]
- 属性 headers: Dict[str, str]¶
- 属性 query_params: str¶
为GitHub API创建查询参数。
- 属性 url: str¶
为GitHub API创建URL。