Huggingface.js 文档

@huggingface/hub

Huggingface.js

加入 Hugging Face 社区

并获得增强的文档体验

协作处理模型、数据集和 Spaces

通过加速推理获得更快的示例

切换文档主题

开始使用

@huggingface/hub

类

接口

类型别名

AccessToken

Ƭ AccessToken: string

实际上是 hf_${string}，但为了方便，使用字符串类型

定义在

hub/src/types/public.ts:15

AccessTokenRole

Ƭ AccessTokenRole: "admin" | "write" | "contributor" | "read"

定义在

hub/src/types/public.ts:70

AuthType

Ƭ AuthType: "access_token" | "app_token" | "app_token_as_user"

CommitParams

Ƭ CommitParams: { abortSignal?: AbortSignal ; branch?: string ; description?: string ; fetch?: typeof __type ; hubUrl?: string ; isPullRequest?: boolean ; operations: CommitOperation[] ; parentCommit?: string ; repo: RepoDesignation ; title: string ; useWebWorkers?: boolean | { minSize?: number ; poolSize?: number } } & Partial\<CredentialsParams>

定义在

hub/src/lib/commit.ts:57

CommitProgressEvent

Ƭ CommitProgressEvent: { event: "phase" ; phase: "preuploading" | "uploadingLargeFiles" | "committing" } | { event: "fileProgress" ; path: string ; progress: number ; state: "hashing" | "uploading" }

定义在

hub/src/lib/commit.ts:106

ContentSource

Ƭ ContentSource: Blob | URL

定义于

hub/src/lib/commit.ts:35

Dtype

Ƭ Dtype: "F64" | "F32" | "F16" | "BF16" | "I64" | "I32" | "I16" | "I8" | "U8" | "BOOL"

定义于

hub/src/lib/parse-safetensors-metadata.ts:45

PipelineType

Ƭ PipelineType: keyof typeof PIPELINE_DATA

定义于

tasks/dist/commonjs/pipelines.d.ts:437

RepoDesignation

Ƭ RepoDesignation: RepoId | RepoFullName

定义于

hub/src/types/public.ts:12

RepoFullName

Ƭ RepoFullName: string | `spaces/${string}` | `datasets/${string}`

定义于

hub/src/types/public.ts:10

RepoType

Ƭ RepoType: "space" | "dataset" | "model"

定义于

hub/src/types/public.ts:3

SafetensorsFileHeader

Ƭ SafetensorsFileHeader: Record\<TensorName, TensorInfo> & { __metadata__: Record\<string, string> }

定义于

hub/src/lib/parse-safetensors-metadata.ts:53

SafetensorsParseFromRepo

Ƭ SafetensorsParseFromRepo: { header: SafetensorsFileHeader ; parameterCount?: Partial\<Record\<Dtype, number>> ; sharded: false } | { headers: SafetensorsShardedHeaders ; index: SafetensorsIndexJson ; parameterCount?: Partial\<Record\<Dtype, number>> ; sharded: true }

定义于

hub/src/lib/parse-safetensors-metadata.ts:67

SafetensorsShardedHeaders

Ƭ SafetensorsShardedHeaders: Record\<FileName, SafetensorsFileHeader>

定义于

hub/src/lib/parse-safetensors-metadata.ts:65

SpaceHardwareFlavor

定义于

hub/src/types/public.ts:40

SpaceSdk

Ƭ SpaceSdk: "streamlit" | "gradio" | "docker" | "static"

定义于

hub/src/types/public.ts:56

SpaceStage

定义于

hub/src/types/public.ts:58

TensorName

Ƭ TensorName: string

定义于

hub/src/lib/parse-safetensors-metadata.ts:44

WhoAmI

Ƭ WhoAmI: WhoAmIApp | WhoAmIOrg | WhoAmIUser

定义于

hub/src/lib/who-am-i.ts:50

变量

DATASET _ EXPANDABLE _ KEYS

• Const DATASET_EXPANDABLE_KEYS: readonly ["author", "cardData", "citation", "createdAt", "disabled", "description", "downloads", "downloadsAllTime", "gated", "gitalyUid", "lastModified", "likes", "paperswithcode_id", "private", "sha", "tags"]

定义于

hub/src/lib/list-datasets.ts:17

