langchain.document_loaders.github.GitHubIssuesLoader¶

class langchain.document_loaders.github.GitHubIssuesLoader(*, repo: str, access_token: str, include_prs: bool = True, milestone: Optional[Union[int, Literal['*', 'none']]] = None, state: Optional[Literal['open', 'closed', 'all']] = None, assignee: Optional[str] = None, creator: Optional[str] = None, mentioned: Optional[str] = None, labels: Optional[List[str]] = None, sort: Optional[Literal['created', 'updated', 'comments']] = None, direction: Optional[Literal['asc', 'desc']] = None, since: Optional[str] = None)[source]¶

Bases: BaseGitHubLoader

Load issues of a GitHub repository.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param access_token: str [Required]¶

Personal access token - see https://github.com/settings/tokens?type=beta

param assignee: Optional[str] = None¶

Filter on assigned user. Pass ‘none’ for no user and ‘*’ for any user.

param creator: Optional[str] = None¶

Filter on the user that created the issue.

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

The direction to sort the results by. Can be one of: ‘asc’, ‘desc’.

param include_prs: bool = True¶

If True include Pull Requests in results, otherwise ignore them.

param labels: Optional[List[str]] = None¶

Label names to filter one. Example: bug,ui,@high.

param mentioned: Optional[str] = None¶

Filter on a user that’s mentioned in the issue.

param milestone: Optional[Union[int, Literal['*', 'none']]] = None¶

If integer is passed, it should be a milestone’s number field. If the string ‘*’ is passed, issues with any milestone are accepted. If the string ‘none’ is passed, issues without milestones are returned.

param repo: str [Required]¶

Name of repository

param since: Optional[str] = None¶

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

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

What to sort results by. Can be one of: ‘created’, ‘updated’, ‘comments’. Default is ‘created’.

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

Filter on issue state. Can be one of: ‘open’, ‘closed’, ‘all’.

lazy_load() → Iterator[Document][source]¶

Get issues of a GitHub repository.

Returns

  • page_content

  • metadata

    • url

    • title

    • creator

    • created_at

    • last_update_time

    • closed_time

    • number of comments

    • state

    • labels

    • assignee

    • assignees

    • milestone

    • locked

    • number

    • is_pull_request

Return type

A list of Documents with attributes

load() → List[Document][source]¶

Get issues of a GitHub repository.

Returns

  • page_content

  • metadata

    • url

    • title

    • creator

    • created_at

    • last_update_time

    • closed_time

    • number of comments

    • state

    • labels

    • assignee

    • assignees

    • milestone

    • locked

    • number

    • is_pull_request

Return type

A list of Documents with attributes

load_and_split(text_splitter: Optional[TextSplitter] = None) → List[Document]¶

Load Documents and split into chunks. Chunks are returned as Documents.

Parameters

text_splitter – TextSplitter instance to use for splitting documents. Defaults to RecursiveCharacterTextSplitter.

Returns

List of Documents.

parse_issue(issue: dict) → Document[source]¶

Create Document objects from a list of GitHub issues.

validator validate_environment  »  all fields¶

Validate that access token exists in environment.

validator validate_since  »  since[source]¶
property headers: Dict[str, str]¶
property query_params: str¶

Create query parameters for GitHub API.

property url: str¶

Create URL for GitHub API.

Examples using GitHubIssuesLoader¶