GitHub
此笔记本展示了如何加载给定存储库上的问题和拉取请求 (PR)。还展示了如何加载给定存储库上的 Github 文件。我们将使用 LangChain Python 存储库作为示例。
设置访问令牌
要访问 GitHub API，您需要一个个人访问令牌 - 您可以在此处设置您的令牌：https://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()
加载问题和 PR
from langchain_community.document_loaders import GitHubIssuesLoader
API 参考：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”创建的所有问题和 PR。
以下是您可以使用的所有过滤器的列表
- include_prs
- milestone
- state
- assignee
- creator
- mentioned
- labels
- sort
- direction
- since
更多信息，请参阅https://githubdocs.cn/en/rest/issues/issues?apiVersion=2022-11-28#list-repository-issues。
docs = loader.load()
print(docs[0].page_content)
print(docs[0].metadata)
仅加载问题
默认情况下，GitHub API 返回的内容将拉取请求也视为问题。要仅获取“纯”问题（即，不包括拉取请求），请使用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 文件内容
对于以下代码，加载rpeo langchain-ai/langchain 中的所有 markdown 文件
from langchain_community.document_loaders import GithubFileLoader
API 参考：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