DATASET _ EXPAND _ KEYS

• Const DATASET_EXPAND_KEYS: readonly ["private", "downloads", "gated", "likes", "lastModified"]

定义于

hub/src/lib/list-datasets.ts:9

DEFAULT _ REVISION

• Const DEFAULT_REVISION: "main"

定义于

hub/src/lib/snapshot-download.ts:12

MODEL _ EXPANDABLE _ KEYS

• Const MODEL_EXPANDABLE_KEYS: readonly ["author", "cardData", "config", "createdAt", "disabled", "downloads", "downloadsAllTime", "gated", "gitalyUid", "inferenceProviderMapping", "lastModified", "library_name", "likes", "model-index", "pipeline_tag", "private", "safetensors", "sha", "spaces", "tags", "transformersInfo"]

定义于

hub/src/lib/list-models.ts:18

MODEL _ EXPAND _ KEYS

• Const MODEL_EXPAND_KEYS: readonly ["pipeline_tag", "private", "gated", "downloads", "likes", "lastModified"]

定义于

hub/src/lib/list-models.ts:9

REGEX _ COMMIT _ HASH

• Const REGEX_COMMIT_HASH: RegExp

定义于

hub/src/lib/download-file-to-cache-dir.ts:11

REPO _ ID _ SEPARATOR

• Const REPO_ID_SEPARATOR: string = "--"

定义于

hub/src/lib/cache-management.ts:25

RE _ SAFETENSORS _ FILE

• Const RE_SAFETENSORS_FILE: RegExp

定义于

hub/src/lib/parse-safetensors-metadata.ts:14

RE _ SAFETENSORS _ INDEX _ FILE

• Const RE_SAFETENSORS_INDEX_FILE: RegExp

定义于

hub/src/lib/parse-safetensors-metadata.ts:15

RE _ SAFETENSORS _ SHARD _ FILE

• Const RE_SAFETENSORS_SHARD_FILE: RegExp

定义于

hub/src/lib/parse-safetensors-metadata.ts:16

SAFETENSORS _ FILE

• Const SAFETENSORS_FILE: "model.safetensors"

定义于

hub/src/lib/parse-safetensors-metadata.ts:10

SAFETENSORS _ INDEX _ FILE

• Const SAFETENSORS_INDEX_FILE: "model.safetensors.index.json"

定义于

hub/src/lib/parse-safetensors-metadata.ts:11

SPACE _ EXPANDABLE _ KEYS

• Const SPACE_EXPANDABLE_KEYS: readonly ["author", "cardData", "datasets", "disabled", "gitalyUid", "lastModified", "createdAt", "likes", "private", "runtime", "sdk", "sha", "subdomain", "tags", "models"]

定义于

hub/src/lib/list-spaces.ts:15

SPACE _ EXPAND _ KEYS

• Const SPACE_EXPAND_KEYS: readonly ["sdk", "likes", "private", "lastModified"]

定义于

hub/src/lib/list-spaces.ts:9

函数

_ _ internal _ sha256

▸ __internal_sha256(buffer, opts?): AsyncGenerator\<number, string>

参数

Name	Type
`buffer`	`Blob`
`opts?`	`Object`
`opts.abortSignal?`	`AbortSignal`
`opts.useWebWorker?`	`boolean` \| { `minSize?`: `number` ; `poolSize?`: `number` }

返回值

AsyncGenerator\<number, string>

hex-encoded sha

Yields

progress (0-1)

定义于

hub/src/utils/sha256.ts:72

checkRepoAccess

▸ checkRepoAccess(params): Promise\<void>

检查我们是否拥有仓库的读取权限。

如果我们没有访问权限，则抛出 HubApiError 错误。HubApiError.statusCode 将为 401、403 或 404。

参数

Name	Type
`params`	{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `repo`: `RepoDesignation` } & `Partial`\<`CredentialsParams`>

返回值

Promise\<void>

定义于

hub/src/lib/check-repo-access.ts:13

commit

▸ commit(params): Promise\<CommitOutput>

参数

Name	Type
`params`	`CommitParams`

返回值

Promise\<CommitOutput>

定义于

hub/src/lib/commit.ts:553

commitIter

▸ commitIter(params): AsyncGenerator\<CommitProgressEvent, CommitOutput>

