• Import from "@langchain/community/document_loaders/web/github" instead. This entrypoint will be removed in 0.3.0.

An interface that represents the parameters for the GithubRepoLoader class. It extends the AsyncCallerParams interface and adds additional properties specific to the GitHub repository loader.

interface GithubRepoLoaderParams {
    accessToken?: string;
    apiUrl?: string;
    baseUrl?: string;
    branch?: string;
    ignoreFiles?: (string | RegExp)[];
    ignorePaths?: string[];
    maxConcurrency?: number;
    maxRetries?: number;
    onFailedAttempt?: FailedAttemptHandler;
    processSubmodules?: boolean;
    recursive?: boolean;
    unknown?: UnknownHandling;
    verbose?: boolean;
}

Hierarchy

  • AsyncCallerParams
    • GithubRepoLoaderParams

Implemented by

Properties

accessToken?: string
apiUrl?: string

The API endpoint URL of the GitHub instance. To be used when you are not targeting github.com, e.g. a GitHub Enterprise instance.

baseUrl?: string

The base URL of the GitHub instance. To be used when you are not targeting github.com, e.g. a GitHub Enterprise instance.

branch?: string
ignoreFiles?: (string | RegExp)[]
ignorePaths?: string[]
maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to 2.

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 2.

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

processSubmodules?: boolean

Set to true to recursively process submodules. Is only effective, when recursive=true.

recursive?: boolean
unknown?: UnknownHandling
verbose?: boolean