GitHubIssueViewer
Fetches and parses GitHub issues into Haystack documents.
Basic Information
- Type:
haystack_integrations.github.src.haystack_integrations.components.connectors.github.issue_viewer.GitHubIssueViewer
Inputs
| Parameter | Type | Default | Description |
|---|---|---|---|
| url | str | GitHub issue URL |
Outputs
| Parameter | Type | Default | Description |
|---|---|---|---|
| documents | List[Document] | Dictionary containing list of documents |
Overview
Work in Progress
Bear with us while we're working on adding pipeline examples and most common components connections.
Fetches and parses GitHub issues into Haystack documents.
The component takes a GitHub issue URL and returns a list of documents where:
- First document contains the main issue content
- Subsequent documents contain the issue comments
Usage Example
components:
GitHubIssueViewer:
type: github.src.haystack_integrations.components.connectors.github.issue_viewer.GitHubIssueViewer
init_parameters:
Parameters
Init Parameters
These are the parameters you can configure in Pipeline Builder:
| Parameter | Type | Default | Description |
|---|---|---|---|
| github_token | Optional[Secret] | None | GitHub personal access token for API authentication as a Secret |
| raise_on_failure | bool | True | If True, raises exceptions on API errors |
| retry_attempts | int | 2 | Number of retry attempts for failed requests |
Run Method Parameters
These are the parameters you can configure for the component's run() method. This means you can pass these parameters at query time through the API, in Playground, or when running a job. For details, see Modify Pipeline Parameters at Query Time.
| Parameter | Type | Default | Description |
|---|---|---|---|
| url | str | GitHub issue URL |
Was this page helpful?