目前的内部函数，由 commit 使用。

稍后可以公开以提供更精细的进度信息

参数

Name	Type
`params`	`CommitParams`

返回值

AsyncGenerator\<CommitProgressEvent, CommitOutput>

定义于

hub/src/lib/commit.ts:123

countCommits

▸ countCommits(params): Promise\<number>

参数

Name	Type
`params`	{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `repo`: `RepoDesignation` ; `revision?`: `string` } & `Partial`\<`CredentialsParams`>

返回值

Promise\<number>

定义于

hub/src/lib/count-commits.ts:7

createRepo

▸ createRepo(params): Promise\<{ repoUrl: string }>

参数

Name Type

params { fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; files?: { content: ArrayBuffer | Blob ; path: string }[] ; hubUrl?: string ; license?: string ; private?: boolean ; repo: RepoDesignation ; sdk?: SpaceSdk | undefined } & CredentialsParams

Name	Type
`params`	{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `files?`: { `content`: `ArrayBuffer` \| `Blob` ; `path`: `string` }[] ; `hubUrl?`: `string` ; `license?`: `string` ; `private?`: `boolean` ; `repo`: `RepoDesignation` ; `sdk?`: SpaceSdk \| undefined } & `CredentialsParams`

返回值

Promise\<{ repoUrl: string }>

定义于

hub/src/lib/create-repo.ts:9

datasetInfo

▸ datasetInfo\<T>(params): Promise\<DatasetEntry & Pick\<ApiDatasetInfo, T>>

类型参数

Name	Type
`T`	extends `"author"` \| `"cardData"` \| `"disabled"` \| `"gitalyUid"` \| `"createdAt"` \| `"tags"` \| `"paperswithcode_id"` \| `"sha"` \| `"citation"` \| `"description"` \| `"downloadsAllTime"` = `never`

参数

Name	Type
`params`	{ `additionalFields?`: `T`[] ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `name`: `string` ; `revision?`: `string` } & `Partial`\<`CredentialsParams`>

返回值

Promise\<DatasetEntry & Pick\<ApiDatasetInfo, T>>

定义于

hub/src/lib/dataset-info.ts:9

deleteFile

▸ deleteFile(params): Promise\<CommitOutput>

参数

Name Type

params { branch?: string ; commitDescription?: string ; commitTitle?: string ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; isPullRequest?: boolean ; parentCommit?: string ; path: string ; repo: RepoDesignation } & CredentialsParams

Name	Type
`params`	{ `branch?`: `string` ; `commitDescription?`: `string` ; `commitTitle?`: `string` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `isPullRequest?`: `boolean` ; `parentCommit?`: `string` ; `path`: `string` ; `repo`: `RepoDesignation` } & `CredentialsParams`

返回值

Promise\<CommitOutput>

定义于

hub/src/lib/delete-file.ts:5

deleteFiles

▸ deleteFiles(params): Promise\<CommitOutput>

参数

Name Type

params { branch?: string ; commitDescription?: string ; commitTitle?: string ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; isPullRequest?: boolean ; parentCommit?: string ; paths: string[] ; repo: RepoDesignation } & CredentialsParams

Name	Type
`params`	{ `branch?`: `string` ; `commitDescription?`: `string` ; `commitTitle?`: `string` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `isPullRequest?`: `boolean` ; `parentCommit?`: `string` ; `paths`: `string`[] ; `repo`: `RepoDesignation` } & `CredentialsParams`

返回值

Promise\<CommitOutput>

定义于

hub/src/lib/delete-files.ts:5

deleteRepo

▸ deleteRepo(params): Promise\<void>

参数

Name	Type
`params`	{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `repo`: `RepoDesignation` } & `CredentialsParams`

返回值

Promise\<void>

定义于

hub/src/lib/delete-repo.ts:7

downloadFile

▸ downloadFile(params): Promise\<Response | null>

参数

Name	Type
`params`	{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `path`: `string` ; `range?`: [`number`, `number`] ; `raw?`: `boolean` ; `repo`: `RepoDesignation` ; `revision?`: `string` } & `Partial`\<`CredentialsParams`>

返回值

Promise\<Response | null>

文件不存在时返回 null

定义于

hub/src/lib/download-file.ts:10

downloadFileToCacheDir

