Skip to main content
本 notebook 展示了如何加载 GitHub 上指定仓库的 Issues 和 Pull Requests(PR),同时也展示了如何加载指定仓库的 GitHub 文件。我们将以 LangChain Python 仓库为例进行说明。

配置访问令牌

要访问 GitHub API,您需要一个个人访问令牌(Personal Access Token),可在此处创建:github.com/settings/tokens?type=beta。您可以将此令牌设置为环境变量 GITHUB_PERSONAL_ACCESS_TOKEN,系统会自动读取;也可以在初始化时通过 access_token 参数直接传入。
# If you haven't set your access token as an environment variable, pass it in here.
from getpass import getpass

ACCESS_TOKEN = getpass()

加载 Issues 和 PR

from langchain_community.document_loaders import GitHubIssuesLoader
loader = GitHubIssuesLoader(
    repo="langchain-ai/langchain",
    access_token=ACCESS_TOKEN,  # delete/comment out this argument if you've set the access token as an env var.
    creator="UmerHA",
)
让我们加载所有由 “UmerHA” 创建的 Issues 和 PR。 以下是所有可用过滤器的列表:
  • include_prs
  • milestone
  • state
  • assignee
  • creator
  • mentioned
  • labels
  • sort
  • direction
  • since
For more info, see docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#list-repository-issues.
docs = loader.load()
print(docs[0].page_content)
print(docs[0].metadata)

仅加载 Issues

默认情况下,GitHub API 将 Pull Requests 也视为 Issues。若只想获取”纯粹”的 Issues(即不含 Pull Requests),请使用 include_prs=False
loader = GitHubIssuesLoader(
    repo="langchain-ai/langchain",
    access_token=ACCESS_TOKEN,  # delete/comment out this argument if you've set the access token as an env var.
    creator="UmerHA",
    include_prs=False,
)
docs = loader.load()
print(docs[0].page_content)
print(docs[0].metadata)

加载 GitHub 文件内容

以下代码加载 langchain-ai/langchain 仓库中所有 Markdown 文件。
from langchain_community.document_loaders import GithubFileLoader
loader = GithubFileLoader(
    repo="langchain-ai/langchain",  # the repo name
    branch="master",  # the branch name
    access_token=ACCESS_TOKEN,
    github_api_url="https://api.github.com",
    file_filter=lambda file_path: file_path.endswith(
        ".md"
    ),  # load all markdowns files.
)
documents = loader.load()
某个文档的输出示例:
document.metadata:
    {
      "path": "README.md",
      "sha": "82f1c4ea88ecf8d2dfsfx06a700e84be4",
      "source": "https://github.com/langchain-ai/langchain/blob/master/README.md"
    }
document.content:
    mock content