▸ downloadFileToCacheDir(params): Promise<string>

下载给定文件，如果该文件尚未存在于本地缓存中。

参数

Name	Type
`params`	{ `cacheDir?`: `string` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`<`Response`> ; `hubUrl?`: `string` ; `path`: `string` ; `raw?`: `boolean` ; `repo`: `RepoDesignation` ; `revision?`: `string` } & `Partial`<`CredentialsParams`>

返回值

Promise<string>

指向 blob 对象的符号链接

定义于

hub/src/lib/download-file-to-cache-dir.ts:41

fileDownloadInfo

▸ fileDownloadInfo(params): Promise<FileDownloadInfoOutput | null>

参数

Name	Type
`params`	{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`<`Response`> ; `hubUrl?`: `string` ; `noContentDisposition?`: `boolean` ; `path`: `string` ; `raw?`: `boolean` ; `repo`: `RepoDesignation` ; `revision?`: `string` } & `Partial`<`CredentialsParams`>

返回值

Promise<FileDownloadInfoOutput | null>

文件不存在时返回 null

定义于

hub/src/lib/file-download-info.ts:18

fileExists

▸ fileExists(params): Promise<boolean>

参数

Name	Type
`params`	{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`<`Response`> ; `hubUrl?`: `string` ; `path`: `string` ; `repo`: `RepoDesignation` ; `revision?`: `string` } & `Partial`<`CredentialsParams`>

返回值

Promise<boolean>

定义于

hub/src/lib/file-exists.ts:7

getBlobStat

▸ getBlobStat(blobPath, blobStats): Promise<Stats>

参数

Name	Type
`blobPath`	`string`
`blobStats`	`Map`<`string`, `Stats`>

返回值

Promise<Stats>

定义于

hub/src/lib/cache-management.ts:244

getHFHubCachePath

▸ getHFHubCachePath(): string

返回值

string

定义于

hub/src/lib/cache-management.ts:19

getRepoFolderName

▸ getRepoFolderName(«destructured»): string

参数

Name	Type
`«destructured»`	`RepoId`

返回值

string

定义于

hub/src/lib/cache-management.ts:27

listCommits

▸ listCommits(params): AsyncGenerator<CommitData>

参数

Name	Type
`params`	{ `batchSize?`: `number` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`<`Response`> ; `hubUrl?`: `string` ; `repo`: `RepoDesignation` ; `revision?`: `string` } & `Partial`<`CredentialsParams`>

返回值

AsyncGenerator<CommitData>

定义于

hub/src/lib/list-commits.ts:17

listDatasets

▸ listDatasets<T>(params?): AsyncGenerator<DatasetEntry & Pick<ApiDatasetInfo, T>>

类型参数

Name	Type
`T`	extends `"author"` \| `"cardData"` \| `"disabled"` \| `"gitalyUid"` \| `"createdAt"` \| `"tags"` \| `"paperswithcode_id"` \| `"sha"` \| `"citation"` \| `"description"` \| `"downloadsAllTime"` = `never`

参数

Name	Type
`params?`	{ search?: { query?: string \| undefined; owner?: string \| undefined; tags?: string[] \| undefined; } \| undefined; hubUrl?: string \| undefined; additionalFields?: T[] \| undefined; limit?: number \| undefined; fetch?: { …; } \| undefined; } & Partial<…>

返回值

AsyncGenerator<DatasetEntry & Pick<ApiDatasetInfo, T>>

定义于

hub/src/lib/list-datasets.ts:47

listFiles

▸ listFiles(params): AsyncGenerator<ListFileEntry>

列出文件夹中的文件。要列出目录中的 *所有* 文件，请使用 params.recursive 设置为 true 来调用它。

参数

Name	Type
`params`	{ `expand?`: `boolean` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `path?`: `string` ; `recursive?`: `boolean` ; `repo`: `RepoDesignation` ; `revision?`: `string` } & `Partial`\<`CredentialsParams`>

AsyncGenerator\<ListFileEntry>

定义于

hub/src/lib/list-files.ts:42

listModels

▸ listModels\<T>(params?): AsyncGenerator\<ModelEntry & Pick\<ApiModelInfo, T>>

类型参数

Name	Type
`T`	继承自 `"spaces"` \| `"author"` \| `"cardData"` \| `"disabled"` \| `"gitalyUid"` \| `"createdAt"` \| `"tags"` \| `"sha"` \| `"downloadsAllTime"` \| `"config"` \| `"inferenceProviderMapping"` \| `"library_name"` \| `"model-index"` \| `"safetensors"` \| `"transformersInfo"` = `never`

参数

Name	Type
`params?`	{ search?: { query?: string \| undefined; owner?: string \| undefined; task?: “other” \| “text-classification” \| “token-classification” \| “table-question-answering” \| “question-answering” \| … 还有 50 多个 … \| undefined; tags?: string[] \| undefined; inferenceProviders?: string[] \| undefined; } \| undefined; hubUrl?: strin…

AsyncGenerator\<ModelEntry & Pick\<ApiModelInfo, T>>

定义于

hub/src/lib/list-models.ts:54

listSpaces

▸ listSpaces\<T>(params?): AsyncGenerator\<SpaceEntry & Pick\<ApiSpaceInfo, T>>

类型参数

Name	Type
`T`	继承自 `"models"` \| `"datasets"` \| `"author"` \| `"cardData"` \| `"disabled"` \| `"gitalyUid"` \| `"createdAt"` \| `"tags"` \| `"sha"` \| `"subdomain"` \| `"runtime"` = `never`

参数

Name	Type
`params?`	{ search?: { query?: string \| undefined; owner?: string \| undefined; tags?: string[] \| undefined; } \| undefined; hubUrl?: string \| undefined; fetch?: { (input: URL \| RequestInfo, init?: RequestInit \| undefined): Promise\<…>; (input: string \| … 还有 1 个 … \| Request, init?: RequestInit \| undefined): Promise\<…>; }…

AsyncGenerator\<SpaceEntry & Pick\<ApiSpaceInfo, T>>

定义于

hub/src/lib/list-spaces.ts:44

modelInfo

▸ modelInfo\<T>(params): Promise\<ModelEntry & Pick\<ApiModelInfo, T>>

类型参数

Name	Type
`T`	继承自 `"spaces"` \| `"author"` \| `"cardData"` \| `"disabled"` \| `"gitalyUid"` \| `"createdAt"` \| `"tags"` \| `"sha"` \| `"downloadsAllTime"` \| `"config"` \| `"inferenceProviderMapping"` \| `"library_name"` \| `"model-index"` \| `"safetensors"` \| `"transformersInfo"` = `never`

参数

Name	Type
`params`	{ `additionalFields?`: `T`[] ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `name`: `string` ; `revision?`: `string` } & `Partial`\<`CredentialsParams`>

`Promise`\<`ModelEntry` & `Pick`\<`ApiModelInfo`, `T`>>

Defined in

hub/src/lib/model-info.ts:9

oauthHandleRedirect

▸ oauthHandleRedirect(opts?): Promise\<OAuthResult>

To call after the OAuth provider redirects back to the app.

There is also a helper function oauthHandleRedirectIfPresent, which will call oauthHandleRedirect if the URL contains an oauth code in the query parameters and return false otherwise.

Parameters

Name	Type	Description
`opts?`	`Object`	-
`opts.codeVerifier?`	`string`	codeVerifier generated by oauthLoginUrl `Default` `ts localStorage.getItem("huggingface.co:oauth:code_verifier")`
`opts.hubUrl?`	`string`	The URL of the hub. Defaults to HUB_URL.
`opts.nonce?`	`string`	nonce generated by oauthLoginUrl `Default` `ts localStorage.getItem("huggingface.co:oauth:nonce")`
`opts.redirectedUrl?`	`string`	The URL to analyze. `Default` `ts window.location.href`

Returns

Promise\<OAuthResult>

Defined in

hub/src/lib/oauth-handle-redirect.ts:114

oauthHandleRedirectIfPresent

▸ oauthHandleRedirectIfPresent(opts?): Promise\<OAuthResult | false>

To call after the OAuth provider redirects back to the app.

It returns false if the URL does not contain an oauth code in the query parameters, otherwise it calls oauthHandleRedirect.

Depending on your app, you may want to call oauthHandleRedirect directly instead.

Parameters

Name	Type	Description
`opts?`	`Object`	-
`opts.codeVerifier?`	`string`	codeVerifier generated by oauthLoginUrl `Default` `ts localStorage.getItem("huggingface.co:oauth:code_verifier")`
`opts.hubUrl?`	`string`	The URL of the hub. Defaults to HUB_URL.
`opts.nonce?`	`string`	nonce generated by oauthLoginUrl `Default` `ts localStorage.getItem("huggingface.co:oauth:nonce")`
`opts.redirectedUrl?`	`string`	The URL to analyze. `Default` `ts window.location.href`

Returns

Promise\<OAuthResult | false>

Defined in

hub/src/lib/oauth-handle-redirect.ts:284

oauthLoginUrl

▸ oauthLoginUrl(opts?): Promise\<string>

Use “Sign in with Hub” to authenticate a user, and get oauth user info / access token.

Returns an url to redirect to. After the user is redirected back to your app, call oauthHandleRedirect to get the oauth user info / access token.

When called from inside a static Space with OAuth enabled, it will load the config from the space, otherwise you need to at least specify the client ID of your OAuth App.

Parameters

Name	Type	Description
`opts?`	`Object`	-
`opts.clientId?`	`string`	OAuth client ID. For static Spaces, you can omit this and it will be loaded from the Space config, as long as `hf_oauth: true` is present in the README.md’s metadata. For other Spaces, it is available to the backend in the OAUTH_CLIENT_ID environment variable, as long as `hf_oauth: true` is present in the README.md’s metadata. You can also create a Developer Application at https://huggingface.co/settings/connected-applications and use its client ID.
`opts.hubUrl?`	`string`	-
`opts.localStorage?`	`Object`	If provided, will be filled with the code verifier and nonce used for the OAuth flow, instead of using localStorage. When calling `oauthHandleRedirectIfPresent` or `oauthHandleRedirect` you will need to provide the same values.
`opts.localStorage.codeVerifier?`	`string`	-
`opts.localStorage.nonce?`	`string`	-
`opts.redirectUrl?`	`string`	Redirect URI, defaults to the current URL. For Spaces, any URL within the Space is allowed. For Developer Applications, you can add any URL you want to the list of allowed redirect URIs at https://huggingface.co/settings/connected-applications.
`opts.scopes?`	`string`	OAuth scope, a list of space-separated scopes. For static Spaces, you can omit this and it will be loaded from the Space config, as long as `hf_oauth: true` is present in the README.md’s metadata. For other Spaces, it is available to the backend in the OAUTH_SCOPES environment variable, as long as `hf_oauth: true` is present in the README.md’s metadata. Defaults to “openid profile”. You can also create a Developer Application at https://huggingface.co/settings/connected-applications and use its scopes. See https://huggingface.co/docs/hub/oauth for a list of available scopes.
`opts.state?`	`string`	State to pass to the OAuth provider, which will be returned in the call to `oauthLogin` after the redirect.

Returns

Promise<string>

Example

import { oauthLoginUrl, oauthHandleRedirectIfPresent } from "@huggingface/hub";

const oauthResult = await oauthHandleRedirectIfPresent();

if (!oauthResult) {
  // If the user is not logged in, redirect to the login page
  window.location.href = await oauthLoginUrl();
}

// You can use oauthResult.accessToken, oauthResult.accessTokenExpiresAt and oauthResult.userInfo
console.log(oauthResult);

(Theoretically, this function could be used to authenticate a user for any OAuth provider supporting PKCE and OpenID Connect by changing hubUrl, but it is currently only tested with the Hugging Face Hub.)

Defined in

hub/src/lib/oauth-login-url.ts:31

parseRepoType

▸ parseRepoType(type): RepoType

Parameters

Name	Type
`type`	`string`

Returns

RepoType

定义于

hub/src/lib/cache-management.ts:254

parseSafetensorsMetadata

▸ parseSafetensorsMetadata(params): Promise\<SetRequired\<SafetensorsParseFromRepo, "parameterCount">>

分析托管在 Hugging Face 上的模型中的 model.safetensors.index.json 或 model.safetensors，使用智能范围请求提取其元数据。

参数

Name	Type
`params`	{ `computeParametersCount`: `true` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `path?`: `string` ; `repo`: `RepoDesignation` ; `revision?`: `string` } & `Partial`\<`CredentialsParams`>

Promise\<SetRequired\<SafetensorsParseFromRepo, "parameterCount">>

定义于

hub/src/lib/parse-safetensors-metadata.ts:177

▸ parseSafetensorsMetadata(params): Promise\<SafetensorsParseFromRepo>

参数

Name	Type
`params`	{ `computeParametersCount?`: `boolean` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `path?`: `string` ; `repo`: `RepoDesignation` ; `revision?`: `string` } & `Partial`\<`CredentialsParams`>

Promise\<SafetensorsParseFromRepo>

定义于

hub/src/lib/parse-safetensors-metadata.ts:199

parseSafetensorsShardFilename

▸ parseSafetensorsShardFilename(filename): SafetensorsShardFileInfo | null

参数

Name	Type
`filename`	`string`

SafetensorsShardFileInfo | null

定义于

hub/src/lib/parse-safetensors-metadata.ts:24

pathsInfo

▸ pathsInfo(params): Promise\<PathInfo & { lastCommit: CommitInfo ; securityFileStatus: SecurityFileStatus }[]>

参数

Name	Type
`params`	{ `expand`: `true` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `paths`: `string`[] ; `repo`: `RepoDesignation` ; `revision?`: `string` } & `Partial`\<`CredentialsParams`>

Promise\<PathInfo & { lastCommit: CommitInfo ; securityFileStatus: SecurityFileStatus }[]>

定义于

hub/src/lib/paths-info.ts:37

▸ pathsInfo(params): Promise\<PathInfo[]>

参数

Name	Type
`params`	{ `expand?`: `boolean` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `paths`: `string`[] ; `repo`: `RepoDesignation` ; `revision?`: `string` } & `Partial`\<`CredentialsParams`>

Promise\<PathInfo[]>

定义于

hub/src/lib/paths-info.ts:50

scanCacheDir

▸ scanCacheDir(cacheDir?): Promise\<HFCacheInfo>

参数

Name	Type	默认值
`cacheDir`	`undefined` \| `string`	`undefined`

Promise\<HFCacheInfo>

定义于

hub/src/lib/cache-management.ts:72

scanCachedRepo

▸ scanCachedRepo(repoPath): Promise\<CachedRepoInfo>

参数

Name	Type
`repoPath`	`string`

Promise\<CachedRepoInfo>

定义于

hub/src/lib/cache-management.ts:114

scanRefsDir

▸ scanRefsDir(refsPath, refsByHash): Promise\<void>

参数

Name	Type
`refsPath`	`string`
`refsByHash`	`Map`\<`string`, `string`[]>

Promise\<void>

定义于

hub/src/lib/cache-management.ts:204

scanSnapshotDir

▸ scanSnapshotDir(revisionPath, cachedFiles, blobStats): Promise\<void>

参数

Name	Type
`revisionPath`	`string`
`cachedFiles`	`CachedFileInfo`[]
`blobStats`	`Map`<`string`, `Stats`>

Promise\<void>

定义于

hub/src/lib/cache-management.ts:219

snapshotDownload

▸ snapshotDownload(params): Promise\<string>

在缓存目录 getHFHubCachePath 中下载给定修订版本的整个仓库。您可以使用 scanCachedRepo 列出所有缓存的仓库。

参数

Name	Type
`params`	{ `cacheDir?`: `string` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `repo`: `RepoDesignation` ; `revision?`: `string` } & `Partial`\<`CredentialsParams`>

Promise<string>

备注

它在内部使用 downloadFileToCacheDir。

定义于

hub/src/lib/snapshot-download.ts:19

spaceInfo

▸ spaceInfo\<T>(params): Promise\<SpaceEntry & Pick\<ApiSpaceInfo, T>>

类型参数

Name	Type
`T`	继承自 `"models"` \| `"datasets"` \| `"author"` \| `"cardData"` \| `"disabled"` \| `"gitalyUid"` \| `"createdAt"` \| `"tags"` \| `"sha"` \| `"subdomain"` \| `"runtime"` = `never`

参数

Name	Type
`params`	{ `additionalFields?`: `T`[] ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` ; `name`: `string` ; `revision?`: `string` } & `Partial`\<`CredentialsParams`>

返回值

Promise\<SpaceEntry & Pick\<ApiSpaceInfo, T>>

定义于

hub/src/lib/space-info.ts:10

uploadFile

▸ uploadFile(params): Promise\<CommitOutput>

参数

Name Type

params { abortSignal?: AbortSignal ; branch?: string ; commitDescription?: string ; commitTitle?: string ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; file: URL | File | { content: ContentSource ; path: string } ; hubUrl?: string ; isPullRequest?: boolean ; parentCommit?: string ; repo: RepoDesignation ; useWebWorkers?: boolean | { minSize?: number ; poolSize?: number } } & Partial\<CredentialsParams>

Name	Type
`params`	{ `abortSignal?`: `AbortSignal` ; `branch?`: `string` ; `commitDescription?`: `string` ; `commitTitle?`: `string` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `file`: `URL` \| `File` \| { `content`: `ContentSource` ; `path`: `string` } ; `hubUrl?`: `string` ; `isPullRequest?`: `boolean` ; `parentCommit?`: `string` ; `repo`: `RepoDesignation` ; `useWebWorkers?`: `boolean` \| { `minSize?`: `number` ; `poolSize?`: `number` } } & `Partial`\<`CredentialsParams`>

返回值

Promise\<CommitOutput>

定义于

hub/src/lib/upload-file.ts:5

uploadFiles

▸ uploadFiles(params): Promise\<CommitOutput>

参数

Name Type

params { abortSignal?: AbortSignal ; branch?: string ; commitDescription?: string ; commitTitle?: string ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; files: (URL | File | { content: ContentSource ; path: string })[] ; hubUrl?: string ; isPullRequest?: boolean ; parentCommit?: string ; repo: RepoDesignation ; useWebWorkers?: boolean | { minSize?: number ; poolSize?: number } } & Partial\<CredentialsParams>

Name	Type
`params`	{ `abortSignal?`: `AbortSignal` ; `branch?`: `string` ; `commitDescription?`: `string` ; `commitTitle?`: `string` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `files`: (`URL` \| `File` \| { `content`: `ContentSource` ; `path`: `string` })[] ; `hubUrl?`: `string` ; `isPullRequest?`: `boolean` ; `parentCommit?`: `string` ; `repo`: `RepoDesignation` ; `useWebWorkers?`: `boolean` \| { `minSize?`: `number` ; `poolSize?`: `number` } } & `Partial`\<`CredentialsParams`>

返回值

Promise\<CommitOutput>

定义于

hub/src/lib/upload-files.ts:5

uploadFilesWithProgress

▸ uploadFilesWithProgress(params): AsyncGenerator\<CommitProgressEvent, CommitOutput>

带进度上传

需要 XMLHttpRequest 以便为上传提供进度事件。将 useWebWorkers 设置为 true 以便为哈希处理提供进度事件。

参数

Name Type

params { abortSignal?: AbortSignal ; branch?: string ; commitDescription?: string ; commitTitle?: string ; files: (URL | File | { content: ContentSource ; path: string })[] ; hubUrl?: string ; isPullRequest?: boolean ; parentCommit?: string ; repo: RepoDesignation ; useWebWorkers?: boolean | { minSize?: number ; poolSize?: number } } & Partial\<CredentialsParams>

Name	Type
`params`	{ `abortSignal?`: `AbortSignal` ; `branch?`: `string` ; `commitDescription?`: `string` ; `commitTitle?`: `string` ; `files`: (`URL` \| `File` \| { `content`: `ContentSource` ; `path`: `string` })[] ; `hubUrl?`: `string` ; `isPullRequest?`: `boolean` ; `parentCommit?`: `string` ; `repo`: `RepoDesignation` ; `useWebWorkers?`: `boolean` \| { `minSize?`: `number` ; `poolSize?`: `number` } } & `Partial`\<`CredentialsParams`>

返回值

AsyncGenerator\<CommitProgressEvent, CommitOutput>

定义于

hub/src/lib/upload-files-with-progress.ts:20

whoAmI

▸ whoAmI(params): Promise\<WhoAmI & { auth: AuthInfo }>

参数

Name	Type
`params`	{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`> ; `hubUrl?`: `string` } & `CredentialsParams`

返回值

Promise\<WhoAmI & { auth: AuthInfo }>

定义于

hub/src/lib/who-am-i.ts:61

< > 在 GitHub 上更新

←与 Hub 交互 HubApiError→